HAAR-2154: typescript template updates

.circleci/config.yml

@@ -1,7 +1,7 @@
 version: 2.1
 
 orbs:
-  hmpps: ministryofjustice/hmpps@7
+  hmpps: ministryofjustice/hmpps@8
   slack: circleci/slack@4.12.5
 
 parameters:
@@ -18,7 +18,7 @@ parameters:
 
   node-version:
     type: string
-    default: 18.12-browsers
+    default: 20.8-browsers
 
 jobs:
   build:
@@ -43,21 +43,16 @@ jobs:
       - run:
           command: |
             npm run build
-            DATE=$(date '+%Y-%m-%d')
-            export BUILD_NUMBER=${DATE}.${CIRCLE_BUILD_NUM}
-            export GIT_REF="$CIRCLE_SHA1"
-            npm run record-build-info
       - run: # Run linter after build because the integration test code depend on compiled typescript...
           name: Linter check
           command: npm run lint
       - persist_to_workspace:
           root: .
           paths:
             - node_modules
-            - build-info.json
             - build
             - dist
-            - .cache/Cypress
+            - assets/stylesheets
 
   unit_test:
     executor:
@@ -77,9 +72,8 @@ jobs:
 
   integration_test:
     executor:
-      name: hmpps/node_redis
-      node_tag: << pipeline.parameters.node-version >>
-      redis_tag: "6.2"
+      name: hmpps/node
+      tag: << pipeline.parameters.node-version >>
     steps:
       - checkout
       - attach_workspace:
@@ -91,7 +85,7 @@ jobs:
           key: dependency-cache-{{ checksum "package-lock.json" }}
       - run:
           name: Get wiremock
-          command: curl -o wiremock.jar https://repo1.maven.org/maven2/com/github/tomakehurst/wiremock-standalone/2.27.1/wiremock-standalone-2.27.1.jar
+          command: curl -o wiremock.jar https://repo1.maven.org/maven2/org/wiremock/wiremock-standalone/3.3.1/wiremock-standalone-3.3.1.jar
       - run:
           name: Run wiremock
           command: java -jar wiremock.jar --port 9091
@@ -109,9 +103,9 @@ jobs:
       - store_test_results:
           path: test_results
       - store_artifacts:
-          path: integration-tests/videos
+          path: integration_tests/videos
       - store_artifacts:
-          path: integration-tests/screenshots
+          path: integration_tests/screenshots
 
 workflows:
   version: 2
@@ -139,6 +133,8 @@ workflows:
           name: deploy_dev
           env: "dev"
           jira_update: true
+          pipeline_id: <<pipeline.id>>
+          pipeline_number: <<pipeline.number>>
           context: hmpps-common-vars
           filters:
             branches:
@@ -159,6 +155,8 @@ workflows:
 #          env: "preprod"
 #          jira_update: true
 #          jira_env_type: staging
+#          pipeline_id: <<pipeline.id>>
+#          pipeline_number: <<pipeline.number>>
 #          context:
 #            - hmpps-common-vars
 #            - hmpps-historical-prisoner-preprod
@@ -174,6 +172,8 @@ workflows:
 #          env: "prod"
 #          jira_update: true
 #          jira_env_type: production
+#          pipeline_id: <<pipeline.id>>
+#          pipeline_number: <<pipeline.number>>
 #          slack_notification: true
 #          slack_channel_name: << pipeline.parameters.releases-slack-channel >>
 #          context:

.eslintrc.json

@@ -96,6 +96,7 @@
         "printWidth": 120,
         "semi": false
       }
-    ]
+    ],
+    "no-empty-function": ["error", { "allow": ["constructors", "arrowFunctions"] }]
   }
 }

.gitignore

