Performance and scaling stubs

These stubs are owned by Orchestration for performance and scaling testing purposes.

There will be three stubs - one for Authentication, one for IPV, and one for SPOT. This will allow Orchestration to exercise different journeys, write Orchestration specific acceptance tests, execute Orchestration performance tests, and test IPV in lower environments.

Prerequisites

A version of SAM CLI (v1.120.0+) that supports Node.js version 20. See the AWS SAM CLI installation guide.

Build

To build the app

npm run build

Start

To start the app locally (requires Docker)

npm run build && npm run start:local

Clean Build

To clean build the app (try if you encounter issues re-running build)

npm run clean && npm run build

Private and public keys

Private and public keys are be needed for decryption and signature validation.

The local private key (in parameters.json) has been commited deliberately. The key pair was generated fresh and should only be used for testing, both locally and as part of the pre-merge GitHub workflow.

In deployed environments, the private key will be retrieved from AWS Secrets Manager, and the public key from AWS Parameter Store. This key pair is different from the one which has been commited here.

Formatting and Linting

Scripts

To check

npm run check; # Check all
npm run check:lint; # Check linting
npm run check:prettier; # Check prettier

To fix formatting/linting

npm run fix; # Fix all
npm run fix:lint; # Fix linting
npm run fix:prettier; # Fix prettier

Test

The easiest way to run all of the tests is to first stand up the local API with

npm run start:local:warm

then in a separate terminal run

npm run test:ci

This will spin up localstack and run both unit and integration tests, reporting coverage. This is what runs in GitHub actions against PRs.

Unit tests

To just run unit tests, you can run

npm run test

Integration tests

You can run just the integration tests with

npm run test:localstack:integration

To run the integration tests repeatedly, it may be faster to stand up localstack with

npm run localstack:up

then run the tests as many times as needed with

npm run test:integration

and finally tear down localstack with

npm run localstack:down