Feature/ccm 13610 letter request event performance

.devcontainer/devcontainer.json

@@ -83,7 +83,8 @@
   },
   "mounts": [
     "source=${localEnv:HOME}/.ssh,target=/home/vscode/.ssh,type=bind,consistency=cached",
-    "source=${localEnv:HOME}/.aws,target=/home/vscode/.aws,type=bind,consistency=cached"
+    "source=${localEnv:HOME}/.aws,target=/home/vscode/.aws,type=bind,consistency=cached",
+    "source=${localEnv:HOME}/.npmrc,target=/home/vscode/.npmrc,type=bind,consistency=cached"
   ],
   "name": "Devcontainer",
   "postCreateCommand": "scripts/devcontainer/postcreatecommand.sh"

.env.template

@@ -0,0 +1,5 @@
+ENVIRONMENT=$ENV_NAME
+API_KEY=
+HEADERAUTH=
+PR_NUMBER=prxx # remove if needs to run against main
+NHSD_APIM_TOKEN=

.github/actions/acceptance-tests/action.yaml

@@ -0,0 +1,51 @@
+name: Acceptance tests
+description: "Run acceptance tests for this repo"
+
+inputs:
+  testType:
+    description: Type of test to run
+    required: true
+
+  targetEnvironment:
+    description: Name of the environment under test
+    required: true
+
+  targetAccountGroup:
+    description: Name of the account group under test
+    default: nhs-notify-template-management-dev
+    required: true
+
+  targetComponent:
+    description: Name of the component under test
+    required: true
+
+runs:
+  using: "composite"
+
+  steps:
+    - name: Fetch terraform output
+      uses: actions/download-artifact@v5
+      with:
+        name: terraform-output-${{ inputs.targetComponent }}
+
+    - name: Get Node version
+      id: nodejs_version
+      shell: bash
+      run: |
+        echo "nodejs_version=$(grep "^nodejs\s" .tool-versions | cut -f2 -d' ')" >> $GITHUB_OUTPUT
+
+    - name: "Repo setup"
+      uses: ./.github/actions/node-install
+      with:
+        node-version: ${{ steps.nodejs_version.outputs.nodejs_version }}
+        GITHUB_TOKEN: ${{ env.GITHUB_TOKEN }}
+
+    - name: "Set PR NUMBER"
+      shell: bash
+      run: |
+          echo "PR_NUMBER=${{ inputs.targetEnvironment }}" >> $GITHUB_ENV
+
+    - name: Run test - ${{ inputs.testType }}
+      shell: bash
+      run: |
+        make test-${{ inputs.testType }}

.github/actions/test-types.json

@@ -0,0 +1,3 @@
+[
+  "component"
+]

.github/workflows/stage-1-commit.yaml

@@ -72,7 +72,7 @@ jobs:
     needs: detect-terraform-changes
     if: needs.detect-terraform-changes.outputs.terraform_changed == 'true'
     permissions:
-        contents: write
+      contents: write
     steps:
       - name: "Checkout code"
         uses: actions/checkout@v5
@@ -164,8 +164,6 @@ jobs:
           registry-url: 'https://npm.pkg.github.com'
       - name: "Setup ASDF"
         uses: asdf-vm/actions/setup@v4
-      - name: "Perform Setup"
-        uses: ./.github/actions/setup
       - name: "Trivy Scan"
         uses: ./.github/actions/trivy
   count-lines-of-code:
@@ -288,7 +286,7 @@ jobs:
         uses: actions/setup-node@v4
         with:
           node-version: ${{ inputs.nodejs_version }}
-          registry-url: 'https://npm.pkg.github.com'
+          registry-url: "https://npm.pkg.github.com"
 
       - name: check if local version differs from latest published version
         id: check-version

.github/workflows/stage-2-test.yaml

@@ -38,7 +38,7 @@ env:
 
 permissions:
   id-token: write # This is required for requesting the JWT
-  contents: read  # This is required for actions/checkout
+  contents: read # This is required for actions/checkout
   packages: read # This is required for downloading from GitHub Package Registry
 
 jobs:
@@ -49,6 +49,11 @@ jobs:
     steps:
       - name: "Checkout code"
         uses: actions/checkout@v5
