Repository navigation
feat: add a description field to the tile editor - #3403
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
🦋 Changeset detectedLatest commit: 81c0cd1 The changes in this PR will be included in the next version bump. This PR includes changesets to release 4 packages
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 |
🔴 Tier 4 — CriticalTouches 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:
Review process: Deep review from a domain expert. Synchronous walkthrough may be required. Stats
|
Duplicate code analysisNo new duplicate code introduced by this PR. jscpd compared this branch against |
PR Review
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. |
[Medium impact] The PR appears safe to merge; no new actionable issues were found. SummaryAdds a dashboard tile description field and stores its text in
Reviews (4) · Last reviewed commit: "Merge branch 'main' into agent/tile-desc..." · Reviewed by Greptile |
Deep Review✅ No critical issues found. This change moves tile The one data-shape concern — removing 🟡 P2 — recommended
🔵 P3 nitpicks (3)
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, Testing gaps: series-tile external GET round-trip not directly asserted; max-length boundary untested; legacy top-level- 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 |
E2E Test Results✅ All tests passed • 435 passed • 1 skipped • 1352s
Tests ran across 4 shards in parallel. |
Summary
Follow-up to #3352: adds a Description field to the tile editor and fixes series tiles dropping their description in the external API.
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 fromTileSchema.lgbreakpoint. Clearing it removes the field.descriptionat the top level of the tile). The converters now write it into and read it fromconfig, the same waynameis handled.serieslost theirdescription, becausetranslateExternalChartToTileConfigdid not copy it. Both tile shapes are now tested throughconvertExternalTilesToInternal.chart.config.description.Screenshot
How to test
External API: create a dashboard through
POST /api/v2/dashboardswith oneseriestile and oneconfigtile that each setdescription. AGETreturns it on both. Onmaintheseriestile comes back without it.References