Organiser plusieurs fonctions

Au fur et à mesure que vous intégrez Cloud Functions dans votre projet, votre code peut s'étendre pour contenir de nombreuses fonctions indépendantes. Vous pouvez avoir trop de fonctions pour tenir raisonnablement dans un seul fichier, ou différentes équipes peuvent déployer différents groupes de fonctions, créant un risque qu'une équipe écrase ou supprime accidentellement les fonctions d'une autre équipe. Cloud Functions propose différentes façons d'organiser votre code pour faciliter la navigation et la maintenance de vos fonctions.

Organiser les fonctions dans les bases de code

Vous pouvez utiliser la propriété codebase de l'objet de configuration functions dans firebase.json pour gérer une grande collection de fonctions sur plusieurs référentiels ou sous-packages au sein d'une configuration monorepo de référentiel unique :

# firebase.json
"functions": {
  "codebase": "my-codebase"
  # NOTE: Codebase must be less than 63 characters and can contain only
  # lowercase letters, numeric characters, underscores, and dashes.
}

La propriété codebase est prise en charge dans Firebase CLI v10.7.1 et versions ultérieures.

Gestion de plusieurs référentiels

La propriété codebase peut aider à simplifier la gestion de plusieurs référentiels. Examinons un cas où vous avez deux dépôts différents qui déploient des fonctions sur le même projet Firebase :

$  tree .
├── repoA
│   ├── firebase.json
│   └── functions
│       ├── index.js
│       └── package.json
└── repoB
    ├── firebase.json
    └── functions
        ├── index.js
        └── package.json

Sans les annotations de la base de code, la CLI Firebase vous aurait invité à supprimer les fonctions définies dans l'autre référentiel au moment du déploiement :

$ (cd repoA && firebase deploy --only functions)
...
i  functions: preparing functions directory for uploading...
✔  functions: functions folder uploaded successfully
The following functions are found in your project but do not exist in your local source code:
        fn1FromRepoB
        fn2FromRepoB
        ...
? Would you like to proceed with deletion? Selecting no will continue the rest of the deployments. (y/N)

Vous pouvez éviter ce problème en ajoutant une annotation de base de code unique dans la section de configuration des fonctions de firebase.json dans chaque référentiel de projet :

# repoA/firebase.json
"functions": {
  "codebase": "repo-a"
}

# repoB/firebase.json
"functions": {
  "codebase": "repo-b"
}

Avec l'annotation codebase, la CLI Firebase ne vous invite plus à supprimer les fonctions définies en dehors de votre référentiel immédiat :

$ (cd repoA && firebase deploy --only functions)
...
i  functions: preparing functions directory for uploading...
✔  functions: functions folder uploaded successfully
#  Gleefully ignores functions from repoB
i  functions: creating Node.js 16 function fnFromRepoA (us-central1)...
✔  Deploy Complete!

Gestion de plusieurs packages sources (monorepo)

La propriété codebase peut aider à simplifier la gestion de plusieurs packages source dans un référentiel unique. Examinons un cas où vous avez un répertoire de projet firebase avec des définitions de fonctions réparties sur plusieurs sous-packages :

$  tree .
├── firebase.json
├── teamA
│   ├── index.js
│   └── package.json
└── teamB
    ├── index.js
    └── package.json

Cette configuration correspond aux cas d'utilisation suivants :

  • Vous avez une configuration monorepo et différentes équipes gèrent leurs propres définitions de fonctions dans un package isolé.
  • Vous avez une fonction avec une forte dépendance externe et une initialisation de longue durée, et vous souhaitez isoler cette fonction des autres fonctions sensibles à la latence.

Pour prendre en charge la configuration monrepo comme celle-ci, définissez plusieurs configurations de fonctions dans firebase.json :

"functions": [
  {
    "source": "teamA",
    "codebase": "team-a"
  },
  {
    "source": "teamB",
    "codebase": "team-b"
  },
]

Avec cette configuration, la CLI Firebase déploie les fonctions de tous les packages en une seule commande de déploiement :

$ firebase deploy --only functions
i  deploying functions
i  functions: preparing codebase team-a for deployment
i  functions: preparing codebase team-b for deployment
i  functions: creating Node.js 16 function team-a:helloATeam(us-central1)...
i  functions: creating Node.js 16 function team-b:helloBTeam(us-central1)...
...

Vous pouvez également déployer une base de code spécifique :

$ firebase deploy --only functions:team-b
i  deploying functions
i  functions: preparing codebase team-b for deployment
i  functions: updating Node.js 16 function team-b:helloBTeam(us-central1)...
...

Fonctions d'écriture dans plusieurs fichiers

Lors de vos premiers pas avec Cloud Functions, vous pouvez placer vos premières fonctions dans un seul fichier :

index.js


const functions = require('firebase-functions');
exports.foo = functions.https.onRequest((request, response) => {
  // ...
});
exports.bar = functions.https.onRequest((request, response) => {
  // ...
});

Cela peut devenir difficile à gérer avec plus que quelques fonctions. Au lieu de cela, vous pouvez mettre toute votre logique pour chaque fonction dans son propre fichier et utiliser votre fichier index.js comme une simple liste d'exportations :

foo.js


const functions = require('firebase-functions');
exports.foo = functions.https.onRequest((request, response) => {
  // ...
});

bar.js


const functions = require('firebase-functions');
exports.bar = functions.https.onRequest((request, response) => {
  // ...
});

index.js


const foo = require('./foo');
const bar = require('./bar');
exports.foo = foo.foo;
exports.bar = bar.bar;

Fonctions de groupe

Dans de nombreux projets, les fonctions peuvent être séparées en groupes logiques qui doivent être déployés et maintenus ensemble. Par exemple, vous pouvez avoir un groupe de fonctions utilisées pour générer des rapports :

metrics.js


const functions = require('firebase-functions');
exports.usageStats = functions.https.onRequest((request, response) => {
  // ...
});
exports.nightlyReport = functions.https.onRequest((request, response) => {
  // ...
});

Vous pouvez mettre ces fonctions dans un groupe lors de leur exportation dans votre fichier index.js :

index.js


// Export both functions from metrics.js in the "metrics" group:
//  - metrics-usageStats
//  - metrics-nightlyReport
exports.metrics = require('./metrics');

Une fois déployées, les fonctions seront précédées du nom de leur groupe, donc dans cet exemple, les fonctions seraient nommées metrics-usageStats et metrics-nightlyReport .

Lors du déploiement de fonctions, vous pouvez limiter l'action à un seul groupe :


firebase deploy --only functions:metrics

Prochaines étapes

Pour en savoir plus sur Cloud Functions, consultez :