test(REPLICATE_ATTRIBUTES): Add test for REPLICATE_ATTRIBUTES

.gitignore

@@ -1,8 +1,6 @@
-node_modules
-lib
-test/service-account-key.json
-test/functions/integrify.js
 .nyc_output
-coverage
 .vscode
-firestore-debug.log
+*-debug.log
+coverage
+lib
+node_modules

src/rules/replicateAttributes.ts

@@ -68,6 +68,7 @@ export function integrifyReplicateAttributes(
 
       // Call "pre" hook if defined
       const promises = [];
+      // istanbul ignore else
       if (rule.hooks && rule.hooks.pre) {
         promises.push(rule.hooks.pre(change, context));
         console.log(`integrify: Running pre-hook: ${rule.hooks.pre}`);

test/functions/index.js

@@ -1,5 +1,4 @@
 const { integrify } = require('../../lib');
-const { setState } = require('./stateMachine');
 
 const functions = require('firebase-functions');
 const admin = require('firebase-admin');
@@ -34,8 +33,10 @@ module.exports.replicateMasterToDetail = integrify({
     },
   ],
   hooks: {
-    pre: (change, context) => {
-      setState({ change, context });
+    pre: async (change, context) => {
+      await db.collection('prehooks').add({
+        message: '[788a32e05504] REPLICATE_ATTRIBUTES prehook was called!',
+      });
     },
   },
 });
@@ -57,8 +58,10 @@ module.exports.deleteReferencesToMaster = integrify({
     },
   ],
   hooks: {
-    pre: (snap, context) => {
-      setState({ snap, context });
+    pre: async (snap, context) => {
+      await db.collection('prehooks').add({
+        message: '[6a8f4f8f090c] DELETE_REFERENCES prehook was called!',
+      });
     },
   },
 });

test/functions/integrify.rules.js

@@ -3,19 +3,19 @@ module.exports = [
     rule: 'REPLICATE_ATTRIBUTES',
     name: 'replicateMasterToDetailFromFile',
     source: {
-      collection: 'master',
+      collection: 'rules-file-master',
     },
     targets: [
       {
-        collection: 'detail1',
+        collection: 'rules-file-detail1',
         foreignKey: 'masterId',
         attributeMapping: {
           masterField1: 'detail1Field1',
           masterField2: 'detail1Field2',
         },
       },
       {
-        collection: 'detail2',
+        collection: 'rules-file-detail2',
         foreignKey: 'masterId',
         attributeMapping: {
           masterField1: 'detail2Field1',
@@ -29,15 +29,15 @@ module.exports = [
     rule: 'DELETE_REFERENCES',
     name: 'deleteReferencesToMasterFromFile',
     source: {
-      collection: 'master',
+      collection: 'rules-file-master',
     },
     targets: [
       {
-        collection: 'detail1',
+        collection: 'rules-file-detail1',
         foreignKey: 'masterId',
       },
       {
-        collection: 'detail2',
+        collection: 'rules-file-detail2',
         foreignKey: 'masterId',
         isCollectionGroup: true,
       },
@@ -47,11 +47,11 @@ module.exports = [
     rule: 'MAINTAIN_COUNT',
     name: 'maintainFavoritesCountFromFile',
     source: {
-      collection: 'favorites',
+      collection: 'rules-file-favorites',
       foreignKey: 'articleId',
     },
     target: {
-      collection: 'articles',
+      collection: 'rules-file-articles',
       attribute: 'favoritesCount',
     },
   },

test/main.test.js

@@ -2,23 +2,106 @@ const assert = require('chai').assert;
 
 const { integrify } = require('../lib');
 
+const admin = require('firebase-admin');
+admin.initializeApp();
+const db = admin.firestore();
+
 describe('Error conditions', () => {
-  it('should error on bad rule', function () {
+  it('should error on bad rule', () => {
     assert.throws(
       () => integrify({ rule: 'BAD_RULE_ea8e3a2a2d3e' }),
       /Unknown rule/i
     );
     assert.throws(() => require('./functions-bad-rules-file'), /Unknown rule/i);
   });
 
-  it('should error on no rule or config', function () {
+  it('should error on no rule or config', () => {
     assert.throws(() => integrify(42), /Input must be rule or config/i);
   });
 
-  it('should error on absent config file', function () {
+  it('should error on absent config file', () => {
     assert.throws(
       () => require('./functions-absent-rules-file'),
       /Rules file not found/i
     );
   });
 });
+
+describe('REPLICATE_ATTRIBUTES', () => {
+  it('should replicate attributes', async () => {
+    // Create master document to replicate from
+    const masterRef = await db
+      .collection('master')
+      .add({ random: Math.random() });
+    const masterId = masterRef.id;
+
+    // Create couple of detail docs to replicate to
+    await db.collection('detail1').add({ masterId });
+    await db.collection('detail2').add({ masterId });
+
+    // Update master doc
+    const masterField1 = randstr();
+    const masterField2 = randstr();
+    await masterRef.update({ masterField1, masterField2 });
+
+    // Ensure update is reflected in detail docs
+    await assertQuerySizeEventually(
+      db
+        .collection('detail1')
+        .where('masterId', '==', masterId)
+        .where('detail1Field1', '==', masterField1),
+      1
+    );
+    await assertQuerySizeEventually(
+      db
+        .collection('detail2')
+        .where('masterId', '==', masterId)
+        .where('detail2Field1', '==', masterField1),
+      1
+    );
+
+    // Make an irrelevant update
+    await masterRef.set({ someOtherField: randstr() });
+
+    // Ensure prehook is called twice (once for each update)
+    await assertQuerySizeEventually(
+      db
+        .collection('prehooks')
+        .where(
+          'message',
+          '==',
+          '[788a32e05504] REPLICATE_ATTRIBUTES prehook was called!'
+        ),
+      2
+    );
+  });
+});
+
+// Helper functions
+function randstr() {
+  return Math.random().toString(36).substr(2);
+}
+
+function sleep(ms) {
+  return new Promise((resolve) => setTimeout(resolve, ms));
+}
+
+async function assertQuerySizeEventually(
+  query,
+  expectedResultSize,
+  log = console.log
+) {
+  log(`Asserting query result to have [${expectedResultSize}] entries ... `);
+  await sleep(1000);
+  const docs = await new Promise((res) => {
+    unsubscribe = query.onSnapshot((snap) => {
+      log(`Current result size: [${snap.size}]`);
+      if (snap.size === expectedResultSize) {
+        log('Matched!');
+        unsubscribe();
+        res(snap.docs);
+      }
+    });
+  });
+  return docs;
+}

test/run-tests.sh

@@ -9,6 +9,8 @@ rm -rf ../.nyc_output ../coverage
 
 export GCLOUD_PROJECT=dummy-project
 export FIRESTORE_EMULATOR_HOST='localhost:8080'
-npx nyc -r html -r text -r lcov firebase emulators:exec \
-  'mocha --bail --exit --jobs 1 --timeout 30s *.test.js'
-
+: ${MOCHA_TIMEOUT:=30000}
+npx \
+  nyc -r html -r text -r lcov \
+  firebase emulators:exec --ui \
+  "mocha --bail --exit --jobs 1 --timeout $MOCHA_TIMEOUT *.test.js"