feat(#653): add --merge-primary-contacts flag for merge-contacts action

src/fn/delete-contacts.js

@@ -56,7 +56,7 @@ ${bold('OPTIONS')}
   A comma delimited list of ids of contacts to be deleted.
 
 --disable-users
-  When flag is present, users at any deleted place will be permanently disabled.
+  When flag is present, users at any deleted place will be updated and may be permanently disabled. Supported by CHT Core 4.7 and above.
 
 --docDirectoryPath=<path to stage docs>
   Specifies the folder used to store the documents representing the changes in hierarchy.

src/fn/merge-contacts.js

@@ -15,6 +15,7 @@ module.exports = {
     const options = {
       disableUsers: args.disableUsers,
       docDirectoryPath: args.docDirectoryPath,
+      mergePrimaryContacts: args.mergePrimaryContacts,
       force: args.force,
     };
     return HierarchyOperations(db, options).merge(args.sourceIds, args.destinationId);
@@ -44,6 +45,7 @@ const parseExtraArgs = (projectDir, extraArgs = []) => {
     sourceIds,
     disableUsers: !!args['disable-users'],
     docDirectoryPath: path.resolve(projectDir, args.docDirectoryPath || 'json_docs'),
+    mergePrimaryContacts: !!args['merge-primary-contacts'],
     force: !!args.force,
   };
 };
@@ -68,6 +70,9 @@ ${bold('OPTIONS')}
 --disable-users
   When flag is present, users at any deleted place will be updated and may be permanently disabled. Supported by CHT Core 4.7 and above.
 
+--merge-primary-contacts
+  When flag is present, the primary contacts for all the top-level places will also be merged into a single resulting contact.
+
 --docDirectoryPath=<path to stage docs>
   Specifies the folder used to store the documents representing the changes in hierarchy.
 `);

src/lib/hierarchy-operations/delete-hierarchy.js

@@ -22,16 +22,15 @@ async function deleteHierarchy(db, options, sourceIds) {
     }
 
     const affectedContactCount = descendantsAndSelf.length;
-
-    info(`Staged updates to delete ${prettyPrintDocument(sourceDoc)}. ${affectedContactCount.length} contact(s) and ${affectedReportCount} report(s).`);
+    info(`Staged updates to delete ${prettyPrintDocument(sourceDoc)}. ${affectedContactCount} contact(s) and ${affectedReportCount} report(s).`);
   }
 }
 
 async function deleteReportsForContact(db, options, contact) {
   let skip = 0;
   let reportBatch;
   do {
-    reportBatch = await DataSource.getReportsForContacts(db, [], contact._id, skip);
+    reportBatch = await DataSource.getReportsForContacts(db, [], [contact._id], skip);
 
     for (const report of reportBatch) {
       JsDocs.deleteDoc(options, report);

src/lib/hierarchy-operations/hierarchy-data-source.js

@@ -2,6 +2,7 @@ const lineageManipulation = require('./lineage-manipulation');
 
 const HIERARCHY_ROOT = 'root';
 const BATCH_SIZE = 10000;
+const SUBJECT_IDS = ['patient_id', 'patient_uuid', 'place_id', 'place_uuid'];
 
 /*
 Fetches all of the documents associated with the "contactIds" and confirms they exist.
@@ -54,14 +55,10 @@ async function getContactWithDescendants(db, contactId) {
     .filter(doc => doc && doc.type !== 'tombstone');
 }
 
-async function getReportsForContacts(db, createdByIds, createdAtId, skip) {
+async function getReportsForContacts(db, createdByIds, createdAtIds, skip) {
   const createdByKeys = createdByIds.map(id => [`contact:${id}`]);
-  const createdAtKeys = createdAtId ? [
-    [`patient_id:${createdAtId}`],
-    [`patient_uuid:${createdAtId}`],
-    [`place_id:${createdAtId}`],
-    [`place_uuid:${createdAtId}`]
-  ] : [];
+  const mapIdToSubjectKeys = id => SUBJECT_IDS.map(subjectId => [`${subjectId}:${id}`]);
+  const createdAtKeys = createdAtIds ? createdAtIds.map(mapIdToSubjectKeys).flat() : [];
 
   const reports = await db.query('medic-client/reports_by_freetext', {
     keys: [
@@ -95,6 +92,7 @@ async function getAncestorsOf(db, contactDoc) {
 module.exports = {
   BATCH_SIZE,
   HIERARCHY_ROOT,
+  SUBJECT_IDS,
   getAncestorsOf,
   getContactWithDescendants,
   getContact,

src/lib/hierarchy-operations/index.js

@@ -19,24 +19,24 @@ async function moveHierarchy(db, options, sourceIds, destinationId) {
   for (const sourceId of sourceIds) {
     const sourceDoc = sourceDocs[sourceId];
     const descendantsAndSelf = await DataSource.getContactWithDescendants(db, sourceId);
+
     const moveContext = {
       sourceId,
       destinationId,
       descendantsAndSelf,
       replacementLineage,
       merge: !!options.merge,
+      disableUsers: !!options.disableUsers,
+      mergePrimaryContacts: !!options.mergePrimaryContacts,
+      sourcePrimaryContactId: getPrimaryContactId(sourceDoc),
+      destinationPrimaryContactId: getPrimaryContactId(destinationDoc),
     };
 
     await constraints.assertNoPrimaryContactViolations(sourceDoc, destinationDoc, descendantsAndSelf);
 
-    if (options.merge) {
-      const toDeleteUsers = options.disableUsers && constraints.isPlace(sourceDoc);
-      JsDocs.deleteDoc(options, sourceDoc, toDeleteUsers);
-    }
-
     const prettyPrintDocument = doc => `'${doc.name}' (${doc._id})`;
-    trace(`Considering lineage updates to ${descendantsAndSelf.length} descendant(s) of contact ${prettyPrintDocument(sourceDoc)}.`);
-    const updatedDescendants = replaceLineageInContacts(moveContext);
+    trace(`Considering updates to ${descendantsAndSelf.length} descendant(s) of contact ${prettyPrintDocument(sourceDoc)}.`);
+    const updatedDescendants = updateContacts(moveContext, constraints);
 
     const ancestors = await DataSource.getAncestorsOf(db, sourceDoc);
     trace(`Considering primary contact updates to ${ancestors.length} ancestor(s) of contact ${prettyPrintDocument(sourceDoc)}.`);
@@ -56,15 +56,19 @@ async function moveHierarchy(db, options, sourceIds, destinationId) {
   info(`Staged changes to lineage information for ${affectedContactCount} contact(s) and ${affectedReportCount} report(s).`);
 }
 
+function getPrimaryContactId(doc) {
+  return typeof doc?.contact === 'string' ? doc.contact : doc?.contact?._id;
+}
+
 async function updateReports(db, options, moveContext) {
   const descendantIds = moveContext.descendantsAndSelf.map(contact => contact._id);
 
   let skip = 0;
   let reportDocsBatch;
   do {
     info(`Processing ${skip} to ${skip + DataSource.BATCH_SIZE} report docs`);
-    const createdAtId = options.merge && moveContext.sourceId;
-    reportDocsBatch = await DataSource.getReportsForContacts(db, descendantIds, createdAtId, skip);
+    const createdAtIds = getReportsCreatedAtIds(moveContext);
+    reportDocsBatch = await DataSource.getReportsForContacts(db, descendantIds, createdAtIds, skip);
 
     const lineageUpdates = replaceLineageOfReportCreator(reportDocsBatch, moveContext);
     const reassignUpdates = reassignReports(reportDocsBatch, moveContext);
@@ -78,24 +82,47 @@ async function updateReports(db, options, moveContext) {
   return skip;
 }
 
-function reassignReportSubjects(report, { sourceId, destinationId }) {
-  const SUBJECT_IDS = ['patient_id', 'patient_uuid', 'place_id', 'place_uuid'];
+function getReportsCreatedAtIds(moveContext) {
+  const result = [];
+  if (moveContext.merge) {
+    result.push(moveContext.sourceId);
+  }
+
+  if (moveContext.mergePrimaryContacts && moveContext.sourcePrimaryContactId) {
+    result.push(moveContext.sourcePrimaryContactId);
+  }
+
+  return result;
+}
+
+function reassignReportSubjects(report, moveContext) {
   let updated = false;
-  for (const subjectId of SUBJECT_IDS) {
-    if (report[subjectId] === sourceId) {
-      report[subjectId] = destinationId;
-      updated = true;
-    }
+  for (const subjectId of DataSource.SUBJECT_IDS) {
+    updated = updated || reassignSingleReport(report, subjectId, moveContext.sourceId, moveContext.destinationId);
 
-    if (report.fields[subjectId] === sourceId) {
-      report.fields[subjectId] = destinationId;
-      updated = true;
+    if (moveContext.mergePrimaryContacts && moveContext.sourcePrimaryContactId && moveContext.destinationPrimaryContactId) {
+      updated = updated || reassignSingleReport(report, subjectId, moveContext.sourcePrimaryContactId, moveContext.destinationPrimaryContactId);
     }
   }
 
   return updated;
 }
 
+function reassignSingleReport(report, subjectId, matchId, resultingId) {
+  let result = false;
+  if (report[subjectId] === matchId) {
+    report[subjectId] = resultingId;
+    result = true;
+  }
+
+  if (report.fields[subjectId] === matchId) {
+    report.fields[subjectId] = resultingId;
+    result = true;
+  }
+
+  return result;
+}
+
 function reassignReports(reports, moveContext) {
   const updated = new Set();
   if (!moveContext.merge) {
@@ -167,9 +194,26 @@ function replaceLineageInSingleContact(doc, moveContext) {
   }
 }
 
-function replaceLineageInContacts(moveContext) {
+function updateContacts(moveContext, constraints) {
   return moveContext.descendantsAndSelf
-    .map(descendant => replaceLineageInSingleContact(descendant, moveContext))
+    .map(descendant => {
+      const deleteSource = moveContext.merge && descendant._id === moveContext.sourceId;
+      const deletePrimaryContact = moveContext.mergePrimaryContacts 
+        && descendant._id === moveContext.sourcePrimaryContactId 
+        && moveContext.destinationPrimaryContactId;
+
+      if (deleteSource || deletePrimaryContact) {
+        const toDeleteUsers = moveContext.disableUsers && constraints.isPlace(descendant);
+        return {
+          _id: descendant._id,
+          _rev: descendant._rev,
+          _deleted: true,
+          cht_disable_linked_users: !!toDeleteUsers,
+        };
+      }
+
+      return replaceLineageInSingleContact(descendant, moveContext);
+    })
     .filter(Boolean);
 }
 

test/fn/merge-contacts.spec.js

@@ -19,6 +19,7 @@ describe('merge-contacts', () => {
         sourceIds: ['food', 'is', 'tasty'],
         destinationId: 'bar',
         disableUsers: false,
+        mergePrimaryContacts: false,
         force: true,
         docDirectoryPath: '/',
       });

test/fn/upload-docs.spec.js

@@ -123,6 +123,7 @@ describe('upload-docs', function() {
 
   it('should throw if user denies the warning', async () => {
     userPrompt.__set__('readline', { keyInYN: () => false });
+    await assertDbEmpty();
     const actual = uploadDocs.execute();
     await expect(actual).to.eventually.be.rejectedWith('User aborted execution.');
   });

test/lib/hierarchy-operations/hierarchy-operations.spec.js

@@ -664,6 +664,14 @@ describe('hierarchy-operations', () => {
   });
 
   describe('merge', () => {
+    beforeEach(async () => {
+      await mockReport(pouchDb, {
+        id: 'district_primary_contact_report',
+        creatorId: 'district_2_contact',
+        patientId: 'district_2_contact'
+      });
+    });
+
     it('merge district_2 into district_1', async () => {
       // setup
       await mockReport(pouchDb, {
@@ -692,7 +700,7 @@ describe('hierarchy-operations', () => {
         'health_center_2', 'health_center_2_contact', 
         'clinic_2', 'clinic_2_contact',
         'patient_2',
-        'changing_subject_and_contact', 'changing_contact', 'changing_subject'
+        'changing_subject_and_contact', 'changing_contact', 'changing_subject', 'district_primary_contact_report'
       ]);
 
       expect(getWrittenDoc('district_2')).to.deep.eq({
@@ -753,6 +761,16 @@ describe('hierarchy-operations', () => {
           patient_uuid: 'district_1'
         }
       });
+
+      expect(getWrittenDoc('district_primary_contact_report')).to.deep.eq({
+        _id: 'district_primary_contact_report',
+        form: 'foo',
+        type: 'data_record',
+        contact: parentsToLineage('district_2_contact', 'district_1'),
+        fields: {
+          patient_uuid: 'district_2_contact'
+        }
+      });
     });
 
     it('merge two patients', async () => {
@@ -791,6 +809,102 @@ describe('hierarchy-operations', () => {
         }
       });
     });
+
+    it('--merge-primary-contacts results in merge of primary contacts and reports', async () => {
+      await HierarchyOperations(pouchDb, { mergePrimaryContacts: true }).merge(['district_2'], 'district_1');
+
+      expectWrittenDocs([
+        'district_2', 'district_2_contact', 
+        'health_center_2', 'health_center_2_contact', 
+        'clinic_2', 'clinic_2_contact',
+        'patient_2',
+        'district_primary_contact_report'
+      ]);
+
+      expect(getWrittenDoc('district_2_contact')).to.deep.eq({
+        _id: 'district_2_contact',
+        _deleted: true,
+        cht_disable_linked_users: false,
+      });
+
+      expect(getWrittenDoc('district_primary_contact_report')).to.deep.eq({
+        _id: 'district_primary_contact_report',
+        form: 'foo',
+        type: 'data_record',
+        contact: parentsToLineage('district_2_contact', 'district_1'),
+        fields: {
+          patient_uuid: 'district_1_contact'
+        }
+      });
+    });
+
+    it('--merge-primary-contacts when no primary contact on source', async () => {
+      await upsert('district_2', {
+        type: 'district_hospital',
+      });
+
+      await HierarchyOperations(pouchDb, { mergePrimaryContacts: true }).merge(['district_2'], 'district_1');
+
+      expectWrittenDocs([
+        'district_2', 'district_2_contact', 
+        'health_center_2', 'health_center_2_contact', 
+        'clinic_2', 'clinic_2_contact',
+        'patient_2',
+        'district_primary_contact_report'
+      ]);
+
+      // not deleted
+      expect(getWrittenDoc('district_2_contact')).to.deep.eq({
+        _id: 'district_2_contact',
+        type: 'person',
+        parent: parentsToLineage('district_1'),
+      });
+
+      // not reassigned
+      expect(getWrittenDoc('district_primary_contact_report')).to.deep.eq({
+        _id: 'district_primary_contact_report',
+        form: 'foo',
+        type: 'data_record',
+        contact: parentsToLineage('district_2_contact', 'district_1'),
+        fields: {
+          patient_uuid: 'district_2_contact'
+        }
+      });
+    });
+
+    it('--merge-primary-contacts when no primary contact on destination', async () => {
+      await upsert('district_1', {
+        type: 'district_hospital',
+      });
+
+      await HierarchyOperations(pouchDb, { mergePrimaryContacts: true }).merge(['district_2'], 'district_1');
+
+      expectWrittenDocs([
+        'district_2', 'district_2_contact', 
+        'health_center_2', 'health_center_2_contact', 
+        'clinic_2', 'clinic_2_contact',
+        'patient_2',
+        'district_primary_contact_report'
+      ]);
+
+      // not deleted
+      expect(getWrittenDoc('district_2_contact')).to.deep.eq({
+        _id: 'district_2_contact',
+        type: 'person',
+        parent: parentsToLineage('district_1'),
+      });
+
+      // not reassigned
+      expect(getWrittenDoc('district_primary_contact_report')).to.deep.eq({
+        _id: 'district_primary_contact_report',
+        form: 'foo',
+        type: 'data_record',
+        contact: parentsToLineage('district_2_contact', 'district_1'),
+        fields: {
+          patient_uuid: 'district_2_contact'
+        }
+      });
+    });
   });
 
   describe('delete', () => {