কোনও এক্সটেনশনের জন্য Cloud Functions লেখা

আপনি যখন কোনও এক্সটেনশন তৈরি করেন, তখন আপনি Cloud Functions ব্যবহার করে এর লজিক লেখেন, অনেকটা একইভাবে আপনি একটি ফাংশন লিখবেন যা শুধুমাত্র আপনার নিজের প্রোজেক্টে ব্যবহার করা হবে। আপনি extension.yaml ফাইলে আপনার ফাংশন ঘোষণা করেন এবং ব্যবহারকারীরা আপনার এক্সটেনশন ইনস্টল করলে, এই ফাংশনগুলি তাদের প্রজেক্টে ডিপ্লয় করা হয়।

Cloud Functions ব্যবহার করার ব্যাপারে সাধারণ তথ্যের জন্য Cloud Functions ডকুমেন্টেশন দেখুন।

১ম ও ২য় জেনারেশন Cloud Functions

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

প্রতিটি ট্রিগারের ধরনের জন্য ফাংশন জেনারেশন সাপোর্ট নিচে উল্লেখ করা হয়েছে।

বিশেষ বিবেচনা

  • কিছু ফাংশনের সংজ্ঞার ক্ষেত্রে আপনাকে এমন তথ্য উল্লেখ করতে হবে যা extension.yaml ফাইলে উল্লেখ করা আছে। যেমন, Cloud Firestore-এ একটি document() পদ্ধতি আছে যা দেখার জন্য ডকুমেন্ট প্যাটার্ন নির্দিষ্ট করে এবং extension.yaml-এ এর সংশ্লিষ্ট ঘোষণায় একটি resource ফিল্ড আছে যা একই জিনিস নির্দিষ্ট করে।

    এইসব পরিস্থিতিতে, extension.yaml ফাইলে উল্লেখ করা কনফিগারেশন ব্যবহার করা হয় এবং ফাংশন সংজ্ঞায় উল্লেখ করা কনফিগারেশন উপেক্ষা করা হয়।

    ডকুমেন্টেশনের জন্য ফাংশন সংজ্ঞায় কনফিগার করা ভ্যালু উল্লেখ করা একটি সাধারণ প্র্যাক্টিস। এই পৃষ্ঠায় দেওয়া উদাহরণগুলি এই প্যাটার্ন অনুসরণ করে।

  • Cloud Functions ফার্স্ট জেনারেশন SDK-তে functions.config() পদ্ধতি এবং functions:config:set CLI কমান্ড আছে যা আপনি ফার্স্ট জেনারেশন ফাংশনে প্যারামিটারাইজড ভ্যালু নিয়ে কাজ করার জন্য ব্যবহার করতে পারেন। এই টেকনিক Cloud Functions-এ বন্ধ করা হয়েছে এবং এক্সটেনশনে একেবারেই কাজ করবে না। পরিবর্তে, functions.params মডিউল (সাজেস্ট করা হয়েছে) বা process.env ব্যবহার করুন।

TypeScript ব্যবহার করা হচ্ছে

আপনার নিজস্ব এক্সটেনশন ডেভেলপ করার জন্য বেশিরভাগ ডকুমেন্টেশনে Cloud Functions for Firebase-এর জন্য জাভাস্ক্রিপ্ট ব্যবহার করে ওয়ার্কফ্লো বর্ণনা করা হয়েছে। তবে, আপনি TypeScript ব্যবহার করে আপনার ফাংশন লিখতে পারেন।

আসলে, সব অফিসিয়াল Firebase এক্সটেনশন TypeScript-এ লেখা হয়। আপনার এক্সটেনশনের জন্য TypeScript ব্যবহার করার কিছু সেরা পদ্ধতির জন্য আপনি সেই এক্সটেনশনগুলি পর্যালোচনা করতে পারেন।

আপনি যদি TypeScript-এ আপনার এক্সটেনশনের ফাংশন লেখেন, তাহলে আপনার এক্সটেনশন ইনস্টল করার আগে আপনাকে অবশ্যই নিম্নলিখিতগুলি করতে হবে:

  1. আপনার এক্সটেনশনের ফাংশন সোর্স কোড জাভাস্ক্রিপ্টে কম্পাইল করুন।

    firebase ext:dev:init কমান্ড আপনাকে ফাংশন লেখার জন্য TypeScript বেছে নেওয়ার অনুমতি দেয়। কমান্ড আপনাকে একটি সম্পূর্ণ, ইনস্টলযোগ্য এক্সটেনশন এবং একটি বিল্ড স্ক্রিপ্ট প্রদান করে যা আপনি npm run build দিয়ে চালাতে পারেন।

  2. আপনার package.json ফাইলে, main ফিল্ডটি যেন জেনারেট করা জাভাস্ক্রিপ্টে পয়েন্ট করে তা নিশ্চিত করুন।

  3. আপনি লোকাল সোর্স থেকে এক্সটেনশন ইনস্টল বা আপলোড করলে, প্রথমে TypeScript ফাইল কম্পাইল করুন।