+      - name: Setup NodeJS
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ inputs.nodejs_version }}
+          registry-url: "https://npm.pkg.github.com"
       - name: "Cache node_modules"
         uses: actions/cache@v4
         with:
@@ -73,6 +78,11 @@ jobs:
     steps:
       - name: "Checkout code"
         uses: actions/checkout@v5
+      - name: Setup NodeJS
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ inputs.nodejs_version }}
+          registry-url: "https://npm.pkg.github.com"
       - name: "Cache node_modules"
         uses: actions/cache@v4
         with:
@@ -142,6 +152,11 @@ jobs:
     steps:
       - name: "Checkout code"
         uses: actions/checkout@v5
+      - name: Setup NodeJS
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ inputs.nodejs_version }}
+          registry-url: "https://npm.pkg.github.com"
       - name: "Cache node_modules"
         uses: actions/cache@v4
         with:
@@ -168,6 +183,11 @@ jobs:
     steps:
       - name: "Checkout code"
         uses: actions/checkout@v5
+      - name: Setup NodeJS
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ inputs.nodejs_version }}
+          registry-url: "https://npm.pkg.github.com"
       - name: "Cache node_modules"
         uses: actions/cache@v4
         with:

.github/workflows/stage-4-acceptance.yaml

@@ -35,152 +35,36 @@ on:
         required: true
         type: string
 
-jobs:
-#  environment-set-up:
-#    name: "Environment set up"
-#    runs-on: ubuntu-latest
-#    timeout-minutes: 5
-#    steps:
-#      - name: "Checkout code"
-#        uses: actions/checkout@v5
-#      - name: "Create infractructure"
-#        run: |
-#          echo "Creating infractructure..."
-#      - name: "Update database"
-#        run: |
-#          echo "Updating database..."
-#      - name: "Deploy application"
-#        run: |
-#          echo "Deploying application..."
+permissions:
+  id-token: write
+  contents: read
 
-  test-contract:
-    name: "Contract test"
+jobs:
+  run-acceptance-tests:
+    name: Run Acceptance Tests
     runs-on: ubuntu-latest
-#    needs: environment-set-up
-    timeout-minutes: 10
     steps:
-      - name: "Checkout code"
-        uses: actions/checkout@v5
-      - name: "Cache node_modules"
-        uses: actions/cache@v4
+      - uses: actions/checkout@v5.0.0
+
+      - name: 'Use Node.js'
+        uses: actions/setup-node@v6
         with:
-          path: |
-            **/node_modules
-          key: ${{ runner.os }}-node-${{ inputs.nodejs_version }}-${{ hashFiles('**/package-lock.json') }}
-          restore-keys: |
-            ${{ runner.os }}-node-${{ inputs.nodejs_version }}-
-      - name: "Run contract test"
-        run: |
-          make test-contract
+          node-version: '${{ inputs.nodejs_version }}'
+          registry-url: 'https://npm.pkg.github.com'
+          scope: '@nhsdigital'
+
+      - name: Trigger Acceptance Tests
+        shell: bash
         env:
