Acionadores do Firebase Authentication

As funções do Cloud Run podem ser acionadas por eventos do Firebase Authentication no mesmo Google Cloud projeto que a função. Estes eventos incluem a criação e a eliminação de utilizadores. Por exemplo, pode enviar um email de boas-vindas a um utilizador que acabou de criar uma conta na sua app.

Tipos de eventos

A Firebase Authentication pode acionar funções em resposta a eventos de create e delete do utilizador.

Tipo de evento Acionador
providers/firebase.auth/eventTypes/user.create Acionado quando é criada uma conta de utilizador.
providers/firebase.auth/eventTypes/user.delete Acionado quando uma conta de utilizador é eliminada.

Criação de utilizador

As contas do Firebase acionam eventos de criação de utilizadores para funções do Cloud Run quando:

  • Um utilizador cria uma conta de email e uma palavra-passe.

  • Um utilizador inicia sessão pela primeira vez através de um fornecedor de identidade federada.

  • O programador cria uma conta através do SDK de administração do Firebase.

  • Um utilizador inicia sessão numa nova sessão de autenticação anónima pela primeira vez.

Eliminação de utilizador

Também pode configurar uma função para ser acionada quando um utilizador é eliminado.

Estrutura de eventos

Os dados de eventos são fornecidos como um objeto UserRecord.

Segue-se um exemplo de um evento de criação de uma conta baseada em palavra-passe:

{
  "email": "me@example.com",
  "metadata": {
      "createdAt": "2018-10-19T19:29:16Z"
  },
  "uid": "XXXXX"
}

Algumas propriedades deste objeto só são definidas quando são usados determinados métodos de autenticação. Por exemplo, os eventos de conta baseada em palavra-passe definem uma propriedade email que contém o endereço de email do utilizador. A propriedade uid (que contém um ID do utilizador exclusivo do seu projeto) está sempre definida.

Exemplo de código

Node.js 

/**
 * Background Function triggered by a change to a Firebase Auth user object.
 *
 * @param {!Object} event The Cloud Functions event.
 */
exports.helloAuth = event => {
  try {
    console.log(`Function triggered by change to user: ${event.uid}`);
    console.log(`Created at: ${event.metadata.createdAt}`);

    if (event.email) {
      console.log(`Email: ${event.email}`);
    }
  } catch (err) {
    console.error(err);
  }
};

Python 

import json

def hello_auth(data, context):
    """Triggered by creation or deletion of a Firebase Auth user object.
    Args:
           data (dict): The event payload.
           context (google.cloud.functions.Context): Metadata for the event.
    """
    print("Function triggered by creation/deletion of user: %s" % data["uid"])
    print("Created at: %s" % data["metadata"]["createdAt"])

    if "email" in data:
        print("Email: %s" % data["email"])

Go 


// Package firebase contains a Firestore Cloud Function.
package firebase

import (
	"context"
	"log"
	"time"
)

// AuthEvent is the payload of a Firestore Auth event.
type AuthEvent struct {
	Email    string `json:"email"`
	Metadata struct {
		CreatedAt time.Time `json:"createdAt"`
	} `json:"metadata"`
	UID string `json:"uid"`
}

// HelloAuth is triggered by Firestore Auth events.
func HelloAuth(ctx context.Context, e AuthEvent) error {
	log.Printf("Function triggered by creation or deletion of user: %q", e.UID)
	log.Printf("Created at: %v", e.Metadata.CreatedAt)
	if e.Email != "" {
		log.Printf("Email: %q", e.Email)
	}
	return nil
}

Java 

import com.google.cloud.functions.Context;
import com.google.cloud.functions.RawBackgroundFunction;
import com.google.gson.Gson;
import com.google.gson.JsonObject;
import java.util.logging.Logger;

public class FirebaseAuth implements RawBackgroundFunction {
  private static final Logger logger = Logger.getLogger(FirebaseAuth.class.getName());

  // Use GSON (https://github.com/google/gson) to parse JSON content.
  private static final Gson gson = new Gson();

  @Override
  public void accept(String json, Context context) {
    JsonObject body = gson.fromJson(json, JsonObject.class);

    if (body != null && body.has("uid")) {
      logger.info("Function triggered by change to user: " + body.get("uid").getAsString());
    }

    if (body != null && body.has("metadata")) {
      JsonObject metadata = body.get("metadata").getAsJsonObject();
      logger.info("Created at: " + metadata.get("createdAt").getAsString());
    }

    if (body != null && body.has("email")) {
      logger.info("Email: " + body.get("email").getAsString());
    }
  }
}

