hmcts / rpx-xui-webapp

rpx-xui-webapp

Manage Cases

To run the application locally please make sure you follow the prerequisite task of Setting up Secrets locally as documented below.

Then follow:

Startup the Node service locally

1. Make sure you have local-development.json within /config, if you do not you can get this from an XUI team member.
2. Start the Node service locally using: export IDAM_SECRET=* && export S2S_SECRET=* && export NODE_CONFIG_DIR=../config && export NODE_CONFIG_ENV=development && export ALLOW_CONFIG_MUTATIONS=1 && npm run start:node

Explanation:

NODE_CONFIG_DIR tells the machine where the configuration for the Node application is located. NODE_CONFIG_ENV=development sets the machine so that the config that is used is local-development.json

@see https://github.com/lorenwest/node-config/wiki/Configuration-Files

Startup the Angular service locally

Run yarn start:ng to start up the UI.

Running unit tests

Run yarn test to execute the unit tests on both the Angular and Node layers. Note that yarn test is run on the build pipelines.

Linting

Run yarn lint to execute all linting across both Angular and Node layers. Note that this is run on the build pipelines. Run yarn lint:node to execute note linting.

PACT

Run yarn test-pact to run the PACT tests.

Run yarn pact-stub to run the PACT stub server.

Branches, Environment and Deployment methods used

Branches, Environment and Deployment methods used

 |---------------------------------------|
 | Branch | Environment | Deployment via |
 |---------------------------------------|
 | local  | development | -              |
 | PR     | preview     | Jenkins        |
 | Master | aat         | Jenkins        |
 | Master | aat         | Flux           |
 | Master | ithc        | Flux           |
 | Master | production  | Flux           |
 |---------------------------------------|

Path to configuration

The application should point to the configuration folder that contains the .json configuration files. There should only ever be three files within this folder:

custom-environmental-variables.json - Allows configuration values to be set by the machines environmental values. Through the Jenkins pipelines they are overwritten by values.*.template.yaml files for the Preview and AAT enviroments. On AKS they are only overwritten by the values.yaml file default.json - Should contain Production configuration values as per Reform standards. local-development.json - Is used for local development

Adding new files into /config should be avoided, as it increases complexity.

It increases complexity if we were to add files to /config as we already have the Preview and AAT Jenkins enviromental values contained within values.preview.template.yaml and values.aat.template.yaml.

Setting up Secrets locally (Required)

You need to setup secrets locally before you run the project. Why? - When you push this application up through AKS deployed through Flux to AAT, ITHC and Prod, the application will take in the secrets on these environments.

The developer needs to set these up locally, so that the developer can see any issues early in the development process, and not when the application is placed up onto the higher AKS environments.

To setup the secrets locally do the following:

Note that Mac OS Catalina introduced a new feature that overlaps and reinforces the filesystem, therefore you will not be able to make changes in the root directory of your file system, hence there are different ways to setup secrets, Pre Catalina and Post Catalina, note that the Post Catalina way should work for all operating system, but I have yet to try this.

####MAC OS - Pre Catalina

1. Create a Mount point on your local machine
   Create the folder: /mnt/secrets/rpx
2. In this folder we create a file per secret. ie. We create the file postgresql-admin-pw (no extension). Within the file we have one line of characters which is the secret.

####MAC OS - Post Catalina

1. Create a Mount point on your local machine within the Volumes folder
   Create the folder: /Volumes/mnt/secrets/rpx
2. In this folder we create a file per secret. ie. We create the file postgresql-admin-pw (no extension). Within the file we have one line of characters which is the secret.
3. If you want to test the secrets locally override the default mountPoint with the following additional option added to .addTo ie. propertiesVolume.addTo(secretsConfig, { mountPoint: '/Volumes/mnt/secrets/' });

Note that this is connected into the application via the following pieces of code:

  keyVaults:
    rpx:
      secrets:
        - postgresql-admin-pw
        - appinsights-instrumentationkey-tc

which in turn uses propertiesVolume.addTo()

How Application Configuration (Node Config) Works

The application picks up the configuration from the /config .json files.

