feat(dashboard): add widget add, edit, and delete commands#407
Merged
feat(dashboard): add widget add, edit, and delete commands#407
Conversation
9 tasks
Contributor
Semver Impact of This PR🟡 Minor (new features) 📋 Changelog PreviewThis is how your changes will appear in the changelog. New Features ✨Telemetry
Other
Bug Fixes 🐛
Internal Changes 🔧
🤖 This preview updates automatically when you update the PR. |
Dashboard API functions now live in src/lib/api/dashboards.ts following the domain module pattern from #405. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
betegon
force-pushed
the
feat/dashboard-commands-core
branch
from
02c23d0 to
f05f91a
Compare
betegon
force-pushed
the
feat/dashboard-widget-commands
branch
from
17da821 to
64ddb86
Compare
Contributor
Codecov Results 📊✅ 126 passed | Total: 126 | Pass Rate: 100% | Execution Time: 0ms 📊 Comparison with Base Branch
✨ No test changes detected All tests are passing successfully. ✅ Patch coverage is 95.27%. Project has 1075 uncovered lines. Files with missing lines (4)
Coverage diff@@ Coverage Diff @@
## main #PR +/-##
==========================================
- Coverage 95.79% 95.78% -0.01%
==========================================
Files 180 184 +4
Lines 24897 25502 +605
Branches 0 0 —
==========================================
+ Hits 23850 24427 +577
- Misses 1047 1075 +28
- Partials 0 0 —Generated by Codecov Action |
…end existing test suites Add ~46 new tests covering dashboard commands (list, create, resolve), URL builders (property-based), human formatters, and type utilities (assignDefaultLayout, stripWidgetServerFields). Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Convert list from buildListCommand to buildCommand with return-based output - Extract formatDashboardListHuman for human-readable table rendering - Add --fresh flag to both list and view commands - Update list tests to include fresh flag Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
betegon
force-pushed
the
feat/dashboard-widget-commands
branch
from
2a0361d to
38e3eda
Compare
…olve.ts Align parseDashboardPositionalArgs with the established codebase pattern used in event/view, trace/view, trace/logs, and dashboard/create. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Add three widget management subcommands under `sentry dashboard widget`: - `widget add` — add a widget with inline --display/--query/--where/--group-by flags - `widget edit` — edit an existing widget by --index or --title, merging only changed fields - `widget delete` — remove a widget by --index or --title All widget commands use GET-modify-PUT pattern with server field stripping and auto-layout for new widgets. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…o shared module - Move resolveWidgetIndex from edit.ts to resolve.ts (shared by edit + delete) - Extract validateWidgetEnums to resolve.ts (shared by add + edit) - Remove inline enum validation from add.ts and edit.ts - Remove inline widget-index logic from delete.ts Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
betegon
force-pushed
the
feat/dashboard-widget-commands
branch
from
1f3a700 to
0d179ef
Compare
BYK
force-pushed
the
feat/dashboard-commands-core
branch
from
f13bbd3 to
67b80d5
Compare
# Conflicts: # plugins/sentry-cli/skills/sentry-cli/SKILL.md # src/app.ts # src/commands/dashboard/create.ts # src/commands/dashboard/index.ts # src/commands/dashboard/list.ts # src/commands/dashboard/resolve.ts # src/commands/dashboard/view.ts # src/lib/api-client.ts # src/lib/api/dashboards.ts # src/lib/formatters/human.ts # src/types/dashboard.ts # test/commands/dashboard/create.test.ts # test/commands/dashboard/list.test.ts # test/types/dashboard.test.ts
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
- Extract shared buildWidgetFromFlags() into resolve.ts (DRY create + add)
- Add return { hint } with dashboard URL to all dashboard commands
- Move enum validation before API calls in widget add (fail fast)
- Use proper DashboardDetail/DashboardWidget types in widget formatters
- Wrap getDashboard in withProgress for loading spinner in view command
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Two bugs prevented dashboard widget commands from working correctly: 1. stripWidgetServerFields used a denylist that missed dozens of extra fields returned by the GET API via Zod .passthrough() (description, thresholds, interval, axisRange, datasetSource, etc.). Switch to an allowlist that only includes fields the PUT API accepts. 2. updateDashboard PUT succeeded but subsequent dashboard view returned stale cached GET data. Add invalidateCachedResponse() to response-cache and call it after every dashboard PUT with the correct URL format. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
The Sentry events API silently resolves function aliases (spm→epm, sps→eps, tpm→epm, tps→eps), but the dashboard widget UI only renders canonical functions from AggregationKey. Widgets created with aliases showed "None" in the visualize field. - Add AGGREGATE_ALIASES map and resolve in parseAggregate() - Remove aliases from SPAN/DISCOVER_AGGREGATE_FUNCTIONS lists - Add validateAggregateNames() to reject unknown functions early - Call validation in buildWidgetFromFlags() before API calls - Update JSDoc to link canonical source files on GitHub Source: https://github.com/getsentry/sentry/blob/master/static/app/utils/fields/index.ts Aliases: https://github.com/getsentry/sentry/blob/master/src/sentry/search/events/constants.py Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Chart widgets (line, area, bar) with --group-by and --limit but no --sort created broken widgets — the dashboard UI couldn't determine which top N groups to display. Auto-default orderby to first aggregate descending (e.g. -count()) when group-by is present and no explicit sort is provided. This matches the Sentry UI's default behavior. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
![sentry[bot]](https://avatars.githubusercontent.com/in/12637?s=60&v=4){kind=small}
1. Fix stale `fields` in mergeQueries — destructure to omit existing `fields` so prepareWidgetQueries recomputes from updated aggregates/ columns (bugbot comment #1) 2. Preserve widgetType without silent default — only set widgetType if explicitly provided via --dataset or already on the existing widget, preventing parseWidgetInput from defaulting to "spans" (bugbot #4) 3. Resolve aliases in paren passthrough — `spm()` now correctly resolves to `epm()` instead of being rejected by validation (bugbot #3) Comment #2 (drops interval/thresholds) is not a real issue — these fields are already stripped by the allowlist in stripWidgetServerFields before buildReplacement sees them. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…-commands # Conflicts: # plugins/sentry-cli/skills/sentry-cli/SKILL.md
The edit command's mergeQueries called parseAggregate but skipped validateAggregateNames, allowing invalid aggregates like --query bogus to pass CLI validation. Add validation in buildReplacement after merging queries, matching the add/create path behavior. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
When --dataset is provided alongside --query, validate aggregates against the new dataset, not the existing widget's widgetType. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…/--widget-title Previously, passing --widget-query, --widget-dataset, etc. without --widget-display or --widget-title silently created a dashboard with no widgets. Now throws a ValidationError explaining both flags are required. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…query Changing --dataset (e.g. discover→spans) without --query skipped aggregate validation, allowing dataset-incompatible aggregates like failure_rate() to be sent with widgetType: "spans". Now validates existing aggregates against the new dataset too. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
resolveWidgetIndex used strict === for title matching while resolveDashboardId used case-insensitive .toLowerCase(). Now both use case-insensitive matching for consistency. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…JSON mode - Add validateWidgetEnums() call in create command before buildInlineWidget for friendly error messages on invalid --widget-display/--widget-dataset - Pass json: flags.json to withProgress in view command to suppress spinner ANSI escape codes when --json is used (matches list command pattern) Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…ands Add 18 tests across 3 files covering: - widget add: API args, JSON/human output, validation (title, display, aggregate), auto-default orderby - widget edit: edit by index/title (case-insensitive), validation (index/title required, invalid aggregate, dataset change) - widget delete: delete by index/title, validation (index/title required, out-of-range), human output Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…ates prepareDashboardForUpdate only returned title, widgets, and projects, silently dropping dashboard-level environment and period filters during widget add/edit/delete operations. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
BYK
reviewed
Mar 20, 2026
Member
BYK
left a comment
BYK
left a comment
There was a problem hiding this comment.
Did a very cursory look. Also seems to be missing the SKILL updates for some reason?
…review comments - Remove --widget-* flags from `dashboard create` (use `dashboard widget add` instead) - Fix `prepareWidgetQueries` empty fields recomputation (cleanQuery sets [] which is truthy) - Add max positional args validation in `widget add` - Extract shared `WidgetQueryFlags` type in resolve.ts for add/edit commands - Update dashboards.md with widget add/edit/delete subcommand docs Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.
…y type The body parameter type was missing environment and period fields that prepareDashboardForUpdate includes, making the type signature inaccurate. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This was referenced Mar 20, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
sentry dashboard widget add— add a widget with inline--display/--query/--where/--group-by/--sort/--limitflagssentry dashboard widget edit— edit an existing widget by--indexor--title, merging only changed fieldssentry dashboard widget delete— remove a widget by--indexor--titleformatWidgetAdded,formatWidgetDeleted,formatWidgetEdited)All widget commands use the GET-modify-PUT pattern with server field stripping and auto-layout for new widgets.
Stacked on #406.
Test plan
bun run typecheck— no new type errorsbun run lint— passesbun test test/types/dashboard.test.ts— 53 tests pass🤖 Generated with Claude Code