namespaced API থেকে মডিউলার অ্যাপ্লিকেশনে আপগ্রেড করা

compat লাইব্রেরি থেকে শুরু করে ভার্সন ৮ বা তার আগের ভার্সন পর্যন্ত নেমস্পেস করা যেকোনও Firebase ওয়েব API ব্যবহার করা অ্যাপের ক্ষেত্রে, এই গাইডের নির্দেশাবলী ব্যবহার করে মডিউলার API-তে মাইগ্রেট করার কথা বিবেচনা করা উচিত।

এই নির্দেশিকা ধরে নেয় যে আপনি namespaced API সম্পর্কে জানেন এবং আপগ্রেড করা ও চলমান মডিউলার অ্যাপ ডেভেলপমেন্টের জন্য webpack বা Rollup-এর মতো মডিউল বান্ডলারের সুবিধা নেবেন।

আপনার ডেভেলপমেন্ট এনভায়রনমেন্টে মডিউল বান্ডলার ব্যবহার করার জন্য জোর দিয়ে সাজেস্ট করা হচ্ছে। আপনি যদি একটি ব্যবহার না করেন, তাহলে আপনি মডুলার API-এর প্রধান সুবিধাগুলি ব্যবহার করতে পারবেন না, যার ফলে অ্যাপের সাইজ কমে যায়। SDK ইনস্টল করতে আপনার npm বা yarn প্রয়োজন হবে।

এই গাইডে আপগ্রেড করার ধাপগুলি একটি কাল্পনিক ওয়েব অ্যাপের উপর ভিত্তি করে তৈরি করা হয়েছে যা Authentication এবং Cloud Firestore SDK ব্যবহার করে। উদাহরণগুলি দেখে আপনি Firebase-এর সব কাজ করে এমন ওয়েব SDK আপগ্রেড করার জন্য প্রয়োজনীয় কনসেপ্ট ও প্র্যাক্টিক্যাল ধাপগুলি শিখে নিতে পারবেন।

নেমস্পেসড (compat) লাইব্রেরি সম্পর্কে

Firebase ওয়েব SDK-এর জন্য দুই ধরনের লাইব্রেরি উপলভ্য:

  • মডিউলার - একটি নতুন API সারফেস যা ট্রি-শেকিং (অব্যবহৃত কোড সরানো) সহজ করার জন্য ডিজাইন করা হয়েছে যাতে আপনার ওয়েব অ্যাপ যতটা সম্ভব ছোট এবং দ্রুত করা যায়।
  • Namespaced (compat) - একটি পরিচিত API সারফেস যা SDK-এর আগের ভার্সনের সাথে সম্পূর্ণ মানানসই, এটি আপনাকে একবারে আপনার সমস্ত Firebase কোড পরিবর্তন না করেই আপগ্রেড করার অনুমতি দেয়। কম্প্যাট লাইব্রেরির সাইজ বা পারফর্ম্যান্সের সুবিধা তাদের নেমস্পেস করা কাউন্টারপার্টের তুলনায় খুব কম বা নেই বললেই চলে।

এই নির্দেশিকা ধরে নেয় যে আপনি আপগ্রেড করার জন্য কম্প্যাট লাইব্রেরির সুবিধা নেবেন। এইসব লাইব্রেরি আপনাকে মডিউলার API-এর জন্য রিফ্যাক্টর করা কোডের পাশাপাশি নেমস্পেস করা কোড ব্যবহার করা চালিয়ে যেতে দেয়। এর অর্থ হল, আপগ্রেড করার প্রসেস চলাকালীন আপনি আরও সহজে অ্যাপ কম্পাইল ও ডিবাগ করতে পারবেন।

