test(replicateAttributes): Add test for primary key

Author: michaelprichardson

test/functions/index.js

@@ -42,7 +42,7 @@ module.exports.replicateMasterToDetail = integrify({
 module.exports.replicateMasterDeleteWhenEmpty = integrify({
   rule: 'REPLICATE_ATTRIBUTES',
   source: {
-    collection: 'master',
+    collection: 'master/{primaryKey}',
   },
   targets: [
     {
@@ -65,6 +65,30 @@ module.exports.replicateMasterDeleteWhenEmpty = integrify({
   },
 });
 
+module.exports.replicateReferencesWithMissingKey = integrify({
+  rule: 'REPLICATE_ATTRIBUTES',
+  source: {
+    collection: 'master/{masterId}',
+  },
+  targets: [
+    {
+      collection: 'detail1',
+      foreignKey: 'randomId',
+      attributeMapping: {
+        masterDetail1: 'foreignDetail1',
+      },
+    },
+  ],
+  hooks: {
+    pre: (snap, context) => {
+      setState({
+        snap,
+        context,
+      });
+    },
+  },
+});
+
 module.exports.deleteReferencesToMaster = integrify({
   rule: 'DELETE_REFERENCES',
   source: {

test/functions/integrify.rules.js

@@ -31,7 +31,7 @@ module.exports = [
     rule: 'REPLICATE_ATTRIBUTES',
     name: 'replicateMasterDeleteWhenEmpty',
     source: {
-      collection: 'master',
+      collection: 'master/{primaryKey}',
     },
     targets: [
       {
@@ -45,6 +45,22 @@ module.exports = [
       },
     ],
   },
+  {
+    rule: 'REPLICATE_ATTRIBUTES',
+    name: 'replicateReferencesWithMissingKey',
+    source: {
+      collection: 'master/{masterId}',
+    },
+    targets: [
+      {
+        collection: 'detail1',
+        foreignKey: 'randomId',
+        attributeMapping: {
+          masterDetail1: 'foreignDetail1',
+        },
+      },
+    ],
+  },
   {
     rule: 'DELETE_REFERENCES',
     name: 'deleteReferencesToMaster',

test/unit.test.js

@@ -17,7 +17,7 @@ admin.initializeApp({
 const db = admin.firestore();
 
 async function clearFirestore() {
-  const collections = ['detail1', 'detail2', 'somecoll'];
+  const collections = ['detail1', 'detail2', 'detail3', 'somecoll'];
   for (const collection of collections) {
     const { docs } = await admin
       .firestore()
@@ -55,14 +55,19 @@ testsuites.forEach(testsuite => {
     testPrimaryKey(sut, t, name));
   test(`[${name}] test target collection parameter swap`, async t =>
     testTargetVariableSwap(sut, t, name));
+
+  // Standard functionality
   test(`[${name}] test replicate attributes`, async t =>
     testReplicateAttributes(sut, t, name));
   test(`[${name}] test delete references`, async t =>
     testDeleteReferences(sut, t, name));
   test(`[${name}] test maintain count`, async t => testMaintainCount(sut, t));
 
+  // Added by GitLive
   test(`[${name}] test replicate attributes delete when field is not there`, async t =>
     testReplicateAttributesDeleteEmpty(sut, t, name));
+  test(`[${name}] test replicate attributes with missing primary key in source reference`, async t =>
+    testReplicateMissingSourceCollectionKey(sut, t, name));
 
   test(`[${name}] test delete with masterId in target reference`, async t =>
     testDeleteParamReferences(sut, t, name));
@@ -75,7 +80,6 @@ testsuites.forEach(testsuite => {
 
   test(`[${name}] test delete all sub-collections in target reference`, async t =>
     testDeleteAllSubCollections(sut, t, name));
-
   test(`[${name}] test delete missing arguments error`, async t =>
     testDeleteMissingArgumentsError(sut, t, name));
 });
@@ -233,9 +237,9 @@ async function testReplicateAttributes(sut, t, name) {
 
 async function testReplicateAttributesDeleteEmpty(sut, t, name) {
   // Add a couple of detail documents to follow master
-  const masterId = makeid();
+  const primaryKey = makeid();
   await db.collection('detail1').add({
-    tempId: masterId,
+    tempId: primaryKey,
     foreignDetail1: 'foreign_detail_1',
     foreignDetail2: 'foreign_detail_2',
   });
@@ -246,13 +250,13 @@ async function testReplicateAttributesDeleteEmpty(sut, t, name) {
       masterDetail1: 'after1',
       masterDetail2: 'after2',
     },
-    `master/${masterId}`
+    `master/${primaryKey}`
   );
   const afterSnap = fft.firestore.makeDocumentSnapshot(
     {
       masterDetail2: 'after3',
     },
-    `master/${masterId}`
+    `master/${primaryKey}`
   );
   const change = fft.makeChange(beforeSnap, afterSnap);
   const wrapped = fft.wrap(sut.replicateMasterDeleteWhenEmpty);
@@ -262,7 +266,7 @@ async function testReplicateAttributesDeleteEmpty(sut, t, name) {
   });
   await wrapped(change, {
     params: {
-      masterId: masterId,
+      primaryKey: primaryKey,
     },
   });
 
@@ -271,28 +275,97 @@ async function testReplicateAttributesDeleteEmpty(sut, t, name) {
     const state = getState();
     t.truthy(state.change);
     t.truthy(state.context);
-    t.is(state.context.params.masterId, masterId);
+    t.is(state.context.params.primaryKey, primaryKey);
   }
 
   // Assert that attributes get replicated to detail documents
   await assertQuerySizeEventually(
     db
       .collection('detail1')
-      .where('tempId', '==', masterId)
+      .where('tempId', '==', primaryKey)
       .where('foreignDetail1', '==', 'foreign_detail_1'),
     0
   );
   await assertQuerySizeEventually(
     db
       .collection('detail1')
-      .where('tempId', '==', masterId)
+      .where('tempId', '==', primaryKey)
       .where('foreignDetail2', '==', 'after3'),
     1
   );
 
   await t.pass();
 }
 
+async function testReplicateMissingSourceCollectionKey(sut, t, name) {
+  // Create some docs referencing master doc
+  const randomId = makeid();
+  await db.collection('detail1').add({
+    tempId: randomId,
+    foreignDetail1: 'foreign_detail_1',
+    foreignDetail2: 'foreign_detail_2',
+  });
+
+  // Trigger function to delete references
+  const beforeSnap = fft.firestore.makeDocumentSnapshot(
+    {
+      masterDetail1: 'after1',
+      masterDetail2: 'after2',
+    },
+    `master/${randomId}`
+  );
+  const afterSnap = fft.firestore.makeDocumentSnapshot(
+    {
+      masterDetail2: 'after3',
+    },
+    `master/${randomId}`
+  );
+  const change = fft.makeChange(beforeSnap, afterSnap);
+  const wrapped = fft.wrap(sut.replicateReferencesWithMissingKey);
+  setState({
+    snap: null,
+    context: null,
+  });
+
+  const error = await t.throwsAsync(async () => {
+    await wrapped(change, {
+      params: {
+        randomId: randomId,
+      },
+    });
+  });
+
+  t.is(
+    error.message,
+    'integrify: Missing a primary key [masterId] in the source params'
+  );
+
+  // Assert pre-hook was called (only for rules-in-situ)
+  if (name === 'rules-in-situ') {
+    const state = getState();
+    t.is(state.snap, null);
+    t.is(state.context, null);
+  }
+
+  // Assert referencing docs were not deleted
+  await assertQuerySizeEventually(
+    db
+      .collection('detail1')
+      .where('tempId', '==', randomId)
+      .where('foreignDetail1', '==', 'foreign_detail_1'),
+    1
+  );
+  await assertQuerySizeEventually(
+    db
+      .collection('detail1')
+      .where('tempId', '==', randomId)
+      .where('foreignDetail2', '==', 'foreign_detail_2'),
+    1
+  );
+
+  t.pass();
+}
+
 async function testDeleteReferences(sut, t, name) {
   // Create some docs referencing master doc
   const masterId = makeid();