Creazione dei gestori di attività

Questa pagina descrive come creare un gestore di attività, ovvero il codice che gestisce un'attività push. Devi fornire un gestore delle richieste per elaborare l'attività. La mappatura dall'URL della richiesta al gestore appropriato viene dichiarata nel fileapp.yamldel tuo servizio, proprio come qualsiasi altro gestore delle richieste. Poiché sei tu a controllare come mappare le richieste di attività a un gestore, puoi organizzare i gestori delle attività come preferisci. Se l'applicazione elabora molti tipi diversi di attività, puoi aggiungere tutti i gestori a un singolo servizio o distribuirli tra più servizi.

Scrittura di un gestore delle richieste di attività push

Nella coda, il servizio coda di attività crea un'intestazione HTTP e la invia a un'istanza del servizio worker specificato dalla destinazione dell'attività. Le richieste della coda di attività vengono inviate dall'indirizzo IP 0.1.0.2.

Il gestore non deve essere scritto nello stesso linguaggio che ha creato e inserito in coda l'attività se il gestore si trova in un servizio separato.

Quando scrivi il gestore, segui queste linee guida:

  • Il codice deve restituire un codice di stato HTTP compreso nell'intervallo 200-299 per indicare l'esito positivo. Qualsiasi altro codice indica che l'attività non è riuscita.

  • Le attività push hanno una scadenza di completamento fissa che dipende dal tipo di scalabilità del servizio che le esegue. I servizi di scalabilità automatica devono terminare entro 10 minuti. I servizi di scalabilità manuale e di base possono essere eseguiti per un massimo di 24 ore. Se il gestore non rispetta la scadenza, il servizio coda di attività presuppone che l'attività non sia riuscita e riproverà.

    Quando il tempo di esecuzione di un'attività si avvicina alla scadenza, App Engine genera un'eccezione DeadlineExceededError (dal modulo google.appengine.runtime) prima che venga raggiunta la scadenza, in modo da poter salvare il lavoro o registrare i progressi compiuti.

  • Il gestore deve essere idempotente. L'API Coda di attività di App Engine è progettata per fornire la distribuzione "at-least-once". In altre parole, se un'attività viene aggiunta correttamente, App Engine la distribuirà a un gestore almeno una volta. Tieni presente che in alcune rare circostanze è possibile l'esecuzione di più attività, pertanto il codice deve garantire che non si verifichino effetti collaterali dannosi dell'esecuzione ripetuta.

La coda di attività utilizza il codice HTTP nella risposta del gestore per determinare se l'attività è riuscita. La risposta del gestore viene visualizzata solo dal servizio coda di attività e solo per determinare se l'attività è riuscita. La coda ignora tutti gli altri campi della risposta. Il servizio elimina quindi la risposta. L'app di origine non riceve mai i dati. Se un'attività non va a buon fine, il servizio coda di attività riprova l'attività inviando un'altra richiesta.

I dati forniti dall'utente possono essere inviati al gestore nella richiesta come stringa di query o come payload nel corpo della richiesta. L'inserimento dei dati utente è descritto in Creazione di attività. Se la richiesta include dati, il gestore deve sapere come sono stati inseriti nella richiesta. Il codice esatto che utilizzi per recuperare i dati dalla richiesta dipende dal framework web specifico che utilizzi.

Per testare un gestore di attività, accedi come amministratore e visita l'URL del gestore nel browser.

Lettura delle intestazioni delle richieste

Una richiesta HTTP di un'attività push ha intestazioni speciali impostate da App Engine, che contengono informazioni specifiche dell'attività che il gestore può utilizzare.

Se queste intestazioni sono presenti in una richiesta di un utente esterno alla tua app, vengono rimosse e sostituite. L'unica eccezione riguarda le richieste degli amministratori dell'applicazione che hanno eseguito l'accesso, ai quali è consentito impostare le intestazioni a scopo di test. Invece, le intestazioni non vengono rimosse quando l'app è in esecuzione nel server di sviluppo.

Le richieste provenienti dalla coda di attività conterranno sempre le seguenti intestazioni:

Intestazione Descrizione
X-Appengine-QueueName Il nome della coda (probabilmente "default" per la coda in modalità push predefinita).
X-Appengine-TaskName Il nome dell'attività o un ID univoco generato dal sistema se non è stato specificato alcun nome.
X-Appengine-TaskRetryCount Il numero di volte in cui è stato ritentato questo task. Per il primo tentativo, questo valore è 0. Questo numero include i tentativi in cui l'attività non è riuscita a causa della mancanza di istanze disponibili e non ha mai raggiunto la fase di esecuzione.
X-Appengine-TaskExecutionCount Il numero di volte in cui questa attività non è riuscita in precedenza durante la fase di esecuzione. Questo numero non include gli errori dovuti alla mancanza di istanze disponibili.
X-Appengine-TaskETA Il tempo di esecuzione target dell'attività, specificato in secondi dal 1° gennaio 1970.

Se il gestore delle richieste trova una delle intestazioni elencate sopra, può considerare attendibile la richiesta come richiesta di coda di attività.

Inoltre, le richieste provenienti dalla coda di attività possono contenere le seguenti intestazioni:

Intestazione Descrizione
X-Appengine-TaskPreviousResponse Il codice di risposta HTTP del tentativo precedente.
X-Appengine-TaskRetryReason Il motivo per cui l'attività viene ripetuta.
X-Appengine-FailFast Indica che un'attività in esecuzione non va a buon fine immediatamente se non è disponibile un'istanza esistente.

Protezione degli URL dei gestori delle attività

Se un'attività esegue operazioni sensibili (ad esempio la modifica dei dati), ti consigliamo di proteggere l'URL del gestore per impedire a un utente esterno malintenzionato di chiamarlo direttamente. Puoi impedire agli utenti di accedere agli URL delle attività limitando l'accesso agli amministratori di App Engine. Le richieste di attività stesse vengono emesse da App Engine e possono sempre avere come target un URL limitato.

Puoi limitare un URL aggiungendo l'elemento login: admin alla configurazione del gestore nel file app.yaml.

Ad esempio:

handlers:
- url: /your-task
  script: worker.app
  login: admin

Passaggi successivi