-
-
Notifications
You must be signed in to change notification settings - Fork 483
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
fix: improve the worker integrity warning #2091
Merged
Merged
Changes from all commits
Commits
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 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 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 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,34 @@ | ||
import { devUtils } from '~/core/utils/internal/devUtils' | ||
import type { SetupWorkerInternalContext } from '../setupWorker/glossary' | ||
|
||
/** | ||
* Check whether the registered Service Worker has been | ||
* generated by the installed version of the library. | ||
* Prints a warning message if the worker scripts mismatch. | ||
*/ | ||
export async function checkWorkerIntegrity( | ||
context: SetupWorkerInternalContext, | ||
): Promise<void> { | ||
// Request the integrity checksum from the registered worker. | ||
context.workerChannel.send('INTEGRITY_CHECK_REQUEST') | ||
|
||
const { payload } = await context.events.once('INTEGRITY_CHECK_RESPONSE') | ||
|
||
// Compare the response from the Service Worker and the | ||
// global variable set during the build. | ||
|
||
// The integrity is validated based on the worker script's checksum | ||
// that's derived from its minified content during the build. | ||
// The "SERVICE_WORKER_CHECKSUM" global variable is injected by the build. | ||
if (payload.checksum !== SERVICE_WORKER_CHECKSUM) { | ||
devUtils.warn( | ||
`The currently registered Service Worker has been generated by a different version of MSW (${payload.packageVersion}) and may not be fully compatible with the installed version. | ||
|
||
It's recommended you update your worker script by running this command: | ||
|
||
\u2022 npx msw init <PUBLIC_DIR> | ||
|
||
You can also automate this process and make the worker script update automatically upon the library installations. Read more: https://mswjs.io/docs/cli/init.`, | ||
) | ||
} | ||
} |
This file was deleted.
Oops, something went wrong.
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
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
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.
Send the MSW version used to generate the worker script in this message to have a better warning.