কাজ করে এমন ফাংশন ট্রিগার

HTTP ট্রিগার

HTTP-ট্রিগার করা ফাংশন পাবলিক https এন্ডপয়েন্টে ডিপ্লয় করা হয় এবং এন্ডপয়েন্ট অ্যাক্সেস করা হলে রান করে।

HTTP-ট্রিগার করা ফাংশন লেখার বিষয়ে তথ্যের জন্য Cloud Functions ডকুমেন্টেশনে HTTP অনুরোধের মাধ্যমে কল ফাংশন দেখুন।

ফাংশনের সংজ্ঞা (শুধুমাত্র ফার্স্ট জেনারেশন)

import { https } from "firebase-functions/v1";

export const yourFunctionName = https.onRequest(async (req, resp) => {
  // ...
});

রিসোর্স ডিক্লারেশন (extension.yaml)

resources:
  - name: yourFunctionName
    type: firebaseextensions.v1beta.function
    properties:
      runtime: nodejs16
      httpsTrigger: {}
  - name: anotherFunction
    type: ...

কল করা যায় এমন ফাংশন

কল করা যায় এমন ফাংশন HTTP-ট্রিগার করা ফাংশনের মতোই, তবে তারা এমন একটি প্রোটোকল প্রয়োগ করে যা আপনার ক্লায়েন্ট-সাইড কোড থেকে তাদের কল করা সুবিধাজনক করে তোলে।

কল করা যায় এমন ফাংশন ব্যবহার করার ব্যাপারে তথ্যের জন্য Cloud Functions ডকুমেন্টেশনে আপনার অ্যাপ থেকে ফাংশন কল করুন দেখুন।

ফাংশনের সংজ্ঞা (শুধুমাত্র ফার্স্ট জেনারেশন)

import { https } from "firebase-functions/v1";

export const yourFunctionName = https.onCall(async (data, context) => {
  // ...
});

রিসোর্স ডিক্লারেশন (extension.yaml)

resources:
  - name: yourFunctionName
    type: firebaseextensions.v1beta.function
    properties:
      runtime: nodejs16
      httpsTrigger: {}
  - name: anotherFunction
    type: ...

শিডিউল করা ফাংশন ট্রিগার

শিডিউল করা ফাংশন কাস্টমাইজ করা যায় এমন শিডিউলের ভিত্তিতে বারবার রান করে।

শিডিউল করা ফাংশন লেখার ব্যাপারে তথ্য পেতে Cloud Functions ডকুমেন্টেশনে শিডিউল ফাংশন দেখুন।

ফাংশনের সংজ্ঞা (শুধুমাত্র ফার্স্ট জেনারেশন)

import { pubsub } from "firebase-functions/v1";

export const yourFunctionName = pubsub.schedule("every 6 hours").onRun((context) => {
  // ...
});

রিসোর্স ডিক্লারেশন (extension.yaml)

resources:
  - name: yourFunctionName
    type: firebaseextensions.v1beta.function
    properties:
      scheduleTrigger:
        schedule: 'every 5 minutes'
  - name: anotherFunction
    type: ...

scheduleTrigger-এর জন্য উপলভ্য সাবফিল্ড এখানে দেওয়া হল:

ফিল্ড বিবরণ
schedule
(প্রয়োজনীয়)

আপনি কত ঘন ঘন ফাংশনটি চালাতে চান।

এই ফিল্ডে যেকোনও সিনট্যাক্স ব্যবহার করা স্ট্রিং গ্রহণ করা হয় (সিঙ্গেল-কোট-এর মধ্যে র‍্যাপ করা আবশ্যক):

timeZone
(ঐচ্ছিক)

যে টাইম জোনে শিডিউল রান করবে।

আপনার এক্সটেনশন ইনস্টল করার সময় ব্যবহারকারীরা যাতে শিডিউল কনফিগার করতে পারেন, তার জন্য আপনার extension.yaml ফাইলে একটি নতুন প্যারামিটার যোগ করুন এবং আপনার ফাংশনের resource ডিক্লারেশনে প্যারামিটারটি রেফারেন্স করুন:

resources:
  - name: yourFunctionName
    type: firebaseextensions.v1beta.function
    properties:
      scheduleTrigger:
        schedule: ${SCHEDULE_FREQUENCY}
  - name: anotherFunction
    type: ...

