Installer, configurer et intégrer la suite d'émulateurs locaux

La suite d'émulateurs locaux Firebase peut être installée et configurée pour différents des environnements de prototype et de test, qu'il s'agisse de sessions de prototypage ponctuelles, d'intégration continue à l'échelle de la production.

Installer la suite d'émulateurs locaux

Avant d'installer la suite d'émulateurs, vous devez disposer des éléments suivants:

• Node.js version 16.0 ou ultérieure.
• Java JDK version 11 ou ultérieure

Pour installer la suite d'émulateurs :

1. Installez la CLI Firebase. Si la CLI Firebase n'est pas déjà installée, l'installer maintenant. Vous aurez besoin de la version 8.14.0 ou ultérieure de la CLI pour utiliser la suite d'émulateurs. Vous pouvez Vérifiez la version que vous avez installée à l'aide de la commande suivante:

   firebase --version

2. Si vous ne l'avez pas déjà fait, initialisez le répertoire de travail actuel en tant que projet Firebase, en suivant les instructions à l'écran pour spécifier produits à utiliser:

   firebase init

3. Configurez la suite d'émulateurs. Cette commande lance un assistant de configuration qui vous permet de sélectionner les émulateurs qui vous intéressent et de télécharger l'émulateur correspondant fichiers binaires, et définissez les ports de l'émulateur si les valeurs par défaut ne sont pas appropriées.

   firebase init emulators

Une fois l'émulateur installé, aucune vérification des mises à jour n'est effectuée et aucune les téléchargements automatiques seront effectués jusqu'à ce que vous mettiez à jour la version de la CLI Firebase.

Configurer la suite d'émulateurs

Vous pouvez éventuellement configurer le paramètre ports réseau et chemin d'accès Définitions des règles dans le fichier firebase.json:

• Modifiez les ports de l'émulateur en exécutant firebase init emulators ou en modifiant firebase.json manuellement.
• Modifiez le chemin d'accès aux définitions des règles de sécurité en modifiant firebase.json manuellement.

Si vous ne configurez pas ces paramètres, les émulateurs écouteront ports par défaut, Cloud Firestore, Realtime Database et Cloud Storage for Firebase les émulateurs s'exécuteront avec une sécurité des données ouverte.

Configuration du port

Chaque émulateur se lie à un port différent de votre machine avec une valeur par défaut préférée .

Configuration de l'ID de projet

Selon la manière dont vous appelez les émulateurs, vous pouvez exécuter plusieurs instances d'un émulateur utilisant différents ID de projet Firebase ou plusieurs instances d'émulateur pour un ID de projet donné. Dans ce cas, les instances d'émulateur s'exécutent dans un environnement distinct.

Il est généralement recommandé de définir un ID de projet pour tous les émulateurs. les appels, de sorte que le Emulator Suite UI, les différents émulateurs de produits les instances en cours d'exécution d'un émulateur peuvent communiquer correctement dans toutes cas d'utilisation.

Local Emulator Suite émet des avertissements lorsqu'il détecte plusieurs ID de projet dans l'environnement. Toutefois, vous pouvez remplacer ce comportement en définissant la clé singleProjectMode sur false dans votre firebase.json.

Vous pouvez vérifier les déclarations d'ID de projet pour détecter les incohérences dans :

• Projet par défaut dans la ligne de commande. Par défaut, l'ID de projet est extrait au démarrage du projet sélectionné avec firebase init ou firebase use. Pour afficher la liste des projets (et voir celui qui est sélectionné), utilisez firebase projects:list.
• Tests unitaires des règles L'ID du projet est souvent spécifié dans les appels aux règles Méthodes de bibliothèque de tests unitaires initializeTestEnvironment ou initializeTestApp.
• L'option de ligne de commande --project. Transmettre l'option --project de la CLI Firebase remplace le projet par défaut. Vous devez vous assurer que la valeur de l'indicateur correspond à l'ID du projet dans les tests unitaires et l'initialisation de l'application.

Vérifiez également les configurations d'ID de projet spécifiques à la plate-forme que vous avez définies la configuration de vos plates-formes Apple ; projets Android et Web.

Configuration des règles de sécurité

Les émulateurs récupèrent la configuration des règles de sécurité à partir de database, Clés de configuration firestore et storage dans firebase.json.

{
  // Existing firebase configuration ...
  "database": {
    "rules": "database.rules.json"
  },
  "firestore": {
    "rules": "firestore.rules"
  },
  "storage": {
    "rules": "storage.rules"
  }

  // ...

  // Optional emulator configuration. Default
  // values are used if absent.
  "emulators": {
    "singleProjectMode": false, // do not warn on detection of multiple project IDs
    "firestore": {
      "port": "8080"
    },
    "ui": {
      "enabled": true,      // Default is `true`
      "port": 4000          // If unspecified, see CLI log for selected port
    },
    "auth": {
      "port": "9099"
    },
    "pubsub": {
      "port": "8085"
    }
  }
}

Spécifier des options Java

L'émulateur Realtime Database, l'émulateur Cloud Firestore et une partie de L'émulateur Cloud Storage for Firebase est basé sur Java et peut être personnalisé avec des indicateurs JVM via la variable d'environnement JAVA_TOOL_OPTIONS.

