feat(#9857): implement CouchDB Nouveau (#9541)

Co-authored-by: Joshua Kuestersteffen <[email protected]>
Co-authored-by: Sugat Bajracharya <[email protected]>

Author: 3 people

admin/src/js/controllers/edit-user.js

@@ -1,8 +1,6 @@
 const moment = require('moment');
 const passwordTester = require('simple-password-tester');
 const phoneNumber = require('@medic/phone-number');
-const cht = require('@medic/cht-datasource');
-const chtDatasource = cht.getDatasource(cht.getRemoteDataContext());
 const PASSWORD_MINIMUM_LENGTH = 8;
 const PASSWORD_MINIMUM_SCORE = 50;
 const SHOW_PASSWORD_ICON = '/login/images/show-password.svg';
@@ -27,6 +25,7 @@ angular
     $scope,
     $translate,
     $uibModalInstance,
+    CHTDatasource,
     ContactTypes,
     CreateUser,
     DB,
@@ -38,6 +37,7 @@ angular
     'use strict';
     'ngInject';
 
+    const datasource = CHTDatasource.datasource;
     $scope.cancel = () => $uibModalInstance.dismiss();
 
     const getRoles = roles => {
@@ -58,7 +58,7 @@ angular
     };
 
     const validateSkipPasswordPermission = () => {
-      $scope.skipPasswordChange = chtDatasource.v1.hasPermissions(
+      $scope.skipPasswordChange = datasource.v1.hasPermissions(
         ['can_skip_password_change'], $scope.editUserModel.roles, $scope.permissions
       );
     };
@@ -293,7 +293,7 @@ angular
         return true;
       }
 
-      const userHasPermission = chtDatasource.v1.hasPermissions(
+      const userHasPermission = datasource.v1.hasPermissions(
         ['can_have_multiple_places'], $scope.editUserModel.roles, $scope.permissions
       );
 

admin/src/js/main.js

@@ -100,6 +100,7 @@ require('./services/add-attachment');
 require('./services/auth');
 require('./services/cache');
 require('./services/changes');
+require('./services/cht-datasource');
 require('./services/contact-muted');
 require('./services/contact-types');
 require('./services/db');

admin/src/js/services/auth.js

@@ -1,16 +1,16 @@
-const cht = require('@medic/cht-datasource');
-const chtDatasource = cht.getDatasource(cht.getRemoteDataContext());
-
 angular.module('inboxServices').factory('Auth',
   function(
     $log,
+    CHTDatasource,
     Session,
     Settings
   ) {
 
     'use strict';
     'ngInject';
 
+    const datasource = CHTDatasource.datasource;
+
     /**
      * Receives a list of groups of permissions and returns a promise that will be resolved if the
      * current user's role has all the permissions of any of the provided groups.
@@ -37,7 +37,7 @@ angular.module('inboxServices').factory('Auth',
             return false;
           }
 
-          return chtDatasource.v1.hasAnyPermission(permissionsGroupList, userCtx.roles, settings.permissions);
+          return datasource.v1.hasAnyPermission(permissionsGroupList, userCtx.roles, settings.permissions);
         })
         .catch(() => false);
     };
@@ -63,7 +63,7 @@ angular.module('inboxServices').factory('Auth',
             return false;
           }
 
-          return chtDatasource.v1.hasPermissions(permissions, userCtx.roles, settings.permissions);
+          return datasource.v1.hasPermissions(permissions, userCtx.roles, settings.permissions);
         })
         .catch(() => false);
     };

admin/src/js/services/cht-datasource.js

@@ -0,0 +1,16 @@
+const cht = require('@medic/cht-datasource');
+
+angular.module('inboxServices').factory('CHTDatasource',
+  function(
+    Location
+  ) {
+    'use strict';
+    'ngInject';
+
+    const dataContext = cht.getRemoteDataContext(Location.rootUrl);
+    const datasource = cht.getDatasource(dataContext);
+    return {
+      dataContext,
+      datasource,
+    };
+  });

admin/src/js/services/location.js

@@ -10,12 +10,14 @@ angular.module('inboxServices').factory('Location',
     const path = '/';
     const adminPath = '/admin/';
     const port = location.port ? ':' + location.port : '';
-    const url = location.protocol + '//' + location.hostname + port + '/' + dbName;
+    const rootUrl = location.protocol + '//' + location.hostname + port;
+    const url = rootUrl + '/' + dbName;
 
     return {
       path: path,
       adminPath: adminPath,
       dbName: dbName,
-      url: url
+      rootUrl: rootUrl,
+      url: url,
     };
   });

admin/src/js/services/search.js

@@ -8,14 +8,14 @@ const Search = require('@medic/search');
   // To make it easier to mock out
   angular.module('inboxServices').factory('SearchFactory',
     function(
-      $q,
+      CHTDatasource,
       DB
     ) {
 
       'ngInject';
 
       return function() {
-        return Search($q, DB());
+        return Search(DB(), CHTDatasource.dataContext);
       };
     });
 

admin/tests/unit/services/cht-datasource.spec.js

@@ -0,0 +1,22 @@
+describe('CHTDatasource service', () => {
+  'use strict';
+
+  let service;
+  let Location;
+
+  beforeEach(() => {
+    Location = { rootUrl: 'ftp//myhost:21' };
+    module('adminApp');
+    module($provide => {
+      $provide.value('Location', Location);
+    });
+    inject(($injector) => {
+      service = $injector.get('CHTDatasource');
+    });
+  });
+
+  it('initializes a datasource and data context', () => {
+    chai.expect(service.dataContext.url).to.equal(Location.rootUrl);
+    chai.expect(service.datasource).to.haveOwnProperty('v1');
+  });
+});

api/src/services/export/contact-mapper.js

@@ -1,5 +1,6 @@
 const db = require('../../db');
-const search = require('@medic/search')(Promise, db.medic);
+const dataContext = require('../data-context');
+const search = require('@medic/search')(db.medic, dataContext);
 const lineage = require('@medic/lineage')(Promise, db.medic);
 
 module.exports = {

api/src/services/export/report-mapper.js

@@ -2,7 +2,8 @@ const _ = require('lodash');
 const objectPath = require('object-path');
 const db = require('../../db');
 const dateFormat = require('./date-format');
-const search = require('@medic/search')(Promise, db.medic);
+const dataContext = require('../data-context');
+const search = require('@medic/search')(db.medic, dataContext);
 const lineage = require('@medic/lineage')(Promise, db.medic);
 
 // Flattens a given object into an object where the keys are dot-notation

api/src/services/monitoring.js

@@ -27,6 +27,18 @@ const VIEW_INDEXES_TO_MONITOR = {
   users: ['users'],
 };
 
+const NOUVEAU_INDEXES_TO_MONITOR = {
+  medic: {
+    'medic': [
+      'contacts_by_freetext',
+      'reports_by_freetext',
+    ],
+  },
+  sentinel: {},
+  usersmeta: {},
+  users: {},
+};
+
 const MESSAGE_QUEUE_STATUS_KEYS = ['due', 'scheduled', 'muted', 'failed', 'delivered'];
 const fromEntries = (keys, value) => {
   // "shim" of Object.fromEntries
@@ -115,7 +127,7 @@ const getFragmentation = ({ sizes }, viewIndexInfos) => {
   return totalFile / totalActive;
 };
 
-const mapDbInfo = (dbInfo, viewIndexInfos) => {
+const mapDbInfo = (dbInfo, viewIndexInfos, nouveauIndexInfos) => {
   return {
     name: dbInfo.db_name || '',
     update_sequence: getSequenceNumber(dbInfo.update_seq),
@@ -131,8 +143,13 @@ const mapDbInfo = (dbInfo, viewIndexInfos) => {
       sizes: {
         active: defaultNumber(viewIndexInfo.view_index?.sizes?.active),
         file: defaultNumber(viewIndexInfo.view_index?.sizes?.file),
-      }
-    }))
+      },
+    })),
+    nouveau_indexes: nouveauIndexInfos?.map(nouveauIndexInfo => ({
+      name: nouveauIndexInfo.name,
+      doc_count: defaultNumber(nouveauIndexInfo.search_index.num_docs),
+      file_size: defaultNumber(nouveauIndexInfo.search_index.disk_size),
+    })),
   };
 };
 
@@ -167,11 +184,38 @@ const fetchViewIndexInfosForDb = (db) => Promise.all(
 
 const fetchAllViewIndexInfos = () => Promise.all(Object.keys(VIEW_INDEXES_TO_MONITOR).map(fetchViewIndexInfosForDb));
 
+const fetchNouveauIndexInfo = (db, designDoc, indexName) => request
+  .get({
+    url: `${environment.serverUrl}/${db}/_design/${designDoc}/_nouveau_info/${indexName}`,
+    json: true
+  })
+  .then(data => ({ ...data, name: `${designDoc}/${indexName}` }))
+  .catch(err => {
+    logger.error('Error fetching nouveau index info: %o', err);
+    return null;
+  });
+
+const fetchNouveauIndexInfosForDdoc = (db, ddoc) => NOUVEAU_INDEXES_TO_MONITOR[db][ddoc].map(
+  indexName => fetchNouveauIndexInfo(DBS_TO_MONITOR[db], ddoc, indexName),
+);
+
+const fetchNouveauIndexInfosForDb = (db) => Promise.all(Object.keys(NOUVEAU_INDEXES_TO_MONITOR[db]).flatMap(
+  ddoc => fetchNouveauIndexInfosForDdoc(db, ddoc),
+)).then((nouveauIndexInfos) => nouveauIndexInfos.filter(info => info));
+
+const fetchAllNouveauIndexInfos = () => Promise.all(
+  Object.keys(NOUVEAU_INDEXES_TO_MONITOR).map(fetchNouveauIndexInfosForDb),
+);
+
 const getDbInfos = async () => {
-  const [dbInfos, viewIndexInfos] = await Promise.all([fetchDbsInfo(), fetchAllViewIndexInfos()]);
+  const [dbInfos, viewIndexInfos, nouveauIndexInfos] = await Promise.all([
+    fetchDbsInfo(),
+    fetchAllViewIndexInfos(),
+    fetchAllNouveauIndexInfos(),
+  ]);
   const result = {};
   Object.keys(DBS_TO_MONITOR).forEach((dbKey, i) => {
-    result[dbKey] = mapDbInfo(dbInfos[i], viewIndexInfos[i]);
+    result[dbKey] = mapDbInfo(dbInfos[i], viewIndexInfos[i], nouveauIndexInfos[i]);
   });
   return result;
 };