params:
  - param: SCHEDULE_FREQUENCY
    label: Schedule
    description: How often do you want to run yourFunctionName()?
    type: string
    default: 'every 5 minutes'  # Specifying a default is optional.
    required: true

টাস্ক কিউ ট্রিগার

আপনার এক্সটেনশনের লাইফসাইকেল ইভেন্ট-এ অথবা অ্যাডমিন SDK-এর TaskQueue.enqueue() পদ্ধতি ব্যবহার করে আপনার এক্সটেনশনের টাস্ক কিউতে ম্যানুয়ালি যোগ করা হলে, টাস্ক কিউ ফাংশন ট্রিগার করা হয়।

লাইফসাইকেল ইভেন্ট ম্যানেজ করে এমন ফাংশন লেখার ব্যাপারে তথ্যের জন্য আপনার এক্সটেনশনের লাইফসাইকেল ইভেন্ট ম্যানেজ করুন দেখুন।

টাস্ক কিউ ফাংশন লেখার ব্যাপারে তথ্য পেতে Cloud Functions ডকুমেন্টেশনে Cloud Tasks-এর সাথে ফাংশন এনকিউ করা দেখুন।

ফাংশনের সংজ্ঞা (শুধুমাত্র ফার্স্ট জেনারেশন)

import { tasks } from "firebase-functions/v1";

export const yourFunctionName = tasks.taskQueue().onDispatch(async (data, context) => {
  // ...
});

রিসোর্স ডিক্লারেশন (extension.yaml)

resources:
  - name: myTaskFunction
    type: firebaseextensions.v1beta.function
    description: >-
      Perform a task when triggered by a lifecycle event
    properties:
      taskQueueTrigger: {}

taskQueueTrigger প্রপার্টি {} অথবা বিকল্পের ম্যাপে সেট করুন যা টাস্ক কিউয়ের রেট লিমিট ও আবার চেষ্টা করার আচরণ টিউন করে (টাস্ক কিউ টিউন করা দেখুন)।

আপনার এক্সটেনশনের লাইফসাইকেল ইভেন্টে ফাংশন ট্রিগার করতে চাইলে, ফাংশনের নাম ও ঐচ্ছিক প্রসেসিং মেসেজ সহ lifecycleEvents রেকর্ড যোগ করুন, যা প্রসেসিং শুরু হলে Firebase কনসোলে দেখানো হবে।

lifecycleEvents:
  onInstall:
    function: myTaskFunction
    processingMessage: Resizing your existing images
  onUpdate:
    function: myOtherTaskFunction
    processingMessage: Setting up your extension
  onConfigure:
    function: myOtherTaskFunction
    processingMessage: Setting up your extension

Analytics

নির্দিষ্ট Analytics ইভেন্ট লগ করা হলে, Analytics-ট্রিগার করা ফাংশন রান করে।

Analytics-ট্রিগার করা ফাংশন লেখার বিষয়ে তথ্যের জন্য Cloud Functions ডকুমেন্টেশনে Google Analytics ট্রিগার দেখুন।

ফাংশনের সংজ্ঞা (শুধুমাত্র ফার্স্ট জেনারেশন)

import { analytics } from "firebase-functions/v1";

export const yourFunctionName = analytics.event("event_name").onLog((event, context) => {
  // ...
});

রিসোর্স ডিক্লারেশন (extension.yaml)

resources:
  - name: yourFunctionName
    type: firebaseextensions.v1beta.function
    properties:
      eventTrigger:
        eventType: providers/google.firebase.analytics/eventTypes/event.log
        resource: projects/${PROJECT_ID}/events/ga_event
  - name: anotherFunction
    type: ...

ব্যবহারকারীরা আপনার এক্সটেনশন ইনস্টল করার সময় Analytics ইভেন্ট কনফিগার করার সুবিধা দিতে চাইলে, আপনার extension.yaml ফাইলে একটি নতুন প্যারামিটার যোগ করুন এবং আপনার ফাংশনের resource ডিক্লারেশনে প্যারামিটারটি রেফারেন্স করুন:

resources:
  - name: yourFunctionName
    type: firebaseextensions.v1beta.function
    properties:
      eventTrigger:
        eventType: providers/google.firebase.analytics/eventTypes/event.log
        resource: projects/${PROJECT_ID}/events/${EVENT_NAME}
  - name: anotherFunction
    type: ...

params:
  - param: EVENT_NAME
    label: Analytics event
    description: What event do you want to respond to?
    type: string
    default: ga_event  # Specifying a default is optional.
    required: true

Authentication

কোনও ব্যবহারকারী তৈরি বা মুছে ফেলা হলে, যাচাইকরণ-ট্রিগার করা ফাংশন রান করে।

