जनरेट किए गए एडमिन एसडीके का इस्तेमाल करना

Firebase SQL Connect admin SDKs की मदद से, Cloud Functions, कस्टम बैकएंड या अपने वर्कस्टेशन जैसे भरोसेमंद प्लैटफ़ॉर्म से क्वेरी और म्यूटेशन को कॉल किया जा सकता है. जिस तरह क्लाइंट ऐप्लिकेशन के लिए SDK टूल जनरेट किए जाते हैं उसी तरह कस्टम एडमिन SDK टूल भी जनरेट किया जा सकता है. इसके लिए, आपको स्कीमा, क्वेरी, और म्यूटेशन डिज़ाइन करने होंगे, जिन्हें SQL Connect सेवा में डिप्लॉय किया जाएगा. इसके बाद, इस एसडीके के तरीकों को अपने बैकएंड लॉजिक या एडमिन स्क्रिप्ट में इंटिग्रेट करें.

जैसा कि हमने पहले भी बताया है, यह ध्यान रखना ज़रूरी है कि अनुरोध के समय, क्लाइंट SQL Connect क्वेरी और म्यूटेशन सबमिट नहीं करते. इसके बजाय, डिप्लॉय किए जाने पर SQL Connect कार्रवाइयां, Cloud Functions की तरह सर्वर पर सेव की जाती हैं. इसका मतलब है कि जब भी अपनी क्वेरी और म्यूटेशन में बदलाव किए जाएंगे, तब आपको Admin SDK को फिर से जनरेट करना होगा. साथ ही, उन पर निर्भर सभी सेवाओं को फिर से डिप्लॉय करना होगा.

शुरू करने से पहले

  • SQL Connect स्कीमा, क्वेरी, और म्यूटेशन डिज़ाइन करने के बारे में जानें. सामान्य वर्कफ़्लो में, इन्हें आपके ऐप्लिकेशन कोड के साथ-साथ डेवलप किया जाएगा. इसमें एडमिन SDK टूल का इस्तेमाल करने वाली सेवाएं भी शामिल हैं.
  • Firebase CLI इंस्टॉल करें.

  • जनरेट किए गए Admin SDK टूल को जहां भी कॉल करना हो वहां डिपेंडेंसी के तौर पर, Node.js के लिए Admin SDK टूल को शामिल करें.

एडमिन एसडीके जनरेट करना

SQL Connect स्कीमा, क्वेरी, और म्यूटेशन बनाने के बाद, उनसे जुड़ा Admin SDK जनरेट किया जा सकता है:

  1. connector.yaml फ़ाइल खोलें या बनाएं और adminNodeSdk डेफ़िनिशन जोड़ें:

    connectorId: default
    generate:
      adminNodeSdk:
        outputDir: ../../dataconnect-generated/admin-generated
        package: "@dataconnect/admin-generated"
        packageJsonDir: ../..
    

    connector.yaml फ़ाइल आम तौर पर उसी डायरेक्ट्री में मिलती है जिसमें GraphQL (.gql) फ़ाइलें होती हैं. इन फ़ाइलों में आपकी क्वेरी और म्यूटेशन की परिभाषाएं होती हैं. अगर आपने क्लाइंट SDK टूल पहले ही जनरेट कर लिए हैं, तो यह फ़ाइल पहले ही बनाई जा चुकी है.

  2. एसडीके जनरेट करें.

    अगर आपने SQL Connect VS Code एक्सटेंशन इंस्टॉल किया है, तो यह जनरेट किए गए एसडीके को हमेशा अप-टू-डेट रखेगा.

    अगर ऐसा नहीं है, तो Firebase CLI का इस्तेमाल करें:

    firebase dataconnect:sdk:generate

    इसके अलावा, gql फ़ाइलों को अपडेट करने पर, एसडीके अपने-आप फिर से जनरेट होने की सुविधा चालू करने के लिए:

    firebase dataconnect:sdk:generate --watch

एडमिन SDK से कार्रवाइयां करना

जनरेट किए गए Admin SDK में, आपके gql की परिभाषाओं से जुड़े इंटरफ़ेस और फ़ंक्शन होते हैं. इनका इस्तेमाल करके, अपने डेटाबेस पर कार्रवाइयां की जा सकती हैं. उदाहरण के लिए, मान लें कि आपने गानों के डेटाबेस के लिए एक एसडीके जनरेट किया है. साथ ही, आपने यह क्वेरी भी जनरेट की है, getSongs:

import { initializeApp } from "firebase-admin/app";
import { getSongs } from "@dataconnect/admin-generated";

const adminApp = initializeApp();

const songs = await getSongs(
  { limit: 4 },
  { impersonate: { unauthenticated: true } }
);

इसके अलावा, कनेक्टर कॉन्फ़िगरेशन तय करने के लिए:

import { initializeApp } from "firebase-admin/app";
import { getDataConnect } from "firebase-admin/data-connect";
import {
  connectorConfig,
  getSongs,
} from "@dataconnect/admin-generated";

const adminApp = initializeApp();
const adminDc = getDataConnect(connectorConfig);

const songs = await getSongs(
  adminDc,
  { limit: 4 },
  { impersonate: { unauthenticated: true } }
);

किसी ऐसे उपयोगकर्ता की पहचान चुराना जिसकी पुष्टि नहीं हुई है

Admin SDK टूल, भरोसेमंद एनवायरमेंट से चलाए जाते हैं. इसलिए, उनके पास आपके डेटाबेस का पूरा ऐक्सेस होता है.

