Skip to content
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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve display of filenames in component stack #12059

Merged
merged 7 commits into from Aug 9, 2018
Merged

Improve display of filenames in component stack #12059

merged 7 commits into from Aug 9, 2018

Conversation

@billyjanitsch
Copy link
Contributor

@billyjanitsch billyjanitsch commented Jan 20, 2018

Fixes #12058, fixes #11519, and supercedes #11523.

FWIW, as a user, I really like the idea of only stripping the common head, but I understand that you want to start simple. :)

Relying on CI to run the test suite for now -- I tried to install Yarn but it clobbered my fnm installation. 馃槩

@@ -17,7 +17,7 @@ export default function(
(name || 'Unknown') +
(source
? ' (at ' +
source.fileName.replace(/^.*[\\\/]/, '') +
source.fileName.match(/[^\\\/]*([\\\/]index\.[^\\\/]+)?$/)[0] +
Copy link
Member

@gaearon gaearon Jan 20, 2018

Choose a reason for hiding this comment

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

Could you add a comment with different things it鈥檚 supposed to match?

Loading

Copy link
Contributor Author

@billyjanitsch billyjanitsch Jan 20, 2018

Choose a reason for hiding this comment

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

Done :)

Loading

@gaearon
Copy link
Member

@gaearon gaearon commented Jan 20, 2018

Can you add some tests ensuring this works? Maybe you could manually create element objects with __source and then use some warning to test them on.

Loading

@billyjanitsch
Copy link
Contributor Author

@billyjanitsch billyjanitsch commented Jan 26, 2018

Sorry for the delay @gaearon. I'll come back to this and add some tests as soon as I'm able to get a Yarn env set up.

(If someone else wants to tackle this first, feel free to co-opt this PR!)

Loading

@gaearon
Copy link
Member

@gaearon gaearon commented Feb 5, 2018

Ping :-)

Loading

@billyjanitsch
Copy link
Contributor Author

@billyjanitsch billyjanitsch commented Feb 7, 2018

Sorry, I've been traveling and don't want to mess with my env again until I have a block of spare time. Np if you want to close this until I come back to it.

Loading

@raunofreiberg
Copy link
Contributor

@raunofreiberg raunofreiberg commented Feb 27, 2018

@billyjanitsch, I've created a working test case for your change - how would you like me to contribute to this PR :)? Create a PR to your forked repo or..?

Loading

@billyjanitsch
Copy link
Contributor Author

@billyjanitsch billyjanitsch commented Feb 27, 2018

Thanks @raunofreiberg, much appreciated! I gave you push access to my fork so you can update the PR directly, if you'd like.

Loading

@raunofreiberg
Copy link
Contributor

@raunofreiberg raunofreiberg commented Feb 27, 2018

Thanks @billyjanitsch. I've updated your PR, although the Danger tests seem to be failing again despite the #12295 fix.

@gaearon I couldn't find a decent way to use the toWarnDev API in order to test the warning stack trace, since the normalizeCodeLocInfo func replaces the whole trace with asterisks. For now, I used the spyOnDev method instead, which works. Although, any suggestions as to how would one approach this in another manner using the toWarnDev API? I thought about modifying the func itself to provide the full stack trace on some condition, but that seemed hacky and I'd rather get your 2 cents on it.

Loading

@billyjanitsch
Copy link
Contributor Author

@billyjanitsch billyjanitsch commented Feb 28, 2018

The tests are probably failing because my fork is based on an old master. Let me try rebasing.

Update: 馃帀

Loading

@raunofreiberg
Copy link
Contributor

@raunofreiberg raunofreiberg commented Mar 13, 2018

Ping @gaearon 馃槃

Loading

@TimNZ
Copy link

@TimNZ TimNZ commented May 7, 2018

Ping everyone 馃槈

Loading

@gaearon
Copy link
Member

@gaearon gaearon commented May 7, 2018

The only thing that holds me back from merging is I'm not confident this regex always works. :-)
Can you walk me through it?

Loading

@gaearon
Copy link
Member

@gaearon gaearon commented Aug 9, 2018

I didn't quite trust this regex so I rewrote with more comprehensive tests. Thank you for starting this!

Loading

@gaearon gaearon merged commit 54d86eb into facebook:master Aug 9, 2018
1 check was pending
Loading
@pull-bot
Copy link

@pull-bot pull-bot commented Aug 9, 2018