auth-ট্রিগার করা ফাংশন লেখার ব্যাপারে তথ্যের জন্য Cloud Functions ডকুমেন্টেশনে Firebase Authentication ট্রিগার দেখুন।

ফাংশনের সংজ্ঞা (শুধুমাত্র ফার্স্ট জেনারেশন)

import { auth } from "firebase-functions/v1";

export const yourFunctionName = auth.user().onCreate((user, context) => {
  // ...
});

export const yourFunctionName2 = auth.user().onDelete((user, context) => {
  // ...
});

রিসোর্স ডিক্লারেশন (extension.yaml)

resources:
  - name: yourFunctionName
    type: firebaseextensions.v1beta.function
    properties:
      eventTrigger:
        eventType: providers/firebase.auth/eventTypes/user.create
        resource: projects/${PROJECT_ID}
  - name: anotherFunction
    type: ...

নিচের সারণীতে দেখানো হয়েছে যে কীভাবে কাজ করে এমন প্রতিটি Authentication ইভেন্টের ধরন নির্দিষ্ট করতে হয়:

Cloud Functions ইভেন্ট ট্রিগার eventType বিবরণ
onCreate() providers/firebase.auth/eventTypes/user.create নতুন ব্যবহারকারী তৈরি হয়েছে
onDelete() providers/firebase.auth/eventTypes/user.delete ব্যবহারকারীকে মুছে ফেলা হয়েছে

Cloud Firestore

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

Firestore-ট্রিগার করা ফাংশন লেখার বিষয়ে তথ্যের জন্য Cloud Functions ডকুমেন্টেশনে Cloud Firestore ট্রিগার দেখুন।

ফাংশনের সংজ্ঞা (শুধুমাত্র ফার্স্ট জেনারেশন)

import { firestore } from "firebase-functions/v1";

export const yourFunctionName = firestore.document("collection/{doc_id}")
  .onCreate((snapshot, context) => {
    // ...
  });

export const yourFunctionName2 = firestore.document("collection/{doc_id}")
  .onUpdate((change, context) => {
    // ...
  });

export const yourFunctionName3 = firestore.document("collection/{doc_id}")
  .onDelete((snapshot, context) => {
    // ...
  });

export const yourFunctionName4 = firestore.document("collection/{doc_id}")
  .onWrite((change, context) => {
    // onWrite triggers on creation, update, and deletion.
    // ...
  });

রিসোর্স ডিক্লারেশন (extension.yaml)

resources:
  - name: yourFunctionName
    type: firebaseextensions.v1beta.function
    properties:
      eventTrigger:
        eventType: providers/cloud.firestore/eventTypes/document.write
        resource: projects/${PROJECT_ID}/databases/(default)/documents/collection/{documentID}
  - name: anotherFunction
    type: ...

নিম্নলিখিত সারণীতে দেখানো হয়েছে যে কীভাবে প্রতিটি কাজ করে এমন Cloud Firestore ইভেন্টের ধরন নির্দিষ্ট করতে হয়:

Cloud Functions ইভেন্ট ট্রিগার eventType বিবরণ
onCreate() providers/cloud.firestore/eventTypes/document.create নতুন ডকুমেন্ট তৈরি করা হয়েছে
onDelete() providers/cloud.firestore/eventTypes/document.delete ডকুমেন্ট মুছে ফেলা হয়েছে
onUpdate() providers/cloud.firestore/eventTypes/document.update ডকুমেন্ট আপডেট করা হয়েছে
onWrite() providers/cloud.firestore/eventTypes/document.write ডকুমেন্ট তৈরি, মুছে ফেলা বা আপডেট করা হয়েছে

আপনার এক্সটেনশন ইনস্টল করার সময় ব্যবহারকারীরা যাতে ডকুমেন্ট পাথ কনফিগার করতে পারেন, তার জন্য আপনার extension.yaml ফাইলে একটি নতুন প্যারামিটার যোগ করুন এবং আপনার ফাংশনের resource ডিক্লারেশনে প্যারামিটারটি রেফারেন্স করুন:

resources:
  - name: yourFunctionName
    type: firebaseextensions.v1beta.function
    properties:
      eventTrigger:
        eventType: providers/cloud.firestore/eventTypes/document.write
        resource: projects/${PROJECT_ID}/databases/(default)/documents/${YOUR_DOCUMENT_PATH}
  - name: anotherFunction
    type: ...

params:
  - param: YOUR_DOCUMENT_PATH
    label: Cloud Firestore path
    description: Where do you want to watch for changes?
    type: string
    default: path/to/{documentID}  # Specifying a default is optional.
    required: true

Pub/Sub

