@mojaloop/central-services-shared 17.6.0 → 17.6.2

package/.circleci/config.yml

@@ -7,22 +7,21 @@ version: 2.1
 # Orbs used in this pipeline
 ##
 orbs:
-  slack: circleci/slack@4.9.3 # Ref: https://github.com/mojaloop/ci-config/tree/master/slack-templates
+  slack: circleci/slack@4.12.5 # Ref: https://github.com/mojaloop/ci-config/tree/master/slack-templates
   pr-tools: mojaloop/pr-tools@0.1.10 # Ref: https://github.com/mojaloop/ci-config/
-  gh: circleci/github-cli@2.1.0
+  gh: circleci/github-cli@2.2.0
 
 ##
 # defaults
 #
 # YAML defaults templates, in alphabetical order
 ##
-defaults_Dependencies: &defaults_Dependencies |
+defaults_docker_Dependencies: &defaults_docker_Dependencies |
     apk --no-cache add git
     apk --no-cache add ca-certificates
     apk --no-cache add curl
     apk --no-cache add openssh-client
-    apk add --no-cache -t build-dependencies make gcc g++ python3 libtool autoconf automake jq
-    npm config set unsafe-perm true
+    apk add --no-cache -t build-dependencies make gcc g++ python3 libtool autoconf automake jq bash
     npm install -g node-gyp
 
 defaults_awsCliDependencies: &defaults_awsCliDependencies |
@@ -59,6 +58,62 @@ defaults_configure_git: &defaults_configure_git
     git config user.email ${GIT_CI_EMAIL}
     git config user.name ${GIT_CI_USER}
 
