Le funzioni di coda di attività sfruttano Google Cloud Tasks per aiutare la tua app a eseguire attività che richiedono molto tempo, molte risorse o una larghezza di banda limitata in modo asincrono, al di fuori del flusso principale dell'applicazione.
Ad esempio, supponiamo di voler creare backup di un ampio insieme di file di immagini attualmente ospitati su un'API con un limite di frequenza. Per essere un consumatore responsabile di questa API, devi rispettare i limiti di frequenza. Inoltre, questo tipo di job a esecuzione prolungata potrebbe essere vulnerabile a errori dovuti a timeout e limiti di memoria.
Per ridurre questa complessità, puoi scrivere una funzione di coda di attività che imposta le opzioni di base
dell'attività come scheduleTime e dispatchDeadline, quindi passa la
funzione a una coda in Cloud Tasks. L'ambiente Cloud Tasks
è progettato specificamente per garantire un controllo efficace della congestione e
politiche di ripetizione per questi tipi di operazioni.
L'SDK Firebase per Cloud Functions for Firebase versione 3.20.1 e successive interagisce con Firebase Admin SDK versione 10.2.0 e successive per supportare le funzioni di coda di attività.
L'utilizzo delle funzioni di coda delle attività con Firebase può comportare addebiti per l'elaborazioneCloud Tasks. Per saperne di più, consulta i prezzi di Cloud Tasks.
Crea funzioni di coda di attività
Per utilizzare le funzioni della coda di attività, segui questo flusso di lavoro:
- Scrivi una funzione di coda di attività utilizzando l'SDK Firebase per Cloud Functions.
- Testa la funzione attivandola con una richiesta HTTP.
- Esegui il deployment della funzione con la CLI Firebase. Quando esegui il deployment della funzione di coda delle attività per la prima volta, la CLI crea una coda di attività in Cloud Tasks con le opzioni (limitazione di frequenza e nuovi tentativi) specificate nel codice sorgente.
- Aggiungi attività alla coda di attività appena creata, passando i parametri per configurare una pianificazione delle esecuzioni, se necessario. Puoi farlo scrivendo il codice utilizzando Admin SDK ed eseguendo il deployment su Cloud Functions for Firebase.
Scrivi funzioni di code di attività
Utilizza onDispatch
per iniziare a scrivere funzioni di code di attività. Una parte importante
della scrittura di una funzione di coda di attività è l'impostazione della configurazione di nuovi tentativi e limitazione della frequenza per coda. Gli esempi di codice in questa pagina si basano su un'app che configura un servizio che esegue il backup di tutte le immagini della foto astronomica del giorno della NASA:
Configura le funzioni della coda di attività
Le funzioni della coda di attività sono dotate di un potente insieme di impostazioni di configurazione per controllare con precisione i limiti di frequenza e il comportamento di nuovi tentativi di una coda di attività:
exports.backupApod = functions
.runWith( {secrets: ["NASA_API_KEY"]})
.tasks.taskQueue({
retryConfig: {
maxAttempts: 5,
minBackoffSeconds: 60,
},
rateLimits: {
maxConcurrentDispatches: 6,
},
}).onDispatch(async (data) => {
retryConfig.maxAttempts=5: ogni attività nella coda di attività viene ritentata automaticamente fino a 5 volte. Ciò contribuisce a mitigare gli errori temporanei come gli errori di rete o l'interruzione temporanea del servizio di un servizio esterno dipendente.retryConfig.minBackoffSeconds=60: Ogni attività viene ritentata almeno 60 secondi dopo ogni tentativo. In questo modo, tra un tentativo e l'altro c'è un ampio margine di tempo per non esaurire troppo rapidamente i 5 tentativi.rateLimits.maxConcurrentDispatch=6: vengono inviate al massimo 6 attività alla volta. In questo modo, viene garantito un flusso costante di richieste alla funzione sottostante e viene ridotto il numero di istanze attive e avvii a freddo.
Testare le funzioni della coda di attività
Nella maggior parte dei casi, l'emulatore Cloud Functions è il modo migliore per testare le funzioni della coda delle attività. Consulta la documentazione di Emulator Suite per scoprire come strumentare la tua app per l'emulazione delle funzioni di code di attività.
Inoltre, le funzioni della coda di attività vengono esposte come semplici funzioni HTTP in Firebase Local Emulator Suite. Puoi testare una funzione di attività emulata inviando una richiesta POST HTTP con un payload di dati JSON:
# start the Firebase Emulators
firebase emulators:start
# trigger the emulated task queue function
curl \
-X POST # An HTTP POST request...
-H "content-type: application/json" \ # ... with a JSON body
http://localhost:$PORT/$PROJECT_ID/$REGION/$NAME \ # ... to function url
-d '{"data": { ... some data .... }}' # ... with JSON encoded data
Esegui il deployment delle funzioni della coda di attività
Esegui il deployment della funzione di coda di attività utilizzando l'interfaccia a riga di comando di Firebase:
$ firebase deploy --only functions:backupApod
Quando esegui il deployment di una funzione di coda di attività per la prima volta, la CLI crea una coda di attività in Cloud Tasks con le opzioni (limitazione di frequenza e nuovi tentativi) specificate nel codice sorgente.
Se si verificano errori di autorizzazione durante il deployment delle funzioni, assicurati che all'utente che esegue i comandi di deployment siano assegnati i ruoli IAM appropriati.
Funzioni di coda di attività di accodamento
Le funzioni della coda di attività possono essere inserite in coda in Cloud Tasks da un ambiente server attendibile come Cloud Functions for Firebase utilizzando Firebase Admin SDK per Node.js. Se non hai mai utilizzato Admin SDK, consulta Aggiungere Firebase a un server per iniziare.
In un flusso tipico, Admin SDK crea una nuova attività, la mette in coda in Cloud Tasks e imposta la configurazione per l'attività:
exports.enqueueBackupTasks = functions.https.onRequest(
async (_request, response) => {
const queue = getFunctions().taskQueue("backupApod");
const enqueues = [];
for (let i = 0; i <= 10; i += 1) {
// Enqueue each task with i*60 seconds delay. Our task queue function
// should process ~1 task/min.
const scheduleDelaySeconds = i * 60
enqueues.push(
queue.enqueue(
{ id: `task-${i}` },
{
scheduleDelaySeconds,
dispatchDeadlineSeconds: 60 * 5 // 5 minutes
},
),
);
}
await Promise.all(enqueues);
response.sendStatus(200);
});
scheduleDelaySeconds: il codice di esempio tenta di distribuire l'esecuzione delle attività associando un ritardo di N minuti per l'N-esima attività. Ciò si traduce nell'attivazione di circa 1 attività al minuto. Tieni presente che puoi anche utilizzarescheduleTimese vuoi che Cloud Tasks attivi un'attività a un'ora specifica.dispatchDeadlineSeconds: periodo di tempo massimo Cloud Tasks attenderà il completamento di un'attività. Cloud Tasks eseguirà un nuovo tentativo per l'attività in base alla configurazione dei nuovi tentativi della coda o fino al raggiungimento di questa scadenza. Nell'esempio, la coda è configurata per riprovare l'attività fino a 5 volte, ma l'attività viene annullata automaticamente se l'intero processo (inclusi i tentativi) richiede più di 5 minuti.
Risoluzione dei problemi
Attivare la registrazione di Cloud Tasks
I log di Cloud Tasks contengono informazioni diagnostiche utili, come lo stato della richiesta associata a un'attività. Per impostazione predefinita, i log di Cloud Tasks sono disattivati a causa del volume elevato di log che possono essere generati potenzialmente nel tuo progetto. Ti consigliamo di attivare i log di debug durante lo sviluppo e il debug attivi delle funzioni della coda di attività. Consulta la sezione Attivare la registrazione.
Autorizzazioni IAM
Potresti visualizzare errori PERMISSION DENIED durante l'accodamento delle attività o quando
Cloud Tasks tenta di richiamare le funzioni della coda di attività. Assicurati che il tuo
progetto abbia i seguenti binding IAM:
L'identità utilizzata per accodare le attività a Cloud Tasks deve disporre dell'autorizzazione IAM
cloudtasks.tasks.create.Nell'esempio, questo è il service account predefinito App Engine
gcloud projects add-iam-policy-binding $PROJECT_ID \
--member=serviceAccount:${PROJECT_ID}@appspot.gserviceaccount.com \
--role=roles/cloudtasks.enqueuer
L'identità utilizzata per accodare le attività a Cloud Tasks deve disporre dell'autorizzazione per utilizzare il service account associato a un'attività in Cloud Tasks.
Nell'esempio, questo è il service account predefinito App Engine.
Consulta la documentazione di Google Cloud IAM per istruzioni su come aggiungere il service account predefinito App Engine come utente del service account predefinito App Engine.
L'identità utilizzata per attivare la funzione di coda delle attività deve disporre dell'autorizzazione
cloudfunctions.functions.invoke.Nell'esempio, questo è il service account predefinito App Engine
gcloud functions add-iam-policy-binding $FUNCTION_NAME \
--region=us-central1 \
--member=serviceAccount:${PROJECT_ID}@appspot.gserviceaccount.com \
--role=roles/cloudfunctions.invoker