@hmcts/media-viewer 4.2.0 → 4.2.4-exui-3994-f

package/.yarnrc.yml

@@ -0,0 +1,13 @@
+compressionLevel: mixed
+
+enableGlobalCache: false
+
+nodeLinker: node-modules
+
+npmAuditRegistry: "https://registry.npmjs.org/"
+
+npmAuthToken: "${NODE_AUTH_TOKEN:-}"
+
+npmPublishRegistry: "${NPM_PUBLISH_REGISTRY:-}"
+
+yarnPath: .yarn/releases/yarn-4.5.0.cjs

package/Dockerfile

@@ -0,0 +1,19 @@
+FROM hmctspublic.azurecr.io/base/node:20-alpine as base
+
+# Update & Install theses apps.
+USER root
+RUN apk update && apk upgrade && apk add --no-cache rsync && apk add python3 make g++
+
+USER hmcts
+
+ENV WORKDIR /opt/app
+WORKDIR ${WORKDIR}
+
+COPY --chown=hmcts:hmcts ./ /opt/app/
+
+RUN yarn \
+  && yarn setup \
+  && yarn cache clean
+
+EXPOSE 1337
+CMD [ "yarn", "start:api" ]

package/Jenkinsfile_CNP

@@ -0,0 +1,131 @@
+#!groovy
+
+properties([
+  [
+    $class       : 'GithubProjectProperty',
+    displayName  : 'MediaViewer',
+    projectUrlStr: 'https://github.com/hmcts/em-media-viewer/'
+  ],
+  pipelineTriggers([
+    [$class: 'GitHubPushTrigger']
+  ])
+])
+
+
+@Library("Infrastructure")
+
+def type = "nodejs"
+def product = "em"
+def component = "media-viewer"
+def channel   = '#xui-pipeline'
+
+def yarnBuilder = new uk.gov.hmcts.contino.YarnBuilder(this)
+
+env.DOCASSEMBLY_URL = "http://dg-docassembly-aat.service.core-compute-aat.internal"
+env.DM_STORE_APP_URL = "http://dm-store-aat.service.core-compute-aat.internal"
+env.HRS_API_URL = "http://em-hrs-api-aat.service.core-compute-aat.internal"
+env.ANNOTATION_API_URL = "http://em-anno-aat.service.core-compute-aat.internal"
+env.ICP_API_URL = "https://em-icp.aat.platform.hmcts.net"
+env.NPA_URL = "http://em-npa-aat.service.core-compute-aat.internal"
+env.IDAM_URL = "http://idam-api.aat.platform.hmcts.net"
+env.S2S_URL = "http://rpe-service-auth-provider-aat.service.core-compute-aat.internal"
+env.REDIRECT_URL = "https://em-show-aat.service.core-compute-aat.internal/oauth2/callback"
+env.NODE_ENV="TEST"
+
+def vaultOverrides = [
+        'preview' : 'aat',
+]
+
+def secrets = [
+        's2s-${env}': [
+                secret('microservicekey-em-gw', 'S2S_KEY')
+        ],
+        'rpa-${env}': [
+                secret('show-oauth2-token', 'IDAM_SECRET')
+        ],
+        'em-showcase-${env}': [
+          secret('ccd-user-email', 'CCD_CASEWORKER_E2E_EMAIL'),
+          secret('ccd-user-password', 'CCD_CASEWORKER_E2E_PASSWORD'),
+          secret('microservicekey-ccd-gw', 'MICROSERVICE_CCD_GW'),
+          secret('idam-client-secret', 'IDAM_CLIENT_SECRET')
+        ]
+]
+
+static LinkedHashMap<String, Object> secret(String secretName, String envVar) {
+    [ $class: 'AzureKeyVaultSecret',
+      secretType: 'Secret',
+      name: secretName,
+      version: '',
+      envVariable: envVar
+    ]
+}
+
+withPipeline(type, product, component) {
+  enableSlackNotifications(channel)
+  overrideVaultEnvironments(vaultOverrides)
+  loadVaultSecrets(secrets)
+  enableSecurityScan()
+  env.EXECUTE_E2E=false
+  env.TEST_URL = 'https://em-media-viewer-staging.service.core-compute-aat.internal/'
+  onPR{
+  env.EXECUTE_E2E=true
+  }
+  enableAksStagingDeployment()
+  disableLegacyDeployment()
+
+  afterSuccess('checkout') {
+      sh ("rm -rf node_modules")
+      sh ("yarn cache clean")
+      sh ('npm rebuild node-sass')
+      sh ('yarn install --check-cache')
+      yarnBuilder.yarn('setup')
+  }
+
+  afterSuccess('build') {
+    yarnBuilder.yarn('build')
+  }
+
+  afterAlways('smoketest:preview') {
+    publishHTML([
+      allowMissing         : true,
+      alwaysLinkToLastBuild: true,
+      keepAll              : true,
+      reportDir            : "functional-output/",
+      reportFiles          : 'mv-e2e-result.html',
+      reportName           : 'PREVIEW Smoke Test'
+    ])
+  }
+
+  afterAlways('functionalTest:preview') {
+      publishHTML([
+              allowMissing         : true,
+              alwaysLinkToLastBuild: true,
+              keepAll              : true,
+              reportDir            : "functional-output/reports/html",
+              reportFiles          : 'index.html',
+              reportName           : 'PREVIEW Functional Test'
+      ])
+  }
+
+  afterAlways('smoketest:aat') {
+    publishHTML([
+      allowMissing         : true,
+      alwaysLinkToLastBuild: true,
+      keepAll              : true,
+      reportDir            : "functional-output/",
+      reportFiles          : 'mv-e2e-result.html',
+      reportName           : 'AAT Smoke Test'
+    ])
+  }
+
+  afterAlways('functionalTest:aat') {
+      publishHTML([
+              allowMissing         : true,
+              alwaysLinkToLastBuild: true,
+              keepAll              : true,
+              reportDir            : "functional-output/reports/html",
+              reportFiles          : 'index.html',
+              reportName           : 'AAT Functional Test'
+      ])
+  }
+}

