Blog.

Understanding Service Workers

Nicolas Bello Camilletti
Nicolas Bello Camilletti
5 min read

In the previous post I mentioned service workers several times as a key component for PWAs. Service workers are a crucial component in modern web development, enabling offline functionality and improving the performance of web applications. In this post, we'll dive into what service workers are, how they work, and how to implement them in your own web applications.

What are Service Workers?

A service worker is a JavaScript file that it's executed in the background of a web page. It's separated from the main browser thread and it works in a full asyncronows way so you will not be able to use DOM APIs or syncronous APIs such as localstorage. It acts as a proxy between the web page and the network, intercepting network requests and controlling the behavior of the page in response to network events.

The most notable feature of service workers is their ability to provide offline functionality. With a service worker, you can cache assets and make them available to your users even when they're offline. This can greatly improve the user experience, especially on slow or unreliable networks.

Why are Service Workers Important?

Service Workers offer several key benefits to web developers and users. Firstly, they allow for offline functionality, meaning that users can still access your web application even when they are not connected to the internet. This is particularly important for web applications that are used in areas with poor or unreliable network coverage, such as remote locations or on airplanes.

Additionally, Service Workers can be used to improve the performance of web applications. For example, by caching resources, Service Workers can reduce the amount of data that needs to be downloaded each time the user visits the website, resulting in faster load times.

Finally, Service Workers allow for push notifications and background sync capabilities, which can be used to deliver timely and relevant information to users, even when they are not actively using the web application.

How Service Workers Work

Service workers are registered by your web application, after which they are installed and activated in the background. Once activated, they can listen for network events and respond to them.

Here's a simple example of how a service worker might work:

  1. The user visits your web page.
  2. The browser checks to see if there's a service worker registered for the page.
  3. If there is, the browser downloads and installs the service worker in the background.
  4. The service worker is activated and starts listening for network events.
  5. The user tries to access a resource that requires a network connection.
  6. The service worker intercepts the network request and checks to see if the requested resource is available in its cache.
  7. If it is, the service worker returns the cached resource to the page, bypassing the network entirely.
  8. If it's not, the service worker makes the network request on behalf of the page, and caches the response for future use.

Implementing Service Workers

To implement service workers in your own web applications, you'll need to write a JavaScript file that acts as the service worker. You'll then need to register this file in your main JavaScript code, which will activate the service worker in the background.

Here's an example of how you might register a service worker in your main JavaScript file:

if ('serviceWorker' in navigator) {
  window.addEventListener('load', function() {
    navigator.serviceWorker.register('/service-worker.js')
      .then(function(registration) {
        console.log('Service worker registered: ', registration.scope);
      })
      .catch(function(error) {
        console.log('Service worker registration failed: ', error);
      });
  });
}

Note that we first check if the serviceWorker feature is available in the browser, if so, then we register it. If not, the site should work without problems but you will not have the advantages of that the service worker provides.

Once the service worker is registered, you'll need to write the code that listens for network events and caches resources. There are many libraries and frameworks available that can help with this, such as Workbox, but it's also possible to write this code from scratch using the Service Worker API.

Here's an example of a simple service worker that caches all assets:

self.addEventListener("install", (event) => {
  event.waitUntil(
    caches.open("v1").then((cache) => {
      return cache.addAll([
        "/",
        "/index.html",
        "/style.css",
        "/script.js",
        "/image.jpg",
      ]);
    })
  );
});

self.addEventListener("fetch", (event) => {
  event.respondWith(
    caches.match(event.request).then((response) => {
      if (response) {
        return response;
      }

      return fetch(event.request).then((response) => {
        let responseClone = response.clone();
        caches.open("v1").then((cache) => {
          cache.put(event.request, responseClone);
        });

        return response;
      });
    })
  );
});

In this example, the install event is listened to, which occurs when the service worker is installed. The service worker caches all assets listed in the cache.addAll method.

The fetch event is also listened to, which occurs whenever a network request is made. The service worker intercepts the request and checks if it's available in its cache. If it is, the cached version is returned. If not, the service worker makes the network request, caches the response, and returns it to the page.

Conclusion

Service workers are a powerful tool for improving the performance and offline functionality of web applications. With their ability to intercept network requests and cache resources, they can greatly enhance the user experience. While there is a learning curve to implementing service workers, the benefits are well worth the effort. Try implementing them in your own web applications and see the results for yourself!


More Stories

Migrating to Gatsby.js

7 min read

My blog post writing history is not the best, but I believe that it's the common story. I started writing in the company's WordPress, then I…

Nicolas Bello Camilletti
Nicolas Bello Camilletti

Angular 2 Http with ASP.NET Core APIs

6 min read

In my previous post, I explained how to configure routing in an application with Angular 2 and ASP.NET Core (if you need more information…

Nicolas Bello Camilletti
Nicolas Bello Camilletti