Admin SDK की मदद से सार्वजनिक कार्रवाइयां करते समय, आपको एडमिन के सभी अधिकारों के साथ कार्रवाई करने से बचना चाहिए. इसके बजाय, कम से कम अधिकारों के सिद्धांत का पालन करें. इसके बजाय, आपको कार्रवाई को किसी ऐसे उपयोगकर्ता के तौर पर चलाना चाहिए जिसकी पहचान की पुष्टि की गई हो (अगला सेक्शन देखें) या जिसकी पहचान की पुष्टि न की गई हो. जिन उपयोगकर्ताओं की पुष्टि नहीं हुई है वे सिर्फ़ PUBLIC के तौर पर मार्क की गई कार्रवाइयां कर सकते हैं.

ऊपर दिए गए उदाहरण में, getSongs क्वेरी को ऐसे उपयोगकर्ता के तौर पर चलाया जाता है जिसकी पुष्टि नहीं हुई है.

किसी उपयोगकर्ता की पहचान चुराना

आपके पास कुछ उपयोगकर्ताओं की ओर से कार्रवाइयां करने का विकल्प भी होता है. इसके लिए, impersonate विकल्प में Firebase Authentication टोकन का कुछ हिस्सा या पूरा टोकन पास करें. आपको कम से कम, सब क्लेम में उपयोगकर्ता का यूज़र आईडी बताना होगा. (यह वैल्यू, auth.uid सर्वर वैल्यू के बराबर होती है. इसे SQL Connect GraphQL ऑपरेशन में रेफ़रंस के तौर पर इस्तेमाल किया जा सकता है.)

किसी उपयोगकर्ता के तौर पर काम करने पर, कार्रवाई सिर्फ़ तब पूरी होगी, जब आपके दिए गए उपयोगकर्ता डेटा की पुष्टि हो जाएगी. यह पुष्टि, आपकी GraphQL परिभाषा में बताई गई जांचों के आधार पर की जाती है.

अगर जनरेट किए गए एसडीके को सार्वजनिक तौर पर ऐक्सेस किए जा सकने वाले एंडपॉइंट से कॉल किया जा रहा है, तो यह ज़रूरी है कि एंडपॉइंट के लिए पुष्टि करना ज़रूरी हो. साथ ही, किसी उपयोगकर्ता के तौर पर काम करने के लिए, पुष्टि करने वाले टोकन का इस्तेमाल करने से पहले, उसकी इंटिग्रिटी की पुष्टि करना ज़रूरी है.

कॉल किए जा सकने वाले Cloud Functions का इस्तेमाल करने पर, पुष्टि करने वाले टोकन की पुष्टि अपने-आप हो जाती है. इसका इस्तेमाल, यहां दिए गए उदाहरण की तरह किया जा सकता है:

import { HttpsError, onCall } from "firebase-functions/https";

export const callableExample = onCall(async (req) => {
    const authClaims = req.auth?.token;
    if (!authClaims) {
        throw new HttpsError("unauthenticated", "Unauthorized");
    }

    const favoriteSongs = await getMyFavoriteSongs(
        undefined,
        { impersonate: { authClaims } }
    );

    // ...
});

इसके अलावा, पुष्टि करने वाले टोकन की पुष्टि करने और उसे डिकोड करने के लिए, Admin SDK के verifyIdToken तरीके का इस्तेमाल करें. उदाहरण के लिए, मान लें कि आपका एंडपॉइंट, सामान्य एचटीटीपी फ़ंक्शन के तौर पर लागू किया गया है. साथ ही, आपने स्टैंडर्ड के तौर पर, authorization हेडर का इस्तेमाल करके, अपने एंडपॉइंट पर Firebase Authentication टोकन पास किया है:

import { getAuth } from "firebase-admin/auth";
import { onRequest } from "firebase-functions/https";

const auth = getAuth();

export const httpExample = onRequest(async (req, res) => {
    const token = req.header("authorization")?.replace(/^bearer\s+/i, "");
    if (!token) {
        res.sendStatus(401);
        return;
    }
    let authClaims;
    try {
        authClaims = await auth.verifyIdToken(token);
    } catch {
        res.sendStatus(401);
        return;
    }

    const favoriteSongs = await getMyFavoriteSongs(
        undefined,
        { impersonate: { authClaims } }
    );

    // ...
});

सिर्फ़ डेटा माइग्रेशन जैसे एडमिन से जुड़े टास्क करते समय, आपको ऐसा यूज़र आईडी डालना चाहिए जिसकी पुष्टि किसी सोर्स से न की जा सके. हालांकि, इसके लिए ज़रूरी है कि ये टास्क किसी सुरक्षित और सार्वजनिक तौर पर ऐक्सेस न किए जा सकने वाले एनवायरमेंट से किए जा रहे हों:

// Never do this if end users can initiate execution of the code!
const favoriteSongs = await getMyFavoriteSongs(
  undefined,
  { impersonate: { authClaims } }
);

बिना किसी पाबंदी के ऐक्सेस के साथ चल रहा है

अगर आपको कोई ऐसी कार्रवाई करनी है जिसके लिए एडमिन लेवल की अनुमतियों की ज़रूरत है, तो कॉल से impersonate पैरामीटर को हटा दें:

await upsertSong(adminDc, {
  title: songTitle_one,
  instrumentsUsed: [Instrument.VOCAL],
});

इस तरह से कॉल किए गए ऑपरेशन के पास, डेटाबेस का पूरा ऐक्सेस होता है. अगर आपके पास ऐसी क्वेरी या म्यूटेशन हैं जिनका इस्तेमाल सिर्फ़ एडमिन के लिए किया जाना है, तो आपको उन्हें @auth(level: NO_ACCESS) डायरेक्टिव के साथ तय करना चाहिए. ऐसा करने से, यह पक्का होता है कि सिर्फ़ एडमिन लेवल के कॉलर ही इन कार्रवाइयों को लागू कर सकते हैं.