Przyspieszenie skryptu service worker dzięki wstępnym ładowaniu nawigacji

Wstępne wczytywanie nawigacji pozwala skrócić czas uruchamiania skryptu service worker dzięki wysyłaniu żądań równolegle.

Jake Archibald
Jake Archibald

Browser Support

  • Chrome: 59.
  • Edge: 18.
  • Firefox: 99.
  • Safari: 15.4.

Source

Podsumowanie

Problem

Gdy przejdziesz do witryny, która używa skryptu service worker do obsługi zdarzeń pobierania, przeglądarka poprosi skrypt service worker o odpowiedź. Obejmuje to uruchomienie skryptu service worker (jeśli jeszcze nie działa) i wysłanie zdarzenia pobierania.

Czas uruchamiania zależy od urządzenia i warunków. Zwykle wynosi około 50 ms. Na urządzeniach mobilnych jest to około 250 ms. W skrajnych przypadkach (wolne urządzenia, przeciążony procesor) może to być ponad 500 ms. Jednak ponieważ skrypt service worker pozostaje aktywny przez określony przez przeglądarkę czas między zdarzeniami, opóźnienie to występuje tylko sporadycznie, np. gdy użytkownik przechodzi do Twojej witryny z nowej karty lub innej witryny.

Czas uruchamiania nie jest problemem, jeśli odpowiadasz z pamięci podręcznej, ponieważ korzyści z pominięcia sieci są większe niż opóźnienie uruchamiania. Jeśli jednak odpowiadasz za pomocą sieci…

Uruchamianie oprogramowania
Żądanie nawigacji

Żądanie sieciowe jest opóźnione przez uruchomienie skryptu service worker.

Cały czas skracamy czas uruchamiania, używając buforowania kodu w V8, pomijając skrypty service worker, które nie mają zdarzenia pobierania, uruchamiając skrypty service worker spekulatywnie i stosując inne optymalizacje. Czas uruchamiania będzie jednak zawsze większy niż 0.

Facebook zwrócił naszą uwagę na wpływ tego problemu i poprosił o możliwość równoległego wykonywania żądań nawigacji:

Uruchamianie oprogramowania
Żądanie nawigacji

Wstępne wczytywanie nawigacji na ratunek

Wstępne wczytywanie nawigacji to funkcja, która pozwala powiedzieć: „Gdy użytkownik wysyła żądanie nawigacji GET, rozpocznij żądanie sieciowe podczas uruchamiania skryptu service worker”.

Opóźnienie uruchomienia nadal występuje, ale nie blokuje żądania sieciowego, dzięki czemu użytkownik szybciej otrzymuje treści.

Oto film, na którym widać, jak to działa. Skrypt service worker ma celowo ustawione 500 ms opóźnienia uruchamiania za pomocą pętli while:

Oto prezentacja. Aby korzystać z zalet wstępnego wczytywania nawigacji, musisz mieć przeglądarkę, która je obsługuje.

Aktywowanie wstępnego wczytywania nawigacji

addEventListener('activate',> event = {
  event.waitUntil(async function() {
    // Feature-detect
    if (self.registration.navigationPreload) {
      // Enable navigation preloads!
      await self.registration.navigationPreload.enable();
    }
  }());
});

Możesz wywołać navigationPreload.enable(), kiedy chcesz, lub wyłączyć tę funkcję za pomocą navigationPreload.disable(). Ponieważ jednak zdarzenie fetch musi z niego korzystać, najlepiej jest je włączać i wyłączać w zdarzeniu activate skryptu service worker.

Korzystanie ze wstępnie załadowanej odpowiedzi

Teraz przeglądarka będzie wstępnie wczytywać dane na potrzeby nawigacji, ale nadal musisz użyć odpowiedzi:

addEventListener('fetch',> event = {
  event.respondWith(async function() {
    // Respond from the cache if we can
    const cachedResponse = await caches.match(event.request);
    if (cachedResponse) return cachedResponse;

    // Else, use the preloaded response, if it's there
    const response = await event.preloadResponse;
    if (response) return response;

    // Else try the network.
    return fetch(event.request);
  }());
});