ReactDOM: size: 馃敽+0.1%, gzip: 馃敽+0.2%

Details of bundled changes.

Comparing: fa824d0...69f7c41

react

File Filesize Diff Gzip Diff Prev Size Current Size Prev Gzip Current Gzip ENV
react.development.js +1.0% +1.2% 58.04 KB 58.6 KB 16.21 KB 16.42 KB UMD_DEV
react.development.js +1.1% +1.4% 52.23 KB 52.79 KB 14.39 KB 14.59 KB NODE_DEV
React-dev.js +1.0% +1.3% 50.06 KB 50.54 KB 13.8 KB 13.98 KB FB_WWW_DEV

react-dom

File Filesize Diff Gzip Diff Prev Size Current Size Prev Gzip Current Gzip ENV
react-dom.development.js +0.1% +0.1% 643 KB 643.56 KB 151 KB 151.19 KB UMD_DEV
react-dom.production.min.js 馃敽+0.1% 馃敽+0.2% 96.27 KB 96.36 KB 31.21 KB 31.26 KB UMD_PROD
react-dom.development.js +0.1% +0.1% 639.14 KB 639.7 KB 149.83 KB 150.02 KB NODE_DEV
react-dom.production.min.js 馃敽+0.1% 馃敽+0.2% 96.26 KB 96.35 KB 30.74 KB 30.81 KB NODE_PROD
react-dom-server.browser.development.js +0.5% +0.6% 102.25 KB 102.81 KB 27.24 KB 27.41 KB UMD_DEV
react-dom-server.browser.development.js +0.6% +0.6% 98.38 KB 98.94 KB 26.3 KB 26.46 KB NODE_DEV
react-dom-server.node.development.js +0.6% +0.6% 100.3 KB 100.86 KB 26.83 KB 26.99 KB NODE_DEV
ReactDOM-dev.js +0.1% +0.1% 646.35 KB 646.83 KB 148.13 KB 148.31 KB FB_WWW_DEV
ReactDOM-prod.js 馃敽+0.1% 馃敽+0.2% 278.1 KB 278.41 KB 52.2 KB 52.28 KB FB_WWW_PROD
ReactDOMServer-dev.js +0.5% +0.6% 99.49 KB 99.98 KB 26 KB 26.16 KB FB_WWW_DEV
react-dom.profiling.min.js +0.1% +0.2% 97.39 KB 97.49 KB 31.14 KB 31.2 KB NODE_PROFILING
ReactDOM-profiling.js +0.1% +0.2% 281.39 KB 281.7 KB 52.92 KB 53.01 KB FB_WWW_PROFILING

react-art

File Filesize Diff Gzip Diff Prev Size Current Size Prev Gzip Current Gzip ENV
react-art.development.js +0.1% +0.2% 435.36 KB 435.92 KB 98.65 KB 98.83 KB UMD_DEV
react-art.production.min.js 馃敽+0.1% 馃敽+0.2% 85.17 KB 85.27 KB 26.42 KB 26.47 KB UMD_PROD
react-art.development.js +0.2% +0.2% 367.88 KB 368.44 KB 81.58 KB 81.76 KB NODE_DEV
react-art.production.min.js 馃敽+0.2% 馃敽+0.3% 50.16 KB 50.26 KB 15.79 KB 15.85 KB NODE_PROD
ReactART-dev.js +0.1% +0.2% 358.35 KB 358.84 KB 76.45 KB 76.61 KB FB_WWW_DEV
ReactART-prod.js 馃敽+0.2% 馃敽+0.3% 152.95 KB 153.26 KB 26.36 KB 26.45 KB FB_WWW_PROD

react-test-renderer

File Filesize Diff Gzip Diff Prev Size Current Size Prev Gzip Current Gzip ENV
react-test-renderer.development.js +0.2% +0.2% 363.77 KB 364.33 KB 79.99 KB 80.17 KB UMD_DEV
react-test-renderer.production.min.js 馃敽+0.2% 馃敽+0.3% 49.03 KB 49.13 KB 15.16 KB 15.21 KB UMD_PROD
react-test-renderer.development.js +0.2% +0.2% 359.9 KB 360.46 KB 79.01 KB 79.2 KB NODE_DEV
react-test-renderer.production.min.js 馃敽+0.2% 馃敽+0.4% 48.74 KB 48.84 KB 15.01 KB 15.07 KB NODE_PROD
react-test-renderer-shallow.development.js +2.4% +2.9% 23.23 KB 23.79 KB 6.29 KB 6.47 KB UMD_DEV
react-test-renderer-shallow.development.js +3.0% +3.5% 18.42 KB 18.98 KB 5.11 KB 5.28 KB NODE_DEV
react-test-renderer-shallow.production.min.js 馃敽+1.2% 馃敽+2.0% 7.77 KB 7.87 KB 2.56 KB 2.61 KB NODE_PROD
ReactTestRenderer-dev.js +0.1% +0.2% 365.01 KB 365.5 KB 77.94 KB 78.11 KB FB_WWW_DEV
ReactShallowRenderer-dev.js +2.9% +3.7% 16.91 KB 17.4 KB 4.42 KB 4.58 KB FB_WWW_DEV

