[docs] Add precaching Service Worker to exported docs builds #10267
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
| @@ -242,6 +242,12 @@ function withRoot(Component) { | |||
| }; | |||
| } | |||
|
|
|||
| componentDidMount() { | |||
| if ('serviceWorker' in navigator) { | |||
| navigator.serviceWorker.register('/service-worker.js'); | |||
There was a problem hiding this comment.
I'm gonna use sw.js as the convention.
There was a problem hiding this comment.
|
@msiadak Hold on. I'm making some changes :) |
|
My bad, will stand by. Thanks for reviewing! |
|
@msiadak Alright, I'm pretty happy with this pull-request. The documentation now works offline. It's huge. |
mbrookes
approved these changes
Feb 15, 2018
|
@msiadak Thank you. |
caub
pushed a commit
to caub/material-ui
that referenced
this pull request
Feb 15, 2018
* Add service worker to exported docs builds * push forward
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.
Closes #9529
Given that we're deploying a static export of the docs website to Firebase, I think we only need to create a service worker for that case rather than trying to address the builds served with the
docs:devanddocs:startscripts.To accomplish this I used the new beta (v3.0.0-beta.0) of Workbox to crawl the docs/export directory and inject a manifest of the exported files into a simple Service Worker template. I wrapped this action in a new npm script:
docs:build-swthat I added into thedocs:exportscript. If we decide that we want to do something more complex with the Service Worker in the future, I think this can provide a decent starting point.Before taking this approach, I looked into some of the other known methods for automating service workers with next.js, but I wasn't able to get any of them working for the static export case without also using a method like the one in this PR.
I was able to get all of the PWA audits on Lighthouse to pass with this configuration with the exception of the https-related ones, although those should be covered by Firebase hosting.