package/Jenkinsfile_nightly

@@ -0,0 +1,119 @@
+#!groovy
+
+properties([
+  [
+  $class       : 'GithubProjectProperty',
+  displayName  : 'MediaViewer',
+  projectUrlStr: 'https://github.com/hmcts/em-media-viewer/'
+  ],
+  pipelineTriggers([
+    cron('H 17 * * *')
+  ]),
+  parameters([
+    string(name: 'ENVIRONMENT', defaultValue: 'aat', description: 'Environment to test'),
+    string(name: 'IDAM_API_URL', defaultValue: 'https://idam-api.aat.platform.hmcts.net', description: 'The Url of IDAM'),
+    string(name: 'S2S_PROVIDER_URL', defaultValue: 'http://rpe-service-auth-provider-aat.service.core-compute-aat.internal', description: 'The Url of S2S provider'),
+    string(name: 'CCD_DATA_STORE_URL', defaultValue: 'http://ccd-data-store-api-aat.service.core-compute-aat.internal', description: 'The Url of ccd data store'),
+    string(name: 'SecurityRules',
+      defaultValue: 'https://raw.githubusercontent.com/hmcts/security-test-rules/master/conf/security-rules.conf',
+      description: 'The URL you want to run these tests against'),
+  ])
+])
+
+@Library("Infrastructure")
+
+def type = "nodejs"
+def product = "em"
+def component = "media-viewer"
+def channel   = '#xui-pipeline'
+
+def yarnBuilder = new uk.gov.hmcts.contino.YarnBuilder(this)
+
+def vaultOverrides = [
+  'aat' : params.ENVIRONMENT,
+]
+
+def secrets = [
+  "s2s-${params.ENVIRONMENT}": [
+    secret('microservicekey-em-gw', 'S2S_KEY')
+  ],
+  "rpa-${params.ENVIRONMENT}": [
+    secret('show-oauth2-token', 'IDAM_SECRET')
+  ],
+  "em-showcase-${params.ENVIRONMENT}": [
+    secret('ccd-user-email', 'CCD_CASEWORKER_E2E_EMAIL'),
+    secret('ccd-user-password', 'CCD_CASEWORKER_E2E_PASSWORD'),
+    secret('microservicekey-ccd-gw', 'MICROSERVICE_CCD_GW'),
+    secret('idam-client-secret', 'IDAM_CLIENT_SECRET')
+  ]
+]
+
+static LinkedHashMap<String, Object> secret(String secretName, String envVar) {
+  [ $class: 'AzureKeyVaultSecret',
+    secretType: 'Secret',
+    name: secretName,
+    version: '',
+    envVariable: envVar
+  ]
+}
+
+withNightlyPipeline(type, product, component) {
+  env.TEST_URL = 'http://em-media-viewer-aat.service.core-compute-aat.internal'
+  env.IDAM_URL = params.IDAM_API_URL
+  env.S2S_PROVIDER = params.S2S_PROVIDER_URL
+  env.CCD_DATA_STORE_API_URL = params.CCD_DATA_STORE_URL
+  env.RUNNING_ENV = params.ENVIRONMENT
+  overrideVaultEnvironments(vaultOverrides)
+  loadVaultSecrets(secrets)
+
+  disableLegacyDeployment()
+  enableSecurityScan()
+  enableSlackNotifications(channel)
+  enableFullFunctionalTest(60)
+  enableCrossBrowserTest()
+
+  afterSuccess('checkout') {
+    sh ("rm -rf node_modules")
+    sh ("yarn cache clean")
+    sh ('npm rebuild node-sass')
+    sh ('yarn install --check-cache')
+    yarnBuilder.yarn('setup')
+  }
+
+  afterSuccess('build') {
+    yarnBuilder.yarn('build')
+  }
+
+  afterAlways('functionalTest') {
+    publishHTML([
+      allowMissing         : true,
+      alwaysLinkToLastBuild: true,
+      keepAll              : true,
+      reportDir            : "functional-output/reports/html",
+      reportFiles          : 'index.html',
+      reportName           : 'Functional Tests'
+    ])
+  }
+
+  afterAlways('crossBrowserTest') {
+    publishHTML([
+      allowMissing         : true,
+      alwaysLinkToLastBuild: true,
+      keepAll              : true,
+      reportDir            : "reports/tests/crossbrowser/",
+      reportFiles          : 'index.html',
+      reportName           : 'Cross Browser Tests'
+    ])
+  }
+
+  afterAlways('securityScan') {
+    publishHTML([
+      allowMissing         : true,
+      alwaysLinkToLastBuild: true,
+      keepAll              : true,
+      reportDir            : "reports/tests/",
+      reportFiles          : 'activescan.html',
+      reportName           : 'ZAP Security Scan Report'
+    ])
+  }
+}

