feat(gatsby-plugin-offline): Allow appending custom scripts to sw.js

[vtenfys]

No description provided.

[vtenfys]

@pieh should be ready to merge now!

[sidharthachatterjee]

What do you think of wrapping this in a try catch here and printing a friendly error if the file doesn't exist? Definitely not a blocker for this PR though.

[vtenfys]

Agreed, I'll implement this change

[vtenfys]

ok, just done this!

[sidharthachatterjee]

Left a few comments but overall looks great, @davidbailey00! 👍

[pieh]

I was just checking some docs - and was wondering if we could just document how to use importScripts workbox config options instead of implementing our custom one?

[m-allanson]

@davidbailey00 if it's possible to use workbox's importScripts, let's close this PR and create a separate issue.

[KyleAMathews]

It was introduced in Workbox 4.3

[KyleAMathews]

So we can't use it since we're on v3 still.

[m-allanson]

Would it be worth updating to workbox 4 instead of doing this?

[vtenfys]

Hmm we could use the Workbox option - it wouldn't just be a one-stop operation though, since we would need to insert the content hash into the filename for any custom scripts this way and then modify the filenames in the config to match, so the first version is not cached forever. The approach taken in this PR instead inserts the custom code into the sw.js file itself. I think either way would work fine, so perhaps it would be best to upgrade Workbox and use the new option after all rather than an API breaking change?

[pieh]

Hmm we could use the Workbox option - it wouldn't just be a one-stop operation though, since we would need to insert the content hash into the filename for any custom scripts this way and then modify the filenames in the config to match, so the first version is not cached forever

Maybe we could do this on user behalf if importScripts was used (i.e. rename file to attach content hash and send renamed filename to workbox)? Not sure if this wouldn't be confusing tho. Or even just completely took over importScripts option and do what is currently done in this PR and strip that field from options passed to workbox?

[m-allanson]

Moving this out of "In Progress" for now. We can circle back to it.

[sidharthachatterjee]

Looks good! Thank you so much for wrapping this up @davidbailey00 🥇

[sidharthachatterjee]

👍

[sidharthachatterjee]

Need to fix these

The 'dontCacheBustUrlsMatching' option has been renamed to 'dontCacheBustURLsMatching'. Please update your config. 'dontCacheBustUrlsMatching' is now deprecated and will be removed in a future release of Workbox.
The 'modifyUrlPrefix' option has been renamed to 'modifyURLPrefix'. Please update your config. 'modifyUrlPrefix' is now deprecated and will be removed in a future release of Workbox.
Specifying 'cacheFirst'' in a 'runtimeCaching[].handler' option is deprecated. Please update your config to use 'CacheFirst' instead. In v4 Workbox strategies are now classes instead of functions.
Specifying 'networkFirst'' in a 'runtimeCaching[].handler' option is deprecated. Please update your config to use 'NetworkFirst' instead. In v4 Workbox strategies are now classes instead of functions.
Specifying 'staleWhileRevalidate'' in a 'runtimeCaching[].handler' option is deprecated. Please update your config to use 'StaleWhileRevalidate' instead. In v4 Workbox strategies are now classes instead of functions.
Specifying 'staleWhileRevalidate'' in a 'runtimeCaching[].handler' option is deprecated. Please update your config to use 'StaleWhileRevalidate' instead. In v4 Workbox strategies are now classes instead of functions.

[sidharthachatterjee]

This is good to go and we will publish it on Monday!

[sidharthachatterjee]

Running this on org and posting a build url here in a bit

[sidharthachatterjee]

Looks like this works great on https://gatsby-org-offline3-test.netlify.com/

[sidharthachatterjee]

Thanks for working on this! 💃

[vtenfys]

Published in gatsby-plugin-offline@3.0.0 🎉