App-Bereitstellung lokal testen

Sie können Ihre App vor der Bereitstellung in App Hosting lokal mit dem App Hosting-Emulator testen, der Teil der Firebase Local Emulator Suite ist.

Bevor Sie den App Hosting-Emulator verwenden, sollten Sie sich mit dem allgemeinen Firebase-Local Emulator Suite-Workflow vertraut machen. Außerdem müssen Sie die Local Emulator Suite installieren und konfigurieren und sich die zugehörigen CLI-Befehle ansehen.

In diesem Thema wird davon ausgegangen, dass Sie bereits mit App Hosting vertraut sind. Lesen Sie bei Bedarf die Einführung in App Hosting und andere Materialien, um zu verstehen, wie App Hosting funktioniert.

Was kann ich mit dem App Hosting-Emulator tun?

Mit dem App Hosting-Emulator können Sie Ihre Webanwendungen lokal testen und optimieren. So können Sie Ihren Entwicklungsprozess optimieren und die Qualität von Webanwendungen verbessern, die mit Firebase erstellt und in App Hosting bereitgestellt werden.

Der App Hosting-Emulator:

  1. Ermöglicht es Ihnen, Ihre Webanwendung lokal mit Umgebungsvariablen und Secrets auszuführen, die in apphosting.yaml-Konfigurationsdateien definiert sind.
  2. Kann Umgebungsvariablen und Secrets für die Verwendung im Emulator mit der Datei apphosting.emulator.yaml überschreiben.
  3. Kann zusammen mit anderen Firebase-Emulatoren verwendet werden. Wenn Sie den Firestore-, Auth- oder einen anderen Emulator verwenden, sorgt Local Emulator Suite dafür, dass diese Emulatoren vor dem App Hosting-Emulator gestartet werden.

Emulator konfigurieren

Installieren und initialisieren Sie zuerst die Local Emulator Suite, wie unter Lokale Emulator Suite installieren, konfigurieren und einbinden beschrieben. Wählen Sie zusätzlich zu allen anderen Firebase-Emulatoren, die Sie einrichten möchten, App Hosting Emulator aus. Die Befehlszeile fordert Sie auf, einige Werte für den App Hosting-Emulator einzugeben, darunter:

  • Das Stammverzeichnis Ihrer Anwendung relativ zum Projekt. Dies ist wichtig, wenn Sie Monorepos mit App Hosting verwenden.
  • Ob Sie Werte für die lokale Entwicklung überschreiben möchten.
  • Ob Sie Teammitgliedern Zugriff auf Secrets für die lokale Entwicklung gewähren möchten.
firebase init emulators
=== Emulators Setup
? Which Firebase emulators do you want to set up? Press Space to select emulators, then Enter to confirm your choices. (Press
<space> to select, <a> to toggle all, <i> to invert selection, and <enter> to proceed)
❯◯ App Hosting Emulator
 ◯ Firestore Emulator
 ◯ Database Emulator
 ◯ Hosting Emulator
 ◯ Pub/Sub Emulator
 ◯ Storage Emulator
 ◯ Eventarc Emulator
(Move up and down to reveal more choices)

? Specify your app's root directory relative to your project (./)

? The App Hosting emulator uses a file called apphosting.emulator.yaml to
override values in apphosting.yaml for local testing. This codebase does not
have one, would you like to create it? (Y/n)

? Which environment variables would you like to override? (Press <space> to
select, <a> to toggle all, <i> to invert selection, and <enter> to proceed)
❯◯ MEMCACHE_ADDR
 ◯ API_KEY

? What new value would you like for plaintext MEMCACHE_ADDR?

? What would you like to name the secret reference for API_KEY? (test-api-key)

? What new value would you like for secret TESTKEY [input is hidden]? [input is hidden]

? Your config has secret values. Please provide a comma-separated list of users
or groups who should have access to secrets for local development:

✔  Successfully set IAM bindings on secret test-api-key.

Alle Werte, die Sie in diesem Einrichtungsablauf angeben, werden verwendet, um Ihre App Hosting-Emulatorkonfiguration in firebase.json zu aktualisieren. Sie können den App Hosting-Emulator auch konfigurieren, indem Sie firebase.json direkt aktualisieren. Das Schema für den App Hosting-Emulator lautet:

{
  ...
  "emulators": {
    "apphosting": {
      "startCommand": <command> [optional],
      "rootDirectory": <path> [optional]
    }
  }
}
  • startCommand wird automatisch generiert und festgelegt, wenn der Emulator initialisiert wird. Wenn Sie nichts angeben, erkennt der Emulator den Entwicklungsbefehl Ihres Paketmanagers und führt ihn aus.
  • rootDirectory wird verwendet, um Monorepo-Projekteinrichtungen zu unterstützen. Wenn sich Ihre Webanwendung in einem Unterverzeichnis befindet, müssen Sie den Pfad dieses Verzeichnisses relativ zum Stammverzeichnis (dem Speicherort von firebase.json) angeben.

Emulation verwalten

