Merge remote-tracking branch 'origin/next' into patryk/cnt-docs

Author: Patryk Lesiewicz

auth-mailchimp-sync/POSTINSTALL.md

@@ -6,7 +6,7 @@ You can test out this extension right away:
 
 1.  Click **Add User** to add a test user.
 
-1.  In a few seconds, go to your Mailchimp audience page, you'll see the test user's email appear in the list.
+1.  In a few seconds, go to your Mailchimp audience page, you'll see the test user's email appear.
 
 ### Using the extension
 

auth-mailchimp-sync/PREINSTALL.md

@@ -6,16 +6,15 @@ This extension adds the email address of each new user to your specified Mailchi
 
 This extension uses Mailchimp, so you'll need to supply your Mailchimp API Key and Audience ID when installing this extension.
 
-### Additional setup
+#### Additional setup
 
 Make sure that you've set up [Firebase Authentication](https://firebase.google.com/docs/auth) to manage your users.
 
 You must also have a Mailchimp account before installing this extension.
 
-### Billing
+#### Billing
 
 This extension uses other Firebase or Google Cloud Platform services which may have associated charges:
-
 - Firebase Realtime Database
 - Cloud Functions
 

auth-mailchimp-sync/functions/lib/logs.js

@@ -21,10 +21,10 @@ exports.complete = () => {
     console.log("Completed execution of extension");
 };
 exports.errorAddUser = (err) => {
-    console.error("Error when adding user to Mailchimp list", err);
+    console.error("Error when adding user to Mailchimp audience", err);
 };
 exports.errorRemoveUser = (err) => {
-    console.error("Error when removing user from Mailchimp list", err);
+    console.error("Error when removing user from Mailchimp audience", err);
 };
 exports.init = () => {
     console.log("Initializing extension with configuration", obfuscatedConfig);

auth-mailchimp-sync/functions/src/logs.ts

@@ -26,11 +26,11 @@ export const complete = () => {
 };
 
 export const errorAddUser = (err: Error) => {
-  console.error("Error when adding user to Mailchimp list", err);
+  console.error("Error when adding user to Mailchimp audience", err);
 };
 
 export const errorRemoveUser = (err: Error) => {
-  console.error("Error when removing user from Mailchimp list", err);
+  console.error("Error when removing user from Mailchimp audience", err);
 };
 
 export const init = () => {

delete-user-data/PREINSTALL.md

@@ -6,16 +6,15 @@ You can configure this extension to delete user data from any or all of the foll
 
 This extension is useful in respecting user privacy and fulfilling compliance requirements. However, using this extension does not guarantee compliance with government and industry regulations.
 
-### Additional setup
+#### Additional setup
 
 Depending on where you'd like to delete user data from, make sure that you've set up [Cloud Firestore](https://firebase.google.com/docs/firestore), [Realtime Database](https://firebase.google.com/docs/database), or [Cloud Storage](https://firebase.google.com/docs/storage) in your Firebase project before installing this extension.
 
 Also, make sure that you've set up [Firebase Authentication](https://firebase.google.com/docs/auth) to manage your users.
 
-### Billing
+#### Billing
 
 This extension uses other Firebase or Google Cloud Platform services which may have associated charges:
-
 - Cloud Firestore
 - Firebase Realtime Database
 - Cloud Storage

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

@@ -109,9 +109,6 @@ const clearStorageData = (storagePaths, uid) => __awaiter(this, void 0, void 0,
     logs.storageDeleted();
 });
 const clearFirestoreData = (firestorePaths, uid) => __awaiter(this, void 0, void 0, function* () {
-    // admin.firestore().settings({
-    //   timestampsInSnapshots: true,
-    // });
     logs.firestoreDeleting();
     const paths = extractUserPaths(firestorePaths, uid);
     const promises = paths.map((path) => __awaiter(this, void 0, void 0, function* () {

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

@@ -112,9 +112,6 @@ const clearStorageData = async (storagePaths: string, uid: string) => {
 };
 
 const clearFirestoreData = async (firestorePaths: string, uid: string) => {
-  // admin.firestore().settings({
-  //   timestampsInSnapshots: true,
-  // });
   logs.firestoreDeleting();
 
   const paths = extractUserPaths(firestorePaths, uid);

firestore-bigquery-export/POSTINSTALL.md

@@ -13,13 +13,13 @@ You can test out this extension right away:
 1.  Query your **raw changelog table**, which should contain a single log of creating the `bigquery-mirror-test` document.
 
     ```  
-    SELECT * FROM `${param:PROJECT_ID}.${param:DATASET_ID}.${param:COLLECTION_PATH}_raw_changelog`   
+    SELECT * FROM `${param:PROJECT_ID}.${param:DATASET_ID}.${param:TABLE_ID}_raw_changelog`   
     ```
 
 1.  Query your **latest view**, which should return the latest change event for the only document present -- `bigquery-mirror-test`.
 
     ```  
-    SELECT * FROM `${param:PROJECT_ID}.${param:DATASET_ID}.${param:COLLECTION_PATH}_raw_latest`
+    SELECT * FROM `${param:PROJECT_ID}.${param:DATASET_ID}.${param:TABLE_ID}_raw_latest`
     ```
 
 1.  Delete the `bigquery-mirror-test` document from [Cloud Firestore](https://console.firebase.google.com/project/${param:PROJECT_ID}/database/firestore/data).  
@@ -28,7 +28,7 @@ The `bigquery-mirror-test` document will disappear from the **latest view** and
 1.  You can check the changelogs of a single document with this query:
 
     ```  
-    SELECT * FROM `${param:PROJECT_ID}.${param:DATASET_ID}.${param:COLLECTION_PATH}_raw_changelog` 
+    SELECT * FROM `${param:PROJECT_ID}.${param:DATASET_ID}.${param:TABLE_ID}_raw_changelog` 
        WHERE document_name = "bigquery-mirror-test" 
        ORDER BY TIMESTAMP ASC  
     ```
@@ -37,12 +37,12 @@ The `bigquery-mirror-test` document will disappear from the **latest view** and
 
 Whenever a document is created, updated, imported, or deleted in the specified collection, this extension sends that update to BigQuery. You can then run queries on this mirrored dataset which contains the following resources:
 
-+   **raw changelog table:** [`${param:DATASET_ID}_raw_changelog`](https://console.cloud.google.com/bigquery?project=${param:PROJECT_ID}&p=${param:PROJECT_ID}&d=${param:DATASET_ID}&t=${param:COLLECTION_PATH}_raw_changelog&page=table)
-+   **latest view:** [`${param:DATASET_ID}_raw_latest`](https://console.cloud.google.com/bigquery?project=${param:PROJECT_ID}&p=${param:PROJECT_ID}&d=${param:DATASET_ID}&t=${param:COLLECTION_PATH}_raw_latest&page=table)
++   **raw changelog table:** [`${param:TABLE_ID}_raw_changelog`](https://console.cloud.google.com/bigquery?project=${param:PROJECT_ID}&p=${param:PROJECT_ID}&d=${param:DATASET_ID}&t=${param:TABLE_ID}_raw_changelog&page=table)
++   **latest view:** [`${param:TABLE_ID}_raw_latest`](https://console.cloud.google.com/bigquery?project=${param:PROJECT_ID}&p=${param:PROJECT_ID}&d=${param:DATASET_ID}&t=${param:TABLE_ID}_raw_latest&page=table)
 
 To review the schema for these two resources, click the **Schema** tab for each resource in BigQuery.
 
-Note that this extension only listens for _document_ changes in the collection, but not changes in any _subcollection_. You can, though, install additional instances of this extension to specifically listen to a subcollection or other collections in your database.
+Note that this extension only listens for _document_ changes in the collection, but not changes in any _subcollection_. You can, though, install additional instances of this extension to specifically listen to a subcollection or other collections in your database. Or if you have the same subcollection across documents in a given collection, you can use `{wildcard}` notation to listen to all those subcollections (for example: `chats/{chatid}/posts`).
 
 ### _(Optional)_ Import existing documents
 

firestore-bigquery-export/PREINSTALL.md

@@ -1,33 +1,28 @@
 Use this extension to export the documents in a Cloud Firestore collection to BigQuery. Exports are realtime and incremental, so the data in BigQuery is a mirror of your content in Cloud Firestore.
 
 The extension creates and updates a [dataset](https://cloud.google.com/bigquery/docs/datasets-intro) containing the following two BigQuery resources:
-
 +   A [table](https://cloud.google.com/bigquery/docs/tables-intro) of raw data that stores a full change history of the documents within your collection. This table includes a number of metadata fields so that BigQuery can display the current state of your data. The principle metadata fields are `timestamp`, `document_name`, and the `operation` for the document change.
 +   A [view](https://cloud.google.com/bigquery/docs/views-intro) which represents the current state of the data within your collection. It also shows a log of the latest `operation` for each document (`CREATE`, `UPDATE`, or `IMPORT`).
 
 Whenever a document is created, updated, deleted, or imported in the specified collection, this extension sends that update to BigQuery. You can then run queries on this mirrored dataset.
 
-Note that this extension only listens for _document_ changes in the collection, but not changes in any _subcollection_. You can, though, install additional instances of this extension to specifically listen to a subcollection or other collections in your database.
+Note that this extension only listens for _document_ changes in the collection, but not changes in any _subcollection_. You can, though, install additional instances of this extension to specifically listen to a subcollection or other collections in your database. Or if you have the same subcollection across documents in a given collection, you can use `{wildcard}` notation to listen to all those subcollections (for example: `chats/{chatid}/posts`).
 
-### Additional setup
+#### Additional setup
 
 Before installing this extension, you'll need to:
-
 +   [Set up Cloud Firestore in your Firebase project.](https://firebase.google.com/docs/firestore/quickstart)
 +   [Link your Firebase project to BigQuery.](https://support.google.com/firebase/answer/6318765)
 
-#### Import existing documents
-
 This extension only sends the content of documents that have been changed -- it does not export your full dataset of existing documents into BigQuery. So, to backfill your BigQuery dataset with all the documents in your collection, you can run the import script provided by this extension.
 
 **Important:** Run the script over the entire collection _after_ installing this extension, otherwise all writes to your database during the import might be lost.
 
 Learn more about using this script to [backfill your existing collection](https://dev-partners.googlesource.com/samples/firebase/mods/+/master/firestore-bigquery-export/guides/IMPORT_EXISTING_DOCUMENTS.md).
 
-### Billing
+#### Billing
 
 This extension uses other Firebase or Google Cloud Platform services which may have associated charges:
-
 +   Cloud Firestore
 +   BigQuery
 +   Cloud Functions

firestore-bigquery-export/extension.yaml

@@ -85,9 +85,11 @@ params:
     type: string
     label: Collection path
     description: >-
-      What is the path of the collection that you would like to export?
-    default: extensions
-    example: extensions
+      What is the path of the collection that you would like to export? 
+      You may use `{wildcard}` notation to match a subcollection of all documents in a collection
+      (for example: `chatrooms/{chatid}/posts`).
+    default: posts
+    example: posts
     validationRegex: "^[^/]+(/[^/]+/[^/]+)*$"
     validationErrorMessage: Must be a valid Cloud Firestore collection
     required: true
@@ -98,10 +100,25 @@ params:
     description: >-
       What ID would you like to use for your BigQuery dataset? This
       extension will create the dataset, if it doesn't already exist.
-    validationRegex: ^[a-zA-Z0-9_]+$
+    validationRegex: "^[a-zA-Z0-9_]+$"
     validationErrorMessage: >
-      Dataset IDs must be alphanumeric (plus underscores) and must be no more than
+      BigQuery dataset IDs must be alphanumeric (plus underscores) and must be no more than
       1024 characters.
-    default: exported_collection
-    example: exported_collection
+    default: firestore_export
+    example: firestore_export
+    required: true
+
+  - param: TABLE_ID
+    type: string
+    label: Table ID
+    description: >-
+      What identifying prefix would you like to use for your table and view
+      inside your BigQuery dataset? This extension will create the table and view,
+      if they don't already exist.
+    validationRegex: "^[a-zA-Z0-9_]+$"
+    validationErrorMessage: >
+      BigQuery table IDs must be alphanumeric (plus underscores) and must be no more than
+      1024 characters.
+    default: posts
+    example: posts
     required: true