Merge pull request #1189 from jembi/PLAT-719-fix-user-matadata-importation

Plat 719 fix user metadata importation

Author: nour-borgi

package.json

@@ -1,7 +1,7 @@
 {
   "name": "openhim-core",
   "description": "The OpenHIM core application that provides logging and routing of http requests",
-  "version": "7.2.0",
+  "version": "7.2.1",
   "main": "./lib/server.js",
   "bin": {
     "openhim-core": "./bin/openhim-core.js"

src/api/metadata.js

@@ -10,6 +10,7 @@ import {ContactGroupModelAPI} from '../model/contactGroups'
 import {KeystoreModelAPI} from '../model/keystore'
 import {MediatorModelAPI} from '../model/mediators'
 import {UserModelAPI} from '../model/users'
+import {PassportModelAPI} from '../model/passport'
 import * as polling from '../polling'
 
 // Map string parameters to collections
@@ -18,6 +19,7 @@ const collections = {
   Clients: ClientModelAPI,
   Mediators: MediatorModelAPI,
   Users: UserModelAPI,
+  Passports: PassportModelAPI,
   ContactGroups: ContactGroupModelAPI,
   KeystoreModelAPI
 }
@@ -39,37 +41,35 @@ function removeProperties(obj) {
 
 // Function to return unique identifier key and value for a collection
 function getUniqueIdentifierForCollection(collection, doc) {
-  let uid
-  let uidKey
+  const returnObj = {}
+
   switch (collection) {
     case 'Channels':
-      uidKey = 'name'
-      uid = doc.name
+      returnObj['name'] = doc.name
       break
     case 'Clients':
-      uidKey = 'clientID'
-      uid = doc.clientID
+      returnObj['clientID'] = doc.clientID
       break
     case 'Mediators':
-      uidKey = 'urn'
-      uid = doc.urn
+      returnObj['urn'] = doc.urn
       break
     case 'Users':
-      uidKey = 'email'
-      uid = doc.email
+      returnObj['email'] = doc.email
+      break
+    case 'Passports':
+      returnObj['protocol'] = doc.protocol
+      returnObj['email'] = doc.email
       break
     case 'ContactGroups':
-      uidKey = 'groups'
-      uid = doc.groups
+      returnObj['groups'] = doc.groups
       break
     default:
       logger.debug(
         `Unhandeled case for ${collection} in getUniqueIdentifierForCollection`
       )
       break
   }
-  const returnObj = {}
-  returnObj[uidKey] = uid
+
   return returnObj
 }
 

src/api/users.js

@@ -87,7 +87,7 @@ export async function authenticateToken(ctx, email) {
     } else {
       const passport = await PassportModelAPI.findOne({
         protocol: 'token',
-        user: user.id
+        email: user.email
       })
 
       if (!passport) {

src/model/passport.js

@@ -68,8 +68,11 @@ const PassportSchema = new Schema({
 
   // Associations
   //
-  // Associate every passport with one, and only one, user.
-  user: {type: Schema.Types.ObjectId, ref: 'User'}
+  // Associate every passport with a user.
+  email: {
+    type: String,
+    required: true
+  }
 })
 
 // compile the Passport Schema into a Model
@@ -90,7 +93,7 @@ export const createPassport = async function (user, passwordInfo) {
   let result = {error: null, user: null}
   return await PassportModelAPI.create({
     protocol: passwordInfo.password ? 'local' : 'token',
-    user: user.id,
+    email: user.email,
     ...passwordInfo
   })
     .then(async function () {

src/model/users.js

@@ -117,7 +117,7 @@ export const updateUser = async function (newUserData) {
         if (password) {
           await PassportModelAPI.findOne({
             protocol: 'local',
-            user: user.id
+            email: user.email
           }).then(async function (passport) {
             if (passport) {
               passport.password = password
@@ -174,7 +174,7 @@ export const updateTokenUser = async function (newUserData) {
       if (passwordHash && passwordAlgorithm && passwordSalt) {
         await PassportModelAPI.findOne({
           protocol: 'token',
-          user: user.id
+          email: user.email
         }).then(async function (passport) {
           if (passport) {
             passport.passwordHash = passwordHash

src/protocols/local.js

@@ -33,7 +33,7 @@ export const login = async function (email, password, next) {
       }
       return PassportModelAPI.findOne({
         protocol: user.provider === 'token' ? 'token' : 'local',
-        user: user.id
+        email: user.email
       })
         .then(function (passport) {
           if (passport) {

src/protocols/openid.js

@@ -94,7 +94,8 @@ export const login = async (
     tokens,
     issuer,
     identifier: identifier,
-    protocol: 'openid'
+    protocol: 'openid',
+    email: user.email
   }
 
   PassportModelAPI.findOne({
@@ -111,10 +112,7 @@ export const login = async (
           return createOrUpdateUser(user)
             .then(function (retrievedUser) {
               return PassportModelAPI.create(
-                {
-                  user: retrievedUser.id,
-                  ...newPassport
-                },
+                newPassport,
                 function () {
                   next(null, retrievedUser)
                 }

src/protocols/token.js

@@ -82,7 +82,7 @@ export const login = async function (req, next) {
 
     const passport = await PassportModelAPI.findOne({
       protocol: 'token',
-      user: user.id
+      email: user.email
     })
 
     if (passport == null) {

src/upgradeDB.js

@@ -252,7 +252,7 @@ upgradeFuncs.push({
               passwordHash: user.passwordHash,
               passwordAlgorithm: user.passwordAlgorithm,
               passwordSalt: user.passwordSalt,
-              user: user.id,
+              email: user.email,
               protocol: 'token'
             }
 

test/integration/metadataAPITests.js

@@ -16,6 +16,7 @@ import {ClientModelAPI} from '../../src/model/clients'
 import {ContactGroupModelAPI} from '../../src/model/contactGroups'
 import {MediatorModelAPI} from '../../src/model/mediators'
 import {UserModelAPI} from '../../src/model/users'
+import {PassportModelAPI} from '../../src/model/passport'
 import * as polling from '../../src/polling'
 
 const sampleMetadata = {
@@ -89,6 +90,12 @@ const sampleMetadata = {
       groups: ['admin', 'RHIE']
     }
   ],
+  Passports: [
+    {
+      email: '[email protected]',
+      protocol: 'local'
+    }
+  ],
   ContactGroups: [
     {
       group: 'Group 1',
@@ -101,6 +108,11 @@ const sampleMetadata = {
         {user: 'User 6', method: 'email', maxAlerts: '1 per day'}
       ]
     }
+  ],
+  Keystore: [
+    {
+      key: 'Key'
+    }
   ]
 }
 
@@ -112,6 +124,7 @@ describe('API Integration Tests', () => {
       nonRootCookie = ''
 
     before(async () => {
+      await PassportModelAPI.deleteMany({})
       await promisify(server.start)({apiPort: SERVER_PORTS.apiPort})
       await testUtils.setupTestUsers()
     })
@@ -216,6 +229,17 @@ describe('API Integration Tests', () => {
         })
       })
 
+      describe('Passports', () => {
+        it('should fetch passports and return status 200', async () => {
+          const res = await request(BASE_URL)
+            .get('/metadata')
+            .set('Cookie', rootCookie)
+            .expect(200)
+
+          res.body[0].Passports.length.should.equal(2)
+        })
+      })
+
       describe('ContactGroups', () => {
         beforeEach(async () => {
           await new ContactGroupModelAPI(sampleMetadata.ContactGroups[0]).save()
@@ -724,10 +748,103 @@ describe('API Integration Tests', () => {
     // POST TO VALIDATE METADATA TESTS
     describe('*validateMetadata', () => {
       beforeEach(async () => {
+        await PassportModelAPI.deleteMany()
         await testUtils.cleanupAllTestUsers()
         await testUtils.setupTestUsers()
       })
 
+      const sampleMetadata = {
+        Channels: [
+          {
+            name: 'TestChannel1',
+            urlPattern: 'test/sample',
+            allow: ['PoC', 'Test1', 'Test2'],
+            routes: [
+              {name: 'test route', host: 'localhost', port: 9876, primary: true}
+            ],
+            txViewAcl: 'group1',
+            updatedBy: {
+              id: new ObjectId(),
+              name: 'Test'
+            }
+          }
+        ],
+        Clients: [
+          {
+            clientID: 'YUIAIIIICIIAIA',
+            clientDomain: 'him.jembi.org',
+            name: 'OpenMRS Ishmael instance',
+            roles: ['OpenMRS_PoC', 'PoC'],
+            passwordHash:
+              '$2a$10$w8GyqInkl72LMIQNpMM/fenF6VsVukyya.c6fh/GRtrKq05C2.Zgy',
+            certFingerprint:
+              '23:37:6A:5E:A9:13:A4:8C:66:C5:BB:9F:0E:0D:68:9B:99:80:10:FC'
+          }
+        ],
+        Mediators: [
+          {
+            urn: 'urn:uuid:EEA84E13-1C92-467C-B0BD-7C480462D1ED',
+            version: '1.0.0',
+            name: 'Save Encounter Mediator',
+            description: 'A mediator for testing',
+            endpoints: [
+              {
+                name: 'Save Encounter',
+                host: 'localhost',
+                port: '8005',
+                type: 'http'
+              }
+            ],
+            defaultChannelConfig: [
+              {
+                name: 'Save Encounter 1',
+                urlPattern: '/encounters',
+                type: 'http',
+                allow: [],
+                routes: [
+                  {
+                    name: 'Save Encounter 1',
+                    host: 'localhost',
+                    port: '8005',
+                    type: 'http'
+                  }
+                ]
+              }
+            ]
+          }
+        ],
+        Users: [
+          {
+            firstname: 'Namey',
+            surname: 'mcTestName',
+            email: '[email protected]',
+            passwordAlgorithm: 'sha512',
+            passwordHash: '796a5a8e-4e44-4d9f-9e04-c27ec6374ffa',
+            passwordSalt: 'bf93caba-6eec-4c0c-a1a3-d968a7533fd7',
+            groups: ['admin', 'RHIE']
+          }
+        ],
+        Passports: [
+          {
+            email: '[email protected]',
+            protocol: 'local'
+          }
+        ],
+        ContactGroups: [
+          {
+            group: 'Group 1',
+            users: [
+              {user: 'User 1', method: 'sms', maxAlerts: 'no max'},
+              {user: 'User 2', method: 'email', maxAlerts: '1 per hour'},
+              {user: 'User 3', method: 'sms', maxAlerts: '1 per day'},
+              {user: 'User 4', method: 'email', maxAlerts: 'no max'},
+              {user: 'User 5', method: 'sms', maxAlerts: '1 per hour'},
+              {user: 'User 6', method: 'email', maxAlerts: '1 per day'}
+            ]
+          }
+        ]
+      }
+
       it('should validate metadata and return status 201', async () => {
         const res = await request(BASE_URL)
           .post('/metadata/validate')
@@ -741,7 +858,7 @@ describe('API Integration Tests', () => {
           statusCheckObj[doc.status] += 1
         }
 
-        statusCheckObj.Valid.should.equal(5)
+        statusCheckObj.Valid.should.equal(6)
         statusCheckObj.Conflict.should.equal(0)
         statusCheckObj.Error.should.equal(0)
       })
@@ -762,7 +879,7 @@ describe('API Integration Tests', () => {
           statusCheckObj[doc.status] += 1
         }
 
-        statusCheckObj.Valid.should.equal(4)
+        statusCheckObj.Valid.should.equal(5)
         statusCheckObj.Conflict.should.equal(0)
         statusCheckObj.Error.should.equal(1)
       })
@@ -787,7 +904,7 @@ describe('API Integration Tests', () => {
           statusCheckObj[doc.status] += 1
         }
 
-        statusCheckObj.Valid.should.equal(4)
+        statusCheckObj.Valid.should.equal(5)
         statusCheckObj.Conflict.should.equal(1)
         statusCheckObj.Error.should.equal(0)
         ChannelModelAPI.deleteMany({})