Connectez votre application à l'émulateur Cloud Functions

Avant de connecter votre application à l'émulateur Cloud Functions, assurez-vous que vous comprenez le flux de travail global de Firebase Local Emulator Suite , et que vous installez et configurez Local Emulator Suite et passez en revue ses commandes CLI .

Choisissez un projet Firebase

La suite d'émulateurs locaux Firebase émule des produits pour un seul projet Firebase.

Pour sélectionner le projet à utiliser, avant de démarrer les émulateurs, dans la CLI, exécutez firebase use dans votre répertoire de travail. Ou, vous pouvez passer l'indicateur --project à chaque commande de l'émulateur.

Local Emulator Suite prend en charge l'émulation de projets Firebase réels et de projets de démonstration .

Nous vous recommandons d'utiliser des projets de démonstration dans la mesure du possible. Les avantages incluent :

• Configuration plus facile, car vous pouvez exécuter les émulateurs sans jamais créer de projet Firebase
• Sécurité renforcée, car si votre code invoque accidentellement des ressources non émulées (de production), il n'y a aucune chance de modification, d'utilisation et de facturation des données
• Meilleure prise en charge hors ligne, car il n'est pas nécessaire d'accéder à Internet pour télécharger votre configuration SDK.

Instrumentez votre application pour parler aux émulateurs

Instrumentez votre application pour les fonctions appelables

Si vos activités de prototype et de test impliquent des fonctions backend appelables , configurez l'interaction avec l'émulateur Cloud Functions pour Firebase comme suit :

// 10.0.2.2 is the special IP address to connect to the 'localhost' of
// the host computer from an Android emulator.
val functions = Firebase.functions
functions.useEmulator("10.0.2.2", 5001)
MainActivity.kt

// 10.0.2.2 is the special IP address to connect to the 'localhost' of
// the host computer from an Android emulator.
FirebaseFunctions functions = FirebaseFunctions.getInstance();
functions.useEmulator("10.0.2.2", 5001);
MainActivity.java

Functions.functions().useFunctionsEmulator(origin: "http://127.0.0.1:5001")
ViewController.swift

import { getApp } from "firebase/app";
import { getFunctions, connectFunctionsEmulator } from "firebase/functions";

const functions = getFunctions(getApp());
connectFunctionsEmulator(functions, "127.0.0.1", 5001);
fb_functions_emulator_connect.js

firebase.functions().useEmulator("127.0.0.1", 5001);
emulator-suite.js

Instrumentez votre application pour l'émulation des fonctions HTTPS

Chaque fonction HTTPS de votre code sera servie à partir de l'émulateur local en utilisant le format d'URL suivant :

http:// $HOST : $PORT / $PROJECT / $REGION / $NAME

Par exemple, une simple fonction helloWorld avec le port et la région de l'hôte par défaut serait servie à :

https://localhost:5001/ $PROJECT /us-central1/helloWorld

Instrumentez votre application pour l'émulation de fonctions déclenchées en arrière-plan

L'émulateur Cloud Functions est compatible avec les fonctions déclenchées en arrière-plan à partir des sources suivantes :

• Émulateur de base de données en temps réel
• Émulateur Cloud Firestore
• Émulateur d'authentification
• Émulateur Pub/Sub

Pour déclencher des événements en arrière-plan, modifiez les ressources principales à l'aide de l'interface utilisateur d'Emulator Suite ou en connectant votre application ou votre code de test aux émulateurs à l'aide du SDK de votre plate-forme.

Gestionnaires de test pour les événements personnalisés émis par les extensions

Pour les fonctions que vous mettez en œuvre pour gérer les événements personnalisés des extensions Firebase avec Cloud Functions v2, l'émulateur Cloud Functions s'associe à l'émulateur Eventarc pour prendre en charge les déclencheurs Eventarc .

Pour tester les gestionnaires d'événements personnalisés pour les extensions qui émettent des événements, vous devez installer les émulateurs Cloud Functions et Eventarc.

L'environnement d'exécution Cloud Functions définit la variable d'environnement EVENTARC_EMULATOR sur localhost:9299 dans le processus actuel si l'émulateur Eventarc est en cours d'exécution. Les SDK Firebase Admin se connectent automatiquement à l'émulateur Eventarc lorsque la variable d'environnement EVENTARC_EMULATOR est définie. Vous pouvez modifier le port par défaut comme indiqué dans Configurer Local Emulator Suite .

Lorsque les variables d'environnement sont correctement configurées, le SDK Firebase Admin envoie automatiquement des événements à l'émulateur Eventarc. À son tour, l'émulateur Eventarc rappelle l'émulateur Cloud Functions pour déclencher tous les gestionnaires enregistrés.

Vous pouvez consulter les journaux de fonctions dans l'interface utilisateur d'Emulator Suite pour plus de détails sur l'exécution du gestionnaire.

Configurer un environnement de test local

Si vos fonctions reposent sur une configuration d'environnement basée sur dotenv, vous pouvez émuler ce comportement dans votre environnement de test local.

Lorsque vous utilisez un émulateur Cloud Functions local, vous pouvez remplacer les variables d'environnement de votre projet en configurant un fichier .env.local . Le contenu de .env.local a priorité sur .env et le fichier .env spécifique au projet.

