একটি এক্সটেনশন ব্যবহারকারী হুক যোগ করুন

আপনার এক্সটেনশন ইনস্টল করা ব্যবহারকারীদের আপনি আপনার এক্সটেনশনের এক্সিকিউশনে তাদের নিজস্ব কাস্টম লজিক সন্নিবেশ করার ক্ষমতা প্রদান করতে পারেন। এটি সম্পন্ন করার দুটি উপায় রয়েছে:

• Eventarc ইভেন্ট : ব্যবহারকারীদের ইভেন্টগুলিতে অ্যাসিঙ্ক্রোনাসভাবে প্রতিক্রিয়া জানানোর জন্য, আপনি Eventarc-এ প্রকাশ করতে পারেন। ব্যবহারকারীরা ইভেন্ট হ্যান্ডলার ফাংশন স্থাপন করতে পারেন যা, উদাহরণস্বরূপ, দীর্ঘমেয়াদী কাজ সম্পন্ন হওয়ার পরে বিজ্ঞপ্তি পাঠায়, অথবা তারা তাদের নিজস্ব পোস্ট-প্রসেসিং ফাংশন সংজ্ঞায়িত করতে পারে।

• সিঙ্ক্রোনাস হুক : ব্যবহারকারীদের আপনার এক্সটেনশনে ব্লকিং লজিক যোগ করার সুযোগ করে দিতে, আপনি এক্সটেনশনের অপারেশনের পূর্বনির্ধারিত পয়েন্টগুলিতে সিঙ্ক্রোনাস হুক যোগ করতে পারেন। এই পয়েন্টগুলিতে, আপনি একটি ব্যবহারকারী-প্রোভাইডার ফাংশন চালান এবং এটি সম্পূর্ণ হওয়ার পরেই এগিয়ে যান। প্রাক-প্রক্রিয়াকরণের কাজগুলি প্রায়শই এই বিভাগের অধীনে পড়ে।

একটি এক্সটেনশন যেকোনো একটি অথবা উভয় পদ্ধতি ব্যবহার করতে পারে।

ইভেন্টটার্ক ইভেন্ট

এক্সটেনশন থেকে ইভেন্ট প্রকাশ করতে:

1. extension.yaml ফাইলে আপনি যে ধরণের ইভেন্ট প্রকাশ করবেন তা ঘোষণা করুন:

   events:
     - type: publisher-id.extension-name.version.event-name
       description: event-description
     - type: publisher-id.extension-name.version.another-event-name
       description: another-event-description
   

   type আইডেন্টিফায়ারটি বেশ কয়েকটি ডট-ডিলিমিটেড ফিল্ড দিয়ে তৈরি। প্রকাশক আইডি , এক্সটেনশনের নাম এবং ইভেন্টের নাম ফিল্ড প্রয়োজন। সংস্করণ ফিল্ডটি সুপারিশ করা হয়। আপনার প্রকাশিত প্রতিটি ইভেন্ট টাইপের জন্য একটি অনন্য এবং বর্ণনামূলক ইভেন্ট নাম চয়ন করুন।

   উদাহরণস্বরূপ, storage-resize-images এক্সটেনশন একটি একক ইভেন্ট টাইপ ঘোষণা করে:

   events:
     - type: firebase.extensions.storage-resize-images.v1.complete
       description: |
         Occurs when image resizing completes. The event will contain further
         details about specific formats and sizes.
   

   ব্যবহারকারীরা এক্সটেনশনটি ইনস্টল করার সময় কোন ইভেন্টগুলিতে সাবস্ক্রাইব করবেন তা বেছে নিতে পারবেন।

