Skip to content

jakearchibald/async-waituntil-polyfill

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 

What?

In earlier versions of the service worker spec, event.waitUntil had to be called synchronously, as in during the initial execution of the event handler. Meaning this would fail:

self.addEventListener('fetch', event => {
  event.respondWith(
    caches.open('mysite-dynamic').then(cache => {
      // try the cache first
      return cache.match(event.request).then(response => {
        // if we get a response, use it
        if (response) return response;
        // otherwise, go to the network
        return fetch(event.request).then(response => {
          // cache it asynchronously for next time
          event.waitUntil(
            cache.put(event.request, response.clone())
          );

          // return the response
          return response;
        });
      });
    })
  );
});

This fails because waitUntil was called after the execution of the event handler. But we need to use waitUntil here because the browser needs to know to keep the service worker alive after we've sent the response back.

We fixed this in the spec, so you can call waitUntil as long as the promises already passed to waitUntil & respondWith haven't settled yet.

The browsers haven't caught up yet (Chrome issue), but this polyfill makes it work as expected.

Usage

In your service worker:

importScripts('async-waituntil.js');

That's it! The above example now works.