perf(10749): move tasks_by_contact view to offline-only design document

api/src/services/authorization.js

@@ -12,8 +12,10 @@ const { DOC_IDS } = require('@medic/constants');
 const ALL_KEY = '_all'; // key in the docs_by_replication_key view for records everyone can access
 const UNASSIGNED_KEY = '_unassigned'; // key in the docs_by_replication_key view for unassigned records
 const MEDIC_CLIENT_DDOC = '_design/medic-client';
+const MEDIC_OFFLINE_TASKS_DDOC = '_design/medic-offline-tasks';
 const DEFAULT_DDOCS = [
   MEDIC_CLIENT_DDOC,
+  MEDIC_OFFLINE_TASKS_DDOC,
   DOC_IDS.SERVICE_WORKER_META,
   DOC_IDS.SETTINGS,
 ];
@@ -188,9 +190,12 @@ const updateContext = (allowed, authorizationContext, { contactsByDepth }) => {
  * @param   {DocByReplicationKey} docsByReplicationKey - result of `medic/_nouveau/docs_by_replication_key` index
  * @param   {Array}    contactsByDepth - results of `medic/contacts_by_depth` view against doc
  * @returns {Boolean}
- */
 const allowedDoc = (docId, authorizationContext, { docsByReplicationKey, contactsByDepth }) => {
-  if ([MEDIC_CLIENT_DDOC, getUserSettingsId(authorizationContext.userCtx.name)].includes(docId)) {
+  if ([
+    MEDIC_CLIENT_DDOC,
+    MEDIC_OFFLINE_TASKS_DDOC,
+    getUserSettingsId(authorizationContext.userCtx.name),
+  ].includes(docId)) {
     return true;
   }
 
@@ -691,7 +696,11 @@ const getDocsByReplicationKey = async (authorizationContext) => {
  * @returns {string[]}
  */
 const filterAllowedDocIds = (authCtx, docsByReplicationKey, { includeTasks = true } = {}) => {
-  const validatedIds = [MEDIC_CLIENT_DDOC, getUserSettingsId(authCtx.userCtx.name)];
+  const validatedIds = [
+    MEDIC_CLIENT_DDOC,
+    MEDIC_OFFLINE_TASKS_DDOC,
+    getUserSettingsId(authCtx.userCtx.name),
+  ];
 
   if (!docsByReplicationKey || !docsByReplicationKey.length) {
     return validatedIds;

shared-libs/memdown/src/memdown-medic.js

@@ -57,6 +57,16 @@ module.exports = (rootDir='./') => {
   if (!ddocs) {
     ddocs = [];
     filesIn(`${rootDir}/ddocs/medic-db`).forEach(ddoc => loadDdoc(rootDir, 'medic-db', ddoc));
+
+    // Load offline-only tasks view for tests
+    const tasksMapPath = `${rootDir}/webapp/src/js/bootstrapper/offline-ddocs/medic-offline-tasks/tasks_by_contact.js`;
+    if (fs.existsSync(tasksMapPath)) {
+      const tasksMap = readFile(tasksMapPath).replace(/module.exports.map = /, '');
+      ddocs.push({
+        _id: '_design/medic-offline-tasks',
+        views: { tasks_by_contact: { map: tasksMap } }
+      });
+    }
   }
   const db = new PouchDB(uuid(), { adapter: 'memory' });
   return Promise.all(ddocs.map(ddoc => db.put(ddoc)))

shared-libs/rules-engine/src/pouchdb-provider.js

@@ -39,7 +39,7 @@ const medicPouchProvider = db => {
     // For users with ~1000 contacts it is ~50x faster to provider a start/end key instead of specifying all ids
     allTasks: prefix => {
       const options = { startkey: `${prefix}-`, endkey: `${prefix}-\ufff0`, include_docs: true };
-      return docsOf(dbQuery('medic-client/tasks_by_contact', options));
+      return docsOf(dbQuery('medic-offline-tasks/tasks_by_contact', options));
     },
 
     allTaskData: userSettingsDoc => {
@@ -108,12 +108,12 @@ const medicPouchProvider = db => {
 
     tasksByRelation: (contactIds, prefix) => {
       const keys = contactIds.map(contactId => `${prefix}-${contactId}`);
-      return docsOf(dbQuery( 'medic-client/tasks_by_contact', { keys, include_docs: true }));
+      return docsOf(dbQuery( 'medic-offline-tasks/tasks_by_contact', { keys, include_docs: true }));
     },
 
     allTaskRowsByOwner: (contactIds) => {
       const keys = contactIds.map(contactId => (['owner', 'all', contactId]));
-      return rowsOf(dbQuery( 'medic-client/tasks_by_contact', { keys }));
+      return rowsOf(dbQuery( 'medic-offline-tasks/tasks_by_contact', { keys }));
     },
 
     allTaskRows: () => {
@@ -122,7 +122,7 @@ const medicPouchProvider = db => {
         endkey: ['owner', 'all', '\ufff0'],
       };
 
-      return rowsOf(dbQuery( 'medic-client/tasks_by_contact', options));
+      return rowsOf(dbQuery( 'medic-offline-tasks/tasks_by_contact', options));
     },
 
     taskDataFor: async (contactIds, userSettingsDoc) => {

shared-libs/rules-engine/test/integration.spec.js

@@ -69,12 +69,12 @@ const reportByPatientIdOnly = {
 const expectedQueriesForAllFreshData = [
   'medic-client/contacts_by_type',
   'medic-client/reports_by_subject',
-  'medic-client/tasks_by_contact'
+  'medic-offline-tasks/tasks_by_contact'
 ];
 const expectedQueriesForFreshData = [
   'medic-client/reports_by_subject',
-  'medic-client/tasks_by_contact',
-  'medic-client/tasks_by_contact',
+  'medic-offline-tasks/tasks_by_contact',
+  'medic-offline-tasks/tasks_by_contact',
 ];
 
 const fetchTargets = async (interval) => {
@@ -455,7 +455,7 @@ describe(`Rules Engine Integration Tests`, () => {
       const tasksAfterPurge = await rulesEngine.fetchTasksFor();
       expect(tasksAfterPurge).to.have.property('length', 0);
 
-      const allTasks = await db.query('medic-client/tasks_by_contact');
+      const allTasks = await db.query('medic-offline-tasks/tasks_by_contact');
       expect(allTasks.total_rows).to.eq(0);
     });
 
@@ -484,7 +484,7 @@ describe(`Rules Engine Integration Tests`, () => {
       expect(secondTasks).to.deep.eq(firstTasks);
       expect(db.query.args.map(args => args[0])).to.deep.eq([
         ...expectedQueriesForAllFreshData,
-        'medic-client/tasks_by_contact',
+        'medic-offline-tasks/tasks_by_contact',
         'medic-client/contacts_by_reference',
         ...expectedQueriesForFreshData
       ]);
@@ -542,7 +542,7 @@ describe(`Rules Engine Integration Tests`, () => {
       expect(rulesEmitter.getEmissionsFor.args).excludingEvery(['_rev', 'state', 'stateHistory'])
         .to.deep.eq([[[], [headlessReport, headlessReport2], [taskEmittedByHeadless2]]]);
       expect(db.query.args.map(args => args[0]))
-        .to.deep.eq([...expectedQueriesForAllFreshData, 'medic-client/tasks_by_contact']);
+        .to.deep.eq([...expectedQueriesForAllFreshData, 'medic-offline-tasks/tasks_by_contact']);
       expect(firstResult).excludingEvery('_rev').to.deep.eq([taskOwnedByHeadless]);
       expect(db.bulkDocs.callCount).to.eq(2); // taskEmittedByHeadless2 gets cancelled
 
@@ -770,7 +770,7 @@ const triggerFacilityReminderInReadyState = async (selectBy, docs = [patientCont
   const tasks = await rulesEngine.fetchTasksFor(selectBy);
   expect(tasks).to.have.property('length', 1);
   expect(db.query.args.map(args => args[0])).to.deep.eq(
-    selectBy ? expectedQueriesForFreshData : [...expectedQueriesForAllFreshData, 'medic-client/tasks_by_contact']
+    selectBy ? expectedQueriesForFreshData : [...expectedQueriesForAllFreshData, 'medic-offline-tasks/tasks_by_contact']
   );
   expect(db.bulkDocs.callCount).to.eq(2);
   expect(tasks[0]).to.deep.include({

shared-libs/rules-engine/test/pouchdb-provider.spec.js

@@ -347,7 +347,10 @@ describe('pouchdb provider', () => {
       });
       expect(db.query.args).to.deep.equal([
         ['medic-client/reports_by_subject', { keys: ['abc'], include_docs: true, ...defaultQueryParams }],
-        ['medic-client/tasks_by_contact', { keys: ['requester-abc'], include_docs: true, ...defaultQueryParams }],
+        [
+          'medic-offline-tasks/tasks_by_contact',
+          { keys: ['requester-abc'], include_docs: true, ...defaultQueryParams },
+        ],
       ]);
     });
     it('cht contact yields', async() => {
@@ -369,11 +372,19 @@ describe('pouchdb provider', () => {
       expect(db.query.args).to.deep.equal([
         [
           'medic-client/reports_by_subject',
-          { keys: [chtDocs.contact._id, 'abc', chtDocs.contact.patient_id], include_docs: true, ...defaultQueryParams },
+          {
+            keys: [chtDocs.contact._id, 'abc', chtDocs.contact.patient_id],
+            include_docs: true,
+            ...defaultQueryParams,
+          },
         ],
         [
-          'medic-client/tasks_by_contact',
-          { keys: [`requester-${chtDocs.contact._id}`, 'requester-abc'], include_docs: true, ...defaultQueryParams }
+          'medic-offline-tasks/tasks_by_contact',
+          {
+            keys: [`requester-${chtDocs.contact._id}`, 'requester-abc'],
+            include_docs: true,
+            ...defaultQueryParams,
+          },
         ],
       ]);
     });
@@ -439,11 +450,19 @@ describe('pouchdb provider', () => {
       expect(db.query.args).to.deep.equal([
         [
           'medic-client/reports_by_subject',
-          { keys: [ ...contactIds, 'place_id', 'patient_id' ], include_docs: true, ...defaultQueryParams },
+          {
+            keys: [ ...contactIds, 'place_id', 'patient_id' ],
+            include_docs: true,
+            ...defaultQueryParams,
+          },
         ],
         [
-          'medic-client/tasks_by_contact',
-          { keys: contactIds.map(id => `requester-${id}`), include_docs: true, ...defaultQueryParams }
+          'medic-offline-tasks/tasks_by_contact',
+          {
+            keys: contactIds.map(id => `requester-${id}`),
+            include_docs: true,
+            ...defaultQueryParams,
+          },
         ],
       ]);
 
@@ -481,7 +500,7 @@ describe('pouchdb provider', () => {
           { include_docs: true, ...defaultQueryParams },
         ],
         [
-          'medic-client/tasks_by_contact',
+          'medic-offline-tasks/tasks_by_contact',
           { include_docs: true, ...defaultQueryParams }
         ],
       ]);

shared-libs/rules-engine/test/provider-wireup.spec.js

@@ -402,7 +402,7 @@ describe('provider-wireup integration tests', () => {
       expect(actual).to.be.empty;
       expect(rulesEmitter.getEmissionsFor.callCount).to.eq(1);
       expect(db.query.callCount).to.eq(3);
-      expect(db.query.args[2][0]).to.eq('medic-client/tasks_by_contact');
+      expect(db.query.args[2][0]).to.eq('medic-offline-tasks/tasks_by_contact');
       expect(db.query.args[2][1]).to.not.have.property('keys');
     });
 

webapp/src/js/bootstrapper/offline-ddocs/index.js

@@ -1,4 +1,5 @@
 const contactsByFreetext = require('./medic-offline-freetext');
+const tasks = require('./medic-offline-tasks');
 
 const getRev = async (db, id) => db
   .get(id)
@@ -15,4 +16,7 @@ const initDdoc = async (db, ddoc) => db.put({
   _rev: await getRev(db, ddoc._id),
 });
 
-module.exports.init = async (db) => initDdoc(db, contactsByFreetext);
+module.exports.init = async (db) => {
+  await initDdoc(db, contactsByFreetext);
+  await initDdoc(db, tasks);
+};

webapp/src/js/bootstrapper/offline-ddocs/medic-offline-tasks/index.js

@@ -0,0 +1,10 @@
+const tasksByContact = require('./tasks_by_contact');
+
+const packageView = ({ map }) => ({ map: map.toString() });
+
+module.exports = {
+  _id: '_design/medic-offline-tasks',
+  views: {
+    tasks_by_contact: packageView(tasksByContact),
+  }
+};

ddocs/medic-db/medic-client/views/tasks_by_contact/map.js → webapp/src/js/bootstrapper/offline-ddocs/medic-offline-tasks/tasks_by_contact.js

@@ -1,7 +1,7 @@
-function(doc) {
+module.exports.map = function(doc) {
   if (doc.type === 'task') {
-    var isTerminalState = ['Cancelled', 'Completed', 'Failed'].indexOf(doc.state) >= 0;
-    var owner = (doc.owner || '_unassigned');
+    const isTerminalState = ['Cancelled', 'Completed', 'Failed'].includes(doc.state);
+    const owner = (doc.owner || '_unassigned');
 
     if (!isTerminalState) {
       emit('owner-' + owner);
@@ -13,4 +13,4 @@ function(doc) {
 
     emit(['owner', 'all', owner], { state: doc.state });
   }
-}
+};