-          GITHUB_PACKAGES_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      - name: "Save result"
+          APP_PEM_FILE: ${{ secrets.APP_PEM_FILE }}
+          APP_CLIENT_ID: ${{ secrets.APP_CLIENT_ID }}
+          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
-          echo "Nothing to save"
-
-# Environment-based tests should run from notify-internal repo, not in public repo
-#  test-security:
-#    name: "Security test"
-#    runs-on: ubuntu-latest
-#    needs: environment-set-up
-#    timeout-minutes: 10
-#    steps:
-#      - name: "Checkout code"
-#        uses: actions/checkout@v5
-#      - name: "Run security test"
-#        run: |
-#          make test-security
-#      - name: "Save result"
-#        run: |
-#          echo "Nothing to save"
-#  test-ui:
-#    name: "UI test"
-#    runs-on: ubuntu-latest
-#    needs: environment-set-up
-#    timeout-minutes: 10
-#    steps:
-#      - name: "Checkout code"
-#        uses: actions/checkout@v5
-#      - name: "Run UI test"
-#        run: |
-#          make test-ui
-#      - name: "Save result"
-#        run: |
-#          echo "Nothing to save"
-#  test-ui-performance:
-#    name: "UI performance test"
-#    runs-on: ubuntu-latest
-#    needs: environment-set-up
-#    timeout-minutes: 10
-#    steps:
-#      - name: "Checkout code"
-#        uses: actions/checkout@v5
-#      - name: "Run UI performance test"
-#        run: |
-#          make test-ui-performance
-#      - name: "Save result"
-#        run: |
-#          echo "Nothing to save"
-#  test-integration:
-#    name: "Integration test"
-#    runs-on: ubuntu-latest
-#    needs: environment-set-up
-#    timeout-minutes: 10
-#    steps:
-#      - name: "Checkout code"
-#        uses: actions/checkout@v5
-#      - name: "Run integration test"
-#        run: |
-#          make test-integration
-#      - name: "Save result"
-#        run: |
-#          echo "Nothing to save"
-#  test-accessibility:
-#    name: "Accessibility test"
-#    runs-on: ubuntu-latest
-#    needs: environment-set-up
-#    timeout-minutes: 10
-#    steps:
-#      - name: "Checkout code"
-#        uses: actions/checkout@v5
-#      - name: "Run accessibility test"
-#        run: |
-#          make test-accessibility
-#      - name: "Save result"
-#        run: |
-#          echo "Nothing to save"
-#  test-load:
-#    name: "Load test"
-#    runs-on: ubuntu-latest
-#    needs: environment-set-up
-#    timeout-minutes: 10
-#    steps:
-#      - name: "Checkout code"
-#        uses: actions/checkout@v5
-#      - name: "Run load tests"
-#        run: |
-#          make test-load
-#      - name: "Save result"
-#        run: |
-#          echo "Nothing to save"
-#  environment-tear-down:
-#    name: "Environment tear down"
-#    runs-on: ubuntu-latest
-#    needs:
-#      [
-#        test-accessibility,
-#        test-contract,
-#        test-integration,
-#        test-load,
-#        test-security,
-#        test-ui-performance,
-#        test-ui,
-#      ]
-#    if: always()
-#    timeout-minutes: 5
-#    steps:
-#      - name: "Checkout code"
-#        uses: actions/checkout@v5
-#      - name: "Tear down environment"
-#        run: |
-#          echo "Tearing down environment..."
+          .github/scripts/dispatch_internal_repo_workflow.sh \
+            --targetWorkflow "dispatch-contextual-tests-dynamic-env.yaml" \
+            --infraRepoName "nhs-notify-supplier-api" \
+            --releaseVersion "${GITHUB_HEAD_REF:-${GITHUB_REF#refs/heads/}}" \
+            --overrideProjectName "nhs" \
+            --targetEnvironment "pr${{ inputs.pr_number }}" \
+            --targetAccountGroup "nhs-notify-supplier-api-dev" \
+            --targetComponent "api"

.gitignore

@@ -13,6 +13,7 @@ version.json
 # Please, add your custom content below!
 .idea
 .env
+.envrc
 
 # dependencies
 node_modules

.vscode/settings.json

@@ -1,5 +1,8 @@
 {
   "autoOpenWorkspace.enableAutoOpenIfSingleWorkspace": true,
+  "cSpell.words": [
+    "envrc"
+  ],
   "files.exclude": {
     "**/.DS_Store": true,
     "**/.git": true,

docs/assets/diagrams/types.md

@@ -31,16 +31,27 @@ erDiagram
 erDiagram
     MI {
         string id
-        string supplierId "ref: Supplier"
-        string specificationId
-        string groupId
         string lineItem
+        string timestamp
         number quantity
+        string specificationId
+        string groupId
         number stockRemaining
+        string supplierId
         string createdAt
         string updatedAt
+        number ttl "min: -9007199254740991, max: 9007199254740991"
     }
+```
+
+## Supplier schema
+
+```mermaid
+erDiagram
     Supplier {
+        string id
+        string name
+        string apimId
+        string status "enum: ENABLED, DISABLED"
     }
-    MI }o--|| Supplier : "supplierId"
 ```