Activadores de Cloud Storage

Puedes activar una función en respuesta a la carga, actualización o eliminación de archivos y carpetas en Cloud Storage.

Los ejemplos de esta página se basan en una función de ejemplo que se activa cuando los archivos de imagen se suben a Cloud Storage. En esta función de ejemplo, se muestra cómo acceder a atributos de eventos, cómo descargar un archivo a una instancia de Cloud Functions y otros aspectos fundamentales del control de eventos de Cloud Storage.

Activa una función en los cambios de Cloud Storage

Usa el subpaquete firebase-functions/v2/storage para crear una función que maneje los eventos de Cloud Storage. Según si deseas definir el alcance de la función a un bucket específico de Cloud Storage o utilizar el bucket predeterminado, elige uno de los siguientes patrones:

// scope handler to a specific bucket, using a string parameter
export archivedbucket = onObjectArchived("myBucket", (event) => {
  //…
});

// scope handler to a specific bucket, using storage options parameter
export archivedopts = onObjectArchived({ bucket: "myBucket" }, (event) => {
  //…
});

Por el contrario, el alcance de esta función del generador de miniaturas se limita al bucket predeterminado del proyecto:

exports.generateThumbnail = onObjectFinalized({cpu: 2}, async (event) => {
  // ...
});

Configura la ubicación de la función

La distancia entre la ubicación de la función y la del bucket de Cloud Storage puede generar una latencia de red considerable. Además, una discrepancia entre las ubicaciones puede provocar un error de implementación. A fin de evitar estas situaciones, especifica la ubicación de la función para que coincida con la ubicación del bucket o del activador de una de las siguientes maneras:

  • La ubicación de la función es la misma que la ubicación del activador.
  • La ubicación de la función está dentro de la ubicación del activador (cuando la región del activador es dual o multirregional).
  • La función puede estar en cualquier ubicación si la región del activador está configurada en us-central1.

Controla eventos de Cloud Storage

Cloud Storage admite los siguientes eventos:

Estos son los controladores disponibles para responder a eventos de Cloud Storage:

  • onObjectArchived: Solo se envía cuando un bucket tiene habilitado el control de versiones de objetos. Este evento señala que la versión publicada de un objeto se convirtió en una versión archivada, ya sea porque se la archivó o porque se reemplazó cuando se subió un objeto con el mismo nombre.
  • onObjectDeleted: Se envía cuando se borra un objeto de manera permanente. Incluye los objetos que se reemplazan o se borran según la configuración del ciclo de vida del bucket. En el caso de los buckets que tienen habilitado el control de versiones de objetos, este evento no se envía cuando se archiva un objeto (consulta onArchive), incluso si el archivado se lleva a cabo con el método storage.objects.delete.
  • onObjectFinalized: Se envía cuando se crea correctamente un objeto nuevo (o una nueva generación de un objeto existente) en el bucket. Incluye la copia o la reescritura de un objeto existente. Una carga con errores no activa este evento.
  • onMetadataUpdated: Se envía cuando cambian los metadatos de un objeto existente.

Accede a los atributos de objetos de Cloud Storage

Cloud Functions expone varios atributos de los objetos de Cloud Storage, como size y contentType, del archivo actualizado. El atributo metageneration aumenta siempre que se produce un cambio en los metadatos del objeto. En el caso de los objetos nuevos, el valor de metageneration es 1.

const fileBucket = event.data.bucket; // Storage bucket containing the file.
const filePath = event.data.name; // File path in the bucket.
const contentType = event.data.contentType; // File content type.
index.js

La muestra de generación de miniaturas utiliza algunos de estos atributos para detectar casos de salida en los que el resultado es el siguiente:

// Exit if this is triggered on a file that is not an image.
if (!contentType.startsWith("image/")) {
  return logger.log("This is not an image.");
}
// Exit if the image is already a thumbnail.
const fileName = path.basename(filePath);
if (fileName.startsWith("thumb_")) {
  return logger.log("Already a Thumbnail.");
}
index.js

Descarga, transforma y sube un archivo

En algunos casos, tal vez no sea necesario descargar archivos desde Cloud Storage. Sin embargo, para realizar tareas intensivas, como generar una imagen en miniatura desde un archivo almacenado en Cloud Storage, debes descargar archivos en la instancia de las funciones, es decir, en la máquina virtual que ejecuta el código.

Para descargar objetos y volver a subirlos a Cloud Storage con facilidad, instala el paquete de Google Cloud Storage mediante el comando npm install --save @google-cloud/storage y, luego, impórtalo. A fin de usar promesas de JavaScript para controlar procesos externos, como las tareas de procesamiento de miniaturas de la muestra, importa también child-process-promise de la siguiente manera:

const {onObjectFinalized} = require("firebase-functions/v2/storage");

const {initializeApp} = require("firebase-admin/app");
const {getStorage} = require("firebase-admin/storage");
const logger = require("firebase-functions/logger");
const path = require("path");

// library for image resizing
const sharp = require("sharp");

initializeApp();
index.js

Usa gcs.bucket.file(filePath).download para descargar un archivo en un directorio temporal en tu instancia de Cloud Functions. En esta ubicación, puedes procesar el archivo según sea necesario y, luego, subirlo a Cloud Storage. Cuando ejecutes tareas asíncronas, asegúrate de mostrar una promesa de JavaScript en tu devolución de llamada.

Ejemplo: transformación de imágenes

Con Cloud Functions y los programas de procesamiento de imágenes como ImageMagick, puedes manipular archivos de imagen gráfica. El siguiente es un ejemplo de cómo crear una imagen en miniatura para un archivo de imagen subido:

// Download file into memory from bucket.
const bucket = getStorage().bucket(fileBucket);
const downloadResponse = await bucket.file(filePath).download();
const imageBuffer = downloadResponse[0];
logger.log("Image downloaded!");

// Generate a thumbnail using sharp.
const thumbnailBuffer = await sharp(imageBuffer).resize({
  width: 200,
  height: 200,
  withoutEnlargement: true,
}).toBuffer();
logger.log("Thumbnail created");

// Prefix 'thumb_' to file name.
const thumbFileName = `thumb_${fileName}`;
const thumbFilePath = path.join(path.dirname(filePath), thumbFileName);

// Upload the thumbnail.
const metadata = {contentType: contentType};
await bucket.file(thumbFilePath).save(thumbnailBuffer, {
  metadata: metadata,
});
return logger.log("Thumbnail uploaded!");
index.js

Este código ejecuta el programa de línea de comandos convert de ImageMagick para crear una miniatura de 200 × 200 píxeles de la imagen guardada en un directorio temporal y, luego, la sube a Cloud Storage.

Consulta toda la documentación de los activadores de Google Cloud Storage para obtener más información.