কোনও নির্দিষ্ট বিষয়ে মেসেজ প্রকাশ করা হলে, Pub/Sub-ট্রিগার করা ফাংশন রান করে।

Pub/Sub-ট্রিগার করা ফাংশন লেখার ব্যাপারে তথ্যের জন্য Cloud Functions ডকুমেন্টেশনে Pub/Sub ট্রিগার দেখুন।

ফাংশনের সংজ্ঞা (শুধুমাত্র ফার্স্ট জেনারেশন)

import { pubsub } from "firebase-functions/v1";

export const yourFunctionName = pubsub.topic("topic_name").onPublish((message, context) => {
  // ...
});

রিসোর্স ডিক্লারেশন (extension.yaml)

resources:
  - name: yourFunctionName
    type: firebaseextensions.v1beta.function
    properties:
      eventTrigger:
        eventType: google.pubsub.topic.publish
        resource: projects/${PROJECT_ID}/topics/topic-name
  - name: anotherFunction
    type: ...

ব্যবহারকারীরা আপনার এক্সটেনশন ইনস্টল করার সময় আপনি যদি তাদের Pub/Sub বিষয় কনফিগার করার অনুমতি দিতে চান, তাহলে আপনার extension.yaml ফাইলে একটি নতুন প্যারামিটার যোগ করুন এবং আপনার ফাংশনের resource ঘোষণায় প্যারামিটারটি উল্লেখ করুন:

resources:
  - name: yourFunctionName
    type: firebaseextensions.v1beta.function
    properties:
      eventTrigger:
        eventType: google.pubsub.topic.publish
        resource: projects/${PROJECT_ID}/topics/${PUBSUB_TOPIC}
  - name: anotherFunction
    type: ...

params:
  - param: PUBSUB_TOPIC
    label: Pub/Sub topic
    description: Which Pub/Sub topic do you want to watch for messages?
    type: string
    default: topic-name  # Specifying a default is optional.
    required: true

Realtime Database

নির্দিষ্ট প্যাটার্নের সাথে মেলে এমন কোনও পাথ তৈরি, আপডেট বা মুছে ফেলা হলে, রিয়েল-টাইম ডেটাবেস-ট্রিগার করা ফাংশন রান করে।

RTDB-ট্রিগার করা ফাংশন লেখার ব্যাপারে তথ্যের জন্য Cloud Functions ডকুমেন্টেশনে রিয়েল-টাইম ডেটাবেস ট্রিগার দেখুন।

ফাংশনের সংজ্ঞা (শুধুমাত্র ফার্স্ট জেনারেশন)

import { database } from "firebase-functions/v1";

export const yourFunctionName = database.ref("path/to/{item}")
  .onCreate((snapshot, context) => {
    // ...
  });

export const yourFunctionName2 = database.ref("path/to/{item}")
  .onUpdate((change, context) => {
    // ...
  });

export const yourFunctionName3 = database.ref("path/to/{item}")
  .onDelete((snapshot, context) => {
    // ...
  });

export const yourFunctionName4 = database.ref("path/to/{item}")
  .onWrite((change, context) => {
    // onWrite triggers on creation, update, and deletion.
    // ...
  });

রিসোর্স ডিক্লারেশন (extension.yaml)

resources:
  - name: yourFunctionName
    type: firebaseextensions.v1beta.function
    properties:
      eventTrigger:
        eventType: providers/google.firebase.database/eventTypes/ref.create
        # DATABASE_INSTANCE (project's default instance) is an auto-populated
        # parameter value. You can also specify an instance.
        resource: projects/_/instances/${DATABASE_INSTANCE}/refs/path/to/{itemId}
  - name: anotherFunction
    type: ...

নিম্নলিখিত সারণীতে দেখানো হয়েছে যে কীভাবে প্রতিটি কাজ করে এমন Cloud Firestore ইভেন্টের ধরন নির্দিষ্ট করতে হয়:

Cloud Functions ইভেন্ট ট্রিগার eventType বিবরণ
onCreate() providers/google.firebase.database/eventTypes/ref.create ডেটা তৈরি করা হয়েছে
onDelete() providers/google.firebase.database/eventTypes/ref.delete ডেটা মোছা হয়েছে
onUpdate() providers/google.firebase.database/eventTypes/ref.update ডেটা আপডেট করা হয়েছে
onWrite() providers/google.firebase.database/eventTypes/ref.write ডেটা তৈরি, মুছে ফেলা বা আপডেট করা হয়েছে

আপনি যদি চান যে ব্যবহারকারীরা আপনার এক্সটেনশন ইনস্টল করার সময় দেখার জন্য পাথ কনফিগার করতে পারবেন, তাহলে আপনার extension.yaml ফাইলে একটি নতুন প্যারামিটার যোগ করুন এবং আপনার ফাংশনের resource ঘোষণায় প্যারামিটারটি উল্লেখ করুন:

