feat(module-federation): improve console output for remote build errors #26711
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎ 1 Ignored Deployment
|
☁️ Nx Cloud ReportCI is running/has finished running commands for commit eea60a3. As they complete they will appear below. Click to see the status, the terminal output, and the build insights. 📂 See all runs for this CI Pipeline Execution ✅ Successfully ran 6 targets
Sent with 💌 from NxCloud. |
|
Hi @FrozenPandaz & @ndcunningham. I know this is a low priority change, but would appreciate any feedback either of you have on it. It's a great quality of life improvement on surfacing errors. If there are no concerns with the changes, then will update the branch with latest |
Coly010
approved these changes
Jul 24, 2024
ndcunningham
pushed a commit
that referenced
this pull request
Jul 24, 2024
…rs (#26711) ## Current Behavior When running `nx serve` for a module federation application, if one of the static remotes fail you get output that looks as such ``` > nx run shell:serve:development NX Starting module federation dev-server for shell with 13 remotes NX Building 13 static remotes... /<user-path>/node_modules/@nx/react/src/executors/module-federation-dev-server/module-federation-dev-server.impl.js:140 throw new Error(`Remote failed to start. A complete log can be found in: ${remoteBuildLogFile}`); ^ Error: Remote failed to start. A complete log can be found in: /<user-path>/.nx/workspace-data/2024-06-26T21_21_37_744Z-build.log at ChildProcess.<anonymous> (/<user-path>/node_modules/@nx/react/src/executors/module-federation-dev-server/module-federation-dev-server.impl.js:140:23) at Object.onceWrapper (node:events:632:26) at ChildProcess.emit (node:events:517:28) at Process.ChildProcess._handle.onexit (node:internal/child_process:292:12) Node.js v18.20.3 —————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————— NX Running target serve for project shell failed ``` The cause of the failure is not immediately obvious. The output is cryptic and seems like a fatal error occurred, not one from the project source code. The failure could happen for many reasons such as updating a package that is not compatible with all remotes. ## Expected Behavior With the changes proposed in this PR, we get a much more improved output that's easier to read and much more obvious what happened in the project source code. 1. Replace the `throw` statement with a promise rejection which outputs a clean Nx Error 2. When an error is detected from webpack, output that snippet directly into the console. No need to open and scroll through the entire log file searching for the error. ``` NX Starting module federation dev-server for shell with 13 remotes NX Building 13 static remotes... m (id hint: vendors) 134 KiB [rendered] reused as split chunk (cache group: defaultVendors) chunk (runtime: mover) 8762.js 13.4 KiB [rendered] chunk (runtime: mover) 8798.js 14.9 KiB [rendered] chunk (runtime: mover) 8802.js (id hint: vendors) 20.1 KiB [rendered] reused as split chunk (cache group: defaultVendors) chunk (runtime: mover) 8930.js (id hint: vendors) 121 KiB [rendered] split chunk (cache group: defaultVendors) chunk (runtime: mover) 8974.css, 8974.js 150 KiB (javascript) 252 bytes (consume-shared) 25.6 KiB (css/mini-extract) [rendered] chunk (runtime: mover) 42 bytes reused as split chunk (cache group: default) chunk (runtime: mover) 9199.js 17.4 KiB [rendered] chunk (runtime: mover) 9227.js 7.02 KiB [rendered] chunk (runtime: mover) 9241.js 10.7 KiB [rendered] chunk (runtime: mover) 9279.js (id hint: vendors) 209 KiB [rendered] split chunk (cache group: defaultVendors) chunk (runtime: mover) 9289.js (id hint: vendors) 228 KiB [rendered] reused as split chunk (cache group: defaultVendors) chunk (runtime: mover) 9354.js 15 bytes [rendered] chunk (runtime: mover) 9356.js 14.5 KiB [rendered] chunk (runtime: mover) 9426.js (id hint: vendors) 26.8 KiB [rendered] reused as split chunk (cache group: defaultVendors) chunk (runtime: mover) 9500.js 1.05 KiB [rendered] chunk (runtime: mover) 9637.js 78.1 KiB (javascript) 84 bytes (consume-shared) [rendered] reused as split chunk (cache group: default) chunk (runtime: mover) 9716.js (id hint: vendors) 59.5 KiB [rendered] split chunk (cache group: defaultVendors) chunk (runtime: mover) 9807.js 16.2 KiB [rendered] chunk (runtime: mover) 9888.js 7.42 KiB [rendered] ERROR in ./apps/app1/src/../../../index.tsx:20:20 TS2322: Type '"foo"' is not assignable to type 'Tones'. 18 | return ( 19 | <div data-component-id="Banner"> > 20 | <ComponentA tone={'foo'} > | ^^^^ 21 | <div className="space-y-2"> 22 | <div className="pr-2"> webpack compiled with 1 error (bd60f37cf54db8e4) NX Remote failed to start. A complete log can be found in: /<user-path>/.nx/workspace-data/2024-06-26T21_27_40_438Z-build.log —————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————— NX Running target serve for project shell failed ``` ## Related Issue(s) N/A Co-authored-by: Hancock, Matthew <[email protected]>
FrozenPandaz
pushed a commit
that referenced
this pull request
Jul 24, 2024
…rs (#26711) ## Current Behavior When running `nx serve` for a module federation application, if one of the static remotes fail you get output that looks as such ``` > nx run shell:serve:development NX Starting module federation dev-server for shell with 13 remotes NX Building 13 static remotes... /<user-path>/node_modules/@nx/react/src/executors/module-federation-dev-server/module-federation-dev-server.impl.js:140 throw new Error(`Remote failed to start. A complete log can be found in: ${remoteBuildLogFile}`); ^ Error: Remote failed to start. A complete log can be found in: /<user-path>/.nx/workspace-data/2024-06-26T21_21_37_744Z-build.log at ChildProcess.<anonymous> (/<user-path>/node_modules/@nx/react/src/executors/module-federation-dev-server/module-federation-dev-server.impl.js:140:23) at Object.onceWrapper (node:events:632:26) at ChildProcess.emit (node:events:517:28) at Process.ChildProcess._handle.onexit (node:internal/child_process:292:12) Node.js v18.20.3 —————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————— NX Running target serve for project shell failed ``` The cause of the failure is not immediately obvious. The output is cryptic and seems like a fatal error occurred, not one from the project source code. The failure could happen for many reasons such as updating a package that is not compatible with all remotes. ## Expected Behavior With the changes proposed in this PR, we get a much more improved output that's easier to read and much more obvious what happened in the project source code. 1. Replace the `throw` statement with a promise rejection which outputs a clean Nx Error 2. When an error is detected from webpack, output that snippet directly into the console. No need to open and scroll through the entire log file searching for the error. ``` NX Starting module federation dev-server for shell with 13 remotes NX Building 13 static remotes... m (id hint: vendors) 134 KiB [rendered] reused as split chunk (cache group: defaultVendors) chunk (runtime: mover) 8762.js 13.4 KiB [rendered] chunk (runtime: mover) 8798.js 14.9 KiB [rendered] chunk (runtime: mover) 8802.js (id hint: vendors) 20.1 KiB [rendered] reused as split chunk (cache group: defaultVendors) chunk (runtime: mover) 8930.js (id hint: vendors) 121 KiB [rendered] split chunk (cache group: defaultVendors) chunk (runtime: mover) 8974.css, 8974.js 150 KiB (javascript) 252 bytes (consume-shared) 25.6 KiB (css/mini-extract) [rendered] chunk (runtime: mover) 42 bytes reused as split chunk (cache group: default) chunk (runtime: mover) 9199.js 17.4 KiB [rendered] chunk (runtime: mover) 9227.js 7.02 KiB [rendered] chunk (runtime: mover) 9241.js 10.7 KiB [rendered] chunk (runtime: mover) 9279.js (id hint: vendors) 209 KiB [rendered] split chunk (cache group: defaultVendors) chunk (runtime: mover) 9289.js (id hint: vendors) 228 KiB [rendered] reused as split chunk (cache group: defaultVendors) chunk (runtime: mover) 9354.js 15 bytes [rendered] chunk (runtime: mover) 9356.js 14.5 KiB [rendered] chunk (runtime: mover) 9426.js (id hint: vendors) 26.8 KiB [rendered] reused as split chunk (cache group: defaultVendors) chunk (runtime: mover) 9500.js 1.05 KiB [rendered] chunk (runtime: mover) 9637.js 78.1 KiB (javascript) 84 bytes (consume-shared) [rendered] reused as split chunk (cache group: default) chunk (runtime: mover) 9716.js (id hint: vendors) 59.5 KiB [rendered] split chunk (cache group: defaultVendors) chunk (runtime: mover) 9807.js 16.2 KiB [rendered] chunk (runtime: mover) 9888.js 7.42 KiB [rendered] ERROR in ./apps/app1/src/../../../index.tsx:20:20 TS2322: Type '"foo"' is not assignable to type 'Tones'. 18 | return ( 19 | <div data-component-id="Banner"> > 20 | <ComponentA tone={'foo'} > | ^^^^ 21 | <div className="space-y-2"> 22 | <div className="pr-2"> webpack compiled with 1 error (bd60f37cf54db8e4) NX Remote failed to start. A complete log can be found in: /<user-path>/.nx/workspace-data/2024-06-26T21_27_40_438Z-build.log —————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————— NX Running target serve for project shell failed ``` ## Related Issue(s) N/A Co-authored-by: Hancock, Matthew <[email protected]> (cherry picked from commit 92eb1fa)
This was referenced Jul 26, 2024
|
This pull request has already been merged/closed. If you experience issues related to these changes, please open a new issue referencing this pull request. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Current Behavior
When running
nx servefor a module federation application, if one of the static remotes fail you get output that looks as suchThe cause of the failure is not immediately obvious. The output is cryptic and seems like a fatal error occurred, not one from the project source code. The failure could happen for many reasons such as updating a package that is not compatible with all remotes.
Expected Behavior
With the changes proposed in this PR, we get a much more improved output that's easier to read and much more obvious what happened in the project source code.
throwstatement with a promise rejection which outputs a clean Nx ErrorRelated Issue(s)
N/A