ใช้ Admin SDK กับ SQL Connect

Firebase Admin SDK คือชุดไลบรารีเซิร์ฟเวอร์ที่ช่วยให้คุณโต้ตอบกับ Firebase จากสภาพแวดล้อมที่มีสิทธิ์เพื่อดำเนินการต่างๆ เช่น การค้นหา และการเปลี่ยนแปลงในบริการ Firebase SQL Connect สำหรับการจัดการข้อมูลแบบเป็นกลุ่ม รวมถึงการดำเนินการอื่นๆ ที่มีสิทธิ์เข้าถึงระดับสูงและข้อมูลเข้าสู่ระบบที่สวมบทบาท

Admin SDK มี API ให้คุณเรียกใช้การดำเนินการทั้งใน โหมดอ่าน/เขียนและโหมดอ่านอย่างเดียว การดำเนินการในโหมดอ่านอย่างเดียวช่วยให้คุณมั่นใจได้ว่าจะสามารถใช้ฟังก์ชันการดูแลระบบที่ไม่สามารถแก้ไขข้อมูลในฐานข้อมูลได้

การตั้งค่า Admin SDK

หากต้องการเริ่มต้นใช้งานกับ Firebase SQL Connect ในเซิร์ฟเวอร์ คุณจะต้อง ติดตั้งและตั้งค่า Admin SDK สำหรับ Node.js ก่อน

เริ่มต้น Admin SDK ในสคริปต์

หากต้องการเริ่มต้น SDK ให้นำเข้าส่วนขยาย SQL Connect และ ประกาศรหัสบริการและสถานที่ตั้งของโปรเจ็กต์


import { initializeApp } from 'firebase-admin/app';
import { getDataConnect } from 'firebase-admin/data-connect';

// If you'd like to use OAuth2 flows and other credentials to log in,
// visit https://firebase.google.com/docs/admin/setup#initialize-sdk
// for alternative ways to initialize the SDK.

const app = initializeApp();

const dataConnect = getDataConnect({
    serviceId: 'serviceId',
    location: 'us-west2'
});

ออกแบบการค้นหาและการเปลี่ยนแปลงที่จะใช้กับ Admin SDK

Admin SDK มีประโยชน์สำหรับการเรียกใช้การดำเนินการ SQL Connect โดยพิจารณา สิ่งต่อไปนี้

ทำความเข้าใจ SDK และคำสั่งการดำเนินการ @auth(level: NO_ACCESS)

เนื่องจาก Admin SDK ทำงานด้วยสิทธิ์ จึงสามารถเรียกใช้ การค้นหาและการเปลี่ยนแปลงใดก็ได้โดยไม่คำนึงถึงระดับการเข้าถึงที่ตั้งค่าโดยใช้ @auth คำสั่ง ซึ่งรวมถึงระดับ NO_ACCESS

หากคุณจัดระเบียบการค้นหาและการเปลี่ยนแปลงด้านการดูแลระบบในไฟล์ต้นฉบับ .gql เพื่อนำเข้าไปยังสคริปต์การดูแลระบบควบคู่ไปกับการดำเนินการของไคลเอ็นต์ Firebase ขอแนะนำให้คุณทำเครื่องหมายการดำเนินการด้านการดูแลระบบโดยไม่มีระดับการเข้าถึงการให้สิทธิ์ หรืออาจระบุให้ชัดเจนยิ่งขึ้นและตั้งค่าเป็น NO_ACCESS ไม่ว่าจะด้วยวิธีใดก็ตาม วิธีนี้จะป้องกันไม่ให้มีการดำเนินการดังกล่าวจากไคลเอ็นต์หรือในบริบทอื่นๆ ที่ไม่มีสิทธิ์

ใช้ SDK กับโปรแกรมจำลอง SQL Connect

ในสภาพแวดล้อมต้นแบบและสภาพแวดล้อมการทดสอบ การดำเนินการเริ่มต้นข้อมูลและการดำเนินการอื่นๆ กับข้อมูลในเครื่องอาจมีประโยชน์ Admin SDK ช่วยให้คุณลดความซับซ้อนของ เวิร์กโฟลว์ได้เนื่องจากสามารถข้ามการตรวจสอบสิทธิ์และการให้สิทธิ์สำหรับโฟลว์ในเครื่องได้ (นอกจากนี้ คุณยังเลือกที่จะปฏิบัติตามการกำหนดค่าการตรวจสอบสิทธิ์และการให้สิทธิ์ของการดำเนินการด้วยการสวมบทบาทเป็นผู้ใช้ได้ด้วย)