resources:
  - name: yourFunctionName
    type: firebaseextensions.v1beta.function
    properties:
      eventTrigger:
        eventType: providers/google.firebase.database/eventTypes/ref.create
        # DATABASE_INSTANCE (project's default instance) is an auto-populated
        # parameter value. You can also specify an instance.
        resource: projects/_/instances/${DATABASE_INSTANCE}/refs/${DB_PATH}
  - name: anotherFunction
    type: ...

params:
  - param: DB_PATH
    label: Realtime Database path
    description: Where do you want to watch for changes?
    type: string
    default: path/to/{itemId}  # Specifying a default is optional.
    required: true

Remote Config

কোনও প্রোজেক্টের প্যারামিটার টেমপ্লেট আপডেট করা হলে, রিমোট কনফিগ-ট্রিগার করা ফাংশন রান করে।

'রিমোট কনফিগ' ট্রিগার করা ফাংশন লেখার ব্যাপারে তথ্য পেতে, Cloud Functions ডকুমেন্টেশনে 'রিমোট কনফিগ' ট্রিগার দেখুন।

ফাংশনের সংজ্ঞা (শুধুমাত্র ফার্স্ট জেনারেশন)

import { remoteConfig } from "firebase-functions/v1";

export const yourFunctionName = remoteConfig.onUpdate((version, context) => {
  // ...
});

রিসোর্স ডিক্লারেশন (extension.yaml)

resources:
  - name: yourFunctionName
    type: firebaseextensions.v1beta.function
    properties:
      eventTrigger:
        eventType: google.firebase.remoteconfig.update
        resource: projects/${PROJECT_ID}
  - name: anotherFunction
    type: ...

Cloud Storage

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

Storage-ট্রিগার করা ফাংশন লেখার ব্যাপারে তথ্যের জন্য Cloud Functions ডকুমেন্টেশনে Cloud Storage ট্রিগার দেখুন।

ফাংশনের সংজ্ঞা (শুধুমাত্র ফার্স্ট জেনারেশন)

import { storage } from "firebase-functions/v1";

export const yourFunctionName = storage.object().onFinalize((object, context) => {
  // ...
});

export const yourFunctionName2 = storage.object().onMetadataUpdate((object, context) => {
  // ...
});

export const yourFunctionName3 = storage.object().onArchive((object, context) => {
  // ...
});

export const yourFunctionName4 = storage.object().onDelete((object, context) => {
  // ...
});

রিসোর্স ডিক্লারেশন (extension.yaml)

resources:
  - name: yourFunctionName
    type: firebaseextensions.v1beta.function
    properties:
      eventTrigger:
        eventType: google.storage.object.finalize
        # STORAGE_BUCKET (project's default bucket) is an auto-populated
        # parameter. You can also specify a bucket.
        resource: projects/_/buckets/${STORAGE_BUCKET}
  - name: anotherFunction
    type: ...

নিম্নলিখিত সারণীতে দেখানো হয়েছে যে কীভাবে প্রতিটি কাজ করে এমন Cloud Storage ইভেন্টের ধরন নির্দিষ্ট করতে হয়:

Cloud Functions ইভেন্ট ট্রিগার eventType বিবরণ
onFinalize() google.storage.object.finalize অবজেক্ট তৈরি করা হয়েছে
onMetadataUpdate() google.storage.object.metadataUpdate অবজেক্ট মেটাডেটা আপডেট করা হয়েছে
onArchive() google.storage.object.archive অবজেক্ট আর্কাইভ করা হয়েছে
onDelete() google.storage.object.delete অবজেক্ট মুছে ফেলা হয়েছে

আপনি যদি চান যে ব্যবহারকারীরা আপনার এক্সটেনশন ইনস্টল করার সময় স্টোরেজ বাকেট কনফিগার করতে সক্ষম হোক, তাহলে আপনার extension.yaml ফাইলে একটি নতুন প্যারামিটার যোগ করুন এবং আপনার ফাংশনের resource ঘোষণায় প্যারামিটারটি রেফারেন্স করুন:

resources:
  - name: yourFunctionName
    type: firebaseextensions.v1beta.function
    properties:
      eventTrigger:
        eventType: google.storage.object.finalize
        resource: projects/_/buckets/${YOUR_BUCKET}
  - name: anotherFunction
    type: ...

params:
  - param: YOUR_BUCKET
    label: Cloud Storage bucket
    description: Which bucket do you want to watch for changes?
    type: selectResource
    resourceType: storage.googleapis.com/Bucket
    default: ${STORAGE_BUCKET}  # Specifying a default is optional.
    required: true

