Add preLoadModules option to import modules on main thread #1777
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
dherault
requested changes
Aug 17, 2024
|
I've added an explanation document about the cli parameter in the README. Could you please check this again? @dherault |
|
I will merge this soon, sorry for the delay. |
dherault
added a commit
that referenced
this pull request
Aug 30, 2024
Add preLoadModules option to import modules on main thread
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.
Description
This commit adds 'preLoadModules' option that allows the main thread to load specified modules.
Motivation and Context
Some Node.js modules, such as 'sharp', are not safe to use with worker threads. Importing them in a worker thread can lead to crashes. There are several reported issues regarding this, for example, see:
#1603
And 'sharp' recommends importing the module on the main thread to prevent such problems.
lovell/sharp#2263 (comment)
While the 'useInProcess' option allows us to avoid using threading, it also disables hot reloading, which significantly reduces convenience. This commit implements the 'preLoadModules' option (e.g., preLoadModules: "sharp, canvas") to import these modules before creating worker threads.
How Has This Been Tested?
I've tested in my own project using serverless offline, and also conducted tests with Mocha in this repository.