Firebase ওয়েব SDK-তে খুব কম এক্সপোজার সহ অ্যাপের জন্য—যেমন, এমন অ্যাপ যা শুধুমাত্র Authentication API-তে একটি সাধারণ কল করে—কম্প্যাট লাইব্রেরি ব্যবহার না করে পুরনো নেমস্পেসড কোড রিফ্যাক্টর করা বাস্তবসম্মত হতে পারে। আপনি যদি এই ধরনের কোনও অ্যাপ আপগ্রেড করেন, তাহলে কম্প্যাট লাইব্রেরি ব্যবহার না করেই "modular API"-এর জন্য এই গাইডে দেওয়া নির্দেশাবলী অনুসরণ করতে পারেন।

আপগ্রেড করার প্রসেস সম্পর্কে

আপগ্রেড করার প্রসেসের প্রতিটি ধাপের স্কোপ নির্ধারণ করা হয় যাতে আপনি অ্যাপের সোর্স এডিট করা শেষ করতে পারেন এবং তারপরে কোনও সমস্যা ছাড়াই এটি কম্পাইল ও রান করতে পারেন। সংক্ষেপে, অ্যাপ আপগ্রেড করার জন্য আপনাকে যা করতে হবে:

  1. আপনার অ্যাপে মডিউলার লাইব্রেরি ও কম্প্যাট লাইব্রেরি যোগ করুন।
  2. আপনার কোডে ইমপোর্ট স্টেটমেন্ট আপডেট করে compat-এ পরিবর্তন করুন।
  3. একটি প্রোডাক্টের (যেমন, Authentication) কোড রিফ্যাক্টর করে মডিউলার স্টাইলে পরিবর্তন করো।
  4. ঐচ্ছিক: এই পর্যায়ে, Authentication-এর জন্য Authentication কম্প্যাট লাইব্রেরি ও কম্প্যাট কোড সরিয়ে দিন যাতে চালিয়ে যাওয়ার আগে Authentication-এর জন্য অ্যাপ সাইজের সুবিধা উপলব্ধ হয়।
  5. প্রতিটি প্রোডাক্টের জন্য ফাংশন রিফ্যাক্টর করুন (যেমন, Cloud Firestore, FCM, ইত্যাদি) মডিউলার স্টাইলে, কম্পাইল এবং সব ক্ষেত্র সম্পূর্ণ না হওয়া পর্যন্ত পরীক্ষা করা।
  6. মডুলার স্টাইলে ইনিশিয়ালাইজেশন কোড আপডেট করুন।
  7. আপনার অ্যাপ থেকে বাকি সব কম্প্যাট স্টেটমেন্ট ও কম্প্যাট কোড সরিয়ে দিন।

SDK-এর লেটেস্ট ভার্সন ডাউনলোড করুন

শুরু করতে, npm ব্যবহার করে মডিউলার লাইব্রেরি এবং কম্প্যাট লাইব্রেরি পান:

npm i firebase@13.2.0

# OR

yarn add firebase@13.2.0

কমপ্যাট করার জন্য ইমপোর্ট আপডেট করুন

আপনার ডিপেন্ডেন্সি আপডেট করার পরে আপনার কোড যাতে কাজ করে, তার জন্য প্রতিটি ইমপোর্টের "compat" ভার্সন ব্যবহার করতে আপনার ইমপোর্ট স্টেটমেন্ট পরিবর্তন করুন। যেমন:

আগে: ভার্সন ৮ বা তার আগের ভার্সন

import firebase from 'firebase/app';
import 'firebase/auth';
import 'firebase/firestore';

After: compat

// compat packages are API compatible with namespaced code
import firebase from 'firebase/compat/app';
import 'firebase/compat/auth';
import 'firebase/compat/firestore';

মডিউলার স্টাইলে রিফ্যাক্টর করুন

namespaced API ডট-চেনড নেমস্পেস ও পরিষেবা প্যাটার্নের উপর ভিত্তি করে তৈরি হলেও, মডুলার অ্যাপ্রোচের অর্থ হল আপনার কোড মূলত ফাংশন-এর উপর ভিত্তি করে অর্গানাইজ করা হবে। মডুলার API-তে, firebase/app প্যাকেজ এবং অন্যান্য প্যাকেজ এমন একটি বিস্তারিত এক্সপোর্ট রিটার্ন করে না যাতে প্যাকেজের সব পদ্ধতি থাকে। পরিবর্তে, প্যাকেজগুলি আলাদা আলাদা ফাংশন এক্সপোর্ট করে।