event.preloadResponse to obietnica, która jest spełniana, gdy:

  • Wstępne wczytywanie nawigacji jest włączone.
  • Żądanie jest żądaniem typu GET.
  • Żądanie jest żądaniem nawigacji (które przeglądarki generują podczas wczytywania stron, w tym elementów iframe).

W przeciwnym razie event.preloadResponse nadal istnieje, ale jest rozwiązywany za pomocą undefined.

Jeśli strona potrzebuje danych z sieci, najszybszym sposobem jest wysłanie żądania w skrypcie service worker i utworzenie pojedynczej odpowiedzi strumieniowej zawierającej części z pamięci podręcznej i części z sieci.

Załóżmy, że chcemy wyświetlić artykuł:

addEventListener('fetch',> event = {
  const url = new URL(event.request.url);
  const includeURL = new URL(url);
  includeURL.pathname += 'include';

  if (isArticleURL(url)) {
    event.respondWith(async function() {
      // We're going to build a single request from multiple parts.
      const parts = [
        // The top of the page.
        caches.match('/article-top.include'),
        // The primary content
        fetch(includeURL)
          // A fallback if the network >fails.
          .catch(() = caches.match('/article-offline.include')),
        // The bottom of the page
        caches.match('/article-bottom.include')
      ];

      // Merge them all together.
      const {done, response} = await mergeResponses(parts);

      // Wait until the stream is complete.
      event.waitUntil(done);

      // Return the merged response.
      return response;
    }());
  }
});

W powyższym przykładzie mergeResponses to mała funkcja, która scala strumienie każdego żądania. Oznacza to, że możemy wyświetlać nagłówek z pamięci podręcznej, podczas gdy treść jest przesyłana strumieniowo z sieci.

Jest to szybsze niż model „powłoki aplikacji”, ponieważ żądanie sieciowe jest wysyłane wraz z żądaniem strony, a treści mogą być przesyłane strumieniowo bez poważnych modyfikacji.

Jednak żądanie dotyczące includeURL zostanie opóźnione o czas uruchamiania skryptu service worker. Możemy też użyć wstępnego wczytywania nawigacji, aby to naprawić, ale w tym przypadku nie chcemy wstępnie wczytywać całej strony, tylko element dołączany.

Aby to umożliwić, z każdym żądaniem wstępnego wczytania wysyłany jest nagłówek:

Service-Worker-Navigation-Preload: true

Serwer może użyć tej informacji, aby wysłać inną treść w odpowiedzi na żądanie wstępnego wczytywania nawigacji niż w przypadku zwykłego żądania nawigacji. Pamiętaj tylko, aby dodać nagłówek Vary: Service-Worker-Navigation-Preload, dzięki czemu pamięci podręczne będą wiedzieć, że odpowiedzi się różnią.

Teraz możemy użyć żądania wstępnego wczytania:

// Try to use the preload
const networkContent = Promise.resolve(event.preloadResponse)
  // Else do a normal fetch
  .then(r => r || fetch(includeURL))
  // A fallback if the network fails.
  .catch(() => caches.match('/article-offline.include'));

const parts = [
  caches.match('/article-top.include'),
  networkContent,
  caches.match('/article-bottom')
];

Zmienianie nagłówka

Domyślnie wartość nagłówka Service-Worker-Navigation-Preload to true, ale możesz ustawić dowolną wartość:

navigator.serviceWorker.ready.then(registration => {
  return registration.navigationPreload.setHeaderValue(newValue);
}).then(() => {
  console.log('Done!';);
});

Możesz na przykład ustawić identyfikator ostatniego posta zapisanego lokalnie w pamięci podręcznej, aby serwer zwracał tylko nowsze dane.

Pobieranie stanu

Stan wstępnego wczytywania nawigacji możesz sprawdzić za pomocą getState:

navigator.serviceWorker.ready.then(registration => {
  return registration.navigationPreload.getState();
}).then(state => {
  console.log(state.enabled); // boolean
  console.log(state.headerValue); // string
});

Dziękujemy Mattowi Falkenhagenowi i Tsuyoshiemu Horo za pracę nad tą funkcją i pomoc przy tym artykule. Dziękujemy wszystkim, którzy przyczynili się do standaryzacji.