C# 

using CloudNative.CloudEvents;
using Google.Cloud.Functions.Framework;
using Google.Events.Protobuf.Firebase.Auth.V1;
using Microsoft.Extensions.Logging;
using System.Threading;
using System.Threading.Tasks;

namespace FirebaseAuth;

public class Function : ICloudEventFunction<AuthEventData>
{
    private readonly ILogger _logger;

    public Function(ILogger<Function> logger) =>
        _logger = logger;

    public Task HandleAsync(CloudEvent cloudEvent, AuthEventData data, CancellationToken cancellationToken)
    {
        _logger.LogInformation("Function triggered by change to user: {uid}", data.Uid);
        if (data.Metadata is UserMetadata metadata)
        {
            _logger.LogInformation("User created at: {created:s}", metadata.CreateTime.ToDateTimeOffset());
        }
        if (!string.IsNullOrEmpty(data.Email))
        {
            _logger.LogInformation("Email: {email}", data.Email);
        }

        // In this example, we don't need to perform any asynchronous operations, so the
        // method doesn't need to be declared async.
        return Task.CompletedTask;
    }
}

Ruby 

require "functions_framework"

# Triggered by creation or deletion of a Firebase Auth user object.
FunctionsFramework.cloud_event "hello_auth" do |event|
  # Event-triggered Ruby functions receive a CloudEvents::Event::V1 object.
  # See https://cloudevents.github.io/sdk-ruby/latest/CloudEvents/Event/V1.html
  # The Firebase event payload can be obtained from the `data` field.
  payload = event.data

  logger.info "Function triggered by creation/deletion of user: #{payload['uid']}"
  logger.info "Created at: #{payload['metadata']['createdAt']}"
  logger.info "Email: #{payload['email']}" if payload.key? "email"
end

PHP 

use Google\CloudFunctions\CloudEvent;

function firebaseAuth(CloudEvent $cloudevent)
{
    $log = fopen(getenv('LOGGER_OUTPUT') ?: 'php://stderr', 'wb');
    $data = $cloudevent->getData();

    fwrite(
        $log,
        'Function triggered by change to user: ' . $data['uid'] . PHP_EOL
    );
    fwrite($log, 'Created at: ' . $data['metadata']['createTime'] . PHP_EOL);

    if (isset($data['email'])) {
        fwrite($log, 'Email: ' . $data['email'] . PHP_EOL);
    }
}

Implementar a sua função

Para implementar a sua função, tem de especificar o tipo de evento e o projeto para o qual tem o Firebase Auth configurado. Na Google Cloud consola, existe um único campo para Tipo de evento, uma vez que se assume que o projeto é o mesmo que o projeto que contém a sua função.

No entanto, na linha de comandos, tem de usar strings específicas para especificar estes dois parâmetros. O comando gcloud seguinte implementa uma função que é acionada por eventos create do utilizador:

gcloud functions deploy FUNCTION_NAME \
  --no-gen2 \
  --entry-point ENTRY_POINT \
  --trigger-event providers/firebase.auth/eventTypes/user.create \
  --trigger-resource YOUR_PROJECT_ID \
  --runtime RUNTIME
Argumento Descrição
FUNCTION_NAME O nome registado das funções do Cloud Run que está a implementar. Pode ser o nome de uma função no seu código-fonte ou uma string arbitrária. Se FUNCTION_NAME for uma string arbitrária, tem de incluir a flag --entry-point.
--entry-point ENTRY_POINT O nome de uma função ou classe no seu código-fonte. Opcional, a menos que não tenha usado FUNCTION_NAME para especificar a função no código fonte a ser executada durante a implementação. Nesse caso, tem de usar --entry-point para indicar o nome da função executável.
--trigger-event NAME O nome do tipo de evento que aciona a função. Neste caso, deve ser uma das opções criar ou eliminar, conforme indicado acima.
--trigger-resource NAME O ID do projeto (neste exemplo, YOUR_PROJECT_ID) para o projeto que contém a sua função e a autenticação do Firebase.
--runtime RUNTIME O nome do tempo de execução que está a usar. Para ver uma lista completa, consulte a gcloud referência.