Par exemple, un projet pourrait inclure ces trois fichiers contenant des valeurs légèrement différentes pour le développement et les tests locaux :

Lorsqu'il est démarré dans le contexte local, l'émulateur charge les variables d'environnement comme indiqué :

  $ firebase emulators:start
  i  emulators: Starting emulators: functions
  # Starts emulator with following environment variables:
  #  PLANET=Earth
  #  AUDIENCE=Local Humans

Secrets et identifiants dans l'émulateur Cloud Functions

L'émulateur Cloud Functions prend en charge l'utilisation de secrets pour stocker et accéder aux informations de configuration sensibles . Par défaut, l'émulateur essaiera d'accéder à vos secrets de production en utilisant les informations d'identification par défaut de l'application . Dans certaines situations telles que les environnements CI, l'émulateur peut ne pas accéder aux valeurs secrètes en raison de restrictions d'autorisation.

Comme pour la prise en charge de l'émulateur Cloud Functions pour les variables d'environnement, vous pouvez remplacer les valeurs secrètes en configurant un fichier .secret.local . Cela vous permet de tester facilement vos fonctions localement, surtout si vous n'avez pas accès à la valeur secrète.

Quels autres outils existent pour tester Cloud Functions ?

L'émulateur Cloud Functions est complété par d'autres prototypes et outils de test :

• Le shell Cloud Functions, qui permet le prototypage et le développement de fonctions interactives et itératives. Le shell utilise l'émulateur Cloud Functions avec une interface de style REPL pour le développement. Aucune intégration avec les émulateurs Cloud Firestore ou Realtime Database n'est fournie. À l'aide du shell, vous simulez des données et effectuez des appels de fonction pour simuler l'interaction avec des produits que Local Emulator Suite ne prend pas actuellement en charge : Analytics, Remote Config et Crashlytics.
• Le SDK de test Firebase pour Cloud Functions, un Node.js avec un framework mocha pour le développement de fonctions. En effet, le SDK de test Cloud Functions fournit une automatisation au-dessus du shell Cloud Functions.

Vous trouverez plus d'informations sur le shell Cloud Functions et le SDK de test Cloud Functions sur Tester les fonctions de manière interactive et sur les tests unitaires de Cloud Functions .

Différences entre l'émulateur Cloud Functions et la production

L'émulateur Cloud Functions est assez proche de l'environnement de production pour la majorité des cas d'utilisation. Nous avons déployé des efforts considérables pour nous assurer que tout ce qui se trouve dans l'environnement d'exécution de Node est aussi proche que possible de la production. Cependant, l'émulateur n'imite pas l'environnement de production conteneurisé complet, donc bien que votre code de fonction s'exécute de manière réaliste, d'autres aspects de votre environnement (c'est-à-dire les fichiers locaux, le comportement après le plantage des fonctions, etc.) seront différents.

Cloud IAM

Firebase Emulator Suite ne tente pas de répliquer ou de respecter un comportement lié à IAM pour l'exécution. Les émulateurs respectent les règles de sécurité Firebase fournies, mais dans les situations où IAM serait normalement utilisé, par exemple pour définir les fonctions Cloud invoquant le compte de service et donc les autorisations, l'émulateur n'est pas configurable et utilisera le compte disponible dans le monde entier sur votre machine de développeur, similaire à l'exécution directe d'un script local.

Restrictions de la mémoire et du processeur

L'émulateur n'applique pas de restrictions de mémoire ou de processeur pour vos fonctions. Cependant, l'émulateur prend en charge les fonctions de temporisation via l'argument d'exécution timeoutSeconds .

Notez que le temps d'exécution des fonctions peut différer de la production lorsque les fonctions sont exécutées dans l'émulateur. Après avoir conçu et testé des fonctions avec l'émulateur, nous vous recommandons d'exécuter des tests limités en production pour confirmer les temps d'exécution.

Planification des différences dans les environnements locaux et de production

Étant donné que l'émulateur s'exécute sur votre ordinateur local, il dépend de votre environnement local pour les applications et les programmes et utilitaires intégrés.

Sachez que votre environnement local de développement Cloud Functions peut différer de l'environnement de production Google :

• Les applications que vous installez localement pour simuler l'environnement de production (par exemple ImageMagick de ce didacticiel ) peuvent avoir un comportement différent de celui de la production, en particulier si vous avez besoin de versions différentes ou si vous développez dans un environnement non-Linux. Envisagez de déployer votre propre copie binaire du programme manquant parallèlement au déploiement de votre fonction.

• De même, les utilitaires intégrés (par exemple, les commandes shell telles que ls , mkdir ) peuvent différer des versions disponibles en production, en particulier si vous développez dans un environnement non Linux (par exemple, macOS). Vous pouvez gérer ce problème en utilisant des alternatives de nœud uniquement aux commandes natives, ou en créant des binaires Linux à regrouper avec votre déploiement.

Nouvelle tentative

L'émulateur Cloud Functions ne prend pas en charge les nouvelles tentatives de fonctions en cas d'échec.

Et ensuite ?

• Pour un ensemble de vidéos organisées et des exemples détaillés de procédures, suivez la liste de lecture de formation Firebase Emulators .
• Pour en savoir plus sur l'émulateur Cloud Functions for Firebase, consultez Exécuter les fonctions localement .