+defaults_configure_nvm: &defaults_configure_nvm
+  name: Configure NVM
+  command: |
+    cd $HOME
+
+    export ENV_DOT_PROFILE=$HOME/.profile
+    touch $ENV_DOT_PROFILE
+
+    echo "1. Export env variable"
+    export NVM_DIR="$HOME/.nvm"
+    if [ -z "$NVMRC_VERSION" ]; then
+      echo "==> Configuring NVMRC_VERSION!"
+      export NVMRC_VERSION=$(cat $CIRCLE_WORKING_DIRECTORY/.nvmrc)
+      echo "export NVMRC_VERSION=$NVMRC_VERSION" >> $ENV_DOT_PROFILE
+    fi
+
+    if [ -f "$NVM_DIR" ]; then
+      echo "==> $NVM_DIR exists. Skipping steps 2-4!"
+    else 
+      echo "==> $NVM_DIR does not exists. Executing steps 2-4!"
+
+      echo "2. Installing NVM"
+      curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.3/install.sh | bash
+
+      echo "3. Executing $NVM_DIR/nvm.sh"
+      [ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"
+
+      # echo "4. Update $ENV_DOT_PROFILE"
+      # echo '[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"' >> $ENV_DOT_PROFILE
+      # echo "export NVM_DIR=$NVM_DIR" >> $ENV_DOT_PROFILE
+    fi
+
+    ## Ref: https://github.com/nvm-sh/nvm/issues/1102#issuecomment-550572252
+    if [ ! -z "$NVM_ARCH_UNOFFICIAL_OVERRIDE" ]; then
+      echo "==> Handle NVM_ARCH_UNOFFICIAL_OVERRIDE=$NVM_ARCH_UNOFFICIAL_OVERRIDE!"
+      echo "nvm_get_arch() { nvm_echo \"${NVM_ARCH_UNOFFICIAL_OVERRIDE}\"; }" >> $ENV_DOT_PROFILE
+      echo "export NVM_NODEJS_ORG_MIRROR=https://unofficial-builds.nodejs.org/download/release" >> $ENV_DOT_PROFILE
+      source $ENV_DOT_PROFILE
+    fi
+
+    echo "4. Installing Node version: $NVMRC_VERSION"
+    nvm install $NVMRC_VERSION
+    nvm alias default $NVMRC_VERSION
+    nvm use $NVMRC_VERSION
+
+    cd $CIRCLE_WORKING_DIRECTORY
+
+defaults_display_versions: &defaults_display_versions
+  name: Display Versions
+  command: |
+    echo "What is the active version of Nodejs?"
+    echo "node: $(node --version)"
+    echo "yarn: $(yarn --version)"
+    echo "npm: $(npm --version)"
+    echo "nvm: $(nvm --version)"
+
 ##
 # Executors
 #
@@ -67,13 +122,18 @@ defaults_configure_git: &defaults_configure_git
 executors:
   default-docker:
     working_directory: &WORKING_DIR /home/circleci/project
+    shell: "/bin/sh -leo pipefail" ## Ref: https://circleci.com/docs/env-vars/#alpine-linux
+    environment:
+      BASH_ENV: /etc/profile ## Ref: https://circleci.com/docs/env-vars/#alpine-linux
+      NVM_ARCH_UNOFFICIAL_OVERRIDE: x64-musl ## Ref: https://github.com/nvm-sh/nvm/issues/1102#issuecomment-550572252
     docker:
-      - image: node:16.15.0-alpine
+      - image: node:lts-alpine
 
   default-machine:
     working_directory: *WORKING_DIR
+    shell: "/bin/bash -leo pipefail"
     machine:
-      image: ubuntu-2004:current
+      image: ubuntu-2204:2023.04.2 # Ref: https://circleci.com/developer/machine/image/ubuntu-2204
 
 jobs:
   setup:
@@ -81,10 +141,14 @@ jobs:
     steps:
       - run:
           name: Install general dependencies
-          command: *defaults_Dependencies
+          command: *defaults_docker_Dependencies
       - checkout
       - run:
-          name: Update NPM install
+          <<: *defaults_configure_nvm
+      - run:
+          <<: *defaults_display_versions
+      - run:
+          name: Install NPM dependencies
           command: npm ci
       - save_cache:
           key: dependency-cache-{{ .Environment.CIRCLE_SHA1 }}
@@ -96,8 +160,12 @@ jobs:
     steps:
       - run:
           name: Install general dependencies
-          command: *defaults_Dependencies
+          command: *defaults_docker_Dependencies
       - checkout
+      - run:
+          <<: *defaults_configure_nvm
+      - run:
+          <<: *defaults_display_versions
       - restore_cache:
           key: dependency-cache-{{ .Environment.CIRCLE_SHA1 }}
       - run:
@@ -109,8 +177,12 @@ jobs:
     steps:
       - run:
           name: Install general dependencies
-          command: *defaults_Dependencies
+          command: *defaults_docker_Dependencies
       - checkout
+      - run:
+          <<: *defaults_configure_nvm
+      - run:
+          <<: *defaults_display_versions
       - restore_cache:
           key: dependency-cache-{{ .Environment.CIRCLE_SHA1 }}
       - run:
@@ -122,8 +194,12 @@ jobs:
     steps:
       - run:
           name: Install general dependencies
-          command: *defaults_Dependencies
+          command: *defaults_docker_Dependencies
       - checkout
+      - run:
+          <<: *defaults_configure_nvm
+      - run:
+          <<: *defaults_display_versions
       - restore_cache:
           key: dependency-cache-{{ .Environment.CIRCLE_SHA1 }}
       - run:
@@ -138,7 +214,7 @@ jobs:
           command: npm -s run test:xunit
       - store_artifacts:
           path: ./test/results
-          prefix: test
+          destination: test
       - store_test_results:
           path: ./test/results
 
@@ -147,11 +223,15 @@ jobs:
     steps:
       - run:
           name: Install general dependencies
-          command: *defaults_Dependencies
+          command: *defaults_docker_Dependencies
       - run:
           name: Install AWS CLI dependencies
           command: *defaults_awsCliDependencies
       - checkout
+      - run:
+          <<: *defaults_configure_nvm
+      - run:
+          <<: *defaults_display_versions
       - restore_cache:
           key: dependency-cache-{{ .Environment.CIRCLE_SHA1 }}
       - run:
@@ -159,27 +239,21 @@ jobs:
           command: npm -s run test:coverage-check
       - store_artifacts:
           path: coverage
-          prefix: test
+          destination: test
       - store_test_results:
           path: coverage
-      - run:
-          name: Copy code coverage to SonarQube
-          command: |
-            if [ "${CIRCLE_BRANCH}" == "master" ];
-            then
-                echo "Sending lcov.info to SonarQube..."
-                aws s3 cp coverage/lcov.info $AWS_S3_DIR_SONARQUBE/${CIRCLE_PROJECT_REPONAME}/lcov.info
-            else
-                echo "Not a release (env CIRCLE_BRANCH != 'master'), skipping sending lcov.info to SonarQube."
-            fi
 
   vulnerability-check:
     executor: default-docker
     steps:
       - run:
           name: Install general dependencies
-          command: *defaults_Dependencies
+          command: *defaults_docker_Dependencies
       - checkout
+      - run:
+          <<: *defaults_configure_nvm
+      - run:
+          <<: *defaults_display_versions
       - restore_cache:
           key: dependency-cache-{{ .Environment.CIRCLE_SHA1 }}
       - run:
@@ -190,14 +264,14 @@ jobs:
           command: npm run audit:check -- -o json > ./audit/results/auditResults.json
       - store_artifacts:
           path: ./audit/results
-          prefix: audit
+          destination: audit
 
   audit-licenses:
     executor: default-docker
     steps:
       - run:
           name: Install general dependencies
-          command: *defaults_Dependencies
+          command: *defaults_docker_Dependencies
       - run:
           <<: *defaults_license_scanner
       - checkout
@@ -208,14 +282,14 @@ jobs:
           command: cd /tmp/license-scanner && pathToRepo=$CIRCLE_WORKING_DIRECTORY make run
       - store_artifacts:
           path: /tmp/license-scanner/results
-          prefix: licenses
+          destination: licenses
 
   release:
     executor: default-docker
     steps:
       - run:
           name: Install general dependencies
-          command: *defaults_Dependencies
+          command: *defaults_docker_Dependencies
       - checkout
       - restore_cache:
           keys:
@@ -242,6 +316,7 @@ jobs:
 
   github-release:
     executor: default-machine
+    shell: "/bin/bash -eo pipefail"
     steps:
       - run:
           name: Install git
@@ -287,7 +362,7 @@ jobs:
     steps:
       - run:
           name: Install general dependencies
-          command: *defaults_Dependencies
+          command: *defaults_docker_Dependencies
       - checkout
       - restore_cache:
           key: dependency-cache-{{ .Environment.CIRCLE_SHA1 }}
@@ -325,7 +400,7 @@ jobs:
     steps:
       - run:
           name: Install general dependencies
-          command: *defaults_Dependencies
+          command: *defaults_docker_Dependencies
       - checkout
       - restore_cache:
           key: dependency-cache-{{ .Environment.CIRCLE_SHA1 }}
@@ -362,7 +437,6 @@ jobs:
           template: SLACK_TEMP_RELEASE_FAILURE
 
 workflows:
-  version: 2
   build_and_test:
     jobs:
       - pr-tools/pr-title-check:

package/.nvmrc

@@ -1 +1 @@
-16.15.0
+18.17.1

package/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [17.6.2](https://github.com/mojaloop/central-services-shared/compare/v17.6.1...v17.6.2) (2023-08-24)
+
+### [17.6.1](https://github.com/mojaloop/central-services-shared/compare/v17.6.0...v17.6.1) (2023-08-17)
+
 ## [17.6.0](https://github.com/mojaloop/central-services-shared/compare/v17.5.3...v17.6.0) (2023-08-17)
 
 

package/audit-ci.jsonc

@@ -9,20 +9,9 @@
     "GHSA-phwq-j96m-2c2q",
     "GHSA-282f-qqgm-c34q",
     "GHSA-6vfc-qv3f-vr6c",
-    "GHSA-6vfc-qv3f-vr6c",
-    "GHSA-wc69-rhjr-hc9g",
-    "GHSA-g954-5hwp-pp24",
-    "GHSA-g954-5hwp-pp24",
     "GHSA-mjxr-4v3x-q3m4",
     "GHSA-rjqq-98f6-6j3r",
     "GHSA-w5p7-h5w8-2hfq",
-    "GHSA-p9pc-299p-vxgp",
-    // TODO: There is a conflict with the sub-dependency jsonwebtoken. Not able to fix with 'npm audit fix'. Need too investigate the root cause.
-    "GHSA-hjrf-2m68-5959",
-    "GHSA-8cf7-32gw-wr33",
-    "GHSA-qwph-4952-7xr6",
-    "GHSA-27h2-hvpr-p74q",
-    "GHSA-h755-8qp9-cq85", // https://github.com/advisories/GHSA-h755-8qp9-cq85
-    "GHSA-c2qf-rxjj-qqgw"  // https://github.com/advisories/GHSA-c2qf-rxjj-qqgw
+    "GHSA-p9pc-299p-vxgp"
   ]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mojaloop/central-services-shared",
-  "version": "17.6.0",
+  "version": "17.6.2",
   "description": "Shared code for mojaloop central services",
   "license": "Apache-2.0",
   "author": "ModusBox",
@@ -24,9 +24,6 @@
   ],
   "main": "src/index.js",
   "types": "src/index.d.ts",