মডিউলার API-তে, পরিষেবাগুলি প্রথম আর্গুমেন্ট হিসাবে পাস করা হয় এবং ফাংশনটি তখন বাকি কাজ করতে পরিষেবার বিবরণ ব্যবহার করে। আসুন, দুটি উদাহরণের মাধ্যমে এটি কীভাবে কাজ করে তা পরীক্ষা করে দেখি, যেখানে Authentication এবং Cloud Firestore API-তে কল রিফ্যাক্টর করা হয়।

উদাহরণ ১: Authentication ফাংশন রিফ্যাক্টর করা

আগে: compat

কম্প্যাট কোডটি নেমস্পেসড কোডের মতোই, তবে ইম্পোর্ট পরিবর্তিত হয়েছে।

import firebase from "firebase/compat/app";
import "firebase/compat/auth";

const auth = firebase.auth();
auth.onAuthStateChanged(user => { 
  // Check for user status
});

পরে: মডিউলার

getAuth ফাংশন প্রথম প্যারামিটার হিসেবে firebaseApp নেয়। onAuthStateChanged ফাংশনটি auth ইনস্ট্যান্স থেকে চেইন করা হয় না, যেমনটি namespaced API-তে হয়; পরিবর্তে, এটি একটি ফ্রি ফাংশন যা auth-কে তার প্রথম প্যারামিটার হিসেবে নেয়।

import { getAuth, onAuthStateChanged } from "firebase/auth";

const auth = getAuth(firebaseApp);
onAuthStateChanged(auth, user => {
  // Check for user status
});

getRedirectResult যাচাইকরণ পদ্ধতি ম্যানেজ করার প্রসেস আপডেট করুন

মডুলার API, getRedirectResult-এ ব্রেকিং পরিবর্তন নিয়ে আসে। কোনও রিডাইরেক্ট অপারেশন কল করা না হলে, modular API null রিটার্ন করে, namespaced API-এর ক্ষেত্রে এটি হয় না, যা null ব্যবহারকারীর সাথে UserCredential রিটার্ন করে।

আগে: compat

const result = await auth.getRedirectResult()
if (result.user === null && result.credential === null) {
  return null;
}
return result;

পরে: মডিউলার

const result = await getRedirectResult(auth);
// Provider of the access token could be Facebook, Github, etc.
if (result === null || provider.credentialFromResult(result) === null) {
  return null;
}
return result;

উদাহরণ ২: Cloud Firestore ফাংশন রিফ্যাক্টর করা

আগে: compat

import "firebase/compat/firestore"

const db = firebase.firestore();
db.collection("cities").where("capital", "==", true)
    .get()
    .then((querySnapshot) => {
        querySnapshot.forEach((doc) => {
            // doc.data() is never undefined for query doc snapshots
            console.log(doc.id, " => ", doc.data());
        });
    })
    .catch((error) => {
        console.log("Error getting documents: ", error);
    });

পরে: মডিউলার

getFirestore ফাংশন প্রথম প্যারামিটার হিসেবে firebaseApp নেয়, যা আগের উদাহরণে initializeApp থেকে ফেরত পাঠানো হয়েছিল। মনে রাখবেন, মডুলার API-তে কোয়েরি তৈরি করার কোডটি খুবই আলাদা; কোনও চেইনিং নেই এবং query বা where-এর মতো পদ্ধতিগুলি এখন ফ্রি ফাংশন হিসেবে প্রকাশ করা হয়েছে।

import { getFirestore, collection, query, where, getDocs } from "firebase/firestore";

const db = getFirestore(firebaseApp);

const q = query(collection(db, "cities"), where("capital", "==", true));

