feat(delete-user-data): add non-default firestore instance support

Author: cabljac

delete-user-data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## Version 0.2.0
+
+feat - add support for multiple Firestore databases via FIRESTORE_DATABASE_ID parameter
+
 ## Version 0.1.24
 
 feat - move to Node.js 20 runtimes

delete-user-data/PREINSTALL.md

@@ -14,6 +14,8 @@ Depending on where you'd like to delete user data from, make sure that you've se
 
 Also, make sure that you've set up [Firebase Authentication](https://firebase.google.com/docs/auth) to manage your users.
 
+**Note about multiple Firestore databases:** This extension supports using non-default Firestore databases. During installation, you can specify which database to use via the `FIRESTORE_DATABASE_ID` parameter. Use "(default)" for the default database, or specify your named database ID.
+
 #### Billing
 To install an extension, your project must be on the [Blaze (pay as you go) plan](https://firebase.google.com/pricing)
 

delete-user-data/README.md

@@ -22,6 +22,8 @@ Depending on where you'd like to delete user data from, make sure that you've se
 
 Also, make sure that you've set up [Firebase Authentication](https://firebase.google.com/docs/auth) to manage your users.
 
+**Note about multiple Firestore databases:** This extension supports using non-default Firestore databases. During installation, you can specify which database to use via the `FIRESTORE_DATABASE_ID` parameter. Use "(default)" for the default database, or specify your named database ID.
+
 #### Billing
 To install an extension, your project must be on the [Blaze (pay as you go) plan](https://firebase.google.com/pricing)
 
@@ -37,6 +39,8 @@ To install an extension, your project must be on the [Blaze (pay as you go) plan
 
 **Configuration Parameters:**
 
+* Firestore Database ID: The ID of the Firestore database to use. Use "(default)" for the default database. You can view your available Firestore databases at https://console.cloud.google.com/firestore/databases.
+
 * Cloud Firestore paths: Which paths in your Cloud Firestore instance contain data keyed on a user ID? Leave empty if you don't use Cloud Firestore.
 Enter the full paths, separated by commas. Use `{UID}` as a placeholder for the user's UID.
 For example, if you have the collections `users` and `admins`, and each collection has documents with User ID as document IDs, then enter `users/{UID},admins/{UID}`.

delete-user-data/extension.yaml

@@ -13,7 +13,7 @@
 # limitations under the License.
 
 name: delete-user-data
-version: 0.1.24
+version: 0.2.0
 specVersion: v1beta
 
 displayName: Delete User Data
@@ -86,6 +86,16 @@ resources:
         resource: projects/${PROJECT_ID}/topics/ext-${EXT_INSTANCE_ID}-deletion
 
 params:
+  - param: FIRESTORE_DATABASE_ID
+    label: Firestore Database ID
+    description: >-
+      The ID of the Firestore database to use. Use "(default)" for the default
+      database. You can view your available Firestore databases at
+      https://console.cloud.google.com/firestore/databases.
+    type: string
+    default: (default)
+    required: true
+
   - param: FIRESTORE_PATHS
     label: Cloud Firestore paths
     description: >-

delete-user-data/functions/__tests__/recursiveDelete.test.ts

@@ -20,7 +20,7 @@ describe("recursiveDelete", () => {
       foo: "bar",
     });
 
-    await recursiveDelete(ref);
+    await recursiveDelete(ref, db);
 
     const doc = db.doc(ref);
     await doc.get().then((doc) => {
@@ -34,7 +34,7 @@ describe("recursiveDelete", () => {
       foo: "bar",
     });
 
-    await recursiveDelete(ref);
+    await recursiveDelete(ref, db);
 
     const collection = db.collection(ref);
     await collection.get().then((collection) => {
@@ -49,7 +49,7 @@ describe("recursiveDelete", () => {
       foo: "bar",
     });
 
-    await recursiveDelete(parentRef);
+    await recursiveDelete(parentRef, db);
 
     const collection = db.collection(ref);
     await collection.get().then((collection) => {

delete-user-data/functions/__tests__/search.test.ts

@@ -44,7 +44,7 @@ describe("discovery", () => {
 
   describe("searches on top level collections", () => {
     test("can delete is single collection named {uid}", async () => {
-      await search(user.uid, 1);
+      await search(user.uid, 1, db);
 
       await waitForCollectionDeletion(rootCollection, 20_000);
     }, 60000);
@@ -53,7 +53,7 @@ describe("discovery", () => {
   describe("searches on top level collection documents", () => {
     test("can delete a document named {uid}", async () => {
       const document = await db.collection(generateRandomId()).doc(user.uid);
-      await search(user.uid, 1);
+      await search(user.uid, 1, db);
 
       await waitForDocumentDeletion(document);
     }, 60000);
@@ -62,14 +62,14 @@ describe("discovery", () => {
       const document = await db
         .collection(generateRandomId())
         .add({ field1: user.uid });
-      await search(user.uid, 1);
+      await search(user.uid, 1, db);
 
       await waitForDocumentDeletion(document, 60000);
     }, 60000);
 
     test("can check a document without any field values", async () => {
       await db.collection(generateRandomId()).add({});
-      await search(user.uid, 1);
+      await search(user.uid, 1, db);
 
       expect(true).toBeTruthy();
     }, 60000);
@@ -93,7 +93,7 @@ describe("discovery", () => {
 
       expect(checkExists).toBe(true);
 
-      await search(user.uid, 1);
+      await search(user.uid, 1, db);
 
       await waitForCollectionDeletion(subcollection);
     }, 60000);
@@ -118,7 +118,7 @@ describe("discovery", () => {
 
       expect(collectionPathCount).toBeGreaterThan(config.searchDepth);
 
-      await search(user.uid, 1);
+      await search(user.uid, 1, db);
 
       // /** Wait 10 seconds for the discovery to complete */
       await new Promise((resolve) => setTimeout(resolve, 20000));
@@ -149,7 +149,7 @@ describe("discovery", () => {
 
       expect(collectionPathCount).toBeGreaterThan(config.searchDepth);
 
-      await search(user.uid, 1);
+      await search(user.uid, 1, db);
 
       // /** Wait 10 seconds for the discovery to complete */
       await new Promise((resolve) => setTimeout(resolve, 20000));
@@ -169,7 +169,7 @@ describe("discovery", () => {
       const collection = await db.collection(generateRandomId());
       const document = await collection.add({ testing: "should-not-delete" });
 
-      await search(collection.id, -1, document);
+      await search(collection.id, -1, db, document);
 
       /** Check document still exists */
       const checkExists = await document.get().then((doc) => doc.exists);
@@ -180,7 +180,7 @@ describe("discovery", () => {
       const document = await db
         .collection(generateRandomId())
         .add({ field1: "unknown" });
-      await search(user.uid, 1);
+      await search(user.uid, 1, db);
 
       /** Wait 10 seconds */
       await new Promise((resolve) => setTimeout(resolve, 10000));

delete-user-data/functions/src/config.ts

@@ -16,6 +16,7 @@
 
 export default {
   location: process.env.LOCATION,
+  databaseId: process.env.FIRESTORE_DATABASE_ID || "(default)",
   firestorePaths: process.env.FIRESTORE_PATHS,
   firestoreDeleteMode: process.env.FIRESTORE_DELETE_MODE,
   rtdbPaths: process.env.RTDB_PATHS,

delete-user-data/functions/src/index.ts

@@ -15,7 +15,11 @@
  */
 
 import * as admin from "firebase-admin";
-import { FieldPath, DocumentReference } from "firebase-admin/firestore";
+import {
+  FieldPath,
+  DocumentReference,
+  getFirestore,
+} from "firebase-admin/firestore";
 import * as functions from "firebase-functions";
 import { getDatabaseUrl, hasValidUserPath } from "./helpers";
 import chunk from "lodash.chunk";
@@ -40,7 +44,8 @@ admin.initializeApp({
   databaseURL,
 });
 
-const db = admin.firestore();
+// Initialize Firestore with the configured database
+const db = getFirestore(config.databaseId);
 
 /** Setup EventArc Channels */
 const eventChannel =
@@ -82,7 +87,7 @@ export const handleDeletion = functions.pubsub
           continue;
         }
         if (config.firestoreDeleteMode === "recursive") {
-          await recursiveDelete(path);
+          await recursiveDelete(path, db);
         } else {
           batch.delete(docRef);
         }
@@ -127,7 +132,7 @@ export const handleSearch = functions.pubsub
     if (depth <= config.searchDepth) {
       // If the collection ID is the same as the UID, delete the entire collection and sub-collections
       if (collection.id === uid) {
-        await recursiveDelete(path);
+        await recursiveDelete(path, db);
 
         if (eventChannel) {
           /** Publish event to EventArc */
@@ -151,7 +156,7 @@ export const handleSearch = functions.pubsub
         documentReferences.map(async (reference) => {
           // Start a sub-collection search on each document.
           if (nextDepth <= config.searchDepth) {
-            await search(uid, nextDepth, reference);
+            await search(uid, nextDepth, db, reference);
           }
 
           // If the ID of the document is the same as the UID, add it to delete list.
@@ -223,7 +228,7 @@ export const clearData = functions.auth.user().onDelete(async (user) => {
 
   /** If search mode enable, run pubsub search fn */
   if (enableSearch) {
-    await search(uid, 1);
+    await search(uid, 1, db);
   }
 
   /** If search function provided, return a list of queries */
@@ -316,19 +321,18 @@ const clearFirestoreData = async (firestorePaths: string, uid: string) => {
       const isRecursive = config.firestoreDeleteMode === "recursive";
 
       if (!isRecursive) {
-        const firestore = admin.firestore();
         logs.firestorePathDeleting(path, false);
 
         // Wrapping in transaction to allow for automatic retries (#48)
-        await firestore.runTransaction((transaction) => {
-          transaction.delete(firestore.doc(path));
+        await db.runTransaction((transaction) => {
+          transaction.delete(db.doc(path));
           return Promise.resolve();
         });
         logs.firestorePathDeleted(path, false);
       } else {
         logs.firestorePathDeleting(path, true);
 
-        await recursiveDelete(path);
+        await recursiveDelete(path, db);
 
         logs.firestorePathDeleted(path, true);
       }

delete-user-data/functions/src/recursiveDelete.ts

@@ -2,8 +2,10 @@ import * as admin from "firebase-admin";
 
 const MAX_RETRY_ATTEMPTS = 3;
 
-export const recursiveDelete = async (path: string) => {
-  const db = admin.firestore();
+export const recursiveDelete = async (
+  path: string,
+  db: admin.firestore.Firestore
+) => {
   // Recursively delete a reference and log the references of failures.
   const bulkWriter = db.bulkWriter();
 

delete-user-data/functions/src/search.ts

@@ -5,10 +5,9 @@ const { PubSub } = require("@google-cloud/pubsub");
 export const search = async (
   uid: string,
   depth: number,
+  db: admin.firestore.Firestore,
   document?: admin.firestore.DocumentReference<admin.firestore.DocumentData>
 ) => {
-  const db = admin.firestore();
-
   const pubsub = new PubSub();
 
   const topic = pubsub.topic(