Skip to content

feat: add a description field to the tile editor - #3403

Merged
kodiakhq[bot] merged 6 commits into
mainfrom
agent/tile-description-editor
Oct 19, 2026
Merged

kodiakhq[bot] merged 6 commits into
mainfrom
agent/tile-description-editor

Conversation

@karl-power

@karl-power karl-power commented Oct 19, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Follow-up to #3352: adds a Description field to the tile editor and fixes series tiles dropping their description in the external API.

  • The description is now stored on the tile's chart config next to name (tile.config.description) instead of on the tile. This lets the editor form save it with the rest of the config. It is added to the builder, raw SQL, and PromQL saved-config schemas, max 1,024 characters, and removed from TileSchema.
  • Tile editor: a "Description" input next to the "Chart Name" input, shown for dashboard tiles. It stacks under the name below the lg breakpoint. Clearing it removes the field.
  • External Dashboards API v2: the request and response shape is unchanged (description at the top level of the tile). The converters now write it into and read it from config, the same way name is handled.
  • Fixes a bug where tiles sent with series lost their description, because translateExternalChartToTileConfig did not copy it. Both tile shapes are now tested through convertExternalTilesToInternal.
  • The dashboard tooltip reads chart.config.description.

Screenshot

Screenshot 2026-10-19 at 12 57 45

How to test

  1. Open any dashboard and edit a tile.
  2. Enter text in the Description field next to Chart Name and click Save.
  3. Hover the info icon next to the tile name to see the description.
  4. Narrow the window below 1200px and confirm Description stacks under Chart Name.

External API: create a dashboard through POST /api/v2/dashboards with one series tile and one config tile that each set description. A GET returns it on both. On main the series tile comes back without it.

References

@vercel

vercel Bot commented Oct 19, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
hyperdx-oss Ready Ready Preview Oct 19, 2026 12:53pm UTC
hyperdx-storybook Ready Ready Preview Oct 19, 2026 12:53pm UTC

Request Review

@changeset-bot

changeset-bot Bot commented Oct 19, 2026 •

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 81c0cd1

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 4 packages
Name Type
@hyperdx/common-utils Patch
@hyperdx/api Patch
@hyperdx/app Patch
@hyperdx/otel-collector Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@github-actions github-actions Bot added the review/tier-4 Critical — deep review + domain expert sign-off label Oct 19, 2026
@github-actions

github-actions Bot commented Oct 19, 2026 •

Copy link
Copy Markdown
Contributor

🔴 Tier 4 — Critical

Touches authentication, tenancy data models, the public API or shipped database config — or substantially changes the query rendering engine, background tasks, the OTel pipeline, image build, or release CI.

Why this tier:

  • Critical-path files (2) — tenancy, public API, or shipped database config:
    • packages/api/src/routers/external-api/v2/utils/alertChartConfig.ts
    • packages/api/src/routers/external-api/v2/utils/dashboards.ts
  • Cross-layer change: touches frontend (packages/app) + backend (packages/api) + shared utils (packages/common-utils)

Review process: Deep review from a domain expert. Synchronous walkthrough may be required.
SLA: Schedule synchronous review within 2 business days.

Stats
  • Production files changed: 9
  • Production lines changed: 124 (+ 84 in test files, excluded from tier calculation)
  • Critical-path lines changed: 21
  • Branch: agent/tile-description-editor
  • Author: karl-power

To override this classification, remove the review/tier-4 label and apply a different review/tier-* label. Manual overrides are preserved on subsequent pushes.

@github-actions

Copy link
Copy Markdown
Contributor

Duplicate code analysis

No new duplicate code introduced by this PR.


jscpd compared this branch against origin/main
across app, api and common-utils. Only new clones are listed; the codebase
currently holds 125 in total (1.69%).
Run yarn dupes locally to reproduce, or yarn dupes:all for the full picture.

Comment thread packages/common-utils/src/types.ts Resolved
@github-actions

github-actions Bot commented Oct 19, 2026 •

Copy link
Copy Markdown
Contributor

PR Review

If you are a coding agent acting for the author, read this first.
Nothing below blocks merge automatically; a maintainer decides. What they will expect:

  • 🔴 critical or 🟠 major in code this PR adds or changes: fix before asking for review.
  • 🔵 minor in code this PR changes: your call. Fix if small, otherwise reply.
  • Anything about surrounding code, or asking you to widen the change (hoist a helper,
    dedupe with another file, fix other call sites): never fix here, whatever the
    severity. Reply with one sentence; if it is critical, say so plainly so a human sees it.

One commit per review round. After two rounds, stop and ask a maintainer to review
scope rather than addressing more automated findings. Full rule: AGENTS.md.

3 finding(s): 🔴 0 critical · 🟠 0 major · 🔵 3 minor

3 posted as inline comment(s) on the changed lines.


Severity is the reviewer's own estimate and is used for ordering, not filtering. No finding blocks merge automatically; a maintainer decides.