const querySnapshot = await getDocs(q);
querySnapshot.forEach((doc) => {
  // doc.data() is never undefined for query doc snapshots
  console.log(doc.id, " => ", doc.data());
});

Firestore DocumentSnapshot.exists-এ রেফারেন্স আপডেট করুন

মডুলার API একটি ব্রেকিং পরিবর্তন নিয়ে আসে যেখানে প্রপার্টি firestore.DocumentSnapshot.exists-কে পদ্ধতিতে পরিবর্তন করা হয়েছে। ফাংশনালিটি মূলত একই (ডকুমেন্ট আছে কিনা তা পরীক্ষা করা) তবে দেখানো নতুন পদ্ধতি ব্যবহার করার জন্য আপনাকে অবশ্যই কোড রিফ্যাক্টর করতে হবে:

Before:compat

if (snapshot.exists) {
  console.log("the document exists");
}

পরে: মডিউলার

if (snapshot.exists()) {
  console.log("the document exists");
}

উদাহরণ ৩: নেমস্পেস ও মডিউলার কোড স্টাইল একত্রিত করা

আপগ্রেড করার সময় কম্প্যাট লাইব্রেরি ব্যবহার করলে, আপনি modular API-এর জন্য রিফ্যাক্টর করা কোডের পাশাপাশি নেমস্পেসড কোড ব্যবহার করা চালিয়ে যেতে পারবেন। এর অর্থ হল, আপনি Authentication বা অন্যান্য Firebase SDK কোড মডুলার স্টাইলে রিফ্যাক্টর করার সময় Cloud Firestore-এর জন্য আগে থেকে থাকা নেমস্পেসড কোড রেখে দিতে পারবেন এবং এখনও দুটি কোড স্টাইল ব্যবহার করে আপনার অ্যাপ সফলভাবে কম্পাইল করতে পারবেন। একইভাবে, কোনও প্রোডাক্টের মধ্যে নেমস্পেস করা এবং মডিউলার API কোডের ক্ষেত্রেও এটি প্রযোজ্য, যেমন Cloud Firestore; আপনি যতক্ষণ পর্যন্ত কম্প্যাট প্যাকেজ ইমপোর্ট করছেন, ততক্ষণ পর্যন্ত নতুন এবং পুরনো কোড স্টাইল একসাথে থাকতে পারে:

import firebase from 'firebase/compat/app';
import 'firebase/compat/firestore';
import { getDoc } from 'firebase/firestore'

const docRef = firebase.firestore().doc();
getDoc(docRef);

মনে রাখবেন যে, আপনার অ্যাপ কম্পাইল করা হলেও, আপনি অ্যাপ থেকে কম্প্যাট স্টেটমেন্ট এবং কোড সম্পূর্ণভাবে না সরানো পর্যন্ত মডুলার কোডের অ্যাপ সাইজ সংক্রান্ত সুবিধা পাবেন না।

ইনিশিয়ালাইজেশন কোড আপডেট করুন

মডিউলার সিনট্যাক্স ব্যবহার করতে আপনার অ্যাপের ইনিশিয়ালাইজেশন কোড আপডেট করুন। আপনার অ্যাপের সব কোড রিফ্যাক্টর করা সম্পূর্ণ করার পরে এই কোড আপডেট করা গুরুত্বপূর্ণ; কারণ firebase.initializeApp() কম্প্যাট ও মডিউলার API, দুটির জন্যই গ্লোবাল স্টেট ইনিশিয়ালাইজ করে, যেখানে মডিউলার initializeApp() ফাংশন শুধু মডিউলারের জন্য স্টেট ইনিশিয়ালাইজ করে।

আগে: compat

import firebase from "firebase/compat/app"

firebase.initializeApp({ /* config */ });

পরে: মডিউলার

import { initializeApp } from "firebase/app"

const firebaseApp = initializeApp({ /* config */ });

কম্প্যাট কোড সরান

