Déclencheurs Cloud Storage (1re génération)

Vous pouvez déclencher une fonction en réponse à l'importation, à la mise à jour ou à la suppression de fichiers et de dossiers dans Cloud Storage.

Les exemples de cette page sont basés sur une fonction d'exemple qui se déclenche lorsque des fichiers image sont importés dans Cloud Storage. Cette fonction d'exemple montre comment accéder aux attributs d'événement, comment télécharger un fichier sur une Cloud Functions instance, et d'autres principes fondamentaux de la gestion des Cloud Storage événements.

Pour plus d'exemples de cas d'utilisation, consultez la section Que puis-je accomplir avec Cloud Functions ?

Déclencher une fonction lors de Cloud Storage modifications

Utilisez functions.storage pour créer une fonction qui gère les Cloud Storage événements. Selon que vous souhaitez limiter votre fonction à un bucket Cloud Storage spécifique ou utiliser le bucket par défaut, utilisez l'une des options suivantes :

Par exemple, l'exemple de générateur de miniatures est limité au bucket par défaut du projet :

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

Cloud Storage est compatible avec les événements suivants :

  • onArchive Envoyé uniquement lorsqu'un bucket a activé la gestion des versions d'objets. Cet événement indique que la version en ligne d'un objet a été archivée (soit à la suite d'un archivage, soit parce qu'elle a été remplacée lors de l'importation d'un objet portant le même nom).
  • onDelete Envoyé lorsqu'un objet a été définitivement supprimé. Cela inclut les objets écrasés ou supprimés dans le cadre de la configuration du cycle de vie du bucket. Pour les buckets sur lesquels la gestion des versions d'objets est activée, cet événement n'est pas envoyé lorsqu'un objet est archivé (voir onArchive), même si l'archivage s'effectue via la méthode storage.objects.delete.
  • onFinalize Envoyé lorsqu'un objet (ou une nouvelle génération d'un objet existant) est correctement créé dans le bucket. Cela inclut la copie ou la réécriture d'un objet existant. Les échecs d'importation ne génèrent pas cet événement.
  • onMetadataUpdate Envoyé lorsque les métadonnées d'un objet existant sont modifiées.

Définissez l'événement dans le gestionnaire d'événements on, comme indiqué ci-dessus pour onFinalize.

Accéder aux attributs d'objet Cloud Storage

Cloud Functions expose un certain nombre d'attributs d'objet Cloud Storage, tels que size et contentType pour le fichier mis à jour. L' attribut "metageneration" est incrémenté chaque fois que les métadonnées de l' objet sont modifiées. Pour les nouveaux objets, la valeur metageneration est 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.
index.js

L'exemple de génération de miniatures utilise certains de ces attributs pour détecter les cas de sortie dans lesquels la fonction renvoie :

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

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

Télécharger, transformer et importer un fichier

Dans certains cas, il n'est pas nécessaire de télécharger des fichiers depuis Cloud Storage. Toutefois, pour effectuer des tâches intensives telles que la génération d'une image miniature à partir d'un fichier stocké dans Cloud Storage, vous devez télécharger des fichiers sur l'instance de fonctions, c'est-à-dire la machine virtuelle qui exécute votre code.

Pour télécharger et importer facilement des objets dans Cloud Storage, installez le Google Cloud Storage package à l'aide de npm install --save @google-cloud/storage, puis importez-le. Pour utiliser des promesses JavaScript afin de gérer des processus externes tels que les tâches de traitement des miniatures dans l'exemple, importez également child-process-promise :

const functions = require('firebase-functions/v1');
const admin = require('firebase-admin');
admin.initializeApp()
const path = require('path');

//library for resizing images
const sharp = require('sharp');
index.js

Utilisez gcs.bucket.file(filePath).download pour télécharger un fichier dans un répertoire temporaire de votre instance Cloud Functions. À cet emplacement, vous pouvez traiter le fichier si nécessaire, puis l'importer dans Cloud Storage. Lorsque vous effectuez des tâches asynchrones, assurez-vous de renvoyer une promesse JavaScript dans votre rappel.

Exemple : transformation d'image

En utilisant Cloud Functions avec des programmes de traitement d'images tels que sharp, vous pouvez effectuer des manipulations sur des fichiers d'images graphiques. Voici un exemple de création d'une image miniature pour un fichier image importé :

// Download file from bucket.
const bucket = admin.storage().bucket(fileBucket);
const metadata = {
  contentType: contentType,
};
const downloadResponse = await bucket.file(filePath).download();
const imageBuffer = downloadResponse[0];
functions.logger.log("Image downloaded!");

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

// Upload the thumbnail with a 'thumb_' prefix.
const thumbFileName = `thumb_${fileName}`;
const thumbFilePath = path.join(path.dirname(filePath), thumbFileName);
await bucket.file(thumbFilePath).save(thumbnailBuffer, {
  metadata: metadata,
});
return functions.logger.log("Thumbnail uploaded!");
index.js

Ce code crée une miniature de 200 x 200 pour l'image enregistrée dans un répertoire temporaire, puis la réimporte dans Cloud Storage.

Découvrir d'autres exemples

Autres exemples de fonctions de transformation multimédia courantes, y compris le transcodage d'images, la modération de contenu, l'extraction de métadonnées EXIF. La liste complète des exemples est disponible sur GitHub.