Implement aggressive stack trace normalization for better error grouping #6120
Conversation
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
This change significantly improves how errors are grouped in our telemetry system by normalizing environment-specific paths in stack traces. Key improvements: - Fix critical security vulnerabilities: * Sanitize path traversal sequences (../ and ./) * Add input validation with 1000 char length limit * Preserve Windows drive letters as <DRIVE_C>, <DRIVE_D> etc - Fix correctness bugs: * UUID pattern now matches anywhere in path (not just between slashes) * Version pattern now matches at end of paths without trailing slash - Add comprehensive path normalizations: * Home directories → <HOME> * Temp directories → <TEMP> * Global package managers → <GLOBAL_NPM>, <GLOBAL_YARN>, <GLOBAL_PNPM> * Webpack chunks → chunk-<HASH>.js * CI/CD environments → <CI_WORKSPACE> * Container paths → <CONTAINER> * Version numbers → @<VERSION> * UUIDs → <UUID> - Add 56 comprehensive tests including security edge cases - Add early exit optimization for performance This prevents identical errors from being split into multiple groups due to differences in user environments, making error monitoring more effective. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
…ping This change implements much more aggressive stack trace normalization to ensure identical errors always produce identical stack traces, regardless of environment. Key changes: - Strip ALL absolute path prefixes (no more <HOME>, <CI_WORKSPACE>, etc) - For node_modules: extract ONLY the part after node_modules/ - For other paths: remove all leading slashes to make them relative - Preserve original stack trace in Bugsnag metadata for debugging Examples of normalization: - /Users/john/project/node_modules/@shopify/cli/dist/index.js → @shopify/cli/dist/index.js - /home/user/.yarn/cache/@shopify-cli-npm-3.45.0/node_modules/@shopify/cli/dist/index.js → @shopify/cli/dist/index.js - /github/workspace/packages/cli-kit/src/error.js → packages/cli-kit/src/error.js This ensures identical errors produce identical stack traces regardless of: - Installation location (global vs local) - Package manager (npm/yarn/pnpm) - Operating system (Windows/Mac/Linux) - User home directory - CI/CD environment The original stack trace is preserved in Bugsnag metadata under "original_stacktrace" for debugging purposes. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
|
We detected some changes at Caution DO NOT create changesets for features which you do not wish to be included in the public changelog of the next CLI release. |
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
Coverage report
Show files with reduced coverage 🔻
Test suite run success3073 tests passing in 1315 suites. Report generated by 🧪jest coverage report action from fdfd987 |
isaacroldan
reviewed
Jul 17, 2025
Comment on lines
55
to
56
| ['macOS home', '/Users/john/project/file.js', 'Users/john/project/file.js'], | ||
| ['Linux home', '/home/jane/work/app.js', 'home/jane/work/app.js'], |
There was a problem hiding this comment.
Shouldn't user names be removed here?
isaacroldan
reviewed
Jul 17, 2025
Comment on lines
61
to
67
| [ | ||
| 'Windows AppData Roaming', | ||
| '/Users/LENOVO/AppData/Roaming/npm/node_modules/@shopify/cli/dist/chunk-AE3MLJMV.js', | ||
| '@shopify/cli/dist/chunk-<HASH>.js', | ||
| ], | ||
| ['Windows AppData Local', '/Users/john/AppData/Local/Programs/app.js', 'Users/john/AppData/Local/Programs/app.js'], | ||
| ['Windows AppData Temp', '/Users/john/AppData/Local/Temp/test.js', 'Users/john/AppData/Local/Temp/test.js'], |
There was a problem hiding this comment.
Same here for Windows AppData Local and Temp
|
Sorry @isaacroldan, this is still WIP. I've converted to draft. |
- Strip ALL environment-specific path prefixes to improve error grouping - Remove user home directories, temp paths, CI workspaces entirely - Handle yarn/pnpm cache paths by extracting only the package-relative path - Aggressively strip Windows AppData paths (Local/Programs, Roaming, etc.) - Preserve original stack traces in Bugsnag metadata for debugging - Fix linter errors by moving inline comments to separate lines This ensures identical errors produce identical stack traces regardless of: - Installation method (npm, yarn, pnpm, global vs local) - User home directory location - Operating system (Windows/Mac/Linux) - CI/CD environment (GitHub Actions, GitLab, etc.) - Container or temporary directory paths 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
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.
Summary
This PR implements aggressive stack trace normalization to ensure identical errors always produce identical stack traces, regardless of environment differences. This will significantly improve error grouping in our telemetry system.
Problem
Previously, the same error would create different stack traces depending on:
This caused identical errors to be split into multiple groups in Bugsnag, making it difficult to identify and prioritize issues.
Solution
Aggressive path normalization: Strip ALL absolute path prefixes
node_modulespaths: Extract only the part afternode_modules/Preserve original stack traces: Store the original stack trace in Bugsnag metadata under
original_stacktracefor debuggingExamples
All of these paths now normalize to the same result:
Testing
Notes
fileShortproperty, but it adds relative path prefixes that make the problem worse🤖 Generated with Claude Code