A Beginner's Guide to Workbox For Webpack

A Beginner's Guide to Workbox For Webpack

Get Started With Workbox For Webpack

In this codelab, you use Workbox to make a simple web app work offline.

If you'd like a conceptual overview of Workbox before starting this tutorial, see the overview.

Step 1: Set up your project

The project that you're going to add Workbox to is hosted on Glitch. First, you need to set up Glitch so that you can edit your own copy of the project.

1 - Open the demo.

2 - Figure 1. The starting point demo, hosted on Glitch

3 - Click workbox-webpack at the top-left of the page. The Project info and options dropdown appears.

4 - Click Remix This. Your browser redirects to an editable copy of the project.

Try out the initial app

The client-side JavaScript in the app fetches the top 10 Hacker News (HN) articles, and then populates the HTML with the content.

Note: This tutorial uses Google Chrome and Chrome DevTools to demonstrate how the web app behaves when offline. You can use any browser that supports service workers.

1- Click Show. The live app appears in a new tab.

Figure 2. The live appIn the tab that's running the live app, press Command+Option+J (Mac) or Control+Shift+J (Windows, Linux) to open DevTools.

2 - In the tab that's running the live app, press Command+Option+J (Mac) or Control+Shift+J (Windows, Linux) to open DevTools.

3 - Focus DevTools and press Command+Shift+P (Mac) or Control+Shift+P (Windows, Linux) to open the Command Menu.

4 - Type Offline, select Go offline, then press Enter. Google Chrome now has no connection to the Internet in this tab.

Figure 3. The Go Offline command

5 - Reload the page. Google Chrome says that you're offline. In other words, the app doesn't work at all when offline.

Figure 4. The initial app doesn't work at all when offline

6 - Open the Command Menu again, type Online, and select Go online to restore your internet connection in this tab.

Step 2: Install Workbox

Next, you're going to add Workbox to the project to enable an offline experience.

  1. Re-focus the tab that shows you the source code of the project.
  2. Click package.json to open that file.
  3. Click Add package.
  4. Type workbox-webpack-plugin within the Add Package text box, then click on the matching package to add it to the project.
  5. Note: This is equivalent to running npm install workbox-webpack-plugin. In your own projects, you'll probably want to save Workbox as a development dependency instead by running npm install workbox-webpack-plugin --save-dev, since workbox-webpack-plugin is a build-time tool.

Figure 5. Adding the workbox-webpack-plugin package

Every time you make a change to your code, Glitch automatically re-builds and re-deploys your app. The tab running the live app automatically refreshes, too.

Step 3: Add Workbox to your Webpack build process

Workbox is installed, but you're not using it in your webpack build process, yet.

1 - Click webpack.config.js to open that file.

2 - Import the Workbox plugin. The bold code is the code that you need to add to your project.

const path = require('path'),
    htmlPlugin = require('html-webpack-plugin'),
    cleanPlugin = require('clean-webpack-plugin'),
    dist = 'dist',
    workboxPlugin = require('workbox-webpack-plugin');

3 - Call the Workbox plugin as the last step in plugins.

plugins: [
  new cleanPlugin([dist]),
  new htmlPlugin({
    filename: 'index.html',
    title: 'Get Started With Workbox For Webpack'
  }),
  new workboxPlugin.GenerateSW({
    swDest: 'sw.js',
    clientsClaim: true,
    skipWaiting: true,
  })
]

Optional: How the config works

webpack.config.js determines how the app is built.

  • cleanPlugin deletes dist, which is the path to the output directory.
  • htmlPlugin re-generates the HTML output and places it back in dist.
  • workboxPlugin.GenerateSW knows about the assets bundled by webpack, and generates service worker code for caching those files. Since Workbox revisions each file based on its contents, Workbox should always be the last plugin you call.

The object that you pass to workboxPlugin.GenerateSW configures how Workbox runs.

  • swDest is where Workbox outputs the service worker that it generates. The parent directory for this file will be based on your output.path webpack configuration.
  • clientsClaim instructs the latest service worker to take control of all clients as soon as it's activated. See clients.claim.
  • skipWaiting instructs the latest service worker to activate as soon as it enters the waiting phase. See Skip the waiting phase.
Step 4: Register and inspect the generated service worker

Workbox has generated a service worker, but there's no reference to it from your app, yet.

1 - Click src/app.js to open that file.

2 - Register your service worker at the bottom of init().

function init() {
  ...
  if ('serviceWorker' in navigator) {
    window.addEventListener('load', () => {
      navigator.serviceWorker.register('/sw.js').then(registration => {
        console.log('SW registered: ', registration);
      }).catch(registrationError => {
        console.log('SW registration failed: ', registrationError);
      });
    });
  }
}

3 - Re-focus the tab that's running the live version of your app. In the DevTools Console you see a message indicating that the service worker was registered.

