feat(#8877): Look up users from their facility_id or contact_id

api/src/controllers/users.js

@@ -110,9 +110,8 @@ const getAllowedDocsCounts = async (userCtx) => {
 // In express4, req.host strips off the port number: https://expressjs.com/en/guide/migrating-5.html#req.host
 const getAppUrl = (req) => `${req.protocol}://${req.hostname}`;
 
-const getUserList = async (req) => {
-  await auth.check(req, 'can_view_users');
-  return await users.getList();
+const getUserList = async (filters = {}) => {
+  return await users.getList(filters);
 };
 
 const getType = user => {
@@ -132,7 +131,8 @@ const convertUserListToV1 = (users=[]) => {
 
 module.exports = {
   get: (req, res) => {
-    return getUserList(req)
+    return auth.check(req, 'can_view_users')
+      .then(() => getUserList())
       .then(list => convertUserListToV1(list))
       .then(body => res.json(body))
       .catch(err => serverUtils.error(err, req, res));
@@ -233,7 +233,12 @@ module.exports = {
   v2: {
     get: async (req, res) => {
       try {
-        const body = await getUserList(req, res);
+        await auth.check(req, 'can_view_users');
+        const filters = _.chain(req.query)
+          .pick(['facility_id', 'contact_id']) // keep only supported filtering properties
+          .mapKeys((value, key) => _.camelCase(key)) // rename them to keep consistent variable names
+          .value();
+        const body = await getUserList(filters);
         res.json(body);
       } catch (err) {
         serverUtils.error(err, req, res);

api/tests/mocha/controllers/users.spec.js

@@ -31,15 +31,24 @@ describe('Users Controller', () => {
   afterEach(() => sinon.restore());
 
   describe('get users list', () => {
+    let userList;
 
     beforeEach(() => {
+      userList = [
+        { id: 'org.couchdb.user:admin', roles: ['_admin'] },
+        {
+          id: 'org.couchdb.user:chw',
+          roles: ['chw', 'district-admin'],
+          contact: {
+            _id: 'chw-contact',
+            parent: { _id: 'chw-facility' },
+          }
+        },
+        { id: 'org.couchdb.user:unknown' },
+      ];
       req = { };
       res = { json: sinon.stub() };
-      sinon.stub(users, 'getList').resolves([
-        { id: 'org.couchdb.user:admin', roles: [ '_admin' ] },
-        { id: 'org.couchdb.user:chw', roles: [ 'chw', 'district-admin' ] },
-        { id: 'org.couchdb.user:unknown' },
-      ]);
+      sinon.stub(users, 'getList').resolves(userList);
     });
 
     describe('v1', () => {
@@ -69,14 +78,13 @@ describe('Users Controller', () => {
     });
 
     describe('v2', () => {
-
       it('rejects if not permitted', async () => {
         sinon.stub(auth, 'check').rejects(new Error('nope'));
         await controller.v2.get(req, res);
         chai.expect(serverUtils.error.callCount).to.equal(1);
       });
 
-      it('gets the list of users', async () => {
+      it('gets the list of users without filters', async () => {
         sinon.stub(auth, 'check').resolves();
 
         await controller.v2.get(req, res);
@@ -92,6 +100,53 @@ describe('Users Controller', () => {
         chai.expect(result[2].roles).to.be.undefined;
       });
 
+      it('gets the list of users with facility_id filter', async () => {
+        sinon.stub(auth, 'check').resolves();
+        users.getList.resolves([userList[1]]);
+        req.query = { facility_id: 'chw-facility' };
+
+        await controller.v2.get(req, res);
+        chai.expect(users.getList.firstCall.args[0]).to.deep.equal({ facilityId: 'chw-facility' });
+        const result = res.json.args[0][0];
+        chai.expect(result.length).to.equal(1);
+        chai.expect(result[0].id).to.equal('org.couchdb.user:chw');
+        chai.expect(result[0].type).to.be.undefined;
+        chai.expect(result[0].roles).to.deep.equal(['chw', 'district-admin']);
+        chai.expect(result[0].contact._id).to.equal('chw-contact');
+        chai.expect(result[0].contact.parent._id).to.equal('chw-facility');
+      });
+
+      it('gets the list of users with facility_id and contact_id filters', async () => {
+        sinon.stub(auth, 'check').resolves();
+        users.getList.resolves([userList[1]]);
+        req.query = { facility_id: 'chw-facility', contact_id: 'chw-contact' };
+
+        await controller.v2.get(req, res);
+        chai.expect(users.getList.firstCall.args[0]).to.deep.equal({
+          contactId: 'chw-contact',
+          facilityId: 'chw-facility',
+        });
+        const result = res.json.args[0][0];
+        chai.expect(result.length).to.equal(1);
+        chai.expect(result[0].id).to.equal('org.couchdb.user:chw');
+        chai.expect(result[0].type).to.be.undefined;
+        chai.expect(result[0].roles).to.deep.equal(['chw', 'district-admin']);
+        chai.expect(result[0].contact._id).to.equal('chw-contact');
+        chai.expect(result[0].contact.parent._id).to.equal('chw-facility');
+      });
+
+      it('gets the list of users and ignores unexpected filters', async () => {
+        sinon.stub(auth, 'check').resolves();
+        req.query = { roles: ['chw'], name: 'admin' };
+
+        await controller.v2.get(req, res);
+        chai.expect(users.getList.firstCall.args[0]).to.deep.equal({});
+        const result = res.json.args[0][0];
+        chai.expect(result.length).to.equal(3);
+        chai.expect(result[0].id).to.equal('org.couchdb.user:admin');
+        chai.expect(result[1].id).to.equal('org.couchdb.user:chw');
+        chai.expect(result[2].id).to.equal('org.couchdb.user:unknown');
+      });
     });
 
   });

ddocs/medic-db/medic-client/views/doc_by_type/map.js

@@ -6,5 +6,12 @@ function(doc) {
     });
     return;
   }
+  if (doc.type === 'user-settings') {
+    emit([ doc.type ]);
+    emit([ doc.type, doc.facility_id ]);
+    emit([ doc.type, doc.contact_id ]);
+    emit([ doc.type, doc.facility_id, doc.contact_id ]);
+    return;
+  }
   emit([ doc.type ]);
 }

shared-libs/user-management/src/libs/facility.js

@@ -3,7 +3,7 @@ const db = require('./db');
 const list = async (users, settings) => {
   const ids = new Set();
   for (const user of users) {
-    ids.add(user?.doc?.facility_id);
+    ids.add(user?.facility_id);
   }
   for (const setting of settings) {
     ids.add(setting?.contact_id);

shared-libs/user-management/src/users.js

@@ -105,18 +105,34 @@ const getDocID = doc => {
   }
 };
 
-const getAllUserSettings = () => {
+const getAllUserSettings = ({ facilityId, contactId } = {}) => {
+  const key = ['user-settings'];
+  if (facilityId) {
+    key.push(facilityId);
+  }
+  if (contactId) {
+    key.push(contactId);
+  }
+
   const opts = {
     include_docs: true,
-    key: ['user-settings']
+    key,
   };
   return db.medic.query('medic-client/doc_by_type', opts)
     .then(result => result.rows.map(row => row.doc));
 };
 
 const getAllUsers = () => {
   return db.users.allDocs({ include_docs: true })
-    .then(result => result.rows);
+    .then(result => result.rows.map(({ doc }) => doc));
+};
+
+const getUsersByIds = async (ids) => {
+  const docs = ids.map(id => ({ id }));
+  const { results } = await db.users.bulkGet({ docs });
+  return results
+    .map(result => result.docs && result.docs[0] && result.docs[0].ok)
+    .filter(doc => doc);
 };
 
 const validateContact = (id, placeID) => {
@@ -335,21 +351,21 @@ const hasParent = (facility, id) => {
 const mapUsers = (users, settings, facilities) => {
   users = users || [];
   return users
-    .filter(user => user.id.indexOf(USER_PREFIX) === 0)
+    .filter(user => user._id.indexOf(USER_PREFIX) === 0)
     .map(user => {
-      const setting = getDoc(user.id, settings) || {};
+      const setting = getDoc(user._id, settings) || {};
       return {
-        id: user.id,
-        rev: user.doc._rev,
-        username: user.doc.name,
+        id: user._id,
+        rev: user._rev,
+        username: user.name,
         fullname: setting.fullname,
         email: setting.email,
         phone: setting.phone,
-        place: getDoc(user.doc.facility_id, facilities),
-        roles: user.doc.roles,
+        place: getDoc(user.facility_id, facilities),
+        roles: user.roles,
         contact: getDoc(setting.contact_id, facilities),
         external_id: setting.external_id,
-        known: user.doc.known
+        known: user.known
       };
     });
 };
@@ -770,8 +786,18 @@ const getUserSettings = async({ name }) => {
  */
 module.exports = {
   deleteUser: username => deleteUser(createID(username)),
-  getList: async () => {
-    const [ users, settings ] = await Promise.all([ getAllUsers(), getAllUserSettings() ]);
+  getList: async (filters) => {
+    let users;
+    let settings;
+
+    if (_.isEmpty(filters)) {
+      [users, settings] = await Promise.all([getAllUsers(), getAllUserSettings()]);
+    } else {
+      settings = await getAllUserSettings(filters);
+      const ids = settings.map(({ _id }) => _id);
+      users = await getUsersByIds(ids);
+    }
+
     const facilities = await facility.list(users, settings);
     return mapUsers(users, settings, facilities);
   },

shared-libs/user-management/test/unit/libs/facility.spec.js

@@ -6,8 +6,8 @@ const db = require('../../../src/libs/db');
 
 describe('facility', () => {
 
-  const userA = { doc: { facility_id: 'a' } };
-  const userB = { doc: { facility_id: 'b' } };
+  const userA = { facility_id: 'a' };
+  const userB = { facility_id: 'b' };
 
   const settingA = { contact_id: 'a' };
   const settingB = { contact_id: 'e' };