fix: enrich short ID 404 with org context and suggestions (CLI-A1)#494
Merged
fix: enrich short ID 404 with org context and suggestions (CLI-A1)#494
Conversation
When resolving an issue by short ID fails with 404, the generic 'Failed to resolve short ID: 404 Not Found' doesn't tell the user what went wrong. This affects 27 users (CLI-A1). Improved the error in getIssueByShortId to include: - The short ID that was searched for - The organization it was searched in - Suggestions about deletion/merging, verifying the ID, and listing issues The enhanced ApiError still has status=404, so tryGetIssueByShortId (used for parallel fan-out across orgs) continues to work unchanged.
Contributor
Semver Impact of This PR🟢 Patch (bug fixes) 📋 Changelog PreviewThis is how your changes will appear in the changelog. New Features ✨
Bug Fixes 🐛
Internal Changes 🔧
🤖 This preview updates automatically when you update the PR. |
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 100.00%. Project has 1056 uncovered lines. Files with missing lines (1)
Coverage diff@@ Coverage Diff @@
## main #PR +/-##
==========================================
+ Coverage 95.72% 95.72% —%
==========================================
Files 180 180 —
Lines 24654 24669 +15
Branches 0 0 —
==========================================
+ Hits 23598 23613 +15
- Misses 1056 1056 —
- Partials 0 0 —Generated by Codecov Action |
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
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.
Problem
When resolving an issue by short ID (e.g.,
sentry issue view CLI-BM) fails with 404, the error shows:This doesn't tell the user what short ID was searched, which organization was searched, or what to do next. Affects 27 users (CLI-A1).
Fix
Enhanced the 404 error in
getIssueByShortIdto include context and suggestions:Design Decisions
status=404, sotryGetIssueByShortId(used for parallel fan-out across orgs) continues to work unchanged — it catchesApiErrorby status codedetailfield, whichApiError.format()renders on indented lines below the main message