package/Makefile

@@ -0,0 +1,3 @@
+#installs and runs the em-media-viewer application locally
+app-run:
+	yarn install; yarn package; yarn start:ng;

package/angular.json

@@ -0,0 +1,205 @@
+{
+  "$schema": "./node_modules/@angular/cli/lib/config/schema.json",
+  "version": 1,
+  "newProjectRoot": "projects",
+  "projects": {
+    "media-viewer": {
+      "root": "projects/media-viewer",
+      "sourceRoot": "projects/media-viewer/src",
+      "projectType": "library",
+      "prefix": "app",
+      "architect": {
+        "build": {
+          "builder": "@angular-devkit/build-angular:ng-packagr",
+          "options": {
+            "tsConfig": "projects/media-viewer/tsconfig.lib.json",
+            "project": "projects/media-viewer/ng-package.json"
+          },
+          "configurations": {
+            "production": {
+              "project": "projects/media-viewer/ng-package.prod.json"
+            }
+          }
+        },
+        "test": {
+          "builder": "@angular-devkit/build-angular:karma",
+          "options": {
+            "codeCoverage": true,
+            "codeCoverageExclude": [
+              "**/*.spec.ts",
+              "**/*.spec.js",
+              "test/**",
+              "config/**",
+              "api/**/templates/**",
+              "src/public/**",
+              "src/environments/**"
+            ],
+            "main": "projects/media-viewer/src/test.ts",
+            "tsConfig": "projects/media-viewer/tsconfig.spec.json",
+            "karmaConfig": "projects/media-viewer/karma.conf.js"
+          }
+        },
+        "lint": {
+          "builder": "@angular-eslint/builder:lint",
+          "options": {
+            "lintFilePatterns": [
+              "projects/media-viewer/**/*.ts",
+              "projects/media-viewer/**/*.html"
+            ]
+          }
+        }
+      }
+    },
+    "media-viewer-demo-app": {
+      "root": "",
+      "sourceRoot": "src",
+      "projectType": "application",
+      "prefix": "app",
+      "schematics": {},
+      "architect": {
+        "build": {
+          "builder": "@angular-devkit/build-angular:browser",
+          "options": {
+            "outputPath": "dist/demo-app",
+            "index": "src/index.html",
+            "main": "src/main.ts",
+            "polyfills": "src/polyfills.ts",
+            "tsConfig": "src/tsconfig.app.json",
+            "assets": [
+              {
+                "glob": "**/*",
+                "input": "dist/media-viewer/assets",
+                "output": "/assets"
+              },
+              {
+                "glob": "**/*",
+                "input": "dist/media-viewer/assets/images",
+                "output": "/"
+              },
+              {
+                "glob": "favicon.ico",
+                "input": "src",
+                "output": "/"
+              },
+              {
+                "glob": "**/*",
+                "input": "src/assets",
+                "output": "/assets"
+              },
+              {
+                "glob": "**/*",
+                "input": "src/assets/documents/pdf",
+                "output": "/"
+              },
+              {
+                "glob": "**/*",
+                "input": "src/assets/documents/image",
+                "output": "/"
+              }
+            ],
+            "styles": [
+              "src/app/app.component.scss"
+            ],
+            "scripts": [],
+            "aot": false,
+            "vendorChunk": true,
+            "extractLicenses": false,
+            "buildOptimizer": false,
+            "sourceMap": true,
+            "optimization": false,
+            "namedChunks": true
+          },
+          "configurations": {
+            "production": {
+              "fileReplacements": [
+                {
+                  "replace": "src/environments/environment.ts",
+                  "with": "src/environments/environment.prod.ts"
+                }
+              ],
+              "optimization": true,
+              "outputHashing": "all",
+              "sourceMap": false,
+              "namedChunks": false,
+              "aot": true,
+              "extractLicenses": true,
+              "vendorChunk": false,
+              "buildOptimizer": true
+            }
+          },
+          "defaultConfiguration": ""
+        },
+        "serve": {
+          "builder": "@angular-devkit/build-angular:dev-server",
+          "options": {
+            "port": 3000,
+            "proxyConfig": "proxy.config.js",
+            "buildTarget": "media-viewer-demo-app:build"
+          },
+          "configurations": {
+            "production": {
+              "buildTarget": "media-viewer-demo-app:build:production"
+            }
+          }
+        },
+        "extract-i18n": {
+          "builder": "@angular-devkit/build-angular:extract-i18n",
+          "options": {
+            "buildTarget": "media-viewer-demo-app:build"
+          }
+        },
+        "test": {
+          "builder": "@angular-devkit/build-angular:karma",
+          "options": {
+            "codeCoverage": true,
+            "codeCoverageExclude": [
+              "**/*.spec.ts",
+              "**/*.spec.js",
+              "test/**",
+              "config/**",
+              "api/**/templates/**",
+              "src/public/**",
+              "src/environments/**"
+            ],
+            "main": "src/test.ts",
+            "polyfills": "src/polyfills.ts",
+            "tsConfig": "src/tsconfig.spec.json",
+            "karmaConfig": "src/karma.conf.js",
+            "styles": [],
+            "scripts": [],
+            "assets": [
+              "src/favicon.ico",
+              "src/assets"
+            ]
+          }
+        }
+      }
+    },
+    "media-viewer-e2e": {
+      "root": "projects/media-viewer-e2e/",
+      "projectType": "application",
+      "architect": {
+        "e2e": {
+          "builder": "@angular-devkit/build-angular:protractor",
+          "options": {
+            "protractorConfig": "e2e/protractor.conf.js",
+            "devServerTarget": "media-viewer-demo-app:serve"
+          },
+          "configurations": {
+            "production": {
+              "devServerTarget": "media-viewer-demo-app:serve:production"
+            }
+          }
+        }
+      }
+    }
+  },
+  "schematics": {
+    "@schematics/angular:component": {
+      "styleext": "scss"
+    }
+  },
+  "cli": {
+    "analytics": false
+  }
+}