4 - Click the Application tab of DevTools.

5 - Click the Service Workers tab.

Figure 6. The Service Workers pane

6 - Click sw.js, next to Source. DevTools displays the service worker code that Workbox generated. It should look close to this:

Figure 7. The generated service worker code

Try out the offline-capable app

Your app now sort-of works offline. Try it now:

1 - In the live version of your app, use DevTools to go offline again. Focus DevTools and press Command+Shift+P (Mac) or Control+Shift+P (Windows, Linux) to open the Command Menu. Type Offline, select Go offline, then press Enter.

2 - Reload the page. The title of the page appears, but the list of the top 10 stories doesn't.

3 - Click the Network tab in DevTools. The request for topstories.json is red, meaning that it failed. This is why the list isn't appearing. The app tries to make a request for <a href="https://hacker-news.firebaseio.com/v0/topstories.json" target="_blank">https://hacker-news.firebaseio.com/v0/topstories.json</a>, but the request fails since you're offline and you haven't instructed Workbox to cache this resource, yet.

Figure 8. The incomplete offline experience

4 - Use the Command Menu in DevTools to go back online.

Optional: How the service worker code works

The service worker code is generated based on your Workbox configuration.

  • importScripts('<a href="https://storage.googleapis.com/workbox-cdn/releases/4.3.1/workbox-sw.js');" target="_blank">https://storage.googleapis.com/workbox-cdn/releases/4.3.1/workbox-sw.js');</a> imports Workbox's service worker library. You can inspect this file from the Sources panel of DevTools.

Figure 9. The code for Workbox's service worker library

  • The self.__precacheManifest array lists all of the resources that Workbox is precaching.
  • Each resource has a revision property. This is how Workbox determines when to update a resource. Each time you build your app, Workbox generates a hash based on the contents of the resource. If the contents change, then the revision hash changes.
  • When the service worker runs, it writes the url and revision of each resource to IndexedDB (IDB) if it doesn't exist. If the resource does exist, the service worker checks that the revision in its code matches the revision in IDB. If the hashes don't match, then the resource has changed, and therefore the service worker needs to download the updated resource and update the hash in IDB.

In sum, Workbox only re-downloads resources when they change, and ensures that your app always caches the most up-to-date version of each resource.

Step 5: Add runtime caching

Runtime caching lets you store content that's not under your control when your app requests it at runtime. For example, by runtime caching the Hacker News content which this app relies on, you'll be able to provide an improved offline experience for your users. When users visit the app while offline, they'll be able to see the content from the last time that they had an internet connection.

  1. Re-focus the tab that shows you the source code of your project.
  2. Open webpack.config.js again.
  3. Add a runtimeCaching property to your Workbox configuration. urlPattern is a regular expression pattern telling Workbox which URLs to store locally. (When your app makes a network request at runtime, Workbox caches any request that matches the regular expression in <em>handler</em>, regardless of its origin. This means that you can cache content from external sites as well, as this example demonstrates.) handler defines the caching strategy that Workbox uses for any matching URL. See The Offline Cookbook for more on caching strategies.
new workboxPlugin.GenerateSW({
  swDest: 'sw.js',
  clientsClaim: true,
  skipWaiting: true,
  runtimeCaching: [{
    urlPattern: new RegExp('https://hacker-news.firebaseio.com'),
    handler: 'StaleWhileRevalidate'
  }]
})

Try out the complete offline experience

The app now provides a complete offline experience. Try it now:

1 - Reload the live version of your app.

2 - Use the DevTools Command Menu to go back offline.

3 - Reload the app. The app now displays the content from the last time that you were online. If you're still only seeing the page title, go back online, reload the page, and then try again.

Figure 10. The complete offline experience

4 - Use the DevTools Command Menu to go back online.

Step 6: Create your own service worker

Up until now, you've been letting Workbox generate your entire service worker. If you've got a big project, or you want to customize how you cache certain resources, or do custom logic in your service worker, then you need to create a custom service worker that calls Workbox instead. Think of the service worker code you write as a template. You write your custom logic with placeholder keywords that instruct Workbox where to inject its code.

In this section, you add push notification support in your service worker. Since this is custom logic, you need to write custom service worker code, and then inject the Workbox code into the service worker at build-time.

1 - Re-focus the tab containing your project source code.

2 - Add the following line of code to the init() function in app.js.

function init() {
  ...
  if ('serviceWorker' in navigator) {
    window.addEventListener('load', () => {
      navigator.serviceWorker.register('/sw.js').then(registration => {
        console.log('SW registered: ', registration);
        registration.pushManager.subscribe({userVisibleOnly: true});
      }).catch(registrationError => {
        ...
      });
    });
  }
}