Firebase Admin SDK จะเชื่อมต่อกับโปรแกรมจำลอง SQL Connect โดยอัตโนมัติเมื่อตั้งค่าตัวแปรสภาพแวดล้อม DATA_CONNECT_EMULATOR_HOST ดังนี้

export DATA_CONNECT_EMULATOR_HOST="127.0.0.1:9399"

ดูข้อมูลเพิ่มเติมได้ที่

เรียกใช้การดำเนินการของผู้ดูแลระบบ

Admin SDK มีไว้สำหรับการดำเนินการที่มีสิทธิ์กับข้อมูลสำคัญ

Admin SDK มี API 3 ชุด ดังนี้

  • Admin SDK ที่สร้างขึ้น ซึ่งเป็น SDK ที่ปลอดภัยตามประเภทที่สร้างขึ้นจากคำจำกัดความ gql ในลักษณะเดียวกับที่คุณสร้าง SDK ของไคลเอ็นต์
  • อินเทอร์เฟซทั่วไปสำหรับการเรียกใช้การดำเนินการ GraphQL ที่กำหนดเอง ซึ่ง โค้ดของคุณจะใช้การค้นหาและการเปลี่ยนแปลง แล้วส่งไปยังเมธอดแบบอ่าน/เขียน executeGraphql หรือเมธอดแบบอ่านอย่างเดียว executeGraphqlRead
  • อินเทอร์เฟซเฉพาะสำหรับการดำเนินการกับข้อมูลแบบเป็นกลุ่ม ซึ่งแทนที่จะใช้ เมธอด executeGraphql ทั่วไป แต่จะแสดงเมธอดเฉพาะสำหรับการดำเนินการเปลี่ยนแปลง ได้แก่ insert, insertMany, upsert, และ upsertMany

จัดการข้อมูลด้วย SDK ที่สร้างขึ้น

คุณ สร้าง Admin SDK จากคำจำกัดความ gql ในลักษณะเดียวกับที่คุณสร้าง SDK ของไคลเอ็นต์

Admin SDK ที่สร้างขึ้นมีอินเทอร์เฟซและฟังก์ชันที่สอดคล้องกับคำจำกัดความ gql ซึ่งคุณสามารถใช้เพื่อดำเนินการกับฐานข้อมูลได้ ตัวอย่างเช่น สมมติว่าคุณสร้าง SDK สำหรับฐานข้อมูลเพลงพร้อมกับการค้นหา 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 โดยคุณ ต้องระบุ User-ID ของผู้ใช้ในคำกล่าวอ้าง `sub` อย่างน้อยFirebase Authentication (ซึ่งเป็นค่าเดียวกับค่าเซิร์ฟเวอร์ auth.uidที่คุณอ้างอิงได้ในการดำเนินการ GraphQL SQL Connect)

เมื่อคุณสวมบทบาทเป็นผู้ใช้ การดำเนินการจะสำเร็จก็ต่อเมื่อข้อมูลผู้ใช้ที่คุณระบุผ่านการตรวจสอบสิทธิ์ที่ระบุไว้ในคำจำกัดความ GraphQL

หากคุณเรียกใช้ SDK ที่สร้างขึ้นจากปลายทางที่เข้าถึงได้แบบสาธารณะ สิ่งสำคัญคือปลายทางต้องมีการตรวจสอบสิทธิ์ และคุณต้องตรวจสอบความสมบูรณ์ของโทเค็นการตรวจสอบสิทธิ์ก่อนที่จะใช้โทเค็นดังกล่าวเพื่อสวมบทบาทเป็นผู้ใช้

เมื่อใช้ 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's verifyIdToken เพื่อตรวจสอบและถอดรหัส โทเค็นการตรวจสอบสิทธิ์ ตัวอย่างเช่น สมมติว่าปลายทางของคุณมีการใช้งานเป็น ฟังก์ชัน HTTP ธรรมดา และคุณได้ส่งโทเค็นFirebase Authenticationไปยังปลายทางโดยใช้ส่วนหัวauthorizationตามมาตรฐาน

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 } }
    );

    // ...
});

