From 400942c6ad4aa66f6f21432c56947af1cbb82511 Mon Sep 17 00:00:00 2001 From: Tom Ridd Date: Wed, 8 Nov 2023 14:38:03 +0000 Subject: [PATCH] Haar 2038 filter functionality (#36) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Initial commit * Alee/init (#1) * Initial commit * πŸŽ‰ Initial drop of code * 🎨 Small tidy up * Adding circle build and updating node to v14 * Adding helm config * Fix wiremock port and update package.json Co-authored-by: Jon Brighton Co-authored-by: Jon Brighton * Fixing docker image (#2) * Fix secret name (#3) * Correcting variable names and removing unnecessary ones (#4) * Fixing variable name (#5) * Removing trailing slashes from env vars (#6) * Fix hostname (#7) * Update dependencies (#8) * Update dependencies Also move to use declaration overrides for describing additional possible fields in session data Also removing/moving unnecessary prod dependencies Moving jest tests to run in parallel * Fix types for user * Do not allow any warnings * Correcting test results path * Reducing docker image size (#9) Also * Update dependencies * Adopt standard github gitignore for node projects * Using body typography * Add rename script (#10) * Add rename script * PR reviews * Removing unused vars * Alee/decoupling auth client from redis (#11) * Decoupling auth client from redis impl * Update to latest hmpps orb version (#12) * Fixing build-info.json placement (#13) * Convert to arrow functions in utils (#14) * Convert to arrow functions in utils * Remove returns and fix prettier issues * Make the use of logger naming consistent (#15) * Adding outdated job (#16) * Adding outdated job * Updating dependencies * Removing patch to minor version * Updating dependencies (#17) * Moving to enable no-implicit-any (#18) * DT-1659: πŸ”¨ Remove helm copying secrets from AWS (#19) * Adding moj design system (#20) * Add new veracode scan for schedueled workflow (#21) * Add new veracode scan for schedueled workflow * Re-add - check_outdated job * Removing deprecated body parser (#22) * DT-1627: πŸ“„ Update license with correct year (#23) * Added missing ping endpoint as used by Kubernetes for liveliness probe (#24) * DT-2012 - upgrade hmpps orb, and add veracode policy scan job. (#25) * Use generic-service and generic-prometheus-alerts charts (#26) * Updating dependencies and adding slack notifications to outdated checks (#27) * Updating dependencies and adding slack notifications to outdated checks * Add slack orb * Moving to group middleware into related modules, following the pattern established in prison staff hub (#28) * Fix the slack notification on `check_outdated` (#30) * Ensure that the `SLACK_ACCESS_TOKEN` env var is set for `check_outdated` As the final step (on fail) is a slack notification we need to use a context containing the variable. * Refactor the channel for alerts into parameters This establishes a reusable pattern in case consumers wish to notify slack on other jobs. * Updating node dependencies (#31) * Fixing configuration of security audit (#32) The "medium" configuration was not an acceptable term, should be one of "info", "low", "moderate", "high" or "critical". This meant that it would not pick up on anything! * Alee/update dependencies (#33) * Updating dependencies and node * Use parameterised slack channel rather than default of typescript alerts channel * Extracting out executor * DT-2166 - add trivy image scanning job (#35) * Fix trivy scan job slack notifications channel (#36) * Use node executor and parameterise the version (#34) * WFP-322 use the hmpps/node executor to build * WFP-322 parameterise the node version in the executor * WFP-322 use node version parameter in integration test image * WFP-322 integration tests use new node_redis executor Co-authored-by: Andrew Lee <1517745+andrewrlee@users.noreply.github.com> * Deploy template project to template k8s namespace (#37) * Deploy template project to template k8s namespace * DT-2260 - update to latest circleci orb and chart dependencies (#38) * Updating dependencies and improving README (#39) * DT-2282: ⬆️ Fix veracode policy scan (#40) * Moving cypress tests to typescript (#41) * DT-2404: πŸ’„ Switch to sign in / out instead of login / out (#42) * DT-2404: πŸ’„ Switch to sign in / out instead of login / out * DT-2404: πŸ’„ Don't need .gitignore for husky any more * DT-2404: βœ… Run tests automatically on commit (#43) * Update dependencies (#44) * DT-2297 - Veracode - switch to daily pipeline scan (results in circleci), and weekly policy scan (upload to veracode portal). (#45) * DT-2297- randomise timing of circleci security workflow due to rate limiting at veracode. (#47) * update typescript (#48) * Fixing docker caching apt-get layer (#49) * Fix docker build failing, and reduce image size (#50) * Remove use of semi colons before arrays (#51) * Remove use of semi-colons before arrays * Fix typos in README * WFP-610 update to npmv7 and fix some audit (#52) * WFP-610 update to npm 7 * WFP-610 update outdated dependencies * WFP-610 fixed some audit vulnerabilities * WFP-610 updated passport-oauth2 * WFP-610 upgrade to jest-junit 13 to bring in new ansi-regex (#54) * Upgrading dependencies (#55) * FIXBUILD: update ansi-regex subdependency (#56) * DT-2702: πŸ”¨ Use new generic service configuration (#57) * Update dependencies (#58) * Moving to use HMPPS header (#59) * Moving to use HMPPS header * Removing explicit reference to DPS * Fix path of unit test results that are uploaded as artifacts (#60) and properly indent "build" job (jobs should be an array of [name] to dictionary) Co-authored-by: Jon Brighton * DT-2814: πŸ› Fix cron timings for veracode (#61) * NN-3747 fixing json structure for the stubUserRoles call and populating the user directly and not from the request because passport isn't in the test stack (#62) * Bumping node version (#63) Also fixing open handle in test and bumping dependencies * DT-2796: πŸ”¨ Migrate dev to live context (#64) * Update dependencies and move to NPM v8 (#65) * Upgrading dependencies (#66) * Update modules and remove express-request-id (#67) * INC-163 Timeout Fix - Correctly sets the timeout for a HttpAgent (#69) * ⬆️ update dependencies and πŸ’„add no-only-tests linting rule for cypress (#70) * ⬆️ update dependencies * πŸ’„Add no-only-tests linting rule for cypress * SDI-60: πŸ”¨ Add global protect and petty france to allowlists (#71) * Update dependencies (#72) * DCS-1442 jquery-ui.css coep fix (#73) * Fixing docker caching issue (#74) Need to refer to build args before calling apt-get upgrade otherwise the set of packages are cached and not upgraded. Docker cannot cache anything in layers after a dynamic variable has been used Also bumping version of node and fixing test compilation issue * Setup prometheus metrics by default. (#75) This change sets up prometheus metrics to be available on port 3001, and with the helm chart changes they will automatically get scraped and be available for alerts and dashboards in grafana. The added metrics include: - General nodejs stats: memory use, gc etc - HTTP server requests: counters and timings of all served HTTP requests by the app. - HTTP client requests: counters and timings of all HTTP requests to other upstream APIs (as long as they are based off `restClient.ts`). - Upstream healthchecks: guages recording the status/health of each upstream service when the healthcheck is tested. This is all backported from the `manage-recalls-ui` app, please let me know what you think. :) * Bump minimist from 1.2.5 to 1.2.6 (#76) Bumps [minimist](https://github.com/substack/minimist) from 1.2.5 to 1.2.6. - [Release notes](https://github.com/substack/minimist/releases) - [Commits](https://github.com/substack/minimist/compare/1.2.5...1.2.6) --- updated-dependencies: - dependency-name: minimist dependency-type: indirect ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Update dependencies (#77) * Audit fix (#79) * NN-4060: App Insights only works with bunyan v1 (#80) Co-authored-by: sp-watson * Update orb and dependencies (#82) * Stop metrics test from hitting a real service and occasionally timing out (#81) Co-authored-by: Jon Wyatt <> Co-authored-by: Andrew Lee <1517745+andrewrlee@users.noreply.github.com> * SDI-181: πŸ”§ Add jira notifications for new projects (#83) * Adding better redis error handling (#84) * SDI-181: πŸ”§ Use new cimg redis executor (#85) * SDI-181: πŸ”§ Use new cimg redis executor * SDI-181: πŸ”§ Improve docker ignore and use released orb instead * SDI-181: ⬆️ Bump node minor version * SLM-245 Restore cache prior to running up the app for the integration tests (#86) This caused an issue with our build where we received a segmentation fault as soon as the integration tests called the node app. Segmentation faults generally indicate an issue with one of the native C/C++ modules and it appears that one of these modules was relying on something we have stashed in the cache. * SDI-88: 🚨 Fix querystring warning (#87) * SDI-88: 🚨 Fix querystring warning * SDI-88: 🚨 Second attempt to querystring warning * SDI-88: πŸ› Fix cookie session down as a dependency (#88) * SDI-88: ♻️ Tidy up mocks and switch to multiplatform builds (#89) * Allow async get to take an array of strings for paths like original get method (#90) * SDI-182: ✨ Switch to using connection string instead (#91) * Update README.md (#92) * SDI-88: βœ… Add token verification integration tests (#94) * Minor "code smell" fixes suggested by Sonar Cloud (#95) * INC-567: Remove unnecessary type assertions * INC-567: Return resolved promise directly * SDI-211: πŸ”’οΈ Bump versions to fix security issues and cope with passport major upgrade (#96) * Updating dependencies (#97) * SDI-211: 🎨 Enforce trailing comma on functions too (#98) * SDI-211: 🎨 Enforce arrow parens (#99) * Bump dependencies (#100) * SDI-218: ⬆ Upgrade cypress to v10 (#101) * ⬆️ Update dependencies (#102) * Ignore false positive around nodemon (#103) * Ignore false positive around nodemon * Manage version of audit ci and provide full path to ignored dependency * Updating dependencies (#104) * Update dependencies (#105) * Create services container (#106) This allows passing through a container of wired up services through to route This approach has been used for the dps-shared and farsight projects and it leads to a testing approach that scales more naturally. Means you can pass through the services through to where they are needed and this can grow without changes propagating through the application Also extracted standard router into standalone middleware as the current approach relies on mutation and encourages making multiple copies of it. * SDI-265: ♻️ Minor improvements (#107) * SDI-265: 🚨 Add lint check for only (#108) * Update Jest to v28 and minor dependency updates (#109) * Remove duplicate
elements (#110) The govuk/template.njk which the layout.njk extends which these files use already includes a
element According to the HTML spec there should only be one
element present in the document at a time * Bumping dependencies and fixing page width (#111) * Bumping dependencies and fixing page width There seems to be a lot of variability in page width so going with something that seems most popular in HMPPS * Run tests in band Partially to fix tests hanging in circle, but also as test seems to run almost twice as fast (after clearing cache) * Add a `cspNonce` to the webSecurity setup (#112) Based on what I’ve seen elsewhere, this seems to now be a common approach to allow us to inline scripts, see: https://content-security-policy.com/nonce The GOV.UK frontend has now been updated to support the use of the `cspNonce` local - see: https://github.com/alphagov/govuk-frontend/commit/2e40d744af6e6e4213ebc47644982d4eb94422d4 So we no longer need to add the inline hash, which is vulnerable to if the code in the frontend template is changed. I’ve also removed the domain-specific overrides for jQuery scripts and styles, as we can use the nonce for this too. * Update dependencies 2022-08-22 (#113) * Update dependencies to fix check outdated flagging typescript (#114) * Update dependencies 2022-09-09 (#115) * Speeding up jest tests (#116) This speeds up the running of jest tests by enabling isolatedModules which has the effect of [disabling typechecking](https://kulshekhar.github.io/ts-jest/docs/getting-started/options/isolatedModules) It also drastically reduces memory usage, allowing for running tests in parallel locally at least. On my laptop this reduces the time to run the tests in this project from ~14 seconds to ~4 seconds. On larger projects the effect is much more pronounced, welcome-people-to-prison reduces build time from ~2mins, 20 seconds to ~25 seconds. In circle we still need to run in band but this is still significantly faster than before, in WPIP it reduces the build by over 1 min. Type checking is still available in the IDE, it is also part of the husky pre-commit hook and run by circle as part of the build, so the risk of type errors slipping through are very small. (We could possibly add a typechecking stage before running jest and it would still be much faster but not adding unless it becomes apparent that we need it ) It would be worth to re-assess this after jest 29 as there seems to be some fixes around a [memory issue](https://github.com/facebook/jest/issues/11956) that is part of node in versions > 16.10 NB: This will not work if type declaration (`d.ts`) files contain enums or any other constructs that generate javascript code. This seems to be a bit of an anti-pattern anyway (see [here](https://lukasbehal.com/2017-05-22-enums-in-declaration-files/)). Other tooling such as cypress will only allow you to import types from these files. * Removing colour from logs in production mode (#117) * Move ingress (#118) * Move ingress * CHange generic service to latest * SDI-345: ⬆️ Upgrade node and cypress (#119) * SDI-345: ⬆️ Upgrade node and cypress * SDI-345: ⬆️ Actually upgrade cypress * Fixing logging (#120) There was an issue where we weren't sending trace info to app insights. This is because appInsights needs to be imported before bunyan is imported so it can do its instrumentation magic. There was a related issue that obscured this. It was previously impossible to test app insights locally as dotenv wasn't set up correctly - it needed to happen before app insights is imported or app insights would prevent the app starting up. So this moves dotenv to dev dependencies and preloads it before running the app via start:dev. This removes some code that is only relevant for local development. It also means the application runs similar locally to how it would run in docker or kubernetes - it just expects the environment variables to be present. Also moving the app insights import so it's very apparent that it's the first thing that happens when the app starts. * Update dependencies 2022-09-28 (#121) * ⬆️Upgrade to latest helm chart versions (#122) * Adding badges (#123) * Adding badges * Update README.md * Updating node to v18 (#124) * Set helm timeout to 5 minutes (#125) * Use official redis image for docker-compose (#126) Which is suitable for arm64 and consistent with docker-compose-test which was updated with https://github.com/ministryofjustice/hmpps-template-typescript/pull/89 * Update Helm config to match Kotlin template (#127) * Update dependencies 2022-11-15 (#128) * Update dependencies 2022-11-16 (#129) * Update node images (#130) * SDI-476: ⬆ Bump versions (#131) * Update dependencies 2022-12-08 (#132) * Update dependencies 2022-12-19 (#133) * Bump jsonwebtoken from 8.5.1 to 9.0.0 (#136) Bumps [jsonwebtoken](https://github.com/auth0/node-jsonwebtoken) from 8.5.1 to 9.0.0. - [Release notes](https://github.com/auth0/node-jsonwebtoken/releases) - [Changelog](https://github.com/auth0/node-jsonwebtoken/blob/master/CHANGELOG.md) - [Commits](https://github.com/auth0/node-jsonwebtoken/compare/v8.5.1...v9.0.0) --- updated-dependencies: - dependency-name: jsonwebtoken dependency-type: direct:development ... Signed-off-by: dependabot[bot] Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Fix conflicting prettier / eslint rule (#135) In eslint, we ask for a trailing comma, while the prettier rules are set to `es5`. This causes issues if you have your IDE set up to fix on save, as one linter kicks in before the other, causing conflicting fixes. Co-authored-by: Andrew Lee <1517745+andrewrlee@users.noreply.github.com> * SDI-523: πŸ”’οΈ Fix / ignoresecurity issues (#138) * HEAT-41: use npm outdated job from HMPPS Orb; update other dependencies (#139) * Update dependencies 2023-01-24 (#140) * Update dependencies 2023-01-31 (#141) * Update dependencies 2023-02-01 (#142) * Configure Renovate (#144) * Add renovate.json * HEAT-52: source Renovate config from shared HMPPS repo * HEAT-52: tweak dependencies pinned by Renovate Inherit the ones from https://github.com/ministryofjustice/hmpps-renovate-config/blob/main/node.json * HEAT-52: manually bump Slack Orb as Renovate was complaining 'Can't find version matching 4.4.2 for slack' --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Neil Mendum * Update Helm release generic-service to v2.4.0 (#146) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * Update peter-evans/create-pull-request action to v4 (#148) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * Update actions/checkout action to v3 (#147) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * Add .nvmrc file, Prettier support for Nunjucks and use SCSS (#143) * Add .nvmrc file with node version set to `18` Update npm engine version to `^9` Add `prettier-plugin-jinja-template` as dev dependency plus config Refactor `.sass` files to `.scss` for consistency * Add newline to .nvmrc --------- Co-authored-by: Neil Mendum * Revert build_multiplatform_docker because it causes the build to take over an hour (#149) See Slack discussion https://mojdt.slack.com/archives/C69NWE339/p1671529301455009?thread_ts=1671529075.740459&cid=C69NWE339 * Update dependency cypress to ^12.5.1 (#150) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * HEAT-52: reduce the size of the PR body by specifying prBodyTemplate (#152) This should help with GitHub integration in Slack * Update all non major NPM dependencies (#151) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * Update all non major NPM dependencies (#153) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * Update all non major NPM dependencies (#155) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * Update all non major NPM dependencies (#156) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * Update all non major NPM dependencies (#159) * Update all non major NPM dependencies * Reduce Renovate stabilityDays so that it raises fewer PRs --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Neil Mendum * Update Helm release generic-service to v2.5.0 (#161) * Update Helm release generic-service to v2.5.0 * Drop generic-service params no longer required --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Neil Mendum * Update node image and regenerate package-lock.json (#165) * Update hmpps-orb to v7.2.1 (#166) * Upgrade to connect-redis 7 and update other dependencies (#168) * Upgrade to connect-redis 7 and update other dependencies * Remove legacy mode * Fix npm prune warning * Upgrade to typescript 5 (#169) * Add HMPPS Auth URL to form-action CSP string (#170) Update the Content Security Policy to allow the HMPPS Auth URL as a possible form action target. Currently, if a 403 error occurs on a GET request, this will be captured by the error handling setup in errorHandler.ts, and the user will be redirected to the sign out URL, which then redirects to the HMPPS Auth URL. However, if a 403 error occurs on a POST request, this second redirect may not occur, and the user may, depending on their choice of browser, be frozen on the form page they just submitted. Due to CSP implementation details that vary between browsers, adding the HMPPS Auth URL to our form action targets allows this second redirect to occur as expected. * Update TypeScript etc 2023-04-03 (#174) * Removing unnecessary build (#172) All 3 processes: tsc, sass and copy-views are run by concurrently at start up anyway * Update dependencies 2023-04-12 (#177) * SDIT-738: ⚑️ Cache static resources for 1 hour (#178) * Update dependencies 2023-04-21 (#181) * Fix security vuln 2023-04-25 (#183) * Update Helm release generic-service to v2.6.2 (#182) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Neil Mendum * SDIT-760: πŸ”§ Upgrade redis to 7 (#186) * Update Helm release generic-service to v2.6.3 (#184) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * Tie css cache to version of application (#188) At the moment the cache is linked to the start up time of pod, so get unnecessary cache misses for each pod in the cluster and also when pods restart This ties the cache to the git short hash of the deployment * Fix version not appearing in application insights (#190) * Fix version not appearing in application insights This previously relied on running a shell script to generate a file with a json payload in it. The code that read this file to extract out the version for the cache improvement and also setting the application version in app insights, was looking in the wrong location There was another location that looked up the file and read in the details for the health endpoint which was looking in the right place This change moves to reading the version and git reference into an env var in the docker file instead, which means we can centralise how this info is made available and remove the additional file management This should be a safe fix as the build info file was previously being generated from the docker build anyway - so the file should be available * Tidy up passing around application version * Update Helm release generic-prometheus-alerts to v1.3.2 (#189) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * Add PreProd and Prod helm config (#193) As per Kotlin Template https://github.com/ministryofjustice/hmpps-template-kotlin/tree/main/helm_deploy * Update slack orb to v4.12.5 (#185) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * Update peter-evans/create-pull-request action to v5 (#175) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * Update all non major NPM dependencies (#176) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * Update Node.js to v18.16 (#191) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * Update dependencies 2023-06-07 (#196) * Do not retry POST requests by default (#197) It doesn't really make sense to retry non-idempotent calls Also moving sanitised error over to a real error rather than a object. Makes it a little bit easier to test these: 'expect(..).reject.throws' etc.. doesn't work if you don't have really errors * Adding changelog (#198) * Have `sanitisedError` always return an Error instance (#199) … for the same reasons as explained in https://github.com/ministryofjustice/hmpps-template-typescript/pull/197 * Update all non major NPM dependencies (#195) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * Update all non major NPM dependencies (#200) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * Fix semver vuln (#202) * Update govuk-frontend to 4.7.0 (#205) * Update all non major NPM dependencies (#204) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * HEAT-82: Add productId and /info endpoint (#212) * HEAT-82: Add productId and /info endpoint * Update README and default value * Update values.yaml to point at README.md * Update README with dev portal URL (#213) * Update README with dev portal URL * Fix URL * Fix info endpoint test description (#214) * Update CHANGELOG.md (#216) * Fix linting, update modules, remove override (#219) * Move /info to health check block (#220) * Update dependencies 2023-09-05 (#226) * Update dependencies 2023-09-05 * Fix node version * Fix CircleCI workflows for cypress (#223) * Persist compiled stylesheets to workspace so that integration tests can load styles properly * Upload cypress screenshot and video artefacts from correct location * Fix cypress config and remove some vestigial code (#228) * Remove unused/vestigial integration test method * Remove deleted cypress config option * Update copyright date * Update readme (#229) * Update Helm release generic-prometheus-alerts to v1.3.3 (#224) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * Update redis Docker tag to v7.2 (#221) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * Update Node.js to v18.18 (#230) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * HEAT-106: Standardise endpoints (#231) * HEAT-106: Standardise endpoints * Fix e2e * Correct response * Update Dockerfile to pull through branch name * Amend output checks for int tests * Fix bugs and add Changelog * SDIT-1088: ✨ Get components to always return status even if failed (#232) * SDIT-1108: πŸ”§ Don't default build args (#233) * SDIT-1108: πŸ”§ Don't default build args * SDIT-1108: πŸ”§ Copy across args to env variables * SDIT-1108: πŸ”§ Add in docker compose build args and missing env vars * SDIT-1108: ♻️ Fix deprecated syntax version of ENV (#234) * SDIT-1108: ✨ Add in environment name to header (#235) * SDIT-1108: πŸ“ Add new environment name to changelog (#236) * NON-270: Improve REST client (#238) * Improve REST client typing information and add PATCH, PUT and DELETE methods allowing for query parameters as well as body payloads * Propagate user types into `res.locals` in request handlers * Update actions/checkout action to v4 (#225) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * Update all non major NPM dependencies (#210) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * Update Helm release generic-service to v2.6.5 (#237) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * Update dependencies 2023-10-17 (#243) * add tests for list base clients page * add view base client page * Fix errors in template * basic view for create new base client screen * HAAR-1891: Update deprecated endpoints with new endpoints (#247) * HAAR-1891: Update deprecated endpoints with new (manage users api) endpoints * HAAR-1891: Update following PR comments * HAAR-1891: Added MANAGE_USERS_API_URL values. * HAAR-1891: Added MANAGE_USERS_API_URL values. * Update renovate.json (#248) …to prevent Node docker image from being updated beyond LTS * post new base client with error loop * added controller tests * add tests for presenter * add test for expiry today * Move to Node 20 plus minor updates (#249) * Update CHANGELOG for node 20 change (#250) * Update CHANGELOG for node 20 change * Missed update link * Update jwt-decode module to version 4.0.0 (#252) * Update CHANGELOG.md (#253) * correct test comments and refactor time functions * Added changelog for PR #247 (#254) * display edit base clients details page * Add post update functionality * update test comments * update comments * display edit base clients deployment details page * add update deployment flow * fix integration test * remove excess helm folder * add manage-users-api to docker-compose * add remove client instance code * page to display Delete Client confirmation * test update * delete functionality - validation * add filter functionality --------- Signed-off-by: dependabot[bot] Co-authored-by: Andrew Lee <1517745+andrewrlee@users.noreply.github.com> Co-authored-by: Jon Brighton Co-authored-by: Jon Brighton Co-authored-by: Matt <34448412+mattops@users.noreply.github.com> Co-authored-by: Paul Solecki <51918433+psoleckimoj@users.noreply.github.com> Co-authored-by: petergphillips Co-authored-by: Andy Marke Co-authored-by: Darren Oakley Co-authored-by: markreesmoj <76954782+markreesmoj@users.noreply.github.com> Co-authored-by: Connor Glynn <66882795+connormaglynn@users.noreply.github.com> Co-authored-by: Gareth.m.Davies Co-authored-by: ushkarev Co-authored-by: richardpopple Co-authored-by: Michael Willis Co-authored-by: Louise N Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: sp-watson <77974320+sp-watson@users.noreply.github.com> Co-authored-by: sp-watson Co-authored-by: Jon Wyatt Co-authored-by: Mike Halma <58170926+mikehalmamoj@users.noreply.github.com> Co-authored-by: Richard James <44123869+richpjames@users.noreply.github.com> Co-authored-by: Stuart Harrison Co-authored-by: Neil Mendum Co-authored-by: carlov20 Co-authored-by: Neil Mendum Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: David Middleton <122619525+davidmiddletonmoj@users.noreply.github.com> Co-authored-by: Gareth.m.Davies Co-authored-by: bryangaledxw <94137563+bryangaledxw@users.noreply.github.com> Co-authored-by: ravmoj <104509282+ravmoj@users.noreply.github.com> --- docker-compose.yml | 17 + .../hmpps-template-typescript/.helmignore | 21 - .../hmpps-template-typescript/Chart.yaml | 12 - .../hmpps-template-typescript/values.yaml | 67 -- .../controllers/baseClientController.test.ts | 128 ++++ server/controllers/baseClientController.ts | 90 +++ server/interfaces/baseClientApi/baseClient.ts | 9 + server/mappers/forms/mapFilterForm.ts | 16 + server/routes/baseClientRouter.ts | 4 + server/testutils/factories/filter.ts | 11 + server/testutils/factories/index.ts | 2 + server/views/pages/base-client.njk | 690 +++++++++--------- server/views/pages/base-clients.njk | 19 +- server/views/pages/delete-client-instance.njk | 68 ++ .../listBaseClientsPresenter.test.ts | 63 +- .../presenters/listBaseClientsPresenter.ts | 54 +- .../viewBaseClientPresenter.test.ts | 4 +- .../presenters/viewBaseClientPresenter.ts | 2 +- 18 files changed, 806 insertions(+), 471 deletions(-) delete mode 100644 helm_deploy/hmpps-template-typescript/.helmignore delete mode 100644 helm_deploy/hmpps-template-typescript/Chart.yaml delete mode 100644 helm_deploy/hmpps-template-typescript/values.yaml create mode 100644 server/mappers/forms/mapFilterForm.ts create mode 100644 server/testutils/factories/filter.ts create mode 100644 server/views/pages/delete-client-instance.njk diff --git a/docker-compose.yml b/docker-compose.yml index cd5c1ea..bee9b04 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -24,6 +24,23 @@ services: - SPRING_PROFILES_ACTIVE=dev - APPLICATION_AUTHENTICATION_UI_ALLOWLIST=0.0.0.0/0 + manage-users-api: + image: quay.io/hmpps/hmpps-manage-users-api:latest + networks: + - hmpps + container_name: manage-users-api_mhaa + depends_on: + - hmpps-auth + ports: + - "9091:8080" + healthcheck: + test: [ "CMD", "curl", "-f", "http://localhost:8080/health" ] + environment: + - SERVER_PORT=8080 + - SPRING_PROFILES_ACTIVE=dev + - HMPPS_AUTH_ENDPOINT_URL=http://hmpps-auth:8080/auth + - EXTERNAL_USERS_ENDPOINT_URL=http://hmpps-external-users-api:8080 + app: build: context: . diff --git a/helm_deploy/hmpps-template-typescript/.helmignore b/helm_deploy/hmpps-template-typescript/.helmignore deleted file mode 100644 index f0c1319..0000000 --- a/helm_deploy/hmpps-template-typescript/.helmignore +++ /dev/null @@ -1,21 +0,0 @@ -# Patterns to ignore when building packages. -# This supports shell glob matching, relative path matching, and -# negation (prefixed with !). Only one pattern per line. -.DS_Store -# Common VCS dirs -.git/ -.gitignore -.bzr/ -.bzrignore -.hg/ -.hgignore -.svn/ -# Common backup files -*.swp -*.bak -*.tmp -*~ -# Various IDEs -.project -.idea/ -*.tmproj diff --git a/helm_deploy/hmpps-template-typescript/Chart.yaml b/helm_deploy/hmpps-template-typescript/Chart.yaml deleted file mode 100644 index 14b6cbd..0000000 --- a/helm_deploy/hmpps-template-typescript/Chart.yaml +++ /dev/null @@ -1,12 +0,0 @@ -apiVersion: v2 -appVersion: '1.0' -description: A Helm chart for Kubernetes -name: hmpps-template-typescript -version: 0.2.0 -dependencies: - - name: generic-service - version: 2.6.5 - repository: https://ministryofjustice.github.io/hmpps-helm-charts - - name: generic-prometheus-alerts - version: 1.3.3 - repository: https://ministryofjustice.github.io/hmpps-helm-charts diff --git a/helm_deploy/hmpps-template-typescript/values.yaml b/helm_deploy/hmpps-template-typescript/values.yaml deleted file mode 100644 index 3b918b0..0000000 --- a/helm_deploy/hmpps-template-typescript/values.yaml +++ /dev/null @@ -1,67 +0,0 @@ ---- -generic-service: - nameOverride: hmpps-template-typescript - productId: "UNASSIGNED" # productId for the product that this belongs too, i.e. DPS001, see README.md for details - - replicaCount: 4 - - image: - repository: quay.io/hmpps/hmpps-template-typescript - tag: app_version # override at deployment time - port: 3000 - - ingress: - enabled: true - host: app-hostname.local # override per environment - tlsSecretName: hmpps-template-typescript-cert - - livenessProbe: - httpGet: - path: /ping - - readinessProbe: - httpGet: - path: /ping - - custommetrics: - enabled: true - scrapeInterval: 15s - metricsPath: /metrics - metricsPort: 3001 - - # Environment variables to load into the deployment - env: - NODE_ENV: "production" - REDIS_TLS_ENABLED: "true" - TOKEN_VERIFICATION_ENABLED: "true" - APPLICATIONINSIGHTS_CONNECTION_STRING: "InstrumentationKey=$(APPINSIGHTS_INSTRUMENTATIONKEY);IngestionEndpoint=https://northeurope-0.in.applicationinsights.azure.com/;LiveEndpoint=https://northeurope.livediagnostics.monitor.azure.com/" - - # Pre-existing kubernetes secrets to load as environment variables in the deployment. - # namespace_secrets: - # [name of kubernetes secret]: - # [name of environment variable as seen by app]: [key of kubernetes secret to load] - - namespace_secrets: - hmpps-template-typescript: - APPINSIGHTS_INSTRUMENTATIONKEY: "APPINSIGHTS_INSTRUMENTATIONKEY" - API_CLIENT_ID: "API_CLIENT_ID" - API_CLIENT_SECRET: "API_CLIENT_SECRET" - SYSTEM_CLIENT_ID: "SYSTEM_CLIENT_ID" - SYSTEM_CLIENT_SECRET: "SYSTEM_CLIENT_SECRET" - SESSION_SECRET: "SESSION_SECRET" - elasticache-redis: - REDIS_HOST: "primary_endpoint_address" - REDIS_AUTH_TOKEN: "auth_token" - - allowlist: - office: "217.33.148.210/32" - health-kick: "35.177.252.195/32" - petty-france-wifi: "213.121.161.112/28" - global-protect: "35.176.93.186/32" - mojvpn: "81.134.202.29/32" - cloudplatform-live-1: "35.178.209.113/32" - cloudplatform-live-2: "3.8.51.207/32" - cloudplatform-live-3: "35.177.252.54/32" - -generic-prometheus-alerts: - targetApplication: hmpps-template-typescript diff --git a/server/controllers/baseClientController.test.ts b/server/controllers/baseClientController.test.ts index 663a8e4..35934d5 100644 --- a/server/controllers/baseClientController.test.ts +++ b/server/controllers/baseClientController.test.ts @@ -266,4 +266,132 @@ describe('BaseClientController', () => { expect(response.redirect).toHaveBeenCalledWith(`/base-clients/${baseClient.baseClientId}`) }) }) + + describe('create client instance', () => { + it('if success renders the secrets screen', async () => { + // GIVEN the service returns success and a set of secrets + const baseClient = baseClientFactory.build() + baseClientService.getBaseClient.mockResolvedValue(baseClient) + request = createMock({ body: { baseClientId: baseClient.baseClientId } }) + + const secrets = clientSecretsFactory.build() + baseClientService.addClientInstance.mockResolvedValue(secrets) + + // WHEN it is posted + await baseClientController.createClientInstance()(request, response, next) + + // THEN the new base client success page is rendered + expect(response.render).toHaveBeenCalledWith( + 'pages/new-base-client-success.njk', + expect.objectContaining({ secrets }), + ) + }) + }) + + describe('delete client instance', () => { + it.each([ + ['renders one client instance', 1, true], + ['renders multiple client instances', 3, false], + ])(`if %s renders the page with isLastClient %s`, async (_, clientCount, isLastClient) => { + // GIVEN a base client + const baseClient = baseClientFactory.build() + const clients = clientFactory.buildList(clientCount) + const client = clients[0] + baseClientService.getBaseClient.mockResolvedValue(baseClient) + baseClientService.listClientInstances.mockResolvedValue(clients) + + // WHEN the index page is requested + request = createMock({ params: { baseClientId: baseClient.baseClientId, clientId: client.clientId } }) + await baseClientController.displayDeleteClientInstance()(request, response, next) + + // THEN the view base client page is rendered with isLastClient true + expect(response.render).toHaveBeenCalledWith('pages/delete-client-instance.njk', { + baseClient, + clientId: client.clientId, + isLastClient, + error: null, + }) + + // AND the base client is retrieved from the base client service + expect(baseClientService.getBaseClient).toHaveBeenCalledWith(token, baseClient.baseClientId) + + // AND the clients are retrieved from the base client service + expect(baseClientService.listClientInstances).toHaveBeenCalledWith(token, baseClient) + }) + + it(`renders the page with error`, async () => { + // GIVEN a base client + const baseClient = baseClientFactory.build() + const clients = clientFactory.buildList(3) + const client = clients[0] + baseClientService.getBaseClient.mockResolvedValue(baseClient) + baseClientService.listClientInstances.mockResolvedValue(clients) + const errorCode = 'clientIdMismatch' + + // WHEN the index page is requested + request = createMock({ + params: { baseClientId: baseClient.baseClientId, clientId: client.clientId }, + query: { error: errorCode }, + }) + await baseClientController.displayDeleteClientInstance()(request, response, next) + + // THEN the view base client page is rendered with error + const expectedError = 'Client ID does not match' + expect(response.render).toHaveBeenCalledWith('pages/delete-client-instance.njk', { + baseClient, + clientId: client.clientId, + isLastClient: false, + error: expectedError, + }) + }) + + describe(`delete the client instance`, () => { + it.each([ + ['one client instance exists', '/', 1], + ['multiple client instances', '/base-clients/abcd', 3], + ])(`if delete successful and %s, redirects to %s`, async (_, redirectURL, clientCount) => { + // GIVEN a base client + const baseClient = baseClientFactory.build({ baseClientId: 'abcd' }) + const clients = clientFactory.buildList(clientCount) + const client = clients[0] + baseClientService.getBaseClient.mockResolvedValue(baseClient) + baseClientService.listClientInstances.mockResolvedValue(clients) + + // WHEN a delete request is made + request = createMock({ + params: { baseClientId: baseClient.baseClientId, clientId: client.clientId }, + query: { error: null }, + body: { confirm: client.clientId }, + }) + await baseClientController.deleteClientInstance()(request, response, next) + + // THEN the client instance is deleted + expect(baseClientService.deleteClientInstance).toHaveBeenCalledWith(token, client) + + // AND the user is redirected + expect(response.redirect).toHaveBeenCalledWith(redirectURL) + }) + + it(`if client does not match, redirects with error`, async () => { + // GIVEN a base client + const baseClient = baseClientFactory.build({ baseClientId: 'abcd' }) + const clients = clientFactory.buildList(3) + const client = clients[0] + baseClientService.getBaseClient.mockResolvedValue(baseClient) + baseClientService.listClientInstances.mockResolvedValue(clients) + + // WHEN a delete request is made + request = createMock({ + params: { baseClientId: baseClient.baseClientId, clientId: client.clientId }, + query: { error: null }, + body: { confirm: 'something incorrect' }, + }) + await baseClientController.deleteClientInstance()(request, response, next) + + // THEN the user is redirected with error + const expectedURL = `/base-clients/${baseClient.baseClientId}/clients/${client.clientId}/delete?error=clientIdMismatch` + expect(response.redirect).toHaveBeenCalledWith(expectedURL) + }) + }) + }) }) diff --git a/server/controllers/baseClientController.ts b/server/controllers/baseClientController.ts index ff732d4..aef6a3d 100644 --- a/server/controllers/baseClientController.ts +++ b/server/controllers/baseClientController.ts @@ -6,6 +6,7 @@ import nunjucksUtils from '../views/helpers/nunjucksUtils' import { mapCreateBaseClientForm, mapEditBaseClientDeploymentForm, mapEditBaseClientDetailsForm } from '../mappers' import { BaseClient } from '../interfaces/baseClientApi/baseClient' import editBaseClientPresenter from '../views/presenters/editBaseClientPresenter' +import mapFilterForm from '../mappers/forms/mapFilterForm' export default class BaseClientController { constructor(private readonly baseClientService: BaseClientService) {} @@ -23,6 +24,21 @@ export default class BaseClientController { } } + public filterBaseClients(): RequestHandler { + return async (req, res) => { + const userToken = res.locals.user.token + const filter = mapFilterForm(req) + + const baseClients = await this.baseClientService.listBaseClients(userToken) + + const presenter = listBaseClientsPresenter(baseClients, filter) + + res.render('pages/base-clients.njk', { + presenter, + }) + } + } + public displayBaseClient(): RequestHandler { return async (req, res) => { const userToken = res.locals.user.token @@ -159,4 +175,78 @@ export default class BaseClientController { res.redirect(`/base-clients/${baseClientId}`) } } + + public createClientInstance(): RequestHandler { + return async (req, res, next) => { + const userToken = res.locals.user.token + const { baseClientId } = req.params + + // get base client + const baseClient = await this.baseClientService.getBaseClient(userToken, baseClientId) + + // Create base client + const secrets = await this.baseClientService.addClientInstance(userToken, baseClient) + + // Display success page + res.render('pages/new-base-client-success.njk', { + title: `Client has been added`, + baseClientId: baseClient.baseClientId, + secrets, + }) + } + } + + public displayDeleteClientInstance(): RequestHandler { + return async (req, res, next) => { + const userToken = res.locals.user.token + const { baseClientId, clientId } = req.params + const error = req.query.error === 'clientIdMismatch' ? 'Client ID does not match' : null + + // get base client + const baseClient = await this.baseClientService.getBaseClient(userToken, baseClientId) + const clients = await this.baseClientService.listClientInstances(userToken, baseClient) + + // Display delete confirmation page + res.render('pages/delete-client-instance.njk', { + baseClient, + clientId, + isLastClient: clients.length === 1, + error, + }) + } + } + + public deleteClientInstance(): RequestHandler { + return async (req, res, next) => { + const userToken = res.locals.user.token + const { baseClientId, clientId } = req.params + + // check client id matches + if (req.body.confirm !== clientId) { + res.redirect(`/base-clients/${baseClientId}/clients/${clientId}/delete?error=clientIdMismatch`) + return + } + + // get base client + const baseClient = await this.baseClientService.getBaseClient(userToken, baseClientId) + const clients = await this.baseClientService.listClientInstances(userToken, baseClient) + const client = clients.find(c => c.clientId === clientId) + + // check client exists + if (!client) { + res.redirect(`/base-clients/${baseClientId}/clients/${clientId}/delete?error=clientNotFound`) + return + } + + // delete client + await this.baseClientService.deleteClientInstance(userToken, client) + + // return to view base client screen (or home screen if last client deleted) + if (clients.length === 1) { + res.redirect(`/`) + } else { + res.redirect(`/base-clients/${baseClientId}`) + } + } + } } diff --git a/server/interfaces/baseClientApi/baseClient.ts b/server/interfaces/baseClientApi/baseClient.ts index 7734c5e..4e7421f 100644 --- a/server/interfaces/baseClientApi/baseClient.ts +++ b/server/interfaces/baseClientApi/baseClient.ts @@ -56,3 +56,12 @@ export interface ClientSecrets { base64ClientId: string base64ClientSecret: string } + +export interface BaseClientListFilter { + roleSearch: string + clientCredentials: boolean + authorisationCode: boolean + serviceClientType: boolean + personalClientType: boolean + blankClientType: boolean +} diff --git a/server/mappers/forms/mapFilterForm.ts b/server/mappers/forms/mapFilterForm.ts new file mode 100644 index 0000000..8f1103e --- /dev/null +++ b/server/mappers/forms/mapFilterForm.ts @@ -0,0 +1,16 @@ +import { Request } from 'express' +import { BaseClientListFilter } from '../../interfaces/baseClientApi/baseClient' + +export default (request: Request): BaseClientListFilter => { + // valid days is calculated from expiry date + const data = request.body + + return { + roleSearch: data.role.trim(), + clientCredentials: data.grantType ? data.grantType.includes('client-credentials') : true, + authorisationCode: data.grantType ? data.grantType.includes('authorization-code') : true, + serviceClientType: data.clientType ? data.clientType.includes('service') : true, + personalClientType: data.clientType ? data.clientType.includes('personal') : true, + blankClientType: data.clientType ? data.clientType.includes('blank') : true, + } +} diff --git a/server/routes/baseClientRouter.ts b/server/routes/baseClientRouter.ts index e0b2477..228e717 100644 --- a/server/routes/baseClientRouter.ts +++ b/server/routes/baseClientRouter.ts @@ -25,8 +25,12 @@ export default function baseClientRouter(services: Services): Router { get('/base-clients/:baseClientId/deployment', baseClientController.displayEditBaseClientDeployment()) get('/base-clients/:baseClientId/edit', baseClientController.displayEditBaseClient()) get('/base-clients/:baseClientId', baseClientController.displayBaseClient()) + get('/base-clients/:baseClientId/clients/:clientId/delete', baseClientController.displayDeleteClientInstance()) + post('/', baseClientController.filterBaseClients()) post('/base-clients/new', baseClientController.createBaseClient()) post('/base-clients/:baseClientId/deployment', baseClientController.updateBaseClientDeployment()) post('/base-clients/:baseClientId/edit', baseClientController.updateBaseClientDetails()) + post('/base-clients/:baseClientId/clients', baseClientController.createClientInstance()) + post('/base-clients/:baseClientId/clients/:clientId/delete', baseClientController.deleteClientInstance()) return router } diff --git a/server/testutils/factories/filter.ts b/server/testutils/factories/filter.ts new file mode 100644 index 0000000..15af529 --- /dev/null +++ b/server/testutils/factories/filter.ts @@ -0,0 +1,11 @@ +import { Factory } from 'fishery' +import { BaseClientListFilter } from '../../interfaces/baseClientApi/baseClient' + +export default Factory.define(() => ({ + roleSearch: '', + clientCredentials: true, + authorisationCode: true, + serviceClientType: true, + personalClientType: true, + blankClientType: true, +})) diff --git a/server/testutils/factories/index.ts b/server/testutils/factories/index.ts index 1159afe..41044a6 100644 --- a/server/testutils/factories/index.ts +++ b/server/testutils/factories/index.ts @@ -10,6 +10,7 @@ import updateBaseClientRequestFactory from './requests/updateBaseClientRequest' import updateBaseClientDeploymentFactory from './requests/updateBaseClientDeploymentRequest' import listClientInstancesResponseFactory from './responses/listClientInstancesResponse' import clientSecretsFactory from './secrets' +import filterFactory from './filter' export { baseClientFactory, @@ -22,4 +23,5 @@ export { updateBaseClientRequestFactory, updateBaseClientDeploymentFactory, listClientInstancesResponseFactory, + filterFactory, } diff --git a/server/views/pages/base-client.njk b/server/views/pages/base-client.njk index 83d27b8..e368421 100644 --- a/server/views/pages/base-client.njk +++ b/server/views/pages/base-client.njk @@ -4,10 +4,9 @@ {% set mainClasses = "app-container govuk-body" %} {% set pageName="Home" %} -{% set bodyClasses = "extra-wide" %} {% block header %} - {% include "partials/header.njk" %} + {% include "partials/header.njk" %} {% endblock %} {%- from "moj/components/header/macro.njk" import mojHeader -%} @@ -22,370 +21,371 @@ {%- from "govuk/components/table/macro.njk" import govukTable -%} {% block content %} - {{ govukBackLink({ - text: "Back", - href: "/" - }) }} + {{ govukBackLink({ + text: "Back", + href: "/" + }) }} -
-
- -

- Client: {{ baseClient.baseClientId }} -

+
+
- {{ govukTable({ - firstCellIsHeader: false, - head: [ - { - text: "Client ID" - },{ - text: "Created" - },{ - text: "Last accessed" - },{ - text: "" - } - ], - rows: presenter.clientsTable - }) }} +

+ Client: {{ baseClient.baseClientId }} +

-
-
- {{ govukButton({ - text: "Add new client" - }) }} -
-
+ {{ govukTable({ + firstCellIsHeader: false, + head: [ + { + text: "Client ID" + },{ + text: "Created" + },{ + text: "Last accessed" + },{ + text: "" + } + ], + rows: presenter.clientsTable + }) }} -
-
-

Base client details

-
-
- Change - client details -
-
+
+ +
+ {{ govukButton({ + text: "Add new client" + }) }} +
+
- {{ govukTable({ - firstCellIsHeader: false, - head: [ - { - text: "Base client" - },{ - text: baseClient.baseClientId - }], - rows: [ - [ - { - text: "Client type" - },{ - text: capitalize(baseClient.clientType) - } - ], - [ - { - text: "Access token validity" - },{ - text: baseClient.accessTokenValidity - } - ],[ - { - text: "Approved scopes" - },{ - html: toLinesHtml(baseClient.scopes) - } - ] - ] - }) }} +
+
+

Base client details

+
+
+ Change + client details +
+
- {{ govukTable({ - firstCellIsHeader: false, - head: [ - { - text: "Audit trail" - },{ - text: "" - }], - rows: [ - [{ - text: "Details" - },{ - text: baseClient.audit - }] - ] - }) }} + {{ govukTable({ + firstCellIsHeader: false, + head: [ + { + text: "Base client" + },{ + text: baseClient.baseClientId + }], + rows: [ + [ + { + text: "Client type" + },{ + text: capitalize(baseClient.clientType) + } + ], + [ + { + text: "Access token validity" + },{ + text: baseClient.accessTokenValidity + } + ],[ + { + text: "Approved scopes" + },{ + html: toLinesHtml(baseClient.scopes) + } + ] + ] + }) }} + {{ govukTable({ + firstCellIsHeader: false, + head: [ + { + text: "Audit trail" + },{ + text: "" + }], + rows: [ + [{ + text: "Details" + },{ + text: baseClient.audit + }] + ] + }) }} - {% if baseClient.grantType == "client_credentials" %} - {{ govukTable({ - firstCellIsHeader: false, - head: [ - { - text: "Grant details" - },{ - text: "" - }], - rows: [ - [ - { - text: "Grant type" - },{ - text: "Client credentials" - } - ],[ - { - text: "Roles" - },{ - html: toLinesHtml(baseClient.clientCredentials.authorities) - } - ],[ - { - text: "Database username" - },{ - text: baseClient.clientCredentials.databaseUserName - } - ] - ] - }) }} - {% endif %} - {% if baseClient.grantType == "authorization_code" %} - {{ govukTable({ - firstCellIsHeader: false, - head: [ - { - text: "Grant details" - },{ - text: "" - }], - rows: [ - [ - { - text: "Grant type" - },{ - text: "Authorization code" - } - ],[ - { - text: "Registered redirect URIs" - },{ - text: toLinesHtml(baseClient.authorisationCode.registeredRedirectURIs) - } - ],[ - { - text: "JWT Fields Configuration" - },{ - text: baseClient.authorisationCode.jwtFields - } - ],[ - { - text: "Azure Ad login flow" - },{ - text: presenter.skipToAzureField - } - ] - ] - }) }} - {% endif %} + {% if baseClient.grantType == "client_credentials" %} + {{ govukTable({ + firstCellIsHeader: false, + head: [ + { + text: "Grant details" + },{ + text: "" + }], + rows: [ + [ + { + text: "Grant type" + },{ + text: "Client credentials" + } + ],[ + { + text: "Roles" + },{ + html: toLinesHtml(baseClient.clientCredentials.authorities) + } + ],[ + { + text: "Database username" + },{ + text: baseClient.clientCredentials.databaseUserName + } + ] + ] + }) }} + {% endif %} + {% if baseClient.grantType == "authorization_code" %} + {{ govukTable({ + firstCellIsHeader: false, + head: [ + { + text: "Grant details" + },{ + text: "" + }], + rows: [ + [ + { + text: "Grant type" + },{ + text: "Authorization code" + } + ],[ + { + text: "Registered redirect URIs" + },{ + text: toLinesHtml(baseClient.authorisationCode.registeredRedirectURIs) + } + ],[ + { + text: "JWT Fields Configuration" + },{ + text: baseClient.authorisationCode.jwtFields + } + ],[ + { + text: "Azure Ad login flow" + },{ + text: presenter.skipToAzureField + } + ] + ] + }) }} + {% endif %} - {{ govukTable({ - firstCellIsHeader: false, - head: [ - { - text: "Config" - },{ - text: "" - }], - rows: [ - [ - { - text: "Allow client to expire" - },{ - text: presenter.expiry - } - ],[ - { - text: "Allowed IPs" - },{ - html: toLinesHtml(baseClient.config.allowedIPs) - } - ] - ] - }) }} + {{ govukTable({ + firstCellIsHeader: false, + head: [ + { + text: "Config" + },{ + text: "" + }], + rows: [ + [ + { + text: "Allow client to expire" + },{ + text: presenter.expiry + } + ],[ + { + text: "Allowed IPs" + },{ + html: toLinesHtml(baseClient.config.allowedIPs) + } + ] + ] + }) }} - {% if baseClient.grantType == "authorization_code" %} -
-
-

Service details

-
-
- Change - service details -
-
- {{ govukTable({ - firstCellIsHeader: false, - head: [ - { - text: "Service details" - },{ - text: "" - }], - rows: [ - [ - { - text: "Name" - },{ - text: baseClient.serviceDetails.serviceName - } - ],[ - { - text: "Description" - },{ - text: baseClient.serviceDetails.serviceDescription - } - ],[ - { - text: "Authorised roles" - },{ - text: baseClient.serviceDetails.serviceAuthorisedRoles.join('
') - } - ],[ - { - text: "URL" - },{ - text: baseClient.serviceDetails.serviceURL - } - ],[ - { - text: "Contact URL/email" - },{ - text: baseClient.serviceDetails.contactUsURL - } - ],[ - { - text: "Status" - },{ - text: presenter.serviceEnabledLabel - } - ] - ] - }) }} - {% endif %} + {% if baseClient.grantType == "authorization_code" %} +
+
+

Service details

+
+
+ Change + service details +
+
-
-
-

Deployment details

-
-
- Change - deployment details -
-
+ {{ govukTable({ + firstCellIsHeader: false, + head: [ + { + text: "Service details" + },{ + text: "" + }], + rows: [ + [ + { + text: "Name" + },{ + text: baseClient.serviceDetails.serviceName + } + ],[ + { + text: "Description" + },{ + text: baseClient.serviceDetails.serviceDescription + } + ],[ + { + text: "Authorised roles" + },{ + text: baseClient.serviceDetails.serviceAuthorisedRoles.join('
') + } + ],[ + { + text: "URL" + },{ + text: baseClient.serviceDetails.serviceURL + } + ],[ + { + text: "Contact URL/email" + },{ + text: baseClient.serviceDetails.contactUsURL + } + ],[ + { + text: "Status" + },{ + text: presenter.serviceEnabledLabel + } + ] + ] + }) }} + {% endif %} - {{ govukTable({ - firstCellIsHeader: false, - head: [ - { - text: "Contact" - },{ - text: "" - }], - rows: [ - [ - { - text: "Team" - },{ - text: baseClient.deployment.team - } - ], - [ - { - text: "Team contact" - },{ - text: baseClient.deployment.teamContact - } - ], - [ - { - text: "Team slack" - },{ - text: baseClient.deployment.teamSlack - } - ] - ] - }) }} +
+
+

Deployment details

+
+
+ Change + deployment details +
+
- {{ govukTable({ - firstCellIsHeader: false, - head: [ - { - text: "Platform" - },{ - text: "" - }], - rows: [ - [ - { - text: "Hosting" - },{ - text: baseClient.deployment.hosting - } - ], - [ - { - text: "Namespace" - },{ - text: baseClient.deployment.namespace - } - ], - [ - { - text: "Deployment" - },{ - text: baseClient.deployment.deployment - } - ], - [ - { - text: "Secret name" - },{ - text: baseClient.deployment.secretName - } - ], - [ - { - text: "Client id key" - },{ - text: baseClient.deployment.clientIdKey - } - ], - [ - { - text: "Secret key" - },{ - text: baseClient.deployment.secretKey - } - ], - [ - { - text: "Deployment info" - },{ - text: baseClient.deployment.deploymentInfo - } - ] + {{ govukTable({ + firstCellIsHeader: false, + head: [ + { + text: "Contact" + },{ + text: "" + }], + rows: [ + [ + { + text: "Team" + },{ + text: baseClient.deployment.team + } + ], + [ + { + text: "Team contact" + },{ + text: baseClient.deployment.teamContact + } + ], + [ + { + text: "Team slack" + },{ + text: baseClient.deployment.teamSlack + } + ] + ] + }) }} - ] - }) }} + {{ govukTable({ + firstCellIsHeader: false, + head: [ + { + text: "Platform" + },{ + text: "" + }], + rows: [ + [ + { + text: "Hosting" + },{ + text: baseClient.deployment.hosting + } + ], + [ + { + text: "Namespace" + },{ + text: baseClient.deployment.namespace + } + ], + [ + { + text: "Deployment" + },{ + text: baseClient.deployment.deployment + } + ], + [ + { + text: "Secret name" + },{ + text: baseClient.deployment.secretName + } + ], + [ + { + text: "Client id key" + },{ + text: baseClient.deployment.clientIdKey + } + ], + [ + { + text: "Secret key" + },{ + text: baseClient.deployment.secretKey + } + ], + [ + { + text: "Deployment info" + },{ + text: baseClient.deployment.deploymentInfo + } + ] -
+ ] + }) }}
+
+ {% endblock %} diff --git a/server/views/pages/base-clients.njk b/server/views/pages/base-clients.njk index d53c51f..3c0d4c6 100644 --- a/server/views/pages/base-clients.njk +++ b/server/views/pages/base-clients.njk @@ -32,7 +32,8 @@ label: { text: 'Role', classes: 'govuk-label--m' - } + }, + value: presenter.filter.roleSearch }) }} {{ govukCheckboxes({ @@ -49,12 +50,12 @@ { value: 'client-credentials', text: 'Client credentials', - checked: true + checked: presenter.filter.clientCredentials }, { value: 'authorization-code', text: 'Authorization code', - checked: true + checked: presenter.filter.authorisationCode } ] }) }} @@ -73,17 +74,17 @@ { value: 'service', text: 'Service', - checked: true + checked: presenter.filter.serviceClientType }, { value: 'personal', text: 'Personal', - checked: true + checked: presenter.filter.personalClientType }, { value: 'blank', text: '[blank]', - checked: true + checked: presenter.filter.blankClientType } ] }) }} @@ -94,10 +95,10 @@ {% block content %} -
+
- + {{ mojFilter({ heading: { text: 'Filter' @@ -142,7 +143,7 @@ }) }}
-
+ {% endblock %} {% block pageScripts %} diff --git a/server/views/pages/delete-client-instance.njk b/server/views/pages/delete-client-instance.njk new file mode 100644 index 0000000..47518d0 --- /dev/null +++ b/server/views/pages/delete-client-instance.njk @@ -0,0 +1,68 @@ +{% extends "../partials/layout.njk" %} + +{% set pageTitle = applicationName + " - Home" %} +{% set mainClasses = "app-container govuk-body" %} + +{% set pageName="Delete client?" %} + +{% block header %} + {% include "partials/header.njk" %} +{% endblock %} + +{%- from "moj/components/header/macro.njk" import mojHeader -%} +{% from "govuk/components/input/macro.njk" import govukInput %} +{% from "govuk/components/button/macro.njk" import govukButton %} +{% from "govuk/components/warning-text/macro.njk" import govukWarningText %} + +{% block content %} + +
+

Delete client?

+ +
+
+ + {% if isLastClient %} + {{ govukWarningText({ + text: "Deleting this client will also delete base-client '" + baseClient.baseClientId + "'.", + iconFallbackText: "Warning" + }) }} + {% endif %} + {{ govukWarningText({ + text: "Deleted clients cannot be restored!", + iconFallbackText: "Warning" + }) }} + + +
+ + {{ govukInput({ + label: { + text: "Confirmation" + }, + hint: { + html: "Type \"" + clientId + "\" to confirm" + }, + errorMessage: { + text: error + }, + classes: "govuk-!-width-two-thirds", + id: "confirm", + name: "confirm" + }) }} + + {{ govukButton({ + text: "Delete client instance", + type: "submit", + classes: "govuk-button--warning" + }) }} + {{ govukButton({ + text: "Cancel", + href: "/base-clients/" + baseClient.baseClientId + }) }} +
+
+
+
+ +{% endblock %} diff --git a/server/views/presenters/listBaseClientsPresenter.test.ts b/server/views/presenters/listBaseClientsPresenter.test.ts index 80048ee..23793d8 100644 --- a/server/views/presenters/listBaseClientsPresenter.test.ts +++ b/server/views/presenters/listBaseClientsPresenter.test.ts @@ -1,6 +1,6 @@ import { BaseClient } from '../../interfaces/baseClientApi/baseClient' -import { baseClientFactory } from '../../testutils/factories' -import listBaseClientsPresenter from './listBaseClientsPresenter' +import { baseClientFactory, filterFactory } from '../../testutils/factories' +import listBaseClientsPresenter, { filterBaseClient } from './listBaseClientsPresenter' let baseClients: BaseClient[] @@ -22,7 +22,7 @@ describe('listBaseClientsPresenter', () => { it('contains a constant for table head', () => { // When we map to a presenter - const presenter = listBaseClientsPresenter(baseClients) + const presenter = listBaseClientsPresenter(baseClients, filterFactory.build()) // Then it contains a table head constant expect(presenter.tableHead).not.toBeNull() @@ -31,11 +31,11 @@ describe('listBaseClientsPresenter', () => { describe('tableHeadRows', () => { it('maps a link to the view page in the first column', () => { // When we map to a presenter - const presenter = listBaseClientsPresenter(baseClients) + const presenter = listBaseClientsPresenter(baseClients, filterFactory.build()) const expected = [ - 'baseClientIdA', - 'baseClientIdB', + "baseClientIdA", + "baseClientIdB", ] const actual = presenter.tableRows.map(row => row[0].html) expect(actual).toEqual(expected) @@ -44,7 +44,7 @@ describe('listBaseClientsPresenter', () => { it('maps moj-badge for count to the second column if count > 1', () => { // When we map to a presenter const presenter = listBaseClientsPresenter(baseClients) - const expected = ['', '2'] + const expected = ['', "2"] const actual = presenter.tableRows.map(row => row[1].html) expect(actual).toEqual(expected) }) @@ -57,4 +57,53 @@ describe('listBaseClientsPresenter', () => { expect(actual).toEqual(expected) }) }) + + describe('filter', () => { + describe('by role - free text search', () => { + it('matches if the free text matches a client credentials authority', () => { + const filter = filterFactory.build({ roleSearch: 'ONE' }) + const baseClient = baseClientFactory.build({ clientCredentials: { authorities: ['ONE', 'TWO'] } }) + + const passesFilter = filterBaseClient(baseClient, filter) + + expect(passesFilter).toBeTruthy() + }) + + it('is case insensitive', () => { + const filter = filterFactory.build({ roleSearch: 'onE' }) + const baseClient = baseClientFactory.build({ clientCredentials: { authorities: ['ONE', 'TWO'] } }) + + const passesFilter = filterBaseClient(baseClient, filter) + + expect(passesFilter).toBeTruthy() + }) + + it('ignores whitespace', () => { + const filter = filterFactory.build({ roleSearch: ' one ' }) + const baseClient = baseClientFactory.build({ clientCredentials: { authorities: ['ONE', 'TWO'] } }) + + const passesFilter = filterBaseClient(baseClient, filter) + + expect(passesFilter).toBeTruthy() + }) + + it('does not filter if search is empty', () => { + const filter = filterFactory.build({ roleSearch: '' }) + const baseClient = baseClientFactory.build({ clientCredentials: { authorities: ['ONE', 'TWO'] } }) + + const passesFilter = filterBaseClient(baseClient, filter) + + expect(passesFilter).toBeTruthy() + }) + + it('does not matches if the free text not contained in a client credentials authority', () => { + const filter = filterFactory.build({ roleSearch: 'ONE' }) + const baseClient = baseClientFactory.build({ clientCredentials: { authorities: ['alpha', 'beta'] } }) + + const passesFilter = filterBaseClient(baseClient, filter) + + expect(passesFilter).toBeFalsy() + }) + }) + }) }) diff --git a/server/views/presenters/listBaseClientsPresenter.ts b/server/views/presenters/listBaseClientsPresenter.ts index 8685ff6..9fc0822 100644 --- a/server/views/presenters/listBaseClientsPresenter.ts +++ b/server/views/presenters/listBaseClientsPresenter.ts @@ -1,4 +1,4 @@ -import { BaseClient } from '../../interfaces/baseClientApi/baseClient' +import { BaseClient, BaseClientListFilter } from '../../interfaces/baseClientApi/baseClient' import { convertToTitleCase } from '../../utils/utils' const indexTableHead = () => { @@ -69,13 +69,15 @@ const indexTableHead = () => { ] } -const indexTableRows = (data: BaseClient[]) => { - return data.map(item => [ +const indexTableRows = (data: BaseClient[], filter?: BaseClientListFilter) => { + const dataItems = filterItems(data, filter) + + return dataItems.map(item => [ { - html: `${item.baseClientId}`, + html: `${item.baseClientId}`, }, { - html: item.count > 1 ? `${item.count}` : '', + html: item.count > 1 ? `${item.count}` : '', }, { text: item.clientType ? convertToTitleCase(item.clientType) : '', @@ -101,9 +103,47 @@ const indexTableRows = (data: BaseClient[]) => { ]) } -export default (data: BaseClient[]) => { +const filterItems = (data: BaseClient[], filter?: BaseClientListFilter) => { + return filter ? data.filter(item => filterBaseClient(item, filter)) : data +} + +export const filterBaseClient = (baseClient: BaseClient, filter: BaseClientListFilter) => { + if (filter.roleSearch) { + const roles = baseClient.clientCredentials.authorities.join(' ').toLowerCase() + const roleSearch = filter.roleSearch.toLowerCase().trim() + if (roles.includes(roleSearch) === false) { + return false + } + } + + if (baseClient.grantType === 'client_credentials' && !filter.clientCredentials) { + return false + } + + if (baseClient.grantType === 'authorisation_code' && !filter.authorisationCode) { + return false + } + + if (baseClient.clientType === 'PERSONAL' && !filter.personalClientType) { + return false + } + if (baseClient.clientType === 'SERVICE' && !filter.serviceClientType) { + return false + } + return filter.blankClientType +} + +export default (data: BaseClient[], filter?: BaseClientListFilter) => { return { tableHead: indexTableHead(), - tableRows: indexTableRows(data), + tableRows: indexTableRows(data, filter), + filter: filter || { + roleSearch: '', + clientCredentials: true, + authorisationCode: true, + serviceClientType: true, + personalClientType: true, + blankClientType: true, + }, } } diff --git a/server/views/presenters/viewBaseClientPresenter.test.ts b/server/views/presenters/viewBaseClientPresenter.test.ts index 274c118..b3d680e 100644 --- a/server/views/presenters/viewBaseClientPresenter.test.ts +++ b/server/views/presenters/viewBaseClientPresenter.test.ts @@ -43,8 +43,8 @@ describe('viewBaseClientPresenter', () => { // Then the dates are formatted as DD/MM/YYYY const expected = [ - 'delete', - 'delete', + 'delete', + 'delete', ] const actual = presenter.clientsTable.map(row => row[3].html) expect(expected).toEqual(actual) diff --git a/server/views/presenters/viewBaseClientPresenter.ts b/server/views/presenters/viewBaseClientPresenter.ts index 11c213f..90839f8 100644 --- a/server/views/presenters/viewBaseClientPresenter.ts +++ b/server/views/presenters/viewBaseClientPresenter.ts @@ -15,7 +15,7 @@ export default (baseClient: BaseClient, clients: Client[]) => { html: item.accessed.toLocaleDateString('en-GB'), }, { - html: `delete`, + html: `delete`, }, ]), expiry: baseClient.config.expiryDate ? `Yes - days remaining ${daysRemaining(baseClient.config.expiryDate)}` : 'No',