package/api/annotation-stubs.js

@@ -0,0 +1,41 @@
+var express = require('express');
+var bodyParser = require('body-parser');
+var app = express();
+
+app.use(bodyParser.json());
+
+app.get('/em-anno/annotation-sets/filter', function (req, res) {
+
+  res.status(404);
+  res.end();
+
+});
+
+app.post('/em-anno/annotation-sets', function (req, res) {
+
+  var json = req.body;
+
+  json.annotations = [];
+
+  res.json(json);
+
+});
+
+app.post('/em-anno/annotations', function (req, res) {
+
+  var json = req.body;
+
+  res.json(json);
+
+});
+
+app.delete('/em-anno/annotations/:id', function (req, res) {
+  res.end('');
+
+});
+
+var server = app.listen(1337, function () {
+  var host = server.address().address
+  var port = server.address().port
+  console.log("Example app listening at http://%s:%s", host, port)
+})

package/api/config.ts

@@ -0,0 +1,63 @@
+import * as aksVaultConfig from 'config';
+import * as propertiesVolume from '@hmcts/properties-volume';
+propertiesVolume.addTo(aksVaultConfig);
+
+const IDAM_SECRET = aksVaultConfig.secrets ? aksVaultConfig.secrets['em-showcase']['show-oauth2-token'] : undefined;
+const S2S_KEY = aksVaultConfig.secrets ? aksVaultConfig.secrets['em-showcase']['microservicekey-em-gw'] : undefined;
+const IDAM_PASSWORD = aksVaultConfig.secrets ? aksVaultConfig.secrets['em-showcase']['password'] : undefined;
+
+export const config = {
+  proxies: {
+    assembly: {
+      endpoints: [
+        '/api/form-definitions',
+        '/api/template-renditions',
+        '/doc-assembly'
+      ],
+      target: process.env['REFORM_ENVIRONMENT'] ? process.env['DOCASSEMBLY_URL'] : 'http://localhost:4631',
+      pathRewrite: {
+        '^/doc-assembly': '/api'
+      }
+    },
+    dmStore: {
+      endpoints: ['/documents'],
+      target: process.env['REFORM_ENVIRONMENT'] ? process.env['DM_STORE_APP_URL'] : 'http://localhost:4603'
+    },
+    hrsApi: {
+      endpoints: ['/hearing-recordings'],
+      target: process.env['REFORM_ENVIRONMENT'] ? process.env['HRS_API_URL'] : 'http://localhost:8080'
+    },
+    annotation: {
+      endpoints: ['/em-anno'],
+      target: process.env['REFORM_ENVIRONMENT'] ? process.env['ANNOTATION_API_URL'] : 'http://localhost:4623',
+      pathRewrite: {
+        '^/em-anno': '/api'
+      }
+    },
+    npa: {
+      endpoints: [
+        '/api/markups',
+        '/api/redaction'
+      ],
+      target: process.env['REFORM_ENVIRONMENT'] ? process.env['NPA_URL'] : 'http://localhost:4624'
+    },
+    icp: {
+      endpoints: ['/icp'],
+      target: process.env['REFORM_ENVIRONMENT'] ? process.env['ICP_API_URL'] : 'http://localhost:4621',
+    }
+  },
+  idam: {
+    url: process.env['IDAM_URL'] || 'http://localhost:5000',
+    client: 'webshow',
+    secret: IDAM_SECRET || 'AAAAAAAAAAAAAAAA',
+    redirect: process.env['REDIRECT_URL'] || 'https://em-show-aat.service.core-compute-aat.internal/oauth2/callback',
+    password: IDAM_PASSWORD || '***REMOVED***',
+  },
+  s2s: {
+    url: process.env['S2S_URL'] || 'http://localhost:4502',
+    secret: S2S_KEY || 'AAAAAAAAAAAAAAAA',
+    microservice: 'em_gw'
+  },
+  port: process.env.PORT || 1337,
+  tokenRefreshTime: 60 * 60 * 1000
+};

package/api/health.ts

@@ -0,0 +1,14 @@
+import * as express from 'express';
+import * as healthcheck from '@hmcts/nodejs-healthcheck';
+
+export const healthcheckRoutes: express.Router = express.Router();
+
+const healthCheckConfig = {
+  checks: {
+    icp: healthcheck.raw(() => {
+      return healthcheck.up();
+    })
+  },
+};
+
+healthcheck.addTo(healthcheckRoutes, healthCheckConfig);

package/api/logger.ts

@@ -0,0 +1,3 @@
+import { Logger } from '@hmcts/nodejs-logging';
+
+export const logger = Logger.getLogger('em-media-viewer');