คุณควรระบุ User-ID ที่ไม่ได้มาจากแหล่งที่มาที่ตรวจสอบได้ก็ต่อเมื่อดำเนินการด้านการดูแลระบบที่แท้จริง เช่น การย้ายข้อมูล จากสภาพแวดล้อมที่ปลอดภัยและเข้าถึงได้แบบสาธารณะ

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

การเรียกใช้ด้วยสิทธิ์เข้าถึงแบบไม่จำกัด

หากคุณกำลังดำเนินการที่ต้องใช้สิทธิ์ระดับผู้ดูแลระบบ ให้ละเว้นพารามิเตอร์การสวมบทบาทจากการเรียก

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

การดำเนินการที่เรียกในลักษณะนี้จะมีสิทธิ์เข้าถึงฐานข้อมูลแบบสมบูรณ์ หากคุณมีการค้นหาหรือการเปลี่ยนแปลงที่มีไว้เพื่อใช้เพื่อวัตถุประสงค์ด้านการดูแลระบบเท่านั้น คุณควรกำหนดการค้นหาหรือการเปลี่ยนแปลงเหล่านั้นด้วยคำสั่ง @auth(level: NO_ACCESS) การดำเนินการเช่นนี้จะช่วยให้มั่นใจได้ว่าเฉพาะผู้เรียกที่อยู่ในระดับผู้ดูแลระบบเท่านั้นที่จะเรียกใช้การดำเนินการเหล่านี้ได้

จัดการข้อมูลด้วยเมธอด executeGraphql

หากคุณต้องเรียกใช้การดำเนินการแบบครั้งเดียวซึ่งคุณไม่ได้กำหนดgql การเปลี่ยนแปลงหรือการค้นหาไว้ คุณสามารถใช้เมธอดexecuteGraphql หรือเมธอดแบบอ่านอย่างเดียว executeGraphqlRead

การสวมบทบาทเป็นผู้ใช้ที่ไม่ได้ตรวจสอบสิทธิ์

เมื่อเรียกใช้การดำเนินการสาธารณะด้วย Admin SDK คุณควรหลีกเลี่ยงการเรียกใช้การดำเนินการที่มีสิทธิ์ของผู้ดูแลระบบแบบเต็ม (ตามหลักการให้สิทธิ์ขั้นต่ำที่สุด) แต่คุณควรเรียกใช้การดำเนินการในฐานะผู้ใช้ที่สวมบทบาท (ดูส่วนถัดไป) หรือในฐานะผู้ใช้ที่ไม่ได้ตรวจสอบสิทธิ์ที่สวมบทบาท ผู้ใช้ที่ไม่ได้ตรวจสอบสิทธิ์จะเรียกใช้ได้เฉพาะการดำเนินการที่ทำเครื่องหมายเป็น PUBLIC

// Query to get posts, with authentication level PUBLIC
const queryGetPostsImpersonation = `
    query getPosts @auth(level: PUBLIC) {
        posts {
          description
        }
    }`;

// Attempt to access data as an unauthenticated user
const optionsUnauthenticated: GraphqlOptions<undefined> = {
    impersonate: {
        unauthenticated: true
    }
};

// executeGraphql with impersonated unauthenticated user scope
const gqlResponse = await dataConnect.executeGraphql<UserData, undefined>(queryGetPostsImpersonation, optionsUnauthenticated);

การสวมบทบาทเป็นผู้ใช้

นอกจากนี้ ยังมีกรณีการใช้งานที่คุณต้องการให้สคริปต์แก้ไขข้อมูลผู้ใช้โดยอิงตามข้อมูลเข้าสู่ระบบที่จำกัดในนามของผู้ใช้ที่เฉพาะเจาะจง แนวทางนี้เป็นไปตามหลักการให้สิทธิ์ขั้นต่ำที่สุด

หากต้องการใช้อินเทอร์เฟซนี้ ให้รวบรวมข้อมูลจากโทเค็นการตรวจสอบสิทธิ์ JWT ที่กำหนดเองที่ เป็นไปตามรูปแบบโทเค็นAuthentication ดูคู่มือโทเค็นที่กำหนดเองด้วย

// Get the current user's data
const queryGetUserImpersonation = `
    query getUser @auth(level: USER) {
        user(key: {uid_expr: "auth.uid"}) {
            id,
            name
        }
    }`;

