-
Notifications
You must be signed in to change notification settings - Fork 39
fix(cloudxr): sync and serve webpack lazy chunks for OOB static client #684
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
gareth-morgan-nv
wants to merge
6
commits into
main
Choose a base branch
from
gmorgan/MultipleChunks
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
5796483
Support multiple chunks for bundle loading
gareth-morgan-nv ca93cb8
Run lint
gareth-morgan-nv 1c2914d
PR comments
gareth-morgan-nv f8c4236
Go to just one extra bundle
gareth-morgan-nv a2d84e6
Simplify OOB changes
gareth-morgan-nv ad55dd7
Address PR review findings
gareth-morgan-nv File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,113 @@ | ||
| /* | ||
| * SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| * | ||
| * Human-readable chunk names for production builds. | ||
| * | ||
| * Target layout (two JS artifacts): | ||
| * - ``bundle.js`` — main application (UIKit, MSDF text, Lucide icons, runtime) | ||
| * - ``bundle.emulator.js`` — desktop XR / IWER code (DevUI, SEM scenes, deps) | ||
| * | ||
| * MSDF is pulled into the main entry (see ``webpack.common.js``) so in-VR text | ||
| * does not depend on extra lazy chunks over OOB. The MSDF web worker is inlined | ||
| * via ``asset/inline`` (data URL) so no separate worker file is emitted. | ||
| * | ||
| * Lazy boundary: ``@pmndrs/xr`` ``import('./emulate.js')`` → ``bundle.emulator.js``. | ||
| * OOB/--host-client sync downloads ``index.html``, ``bundle.js``, and | ||
| * ``bundle.emulator.js``. | ||
| */ | ||
|
|
||
| const path = require('path'); | ||
|
|
||
| /** Only non-main async chunk basename. */ | ||
| const EMULATOR_CHUNK = 'emulator'; | ||
|
|
||
| /** | ||
| * True when *resource* belongs in the single IWER / desktop-emulator async chunk. | ||
| * | ||
| * @param {string | undefined} resource Webpack module resource path. | ||
| * @returns {boolean} | ||
| */ | ||
| function isEmulatorAsyncModule(resource = '') { | ||
| if (!resource) { | ||
| return false; | ||
| } | ||
| if (/[\\/]@pmndrs[\\/]xr[\\/]dist[\\/]emulate/.test(resource)) { | ||
| return true; | ||
| } | ||
| if (/[\\/]node_modules[\\/]iwer[\\/]lib/.test(resource)) { | ||
| return true; | ||
| } | ||
| if (/[\\/]node_modules[\\/]@iwer[\\/]/.test(resource)) { | ||
| return true; | ||
| } | ||
| if (/[\\/]node_modules[\\/](?:styled-components|stylis|@fortawesome|gl-matrix)/.test(resource)) { | ||
| return true; | ||
| } | ||
| if ( | ||
| /[\\/]node_modules[\\/](?:prop-types|@bufbuild[\\/]protobuf|scheduler|webxr-layers-polyfill)/.test( | ||
| resource | ||
| ) | ||
| ) { | ||
| return true; | ||
| } | ||
| return false; | ||
| } | ||
|
|
||
| /** @type {import('webpack').Configuration['optimization']} */ | ||
| const chunkOptimization = { | ||
| chunkIds: 'named', | ||
| splitChunks: { | ||
| chunks: 'async', | ||
| cacheGroups: { | ||
| default: false, | ||
| defaultVendors: false, | ||
| emulator: { | ||
| test: module => isEmulatorAsyncModule(module.resource), | ||
| name: EMULATOR_CHUNK, | ||
| chunks: 'async', | ||
| enforce: true, | ||
| }, | ||
| }, | ||
| }, | ||
| }; | ||
|
|
||
| /** @type {import('webpack').Configuration['output']['chunkFilename']} */ | ||
| function chunkFilename(pathData) { | ||
| const name = pathData.chunk?.name; | ||
| if (name === EMULATOR_CHUNK) { | ||
| return 'bundle.emulator.js'; | ||
| } | ||
| const id = String(pathData.chunk?.id ?? 'unknown'); | ||
| throw new Error( | ||
| `Unexpected async chunk "${id}" (name=${name ?? ''}). ` + | ||
| 'Only bundle.emulator.js is allowed besides bundle.js. ' + | ||
| 'Update webpack.common.js entry or webpack.chunkNames.js.' | ||
| ); | ||
| } | ||
|
|
||
| /** | ||
| * Keep MSDF in ``bundle.js``: ``@pmndrs/uikit`` dynamically imports | ||
| * ``@zappar/msdf-generator``, which would otherwise become a third lazy chunk. | ||
| */ | ||
| const msdfGeneratorEntry = path.resolve( | ||
| __dirname, | ||
| 'node_modules/@zappar/msdf-generator/dist/index.js' | ||
| ); | ||
|
|
||
| /** Inline MSDF worker as a data URL inside ``bundle.js`` (no extra worker file). */ | ||
| const msdfInlineRules = { | ||
| rules: [ | ||
| { | ||
| test: /[\\/]@zappar[\\/]msdf-generator[\\/]dist[\\/]worker\.js$/, | ||
| type: 'asset/inline', | ||
| }, | ||
| ], | ||
| }; | ||
|
|
||
| module.exports = { | ||
| chunkFilename, | ||
| chunkOptimization, | ||
| msdfGeneratorEntry, | ||
| msdfInlineRules, | ||
| }; |
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 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 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 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 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 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 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 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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I felt the description here is not needed (hidden from robotics/teleop people)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Note
This response was drafted by AI (Claude) on behalf of the author.
Agreed — removed the implementation-detail paragraphs (the two-bundle rationale and
asyncChunkswarning). Thebuild_from_sourcedoc now just shows the commands.