Check out what’s new from Firebase@ Google I/O 2021, and join our alpha program for early access to the new Remote Config personalization feature. Learn more

Exécuter des fonctions localement

La CLI Firebase inclut un émulateur Cloud Functions qui peut émuler les types de fonctions suivants :

  • Fonctions HTTPS
  • Fonctions appelables
  • Fonctions d'arrière-plan déclenchées à partir de l'authentification, de la base de données en temps réel, de Cloud Firestore et de Cloud Pub/Sub.

Vous pouvez exécuter des fonctions localement pour les tester avant de les déployer en production.

Installer la CLI Firebase

Pour utiliser l'émulateur Cloud Functions, commencez par installer la CLI Firebase :

npm install -g firebase-tools

Pour utiliser l'émulateur local, vos fonctions Cloud doivent dépendre de :

  • firebase-admin version 8.0.0 ou supérieure.
  • firebase-functions version 3.0.0 ou supérieure.

Configurer les informations d'identification d'administrateur (facultatif)

Si vous souhaitez que vos tests de fonctions interagissent avec les API Google ou d'autres API Firebase via le SDK Firebase Admin , vous devrez peut-être configurer des informations d'identification d'administrateur.

  • Les déclencheurs Cloud Firestore et Realtime Database disposent déjà d'informations d'identification suffisantes et ne nécessitent pas de configuration supplémentaire.
  • Toutes les autres API, y compris les API Firebase telles que Authentication et FCM ou les API Google telles que Cloud Translation ou Cloud Speech, nécessitent les étapes de configuration décrites dans cette section. Cela s'applique que vous utilisiez les fonctions shell ou firebase emulators:start .

Pour configurer les informations d'identification d'administrateur pour les fonctions émulées :

  1. Ouvrez le volet Comptes de service de Google Cloud Console.
  2. Assurez-vous que le compte de service par défaut App Engine est sélectionné et utilisez le menu d'options à droite pour sélectionner Créer une clé .
  3. Lorsque vous y êtes invité, sélectionnez JSON pour le type de clé, puis cliquez sur Créer .
  4. Définissez vos identifiants Google par défaut pour qu'ils pointent vers la clé téléchargée :

    Unix

    $ export GOOGLE_APPLICATION_CREDENTIALS="path/to/key.json"
    
    $ firebase emulators:start
    

    les fenêtres

    $ set GOOGLE_APPLICATION_CREDENTIALS=path\to\key.json
    
    $ firebase emulators:start
    

Une fois ces étapes terminées, vos tests de fonctions peuvent accéder aux API Firebase et Google à l'aide du SDK Admin . Par exemple, lors du test d'un déclencheur d'authentification, la fonction émulée peut appeler admin.auth().getUserByEmail(email) .

Paramétrer la configuration des fonctions (facultatif)

Si vous utilisez des variables de configuration de fonctions personnalisées, exécutez d'abord la commande pour obtenir votre configuration personnalisée (exécutez-la dans le répertoire des functions ) dans votre environnement local :

firebase functions:config:get > .runtimeconfig.json
# If using Windows PowerShell, replace the above with:
# firebase functions:config:get | ac .runtimeconfig.json
firebase functions:shell

Exécuter la suite d'émulateurs

Pour exécuter l'émulateur Cloud Functions, utilisez la commande emulators:start :

firebase emulators:start

La commande emulators:start démarrera les émulateurs pour Cloud Functions, Cloud Firestore, Realtime Database et Firebase Hosting en fonction des produits que vous avez initialisés dans votre projet local à l'aide de firebase init . Si vous souhaitez démarrer un émulateur particulier, utilisez l'indicateur --only :

firebase emulators:start --only functions

Si vous souhaitez exécuter une suite de tests ou un script de test après le démarrage des emulators:exec , utilisez la commande emulators:exec :

firebase emulators:exec "./my-test.sh"

Instrumentez votre application pour parler aux émulateurs

Pour instrumenter votre application afin d'interagir avec les émulateurs, vous devrez peut-être effectuer une configuration supplémentaire.

Instrumentez votre application pour des fonctions appelables

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

Android
        // 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);
iOS - Swift
Functions.functions().useFunctionsEmulator(origin: "http://localhost:5001")

Web v8

firebase.functions().useEmulator("localhost", 5001);

Web v9

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

const functions = getFunctions(getApp());
useFunctionsEmulator(functions, "localhost", 5001);

Instrumenter votre application pour l'émulation de 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 hôte et la région 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 prend en charge 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, connectez votre application ou votre code de test aux émulateurs à l'aide du SDK de votre plate-forme.

Interactions avec d'autres services

La suite d'émulateurs comprend plusieurs émulateurs, qui permettent de tester les interactions entre produits.

Cloud Firestore

Si vous disposez de Cloud Functions qui utilisent le SDK Firebase Admin pour écrire dans Cloud Firestore, ces écritures seront envoyées à l'émulateur Cloud Firestore s'il est en cours d'exécution. Si d'autres fonctions Cloud Functions sont déclenchées par ces écritures, elles seront exécutées dans l'émulateur Cloud Functions.

Hébergement Firebase

Si vous utilisez Cloud Functions pour générer du contenu dynamique pour Firebase Hosting , firebase emulators:start utilise vos fonctions HTTP locales comme proxy pour l'hébergement.

Enregistrement

L'émulateur diffuse les journaux de vos fonctions vers la fenêtre du terminal où elles s'exécutent. Il affiche toutes les sorties des console.log() , console.info() , console.error() et console.warn() dans vos fonctions.

Prochaines étapes

Pour obtenir un exemple complet d'utilisation de la suite d'émulateurs Firebase, consultez l' exemple de démarrage rapide de test .