feat(#138): move polling to openhim channel config

cht-config/package.json

@@ -13,7 +13,7 @@
     "test-targets": "npm run eslint && TZ=Africa/Nairobi mocha --reporter progress test/targets/*.spec.js --timeout 10000",
     "test-contact-summary": "npm run eslint && TZ=Africa/Nairobi mocha --reporter progress test/contact-summary/*.spec.js --timeout 10000",
     "test-unit": "TZ=Africa/Nairobi mocha --recursive --reporter spec test --timeout 20000",
-    "deploy": "wait-on http://api:5988/ && sleep 100 && sh ./script.sh"
+    "deploy": "wait-on http://api:5988/ && sh ./script.sh"
   },
   "devDependencies": {
     "chai": "^4.2.0",

docker/docker-compose.cht-core.yml

@@ -52,6 +52,8 @@ services:
       - COUCH_URL=http://${COUCHDB_USER:-admin}:${COUCHDB_PASSWORD:-password}@haproxy:${HAPROXY_PORT:-5984}/medic
       - BUILDS_URL=${MARKET_URL_READ:-https://staging.dev.medicmobile.org}/${BUILDS_SERVER:-_couch/builds_4}
       - UPGRADE_SERVICE_URL=${UPGRADE_SERVICE_URL:-http://localhost:5100}
+    ports:
+      - "5988:5988"
     logging:
       driver: "local"
       options:
@@ -117,6 +119,7 @@ services:
       - "COUCHDB_PASSWORD=${COUCHDB_PASSWORD:-password}"
     depends_on:
       - couchdb
+      - api
     networks:
       - cht-net
 

docker/docker-compose.mediator.yml

@@ -12,11 +12,11 @@ services:
       - "OPENHIM_API_URL=${OPENHIM_API_URL:-https://openhim-core:8080}"
       - "PORT=${PORT:-6000}"
       - "FHIR_URL=${FHIR_URL:-http://openhim-core:5001/fhir}"
-      - "FHIR_USERNAME=${MEDIATORS_USERNAME:-interop-client}"
-      - "FHIR_PASSWORD=${MEDIATORS_PASSWORD:-interop-password}"
-      - "OPENMRS_URL=${OPENMRS_CHANNEL_URL}"
-      - "OPENMRS_USERNAME=${MEDIATORS_USERNAME}"
-      - "OPENMRS_PASSWORD=${MEDIATORS_PASSWORD}"
+      - "FHIR_USERNAME=${FHIR_USERNAME:-interop-client}"
+      - "FHIR_PASSWORD=${FHIR_PASSWORD:-interop-password}"
+      - "OPENMRS_CHANNEL_URL=${OPENMRS_CHANNEL_URL:-http://openhim-core:5001/openmrs}"
+      - "OPENMRS_CHANNEL_USERNAME=${OPENMRS_CHANNEL_USERNAME:-interop-client}"
+      - "OPENMRS_CHANNEL_PASSWORD=${OPENMRS_CHANNEL_PASSWORD:-interop-password}"
       - "CHT_URL=${CHT_URL:-https://nginx}"
       - "CHT_USERNAME=${CHT_USERNAME:-admin}"
       - "CHT_PASSWORD=${CHT_PASSWORD:-password}"

mediator/config/index.ts

@@ -25,13 +25,16 @@ export const CHT = {
 };
 
 export const OPENMRS = {
-  url: getEnvironmentVariable('OPENMRS_URL', ''),
-  username: getEnvironmentVariable('OPENMRS_USERNAME', ''),
-  password: getEnvironmentVariable('OPENMRS_PASSWORD', ''),
+  url: getEnvironmentVariable('OPENMRS_CHANNEL_URL', 'http://openhim-core:5001/openmrs'),
+  username: getEnvironmentVariable('OPENMRS_CHANNEL_USERNAME', 'interop-client'),
+  password: getEnvironmentVariable('OPENMRS_CHANNEL_PASSWORD', 'interop-password'),
   timeout: Number(getEnvironmentVariable('REQUEST_TIMEOUT', '5000'))
 };
 
-export const SYNC_INTERVAL = getEnvironmentVariable('SYNC_INTERVAL', '60000');
+// hard code sync interval to 1 minute because it is hard coded in mediator config
+export const SYNC_INTERVAL = '60';
+// how far back shoudl the sync look for new resources
+export const SYNC_PERIOD = getEnvironmentVariable('SYNC_PERIOD', '3600');
 
 function getEnvironmentVariable(env: string, def: string) {
   if (process.env.NODE_ENV === 'test') {

mediator/config/openmrs_mediator.ts

@@ -3,11 +3,30 @@ export const openMRSMediatorConfig = {
   version: '1.0.0',
   name: 'OpenMRS Mediator',
   description: 'A mediator to sync CHT data with OpenMRS',
+  defaultChannelConfig: [
+    {
+      name: 'OpenMRS Sync',
+      urlPattern: '^/trigger$',
+      routes: [
+        {
+          name: 'OpenMRS polling Mediator',
+          host: 'mediator',
+          path: '/openmrs/sync',
+          port: 6000,
+          primary: true,
+          type: 'http',
+        },
+      ],
+      allow: ['interop'],
+      type: 'polling',
+      pollingSchedule: '1 minute'
+    },
+  ],
   endpoints: [
     {
       name: 'OpenMRS Mediator',
       host: 'mediator',
-      path: '/',
+      path: '/openmrs/sync',
       port: '6000',
       primary: true,
       type: 'http',

mediator/env.template

@@ -5,10 +5,12 @@ OPENHIM_API_URL = "https://openhim-core:8080"
 PORT = 6000
 
 FHIR_URL = http://openhim-core:5001/fhir
-OPENMRS_URL = http://openhim-core:5001/openmrs
+FHIR_USERNAME = interop-client
+FHIR_PASSWORD = interop-password
 
-MEDIATORS_USERNAME = interop-client
-MEDIATORS_PASSWORD = interop-password
+OPENMRS_CHANNEL_URL = http://openhim-core:5001/openmrs
+OPENMRS_CHANNEL_USERNAME = interop-client
+OPENMRS_CHANNEL_PASSWORD = interop-password
 
 CHT_URL = http://nginx
 CHT_USERNAME = admin

mediator/index.ts

@@ -3,15 +3,15 @@ import { mediatorConfig } from './config/mediator';
 import { openMRSMediatorConfig } from './config/openmrs_mediator';
 import { logger } from './logger';
 import bodyParser from 'body-parser';
-import {PORT, OPENHIM, SYNC_INTERVAL, OPENMRS} from './config';
+import {PORT, OPENHIM, OPENMRS} from './config';
 import patientRoutes from './src/routes/patient';
 import serviceRequestRoutes from './src/routes/service-request';
 import encounterRoutes from './src/routes/encounter';
 import organizationRoutes from './src/routes/organization';
 import endpointRoutes from './src/routes/endpoint';
 import chtRoutes from './src/routes/cht';
+import openMRSRoutes from './src/routes/openmrs';
 import { registerMediatorCallback } from './src/utils/openhim';
-import { syncPatients, syncEncounters } from './src/utils/openmrs_sync'
 import os from 'os';
 
 const {registerMediator} = require('openhim-mediator-utils');
@@ -21,11 +21,12 @@ const app = express();
 app.use(bodyParser.json());
 app.use(bodyParser.urlencoded({extended: true}));
 
+/*
 app.get('*', (_: Request, res: Response) => {
   const osUptime = os.uptime();
   const processUptime = process.uptime();
   res.send({status: 'success', osuptime: osUptime, processuptime: processUptime});
-});
+});*/
 
 // routes for valid fhir resources
 app.use('/patient', patientRoutes);
@@ -34,30 +35,21 @@ app.use('/encounter', encounterRoutes);
 app.use('/organization', organizationRoutes);
 app.use('/endpoint', endpointRoutes);
 
-// routes for cht docs
+// routes for CHT docs
 app.use('/cht', chtRoutes);
 
+// routes for OpenMRS
+app.use('/openmrs', openMRSRoutes);
+
 if (process.env.NODE_ENV !== 'test') {
   app.listen(PORT, () => logger.info(`Server listening on port ${PORT}`));
 
   // TODO => inject the 'port' and 'http scheme' into 'mediatorConfig'  
   registerMediator(OPENHIM, mediatorConfig, registerMediatorCallback);
 
   // if OPENMRS is specified, register its mediator
-  // and start the sync background task
   if (OPENMRS.url) {
     registerMediator(OPENHIM, openMRSMediatorConfig, registerMediatorCallback);
-    // start patient and ecnounter sync in the background
-    setInterval(async () => {
-      try {
-        const startTime = new Date();
-        startTime.setHours(startTime.getHours() - 1);
-        await syncPatients(startTime);
-        await syncEncounters(startTime);
-      } catch (error: any) {
-        logger.error(error);
-      }
-    }, Number(SYNC_INTERVAL));
   }
 }
 

mediator/src/controllers/cht.ts

@@ -22,18 +22,7 @@ export async function createPatient(chtPatientDoc: any) {
   }
 
   const fhirPatient = buildFhirPatientFromCht(chtPatientDoc.doc);
-  const patientResponse = await getFHIRPatientResource(fhirPatient.id || '');
-  if (patientResponse.status != 200){
-    // any error, just return it to caller
-    return patientResponse;
-  } else if (patientResponse.data.total > 0) {
-    // updates not currently supported
-    return patientResponse;
-  } else {
-    // create or update in the FHIR Server
-    // even for create, sends a PUT request
-    return updateFhirResource({ ...fhirPatient, resourceType: 'Patient' });
-  }
+  return updateFhirResource({ ...fhirPatient, resourceType: 'Patient' });
 }
 
 export async function updatePatientIds(chtFormDoc: any) {

mediator/src/controllers/openmrs.ts

@@ -0,0 +1,18 @@
+import { logger } from '../../logger';
+import { syncPatients, syncEncounters } from '../utils/openmrs_sync'
+import { SYNC_PERIOD } from '../../config'
+
+export async function sync() {
+  try {
+    let now = Date.now();
+    let syncPeriod = parseInt(SYNC_PERIOD, 10);
+    let startTime = new Date(now - syncPeriod);
+
+    await syncPatients(startTime);
+    await syncEncounters(startTime);
+    return { status: 200, data: { message: `OpenMRS sync completed successfully`} };
+  } catch(error: any) {
+    logger.error(error);
+    return { status: 500, data: { message: `Error during OpenMRS Sync`} };
+  }
+}

mediator/src/routes/openmrs.ts

@@ -0,0 +1,12 @@
+import { Router } from 'express';
+import { requestHandler } from '../utils/request';
+import { sync } from '../controllers/openmrs'
+
+const router = Router();
+
+router.get(
+  '/sync',
+  requestHandler((req) => sync())
+);
+
+export default router;

mediator/src/routes/tests/cht.spec.ts

@@ -9,10 +9,6 @@ jest.mock('axios');
 
 describe('POST /cht/patient', () => {
   it('accepts incoming request with valid patient resource', async () => {
-    jest.spyOn(fhir, 'getFHIRPatientResource').mockResolvedValueOnce({
-      data: {},
-      status: 200,
-    });
     jest.spyOn(fhir, 'updateFhirResource').mockResolvedValueOnce({
       data: {},
       status: 200,

mediator/src/routes/tests/openmrs.spec.ts

@@ -0,0 +1,35 @@
+import request from 'supertest';
+import app from '../../..';
+import * as openmrs_sync from '../../utils/openmrs_sync';
+import axios from 'axios';
+
+jest.mock('axios');
+
+describe('GET /openmrs/sync', () => {
+  it('calls syncPatients and syncEncouners', async () => {
+    jest.spyOn(openmrs_sync, 'syncPatients').mockImplementation(async (startTime) => {
+    });
+
+    jest.spyOn(openmrs_sync, 'syncEncounters').mockImplementation(async (startTime) => {
+    });
+
+    const res = await request(app).get('/openmrs/sync').send();
+
+    expect(res.status).toBe(200);
+
+    expect(openmrs_sync.syncPatients).toHaveBeenCalled();
+    expect(openmrs_sync.syncEncounters).toHaveBeenCalled();
+  });
+
+  it('returns 500 if syncPatients throws an error', async () => {
+    jest.spyOn(openmrs_sync, 'syncPatients').mockImplementation(async (startTime) => {
+      throw new Error('Sync Failed');
+    });
+
+    const res = await request(app).get('/openmrs/sync').send();
+
+    expect(res.status).toBe(500);
+
+    expect(openmrs_sync.syncPatients).toHaveBeenCalled();
+  });
+});

mediator/src/utils/fhir.ts

@@ -134,7 +134,7 @@ export function copyIdToNamedIdentifier(fromResource: any, toResource: fhir4.Pat
 }
 
 export function getIdType(resource: fhir4.Patient | fhir4.Encounter, idType: fhir4.CodeableConcept): string{
-  return resource?.identifier?.find((id: any) => id?.type.text == idType.text)?.value || '';
+  return resource?.identifier?.find((id: any) => id?.type?.text == idType.text)?.value || '';
 }
 
 export function addId(resource: fhir4.Patient | fhir4.Encounter, idType: fhir4.CodeableConcept, value: string){

mediator/src/utils/openmrs.ts

@@ -1,12 +1,16 @@
 import { OPENMRS } from '../../config';
 import axios from 'axios';
 import { logger } from '../../logger';
+import https from 'https';
 
 const axiosOptions = {
   auth: {
     username: OPENMRS.username,
     password: OPENMRS.password,
   },
+  httpsAgent: new https.Agent({
+    rejectUnauthorized: false,
+  }),
   timeout: OPENMRS.timeout
 };
 

mediator/src/utils/openmrs_sync.ts

@@ -83,6 +83,9 @@ export async function compare(
   // get the key for each resource and create a Map
   const fhirIds = new Map(comparison.fhirResources.map(resource => [getKey(resource), resource]));
 
+  // dont sync resources created with 2 * SYNC_INTERVAL of start time
+  let syncWindow = (Number(SYNC_INTERVAL) * 1000) * 2
+
   comparison.openMRSResources.forEach((openMRSResource) => {
     const key = getKey(openMRSResource);
     if (fhirIds.has(key)) {
@@ -95,7 +98,7 @@ export async function compare(
         throw new Error("Invalid date format");
       }
       const diff = lastUpdated.getTime() - startTime.getTime();
-      if (diff > (Number(SYNC_INTERVAL) * 2)){
+      if (diff > syncWindow){
         results.incoming.push(openMRSResource);
       }
     }
@@ -107,7 +110,7 @@ export async function compare(
       throw new Error("Invalid date format");
     }
     const diff = lastUpdated.getTime() - startTime.getTime();
-    if (diff > (Number(SYNC_INTERVAL) * 2)){
+    if (diff > syncWindow){
       results.outgoing.push(resource);
     }
   });

mediator/test/e2e-test.sh

@@ -6,6 +6,10 @@ MEDIATORDIR="${BASEDIR}/mediator"
 export NODE_ENV=integration
 export NODE_TLS_REJECT_UNAUTHORIZED=0
 
+export OPENMRS_HOST=openmrs
+export OPENMRS_USERNAME=admin
+export OPENMRS_PASSWORD=Admin123
+
 # Cleanup from last test, in case of interruptions
 cd $BASEDIR
 ./startup.sh destroy
@@ -29,14 +33,20 @@ export FHIR_USERNAME='interop-client'
 export FHIR_PASSWORD='interop-password'
 export CHT_USERNAME='admin'
 export CHT_PASSWORD='password'
-export OPENMRS_URL='http://openhim-core:5001/openmrs'
-export OPENMRS_USERNAME='interop-client'
-export OPENMRS_PASSWORD='interop-password'
+export OPENMRS_CHANNEL_URL='http://localhost:5001/openmrs'
+export OPENMRS_CHANNEL_USERNAME='interop-client'
+export OPENMRS_CHANNEL_PASSWORD='interop-password'
+
+echo 'Waiting for OpenMRS to be ready'
+sleep 180
 npm run test -t workflows.spec.ts
 
 # Cleanup
 unset NODE_ENV
 unset NODE_TLS_REJECT_UNAUTHORIZED
+unset OPENMRS_HOST
+unset OPENMRS_USERNAME
+unset OPENMRS_PASSWORD
 unset OPENHIM_API_URL
 unset FHIR_URL
 unset CHT_URL
@@ -46,9 +56,8 @@ unset FHIR_USERNAME
 unset FHIR_PASSWORD
 unset CHT_USERNAME
 unset CHT_PASSWORD
-unset OPENMRS_URL
-unset OPENMRS_USERNAME
-unset OPENMRS_PASSWORD
+unset OPENMRS_CHANNEL_URL
+unset OPENMRS_CHANNEL_USERNAME
+unset OPENMRS_CHANNEL_PASSWORD
 cd $BASEDIR
 ./startup.sh destroy
-