Bei der Emulatorinitialisierung wird im Stammverzeichnis Ihrer Anwendung eine apphosting.emulator.yaml-Datei erstellt. Diese Konfigurationsdatei hat dasselbe Schema wie die in der Produktion verwendete Datei apphosting.yaml, ist aber ausschließlich für die lokale Entwicklung gedacht. Standardmäßig liest der Emulator die Konfiguration aus der Datei apphosting.yaml. Wenn jedoch eine apphosting.emulator.yaml-Datei vorhanden ist, werden die Konfigurationen in dieser Datei priorisiert und haben Vorrang.

Die Datei apphosting.emulator.yaml ist so konzipiert, dass sie sicher übertragen und mit Kollegen geteilt werden kann. Damit Sie nicht versehentlich vertrauliche Daten in Quell-Repositories übertragen, muss jede Umgebungsvariable, die ein Secret in apphosting.yaml ist, auch ein Secret in apphosting.emulator.yaml sein. Wenn ein Secret zwischen der Produktion und der lokalen Entwicklung nicht geändert werden muss (z. B. ein Gemini API-Schlüssel), muss es nicht zu apphosting.emulator.yaml hinzugefügt werden. Gewähren Sie Ihrem Team stattdessen Zugriff auf das Secret.

Wenn Ihre Anwendung viele Secrets verwendet (z. B. API-Schlüssel für drei verschiedene Dienste mit unterschiedlichen Werten für Produktion, Staging und lokale Entwicklung), überschreiten Sie möglicherweise die kostenlose Stufe von Cloud Secret Manager und zahlen 0,06 $ pro zusätzlichem Secret pro Monat. Wenn Sie die lokale Konfiguration lieber außerhalb der Versionsverwaltung verwalten möchten, um diese Gebühr zu vermeiden, können Sie die Legacy-Datei apphosting.local.yaml verwenden. Im Gegensatz zu apphosting.emulator.yaml darf diese Datei Klartextwerte für Umgebungsvariablen enthalten, die in apphosting.yaml Secret-Werte sind.

Nutzern oder Gruppen Zugriff auf Secrets gewähren

In apphosting.emulator.yaml gespeicherte Secrets werden beim Start des Emulators gelesen. Das bedeutet, dass Ihr Entwicklungsteam Zugriff auf das Secret benötigt. Mit dem Befehl apphosting:secrets:grantaccess können Sie einem Nutzer oder einer Gruppe per E-Mail Zugriff auf ein Secret gewähren.

firebase apphosting:secrets:grantaccess test-api-key --emails my-team@my-company.com

Verwenden Sie gegebenenfalls nur Testschlüssel in apphosting.emulator.yaml, die keinen Zugriff auf Produktionsdaten haben, keine globalen Nebenwirkungen haben (E-Mails senden, Kreditkarten belasten) oder niedrigere Kontingente haben. So haben nicht überprüfte Codes weniger Auswirkungen auf die Praxis.

Verwenden Sie Google Groups, um den Zugriff auf Secrets zu verwalten, anstatt einzelnen Nutzern Zugriff zu gewähren. Dadurch wird das Onboarding neuer Mitglieder in Ihr Entwicklerteam vereinfacht, da sie durch das Hinzufügen zur Gruppe Zugriff auf alle erforderlichen Secrets erhalten. Möglicherweise haben Sie bereits eine geeignete Gruppe, in der Entwickler miteinander kommunizieren. Wenn Sie den Zugriff über Google Groups steuern, können Sie auch dafür sorgen, dass Entwickler, die Ihr Team verlassen, den Zugriff auf alle Secrets verlieren, wenn sie aus der E-Mail-Gruppe entfernt werden. Wenn das Secret Zugriff auf Produktionsdaten oder reale Nebenwirkungen hat, kann es dennoch sinnvoll sein, den Schlüssel zu rotieren und ihm mit firebase apphosting:secrets:set einen neuen Wert zuzuweisen.

Emulator starten

firebase emulators:start

Dadurch werden alle in der Datei firebase.json definierten Emulatoren gestartet, einschließlich des App Hosting-Emulators.

start-Befehl für Angular-Anwendungen konfigurieren

Wenn der Emulatorbefehl start ein Zeitlimit überschreitet, wird Ihre Anwendung wahrscheinlich vom Angular-Entwicklungsserver auf einem anderen Port bereitgestellt, als der App Hosting-Emulator erwartet. Sie können dieses Problem umgehen, indem Sie in firebase.json eine zusätzliche Konfiguration hinzufügen:

  • Setzen Sie emulators.apphosting.startCommand auf ng serve.
  • Wenn Sie einen nicht standardmäßigen Port verwenden möchten, legen Sie ihn mit emulators.apphosting.port fest, anstatt das Flag --port zu ng serve in emulators.apphosting.startCommand hinzuzufügen.

Beispiel:

"emulators": {
    "apphosting": {
      "port": 5002,
      "rootDirectory": "./test-app",
      "startCommand": "ng serve"
    },
    "ui": {
      "enabled": true
    },
    ...
  }