Cloud Storage ট্রিগার

Cloud Storage-এ ফাইল ও ফোল্ডার আপলোড, আপডেট বা মুছে ফেলার পরে আপনি কোনও ফাংশন ট্রিগার করতে পারবেন।

এই পৃষ্ঠায় দেওয়া উদাহরণগুলি এমন একটি স্যাম্পেল ফাংশনের উপর ভিত্তি করে তৈরি করা হয়েছে যা Cloud Storage-এ ছবি ফাইল আপলোড করা হলে ট্রিগার হয়। এই নমুনা ফাংশন দেখায় যে কীভাবে ইভেন্ট অ্যাট্রিবিউট অ্যাক্সেস করতে হয়, কীভাবে Cloud Functions ইনস্ট্যান্সে ফাইল ডাউনলোড করতে হয় এবং Cloud Storage ইভেন্ট ম্যানেজ করার অন্যান্য ফান্ডামেন্টাল।

প্রয়োজনীয় মডিউল ইমপোর্ট করুন

শুরু করতে, Cloud Storage ইভেন্ট ম্যানেজ করার জন্য প্রয়োজনীয় মডিউল ইমপোর্ট করুন:

Node.js

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

Python

 from firebase_functions import storage_fn

সম্পূর্ণ স্যাম্পেল তৈরি করতে, Firebase Admin SDK ও ছবি প্রসেসিং টুলের জন্য প্রয়োজনীয় বিষয়গুলিও যোগ করুন:

Node.js

 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 = /** @type {typeof import("sharp")} */ (require("sharp"));

initializeApp();

Python

 import io
import pathlib

from PIL import Image

from firebase_admin import initialize_app

initialize_app()
from firebase_admin import storage

Cloud Storage ফাংশনের স্কোপ

নির্দিষ্ট Cloud Storage বাকেটে আপনার ফাংশনের স্কোপ করতে এবং কোনও পছন্দসই বিকল্প সেট করতে নিম্নলিখিত প্যাটার্ন ব্যবহার করুন:

Node.js

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

Python

# Scope handler to a specific bucket using storage options parameter
@storage_fn.on_object_archived(bucket="myBucket")
def archived_bucket(event: storage_fn.CloudEvent[storage_fn.StorageObjectData]):
    # ...

অন্যদিকে, উদাহরণ থাম্বনেল জেনারেটর ফাংশনটি প্রোজেক্টের ডিফল্ট বাকেটের মধ্যে সীমাবদ্ধ:

Node.js

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

Python

@storage_fn.on_object_archived()
def generatethumbnail(event: storage_fn.CloudEvent[storage_fn.StorageObjectData]):
    # ...

ফাংশনের লোকেশন সেট করা

লোকেশন ম্যাচ না করলে, ডিপ্লয়মেন্ট ব্যর্থ হতে পারে। এছাড়াও, Cloud Storageবাকেটের লোকেশন ও ফাংশনের লোকেশনের মধ্যে দূরত্ব উল্লেখযোগ্য নেটওয়ার্ক লেটেন্সি তৈরি করতে পারে। এইসব পরিস্থিতি এড়াতে, ফাংশন লোকেশন নির্দিষ্ট করুন যাতে এটি এইসব উপায়ের মধ্যে কোনও একটিতে বাকেট/ট্রিগার লোকেশনের সাথে ম্যাচ করে:

  • ফাংশন লোকেশন ও ট্রিগার লোকেশন একই
  • ফাংশন লোকেশন ট্রিগার লোকেশনের মধ্যে থাকে (যখন ট্রিগার অঞ্চল ডুয়াল/মাল্টি অঞ্চল হয়)
  • ট্রিগার অঞ্চল us-central1 হিসেবে সেট করা থাকলে ফাংশন যেকোনও লোকেশনে থাকতে পারে

Cloud Storage ইভেন্ট ম্যানেজ করা

Cloud Storage ইভেন্টের উত্তর দেওয়ার জন্য এইসব হ্যান্ডলার উপলভ্য:

