feat: firestore datasource

Author: sarike

server/node-service/src/plugins/firebase/queryConfig.ts

@@ -31,8 +31,10 @@ const firestoreDocIdParamConfig = {
 
 const firestoreParentDocIdParamConfig = {
   key: "parentDocumentId",
-  label: "Parent Document ID",
+  label: "Parent",
   type: "textInput",
+  tooltip:
+    "The parent document id of collections you want to list. Leave empty for top-level collections.",
 } as const;
 
 const firestoreDataParamConfig = {
@@ -86,14 +88,37 @@ const queryConfig = {
         {
           label: "Query Firestore",
           actionName: "FS.QueryFireStore",
-          params: [firestoreCollectionParamConfig],
+          params: [
+            firestoreCollectionParamConfig,
+            {
+              key: "orderBy",
+              label: "Order by",
+              type: "textInput",
+            },
+            {
+              key: "orderDirection",
+              label: "Order direction",
+              type: "textInput",
+              defaultValue: "asc",
+              placeholder: "asc",
+            },
+            {
+              key: "limit",
+              label: "Limit",
+              type: "numberInput",
+              defaultValue: 10,
+            },
+          ],
         },
         {
           label: "Insert Document",
           actionName: "FS.InsertDocument",
           params: [
             firestoreCollectionParamConfig,
-            firestoreDocIdParamConfig,
+            {
+              ...firestoreDocIdParamConfig,
+              tooltip: "Leaving empty will use auto generated document id.",
+            },
             firestoreDataParamConfig,
           ],
         },
@@ -121,11 +146,6 @@ const queryConfig = {
           actionName: "FS.GetCollections",
           params: [firestoreParentDocIdParamConfig],
         },
-        {
-          label: "Get Collection Group",
-          actionName: "FS.GetDocumentGroup",
-          params: [firestoreCollectionParamConfig],
-        } as const,
       ] as const
     ).map((i) => ({ ...i, category: [FirebaseCategory.Firestore] })),
   ],

server/node-service/src/plugins/firebase/run.test.ts

@@ -4,7 +4,7 @@ const privateKey = process.env["GOOGLE_PRIVATE_KEY"] || "";
 
 test("realtime database", async () => {
   const res = await runFirebasePlugin(
-    { actionName: "QueryDatabase", databaseRef: "/hello" },
+    { actionName: "RTDB.QueryDatabase", databaseRef: "/hello" },
     {
       databaseUrl: "https://sarike-a3de9-default-rtdb.asia-southeast1.firebasedatabase.app/",
       privateKey,

server/node-service/src/plugins/firebase/run.ts

@@ -1,6 +1,12 @@
 import { badRequest } from "../../common/error";
 import { initializeApp, deleteApp, cert } from "firebase-admin/app";
 import { getDatabase, Reference } from "firebase-admin/database";
+import {
+  CollectionReference,
+  DocumentReference,
+  getFirestore,
+  OrderByDirection,
+} from "firebase-admin/firestore";
 import { DataSourceDataType } from "./dataSourceConfig";
 import { ActionDataType } from "./queryConfig";
 
@@ -25,6 +31,24 @@ export async function runFirebasePlugin(
     return fn(ref);
   };
 
+  const withFirestoreCollection = <T>(fn: (ref: CollectionReference) => T): T => {
+    if (!("collection" in actionData)) {
+      throw badRequest("not a firestore action with collection:" + actionName);
+    }
+    const ref = getFirestore().collection(actionData.collection);
+    return fn(ref);
+  };
+
+  const withFirestoreDoc = <T>(fn: (ref: DocumentReference) => T): T => {
+    if (!("collection" in actionData) || !("documentId" in actionData)) {
+      throw badRequest("not a firestore action with collection and documentId:" + actionName);
+    }
+    const ref = getFirestore().collection(actionData.collection).doc(actionData.documentId);
+    return fn(ref);
+  };
+
+  const successResult = { success: true };
+
   try {
     // firebase
     if (actionName === "RTDB.QueryDatabase") {
@@ -33,15 +57,79 @@ export async function runFirebasePlugin(
     }
 
     if (actionName === "RTDB.SetData") {
-      return await witDbRef((ref) => ref.set(actionData.data));
+      await witDbRef((ref) => ref.set(actionData.data));
+      return successResult;
     }
 
     if (actionName === "RTDB.UpdateData") {
-      return await witDbRef((ref) => ref.update(actionData.data));
+      await witDbRef((ref) => ref.update(actionData.data));
+      return successResult;
     }
 
     if (actionName === "RTDB.AppendDataToList") {
-      return await witDbRef((ref) => ref.push(actionData.data));
+      await witDbRef((ref) => ref.push(actionData.data));
+      return successResult;
+    }
+
+    // firebase
+    if (actionName === "FS.GetCollections") {
+      let collections;
+      if (actionData.parentDocumentId) {
+        collections = await getFirestore().doc(actionData.parentDocumentId).listCollections();
+      } else {
+        collections = await getFirestore().listCollections();
+      }
+      return collections.map((i) => i.id);
+    }
+
+    if (actionName === "FS.QueryFireStore") {
+      const data = await withFirestoreCollection(async (ref) => {
+        let query;
+        if (actionData.orderBy) {
+          query = ref.orderBy(
+            actionData.orderBy,
+            (actionData.orderDirection || "asc") as OrderByDirection
+          );
+        }
+        if (actionData.limit > 0) {
+          query = (query || ref).limit(actionData.limit);
+        }
+        const snapshot = await (query || ref).get();
+        if (snapshot.empty) {
+          return [];
+        }
+        return snapshot.docs.map((i) => i.data());
+      });
+      return data;
+    }
+
+    if (actionName === "FS.GetDocument") {
+      return await withFirestoreDoc(async (ref) => (await ref.get()).data());
+    }
+
+    if (actionName === "FS.InsertDocument") {
+      return await withFirestoreCollection(async (ref) => {
+        if (actionData.documentId) {
+          await ref.doc(actionData.documentId).set(actionData.data);
+        } else {
+          await ref.add(actionData.data);
+        }
+        return successResult;
+      });
+    }
+
+    if (actionName === "FS.UpdateDocument") {
+      return await withFirestoreDoc(async (ref) => {
+        await ref.update(actionData.data);
+        return successResult;
+      });
+    }
+
+    if (actionName === "FS.DeleteDocument") {
+      return await withFirestoreDoc(async (ref) => {
+        await ref.delete();
+        return successResult;
+      });
     }
   } finally {
     deleteApp(app);