Organizza più funzioni

Man mano che integri Cloud Functions nel tuo progetto, il codice potrebbe espandersi per contenere molte funzioni indipendenti. Potresti avere troppe funzioni per inserirle ragionevolmente in un singolo file oppure team diversi potrebbero implementare gruppi diversi di funzioni, creando il rischio che un team sovrascriva o elimini accidentalmente le funzioni di un altro team. Cloud Functions offre vari modi per organizzare il codice e semplificare la navigazione e la gestione

Organizzare le funzioni nelle codebase

Puoi utilizzare la proprietà codebase dell'oggetto di configurazione delle funzioni in firebase.json per gestire una grande raccolta di funzioni in più repository o sottopacchetti all'interno di un'unica configurazione monorepo del repository:

# 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 proprietà codebase è supportata nella versione 10.7.1 e successive dell'interfaccia a riga di comando di Firebase.

Gestione di più repository

La proprietà codebase può contribuire a semplificare la gestione di più repository. Esaminiamo un caso in cui due repository diversi distribuiscono funzioni nello stesso progetto Firebase:

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

Senza le annotazioni del codice base, l'interfaccia a riga di comando di Firebase ti avrebbe chiesto di eliminare le funzioni definite nell'altro repository al momento del deployment:

$ (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)

Puoi evitare questo problema aggiungendo un'annotazione del codice base univoca nella sezione di configurazione delle funzioni del firebase.json in ogni repository del progetto:

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

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

Con l'annotazione del codice base, l'interfaccia a riga di comando di Firebase non ti chiede più di eliminare le funzioni definite al di fuori del tuo repository immediato:

$ (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!

Gestione di più pacchetti di origine (monorepo)

La proprietà codebase può contribuire a semplificare la gestione di più pacchetti di origine in un unico repository. Esaminiamo un caso in cui hai una directory del progetto Firebase con definizioni di funzioni distribuite su più sottopacchetti:

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

Questa configurazione è adatta ai seguenti casi d'uso:

• Hai configurato un monorepo e diversi team gestiscono le proprie definizioni di funzione in un pacchetto isolato.
• Hai una funzione con una dipendenza esterna elevata e un'inizializzazione di lunga durata e vuoi isolarla da altre funzioni sensibili alla latenza.

Per supportare una configurazione monrepo come questa, definisci più configurazioni di funzioni in firebase.json:

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

Con questa configurazione, l'interfaccia a riga di comando di Firebase esegue il deployment delle funzioni di tutti i pacchetti in un unico comando di deployment:

$ 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)...
...

Puoi anche eseguire il deployment di una codebase specifica:

$ 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)...
...

Scrivere funzioni in più file

Quando inizi a utilizzare Cloud Functions, potresti inserire le prime alcune funzioni in un unico file:

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

from firebase_functions import https_fn

@https_fn.on_request()
def foo(req: https_fn.Request) -> https_fn.Response:
    return https_fn.Response("Hello foo!")

@https_fn.on_request()
def bar(req: https_fn.Request) -> https_fn.Response:
    return https_fn.Response("Hello bar!")

Questo può diventare difficile da gestire con più di alcune funzioni. In alternativa, puoi inserire tutta la logica per ogni funzione in un file dedicato e utilizzare il file di origine come elenco di esportazioni:

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

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

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

from firebase_functions import https_fn

@https_fn.on_request()
def foo(req: https_fn.Request) -> https_fn.Response:
    return https_fn.Response("Hello foo!")

from firebase_functions import https_fn

@https_fn.on_request()
def bar(req: https_fn.Request) -> https_fn.Response:
    return https_fn.Response("Hello foo!")

from fn_impl.foo import *
from fn_impl.bar import *

my-project
├── firebase.json
└── functions
    ├── fn_impl
    │   ├── __init__.py
    │   ├── foo.py
    │   └── bar.py
    ├── main.py
    └── requirements.txt

Funzioni di gruppo

In molti progetti, le funzioni possono essere suddivise in gruppi logici che devono essere dipiamente e gestiti insieme. Ad esempio, ipotizziamo che tu abbia un gruppo di funzioni utilizzate per generare report sulle metriche:

metrics.js

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

Puoi raggruppare queste funzioni quando le esporti nel file index.js :

index.js

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

Quando ne viene eseguito il deployment, le funzioni saranno anteposte al prefisso del nome del loro gruppo, quindi in questo esempio le funzioni saranno denominate metrics-usageStats e metrics-nightlyReport.

Quando esegui il deployment di funzioni, puoi limitare l'azione a un singolo gruppo:

firebase deploy --only functions:metrics

Passaggi successivi

Per scoprire di più su Cloud Functions, consulta:

• Gestione delle dipendenze.
• Gestisci le opzioni di deployment e di runtime delle funzioni.