Questa pagina è stata tradotta dall'API Cloud Translation.

Attivare le funzioni Cloud Run utilizzando Cloud Tasks

Questo tutorial mostra come utilizzare Cloud Tasks all'interno di un'applicazione App Engine per attivare una funzione Cloud Run e inviare un'email pianificata.

Nozioni di base sul codice

Questa sezione illustra il codice dell'app e spiega come funziona.

Creazione dell'attività

La pagina indice viene pubblicata utilizzando i gestori in app.yaml. Le variabili necessarie per la creazione delle attività vengono passate come variabili di ambiente.

runtime: nodejs16

env_variables:
  QUEUE_NAME: "my-queue"
  QUEUE_LOCATION: "us-central1"
  FUNCTION_URL: "https://<region>-<project_id>.cloudfunctions.net/sendEmail"
  SERVICE_ACCOUNT_EMAIL: "<member>@<project_id>.iam.gserviceaccount.com"

# Handlers for serving the index page.
handlers:
  - url: /static
    static_dir: static
  - url: /
    static_files: index.html
    upload: index.html

Questo codice crea l'endpoint /send-email. Questo endpoint gestisce gli invii di moduli dalla pagina indice e passa i dati al codice di creazione dell'attività.

app.post('/send-email', (req, res) => {
  // Set the task payload to the form submission.
  const {to_name, from_name, to_email, date} = req.body;
  const payload = {to_name, from_name, to_email};

  createHttpTaskWithToken(
    process.env.GOOGLE_CLOUD_PROJECT,
    QUEUE_NAME,
    QUEUE_LOCATION,
    FUNCTION_URL,
    SERVICE_ACCOUNT_EMAIL,
    payload,
    date
  );

  res.status(202).send('📫 Your postcard is in the mail! 💌');
});

Questo codice crea effettivamente l'attività e la invia alla coda di Cloud Tasks. Il codice crea l'attività:

Specifica il tipo di target come HTTP Request.
Specificando il HTTP method da utilizzare e il URL del target.
Impostazione dell'intestazione Content-Type su application/json in modo che le applicazioni downstream possano analizzare il payload strutturato.
Aggiunta di un indirizzo email del service account in modo che Cloud Tasks possa fornire le credenziali alla destinazione della richiesta, che richiede l'autenticazione. Il account di servizio viene creato separatamente.
Verifica che l'input utente dell'utente per la data rientri nel limite massimo di 30 giorni e lo aggiunge alla richiesta come campo scheduleTime.

const MAX_SCHEDULE_LIMIT = 30 * 60 * 60 * 24; // Represents 30 days in seconds.

const createHttpTaskWithToken = async function (
  project = 'my-project-id', // Your GCP Project id
  queue = 'my-queue', // Name of your Queue
  location = 'us-central1', // The GCP region of your queue
  url = 'https://example.com/taskhandler', // The full url path that the request will be sent to
  email = '<member>@<project-id>.iam.gserviceaccount.com', // Cloud IAM service account
  payload = 'Hello, World!', // The task HTTP request body
  date = new Date() // Intended date to schedule task
) {
  // Imports the Google Cloud Tasks library.
  const {v2beta3} = require('@google-cloud/tasks');

  // Instantiates a client.
  const client = new v2beta3.CloudTasksClient();

  // Construct the fully qualified queue name.
  const parent = client.queuePath(project, location, queue);

  // Convert message to buffer.
  const convertedPayload = JSON.stringify(payload);
  const body = Buffer.from(convertedPayload).toString('base64');

  const task = {
    httpRequest: {
      httpMethod: 'POST',
      url,
      oidcToken: {
        serviceAccountEmail: email,
        audience: url,
      },
      headers: {
        'Content-Type': 'application/json',
      },
      body,
    },
  };

  const convertedDate = new Date(date);
  const currentDate = new Date();

  // Schedule time can not be in the past.
  if (convertedDate < currentDate) {
    console.error('Scheduled date in the past.');
  } else if (convertedDate > currentDate) {
    const date_diff_in_seconds = (convertedDate - currentDate) / 1000;
    // Restrict schedule time to the 30 day maximum.
    if (date_diff_in_seconds > MAX_SCHEDULE_LIMIT) {
      console.error('Schedule time is over 30 day maximum.');
    }
    // Construct future date in Unix time.
    const date_in_seconds =
      Math.min(date_diff_in_seconds, MAX_SCHEDULE_LIMIT) + Date.now() / 1000;
    // Add schedule time to request in Unix time using Timestamp structure.
    // https://googleapis.dev/nodejs/tasks/latest/google.protobuf.html#.Timestamp
    task.scheduleTime = {
      seconds: date_in_seconds,
    };
  }

  try {
    // Send create task request.
    const [response] = await client.createTask({parent, task});
    console.log(`Created task ${response.name}`);
    return response.name;
  } catch (error) {
    // Construct error for Stackdriver Error Reporting
    console.error(Error(error.message));
  }
};

