ran prettier fixes

Author: dackers86

extensions/export-user-data/README.md

@@ -31,45 +31,38 @@ To install an extension, your project must be on the Blaze (pay as you go) plan
 
 **Configuration Parameters:**
 
-* Cloud Functions location: Where do you want to deploy the functions created for this extension? For help selecting a location, refer to the [location selection guide](https://firebase.google.com/docs/functions/locations).
+- Cloud Functions location: Where do you want to deploy the functions created for this extension? For help selecting a location, refer to the [location selection guide](https://firebase.google.com/docs/functions/locations).
 
-* Cloud Storage bucket for exports: To which Cloud Storage bucket will you export your data? It is recommended to create a separate bucket for this extension. For more information, refer to the [pre-installation guide](https://firebase.google.com/products/extensions/storage-resize-images).
+- Cloud Storage bucket for exports: To which Cloud Storage bucket will you export your data? It is recommended to create a separate bucket for this extension. For more information, refer to the [pre-installation guide](https://firebase.google.com/products/extensions/storage-resize-images).
 
+- Folder for storing exported data: To which Cloud Storage folder will you upload exported data?
 
-* Folder for storing exported data: To which Cloud Storage folder will you upload exported data?
+- Firestore collection to record export metadata: What is the path to the collection that will contain the export tracking documents?
 
+- Cloud Firestore paths: Which paths in your Cloud Firestore instance contain data keyed by User ID? Leave empty if you don't use Cloud Firestore. Enter the full paths, separated by commas. You can represent the User ID of the user with `{UID}`. 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}`.
 
-* Firestore collection to record export metadata: What is the path to the collection that will contain the export tracking documents?
+- Realtime Database instance: From which Realtime Database instance do you want to export data keyed by User ID? If this parameter is not specified, this extension will use your default database instance.
 
+- Realtime Database location: (Only applicable if you provided the `Realtime Database instance` parameter.) From which Realtime Database location do you want to export data keyed by User ID?
 
-* Cloud Firestore paths: Which paths in your Cloud Firestore instance contain data keyed by User ID? Leave empty if you don't use Cloud Firestore. Enter the full paths, separated by commas. You can represent the User ID of the user with `{UID}`. 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}`.
+- Realtime Database paths: Which paths in your Realtime Database instance contain data keyed by User ID? Leave empty if you don't use Realtime Database. Enter the full paths, separated by commas. You can represent the User ID of the exported user with `{UID}`. For example: `users/{UID},admins/{UID}`.
 
-* Realtime Database instance: From which Realtime Database instance do you want to export data keyed by User ID? If this parameter is not specified, this extension will use your default database instance.
+- Cloud Storage paths: Where in Google Cloud Storage do you store data keyed by User ID? Leave empty if you don't use Cloud Storage. Enter the full paths to files or directories in your Storage buckets, separated by commas. Use `{UID}` to represent the User ID of the user whose data we're exporting, and use `{DEFAULT}` to represent your default Storage bucket. Here's a series of examples. To export all the files in your default bucket with the file naming scheme `{UID}-pic.png`, enter `{DEFAULT}/{UID}-pic.png`. To also export all the files in another bucket called my-app-logs with the file naming scheme `{UID}-logs.txt`, enter `{DEFAULT}/{UID}-pic.png,my-app-logs/{UID}-logs.txt`. To _also_ export a User ID-labeled directory and all its files (like `media/{UID}`), enter `{DEFAULT}/{UID}-pic.png,my-app-logs/{UID}-logs.txt,{DEFAULT}/media/{UID}`.
 
+- Custom hook endpoint: Specify a function URL to call that will return an object listing paths in services to export data from. See the pre-install documentation for more details.
 
-* Realtime Database location: (Only applicable if you provided the `Realtime Database instance` parameter.) From which Realtime Database location do you want to export data keyed by User ID?
-
-
-* Realtime Database paths: Which paths in your Realtime Database instance contain data keyed by User ID? Leave empty if you don't use Realtime Database. Enter the full paths, separated by commas. You can represent the User ID of the exported user with `{UID}`. For example: `users/{UID},admins/{UID}`.
-
-* Cloud Storage paths: Where in Google Cloud Storage do you store data keyed by User ID? Leave empty if you don't use Cloud Storage. Enter the full paths to files or directories in your Storage buckets, separated by commas. Use `{UID}` to represent the User ID of the user whose data we're exporting, and use `{DEFAULT}` to represent your default Storage bucket. Here's a series of examples. To export all the files in your default bucket with the file naming scheme `{UID}-pic.png`, enter `{DEFAULT}/{UID}-pic.png`. To also export all the files in another bucket called my-app-logs with the file naming scheme `{UID}-logs.txt`, enter `{DEFAULT}/{UID}-pic.png,my-app-logs/{UID}-logs.txt`. To *also* export a User ID-labeled directory and all its files (like `media/{UID}`), enter `{DEFAULT}/{UID}-pic.png,my-app-logs/{UID}-logs.txt,{DEFAULT}/media/{UID}`.
-
-* Custom hook endpoint: Specify a function URL to call that will return an object listing paths in services to export data from. See the pre-install documentation for more details.
-
-* Enable Zipping of Exports: If enabled, will compress all exports into one zip file in storage.
-
+- Enable Zipping of Exports: If enabled, will compress all exports into one zip file in storage.
 
 **Cloud Functions:**
 
-* **exportUserData:** Triggers an export and returns a unique export ID.
-
+- **exportUserData:** Triggers an export and returns a unique export ID.
 
 **Access Required**:
 
 This extension will operate with the following project IAM roles:
 
-* datastore.owner (Reason: Allows the extension to export (user) data from Cloud Firestore.)
+- datastore.owner (Reason: Allows the extension to export (user) data from Cloud Firestore.)
 
-* firebasedatabase.admin (Reason: Allows the extension to export (user) data from Realtime Database.)
+- firebasedatabase.admin (Reason: Allows the extension to export (user) data from Realtime Database.)
 
-* storage.admin (Reason: Allows the extension to export (user) data from Cloud Storage.)
+- storage.admin (Reason: Allows the extension to export (user) data from Cloud Storage.)

extensions/export-user-data/extension.yaml

@@ -2,7 +2,7 @@ name: export-user-data
 displayName: Export User Data
 
 description: >-
- Export certain data keyed on a user ID from Firestore, Realtime Database, or Cloud Storage to a Google Cloud Storage bucket.
+  Export certain data keyed on a user ID from Firestore, Realtime Database, or Cloud Storage to a Google Cloud Storage bucket.
 
 billingRequired: true
 
@@ -106,7 +106,7 @@ params:
     default: exports
     example: exports
     required: false
-    validationRegex: "^[^/]+(/[^/]+/[^/]+)*$"
+    validationRegex: '^[^/]+(/[^/]+/[^/]+)*$'
     validationErrorMessage: Must be a valid Cloud Firestore collection
 
   - param: FIRESTORE_PATHS
@@ -177,7 +177,7 @@ params:
       ID-labeled directory and all its files (like `media/{UID}`), enter
       `{DEFAULT}/{UID}-pic.png,my-app-logs/{UID}-logs.txt,{DEFAULT}/media/{UID}`.
     type: string
-    example: "{DEFAULT}/{UID}-pic.png,my-awesome-app-logs/{UID}-logs.txt"
+    example: '{DEFAULT}/{UID}-pic.png,my-awesome-app-logs/{UID}-logs.txt'
     required: false
 
   - param: CUSTOM_HOOK_ENDPOINT
@@ -201,7 +201,6 @@ params:
         value: no
     default: no
     required: false
-  
 
 events:
   - type: firebase.extensions.export-user-data.v1.firestore

extensions/export-user-data/functions/__tests__/custom_hook/badResponse.test.ts

@@ -14,61 +14,61 @@
  * limitations under the License.
  */
 
-import * as admin from "firebase-admin";
-import waitForExpect from "wait-for-expect";
-import { UserRecord } from "firebase-functions/v1/auth";
+import * as admin from 'firebase-admin';
+import waitForExpect from 'wait-for-expect';
+import { UserRecord } from 'firebase-functions/v1/auth';
 import {
   createFirebaseUser,
   resetFirebaseData,
   validateCompleteRecord,
   validateCSVFile,
   validatePendingRecord,
-} from "../helpers";
-import setupEnvironment from "../helpers/setupEnvironment";
-import config from "../../src/config";
-import { fetchFromCustomHook } from "../../src/utils";
+} from '../helpers';
+import setupEnvironment from '../helpers/setupEnvironment';
+import config from '../../src/config';
+import { fetchFromCustomHook } from '../../src/utils';
 
-const fft = require("firebase-functions-test")();
+const fft = require('firebase-functions-test')();
 
 if (!admin.apps.length) {
   admin.initializeApp();
 }
 
 setupEnvironment();
-jest.spyOn(admin, "initializeApp").mockImplementation();
+jest.spyOn(admin, 'initializeApp').mockImplementation();
 
-import * as funcs from "../../src/index";
+import * as funcs from '../../src/index';
 
 /** prepare extension functions */
 
 // const exportUserDatafn = fft.wrap(funcs.exportUserData);
 
-jest.mock("../../src/config", () => ({
+jest.mock('../../src/config', () => ({
   cloudStorageBucketDefault: process.env.STORAGE_BUCKET,
-  cloudStorageExportDirectory: "exports",
-  firestoreExportsCollection: "exports",
+  cloudStorageExportDirectory: 'exports',
+  firestoreExportsCollection: 'exports',
   customHookEndpoint: `http://localhost:1123`,
   zip: false,
 }));
 
-jest.mock("../../src/utils", () => {
-  const data = "asdas akksfd";
+jest.mock('../../src/utils', () => {
+  const data = 'asdas akksfd';
 
   const response = Promise.resolve({
     ok: true,
     status: 200,
     text: () => JSON.stringify(data),
   });
 
-  const original = jest.requireActual("../../src/utils"); // Step 2.
+  const original = jest.requireActual('../../src/utils'); // Step 2.
   return {
     ...original,
     fetchFromCustomHook: () => response,
   };
 });
 
-describe("extension", () => {
-  describe("custom hooks", () => {
+describe('extension', () => {
+  describe('custom hooks', () => {
     let user: UserRecord;
     let unsubscribe;
 
@@ -80,19 +80,19 @@ describe("extension", () => {
     afterEach(async () => {
       jest.clearAllMocks();
       await resetFirebaseData(user);
-      if (unsubscribe && typeof unsubscribe === "function") {
+      if (unsubscribe && typeof unsubscribe === 'function') {
         unsubscribe();
       }
     });
 
-    xtest("should skip on bad response from hook", async () => {
+    xtest('should skip on bad response from hook', async () => {
       /** Create a top level collection with a single document */
       const ref = await admin
         .firestore()
-        .collection("users")
+        .collection('users')
         .doc(user.uid)
-        .collection("comments")
-        .add({ content: "hello world" });
+        .collection('comments')
+        .add({ content: 'hello world' });
 
       /** Create a subcollection with a single document */
 
@@ -110,12 +110,12 @@ describe("extension", () => {
       const { exportId } = await exportUserDatafn.call(
         {},
         { uid: user.uid },
-        { auth: { uid: user.uid } }
+        { auth: { uid: user.uid } },
       );
 
       // // // expect exportId to be defined and to be a string
       expect(exportId).toBeDefined();
-      expect(typeof exportId).toBe("string");
+      expect(typeof exportId).toBe('string');
 
       // // // wait for the record to have been updated
       await waitForExpect(() => {
@@ -148,7 +148,7 @@ describe("extension", () => {
       const expectedFileName = `users_${user.uid}_comments.firestore.csv`;
       const expectedCSVData = [
         [
-          "FIRESTORE",
+          'FIRESTORE',
           `users/${user.uid}/comments/${commentId}`,
           // TODO: why so many quotation marks?
           '"{""content"":""hello world""}"',

extensions/export-user-data/functions/__tests__/custom_hook/databasePaths.test.ts

@@ -14,48 +14,48 @@
  * limitations under the License.
  */
 
-import * as admin from "firebase-admin";
-import waitForExpect from "wait-for-expect";
-import { UserRecord } from "firebase-functions/v1/auth";
+import * as admin from 'firebase-admin';
+import waitForExpect from 'wait-for-expect';
+import { UserRecord } from 'firebase-functions/v1/auth';
 import {
   createFirebaseUser,
   generateDatabaseNode,
   resetFirebaseData,
   validateCompleteRecord,
   validateCSVFile,
   validatePendingRecord,
-} from "../helpers";
-import setupEnvironment from "../helpers/setupEnvironment";
-import config from "../../src/config";
-import fetch from "node-fetch";
-import { fetchFromCustomHook } from "../../src/utils";
-import { Response, Headers } from "node-fetch";
+} from '../helpers';
+import setupEnvironment from '../helpers/setupEnvironment';
+import config from '../../src/config';
+import fetch from 'node-fetch';
+import { fetchFromCustomHook } from '../../src/utils';
+import { Response, Headers } from 'node-fetch';
 
-const fft = require("firebase-functions-test")();
+const fft = require('firebase-functions-test')();
 
 if (!admin.apps.length) {
   admin.initializeApp();
 }
 
 setupEnvironment();
-jest.spyOn(admin, "initializeApp").mockImplementation();
+jest.spyOn(admin, 'initializeApp').mockImplementation();
 
-import * as funcs from "../../src/index";
+import * as funcs from '../../src/index';
 
 /** prepare extension functions */
 
 // const exportUserDatafn = fft.wrap(funcs.exportUserData);
 
-jest.mock("../../src/config", () => ({
+jest.mock('../../src/config', () => ({
   cloudStorageBucketDefault: process.env.STORAGE_BUCKET,
-  cloudStorageExportDirectory: "exports",
-  firestoreExportsCollection: "exports",
+  cloudStorageExportDirectory: 'exports',
+  firestoreExportsCollection: 'exports',
   customHookEndpoint: `http://localhost:1123`,
   zip: false,
 }));
 
-jest.mock("../../src/utils", () => {
-  const data = { databasePaths: ["{UID}"] };
+jest.mock('../../src/utils', () => {
+  const data = { databasePaths: ['{UID}'] };
 
   const response = Promise.resolve({
     ok: true,
@@ -64,15 +64,15 @@ jest.mock("../../src/utils", () => {
     text: () => JSON.stringify(data),
   });
 
-  const original = jest.requireActual("../../src/utils"); // Step 2.
+  const original = jest.requireActual('../../src/utils'); // Step 2.
   return {
     ...original,
     fetchFromCustomHook: () => response,
   };
 });
 
-describe("extension", () => {
-  describe("custom hooks", () => {
+describe('extension', () => {
+  describe('custom hooks', () => {
     let user: UserRecord;
     let unsubscribe;
 
@@ -84,13 +84,13 @@ describe("extension", () => {
     afterEach(async () => {
       jest.clearAllMocks();
       await resetFirebaseData();
-      if (unsubscribe && typeof unsubscribe === "function") {
+      if (unsubscribe && typeof unsubscribe === 'function') {
         unsubscribe();
       }
     });
 
-    test("can subcollection a top level collection with an id of {userId} to a csv", async () => {
-      const ref = await generateDatabaseNode({ foo: "bar" }, user.uid);
+    test('can subcollection a top level collection with an id of {userId} to a csv', async () => {
+      const ref = await generateDatabaseNode({ foo: 'bar' }, user.uid);
       const exportUserDatafn = fft.wrap(funcs.exportUserData);
 
       // watch the exports collection for changes
@@ -104,11 +104,11 @@ describe("extension", () => {
       const { exportId } = await exportUserDatafn.call(
         {},
         { uid: user.uid },
-        { auth: { uid: user.uid } }
+        { auth: { uid: user.uid } },
       );
       // // expect exportId to be defined and to be a string
       expect(exportId).toBeDefined();
-      expect(typeof exportId).toBe("string");
+      expect(typeof exportId).toBe('string');
 
       // wait for the record to have been updated
       await waitForExpect(() => {
@@ -140,7 +140,7 @@ describe("extension", () => {
       const expectedFileName = `${user.uid}.database.csv`;
       const expectedCSVData = [
         [
-          "DATABASE",
+          'DATABASE',
           `${user.uid}/${ref.key}`,
           // TODO: why so many quotation marks?
           '"{""foo"":""bar""}"',