2. আপনার এক্সটেনশন ফাংশনে, Admin SDK থেকে Eventarc API আমদানি করুন এবং ব্যবহারকারীর ইনস্টলেশন সেটিংস ব্যবহার করে একটি ইভেন্ট চ্যানেল শুরু করুন। এই সেটিংস নিম্নলিখিত পরিবেশ ভেরিয়েবল ব্যবহার করে প্রকাশ করা হয়:

   • EVENTARC_CHANNEL : ব্যবহারকারী যে Eventarc চ্যানেলে ইভেন্ট প্রকাশ করতে চান তার সম্পূর্ণরূপে যোগ্য নাম।
   • EXT_SELECTED_EVENTS : ব্যবহারকারীর দ্বারা প্রকাশ করা ইভেন্টের ধরণের একটি কমা দ্বারা পৃথক তালিকা। যখন আপনি এই মান দিয়ে একটি চ্যানেল শুরু করেন, তখন অ্যাডমিন SDK স্বয়ংক্রিয়ভাবে ব্যবহারকারী কর্তৃক নির্বাচিত না হওয়া ইভেন্টগুলিকে ফিল্টার করে।
   • EVENTARC_CLOUD_EVENT_SOURCE : ক্লাউড ইভেন্ট সোর্স আইডেন্টিফায়ার। অ্যাডমিন SDK স্বয়ংক্রিয়ভাবে প্রকাশিত ইভেন্টের source ফিল্ডে এই মানটি পাস করে। সাধারণত আপনাকে এই ভেরিয়েবলটি স্পষ্টভাবে ব্যবহার করার প্রয়োজন হয় না।

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

   import * as admin from "firebase-admin";
   import {getEventarc} from 'firebase-admin/eventarc';
   
   admin.initializeApp();
   
   // Set eventChannel to a newly-initialized channel, or `undefined` if events
   // aren't enabled.
   const eventChannel =
     process.env.EVENTARC_CHANNEL &&
     getEventarc().channel(process.env.EVENTARC_CHANNEL, {
       allowedEventTypes: process.env.EXT_SELECTED_EVENTS,
     });
   

3. আপনার এক্সটেনশনের যেসব পয়েন্টে আপনি ব্যবহারকারীদের কাছে প্রকাশ করতে চান, সেখানে চ্যানেলে ইভেন্ট প্রকাশ করুন। উদাহরণস্বরূপ:

   // If events are enabled, publish a `complete` event to the configured
   // channel.
   eventChannel && eventChannel.publish({
       type: 'firebase.extensions.storage-resize-images.v1.complete',
       subject: filename,  // the name of the original file
       data: {
         // ...
       }
   });
   

4. আপনার প্রকাশিত ইভেন্টগুলি PREINSTALL অথবা POSTINSTALL ফাইলে নথিভুক্ত করুন।

   প্রতিটি ইভেন্টের জন্য, নিম্নলিখিতগুলি নথিভুক্ত করুন:

   • এর উদ্দেশ্য
   • আপনার এক্সটেনশনের লজিকের মূল বিষয়টি এটি চালায়
   • এতে অন্তর্ভুক্ত আউটপুট ডেটা
   • এর বাস্তবায়নের শর্তাবলী

   অতিরিক্তভাবে, ব্যবহারকারীদের সতর্ক করুন যে তাদের ইভেন্ট হ্যান্ডলারগুলিতে এমন কোনও ক্রিয়া সম্পাদন করবেন না যা একই এক্সটেনশনকে ট্রিগার করতে পারে, যার ফলে একটি অসীম লুপ তৈরি হতে পারে।

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

উদাহরণস্বরূপ, নিম্নলিখিত উদাহরণটি মূল ছবিটি পুনরায় আকার দেওয়ার পরে মুছে ফেলে। মনে রাখবেন যে এই উদাহরণ হ্যান্ডলারটি ইভেন্টের subject সম্পত্তি ব্যবহার করে, যা এই ক্ষেত্রে ছবির মূল ফাইলের নাম।

exports.onimageresized = onCustomEventPublished(
    "firebase.extensions.storage-resize-images.v1.complete",
    (event) => {
      logger.info("Received image resize completed event", event);
      // For example, delete the original.
      return admin.storage()
          .bucket("my-project.firebasestorage.app")
          .file(event.subject)
          .delete();
    });

আরও তথ্যের জন্য কাস্টম ইভেন্ট ট্রিগার দেখুন।

উদাহরণ