The references within .json ie. production.json are set by the /charts/xui-terms-and-conditions/values.yaml file ie. POSTGRES_SERVER_PORT is set by POSTGRES_SERVER_PORT within values.yaml.

HOWEVER if there is a values..template.yaml file it will override the values within the values.yaml file, BUT this only happens on the JENKINS pipelines, where values.*.template.yaml are available to the build pipeline.

AKS uses a .json file in /config and the values.yaml from within charts/xui-terms-and-conditions ONLY.

AKS does not use values.aat.template.yaml and values.previews.template.yaml

DO NOT create a new .json file within /config as this increases the complexity of configuration.

The 3rd party Node config package selects the file within /config based on NODE_ENV which is always production on all environments, due to Reform standards, this does not change on different environments, it is always NODE_ENV=production

If production.json is not within /config, it's not in the case of Manage Cases, it will use the files in the order specified by @see https://github.com/lorenwest/node-config/wiki/Configuration-Files

We DO NOT need to leverage NODE_CONFIG_ENV on the Manage Cases project - All application code be written so that it's not environment specific!

Note about secrets ie.

  keyVaults:
    rpx:
      secrets:
        - postgresql-admin-pw
        - appinsights-instrumentationkey-tc

are set within the values.yaml and there should be NO REFERENCE to them within any /config/*.json file.

The application pulls out the secrets directly using propertiesVolume.addTo()

Issues and Solutions

Property 'cookies' does not exist on type 'EnhancedRequest' - you will need to make sure @types/express-session is added ie. yarn add @types/express-session

The following is the legacy readme.

Code scaffolding

Run ng generate component component-name to generate a new component. You can also use ng generate directive|pipe|service|class|guard|interface|enum|module.

Build

Run ng build to build the project. The build artifacts will be stored in the dist/ directory. Use the --prod flag for a production build.

Running end-to-end tests

Run ng e2e to execute the end-to-end tests via Protractor.

Running Consumer Driven Contract tests (pact)

Run yarn test-pact to execute the Pact tests For publishing the pacts to broker execute yarn publish-pact

Integration Documentation

https://tools.hmcts.net/confluence/display/EUI/EXUI+Low+Level+Design

Further help

To get more help on the Angular CLI use ng help or go and check out the Angular CLI README.

Logger errors and warnings

Extended version of script below:

(https://robferguson.org/blog/2017/09/09/a-simple-logging-service-for-angular-4/)

END Trigger2 Trigger3

rpx-xui-webapp's Issues

Use of mutation testing in rpx-xui-webapp - Help needed

Hello there!

My name is Ana. I noted that you use the mutation testing tool StrykerJS in the project.
I am a postdoctoral researcher at the University of Seville (Spain), and my colleagues and I are studying how mutation testing tools are used in practice. With this aim in mind, we have analysed over 3,500 public GitHub repositories using mutation testing tools, including yours! This work has recently been published in a journal paper available at https://link.springer.com/content/pdf/10.1007/s10664-022-10177-8.pdf.

To complete this study, we are asking for your help to understand better how mutation testing is used in practice, please! We would be extremely grateful if you could contribute to this study by answering a brief survey of 21 simple questions (no more than 6 minutes). This is the link to the questionnaire https://forms.gle/FvXNrimWAsJYC1zB9.

We apologize if you have already received message multiple times or if you have already had the opportunity to complete the survey. If you have already shared your feedback, we want to convey our appreciation, kindly disregard this message, and please accept our apologies for any inconvenience.

Drop me an e-mail if you have any questions or comments ([email protected]). Thank you very much in advance!!

How can the risk of feature toggle technical debt be reduced?

Dear developers,

I, Rezvan Mahdavi Hezaveh ([email protected]), and my colleague, Nirav Ajmeri ([email protected]), software engineering researchers from North Carolina State University are conducting an academic study of feature toggles and technical debt.

In our investigations on GitHub repositories, we noticed that you are using feature toggles in your repository. For instance, in this file the toggle ccdCaseCreate is defined.

We would appreciate your collaboration in this study by answering an anonymous survey based upon your experience with the feature toggles. This survey has 20 questions and the estimated time to answer these questions is 10 minutes.

The link to the survey is here: https://ncsu.qualtrics.com/jfe/form/SV_5BGE3wNDUtFQqMd

Once you start answering the survey questionnaire, you will have 24 hours to finish it.
As an appreciation for your time, we will conduct a random drawing and give $25 Amazon gift cards to five selected survey respondents. Also, we will share our results with you.

Thanks

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Rate-Limited

These updates are currently rate-limited. Click on a checkbox below to force their creation now.

• Replace dependency faker with @faker-js/faker ^5.1.0
• Replace dependency npm-run-all with npm-run-all2 ^5.0.0
• Update angular monorepo (@angular/animations, @angular/common, @angular/compiler, @angular/compiler-cli, @angular/core, @angular/forms, @angular/language-service, @angular/platform-browser, @angular/platform-browser-dynamic, @angular/router, zone.js)
• Update dependency @hmcts/ccpay-web-component to v6.1.6
• Update dependency @microsoft/applicationinsights-web to v3.1.2
• Update dependency @types/csurf to v1.11.5
• Update dependency @types/express to v4.17.21
• Update dependency @types/global-agent to v2.1.3
• Update dependency @types/jasminewd2 to v2.0.13
• Update dependency accessibility-checker to v3.1.69
• Update dependency config to v3.3.11
• Update dependency karma to v6.4.3
• Update dependency moment-timezone to v0.5.45
• Update dependency node-html-parser to v6.1.13
• Update dependency protractor-multiple-cucumber-html-reporter-plugin to v1.8.1
• Update dependency terser-webpack-plugin to v5.3.10
• Update dependency yarn to v1.22.22
• Update Helm release idam-pr to ~2.3.0
• Update Terraform azurerm to ~> 3.99.0
• Update dependency @hmcts/nodejs-healthcheck to v1.8.4
• Update dependency @hmcts/rpx-xui-node-lib to v2.28.0
• Update dependency @pact-foundation/pact-node to v10.18.0
• Update dependency @types/express-session to v1.18.0
• Update dependency @types/jasmine to ~3.10.0
• Update dependency @types/node to v18.19.31
• Update dependency applicationinsights to v1.8.10
• Update dependency axios to v1.6.8
• Update dependency chai to v4.4.1
• Update dependency class-transformer to ^0.5.0
• Update dependency codeceptjs to v3.6.1
• Update dependency com.github.hmcts:fortify-client to v1.4.1
• Update dependency core-js to v3.37.0
• Update dependency eslint to v8.57.0
• Update dependency govuk-frontend to v3.15.0
• Update dependency gradle to v7.6.4
• Update dependency hashicorp/terraform to v1.8.1
• Update dependency http-proxy-middleware to 1.3.x
• Update dependency jasmine-core to ~3.99.0
• Update dependency karma-chrome-launcher to v3.2.0
• Update dependency karma-coverage to ~2.2.0
• Update dependency karma-coverage-istanbul-reporter to ~2.1.0
• Update dependency karma-jasmine to v5.1.0
• Update dependency ngx-chips to v2.2.2
• Update dependency node to v18.20.2
• Update dependency org.slf4j:slf4j-simple to v1.7.36
• Update dependency playwright to v1.43.1
• Update dependency protractor-cucumber-framework to v9.12.0
• Update dependency puppeteer to v22.6.5
• Update dependency sass to v1.75.0
• Update dependency ts-enum-util to v4.1.0
• Update dependency ts-loader to v9.5.1
• Update dependency ts-node to ~10.9.0
• Update dependency webpack to v5.91.0
• Update dependency xlsx to ^0.18.0
• Update Helm release redis to v19
• Update Node.js to v20
• Update Yarn to v4
• Update actions/checkout action to v4
• Update actions/setup-node action to v4
• Update angular monorepo to v17 (major) (@angular/animations, @angular/common, @angular/compiler, @angular/compiler-cli, @angular/core, @angular/forms, @angular/language-service, @angular/platform-browser, @angular/platform-browser-dynamic, @angular/router)
• Update angular-cli monorepo to v17 (major) (@angular-devkit/build-angular, @angular/cli)
• Update angularmaterial monorepo to v17 (major) (@angular/cdk, @angular/material)
• Update dependency @angular-eslint/builder to v17
• Update dependency @angular-material-components/datetime-picker to v16
• Update dependency @angular-material-components/moment-adapter to v16
• Update dependency @hmcts/properties-volume to v1
• Update dependency @ng-idle/core to v14
• Update dependency @ng-idle/keepalive to v14
• Update dependency @nguniversal/express-engine to v16
• Update dependency @pact-foundation/pact to v12
• Update dependency @stryker-mutator/typescript to v4
• Update dependency @types/config to v3
• Update dependency @types/crypto-js to v4
• Update dependency @types/jasmine to v5
• Update dependency applicationinsights to v2
• Update dependency base-64 to v1
• Update dependency chai to v5
• Update dependency codelyzer to v6
• Update dependency cucumber to v6
• Update dependency cucumber-pretty to v6
• Update dependency ejs to v3 (ejs, @types/ejs)
• Update dependency eslint to v9
• Update dependency exception-formatter to v2
• Update dependency faker to v6 (faker, @types/faker)
• Update dependency form-data to v4
• Update dependency get-port to v7
• Update dependency git-rev-sync to v3
• Update dependency global-agent to v3
• Update dependency govuk-frontend to v5
• Update dependency gradle to v8
• Update dependency helmet to v7
• Update dependency http-proxy-middleware to v3
• Update dependency jasmine-core to v5
• Update dependency jasmine-spec-reporter to v7
• Update dependency jsonwebtoken to v9
• Update dependency karma-coverage-istanbul-reporter to v3
• Update dependency karma-jasmine-html-reporter to v2
• Update dependency launchdarkly-js-client-sdk to v3
• Update dependency mocha to v10 (mocha, @types/mocha)
• Update dependency mochawesome to v7
• Update dependency mochawesome-report-generator to v6
• Update dependency ngx-chips to v3
• Update dependency ngx-logger to v5
• Update dependency ngx-md to v14
• Update dependency ngx-pagination to v6
• Update dependency node to v20 (node, @types/node)
• Update dependency node-fetch to v3
• Update dependency nodemon to v3
• Update dependency org.slf4j:slf4j-simple to v2
• Update dependency pa11y to v8
• Update dependency sinon to v17 (sinon, @types/sinon)
• Update dependency typescript to v5
• Update dependency uuid to v9
• Update dependency webpack-cli to v5
• Update ngrx monorepo to v17 (major) (@ngrx/effects, @ngrx/router-store, @ngrx/schematics, @ngrx/store, @ngrx/store-devtools)
• Update stefanzweifel/git-auto-commit-action action to v5
• Update stryker-js monorepo to v8 (major) (@stryker-mutator/api, @stryker-mutator/core, @stryker-mutator/karma-runner, @stryker-mutator/mocha-runner)
• Update tibdex/github-app-token action to v2
• Update typescript-eslint monorepo to v7 (major) (@typescript-eslint/eslint-plugin, @typescript-eslint/parser)
• 🔐 Create all rate-limited PRs at once 🔐

Edited/Blocked

These updates have been manually edited so Renovate will no longer make changes. To discard all commits and start over, click on a checkbox.

• Replace dependency cucumber with @cucumber/cucumber
• Update Helm release redis to v16.13.2
• Update dependency @hmcts/properties-volume to ^0.0.14
• Update dependency @types/config to ^0.0.41
• Update dependency @types/shortid to v0.0.32
• Update dependency cucumber-pretty to v1.5.2

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• Update angular-cli monorepo to v15.2.11 (@angular-devkit/build-angular, @angular/cli)
• Update dependency @types/cookie-parser to v1.4.7
• Update dependency karma-spec-reporter to v0.0.36
• Update Yarn to v3.8.1
• Click on this checkbox to rebase all open PRs at once

Detected dependencies

dockerfile

Dockerfile

• hmctspublic.azurecr.io/base/node 18-alpine

github-actions

.github/workflows/dependency-check.yml

• tibdex/github-app-token v1
• actions/checkout v3
• actions/setup-node v3
• stefanzweifel/git-auto-commit-action v4

gradle

test_codecept/java/settings.gradle

test_codecept/java/build.gradle

• org.slf4j:slf4j-simple 1.6.4
• com.github.hmcts:fortify-client 1.2.2

gradle-wrapper

test_codecept/java/gradle/wrapper/gradle-wrapper.properties

• gradle 7.2

helm-values

charts/xui-webapp/values.yaml

helmv3

charts/xui-webapp/Chart.yaml

• nodejs 3.1.0
• redis 16.13.0
• idam-pr ~2.2.6

npm

api/package.json

package.json

• @angular-material-components/datetime-picker 15.0.0
• @angular/animations ^15.2.9
• @angular/cdk ^15.2.9
• @angular/common ^15.2.9
• @angular/compiler ^15.2.9
• @angular/core ^15.2.9
• @angular/forms ^15.2.9
• @angular/material 15.2.9
• @angular/platform-browser ^15.2.9
• @angular/platform-browser-dynamic ^15.2.9
• @angular/router ^15.2.9
• @edium/fsm ^2.1.2
• @hmcts/ccd-case-ui-toolkit 7.0.29
• @hmcts/ccpay-web-component 6.1.0
• @hmcts/frontend 0.0.50-alpha
• @hmcts/media-viewer 3.0.4
• @hmcts/nodejs-healthcheck 1.7.0
• @hmcts/properties-volume ^0.0.13
• @hmcts/rpx-xui-common-lib 2.0.17
• @hmcts/rpx-xui-node-lib 2.25.12
• @microsoft/applicationinsights-web ^3.1.0
• @ng-idle/core ^11.1.0
• @ng-idle/keepalive ^11.0.3
• @ngrx/effects ^11.1.0
• @ngrx/router-store ^15.2.1
• @ngrx/store ^15.2.1
• @ngrx/store-devtools ^15.2.1
• @nguniversal/express-engine ^15.2.1
• @nicky-lenaers/ngx-scroll-to ^14.0.0
• accessibility-checker ^3.0.6
• applicationinsights 1.7.2
• axios ^1.5.1
• axios-mock-adapter ^1.22.0
• class-transformer ^0.3.2
• codeceptjs 3.5.6
• compression ^1.7.4
• config ^3.2.5
• cookie-parser ^1.4.4
• core-js ^3.19.3
• crypto-js ^4.2.0
• csurf ^1.11.0
• dotenv-extended ^2.7.1
• ejs ^2.6.1
• eligrey-classlist.js ^1.2.20180112
• exception-formatter 1.0.7
• faker ^5.1.0
• file-saver ^2.0.2
• form-data ^2.5.1
• get-port ^5.1.1
• git-rev-sync ^2.0.0
• global-agent ^2.1.7
• govuk-elements-sass ^3.1.3
• govuk-frontend ^3.12.0
• govuk_frontend_toolkit ^9.0.0
• helmet ^3.21.3
• http-proxy-middleware 1.1.x
• isomorphic-fetch ^3.0.0
• karma-coverage ^2.2.1
• launchdarkly-js-client-sdk ^2.16.3
• local-storage ^2.0.0
• lodash ^4.17.21
• lz-string ^1.5.0
• material-design-icons ^3.0.1
• mochawesome ^6.2.1
• mochawesome-report-generator ^5.1.0
• moment-timezone ^0.5.28
• ngx-chips 2.1.0
• ngx-logger ^4.3.3
• ngx-md ^7.0.0
• ngx-pagination ^3.2.1
• node-http-proxy-json ^0.1.9
• p-iteration ^1.1.7
• pegjs ^0.10.0
• portfinder ^1.0.28
• protractor-screenshot-utils ^1.0.5
• puppeteer ^22.4.1
• rpx-xui-translation 1.0.2
• rx-polling-hmcts 1.1.1
• rxjs ^7.8.1
• rxjs-compat ^6.6.7
• shortid ^2.2.14
• smoothscroll-polyfill ^0.4.3
• stream ^0.0.2
• striptags ^3.1.1
• ts-enum-util 4.0.2
• tslib ^2.6.1
• web-animations-js ^2.3.2
• xlsx ^0.15.4
• yarn ^1.22.18
• zone.js ~0.13.1
• @angular-devkit/build-angular ~15.2.9
• @angular-eslint/builder 15.2.1
• @angular-material-components/moment-adapter ^15.0.0
• @angular/cli ^15.2.9
• @angular/compiler-cli ^15.2.9
• @angular/language-service ~15.2.9
• @ngrx/schematics ^14.3.0
• @pact-foundation/pact ^9.11.1
• @pact-foundation/pact-node ^10.9.7
• @stryker-mutator/api ^3.0.1
• @stryker-mutator/core ^3.0.1
• @stryker-mutator/html-reporter ^3.0.1
• @stryker-mutator/karma-runner ^3.0.1
• @stryker-mutator/mocha-runner ^3.0.1
• @stryker-mutator/typescript ^3.0.1
• @types/config ^0.0.36
• @types/cookie-parser ^1.4.2
• @types/crypto-js ^3.1.43
• @types/csurf ^1.11.0
• @types/ejs ^2.6.3
• @types/express ^4.16.1
• @types/express-session ^1.17.0
• @types/faker ^5.1.2
• @types/global-agent ^2.1.0
• @types/jasmine ~3.3.8
• @types/jasminewd2 ~2.0.3
• @types/mocha ^8.0.3
• @types/node ^18.17.0
• @types/shortid 0.0.29
• @types/sinon ^7.0.13
• @typescript-eslint/eslint-plugin ^5.57.0
• @typescript-eslint/parser ^5.57.0
• base-64 ^0.1.0
• chai ^4.3.10
• chai-as-promised 7.1.1
• codeceptjs-cucumber-json-reporter ^1.0.14
• codelyzer ^5.1.2
• cucumber 5.1.0
• cucumber-html-report 0.6.5
• cucumber-html-reporter ^7.1.1
• cucumber-pretty 1.5.0
• cucumberjs-allure-reporter 1.0.3
• eslint ^8.37.0
• jasmine-core ~3.4.0
• jasmine-marbles ^0.9.1
• jasmine-spec-reporter ~4.2.1
• jsonpath ^1.1.1
• jsonwebtoken ^8.5.1
• karma ~6.4.2
• karma-chrome-launcher 3.1.1
• karma-coverage ~2.0.3
• karma-coverage-istanbul-reporter ~2.0.1
• karma-jasmine 5.0.1
• karma-jasmine-html-reporter ^1.4.0
• karma-parallel ^0.3.1
• karma-sonarqube-unit-reporter ^0.0.23
• karma-spec-reporter 0.0.34
• mocha ^8.1.1
• mochawesome-merge ^4.3.0
• ngrx-store-freeze ^0.2.4
• node-fetch ^2.6.1
• node-html-parser ^6.1.5
• nodemon ^2.0.19
• npm-run-all ^4.1.5
• pa11y ^5.3.0
• playwright ^1.18
• protractor ~7.0.0
• protractor-cucumber-framework ^9.7.0
• protractor-multiple-cucumber-html-reporter-plugin 1.8.0
• sass ^1.66.1
• sinon ^7.3.2
• sinon-chai ^3.3.0
• sinon-express-mock ^2.2.0
• sonar-scanner ^3.1.0
• terser-webpack-plugin ^5.3.3
• ts-loader ^9.4.4
• ts-node ~10.8.1
• typescript ~4.9.5
• underscore ^1.9.1
• uuid ^8.3.1
• webpack ^5.75.0
• webpack-cli ^4.10.0
• webpack-node-externals ^3.0.0
• webpack-source-map-support ^2.0.1
• node >=18.17.0
• lodash ^4.17.21
• yarn 3.6.3

nvm

.nvmrc

• node 18.17.0

terraform

infrastructure/main.tf

infrastructure/provider.tf

• azurerm ~> 3.85.0
• hashicorp/terraform ~> 1.6.6

terraform-version

infrastructure/.terraform-version

• hashicorp/terraform 1.6.6

---

• Check this box to trigger a request for Renovate to run again on this repository