als-oracle-pathfinder

An Account Lookup Service Oracle using GSMA PathFinder for resolution of MSISDNs.

Code is based on the Mojaloop ALS Oracle Template.

Notes:

• You need to supply your own PathFinder TLS keys via a k8s Secret for this service to work properly. For more information check the volumeMounts property of deployment.yaml of the mojaloop/helm repository. The paths to these keys are defined in the src/config.js file under the property secrets.

• In order to execute the PathFinder tests, you'll need to supply the secrets in

      ./src/lib/pathfinder/secrets_test

Container Scans

As part of our CI/CD process, we use anchore-cli to scan our built docker container for vulnerabilities upon release.

If you find your release builds are failing, refer to the container scanning in our shared Mojaloop CI config repo. There is a good chance you simply need to update the mojaloop-policy-generator.js file and re-run the circleci workflow.

For more information on anchore and anchore-cli, refer to:

• Anchore CLI
• Circle Orb Registry

Auditing Dependencies

We use npm-audit-resolver along with npm audit to check dependencies for node vulnerabilities, and keep track of resolved dependencies with an audit-resolve.json file.

To start a new resolution process, run:

npm run audit:resolve

You can then check to see if the CI will pass based on the current dependencies with:

npm run audit:check

And commit the changed audit-resolve.json to ensure that CircleCI will build correctly.

Automated Releases

As part of our CI/CD process, we use a combination of CircleCI, standard-version npm package and github-release CircleCI orb to automatically trigger our releases and image builds. This process essentially mimics a manual tag and release.

On a merge to main, CircleCI is configured to use the mojaloopci github account to push the latest generated CHANGELOG and package version number.

Once those changes are pushed, CircleCI will pull the updated main, tag and push a release triggering another subsequent build that also publishes a docker image.

Potential problems

• There is a case where the merge to main workflow will resolve successfully, triggering a release. Then that tagged release workflow subsequently failing due to the image scan, audit check, vulnerability check or other "live" checks.

  This will leave main without an associated published build. Fixes that require a new merge will essentially cause a skip in version number or require a clean up of the main branch to the commit before the CHANGELOG and bump.

  This may be resolved by relying solely on the previous checks of the merge to main workflow to assume that our tagged release is of sound quality. We are still mulling over this solution since catching bugs/vulnerabilities/etc earlier is a boon.

• It is unknown if a race condition might occur with multiple merges with main in quick succession, but this is a suspected edge case.

Additional Notes

N/A

TODO

• pre-commit hook to run tests before commit (https://www.npmjs.com/package/pre-commit or DIY)
• go through and address all TODOs in pathfinder lib
• bring in openapi/header validation libs? hapi-openapi is considerably lacking
• if there is an error in server init, the server hangs forever. Try to throw an error from, for example, the db init method. This could be pretty annoying in production.
• Improve code-coverage to 90% across the board: .nycrc.yml.
• Update CI-CD to include unit and code-coverage checks.