fix: apply custom serializer to source map endpoint in dev server #1284
+49
−0
Conversation
This file contains 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
facebook-github-bot
added
the
CLA Signed
3 tasks
facebook-github-bot
added
the
Shared with Meta
motiz88
reviewed
Jun 5, 2024
Comment on lines
+1156
to
+1157
| // If the project defines a custom serializer, then we should run it to ensure any | ||
| // mutations to the graph are applied in the sourcemap. |
There was a problem hiding this comment.
It makes sense to me to run the custom serializer consistently (and I vaguely remember seeing cases where this was broken), but what do you mean by "mutations to the graph"? When during bundling do those occur?
There was a problem hiding this comment.
If someone were to preModules.splice(0,0, { ... }) to add a new module inside of a custom serializer, then it would technically mutate the arguments used to generate the bundle. I can think of two cases like this:
There was a problem hiding this comment.
Hmm. The serializer API wasn't designed with side-effectful serializers in mind, and the preModules parameter specifically is typed as being read-only. Is there a way to achieve what you're trying to do without mutating read-only arguments?
There was a problem hiding this comment.
Yeah but it's a little unstable. I'm sniffing if the sourceUrl has a .map pathname to determine if the serializer should return source maps. This works for the .map endpoint, but it doesn't account for /symbolicate where the result is getExplodedSourceMap and not a standard source map string.
EvanBacon
added a commit
to expo/expo
that referenced
this pull request
Jun 6, 2024
…9463) # Why - The source maps are off-by-1 in development and this causes debugging and errors to be janky. - The cause is related to Metro serializing the graph differently in `.map` requests than it does in `.bundle` requests. - Required change in Metro facebook/metro#1284 <!-- Please describe the motivation for this PR, and link to relevant GitHub issues, forums posts, or feature requests. --> # How - Mutate the premodules to try and mitigate issues like this from happening in the future. - Detect when a serialization request is meant for source maps in development, and return the maps from the serializer. This depends on an upstream fix in Metro (if it doesn't land, we can try something else). - [Update]: I've also added a new system (consider existing implementation legacy) which injects a polyfill that is one line long. We then update this polyfill in the serializer accordingly to ensure source maps stay correct, even in cases such as error handling where Metro serializes them a third way. <!-- How did you build this feature or fix this bug and why? --> # Test Plan - Added an E2E dev server test which pings the source maps and detects if the `__env__` module is included. - Physically attached a debugger and ensured that the sources were aligned in development. <!-- Please describe how you tested this change and how a reviewer could reproduce your test, especially if this PR does not include automated tests! If possible, please also provide terminal output and/or screenshots demonstrating your test/reproduction. --> # Checklist <!-- Please check the appropriate items below if they apply to your diff. This is required for changes to Expo modules. --> - [ ] Documentation is up to date to reflect these changes (eg: https://docs.expo.dev and README.md). - [ ] Conforms with the [Documentation Writing Style Guide](https://github.com/expo/expo/blob/main/guides/Expo%20Documentation%20Writing%20Style%20Guide.md) - [ ] This diff will work correctly for `npx expo prebuild` & EAS Build (eg: updated a module plugin). --------- Co-authored-by: Expo Bot <[email protected]>
EvanBacon
added a commit
to expo/expo
that referenced
this pull request
Jun 10, 2024
…9463) # Why - The source maps are off-by-1 in development and this causes debugging and errors to be janky. - The cause is related to Metro serializing the graph differently in `.map` requests than it does in `.bundle` requests. - Required change in Metro facebook/metro#1284 <!-- Please describe the motivation for this PR, and link to relevant GitHub issues, forums posts, or feature requests. --> # How - Mutate the premodules to try and mitigate issues like this from happening in the future. - Detect when a serialization request is meant for source maps in development, and return the maps from the serializer. This depends on an upstream fix in Metro (if it doesn't land, we can try something else). - [Update]: I've also added a new system (consider existing implementation legacy) which injects a polyfill that is one line long. We then update this polyfill in the serializer accordingly to ensure source maps stay correct, even in cases such as error handling where Metro serializes them a third way. <!-- How did you build this feature or fix this bug and why? --> # Test Plan - Added an E2E dev server test which pings the source maps and detects if the `__env__` module is included. - Physically attached a debugger and ensured that the sources were aligned in development. <!-- Please describe how you tested this change and how a reviewer could reproduce your test, especially if this PR does not include automated tests! If possible, please also provide terminal output and/or screenshots demonstrating your test/reproduction. --> # Checklist <!-- Please check the appropriate items below if they apply to your diff. This is required for changes to Expo modules. --> - [ ] Documentation is up to date to reflect these changes (eg: https://docs.expo.dev and README.md). - [ ] Conforms with the [Documentation Writing Style Guide](https://github.com/expo/expo/blob/main/guides/Expo%20Documentation%20Writing%20Style%20Guide.md) - [ ] This diff will work correctly for `npx expo prebuild` & EAS Build (eg: updated a module plugin). --------- Co-authored-by: Expo Bot <[email protected]>
kmagiera
added a commit
to software-mansion/radon-ide
that referenced
this pull request
Oct 22, 2024
This PR fixes a problem with debugger on expo projects, caused by prelude lines added to the entry bundle file added by expo. The solution is t0 add the required offset to the prelude causing the problem and scanning for it when receiving source map in the debuger. It is possible that the changes will no longer be needed in future versions of react native as the expo team tries to correct source map generation to include extra lines, for more information read those PRs: - [expo side ](expo/expo#29463) - [metro side](facebook/metro#1284) This is why we add version check before adding lineOffset to initial source map. ### How Has This Been Tested: - open expo project and set a breakpoint, before the changes it would trigger 2 lines above the place it's been set. - save any change in the file containing breakpoint and make sure it still works. - check if links to files generated next to console logs are pointing in to the correct place, again both before and after making changes to the file. - check if error position indicator (when uncaught exception is raised) points to the correct position. ### Additional changes: This PR also fixes a minor mistake with `getReactNativeVersion` utility that does not need to be async and as it is used, we make it synchronous as part of this PR. --------- Co-authored-by: Krzysztof Magiera <[email protected]>
Apple0717
added a commit
to Apple0717/radon
that referenced
this pull request
Nov 30, 2024
This PR fixes a problem with debugger on expo projects, caused by prelude lines added to the entry bundle file added by expo. The solution is t0 add the required offset to the prelude causing the problem and scanning for it when receiving source map in the debuger. It is possible that the changes will no longer be needed in future versions of react native as the expo team tries to correct source map generation to include extra lines, for more information read those PRs: - [expo side ](expo/expo#29463) - [metro side](facebook/metro#1284) This is why we add version check before adding lineOffset to initial source map. ### How Has This Been Tested: - open expo project and set a breakpoint, before the changes it would trigger 2 lines above the place it's been set. - save any change in the file containing breakpoint and make sure it still works. - check if links to files generated next to console logs are pointing in to the correct place, again both before and after making changes to the file. - check if error position indicator (when uncaught exception is raised) points to the correct position. ### Additional changes: This PR also fixes a minor mistake with `getReactNativeVersion` utility that does not need to be async and as it is used, we make it synchronous as part of this PR. --------- Co-authored-by: Krzysztof Magiera <[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
buildfunction. In the Expo metro-config, we use the serializer to inject custom pre-modules for things like SSR and client-side environment variables. These changes aren't reflected in the source map endpoint.Changelog: [Fix] Apply custom serializer to source map graph in
.mapendpoint.