@jrs/orders-guardian-common

Order Worker Common NPM Module

This contains all the comm

Environment Setup

1. Clone the repository from the Carekinesis Gitlab repository

git clone git.carekinesis.net:cpdr/orders-guardian-common.git

2. Install all the needed dependencies

npm install

3. Run the test suite.

npm run test

4. Success!

Publishing an npm update

This is done automatically every time a change is merged into the develop branch via Jenkins. If it doesn't happen immediately, kick off a new build here.

Usage of npm module

1.) Install the component in your project

npm i --save @jrs/orders-guardian-common

From here there are multiple components that can be used

Logger

const { logger } = require('@jrs/orders-guardian-common')

This is a simple Winston logger that provides a common format to be used across the multiple orders workers

Rabbit Configs

const Rascal = require('rascal')
const { rabbitConfig, rabbitTestConfig } = require('@jrs/orders-guardian-common')
const config = Rascal.withDefaultConfig(rabbitConfig)
Rascal.Broker.create(config, async (err, broker) => {
	// rascal pubs and subs
})

This config contains the RabbitMQ configuration as used by rascal. It contains all the exchanges, queues, bindings, publications, and subscriptions that are required by the orders team.

Schema Validation (Guardian Message)

const { schemaForGuardianMessage, guardianMessageValidator } = require('@jrs/orders-guardian-common')

This contains the schema validation (provided by Joi) for the message coming from the polling worker from Guardian

Schema Validation (Biointellisense Message)

const { schemaForBioMessage, bioMessageValidator } = require('@jrs/orders-guardian-common')

This contains the schema validation (provided by Joi) for the going to Biointellisense from the HTTP orders worker

Sequence Diagram