test(deleteReferences): Add more test coverage

michaelprichardson · michaelprichardson · commit 17423985b642 · 2020-07-13T11:49:54.000+01:00
diff --git a/test/functions/index.js b/test/functions/index.js
@@ -73,7 +73,7 @@ module.exports.deleteReferencesWithMasterParam = integrify({
       foreignKey: 'masterId',
     },
     {
-      collection: 'somecoll/{masterId}/detail2',
+      collection: 'somecoll/$masterId/detail2',
       foreignKey: 'masterId',
     },
   ],
@@ -98,7 +98,32 @@ module.exports.deleteReferencesWithSnapshotFields = integrify({
       foreignKey: 'masterId',
     },
     {
-      collection: 'somecoll/{testId}/detail2',
+      collection: 'somecoll/$testId/detail2',
+      foreignKey: 'masterId',
+    },
+  ],
+  hooks: {
+    pre: (snap, context) => {
+      setState({
+        snap,
+        context,
+      });
+    },
+  },
+});
+
+module.exports.deleteReferencesWithMissingFields = integrify({
+  rule: 'DELETE_REFERENCES',
+  source: {
+    collection: 'master',
+  },
+  targets: [
+    {
+      collection: 'detail1',
+      foreignKey: 'masterId',
+    },
+    {
+      collection: 'somecoll/$testId/detail2',
       foreignKey: 'masterId',
     },
   ],
diff --git a/test/functions/integrify.rules.js b/test/functions/integrify.rules.js
@@ -57,7 +57,7 @@ module.exports = [
         foreignKey: 'masterId',
       },
       {
-        collection: 'somecoll/{masterId}/detail2',
+        collection: 'somecoll/$masterId/detail2',
         foreignKey: 'masterId',
       },
     ],
@@ -74,7 +74,24 @@ module.exports = [
         foreignKey: 'masterId',
       },
       {
-        collection: 'somecoll/{testId}/detail2',
+        collection: 'somecoll/$testId/detail2',
+        foreignKey: 'masterId',
+      },
+    ],
+  },
+  {
+    rule: 'DELETE_REFERENCES',
+    name: 'deleteReferencesWithMissingFields',
+    source: {
+      collection: 'master',
+    },
+    targets: [
+      {
+        collection: 'detail1',
+        foreignKey: 'masterId',
+      },
+      {
+        collection: 'somecoll/$testId/detail2',
         foreignKey: 'masterId',
       },
     ],
diff --git a/test/unit.test.js b/test/unit.test.js
@@ -1,10 +1,13 @@
 const { credentials, makeid, sleep } = require('./util');
 const fft = require('firebase-functions-test')(
-  { projectId: credentials.projectId },
+  {
+    projectId: credentials.projectId,
+  },
   credentials.serviceAccountKeyFile
 );
 const test = require('ava');
 const { integrify } = require('../lib');
+const { replaceReferenceWithFields } = require('../lib/common');
 const { getState, setState } = require('./functions/stateMachine');
 
 const admin = require('firebase-admin');
@@ -48,6 +51,8 @@ testsuites.forEach(testsuite => {
     t.true(sut.replicateMasterToDetail.name === 'cloudFunction');
     t.truthy(sut.replicateMasterToDetail.run);
   });
+  test(`[${name}] test basic variable swap`, async t =>
+    testVariableSwap(sut, t, name));
   test(`[${name}] test simple replicate attributes`, async t =>
     testReplicateAttributes(sut, t, name));
   test(`[${name}] test simple delete references`, async t =>
@@ -60,30 +65,93 @@ testsuites.forEach(testsuite => {
   test(`[${name}] test delete with snapshot fields in target reference`, async t =>
     testDeleteSnapshotFieldReferences(sut, t, name));
   test(`[${name}] test delete with missing snapshot fields in target reference`, async t =>
-    testDeleteMissingSnapshotFieldReferences(sut, t, name));
+    testDeleteMissingFieldsReferences(sut, t, name));
 });
 
+async function testVariableSwap(sut, t, name) {
+  // test no fields
+  let collectionId = makeid();
+  let targetCollection = 'collection';
+  let doc = {
+    collectionId,
+  };
+
+  let result = replaceReferenceWithFields(doc, targetCollection);
+
+  t.false(result.hasFields);
+  t.is(result.targetCollection, 'collection');
+
+  // Test one field
+  targetCollection = 'collection/$collectionId/some_detail';
+
+  result = replaceReferenceWithFields(doc, targetCollection);
+
+  t.true(result.hasFields);
+  t.is(result.targetCollection, `collection/${collectionId}/some_detail`);
+
+  // Test multiple fields
+  const testId = makeid();
+  const userId = makeid();
+  targetCollection = 'collection/$testId/some_detail/$userId';
+  doc = {
+    collectionId,
+    testId,
+    userId,
+  };
+
+  result = replaceReferenceWithFields(doc, targetCollection);
+
+  t.true(result.hasFields);
+  t.is(result.targetCollection, `collection/${testId}/some_detail/${userId}`);
+
+  // Test missing field
+  targetCollection = 'collection/$collectionId/some_detail';
+
+  const error = t.throws(() => {
+    replaceReferenceWithFields({}, targetCollection);
+  });
+  t.is(error.message, 'integrify: Missing dynamic reference: [$collectionId]');
+
+  await t.pass();
+}
+
 async function testReplicateAttributes(sut, t, name) {
   // Add a couple of detail documents to follow master
   const masterId = makeid();
-  await db.collection('detail1').add({ masterId: masterId });
+  await db.collection('detail1').add({
+    masterId: masterId,
+  });
   const nestedDocRef = db.collection('somecoll').doc('somedoc');
-  await nestedDocRef.set({ x: 1 });
-  await nestedDocRef.collection('detail2').add({ masterId: masterId });
+  await nestedDocRef.set({
+    x: 1,
+  });
+  await nestedDocRef.collection('detail2').add({
+    masterId: masterId,
+  });
 
   // Call trigger to replicate attributes from master
   const beforeSnap = fft.firestore.makeDocumentSnapshot(
     {},
     `master/${masterId}`
   );
   const afterSnap = fft.firestore.makeDocumentSnapshot(
-    { masterField1: 'after1', masterField3: 'after3' },
+    {
+      masterField1: 'after1',
+      masterField3: 'after3',
+    },
     `master/${masterId}`
   );
   const change = fft.makeChange(beforeSnap, afterSnap);
   const wrapped = fft.wrap(sut.replicateMasterToDetail);
-  setState({ change: null, context: null });
-  await wrapped(change, { params: { masterId: masterId } });
+  setState({
+    change: null,
+    context: null,
+  });
+  await wrapped(change, {
+    params: {
+      masterId: masterId,
+    },
+  });
 
   // Assert pre-hook was called (only for rules-in-situ)
   if (name === 'rules-in-situ') {
@@ -111,22 +179,34 @@ async function testReplicateAttributes(sut, t, name) {
 
   // Assert irrelevant update is safely ignored
   const irrelevantAfterSnap = fft.firestore.makeDocumentSnapshot(
-    { masterFieldIrrelevant: 'whatever' },
+    {
+      masterFieldIrrelevant: 'whatever',
+    },
     `master/${masterId}`
   );
   const irreleventChange = fft.makeChange(beforeSnap, irrelevantAfterSnap);
-  await wrapped(irreleventChange, { params: { masterId: masterId } });
+  await wrapped(irreleventChange, {
+    params: {
+      masterId: masterId,
+    },
+  });
 
   await t.pass();
 }
 
 async function testDeleteReferences(sut, t, name) {
   // Create some docs referencing master doc
   const masterId = makeid();
-  await db.collection('detail1').add({ masterId: masterId });
+  await db.collection('detail1').add({
+    masterId: masterId,
+  });
   const nestedDocRef = db.collection('somecoll').doc('somedoc');
-  await nestedDocRef.set({ x: 1 });
-  await nestedDocRef.collection('detail2').add({ masterId: masterId });
+  await nestedDocRef.set({
+    x: 1,
+  });
+  await nestedDocRef.collection('detail2').add({
+    masterId: masterId,
+  });
   await assertQuerySizeEventually(
     db
       .collection('somecoll')
@@ -139,8 +219,15 @@ async function testDeleteReferences(sut, t, name) {
   // Trigger function to delete references
   const snap = fft.firestore.makeDocumentSnapshot({}, `master/${masterId}`);
   const wrapped = fft.wrap(sut.deleteReferencesToMaster);
-  setState({ snap: null, context: null });
-  await wrapped(snap, { params: { masterId: masterId } });
+  setState({
+    snap: null,
+    context: null,
+  });
+  await wrapped(snap, {
+    params: {
+      masterId: masterId,
+    },
+  });
 
   // Assert pre-hook was called (only for rules-in-situ)
   if (name === 'rules-in-situ') {
@@ -265,6 +352,7 @@ async function testDeleteSnapshotFieldReferences(sut, t, name) {
   await wrapped(snap, {
     params: {
       masterId: masterId,
+      testId: testId,
     },
   });
 
@@ -293,7 +381,7 @@ async function testDeleteSnapshotFieldReferences(sut, t, name) {
   t.pass();
 }
 
-async function testDeleteMissingSnapshotFieldReferences(sut, t, name) {
+async function testDeleteMissingFieldsReferences(sut, t, name) {
   // Create some docs referencing master doc
   const masterId = makeid();
   const testId = makeid();
@@ -318,17 +406,22 @@ async function testDeleteMissingSnapshotFieldReferences(sut, t, name) {
 
   // Trigger function to delete references
   const snap = fft.firestore.makeDocumentSnapshot({}, `master/${masterId}`);
-  const wrapped = fft.wrap(sut.deleteReferencesWithSnapshotFields);
+  const wrapped = fft.wrap(sut.deleteReferencesWithMissingFields);
   setState({
     snap: null,
     context: null,
   });
-  await wrapped(snap, {
-    params: {
-      masterId: masterId,
-    },
+
+  const error = await t.throwsAsync(async () => {
+    await wrapped(snap, {
+      params: {
+        masterId: masterId,
+      },
+    });
   });
 
+  t.is(error.message, 'Error: integrify: Missing dynamic reference: [$testId]');
+
   // Assert pre-hook was called (only for rules-in-situ)
   if (name === 'rules-in-situ') {
     const state = getState();
@@ -360,15 +453,19 @@ async function testMaintainCount(sut, t) {
   await db
     .collection('articles')
     .doc(articleId)
-    .set({ favoritesCount: 0 });
+    .set({
+      favoritesCount: 0,
+    });
 
   // Favorite the article a few times
   const NUM_TIMES_TO_FAVORITE = 5;
   const wrappedUpdater = fft.wrap(sut.maintainFavoritesCount);
   const promises = [];
   const emptySnap = fft.firestore.makeDocumentSnapshot({});
   const snap = fft.firestore.makeDocumentSnapshot(
-    { articleId: articleId },
+    {
+      articleId: articleId,
+    },
     `favorites/${makeid()}`
   );
   for (let i = 1; i <= NUM_TIMES_TO_FAVORITE; ++i) {
@@ -413,10 +510,18 @@ async function testMaintainCount(sut, t) {
 }
 
 test('test error conditions', async t => {
-  t.throws(() => integrify({}), { message: /Input must be rule or config/i });
-  t.throws(() => integrify({ rule: 'UNKNOWN_RULE_4a4e261a2e37' }), {
-    message: /Unknown rule/i,
+  t.throws(() => integrify({}), {
+    message: /Input must be rule or config/i,
   });
+  t.throws(
+    () =>
+      integrify({
+        rule: 'UNKNOWN_RULE_4a4e261a2e37',
+      }),
+    {
+      message: /Unknown rule/i,
+    }
+  );
   t.throws(() => require('./functions-bad-rules-file'), {
     message: /Unknown rule/i,
   });