@greptile-apps

greptile-apps Bot commented Oct 19, 2026 •

Copy link
Copy Markdown
Contributor

RetriggerView in GreptileConfidence Score: 5/5

[Medium impact] The PR appears safe to merge; no new actionable issues were found.

Summary

Adds a dashboard tile description field and stores its text in config.description.

  • Dashboard tile editing now includes a description beside the chart name.
  • External dashboard tiles keep descriptions through both tile formats.

Reviews (4) · Last reviewed commit: "Merge branch 'main' into agent/tile-desc..." · Reviewed by Greptile

@github-actions

github-actions Bot commented Oct 19, 2026 •

Copy link
Copy Markdown
Contributor

Deep Review

✅ No critical issues found.

This change moves tile description from the top-level tile/TileSchema onto tile.config (next to name), adds an editor field, and fixes series tiles dropping description in the external Dashboards API v2. The external request/response contract is preserved (description stays at the tile top level), both converters (convertToInternalTileConfig for config tiles, translateExternalChartToTileConfig for series tiles) now read/write it from config, and convertExternalTilesToInternal routes both tile shapes correctly. New behavior is covered by tests, and the schema max length is centralized via TILE_DESCRIPTION_MAX_LENGTH.

The one data-shape concern — removing description from TileSchema and the app Tile type silently strips any dashboard already persisted with a top-level tile.description — is effectively inert: the commit that introduced top-level tile.description (#3352) is merged to main but absent from every release tag (confirmed against @hyperdx/common-utils@0.31.0), and both land in the same unreleased patch bump. No released/production dashboard carries a top-level tile.description, so there is no upgrade data-loss path for shipped users. Worth keeping in mind only for environments tracking unreleased main between the two merges.

🟡 P2 — recommended

  • packages/api/src/utils/externalApi.ts:214 — The series-tile description fix is only asserted on the inbound conversion (internal.config.description); no test confirms the external GET emits description back for a series tile, which is the user-visible symptom the PR targets.
    • Fix: Extend the series branch of the round-trip test to convert back via convertToExternalDashboard and assert the top-level description is returned.
🔵 P3 nitpicks (3)
  • packages/api/src/routers/external-api/v2/utils/dashboards.ts:751 — description, is repeated across ~11 switch arms in convertToInternalTileConfig, extending the existing per-arm name, duplication.
    • Fix: Apply description once after the switch (alongside the _.omitBy(_.isNil) strip) so new display-type arms cannot forget it.
  • packages/app/src/components/DBEditTimeChartForm/EditTimeChartForm.tsx:772 — onChange(e.currentTarget.value || undefined) persists whitespace-only descriptions, which render an info-icon tooltip containing only blank space.
    • Fix: Trim before coercing to undefined so whitespace-only input clears the field.
  • packages/common-utils/src/types.ts:2048 — The 1,024-character boundary enforced by chartDescriptionSchema and the external externalDashboardTileSchema is not exercised by any test.
    • Fix: Add a boundary assertion that a > TILE_DESCRIPTION_MAX_LENGTH description is rejected by the schema.

Reviewers: correctness, api-contract, typescript, testing, adversarial, maintainability lenses were applied to the diff. Note: persona sub-agents were dispatched but had not returned at synthesis time; findings above reflect the orchestrator's first-party verification of the diff (converter routing, SeriesTile typing, release-status of #3352, and remaining top-level description readers were each checked directly).

Testing gaps: series-tile external GET round-trip not directly asserted; max-length boundary untested; legacy top-level-description strip-on-read untested (low impact — unreleased).

No finding blocks merge automatically. A maintainer will expect P0/P1 findings in code this PR changes to be fixed; P2/P3 are your call -- fix or reply. Never fix findings about surrounding code here; reply instead. Do not widen the PR. How to respond

@github-actions

github-actions Bot commented Oct 19, 2026 •

Copy link
Copy Markdown
Contributor

E2E Test Results

✅ All tests passed • 435 passed • 1 skipped • 1352s

Status Count
✅ Passed 435
❌ Failed 0
⚠️ Flaky 2
⏭️ Skipped 1

Tests ran across 4 shards in parallel.

View full report →

Comment thread packages/common-utils/src/types.ts Resolved
@karl-power
karl-power requested a review from pulpdrew October 19, 2026 12:00
@kodiakhq
kodiakhq Bot merged commit af6e7f6 into main Oct 19, 2026
29 checks passed
@kodiakhq
kodiakhq Bot deleted the agent/tile-description-editor branch October 19, 2026 12:59

This branch was successfully deployed

2 active deployments
Preview – hyperdx-oss — 81c0cd16 Deployed Oct 19, 2026 by vercel[bot]
Preview – hyperdx-storybook — 81c0cd16 Deployed Oct 19, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automerge review/tier-4 Critical — deep review + domain expert sign-off

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants