[delete-user-data] Add new param for enabling recursive delete (#25)

Author: Ehesp

delete-user-data/extension.yaml

@@ -15,7 +15,7 @@
 name: delete-user-data
 displayName: Delete User Data
 specVersion: v1beta
-version: 0.1.1
+version: 0.2.0
 
 description:
   Deletes data keyed on a userId from Cloud Firestore, Realtime
@@ -36,9 +36,12 @@ contributors:
   - authorName: Chris Bianca
     email: chris@csfrequency.com
     url: https://github.com/chrisbianca
+  - authorName: Elliot Hesp
+    email: elliot@invertase.io
+    url: https://github.com/ehesp
 
 roles:
-  - role: datastore.user
+  - role: datastore.owner
     reason: Allows the extension to delete (user) data from Cloud Firestore.
   - role: firebasedatabase.admin
     reason: Allows the extension to delete (user) data from Realtime Database.
@@ -99,6 +102,20 @@ params:
       For example, if you have the collections `users` and `admins`, and each collection
       has documents with User ID as document IDs, then you can enter `users/{UID},admins/{UID}`.
 
+  - param: FIRESTORE_DELETE_MODE
+    type: select
+    label: Cloud Firestore delete mode
+    description: >-
+      How do you want to delete Cloud Firestore documents? To also delete documents in
+      subcollections, set this parameter to `recursive`.
+    options:
+      - label: Recursive
+        value: recursive
+      - label: Shallow
+        value: shallow
+    default: shallow
+    required: true
+
   - param: RTDB_PATHS
     type: string
     label: Realtime Database paths

delete-user-data/functions/lib/config.js

@@ -16,8 +16,9 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = {
-    firestorePaths: process.env.FIRESTORE_PATHS,
     location: process.env.LOCATION,
+    firestorePaths: process.env.FIRESTORE_PATHS,
+    firestoreDeleteMode: process.env.FIRESTORE_DELETE_MODE,
     rtdbPaths: process.env.RTDB_PATHS,
     storagePaths: process.env.STORAGE_PATHS,
 };

delete-user-data/functions/lib/index.js

@@ -25,6 +25,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 const admin = require("firebase-admin");
 const functions = require("firebase-functions");
+const firebase_tools = require("firebase-tools");
 const config_1 = require("./config");
 const logs = require("./logs");
 // Initialize the Firebase Admin SDK
@@ -113,12 +114,24 @@ const clearFirestoreData = (firestorePaths, uid) => __awaiter(this, void 0, void
     const paths = extractUserPaths(firestorePaths, uid);
     const promises = paths.map((path) => __awaiter(this, void 0, void 0, function* () {
         try {
-            logs.firestorePathDeleting(path);
-            yield admin
-                .firestore()
-                .doc(path)
-                .delete();
-            logs.firestorePathDeleted(path);
+            const isRecursive = config_1.default.firestoreDeleteMode === 'recursive';
+            if (!isRecursive) {
+                logs.firestorePathDeleting(path, false);
+                yield admin
+                    .firestore()
+                    .doc(path)
+                    .delete();
+                logs.firestorePathDeleted(path, false);
+            }
+            else {
+                logs.firestorePathDeleting(path, true);
+                yield firebase_tools.firestore.delete(path, {
+                    project: process.env.PROJECT_ID,
+                    recursive: true,
+                    yes: true,
+                });
+                logs.firestorePathDeleted(path, true);
+            }
         }
         catch (err) {
             logs.firestorePathError(path, err);

delete-user-data/functions/lib/logs.js

@@ -28,11 +28,11 @@ exports.firestoreDeleting = () => {
 exports.firestoreNotConfigured = () => {
     console.log("Cloud Firestore paths are not configured, skipping");
 };
-exports.firestorePathDeleted = (path) => {
-    console.log(`Deleted: '${path}' from Cloud Firestore`);
+exports.firestorePathDeleted = (path, recursive) => {
+    console.log(`Deleted: '${path}' from Cloud Firestore ${recursive ? 'with recursive delete' : ''}`);
 };
-exports.firestorePathDeleting = (path) => {
-    console.log(`Deleting: '${path}' from Cloud Firestore`);
+exports.firestorePathDeleting = (path, recursive) => {
+    console.log(`Deleting: '${path}' from Cloud Firestore ${recursive ? 'with recursive delete' : ''}`);
 };
 exports.firestorePathError = (path, err) => {
     console.error(`Error when deleting: '${path}' from Cloud Firestore`, err);

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

@@ -15,8 +15,9 @@
  */
 
 export default {
-  firestorePaths: process.env.FIRESTORE_PATHS,
   location: process.env.LOCATION,
+  firestorePaths: process.env.FIRESTORE_PATHS,
+  firestoreDeleteMode: process.env.FIRESTORE_DELETE_MODE,
   rtdbPaths: process.env.RTDB_PATHS,
   storagePaths: process.env.STORAGE_PATHS,
 };

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

@@ -16,6 +16,7 @@
 
 import * as admin from "firebase-admin";
 import * as functions from "firebase-functions";
+import * as firebase_tools from "firebase-tools";
 
 import config from "./config";
 import * as logs from "./logs";
@@ -117,12 +118,24 @@ const clearFirestoreData = async (firestorePaths: string, uid: string) => {
   const paths = extractUserPaths(firestorePaths, uid);
   const promises = paths.map(async (path) => {
     try {
-      logs.firestorePathDeleting(path);
-      await admin
-        .firestore()
-        .doc(path)
-        .delete();
-      logs.firestorePathDeleted(path);
+      const isRecursive = config.firestoreDeleteMode === 'recursive';
+
+      if (!isRecursive) {
+        logs.firestorePathDeleting(path, false);
+        await admin
+          .firestore()
+          .doc(path)
+          .delete();
+        logs.firestorePathDeleted(path, false);
+      } else {
+        logs.firestorePathDeleting(path, true);
+        await firebase_tools.firestore.delete(path, {
+          project: process.env.PROJECT_ID,
+          recursive: true,
+          yes: true, // auto-confirmation
+        });
+        logs.firestorePathDeleted(path, true);
+      }
     } catch (err) {
       logs.firestorePathError(path, err);
     }

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

@@ -32,12 +32,12 @@ export const firestoreNotConfigured = () => {
   console.log("Cloud Firestore paths are not configured, skipping");
 };
 
-export const firestorePathDeleted = (path: string) => {
-  console.log(`Deleted: '${path}' from Cloud Firestore`);
+export const firestorePathDeleted = (path: string, recursive: boolean) => {
+  console.log(`Deleted: '${path}' from Cloud Firestore ${recursive ? 'with recursive delete' : ''}`);
 };
 
-export const firestorePathDeleting = (path: string) => {
-  console.log(`Deleting: '${path}' from Cloud Firestore`);
+export const firestorePathDeleting = (path: string, recursive: boolean) => {
+  console.log(`Deleting: '${path}' from Cloud Firestore ${recursive ? 'with recursive delete' : ''}`);
 };
 
 export const firestorePathError = (path: string, err: Error) => {