// Impersonate a user with the specified auth claims
const optionsAuthenticated: GraphqlOptions<undefined> = {
    impersonate: {
        authClaims: {
            sub: 'QVBJcy5ndXJ1'
        }
    }
};

// executeGraphql with impersonated authenticated user scope
const gqlResponse = await dataConnect.executeGraphql<UserData, undefined>(queryGetUserImpersonation, optionsAuthenticated);

// gqlResponse -> { "data": { "user": { "id": "QVBJcy5ndXJ1", "name": "Fred" } } }

ใช้ข้อมูลเข้าสู่ระบบของผู้ดูแลระบบ

หากคุณกำลังดำเนินการที่ต้องใช้สิทธิ์ระดับผู้ดูแลระบบ ให้ละเว้นพารามิเตอร์การสวมบทบาทจากการเรียก

// User can be publicly accessible, or restricted to admins
const query = "query getProfile(id: AuthID) { user(id: $id) { id name } }";

interface UserData {
  user: {
    id: string;
    name: string;
  };
}

export interface UserVariables {
  id: string;
}

const options:GraphqlOptions<UserVariables> = { variables: { id: "QVBJcy5ndXJ1" } };

// executeGraphql
const gqlResponse = await dataConnect.executeGraphql<UserData, UserVariables>(query, options);

// executeGraphqlRead (similar to previous sample but only for read operations)
const gqlResponse = await dataConnect.executeGraphqlRead<UserData, UserVariables>(query, options);

// gqlResponse -> { "data": { "user": { "id": "QVBJcy5ndXJ1", "name": "Fred" } } }

การดำเนินการที่เรียกในลักษณะนี้จะมีสิทธิ์เข้าถึงฐานข้อมูลแบบสมบูรณ์ หากคุณมีการค้นหาหรือการเปลี่ยนแปลงที่มีไว้เพื่อใช้เพื่อวัตถุประสงค์ด้านการดูแลระบบเท่านั้น คุณควรกำหนดการค้นหาหรือการเปลี่ยนแปลงเหล่านั้นด้วยคำสั่ง @auth(level: NO_ACCESS) การดำเนินการเช่นนี้จะช่วยให้มั่นใจได้ว่าเฉพาะผู้เรียกที่อยู่ในระดับผู้ดูแลระบบเท่านั้นที่จะเรียกใช้การดำเนินการเหล่านี้ได้

ดำเนินการกับข้อมูลแบบเป็นกลุ่ม

Firebase ขอแนะนำให้คุณใช้ Admin SDK สำหรับการดำเนินการกับข้อมูลแบบเป็นกลุ่มใน ฐานข้อมูลการใช้งานจริง

SDK มีเมธอดต่อไปนี้สำหรับการทำงานกับข้อมูลแบบเป็นกลุ่ม แต่ละเมธอดจะสร้างและเรียกใช้การเปลี่ยนแปลง GraphQL จากอาร์กิวเมนต์ที่ระบุ


// Methods of the bulk operations API
// dc is a SQL Connect admin instance from getDataConnect

const resp = await dc.insert("movie" /*table name*/, data[0]);
const resp = await dc.insertMany("movie" /*table name*/, data);
const resp = await dc.upsert("movie" /*table name*/, data[0]);
const resp = await dc.upsertMany("movie" /*table name*/, data);

หมายเหตุเกี่ยวกับประสิทธิภาพสำหรับการดำเนินการแบบเป็นกลุ่ม

คำขอแต่ละรายการที่ส่งไปยังแบ็กเอนด์จะทำให้เกิดการรับส่งข้อมูลไปกลับ 1 ครั้งไปยัง Cloud SQL ดังนั้นยิ่งคุณจัดกลุ่มคำขอมากเท่าใด ปริมาณงานก็จะยิ่งสูงขึ้น

อย่างไรก็ตาม ขนาดกลุ่มยิ่งใหญ่ คำสั่ง SQL ที่สร้างขึ้นก็จะยิ่งยาวขึ้น เมื่อถึงขีดจำกัดความยาวของคำสั่ง SQL ของ PostgreSQL คุณจะพบข้อผิดพลาด

ในทางปฏิบัติ ให้ทดลองเพื่อหาขนาดกลุ่มที่เหมาะสมสำหรับภาระงานของคุณ

ขั้นตอนต่อไปคืออะไร