feat: add more e2e tests for MPR and add test mode and extension (#3180)

* tests: add various e2e tests for MPR and measurements

wip

add cypress config

feat: add mode and extension for testing

add hp applied through search params

add MPR tests

apply review comments

add more e2e tests

update yarn lock

* fix unit tests failing

extensions/cornerstone-dicom-seg/package.json

@@ -36,13 +36,13 @@
     "react": "^17.0.2",
     "react-dom": "^17.0.2",
     "react-i18next": "^10.11.0",
-    "react-router": "^6.3.0",
-    "react-router-dom": "^6.3.0",
+    "react-router": "^6.8.1",
+    "react-router-dom": "^6.8.1",
     "webpack": "^5.50.0",
     "webpack-merge": "^5.7.3"
   },
   "dependencies": {
-    "@babel/runtime": "7.7.6",
+    "@babel/runtime": "^7.20.13",
     "react-color": "^2.19.3"
   },
   "devDependencies": {

extensions/cornerstone-dicom-sr/package.json

@@ -43,7 +43,7 @@
     "react": "^17.0.2"
   },
   "dependencies": {
-    "@babel/runtime": "7.16.3",
+    "@babel/runtime": "^7.20.13",
     "classnames": "^2.3.2",
     "@cornerstonejs/core": "0.30.1",
     "@cornerstonejs/tools": "0.39.0"

extensions/cornerstone/package.json

@@ -42,7 +42,7 @@
     "lodash": "^4.17.21"
   },
   "dependencies": {
-    "@babel/runtime": "7.17.9",
+    "@babel/runtime": "^7.20.13",
     "@cornerstonejs/adapters": "0.3.0",
     "@cornerstonejs/core": "0.30.1",
     "@cornerstonejs/streaming-image-volume-loader": "^0.11.2",

extensions/cornerstone/src/init.tsx

@@ -77,7 +77,10 @@ export default async function init({
 
   window.services = servicesManager.services;
 
-  if (!window.crossOriginIsolated) {
+  if (
+    appConfig.showWarningMessageForCrossOrigin &&
+    !window.crossOriginIsolated
+  ) {
     uiNotificationService.show({
       title: 'Cross Origin Isolation',
       message:
@@ -86,7 +89,10 @@ export default async function init({
     });
   }
 
-  if (cornerstone.getShouldUseCPURendering()) {
+  if (
+    appConfig.showCPUFallbackMessage &&
+    cornerstone.getShouldUseCPURendering()
+  ) {
     _showCPURenderingModal(uiModalService, hangingProtocolService);
   }
 

extensions/cornerstone/src/utils/callInputDialog.tsx

@@ -59,6 +59,7 @@ function callInputDialog(
                 autoFocus
                 className="mt-2 bg-black border-primary-main"
                 type="text"
+                id="annotation"
                 containerClassName="mr-2"
                 value={value.label}
                 onChange={event => {

extensions/cornerstone/src/utils/mpr/toggleMPRHangingProtocol.ts

@@ -58,26 +58,20 @@ export default function toggleMPRHangingProtocol({
   const viewportDisplaySetInstanceUIDs =
     viewports[activeViewportIndex].displaySetInstanceUIDs;
 
-  const errorCallback = error => {
-    // Unable to create MPR, so be sure to return to the cached/original protocol.
-    hangingProtocolService.setProtocol(
-      cachedState.protocol.id,
-      viewportMatchDetails,
-      restoreErrorCallback
-    );
+  // What is the current active protocol and stage number to restore later
+  const { protocol, stage } = hangingProtocolService.getActiveProtocol();
 
+  const restoreErrorCallback = error => {
+    console.error(error);
     uiNotificationService.show({
       title: 'Multiplanar reconstruction (MPR) ',
       message:
-        'Cannot create MPR for this DisplaySet since it is not reconstructable.',
+        'Something went wrong while trying to restore the previous layout.',
       type: 'info',
       duration: 3000,
     });
   };
 
-  // What is the current active protocol and stage number to restore later
-  const { protocol, stage } = hangingProtocolService.getActiveProtocol();
-
   if (toggledState) {
     resetCachedState();
 
@@ -109,6 +103,23 @@ export default function toggleMPRHangingProtocol({
       getToolGroup
     );
 
+    const errorCallback = error => {
+      // Unable to create MPR, so be sure to return to the cached/original protocol.
+      hangingProtocolService.setProtocol(
+        cachedState.protocol.id,
+        viewportMatchDetails,
+        restoreErrorCallback
+      );
+
+      uiNotificationService.show({
+        title: 'Multiplanar reconstruction (MPR) ',
+        message:
+          'Cannot create MPR for this DisplaySet since it is not reconstructable.',
+        type: 'info',
+        duration: 3000,
+      });
+    };
+
     hangingProtocolService.setProtocol(
       MPR_TOOLGROUP_ID,
       matchDetails,
@@ -117,16 +128,6 @@ export default function toggleMPRHangingProtocol({
     return;
   }
 
-  const restoreErrorCallback = error => {
-    uiNotificationService.show({
-      title: 'Multiplanar reconstruction (MPR) ',
-      message:
-        'Something went wrong while trying to restore the previous layout.',
-      type: 'info',
-      duration: 3000,
-    });
-  };
-
   _disableCrosshairs([MPR_TOOLGROUP_ID], getToolGroup);
 
   const { layoutType, properties } = cachedState.viewportStructure;

extensions/default/package.json

@@ -42,7 +42,7 @@
     "webpack-merge": "^5.7.3"
   },
   "dependencies": {
-    "@babel/runtime": "7.16.3",
+    "@babel/runtime": "^7.20.13",
     "@cornerstonejs/calculate-suv": "^1.0.3"
   }
 }

extensions/default/src/Panels/PanelMeasurementTable.tsx

@@ -176,6 +176,7 @@ export default function PanelMeasurementTable({
             <div className="p-4 bg-primary-dark">
               <Input
                 autoFocus
+                id="annotation"
                 className="mt-2 bg-black border-primary-main"
                 type="text"
                 containerClassName="mr-2"

extensions/dicom-pdf/package.json

@@ -37,7 +37,7 @@
     "react": "^17.0.2"
   },
   "dependencies": {
-    "@babel/runtime": "7.7.6",
+    "@babel/runtime": "^7.20.13",
     "classnames": "^2.3.2"
   }
 }

extensions/dicom-video/package.json

@@ -37,7 +37,7 @@
     "react": "^17.0.2"
   },
   "dependencies": {
-    "@babel/runtime": "7.7.6",
+    "@babel/runtime": "^7.20.13",
     "classnames": "^2.3.2"
   }
 }

extensions/measurement-tracking/package.json

@@ -44,7 +44,7 @@
     "@ohif/ui": "^2.0.0"
   },
   "dependencies": {
-    "@babel/runtime": "7.16.3",
+    "@babel/runtime": "^7.20.13",
     "@ohif/ui": "^2.0.0",
     "@xstate/react": "^0.8.1",
     "xstate": "^4.10.0"

extensions/measurement-tracking/src/panels/PanelMeasurementTableTracking/index.tsx

@@ -198,6 +198,7 @@ function PanelMeasurementTableTracking({ servicesManager, extensionManager }) {
             <div className="p-4 bg-primary-dark">
               <Input
                 autoFocus
+                id="annotation"
                 className="mt-2 bg-black border-primary-main"
                 type="text"
                 containerClassName="mr-2"

extensions/test-extension/.webpack/webpack.dev.js

@@ -0,0 +1,8 @@
+const path = require('path');
+const webpackCommon = require('./../../../.webpack/webpack.commonjs.js');
+const SRC_DIR = path.join(__dirname, '../src');
+const DIST_DIR = path.join(__dirname, '../dist');
+
+module.exports = (env, argv) => {
+  return webpackCommon(env, argv, { SRC_DIR, DIST_DIR });
+};

extensions/test-extension/.webpack/webpack.prod.js

@@ -0,0 +1,43 @@
+const webpack = require('webpack');
+const merge = require('webpack-merge');
+const path = require('path');
+const webpackCommon = require('./../../../.webpack/webpack.base.js');
+const pkg = require('./../package.json');
+
+const ROOT_DIR = path.join(__dirname, './..');
+const SRC_DIR = path.join(__dirname, '../src');
+const DIST_DIR = path.join(__dirname, '../dist');
+
+module.exports = (env, argv) => {
+  const commonConfig = webpackCommon(env, argv, { SRC_DIR, DIST_DIR });
+
+  return merge(commonConfig, {
+    stats: {
+      colors: true,
+      hash: true,
+      timings: true,
+      assets: true,
+      chunks: false,
+      chunkModules: false,
+      modules: false,
+      children: false,
+      warnings: true,
+    },
+    optimization: {
+      minimize: true,
+      sideEffects: true,
+    },
+    output: {
+      path: ROOT_DIR,
+      library: 'OHIFExtDICOMSR',
+      libraryTarget: 'umd',
+      libraryExport: 'default',
+      filename: pkg.main,
+    },
+    plugins: [
+      new webpack.optimize.LimitChunkCountPlugin({
+        maxChunks: 1,
+      }),
+    ],
+  });
+};

extensions/test-extension/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Open Health Imaging Foundation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

extensions/test-extension/README.md

@@ -0,0 +1,4 @@
+# Test Extension
+This extension will provide uitlities and module to help with testing. It is not intended to be used in production.
+For instance, we can use the hanging protocol module to inject a hanging protocol into the core and later
+use it to test the hanging protocol detection mechanism.

extensions/test-extension/babel.config.js

@@ -0,0 +1 @@
+module.exports = require('../../babel.config.js');

extensions/test-extension/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@ohif/extension-test",
+  "version": "0.0.1",
+  "description": "OHIF extension used inside e2e testing",
+  "author": "OHIF",
+  "license": "MIT",
+  "repository": "OHIF/Viewers",
+  "main": "dist/index.umd.js",
+  "module": "src/index.tsx",
+  "engines": {
+    "node": ">=14",
+    "npm": ">=6",
+    "yarn": ">=1.16.0"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "dev": "cross-env NODE_ENV=development webpack --config .webpack/webpack.dev.js --watch --debug --output-pathinfo",
+    "build": "cross-env NODE_ENV=production webpack --config .webpack/webpack.prod.js",
+    "build:package": "yarn run build",
+    "start": "yarn run dev",
+    "test:unit": "jest --watchAll",
+    "test:unit:ci": "jest --ci --runInBand --collectCoverage --passWithNoTests"
+  },
+  "peerDependencies": {
+    "@ohif/core": "^3.0.0",
+    "@ohif/ui": "^2.0.0",
+    "dcmjs": "0.29.4",
+    "dicom-parser": "^1.8.9",
+    "hammerjs": "^2.0.8",
+    "prop-types": "^15.6.2",
+    "react": "^17.0.2"
+  },
+  "dependencies": {
+    "@babel/runtime": "^7.20.13",
+    "classnames": "^2.3.2"
+  }
+}

extensions/test-extension/src/id.js

@@ -0,0 +1,5 @@
+import packageJson from '../package.json';
+
+const id = packageJson.name;
+
+export { id };

extensions/test-extension/src/index.tsx

@@ -0,0 +1,17 @@
+import { id } from './id';
+import { Types } from '@ohif/core';
+
+/**
+ *
+ */
+const testExtension: Types.Extensions.Extension = {
+  /**
+   * Only required property. Should be a unique value across all extensions.
+   */
+  id,
+  preRegistration() {
+    console.debug('hello from test-extension init.js');
+  },
+};
+
+export default testExtension;

extensions/tmtv/package.json

@@ -37,7 +37,7 @@
     "react": "^17.0.2"
   },
   "dependencies": {
-    "@babel/runtime": "7.7.6",
+    "@babel/runtime": "^7.20.13",
     "classnames": "^2.3.2"
   }
 }