workbox: [v5.0.0-beta.1] Can't find self.__WB_MANIFEST in your SW source

Your swSrc shows:

precacheAndRoute(__WB_MANIFEST)

By default, you need to use self.__WB_MANIFEST:

precacheAndRoute(self.__WB_MANIFEST)

(Unless you set injectionPoint: '__WB_MANIFEST', like you said.)

Apologies if this specific requirement caught you out while testing the beta releases, especially since we don’t have the documentation in place yet. That’s the default injectionPoint that we’re going with in v5 across all the build tools.

And again, the second error you encountered, once you got the injectionPoint configuration resolved, should be addressed by https://github.com/GoogleChrome/workbox/pull/2251.

I have encountered the same error whilst using webpack-workbox-plugin with the InjectManifest function. Adding literally just self.__WB_MANIFEST to the bottom of my Service Worker file seems to have fixed it. I guess the plugin code expects to find this variable in the file and doesn’t like it when it isn’t there. It seems odd that I need to add this (seemingly useless, since I’m not interested in precaching) piece of boilerplate code into my service worker. Is the plugin really not able to do this? It also isn’t in the documentation anywhere that I’d expect it to be. e.g. https://developers.google.com/web/tools/workbox/guides/precache-files/webpack

workbox-webpack-plugin includes workbox-build as a dependency, and workbox-build includes all those other workbox-* libraries:

https://github.com/GoogleChrome/workbox/blob/dd408f0c17a50fb68cac485133123775c3d4dfc2/packages/workbox-build/package.json#L45-L58

Technically, that should be sufficient, but some package managers (e.g. yarn) are not happy if you rely on transitive dependencies, so explicitly listing the workbox-* libraries that you use as your own dependencies is probably the best bet. They shouldn’t be installed twice into node_modules, as modern package managers know how to deduplicate that as long as the semver ranges match.

Hi @jeffposnick

I’m a bit confused. So when using InjectManifest of workbox-webpack-plugin we will need to npm install workbox libraries (workbox-core, workbox-precaching, workbox-routing …etc)??

Does that mean those will be installed twice (with webpack plugin & separately)?

Is there a way to let workbox-webpack-plugin expose them? Or do I have to install them if I want, for example, to call skipWaiting and clientsClaim() ?

Thanks for the answer. I understand the change. Anyway, I still think, by default, the choice to use the global context should be left to the user as it’s the native javascript behavior

It’s just a part of the service worker

import { precacheAndRoute } from 'workbox-precaching/precacheAndRoute'
import { createHandlerForURL } from 'workbox-precaching/createHandlerForURL'
import { NavigationRoute } from 'workbox-routing/NavigationRoute'
import { registerRoute } from 'workbox-routing/registerRoute'


precacheAndRoute(__WB_MANIFEST)

registerRoute(
  new NavigationRoute(createHandlerForURL('/index.html'))
)

While adapting code developed originally for a CRA setup, I had commented out a whole lot of stuff, including the precacheAndRoute(self.__WB_MANIFEST) line. What is disconcerting is that this doesn’t seem to be causing an error in --mode development, only --mode production, hence me originally thinking it wasn’t required (in spite of the comment in the CRA-generated code).