@@ -120,7 +120,6 @@ dist
 assets/stylesheets/*.css
 .idea
 .vscode
-build-info.json
 dist/
 test_results/
 integration_tests/videos/

.nvmrc

@@ -1 +1 @@
-18
+20

Dockerfile

@@ -1,8 +1,9 @@
 # Stage: base image
-FROM node:18.15-bullseye-slim as base
+FROM node:20.8-bullseye-slim as base
 
-ARG BUILD_NUMBER=1_0_0
-ARG GIT_REF=not-available
+ARG BUILD_NUMBER
+ARG GIT_REF
+ARG GIT_BRANCH
 
 LABEL maintainer="HMPPS Digital Studio <info@digital.justice.gov.uk>"
 
@@ -14,8 +15,15 @@ RUN addgroup --gid 2000 --system appgroup && \
 
 WORKDIR /app
 
-# Cache breaking
-ENV BUILD_NUMBER ${BUILD_NUMBER:-1_0_0}
+# Cache breaking and ensure required build / git args defined
+RUN test -n "$BUILD_NUMBER" || (echo "BUILD_NUMBER not set" && false)
+RUN test -n "$GIT_REF" || (echo "GIT_REF not set" && false)
+RUN test -n "$GIT_BRANCH" || (echo "GIT_BRANCH not set" && false)
+
+# Define env variables for runtime health / info
+ENV BUILD_NUMBER=${BUILD_NUMBER}
+ENV GIT_REF=${GIT_REF}
+ENV GIT_BRANCH=${GIT_BRANCH}
 
 RUN apt-get update && \
         apt-get upgrade -y && \
@@ -25,8 +33,9 @@ RUN apt-get update && \
 # Stage: build assets
 FROM base as build
 
-ARG BUILD_NUMBER=1_0_0
-ARG GIT_REF=not-available
+ARG BUILD_NUMBER
+ARG GIT_REF
+ARG GIT_BRANCH
 
 RUN apt-get update && \
         apt-get install -y make python g++
@@ -37,10 +46,6 @@ RUN CYPRESS_INSTALL_BINARY=0 npm ci --no-audit
 COPY . .
 RUN npm run build
 
-RUN export BUILD_NUMBER=${BUILD_NUMBER} && \
-        export GIT_REF=${GIT_REF} && \
-        npm run record-build-info
-
 RUN npm prune --no-audit --omit=dev
 
 # Stage: copy production assets and dependencies
@@ -51,9 +56,6 @@ COPY --from=build --chown=appuser:appgroup \
         /app/package-lock.json \
         ./
 
-COPY --from=build --chown=appuser:appgroup \
-        /app/build-info.json ./dist/build-info.json
-
 COPY --from=build --chown=appuser:appgroup \
         /app/assets ./assets
 

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020-2021 Crown Copyright (Ministry of Justice)
+Copyright (c) 2020-2023 Crown Copyright (Ministry of Justice)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -15,15 +15,15 @@ Our security policy is located [here](https://github.com/ministryofjustice/hmpps
 
 More information about the template project including features can be found [here](https://dsdmoj.atlassian.net/wiki/spaces/NDSS/pages/3488677932/Typescript+template+project).
 
-## Creating a CloudPlatform namespace
+## Creating a Cloud Platform namespace
 
 When deploying to a new namespace, you may wish to use this template typescript project namespace as the basis for your new namespace:
 
 <https://github.com/ministryofjustice/cloud-platform-environments/tree/main/namespaces/live.cloud-platform.service.justice.gov.uk/hmpps-template-typescript>
 
 This template namespace includes an AWS elasticache setup - which is required by this template project.
 
-Copy this folder, update all the existing namespace references, and submit a PR to the CloudPlatform team. Further instructions from the CloudPlatform team can be found here: <https://user-guide.cloud-platform.service.justice.gov.uk/#cloud-platform-user-guide>
+Copy this folder, update all the existing namespace references, and submit a PR to the Cloud Platform team. Further instructions from the Cloud Platform team can be found here: <https://user-guide.cloud-platform.service.justice.gov.uk/#cloud-platform-user-guide>
 
 ## Renaming from HMPPS Template Typescript - github Actions
 
@@ -48,12 +48,16 @@ It then performs a search and replace and directory renames so the project is re
 
 To ensure notifications are routed to the correct slack channels, update the `alerts-slack-channel` and `releases-slack-channel` parameters in `.circle/config.yml` to an appropriate channel.
 
+## Filling in the `productId`
+
+To allow easy identification of an application, the product Id of the overall product should be set in `values.yaml`. The Service Catalogue contains a list of these IDs and is currently in development here https://developer-portal.hmpps.service.justice.gov.uk/products
+
 ## Running the app
 The easiest way to run the app is to use docker compose to create the service and all dependencies. 
 
-`docker-compose pull`
+`docker compose pull`
 
-`docker-compose up`
+`docker compose up`
 
 ### Dependencies
 The app requires: 
@@ -64,7 +68,7 @@ The app requires:
 
 To start the main services excluding the example typescript template app: 
 
-`docker-compose up --scale=app=0`
+`docker compose up --scale=app=0`
 
 Install dependencies using `npm install`, ensuring you are using `node v18.x` and `npm v9.x`
 
@@ -84,9 +88,9 @@ And then, to build the assets and start the app with nodemon:
 
 ### Running integration tests
 
-For local running, start a test db, redis, and wiremock instance by:
+For local running, start a test db and wiremock instance by:
 
-`docker-compose -f docker-compose-test.yml up`
+`docker compose -f docker-compose-test.yml up`
 
 Then run the server in test mode by:
 
@@ -100,8 +104,12 @@ Or run tests with the cypress UI:
 
 `npm run int-test-ui`
 
+## Change log
+
+A changelog for the service is available [here](./CHANGELOG.md)
+
 
-### Dependency Checks
+## Dependency Checks
 
 The template project has implemented some scheduled checks to ensure that key dependencies are kept up to date.
 If these are not desired in the cloned project, remove references to `check_outdated` job from `.circleci/config.yml`

assets/js/mojFrontendInit.js

@@ -0,0 +1 @@
+window.MOJFrontend.initAll()

assets/scss/components/_header-bar.scss

@@ -139,3 +139,8 @@
     display: none;
   }
 }
+
+.govuk-phase-banner {
+  @include govuk-width-container;
+  border: none;
+}

audit-ci.json

@@ -2,5 +2,5 @@
   "low": true,
   "package-manager": "auto",
   "registry": "https://registry.npmjs.org",
-  "allowlist": ["GHSA-9c47-m6qq-7p4h"]
+  "allowlist": []
 }

cypress.config.ts

@@ -1,6 +1,7 @@
 import { defineConfig } from 'cypress'
 import { resetStubs } from './integration_tests/mockApis/wiremock'
 import auth from './integration_tests/mockApis/auth'
+import manageUsersApi from './integration_tests/mockApis/manageUsersApi'
 import tokenVerification from './integration_tests/mockApis/tokenVerification'
 
 export default defineConfig({
@@ -12,15 +13,13 @@ export default defineConfig({
   reporterOptions: {
     configFile: 'reporter-config.json',
   },
-  videoUploadOnPasses: false,
   taskTimeout: 60000,
   e2e: {
-    // We've imported your old cypress plugins here.
-    // You may want to clean this up later by importing these.
     setupNodeEvents(on) {
       on('task', {
         reset: resetStubs,
         ...auth,
+        ...manageUsersApi,
         ...tokenVerification,
       })
     },

docker-compose-test.yml

@@ -1,13 +1,6 @@
 version: '3.1'
 services:
 
-  redis:
-    image: 'redis:7.0'
-    networks:
-      - hmpps_int
-    ports:
-      - '6379:6379'
-
   wiremock:
     image: wiremock/wiremock
     networks:

docker-compose.yml

@@ -1,16 +1,6 @@
 version: '3.1'
 services:
 
-  redis:
-    image: 'redis:7.0'
-    networks:
-      - hmpps
-    container_name: redis
-    environment:
-      - ALLOW_EMPTY_PASSWORD=yes
-    ports:
-      - '6379:6379'
-
   hmpps-auth:
     image: quay.io/hmpps/hmpps-auth:latest
     networks:
@@ -25,21 +15,30 @@ services:
       - APPLICATION_AUTHENTICATION_UI_ALLOWLIST=0.0.0.0/0
 
   app:
-    build: .
+    build:
+      context: .
+      args:
+        BUILD_NUMBER: "1.0.0"
+        GIT_REF: "a1b2c3"
+        GIT_BRANCH: main
     networks:
       - hmpps
-    depends_on: [redis]
     ports:
       - "3000:3000"
     environment:
-      - REDIS_HOST=redis
+      - PRODUCT_ID=UNASSIGNED
+      - REDIS_ENABLED=false
       - HMPPS_AUTH_EXTERNAL_URL=http://localhost:9090/auth
       - HMPPS_AUTH_URL=http://hmpps-auth:8080/auth
       # These will need to match new creds in the seed auth service auth
       - API_CLIENT_ID=client-id
       - API_CLIENT_SECRET=client-secret
       - SYSTEM_CLIENT_ID=system-client-id
       - SYSTEM_CLIENT_SECRET=system-client-secret
+      - SESSION_SECRET=somesecretvalue
+      - TOKEN_VERIFICATION_API_URL=http://hmpps-auth:8080/auth
+      - TOKEN_VERIFICATION_ENABLED=false
+      - INGRESS_URL=http://localhost:3000
 
 networks:
   hmpps:

feature.env

@@ -1,9 +1,12 @@
 PORT=3007
 HMPPS_AUTH_URL=http://localhost:9091/auth
+MANAGE_USERS_API_URL=http://localhost:9091/manage-users-api
 TOKEN_VERIFICATION_API_URL=http://localhost:9091/verification
 TOKEN_VERIFICATION_ENABLED=true
+REDIS_ENABLED=false
 NODE_ENV=development
 API_CLIENT_ID=clientid
 API_CLIENT_SECRET=clientsecret
 SYSTEM_CLIENT_ID=clientid
 SYSTEM_CLIENT_SECRET=clientsecret
+ENVIRONMENT_NAME=dev

helm_deploy/README.md

@@ -66,4 +66,4 @@ cloud-platform-environments/namespaces/live-1.cloud-platform.service.justice.gov
 
 Ensure the certificate is created and ready for use.
 
-The name of the kubernetes secret where the certificate is stored is used as a value to the helm chart - this is used to configured the ingress.
+The name of the kubernetes secret where the certificate is stored is used as a value to the helm chart - this is used to configure the ingress.