Node.js

  • onObjectArchived কোনও বাকেটে অবজেক্ট ভার্সনিং চালু করা থাকলে তবেই পাঠানো হয়। এই ইভেন্ট থেকে বোঝা যায় যে কোনও অবজেক্টের লাইভ ভার্সনটি একটি আর্কাইভ করা ভার্সন হয়ে গেছে, এটি আর্কাইভ করা হয়েছে অথবা একই নামের কোনও অবজেক্ট আপলোড করে ওভাররাইট করা হয়েছে।
  • onObjectDeleted কোনও অবজেক্ট স্থায়ীভাবে মুছে দেওয়া হলে পাঠানো হয়। এর মধ্যে লাইফসাইকেল কনফিগারেশনের অংশ হিসেবে ওভাররাইট করা বা মুছে ফেলা অবজেক্ট অন্তর্ভুক্ত। অবজেক্ট ভার্সনিং চালু করা আছে এমন বাকেটের ক্ষেত্রে, কোনও অবজেক্ট আর্কাইভ করা হলে (onArchive দেখুন), এটি পাঠানো হয় না, এমনকি storage.objects.delete পদ্ধতির মাধ্যমে আর্কাইভ করা হলেও।
  • onObjectFinalized কোনও নতুন অবজেক্ট (বা আগে থেকে থাকা অবজেক্টের নতুন জেনারেশন) বাকেটে সফলভাবে তৈরি হলে পাঠানো হয়। এর মধ্যে আগে থেকে থাকা কোনও অবজেক্ট কপি করা বা আবার লেখা অন্তর্ভুক্ত। আপলোড করা না গেলে এই ইভেন্ট ট্রিগার হয় না।
  • onMetadataUpdated আগে থেকে থাকা কোনও অবজেক্টের মেটাডেটা পরিবর্তন হলে পাঠানো হয়।

Python

  • on_object_archived কোনও বাকেটে অবজেক্ট ভার্সনিং চালু করা থাকলে তবেই পাঠানো হয়। এই ইভেন্ট থেকে বোঝা যায় যে কোনও অবজেক্টের লাইভ ভার্সনটি একটি আর্কাইভ করা ভার্সন হয়ে গেছে, এটি আর্কাইভ করা হয়েছে অথবা একই নামের কোনও অবজেক্ট আপলোড করে ওভাররাইট করা হয়েছে।
  • on_object_deleted কোনও অবজেক্ট স্থায়ীভাবে মুছে দেওয়া হলে পাঠানো হয়। এর মধ্যে লাইফসাইকেল কনফিগারেশনের অংশ হিসেবে ওভাররাইট করা বা মুছে ফেলা অবজেক্ট অন্তর্ভুক্ত। অবজেক্ট ভার্সনিং চালু করা আছে এমন বাকেটের ক্ষেত্রে, কোনও অবজেক্ট আর্কাইভ করা হলে (onArchive দেখুন), এটি পাঠানো হয় না, এমনকি storage.objects.delete পদ্ধতির মাধ্যমে আর্কাইভ করা হলেও।
  • on_object_finalized কোনও নতুন অবজেক্ট (বা আগে থেকে থাকা অবজেক্টের নতুন জেনারেশন) বাকেটে সফলভাবে তৈরি হলে পাঠানো হয়। এর মধ্যে আগে থেকে থাকা কোনও অবজেক্ট কপি করা বা আবার লেখা অন্তর্ভুক্ত। আপলোড করা না গেলে এই ইভেন্ট ট্রিগার হয় না।
  • on_metadata_updated আগে থেকে থাকা কোনও অবজেক্টের মেটাডেটা পরিবর্তন হলে পাঠানো হয়।

Cloud Storage অবজেক্ট অ্যাট্রিবিউট অ্যাক্সেস করা

Cloud Functions আপডেট করা ফাইলের জন্য অবজেক্টের সাইজ ও কন্টেন্ট টাইপের মতো অনেক Cloud Storage অবজেক্ট অ্যাট্রিবিউট দেখায়। অবজেক্টের মেটাডেটাতে কোনও পরিবর্তন করা হলে metageneration অ্যাট্রিবিউট ইনক্রিমেন্ট করা হয়। নতুন অবজেক্টের জন্য, metageneration ভ্যালু হল 1।

Node.js

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.

Python