module.exports = createHttpTaskWithToken;

Creazione dell'email

Questo codice crea la funzione Cloud Run che è la destinazione della richiesta Cloud Tasks. Utilizza il corpo della richiesta per creare un'email e inviarla tramite l'API SendGrid.

const sendgrid = require('@sendgrid/mail');

/**
 * Responds to an HTTP request from Cloud Tasks and sends an email using data
 * from the request body.
 *
 * @param {object} req Cloud Function request context.
 * @param {object} req.body The request payload.
 * @param {string} req.body.to_email Email address of the recipient.
 * @param {string} req.body.to_name Name of the recipient.
 * @param {string} req.body.from_name Name of the sender.
 * @param {object} res Cloud Function response context.
 */
exports.sendEmail = async (req, res) => {
  // Get the SendGrid API key from the environment variable.
  const key = process.env.SENDGRID_API_KEY;
  if (!key) {
    const error = new Error(
      'SENDGRID_API_KEY was not provided as environment variable.'
    );
    error.code = 401;
    throw error;
  }
  sendgrid.setApiKey(key);

  // Get the body from the Cloud Task request.
  const {to_email, to_name, from_name} = req.body;
  if (!to_email) {
    const error = new Error('Email address not provided.');
    error.code = 400;
    throw error;
  } else if (!to_name) {
    const error = new Error('Recipient name not provided.');
    error.code = 400;
    throw error;
  } else if (!from_name) {
    const error = new Error('Sender name not provided.');
    error.code = 400;
    throw error;
  }

  // Construct the email request.
  const msg = {
    to: to_email,
    from: 'postcard@example.com',
    subject: 'A Postcard Just for You!',
    html: postcardHTML(to_name, from_name),
  };

  try {
    await sendgrid.send(msg);
    // Send OK to Cloud Task queue to delete task.
    res.status(200).send('Postcard Sent!');
  } catch (error) {
    // Any status code other than 2xx or 503 will trigger the task to retry.
    res.status(error.code).send(error.message);
  }
};

Preparazione della richiesta

Configurazione di SendGrid

Crea un account SendGrid.
- Puoi farlo manualmente tramite il sito web di SendGrid
- In alternativa, puoi utilizzare Google Cloud Launcher, che creerà un account per te e integrerà la fatturazione. Consulta Creare un account SendGrid utilizzando Cloud Launcher.
Crea una chiave API SendGrid:
1. Accedi al tuo account SendGrid.
2. Nel menu di navigazione a sinistra, apri Impostazioni e fai clic su Chiavi API.
3. Fai clic su Crea chiave API e seleziona l'accesso limitato. Nella sezione Invio posta, seleziona Accesso completo.
4. Copia la chiave API quando viene visualizzata (la vedrai una sola volta, quindi assicurati di incollarla da qualche parte per poterla utilizzare in un secondo momento).

Download del codice sorgente

Clona il repository dell'app di esempio sulla tua macchina locale:

git clone https://github.com/GoogleCloudPlatform/nodejs-docs-samples.git

Passa alla directory che contiene il codice di esempio:
```
cd cloud-tasks/
```

Deployment della funzione Cloud Run