Par exemple, si vous rencontrez des erreurs liées à l'espace du tas de mémoire Java, vous pouvez augmenter la taille maximale du tas de mémoire Java à 4 Go:

export JAVA_TOOL_OPTIONS="-Xmx4g"
firebase emulators:start

Plusieurs indicateurs peuvent être spécifiés entre guillemets et séparés par des espaces, comme JAVA_TOOL_OPTIONS="-Xms2g -Xmx4g" Les indicateurs ne concernent que les composants Java des émulateurs et n'ont aucun effet sur les autres parties de la CLI Firebase, telles que Emulator Suite UI.

Démarrer les émulateurs

Vous pouvez démarrer les émulateurs pour qu'ils s'exécutent jusqu'à leur arrêt manuel d'un script de test désigné, puis s'arrête automatiquement.

La méthode firebase emulators:exec est généralement plus adaptée aux workflows d'intégration continue.

Exporter et importer des données d'émulateur

Vous pouvez exporter des données depuis Authentication, Cloud Firestore, Realtime Database et Émulateurs Cloud Storage for Firebase à utiliser comme données de référence communes et partageables défini. Ces ensembles de données peuvent être importés à l'aide de l'indicateur --import, comme décrit ci-dessus.

Intégrer votre système CI

Exécuter des images de la suite d'émulateurs conteneurisées

Installation et configuration de la suite d'émulateurs avec des conteneurs dans un la configuration CI classique est simple.

Quelques points sont à noter:

• Les fichiers JAR sont installés et mis en cache dans ~/.cache/firebase/emulators/.

  • Vous pouvez ajouter ce chemin d'accès à la configuration de votre cache CI pour éviter des téléchargements répétés.

• Si votre dépôt ne contient pas de fichier firebase.json, vous devez ajouter un l'argument de ligne de commande à la commande emulators:start ou emulators:exec pour spécifier les émulateurs à démarrer. Par exemple,
  --only functions,firestore

Générer un jeton d'authentification (émulateur d'hébergement uniquement)

Si vos workflows d'intégration continue reposent sur Firebase Hosting, vous devez vous connecter à l'aide d'un jeton pour exécuter firebase emulators:exec. La les autres émulateurs ne nécessitent pas de connexion.

Pour générer un jeton, exécutez firebase login:ci sur votre environnement local. cela ne doit pas être effectué à partir d'un système CI. Suivez les instructions pour vous authentifier. Vous n'avez besoin d'effectuer cette étape qu'une seule fois par projet, car le jeton sera valide d'une compilation à l'autre. Le jeton doit être traité comme un mot de passe. s’assurer qu’elle reste secrète.

Si votre environnement CI vous permet de spécifier des variables d'environnement utilisées dans les scripts de compilation, il vous suffit de créer une variable d'environnement appelée FIREBASE_TOKEN, dont la valeur correspond à la chaîne du jeton d'accès. CLI Firebase récupère automatiquement la variable d'environnement FIREBASE_TOKEN et les émulateurs démarreront correctement.

En dernier recours, vous pouvez simplement inclure le jeton dans votre script de compilation, mais assurez-vous que les parties non approuvées n'y ont pas accès. Pour cette approche codée en dur, vous pouvez ajouter --token "YOUR_TOKEN_STRING_HERE" à la commande firebase emulators:exec.

Utiliser l'API REST de l'émulateur

Répertorier les émulateurs en cours d'exécution

Pour répertorier les émulateurs en cours d'exécution, envoyez une requête GET au /emulators. du hub d'émulateurs.

curl localhost:4400/emulators

Le résultat est un objet JSON listant tous les émulateurs en cours d'exécution et leur configuration hôte/port, par exemple :

{
  "hub":{
    "name": "hub",
    "host": "localhost",
    "port": 4400
  },
  "functions": {
    "name": "functions",
    "host": "localhost",
    "port": 5001
  }
  "firestore": {
    "name": "firestore",
    "host": "localhost",
    "port": 8080
  }
}

Activer / Désactiver les déclencheurs de la fonction d'arrière-plan

Dans certains cas, vous devrez désactiver temporairement la fonction locale et les déclencheurs d'extension. Par exemple, vous pouvez supprimer toutes les données l'émulateur Cloud Firestore sans déclencher de fonction onDelete qui s'exécutent dans les émulateurs Cloud Functions ou Extensions.

Pour désactiver temporairement les déclencheurs de fonction locale, envoyez une requête PUT au Point de terminaison /functions/disableBackgroundTriggers du hub de l'émulateur.

curl -X PUT localhost:4400/functions/disableBackgroundTriggers

Le résultat est un objet JSON détaillant l'état actuel.

{
  "enabled": false
}

Pour activer les déclencheurs de fonction locale après leur désactivation, envoyez un PUT au point de terminaison /functions/enableBackgroundTriggers de l'émulateur Hub.

curl -X PUT localhost:4400/functions/enableBackgroundTriggers

Le résultat est un objet JSON détaillant l'état actuel.

{
  "enabled": true
}

Intégrations du SDK de l'émulateur

Les tableaux de cette section indiquent les émulateurs compatibles avec le client et les SDK Admin. Future signifie que la compatibilité de l'émulateur est prévue, mais pas encore. disponibles.

Disponibilité du SDK client

Disponibilité du SDK Admin