bucket_name = event.data.bucket
file_path = pathlib.PurePath(event.data.name)
content_type = event.data.content_type

থাম্বনেল জেনারেশন স্যাম্পেল, ফাংশন রিটার্ন করার কেস শনাক্ত করতে এইসব অ্যাট্রিবিউট ব্যবহার করে:

Node.js

// 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.");
}

Python

# Exit if this is triggered on a file that is not an image.
if not content_type or not content_type.startswith("image/"):
    print(f"This is not an image. ({content_type})")
    return

# Exit if the image is already a thumbnail.
if file_path.name.startswith("thumb_"):
    print("Already a thumbnail.")
    return

ফাইল ডাউনলোড, ট্রান্সফর্ম ও আপলোড করা

কিছু ক্ষেত্রে, Cloud Storage থেকে ফাইল ডাউনলোড করার প্রয়োজন নাও হতে পারে। তবে, Cloud Storage-এ সেভ করা ফাইল থেকে থাম্বনেল ছবি তৈরি করার মতো ইনটেনসিভ টাস্ক পারফর্ম করতে, আপনাকে ফাংশন ইনস্ট্যান্সে ফাইল ডাউনলোড করতে হবে—অর্থাৎ, ভার্চুয়াল মেশিন যা আপনার কোড রান করে।

Cloud Functions-এর সাথে Node.js-এর জন্য sharp এবং Python-এর জন্য Pillow-এর মতো ইমেজ-প্রসেসিং প্রোগ্রাম ব্যবহার করে, আপনি গ্রাফিক্যাল ইমেজ ফাইলে ম্যানিপুলেশন করতে পারবেন। আপলোড করা ছবির ফাইলের জন্য কীভাবে থাম্বনেল ছবি তৈরি করতে হয় তার একটি উদাহরণ নিচে দেওয়া হল:

Node.js

/**
 * When an image is uploaded in the Storage bucket,
 * generate a thumbnail automatically using sharp.
 */
exports.generateThumbnail = onObjectFinalized({cpu: 2}, async (event) => {

  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.

  // 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.");
  }

  // 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!");
});

আপনার Cloud Functions ইনস্ট্যান্সে একটি অস্থায়ী ডিরেক্টরিতে ফাইলটি ডাউনলোড করুন। এই লোকেশনে, আপনি প্রয়োজন অনুযায়ী ফাইল প্রসেস করতে এবং তারপরে Cloud Storage-এ আপলোড করতে পারবেন। অ্যাসিঙ্ক্রোনাস টাস্ক পারফর্ম করার সময়, আপনার কলব্যাকে জাভাস্ক্রিপ্ট প্রমিস রিটার্ন করতে ভুলবেন না।

Python

@storage_fn.on_object_finalized()
def generatethumbnail(event: storage_fn.CloudEvent[storage_fn.StorageObjectData]):
    """When an image is uploaded in the Storage bucket, generate a thumbnail
    automatically using Pillow."""

    bucket_name = event.data.bucket
    file_path = pathlib.PurePath(event.data.name)
    content_type = event.data.content_type

    # Exit if this is triggered on a file that is not an image.
    if not content_type or not content_type.startswith("image/"):
        print(f"This is not an image. ({content_type})")
        return

    # Exit if the image is already a thumbnail.
    if file_path.name.startswith("thumb_"):
        print("Already a thumbnail.")
        return

    bucket = storage.bucket(bucket_name)

    image_blob = bucket.blob(str(file_path))
    image_bytes = image_blob.download_as_bytes()
    image = Image.open(io.BytesIO(image_bytes))

    image.thumbnail((200, 200))
    thumbnail_io = io.BytesIO()
    image.save(thumbnail_io, format="png")
    thumbnail_path = file_path.parent / pathlib.PurePath(f"thumb_{file_path.stem}.png")
    thumbnail_blob = bucket.blob(str(thumbnail_path))
    thumbnail_blob.upload_from_string(thumbnail_io.getvalue(), content_type="image/png")

এই কোডটি একটি অস্থায়ী ডিরেক্টরিতে সেভ করা ছবির জন্য ২০০x২০০ থাম্বনেল তৈরি করে, তারপর এটি Cloud Storage-এ আপলোড করে।