Add optional warmup prop and bump docxodus to 6.2.0#20
Merged
Conversation
Bump docxodus to ^6.2.0 and refresh bundled WASM files. Expose an optional `warmup` boolean prop on DocumentViewer that eagerly calls the worker's new `prepare()` API on mount, pre-warming the comparison code path so the first comparison avoids the ~3s assembly-load latency. The prop is a no-op in non-worker mode. Bump peer dependency to docxodus >=6.2 and release v0.6.0.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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
docxodusto^6.2.0and refresh the bundled WASM files inpublic/wasm.warmupboolean prop onDocumentViewer. Whentrue, the viewer eagerly calls the worker's newprepare()API once the worker is ready, pre-warming the .NET comparison assemblies so the firstcompareDocumentsavoids the ~3s assembly-load latency. The call is idempotent and fire-and-forget (warmup failures never surface as viewer errors).warmuponly applies in worker mode (useWorkertrue, the default); it is a no-op whenuseWorker={false}, sinceprepare()only exists on the worker.docxoduspeer dependency to>=6.2.v0.6.0(minor bump).Tests
Added three tests covering the new prop (mocking
docxodus/worker):warmupis unsetprepare()once whenwarmupis set in worker modeprepare()call, no crash) in non-worker modenpm test(33 passed),npm run lint(clean), andnpm run buildall pass.