Test Lab

কোনও টেস্ট ম্যাট্রিক্স তার টেস্ট শেষ করলে, Test Lab-ট্রিগার করা ফাংশন রান করে।

Test Lab-ট্রিগার করা ফাংশন লেখার বিষয়ে তথ্যের জন্য Cloud Functions ডকুমেন্টেশনে Firebase Test Lab ট্রিগার দেখুন।

ফাংশনের সংজ্ঞা (শুধুমাত্র ফার্স্ট জেনারেশন)

import { testLab } from "firebase-functions/v1";

export const yourFunctionName = testLab.testMatrix().onComplete((matrix, context) => {
  // ...
});

রিসোর্স ডিক্লারেশন (extension.yaml)

resources:
  - name: yourFunctionName
    type: firebaseextensions.v1beta.function
    properties:
      eventTrigger:
        eventType: google.testing.testMatrix.complete
        resource: projects/${PROJECT_ID}/testMatrices/{matrixId}
  - name: anotherFunction
    type: ...

Crashlyticsটি সতর্কতা ট্রিগার

Crashlytics-ট্রিগার করা ফাংশন রান করে যখন Crashlytics একটি সতর্কতা প্রকাশ করে।

সতর্কতা-ট্রিগার করা ফাংশন লেখার বিষয়ে তথ্যের জন্য Cloud Functions ডকুমেন্টেশনে Firebase সতর্কতা ট্রিগার দেখুন।

ফাংশনের সংজ্ঞা (শুধুমাত্র ২য়-জেনারেশন)

import {
  onNewFatalIssuePublished,
  onNewNonfatalIssuePublished,
  onNewAnrIssuePublished,
  onRegressionAlertPublished,
  onVelocityAlertPublished,
  onStabilityDigestPublished,
} from "firebase-functions/v2/alerts/crashlytics";

export const yourFunctionName = onNewFatalIssuePublished((event) => {
  // ...
});

export const yourFunctionName2 = onNewNonfatalIssuePublished((event) => {
  // ...
});

export const yourFunctionName3 = onNewAnrIssuePublished((event) => {
  // ...
});

export const yourFunctionName4 = onRegressionAlertPublished((event) => {
  // ...
});

export const yourFunctionName5 = onVelocityAlertPublished((event) => {
  // ...
});

export const yourFunctionName6 = onStabilityDigestPublished((event) => {
  // ...
});

রিসোর্স ডিক্লারেশন (extension.yaml)

resources:
  - name: yourfunctionname
    type: firebaseextensions.v1beta.v2function
    properties:
      buildConfig:
        runtime: nodejs16
      serviceConfig:
        availableMemory: 512M
      eventTrigger:
        eventType: google.firebase.firebasealerts.alerts.v1.published
        triggerRegion: global
        eventFilters:
          - attribute: alerttype
            value: crashlytics.newFatalIssue
  - name: anotherFunction
    type: ...

alerttype-এর জন্য আপনি নিম্নলিখিত ভ্যালু ব্যবহার করতে পারবেন

  • crashlytics.newFatalIssue
  • crashlytics.newNonfatalIssue
  • crashlytics.regression
  • crashlytics.stabilityDigest
  • crashlytics.velocity
  • crashlytics.newAnrIssue

Performance Monitoringটি সতর্কতা ট্রিগার

Performance Monitoring-ট্রিগার করা ফাংশন তখনই রান করে যখন Performance Monitoring কোনও সতর্কতা প্রকাশ করে।

সতর্কতা-ট্রিগার করা ফাংশন লেখার বিষয়ে তথ্যের জন্য Cloud Functions ডকুমেন্টেশনে Firebase সতর্কতা ট্রিগার দেখুন।

ফাংশনের সংজ্ঞা (শুধুমাত্র ২য়-জেনারেশন)

import { onThresholdAlertPublished } from "firebase-functions/v2/alerts/performance";

export const yourFunctionName = onThresholdAlertPublished((event) => {
  // ...
});

রিসোর্স ডিক্লারেশন (extension.yaml)

resources:
  - name: yourfunctionname
    type: firebaseextensions.v1beta.v2function
    properties:
      buildConfig:
        runtime: nodejs16
      serviceConfig:
        availableMemory: 512M
      eventTrigger:
        eventType: google.firebase.firebasealerts.alerts.v1.published
        triggerRegion: global
        eventFilters:
          - attribute: alerttype
            value: performance.threshold
  - name: anotherFunction
    type: ...

App Distributionটি সতর্কতা ট্রিগার

App Distribution-ট্রিগার করা ফাংশন রান করে যখন App Distribution একটি সতর্কতা প্রকাশ করে।