-  "engines": {
-    "node": "=16.x"
-  },
   "imports": {
     "#src/*": "./src/*.js",
     "#test/*": "./test/*.js"
@@ -60,9 +57,9 @@
     "axios": "1.4.0",
     "clone": "2.1.2",
     "dotenv": "16.3.1",
-    "env-var": "7.3.1",
+    "env-var": "7.4.0",
     "event-stream": "4.0.1",
-    "immutable": "4.3.2",
+    "immutable": "4.3.3",
     "lodash": "4.17.21",
     "mustache": "4.2.0",
     "openapi-backend": "5.9.2",
@@ -79,7 +76,7 @@
     "audit-ci": "^6.6.1",
     "base64url": "3.0.1",
     "chance": "1.1.11",
-    "npm-check-updates": "16.12.1",
+    "npm-check-updates": "16.13.1",
     "nyc": "15.1.0",
     "pre-commit": "1.2.2",
     "proxyquire": "2.1.3",
@@ -94,10 +91,10 @@
     "tapes": "4.1.0"
   },
   "peerDependencies": {
-    "@mojaloop/central-services-error-handling": "12.x.x",
-    "@mojaloop/central-services-logger": "11.x.x",
-    "@mojaloop/central-services-metrics": "12.x.x",
-    "@mojaloop/event-sdk": "11.x.x",
+    "@mojaloop/central-services-error-handling": ">=12.x.x",
+    "@mojaloop/central-services-logger": ">=11.x.x",
+    "@mojaloop/central-services-metrics": ">=12.x.x",
+    "@mojaloop/event-sdk": ">=12.x.x",
     "ajv": "8.x.x",
     "ajv-keywords": "5.x.x"
   },