Warning: For simplicity, this demo asks for permission to send push notifications as soon as the service worker is registered. Best practices strongly recommend against out-of-context permission requests like this in real apps. See [Permission UX][UX].

3 - Click New File, enter src/sw.js, then press Enter.

4 - Add the following code to src/sw.js.

workbox.core.skipWaiting();
workbox.core.clientsClaim();

workbox.routing.registerRoute(
  new RegExp('https://hacker-news.firebaseio.com'),
  new workbox.strategies.StaleWhileRevalidate()
);

self.addEventListener('push', (event) => {
  const title = 'Get Started With Workbox';
  const options = {
    body: event.data.text()
  };
  event.waitUntil(self.registration.showNotification(title, options));
});

workbox.precaching.precacheAndRoute(self.__precacheManifest);

Important: workbox.precaching.precacheAndRoute(self.__precacheManifest) reads a list of URLs to precache from an externally defined variable, self.__precacheManifest. At build-time, Workbox injects code needed set self.__precacheManifest to the correct list of URLs.

5 - Open webpack.config.json.

6 - Remove the runtimeCaching, clientsClaim, and skipWaiting properties from your Workbox plugin configuration. These are now handled in your service worker code.

7 - Change the GenerateSW to InjectManifest and add the swSrc property to instruct Workbox to inject its code into a custom service worker.

new workboxPlugin.InjectManifest({
  swSrc: './src/sw.js',
  swDest: 'sw.js'
})

Try out push notifications

The app is now all set to handle push notifications. Try it now:

  1. Re-focus the tab running the live version of your app.
  2. Click Allow when Chrome asks you if you want to grant the app permission to send push notifications.
  3. Go to back to the Service Workers tab in DevTools.
  4. Enter some text into the Push text box, then click Push. Your operating system displays a push notification from the app.

Figure 11. Simulating a push notification from DevTools

Note: If you don't see the Push text box, you're running an older version of Chrome. Click the Push link instead. DevTools sends a notification with the text Test push message from DevTools.

Optional: How service worker injection works

At the bottom of your custom service worker, you call workbox.precaching.precacheAndRoute([]);. This is a placeholder. At build-time, the Workbox plugin replaces the empty array with the list of resources to precache. Your Workbox build configuration still determines what resources get precached.

Mobile App Development Company India | Ecommerce Web Development Company India

Mobile App Development Company India | Ecommerce Web Development Company India

Best Mobile App Development Company India, WebClues Global is one of the leading web and mobile app development company. Our team offers complete IT solutions including Cross-Platform App Development, CMS & E-Commerce, and UI/UX Design.

We are custom eCommerce Development Company working with all types of industry verticals and providing them end-to-end solutions for their eCommerce store development.

Know more about Top E-Commerce Web Development Company

Top Web Application Developer

Top Web Application Developer

You can also contact a web application development company for your business but then why not to contact the best web application development company that can turn up your business and customer satisfaction ratio to sky touching heights.

Not long-ago internet came into existence and the world has never been the same ever since. The Internet made sure that people and business do evolve at a faster rate than ever and was never merciful to the slow ones. Because of this competition and availability of any business with few clicks made India one of the hubs as IT center. This trend of constantly updating has given rise to smartphones, smart machines, wearable gadgets and a lot more is yet to come in the upcoming years. In such time it is always a good idea to hire Web App Developer from India at your service. They are expert in developing not only websites but web applications as well.

We at HireFullStackDeveloperIndia, have a huge team of experienced developers that have grasped over different domains in front and back end development. You can hire web app developers in India from us with many advantages that you won’t get anywhere else in the industry.

Here is why we are the best option if you are looking forward to hiring web app developers in India:

  • Flexible hiring models available, as per your convenience and requirement
  • Maximum ROI, compared to any other company or team of developers.
  • We provide you with Source code Authorization meaning code written for you belong only to you. It cannot be used or copied anywhere else.
  • All of our developers are sound with agile development methodology, so you will be in a constant loop of suggestions, ideas, trends, and updates about your project.
  • Our developers are good with creating custom web applications as well; it guarantees you a better product without any compromise of non-existing functionalities.
  • You can save huge costing on infrastructure by utilizing our hire web app developer in India program.
  • Your hired developer or team will be easily accessible to your preferred mode of communication.
  • You get to exercise complete control over your team or individual that you hire.
  • We believe in Integrity and Transparency.
  • Our developers are highly creative and motivated to deliver excellence.


HireFullStackDeveloperIndia is a Web Application Development Company in India that is known worldwide for our Innovative guaranteed solutions. You can inquire with us about your project and we will be providing you multiple suitable developers that are the best fit for your requirements. You can evaluate them and select one or multiple whosoever deems fit to you. After this, all you have to do is provide your valuable input to the resource through sprint base project development until you get delivery of your project.

Our engagement model will also allow you to get our development team to your site location and proceed with development from your premises.