সতর্কতা-ট্রিগার করা ফাংশন লেখার বিষয়ে তথ্যের জন্য Cloud Functions ডকুমেন্টেশনে Firebase সতর্কতা ট্রিগার দেখুন।

ফাংশনের সংজ্ঞা (শুধুমাত্র ২য়-জেনারেশন)

import {
  onNewTesterIosDevicePublished,
  onInAppFeedbackPublished
} from "firebase-functions/v2/alerts/appDistribution";

export const yourFunctionName = onNewTesterIosDevicePublished((event) => {
  // ...
});

export const yourFunctionName2 = onInAppFeedbackPublished((event) => {
  // ...
});

রিসোর্স ডিক্লারেশন (extension.yaml)

resources:
  - name: yourfunctionname
    type: firebaseextensions.v1beta.v2function
    properties:
      buildConfig:
        runtime: nodejs16
      serviceConfig:
        availableMemory: 512M
      eventTrigger:
        eventType: google.firebase.firebasealerts.alerts.v1.published
        triggerRegion: global
        eventFilters:
          - attribute: alerttype
            value: appDistribution.inAppFeedback
  - name: anotherFunction
    type: ...

alerttype-এর জন্য আপনি নিম্নলিখিত ভ্যালু ব্যবহার করতে পারবেন

  • appDistribution.newTesterIosDevice
  • appDistribution.inAppFeedback

কাস্টম ইভেন্ট ট্রিগার (Eventarc)

Eventarc-ট্রিগার করা ফাংশন তখনই রান করে যখন কোনও নির্দিষ্ট ইভেন্টের ধরন নির্দিষ্ট চ্যানেলে প্রকাশ করা হয়।

Eventarc-ট্রিগার করা ফাংশন লেখার ব্যাপারে তথ্যের জন্য Cloud Functions ডকুমেন্টেশনে কাস্টম ইভেন্ট ট্রিগার তৈরি ও ম্যানেজ করুন দেখুন।

এছাড়াও, আপনার এক্সটেনশন থেকে ইভেন্ট প্রকাশ করতে পারবেন যাতে ব্যবহারকারীরা আপনার এক্সটেনশনে কাস্টম লজিক যোগ করতে পারেন। এক্সটেনশনে ডেভেলপার-প্রদত্ত কাস্টম লজিক ব্যবহার করুন দেখুন।

ফাংশনের সংজ্ঞা (শুধুমাত্র ২য়-জেনারেশন)

import { onCustomEventPublished } from "firebase-functions/v2/eventarc";

export const yourFunctionName = onCustomEventPublished((event) => {
  // ...
});

রিসোর্স ডিক্লারেশন (extension.yaml)

resources:
  - name: yourfunctionname
    type: firebaseextensions.v1beta.v2function
    properties:
      # LOCATION is a user-configured parameter value specified by the user
      # during installation.
      location: ${param:LOCATION}
      buildConfig:
        runtime: nodejs16
      serviceConfig:
        availableMemory: 512M
        timeoutSeconds: 60
      eventTrigger:
        eventType: firebase.extensions.storage-resize-images.v1.complete
        channel: projects/${param:PROJECT_ID}/locations/us-central1/channels/firebase
  - name: anotherFunction
    type: ...

আপনার এক্সটেনশন ইনস্টল করার সময় চ্যানেলটি আগে থেকেই থাকতে হবে। যেমন, আপনি যদি চ্যানেল তৈরি করে এমন অন্য এক্সটেনশন থেকে কাস্টম ইভেন্টের উপর নির্ভর করেন, তাহলে আপনার ব্যবহারকারীদের প্রথমে সেই এক্সটেনশন ইনস্টল করার নির্দেশ দিন।

উপরের উদাহরণটি us-central1 অঞ্চলে "ডিফল্ট" Firebase চ্যানেলের জন্য একটি কাস্টম ইভেন্ট ট্রিগার তৈরি করবে। আপনি প্যারামিটার ব্যবহার করে চ্যানেলের নাম ও অঞ্চল কাস্টমাইজ করতে পারবেন। যেমন:


params:
  - param: EVENTARC_CHANNEL_NAME
    label: Eventarc channel name
    description: What is the name of the Eventarc channel.
    default: firebase
    type: string
    required: true

resources:
  - name: yourfunctionname
    type: firebaseextensions.v1beta.v2function
    properties:
      location: ${param:LOCATION}
      eventTrigger:
        eventType: firebase.extensions.storage-resize-images.v1.complete
        channel: projects/${param:PROJECT_ID}/locations/${param:LOCATION}/channels/${param:EVENTARC_CHANNEL_NAME}