Wyświetlaj pakiety treści Firestore z CDN

Wiele aplikacji serwuje tę samą treść wszystkim użytkownikom przy pierwszym wczytaniu strony. Na przykład witryna z wiadomościami może przedstawiać najnowsze artykuły, a witryna e-commerce może prezentować najlepiej sprzedające się produkty.

Jeśli ta treść jest wyświetlana w Cloud Firestore, każdy użytkownik podczas wczytywania aplikacji wyśle nowe zapytanie dotyczące tych samych wyników. Ze względu na to, że te wyniki nie są przechowywane w pamięci podręcznej między użytkownikami, aplikacja działa wolniej i kosztuje więcej niż to konieczne.

Rozwiązanie: pakiety

Pakiety Cloud Firestore umożliwiają tworzenie pakietów danych na podstawie typowych wyników zapytań w backendzie za pomocą pakietu SDK Firebase Admin i udostępnianie tych wstępnie obliczonych obiektów blob w pamięci podręcznej sieci CDN. Zapewnia to użytkownikom znacznie szybsze pierwsze wczytywanie i obniża koszty zapytań Cloud Firestore.

W tym przewodniku użyjemy Cloud Functions do wygenerowania pakietów, a Hostingu Firebase do dynamicznego buforowania i wyświetlania pakietów. Więcej informacji o pakietach znajdziesz w przewodnikach.

Najpierw utwórz prostą publiczną funkcję HTTP, która wyśle zapytanie dotyczące 50 najnowszych „artykułów” i wyświetli wynik w formie pakietu.

Node.js

exports.createBundle = functions.https.onRequest(async (request, response) => {
  // Query the 50 latest stories
  const latestStories = await db.collection('stories')
    .orderBy('timestamp', 'desc')
    .limit(50)
    .get();

  // Build the bundle from the query results
  const bundleBuffer = db.bundle('latest-stories')
    .add('latest-stories-query', latestStories)
    .build();

  // Cache the response for up to 5 minutes;
  // see https://firebase.google.com/docs/hosting/manage-cache
  response.set('Cache-Control', 'public, max-age=300, s-maxage=600');

  response.end(bundleBuffer);
});
      

Java

package com.example;

import com.google.auth.oauth2.GoogleCredentials;
import com.google.cloud.firestore.Firestore;
import com.google.cloud.firestore.FirestoreBundle;
import com.google.cloud.firestore.Query.Direction;
import com.google.cloud.firestore.QuerySnapshot;
import com.google.cloud.functions.HttpFunction;
import com.google.cloud.functions.HttpRequest;
import com.google.cloud.functions.HttpResponse;
import com.google.firebase.FirebaseApp;
import com.google.firebase.FirebaseOptions;
import com.google.firebase.cloud.FirestoreClient;
import java.io.BufferedWriter;
import java.io.IOException;

public class ExampleFunction implements HttpFunction {

  public static FirebaseApp initializeFirebase() throws IOException {
    if (FirebaseApp.getApps().isEmpty()) {
      FirebaseOptions options = FirebaseOptions.builder()
          .setCredentials(GoogleCredentials.getApplicationDefault())
          .setProjectId("YOUR-PROJECT-ID")
          .build();

      FirebaseApp.initializeApp(options);
    }

    return FirebaseApp.getInstance();
  }

  @Override
  public void service(HttpRequest request, HttpResponse response) throws Exception {
    // Get a Firestore instance
    FirebaseApp app = initializeFirebase();
    Firestore db = FirestoreClient.getFirestore(app);

    // Query the 50 latest stories
    QuerySnapshot latestStories = db.collection("stories")
        .orderBy("timestamp", Direction.DESCENDING)
        .limit(50)
        .get()
        .get();

    // Build the bundle from the query results
    FirestoreBundle bundle = db.bundleBuilder("latest-stores")
        .add("latest-stories-query", latestStories)
        .build();

    // Cache the response for up to 5 minutes
    // see https://firebase.google.com/docs/hosting/manage-cache
    response.appendHeader("Cache-Control", "public, max-age=300, s-maxage=600");

    // Write the bundle to the HTTP response
    BufferedWriter writer = response.getWriter();
    writer.write(new String(bundle.toByteBuffer().array()));
  }
}
      

Następnie skonfiguruj Hosting Firebase tak, aby obsługiwał i buforował tę funkcję w Cloud Functions, modyfikując firebase.json. Przy tej konfiguracji sieć CDN Hostingu Firebase będzie wyświetlać zawartość pakietu zgodnie z ustawieniami pamięci podręcznej ustawionymi przez funkcję w Cloud Functions. Gdy pamięć podręczna utraci ważność, zawartość pamięci podręcznej zostanie odświeżona, ponownie aktywując tę funkcję.

firebase.json
{
  "hosting": {
    // ...
    "rewrites": [{
      "source": "/createBundle",
      "function": "createBundle"
    }]
  },
  // ...
}

Na koniec w aplikacji internetowej pobierz pakiety treści z sieci CDN i wczytaj je do pakietu SDK Firestore.

// If you are using module bundlers.
import firebase from "firebase/app";
import "firebase/firestore";
import "firebase/firestore/bundle" // This line enables bundle loading as a side effect.

async function fetchFromBundle() {
  // Fetch the bundle from Firebase Hosting, if the CDN cache is hit the 'X-Cache'
  // response header will be set to 'HIT'
  const resp = await fetch('/createBundle');

  // Load the bundle contents into the Firestore SDK
  await db.loadBundle(resp.body);

  // Query the results from the cache
  // Note: omitting "source: cache" will query the Firestore backend.
  
  const query = await db.namedQuery('latest-stories-query');
  const storiesSnap = await query.get({ source: 'cache' });

  // Use the results
  // ...
}

Szacowane oszczędności

Weźmy np. witrynę z wiadomościami,która ma 100 tys. użytkowników dziennie i każdy z nich wczytuje te same 50 najważniejszych artykułów przy pierwszym wczytaniu. Bez buforowania odczytywano 50 x 100 000 = 5 000 000 odczytów dokumentów dziennie z Cloud Firestore.

Teraz załóżmy, że witryna przyjmuje powyższą metodę i zapisuje 50 wyników w pamięci podręcznej na maksymalnie 5 minut. Dzięki temu wyniki zapytania są wczytywane dokładnie 12 razy na godzinę, a nie dla każdego użytkownika. Niezależnie od tego, ilu użytkowników odwiedza witrynę, liczba zapytań kierowanych do Cloud Firestore pozostaje bez zmian. Zamiast 5 000 000 odczytów dokumentów ta strona używa 12 x 24 x 50 = 14 400 odsłon dokumentu dziennie. Niewielkie dodatkowe koszty hostingu Firebase i Cloud Functions możesz łatwo zrekompensować przez oszczędności Cloud Firestore.

Deweloper zyskuje na oszczędnościach, ale największym jest użytkownik. Wczytywanie tych 50 dokumentów z CDN Hostingu Firebase zamiast bezpośrednio z Cloud Firestore może spowodować, że czas wczytywania treści strony nie przekroczy 100–200 ms. Badania pokazują, że szybkie strony są bardziej zadowoleni z użytkowników.