Skip to content

Add original path to error messages #363

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 7 commits into
base: master
Choose a base branch
from

Conversation

blakeembrey
Copy link
Member

Closes #336, #358, #356, and #354.

Adds originalPath to TokenData, which will be used (when available) for the error messages. It's already added to any methods that input a string.

@blakeembrey blakeembrey requested a review from a team May 10, 2025 18:02
@blakeembrey blakeembrey force-pushed the be/debug-original-path branch from b25a26b to 3f25805 Compare May 10, 2025 18:03
src/index.ts Outdated
*/
function errorMessage(message: string, originalPath: string | undefined) {
if (originalPath) {
return `${message}: ${originalPath}; visit ${DEBUG_URL} for more info`;
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not tied to this format, happy to get other opinions. Another PR used ${originalPath}: ${message} format instead.

Copy link
Contributor

@bjohansebas bjohansebas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

Copy link
Member

@UlisesGascon UlisesGascon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@bjohansebas
Copy link
Contributor

Can we move forward and make a release for this? this really helps a lot with migrating from Express 4 to Express 5

@shivarm
Copy link

shivarm commented Jul 31, 2025

I think it is time to land it with new realease

Copy link

codecov bot commented Jul 31, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.21%. Comparing base (26d87a2) to head (85e5e2c).
⚠️ Report is 27 commits behind head on master.

Additional details and impacted files
@@             Coverage Diff             @@
##            master     #363      +/-   ##
===========================================
- Coverage   100.00%   99.21%   -0.79%     
===========================================
  Files            1        1              
  Lines          668      381     -287     
  Branches       151      132      -19     
===========================================
- Hits           668      378     -290     
- Misses           0        3       +3     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@blakeembrey
Copy link
Member Author

Refactored and added a test to reduce stack size for pillarjs/router#158.

} catch (error) {
const stack = (error as Error).stack
?.split("\n")
.slice(0, 6)
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This still might not be short enough to get the line when combined with the router stack, but further optimization to reduce function calls starts to affect readability of code.

Copy link
Contributor

@bjohansebas bjohansebas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, for posterity, why did you stop using generators?

@blakeembrey
Copy link
Member Author

why did you stop using generators?

Easiest way reduce the error stack size, otherwise it has 2-3 lines per generator.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve error message when parsing fails
4 participants