-
Notifications
You must be signed in to change notification settings - Fork 16
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: catch sw precaching errors [DHIS2-15625] #812
Open
KaiVandivier
wants to merge
7
commits into
master
Choose a base branch
from
dhis2-15625-catch-sw-precaching-errors
base: master
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.
+246
−30
Open
Changes from 6 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
48d3ddb
fix: catch precaching errors in workbox-precaching
KaiVandivier 4d1be2f
chore: add some materials to test SW precaching in dev mode (wip)
KaiVandivier 2207af2
fix: add app version to sw env
KaiVandivier d3a09cb
fix: add thorough error message
KaiVandivier be95c41
refactor: improve error message
KaiVandivier 5341289
chore: make testing easier by guaranteeing precaching failures
KaiVandivier 5c57496
refactor: simplify precaching
KaiVandivier 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,57 @@ | ||
| diff --git a/node_modules/workbox-precaching/PrecacheController.js b/node_modules/workbox-precaching/PrecacheController.js | ||
| index e00975e..b728b6a 100644 | ||
| --- a/node_modules/workbox-precaching/PrecacheController.js | ||
| +++ b/node_modules/workbox-precaching/PrecacheController.js | ||
| @@ -150,6 +150,7 @@ class PrecacheController { | ||
| return waitUntil(event, async () => { | ||
| const installReportPlugin = new PrecacheInstallReportPlugin(); | ||
| this.strategy.plugins.push(installReportPlugin); | ||
| + const failedUrls = [] | ||
| // Cache entries one at a time. | ||
| // See https://github.com/GoogleChrome/workbox/issues/2528 | ||
| for (const [url, cacheKey] of this._urlsToCacheKeys) { | ||
| @@ -164,12 +165,43 @@ class PrecacheController { | ||
| params: { cacheKey }, | ||
| request, | ||
| event, | ||
| - })); | ||
| + })) | ||
| + // DHIS2: Catch precaching errors to provide a more thorough | ||
| + // error message | ||
| + .catch(err => { | ||
| + failedUrls.push(url) | ||
| + console.error(`Error when attempting to fetch and cache URL ${url}:\n`, err) | ||
| + }); | ||
| } | ||
| const { updatedURLs, notUpdatedURLs } = installReportPlugin; | ||
| if (process.env.NODE_ENV !== 'production') { | ||
| printInstallDetails(updatedURLs, notUpdatedURLs); | ||
| } | ||
| + // DHIS2: Log failed requests to give clear feedback, and throw | ||
| + // error to abort installation | ||
| + if (failedUrls.length > 0) { | ||
| + const appVersion = process.env.REACT_APP_DHIS2_APP_VERSION | ||
| + const appName = process.env.REACT_APP_DHIS2_APP_NAME | ||
| + const errorMessage = | ||
| + `The following assets were unable to be precached when ` + | ||
| + `attempting to install ${appName} version ${appVersion}, ` + | ||
| + `so the installation has been aborted:\n` + | ||
| + `${failedUrls.reduce((acc, curr) => acc + ` * ${curr}\n`, '')}\n` + | ||
| + `If another version of the app is installed in the browser, ` + | ||
| + `you will continue to see that version. If not, you will ` + | ||
| + `see version ${appVersion}, but caching and offline ` + | ||
| + `features will be unavailable, and the app may not be ` + | ||
| + `fully functional due to the missing files. You can find ` + | ||
| + `the app version that's currently active at the bottom ` + | ||
| + `of the user profile menu.\n\n` + | ||
| + `[FOR TECHNICAL USERS]: If another version is installed ` + | ||
| + `and you would like to attempt to view version ` + | ||
| + `${appVersion} (knowing the above caveats), you may use ` + | ||
| + `your browser's developer tools to find the service worker ` + | ||
| + `that's currently active for this app and unregister it.` | ||
| + throw new Error(errorMessage) | ||
| + } | ||
| + | ||
| return { updatedURLs, notUpdatedURLs }; | ||
| }); | ||
| } |
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.
This is included here to show an example of another approach to catching & handling precaching errors (option 2 in the main PR comment)