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. Esta función de ejemplo 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.

Para ver más ejemplos de casos de uso, consulta ¿Qué puedo hacer con Cloud Functions?

Activa una función en los cambios de Cloud Storage

Usa functions.storage para crear una función que controle los eventos de Cloud Storage. Según si deseas definir el alcance de la función para un depósito específico de Cloud Storage o usar el depósito predeterminado, usa una de las siguientes opciones:

Por ejemplo, la muestra del generador de miniaturas se limita al depósito predeterminado para el proyecto:

exports.generateThumbnail = functions.storage.object().onFinalize((object) => {
  // ...
});

Cloud Storage admite los siguientes eventos:

  • onArchive: Solo se envía cuando un depósito habilita 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.
  • onDelete: Se envía cuando un objeto se borra permanentemente. Incluye los objetos que se sobrescriben o que se borran según la configuración del ciclo de vida del depósito. En el caso de los depósitos que tienen habilitado el control de versiones de objetos, no se envía cuando se archiva un objeto (consulta onArchive), incluso si se realiza el archivado con el método storage.objects.delete.
  • onFinalize: Se envía cuando un nuevo objeto (o una nueva generación de un objeto existente) se crea correctamente en el depósito. Incluye la copia y la reescritura de un objeto existente. Una carga con errores no activa este evento.
  • onMetadataUpdate: Se envía cuando cambian los metadatos de un objeto existente.

Configura el evento dentro del controlador de evento on como se muestra en el ejemplo anterior para onFinalize.

Accede a los atributos de objetos de Storage

Cloud Functions expone varios atributos de objeto de Storage, como size y contentType, para el archivo actualizado. El atributo resourceState de un evento tiene el valor "exists" (para la creación y actualización de objetos) o "not_exists" (para la eliminación y el traslado de objetos). Si quieres determinar si un objeto se creó recientemente, debes sincronizar el atributo resourceState con el atributo “metageneration”. El atributo metageneration aumenta siempre que se produce un cambio en los metadatos del objeto. En los objetos nuevos, el valor de metageneration es 1.

const fileBucket = object.bucket; // The Storage bucket that contains the file.
const filePath = object.name; // File path in the bucket.
const contentType = object.contentType; // File content type.
const metageneration = object.metageneration; // Number of times metadata has been generated. New objects have a value of 1.

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

// Exit if this is triggered on a file that is not an image.
if (!contentType.startsWith('image/')) {
  console.log('This is not an image.');
  return null;
}

// Get the file name.
const fileName = path.basename(filePath);
// Exit if the image is already a thumbnail.
if (fileName.startsWith('thumb_')) {
  console.log('Already a Thumbnail.');
  return null;
}

Descarga, transforma y sube un archivo

En algunos casos, es posible que 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 con facilidad a Cloud Storage, instala el paquete de Google Cloud Storage mediante npm install --save @google-cloud/storage. 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 functions = require('firebase-functions');
const gcs = require('@google-cloud/storage')();
const spawn = require('child-process-promise').spawn;
const path = require('path');
const os = require('os');
const fs = require('fs');

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 la imagen

Cloud Functions proporciona un programa de procesamiento de imágenes llamado ImageMagick que tiene la capacidad de manipular archivos de imagen. El siguiente es un ejemplo de cómo crear una imagen en miniatura para un archivo de imagen subido:

// Download file from bucket.
const bucket = gcs.bucket(fileBucket);
const tempFilePath = path.join(os.tmpdir(), fileName);
const metadata = {
  contentType: contentType,
};
return bucket.file(filePath).download({
  destination: tempFilePath,
}).then(() => {
  console.log('Image downloaded locally to', tempFilePath);
  // Generate a thumbnail using ImageMagick.
  return spawn('convert', [tempFilePath, '-thumbnail', '200x200>', tempFilePath]);
}).then(() => {
  console.log('Thumbnail created at', tempFilePath);
  // We add a 'thumb_' prefix to thumbnails file name. That's where we'll upload the thumbnail.
  const thumbFileName = `thumb_${fileName}`;
  const thumbFilePath = path.join(path.dirname(filePath), thumbFileName);
  // Uploading the thumbnail.
  return bucket.upload(tempFilePath, {
    destination: thumbFilePath,
    metadata: metadata,
  });
  // Once the thumbnail has been uploaded delete the local file to free up disk space.
}).then(() => fs.unlinkSync(tempFilePath));

Este código ejecuta el programa de línea de comandos ImageMagick de convert para crear una miniatura de 200 x 200 de la imagen guardada en un directorio temporal y después la sube a Cloud Storage.

Explora más ejemplos

Consulta más ejemplos de funciones comunes de transformación de contenido multimedia, como transcodificación de imágenes, moderación de contenido y extracción de metadatos EXIF. La lista completa de ejemplos está disponible en GitHub.

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

Enviar comentarios sobre…

¿Necesitas ayuda? Visita nuestra página de asistencia.