Vai alla directory function/:
```
cd function/
```
Esegui il deployment della funzione:
```
gcloud functions deploy sendEmail --runtime nodejs14 --trigger-http \
  --no-allow-unauthenticated \
  --set-env-vars SENDGRID_API_KEY=SENDGRID_API_KEY \
```
Sostituisci SENDGRID_API_KEY con la tua chiave API.

Questo comando utilizza i seguenti flag:
- --trigger-http per specificare il tipo di trigger di Cloud Run Functions.
- --no-allow-unauthenticated per specificare la chiamata di funzione richiede l'autenticazione.
- --set-env-var per impostare le credenziali SendGrid
Nota: puoi gestire le funzioni Cloud Run sia dalla console Firebase sia da Google Cloud . La scrittura e il deployment da FirebaseUI possono essere replicati, ma il codice della funzione deve corrispondere al framework delle funzioni Firebase. Scopri di più su come iniziare a utilizzare le funzioni Firebase e i trigger HTTP.
Imposta controllo dell'accesso per la funzione in modo da consentire solo agli utenti autenticati.
1. Seleziona la funzione sendEmail nell'UI di Cloud Run Functions.
2. Se non vedi le informazioni sulle autorizzazioni per sendEmail, fai clic su MOSTRA RIQUADRO INFORMAZIONI nell'angolo in alto a destra.
3. Fai clic sul pulsante Aggiungi entità sopra.
4. Imposta Nuove entità su allAuthenticatedUsers.
5. Imposta il Ruolo.
  - Funzioni di prima generazione (1ª generazione): imposta il ruolo su Cloud Function Invoker
  - Funzioni di seconda generazione (2ª generazione.): imposta il ruolo su Cloud Run Invoker
6. Fai clic su SALVA.

Creazione di una coda di attività Cloud Tasks

Crea una coda utilizzando il seguente comando gcloud:
```
gcloud tasks queues create my-queue --location=LOCATION
```
Sostituisci LOCATION con la tua posizione preferita per la coda, ad esempio us-west2. Se non specifichi la località, gcloud CLI sceglie quella predefinita.
Verifica che sia stato creato correttamente:
```
gcloud tasks queues describe my-queue --location=LOCATION
```
Sostituisci LOCATION con la posizione della coda.

Creazione di un account di servizio

La richiesta Cloud Tasks deve fornire le credenziali nell'intestazione Authorization affinché la funzione Cloud Run autentichi la richiesta. Questo account di servizio consente a Cloud Tasks di creare e aggiungere un token OIDC a questo scopo.

Nell'interfaccia utente degli account di servizio, fai clic su +CREA SERVICE ACCOUNT.
Aggiungi un nome account di servizio(nome visualizzato descrittivo) e seleziona Crea.
Imposta il ruolo e fai clic su Continua.
- Funzioni di prima generazione (1ª generazione): imposta il ruolo su Cloud Function Invoker
- Funzioni di seconda generazione (2ª generazione.): imposta il ruolo su Cloud Run Invoker
Seleziona Fine.

Deployment dell'endpoint e del creatore di attività in App Engine

Vai alla directory app/:
```
cd ../app/
```

Aggiorna le variabili in app.yaml con i tuoi valori:

env_variables:
  QUEUE_NAME: "my-queue"
  QUEUE_LOCATION: "us-central1"
  FUNCTION_URL: "https://<region>-<project_id>.cloudfunctions.net/sendEmail"
  SERVICE_ACCOUNT_EMAIL: "<member>@<project_id>.iam.gserviceaccount.com"

Per trovare la posizione della coda, utilizza il seguente comando:

gcloud tasks queues describe my-queue --location=LOCATION

Sostituisci LOCATION con la posizione della coda.

Per trovare l'URL della funzione, utilizza il seguente comando:

gcloud functions describe sendEmail

Esegui il deployment dell'applicazione nell'ambiente standard di App Engine utilizzando il seguente comando:
```
gcloud app deploy
```
Apri l'applicazione per inviare una cartolina come email:
```
gcloud app browse
```