মডুলার API-এর সাইজ সংক্রান্ত সুবিধা পেতে, আপনাকে শেষ পর্যন্ত উপরে দেখানো মডুলার স্টাইলে সব ইনভোকেশন কনভার্ট করতে হবে এবং আপনার কোড থেকে সব import "firebase/compat/* স্টেটমেন্ট সরিয়ে দিতে হবে। আপনার কাজ হয়ে গেলে, namespaced API স্টাইলে firebase.* গ্লোবাল নেমস্পেস বা অন্য কোনও কোডের আর কোনও রেফারেন্স থাকা উচিত নয়।

উইন্ডো থেকে কম্প্যাট লাইব্রেরি ব্যবহার করা হচ্ছে

মডিউলার API ব্রাউজারের window অবজেক্টের পরিবর্তে মডিউলের সাথে কাজ করার জন্য অপ্টিমাইজ করা হয়েছে। লাইব্রেরির আগের ভার্সনগুলি window.firebase নেমস্পেস ব্যবহার করে Firebase লোড এবং ম্যানেজ করার অনুমতি দেয়। এটি ভবিষ্যতে ব্যবহার করার জন্য সাজেস্ট করা হয় না, কারণ এটি অব্যবহৃত কোড বাদ দেওয়ার অনুমতি দেয় না। তবে, জাভাস্ক্রিপ্ট SDK-এর কম্প্যাট ভার্সন window-এর সাথে কাজ করে সেইসব ডেভেলপারদের জন্য যারা মডিউলার আপগ্রেড পাথ অবিলম্বে শুরু করতে চান না।

<script src="https://www.gstatic.com/firebasejs/13.2.0/firebase-app-compat.js"></script>
<script src="https://www.gstatic.com/firebasejs/13.2.0/firebase-firestore-compat.js"></script>
<script src="https://www.gstatic.com/firebasejs/13.2.0/firebase-auth-compat.js"></script>
<script>
   const firebaseApp = firebase.initializeApp({ /* Firebase config */ });
   const db = firebaseApp.firestore();
   const auth = firebaseApp.auth();
</script>

কম্প্যাটিবিলিটি লাইব্রেরি ব্যাকগ্রাউন্ডে মডিউলার কোড ব্যবহার করে এবং namespaced API-এর মতো একই API প্রদান করে; এর অর্থ হল আপনি বিস্তারিত জানার জন্য namespaced API রেফারেন্স এবং namespaced কোড স্নিপেট দেখতে পারেন। এই পদ্ধতিটি দীর্ঘমেয়াদী ব্যবহারের জন্য সাজেস্ট করা হয় না, তবে সম্পূর্ণ মডুলার লাইব্রেরিতে আপগ্রেড করার জন্য একটি শুরু হিসাবে ব্যবহার করা যেতে পারে।

মডিউলার SDK-এর সুবিধা ও সীমাবদ্ধতা

সম্পূর্ণ মডিউলারাইজড SDK-এর আগের ভার্সনের তুলনায় এইসব সুবিধা আছে:

  • মডিউলার SDK-এর মাধ্যমে অ্যাপের সাইজ অনেকখানি কমানো যায়। এটি আধুনিক JavaScript মডিউল ফর্ম্যাট গ্রহণ করে, যা "ট্রি শেকিং" অনুশীলনের অনুমতি দেয় যেখানে আপনি শুধুমাত্র আপনার অ্যাপের প্রয়োজনীয় আর্টিফ্যাক্ট ইমপোর্ট করেন। আপনার অ্যাপের উপর নির্ভর করে, মডুলার SDK-এর সাথে ট্রি-শেকিংয়ের ফলে namespaced API ব্যবহার করে তৈরি করা তুলনামূলক অ্যাপের চেয়ে ৮০% কম কিলোবাইট হতে পারে।
  • মডুলার SDK-তে নতুন ফিচার ডেভেলপমেন্টের সুবিধা পাওয়া যাবে, তবে namespaced API-তে তা পাওয়া যাবে না।