package/src/util/endpoints.js

@@ -51,7 +51,7 @@ let switchEndpoint
  */
 const fetchEndpoints = async (fsp) => {
   try {
-    Logger.isInfoEnabled && Logger.info(`[fsp=${fsp}] ~ participantEndpointCache::fetchEndpoints := Refreshing the cache for FSP: ${fsp}`)
+    Logger.isDebugEnabled && Logger.debug(`[fsp=${fsp}] ~ participantEndpointCache::fetchEndpoints := Refreshing the cache for FSP: ${fsp}`)
     const defaultHeaders = Http.SwitchDefaultHeaders(Enum.Http.HeaderResources.SWITCH, Enum.Http.HeaderResources.PARTICIPANTS, Enum.Http.HeaderResources.SWITCH)
     const url = Mustache.render(switchEndpoint + Enum.EndPoints.FspEndpointTemplates.PARTICIPANT_ENDPOINTS_GET, { fsp })
     Logger.isDebugEnabled && Logger.debug(`[fsp=${fsp}] ~ participantEndpointCache::fetchEndpoints := URL for FSP: ${url}`)
@@ -86,13 +86,13 @@ const fetchEndpoints = async (fsp) => {
  */
 exports.initializeCache = async (policyOptions) => {
   try {
-    Logger.isInfoEnabled && Logger.info(`participantEndpointCache::initializeCache::start::clientOptions - ${JSON.stringify(clientOptions)}`)
+    Logger.isDebugEnabled && Logger.debug(`participantEndpointCache::initializeCache::start::clientOptions - ${JSON.stringify(clientOptions)}`)
     client = new Catbox.Client(CatboxMemory, clientOptions)
     await client.start()
     policyOptions.generateFunc = fetchEndpoints
-    Logger.isInfoEnabled && Logger.info(`participantEndpointCache::initializeCache::start::policyOptions - ${JSON.stringify(policyOptions)}`)
+    Logger.isDebugEnabled && Logger.debug(`participantEndpointCache::initializeCache::start::policyOptions - ${JSON.stringify(policyOptions)}`)
     policy = new Catbox.Policy(policyOptions, client, partition)
-    Logger.isInfoEnabled && Logger.info('participantEndpointCache::initializeCache::Cache initialized successfully')
+    Logger.isDebugEnabled && Logger.debug('participantEndpointCache::initializeCache::Cache initialized successfully')
     return true
   } catch (err) {
     Logger.isErrorEnabled && Logger.error(`participantEndpointCache::Cache error:: ERROR:'${err}'`)
@@ -114,7 +114,7 @@ exports.initializeCache = async (policyOptions) => {
  */
 exports.getEndpoint = async (switchUrl, fsp, endpointType, options = {}) => {
   switchEndpoint = switchUrl
-  Logger.isInfoEnabled && Logger.info(`participantEndpointCache::getEndpoint::endpointType - ${endpointType}`)
+  Logger.isDebugEnabled && Logger.debug(`participantEndpointCache::getEndpoint::endpointType - ${endpointType}`)
   try {
     const endpoints = await policy.get(fsp)
     return Mustache.render(new Map(endpoints).get(endpointType), options)
@@ -139,7 +139,7 @@ exports.getEndpoint = async (switchUrl, fsp, endpointType, options = {}) => {
  */
 exports.getEndpointAndRender = async (switchUrl, fsp, endpointType, path = '', options) => {
   switchEndpoint = switchUrl
-  Logger.isInfoEnabled && Logger.info(`participantEndpointCache::getEndpointAndRender::endpointType - ${endpointType}`)
+  Logger.isDebugEnabled && Logger.debug(`participantEndpointCache::getEndpointAndRender::endpointType - ${endpointType}`)
   try {
     const endpoints = await policy.get(fsp)
     const endpoint = new Map(endpoints).get(endpointType)
@@ -159,6 +159,6 @@ exports.getEndpointAndRender = async (switchUrl, fsp, endpointType, path = '', o
  * @returns {boolean} - Returns the status
  */
 exports.stopCache = async () => {
-  Logger.isInfoEnabled && Logger.info('participantEndpointCache::stopCache::Stopping the cache')
+  Logger.isDebugEnabled && Logger.debug('participantEndpointCache::stopCache::Stopping the cache')
   return client.stop()
 }

package/src/util/kafka/index.js

@@ -276,7 +276,7 @@ const commitMessageSync = async (kafkaConsumer, kafkaTopic, message) => {
       const consumer = kafkaConsumer.getConsumer(kafkaTopic)
       await consumer.commitMessageSync(message)
     } catch (err) {
-      Logger.isInfoEnabled && Logger.info(`No consumer found for topic ${kafkaTopic}`)
+      Logger.isDebugEnabled && Logger.debug(`No consumer found for topic ${kafkaTopic}`)
       Logger.isErrorEnabled && Logger.error(err)
       throw err
     }