chore(*): Setup Travis configuration (#87)

Author: Salakar

.prettierignore

@@ -1,11 +1,15 @@
 package.json
 extension.yaml
-webpack.config.js
+package-lock.json
+
 **/node_modules/**
 
 # generated files
 README.md
-POSTINSTALL.md
-PREINSTALL.md
 **/functions/lib/**
 **/dist/**
+
+# extension install md files
+#   - excluded as prettier escapes variables e.g. `${PROJECT_ID}` becomes `\${PROJECT_ID}`
+POSTINSTALL.md
+PREINSTALL.md

.prettierrc.yaml

@@ -15,6 +15,6 @@
 trailingComma: es5
 arrowParens: always
 overrides:
-  - files: "*.yaml"
+  - files: "*.{yml,yaml}"
     options:
       proseWrap: always

.travis.yml

@@ -0,0 +1,21 @@
+language: node_js
+
+node_js:
+  - 8
+  - 10
+  - 12
+
+stages:
+  - validate
+  - test
+
+jobs:
+  include:
+    - stage: validate
+      name: "TypeScript Compile"
+      script: npm run clean && npm run build
+    - stage: validate
+      name: "Prettier Format Check"
+      script: npm run lint
+    - stage: test
+      script: npm run test-coverage

auth-mailchimp-sync/jest.config.js

@@ -6,7 +6,5 @@ module.exports = {
   rootDir: "./",
   preset: "ts-jest",
   globalSetup: "./jest.setup.js",
-  globalTeardown: "./jest.teardown.js"
+  globalTeardown: "./jest.teardown.js",
 };
-
-

auth-mailchimp-sync/tsconfig.json

@@ -3,7 +3,5 @@
   "compilerOptions": {
     "outDir": "functions/lib"
   },
-  "include": [
-    "functions/src"
-  ]
+  "include": ["functions/src"]
 }

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

@@ -118,17 +118,17 @@ const clearFirestoreData = async (firestorePaths: string, uid: string) => {
   const paths = extractUserPaths(firestorePaths, uid);
   const promises = paths.map(async (path) => {
     try {
-      const isRecursive = config.firestoreDeleteMode === 'recursive';
+      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 => {
+        await firestore.runTransaction((transaction) => {
           transaction.delete(firestore.doc(path));
           return Promise.resolve();
-        }));
+        });
         logs.firestorePathDeleted(path, false);
       } else {
         logs.firestorePathDeleting(path, true);

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

@@ -33,11 +33,19 @@ export const firestoreNotConfigured = () => {
 };
 
 export const firestorePathDeleted = (path: string, recursive: boolean) => {
-  console.log(`Deleted: '${path}' from Cloud Firestore ${recursive ? 'with recursive delete' : ''}`);
+  console.log(
+    `Deleted: '${path}' from Cloud Firestore ${
+      recursive ? "with recursive delete" : ""
+    }`
+  );
 };
 
 export const firestorePathDeleting = (path: string, recursive: boolean) => {
-  console.log(`Deleting: '${path}' from Cloud Firestore ${recursive ? 'with recursive delete' : ''}`);
+  console.log(
+    `Deleting: '${path}' from Cloud Firestore ${
+      recursive ? "with recursive delete" : ""
+    }`
+  );
 };
 
 export const firestorePathError = (path: string, err: Error) => {
@@ -69,7 +77,10 @@ export const rtdbPathDeleting = (path: string) => {
 };
 
 export const rtdbPathError = (path: string, err: Error) => {
-  console.error(`Error when deleting: '${path}' from the Realtime Database`, err);
+  console.error(
+    `Error when deleting: '${path}' from the Realtime Database`,
+    err
+  );
 };
 
 export const start = () => {

delete-user-data/jest.config.js

@@ -1,8 +1,8 @@
-const packageJson = require('./package.json');
+const packageJson = require("./package.json");
 
 module.exports = {
   name: packageJson.name,
   displayName: packageJson.name,
-  rootDir: './',
-  preset: 'ts-jest',
+  rootDir: "./",
+  preset: "ts-jest",
 };

delete-user-data/tsconfig.json

@@ -3,7 +3,5 @@
   "compilerOptions": {
     "outDir": "functions/lib"
   },
-  "include": [
-    "functions/src"
-  ]
+  "include": ["functions/src"]
 }

firestore-bigquery-export/firestore-bigquery-change-tracker/src/bigquery/index.ts

@@ -15,12 +15,14 @@
  */
 
 import * as bigquery from "@google-cloud/bigquery";
-import {
-  firestoreToBQTable,
-} from "./schema";
+import { firestoreToBQTable } from "./schema";
 import { latestConsistentSnapshotView } from "./snapshot";
 
-import { ChangeType, FirestoreEventHistoryTracker, FirestoreDocumentChangeEvent } from "../tracker";
+import {
+  ChangeType,
+  FirestoreEventHistoryTracker,
+  FirestoreDocumentChangeEvent,
+} from "../tracker";
 import * as logs from "../logs";
 import { BigQuery } from "@google-cloud/bigquery";
 
@@ -38,7 +40,8 @@ export interface FirestoreBigQueryEventHistoryTrackerConfig {
  * - View: Latest view {@link FirestoreBigQueryEventHistoryTracker#rawLatestView}.
  * If any subsequent data export fails, it will attempt to reinitialize.
  */
-export class FirestoreBigQueryEventHistoryTracker implements FirestoreEventHistoryTracker {
+export class FirestoreBigQueryEventHistoryTracker
+  implements FirestoreEventHistoryTracker {
   bq: bigquery.BigQuery;
   initialized: boolean = false;
 
@@ -49,7 +52,7 @@ export class FirestoreBigQueryEventHistoryTracker implements FirestoreEventHisto
   async record(events: FirestoreDocumentChangeEvent[]) {
     await this.initialize();
 
-    const rows = events.map(event => {
+    const rows = events.map((event) => {
       // This must match firestoreToBQTable().
       return {
         timestamp: event.timestamp,
@@ -132,7 +135,7 @@ export class FirestoreBigQueryEventHistoryTracker implements FirestoreEventHisto
       logs.bigQueryTableCreated(changelogName);
     }
     return table;
-  };
+  }
 
   /**
    * Creates the latest snapshot view, which returns only latest operations
@@ -146,7 +149,10 @@ export class FirestoreBigQueryEventHistoryTracker implements FirestoreEventHisto
     if (viewExists) {
       logs.bigQueryViewAlreadyExists(view.id, dataset.id);
     } else {
-      const latestSnapshot = latestConsistentSnapshotView(this.config.datasetId, this.rawChangeLogTableName());
+      const latestSnapshot = latestConsistentSnapshotView(
+        this.config.datasetId,
+        this.rawChangeLogTableName()
+      );
       logs.bigQueryViewCreating(this.rawLatestView(), latestSnapshot.query);
       const options = {
         friendlyName: this.rawLatestView(),
@@ -166,4 +172,3 @@ export class FirestoreBigQueryEventHistoryTracker implements FirestoreEventHisto
     return `${this.config.tableId}_raw_latest`;
   }
 }
-

firestore-bigquery-export/firestore-bigquery-change-tracker/src/bigquery/schema.ts

@@ -47,10 +47,18 @@ const bigQueryField = (
 
 // These field types form the basis of the `raw` data table
 export const dataField = bigQueryField("data", "STRING", "NULLABLE");
-export const documentNameField = bigQueryField("document_name", "STRING", "REQUIRED");
+export const documentNameField = bigQueryField(
+  "document_name",
+  "STRING",
+  "REQUIRED"
+);
 export const eventIdField = bigQueryField("event_id", "STRING", "REQUIRED");
 export const operationField = bigQueryField("operation", "STRING", "REQUIRED");
-export const timestampField = bigQueryField("timestamp", "TIMESTAMP", "REQUIRED");
+export const timestampField = bigQueryField(
+  "timestamp",
+  "TIMESTAMP",
+  "REQUIRED"
+);
 
 // These field types are used for the Firestore GeoPoint data type
 export const latitudeField = bigQueryField("latitude", "NUMERIC");
@@ -74,5 +82,5 @@ export const firestoreToBQTable = (): BigQueryField[] => [
   eventIdField,
   documentNameField,
   operationField,
-  dataField
+  dataField,
 ];

firestore-bigquery-export/firestore-bigquery-change-tracker/src/bigquery/snapshot.ts

@@ -17,31 +17,30 @@
 import * as sqlFormatter from "sql-formatter";
 
 import * as logs from "../logs";
-import {
-  firestoreToBQTable,
-  timestampField,
-} from "./schema";
+import { firestoreToBQTable, timestampField } from "./schema";
 
-const excludeFields: string[] = [
-  "document_name",
-];
+const excludeFields: string[] = ["document_name"];
 
 export const latestConsistentSnapshotView = (
   datasetId: string,
-  tableName: string,
+  tableName: string
 ) => ({
-  query: buildLatestSnapshotViewQuery(datasetId, tableName, timestampField.name,
+  query: buildLatestSnapshotViewQuery(
+    datasetId,
+    tableName,
+    timestampField.name,
     firestoreToBQTable()
-      .map(field => field.name)
-      .filter(name => excludeFields.indexOf(name) == -1)),
+      .map((field) => field.name)
+      .filter((name) => excludeFields.indexOf(name) == -1)
+  ),
   useLegacySql: false,
 });
 
 export function buildLatestSnapshotViewQuery(
   datasetId: string,
   tableName: string,
   timestampColumnName: string,
-  groupByColumns: string[],
+  groupByColumns: string[]
 ): string {
   if (datasetId === "" || tableName === "" || timestampColumnName === "") {
     throw Error(`Missing some query parameters!`);
@@ -58,23 +57,29 @@ export function buildLatestSnapshotViewQuery(
     --   event_id: The id of the event that triggered the cloud function mirrored the event.
     --   data: A raw JSON payload of the current state of the document.
     SELECT
-      document_name${groupByColumns.length > 0 ? `,`: ``}
+      document_name${groupByColumns.length > 0 ? `,` : ``}
       ${groupByColumns.join(",")}
      FROM (
       SELECT
         document_name,
-        ${groupByColumns.map(columnName =>
-          `FIRST_VALUE(${columnName})
+        ${groupByColumns
+          .map(
+            (columnName) =>
+              `FIRST_VALUE(${columnName})
             OVER(PARTITION BY document_name ORDER BY ${timestampColumnName} DESC)
-            AS ${columnName}`).join(',')}${groupByColumns.length > 0 ? `,`: ``}
+            AS ${columnName}`
+          )
+          .join(",")}${groupByColumns.length > 0 ? `,` : ``}
         FIRST_VALUE(operation)
           OVER(PARTITION BY document_name ORDER BY ${timestampColumnName} DESC) = "DELETE"
           AS is_deleted
       FROM \`${process.env.PROJECT_ID}.${datasetId}.${tableName}\`
       ORDER BY document_name, ${timestampColumnName} DESC
      )
      WHERE NOT is_deleted
-     GROUP BY document_name${groupByColumns.length > 0 ? `, `: ``}${groupByColumns.join(",")}`
+     GROUP BY document_name${
+       groupByColumns.length > 0 ? `, ` : ``
+     }${groupByColumns.join(",")}`
   );
   return query;
 }

firestore-bigquery-export/firestore-bigquery-change-tracker/src/logs.ts

@@ -34,20 +34,25 @@ export const bigQueryDatasetExists = (datasetId: string) => {
 
 export const bigQueryErrorRecordingDocumentChange = (e: Error) => {
   console.error(`Error recording document changes.`, e);
-}
+};
 
 export const bigQueryLatestSnapshotViewQueryCreated = (query: string) => {
   console.log(`BigQuery latest snapshot view query:\n${query}`);
-}
+};
 
 export const bigQuerySchemaViewCreated = (name: string) => {
   console.log(`BigQuery created schema view ${name}\n`);
-}
+};
 
-export const bigQueryTableAlreadyExists = (tableName: string, datasetName: string) => {
-  console.log(`BigQuery table with name ${tableName} already ` +
-    `exists in dataset ${datasetName}!`);
-}
+export const bigQueryTableAlreadyExists = (
+  tableName: string,
+  datasetName: string
+) => {
+  console.log(
+    `BigQuery table with name ${tableName} already ` +
+      `exists in dataset ${datasetName}!`
+  );
+};
 
 export const bigQueryTableCreated = (tableName: string) => {
   console.log(`Created BigQuery table: ${tableName}`);
@@ -93,8 +98,13 @@ export const bigQueryViewCreating = (viewName: string, query: string) => {
   console.log(`Creating BigQuery view: ${viewName}\nQuery:\n${query}`);
 };
 
-export const bigQueryViewAlreadyExists = (viewName: string, datasetName: string) => {
-  console.log(`View with id ${viewName} already exists in dataset ${datasetName}.`);
+export const bigQueryViewAlreadyExists = (
+  viewName: string,
+  datasetName: string
+) => {
+  console.log(
+    `View with id ${viewName} already exists in dataset ${datasetName}.`
+  );
 };
 
 export const bigQueryViewUpdated = (viewName: string) => {