react-reconciler

File Filesize Diff Gzip Diff Prev Size Current Size Prev Gzip Current Gzip ENV
react-reconciler.development.js +0.2% +0.2% 348.89 KB 349.45 KB 75.62 KB 75.8 KB NODE_DEV
react-reconciler.production.min.js 馃敽+0.2% 馃敽+0.3% 47.71 KB 47.81 KB 14.47 KB 14.52 KB NODE_PROD
react-reconciler-persistent.development.js +0.2% +0.3% 347.51 KB 348.07 KB 75.06 KB 75.25 KB NODE_DEV
react-reconciler-persistent.production.min.js 馃敽+0.2% 馃敽+0.3% 47.72 KB 47.82 KB 14.47 KB 14.52 KB NODE_PROD

react-native-renderer

File Filesize Diff Gzip Diff Prev Size Current Size Prev Gzip Current Gzip ENV
ReactNativeRenderer-dev.js +0.1% +0.2% 483.18 KB 483.67 KB 106.8 KB 106.98 KB RN_FB_DEV
ReactNativeRenderer-prod.js 馃敽+0.1% 馃敽+0.2% 214.2 KB 214.51 KB 37.54 KB 37.61 KB RN_FB_PROD
ReactNativeRenderer-dev.js +0.1% +0.2% 482.92 KB 483.4 KB 106.74 KB 106.92 KB RN_OSS_DEV
ReactNativeRenderer-prod.js 馃敽+0.2% 馃敽+0.2% 204.24 KB 204.56 KB 35.92 KB 36 KB RN_OSS_PROD
ReactFabric-dev.js +0.1% +0.2% 473.39 KB 473.88 KB 104.36 KB 104.54 KB RN_FB_DEV
ReactFabric-prod.js 馃敽+0.2% 馃敽+0.2% 195.36 KB 195.67 KB 34.36 KB 34.44 KB RN_FB_PROD
ReactFabric-dev.js +0.1% +0.2% 473.43 KB 473.91 KB 104.38 KB 104.56 KB RN_OSS_DEV
ReactFabric-prod.js 馃敽+0.2% 馃敽+0.2% 195.39 KB 195.71 KB 34.37 KB 34.46 KB RN_OSS_PROD
ReactNativeRenderer-profiling.js +0.2% +0.2% 207.75 KB 208.06 KB 36.62 KB 36.7 KB RN_OSS_PROFILING
ReactFabric-profiling.js +0.2% +0.2% 198.41 KB 198.72 KB 35 KB 35.07 KB RN_OSS_PROFILING
ReactNativeRenderer-profiling.js +0.1% +0.2% 217.67 KB 217.98 KB 38.24 KB 38.31 KB RN_FB_PROFILING
ReactFabric-profiling.js +0.2% +0.2% 198.37 KB 198.68 KB 34.98 KB 35.05 KB RN_FB_PROFILING

Generated by 馃毇 dangerJS

Loading

@gaearon
Copy link
Member

@gaearon gaearon commented Aug 9, 2018

Um apparently this is PROD code path too? I forgot. I'll wrap this in a DEV block since it's non-critical.

Loading

@gaearon
Copy link
Member

@gaearon gaearon commented Aug 9, 2018

Loading

@billyjanitsch billyjanitsch deleted the improve-component-stack branch Aug 9, 2018
TejasQ pushed a commit to TejasQ/react that referenced this issue Aug 26, 2018
* Improve display of filenames in component stack

* Add explanatory comment

* tests: add tests for component stack trace displaying

* Tweak test

* Rewrite test and revert implementation

* Extract a variable

* Rewrite implementation
@gaearon gaearon mentioned this pull request Sep 5, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
6 participants