অফিসিয়াল রিসাইজ ইমেজেস এক্সটেনশনটি একটি ছবির আকার পরিবর্তনের পর Eventarc-এ প্রকাশ করে একটি অ্যাসিঙ্ক্রোনাস হুক প্রদান করে।

সিঙ্ক্রোনাস হুক

যখন আপনি ব্যবহারকারীদের এমন একটি হুক প্রদান করতে চান যা আপনার এক্সটেনশন ফাংশনগুলির একটি পরিচালনার জন্য সফলভাবে সম্পন্ন করতে হবে, তখন সিঙ্ক্রোনাস হুক ব্যবহার করুন।

একটি সিঙ্ক্রোনাস হুক একটি ব্যবহারকারী-সংজ্ঞায়িত HTTPS কলযোগ্য ক্লাউড ফাংশন কল করে এবং চালিয়ে যাওয়ার আগে সম্পূর্ণ হওয়ার জন্য অপেক্ষা করে (সম্ভবত একটি ফেরত মান সহ)। ব্যবহারকারী-প্রদত্ত ফাংশনে একটি ত্রুটির ফলে এক্সটেনশন ফাংশনে একটি ত্রুটি দেখা দেয়।

একটি সিঙ্ক্রোনাস হুক প্রকাশ করতে:

1. আপনার এক্সটেনশনে এমন একটি প্যারামিটার যোগ করুন যা ব্যবহারকারীদের তাদের কাস্টম ক্লাউড ফাংশনের URL দিয়ে এক্সটেনশনটি কনফিগার করতে দেয়। উদাহরণস্বরূপ:

   - param: PREPROCESSING_FUNCTION
     label: Pre-processing function URL
     description: >
       An HTTPS callable function that will be called to transform the input data
       before it is processed by this function.
     type: string
     example: https://us-west1-my-project-id.cloudfunctions.net/preprocessData
     required: false
   

2. আপনার এক্সটেনশনের যেখানে আপনি হুকটি প্রকাশ করতে চান, সেখানে ফাংশনটির URL ব্যবহার করে কল করুন। উদাহরণস্বরূপ:

   const functions = require('firebase-functions/v1');
   const fetch = require('node-fetch');
   
   const preprocessFunctionURL = process.env.PREPROCESSING_FUNCTION;
   
   exports.yourFunctionName = functions.firestore.document("collection/{doc_id}")
       .onWrite((change, context) => {
         // PREPROCESSING_FUNCTION hook begins here.
         // If a preprocessing function is defined, call it before continuing.
         if (preprocessFunctionURL) {
           try {
             await fetch(preprocessFunctionURL); // Could also be a POST request if you want to send data.
           } catch (e) {
             // Preprocessing failure causes the function to fail.
             functions.logger.error("Preprocessor error:", e);
             return;
           }
         }
         // End of PREPROCESSING_FUNCTION hook.
   
         // Main function logic follows.
         // ...
       });
   

3. আপনার দ্বারা উপলব্ধ যেকোনো হুক PREINSTALL অথবা POSTINSTALL ফাইলে নথিভুক্ত করুন।

   প্রতিটি হুকের জন্য, নিম্নলিখিতগুলি নথিভুক্ত করুন:

   • এর উদ্দেশ্য
   • আপনার এক্সটেনশনের লজিকের মূল বিষয়টি এটি চালায়
   • এর প্রত্যাশিত ইনপুট এবং আউটপুট
   • এর বাস্তবায়নের জন্য শর্তাবলী (বা বিকল্পগুলি)

   অতিরিক্তভাবে, ব্যবহারকারীদের হুক ফাংশনে এমন কোনও ক্রিয়া সম্পাদন না করার জন্য সতর্ক করুন যা একই এক্সটেনশনকে ট্রিগার করতে পারে, যার ফলে একটি অসীম লুপ তৈরি হতে পারে।

উদাহরণ

অ্যালগোলিয়া সার্চ এক্সটেনশনটি অ্যালগোলিয়ায় লেখার আগে ব্যবহারকারী-সরবরাহকৃত ট্রান্সফর্ম ফাংশন কল করার জন্য একটি সিঙ্ক্রোনাস হুক প্রদান করে।