fix(CinePlayer): always show cine player for dynamic data (#4575)

Co-authored-by: Ibrahim <[email protected]>
OHIF · Dec 5, 2024 · b8e8bbe · b8e8bbe
1 parent 72a35ce
commit b8e8bbe
Show file tree

Hide file tree

Showing 20 changed files with 122 additions and 59 deletions.
diff --git a/extensions/cornerstone-dicom-pmap/package.json b/extensions/cornerstone-dicom-pmap/package.json
@@ -46,8 +46,8 @@
   },
   "dependencies": {
     "@babel/runtime": "^7.20.13",
-    "@cornerstonejs/adapters": "^2.2.20",
-    "@cornerstonejs/core": "^2.2.20",
+    "@cornerstonejs/adapters": "^2.7.3",
+    "@cornerstonejs/core": "^2.7.3",
     "@kitware/vtk.js": "32.1.1",
     "react-color": "^2.19.3"
   }

diff --git a/extensions/cornerstone-dicom-seg/package.json b/extensions/cornerstone-dicom-seg/package.json
@@ -46,8 +46,8 @@
   },
   "dependencies": {
     "@babel/runtime": "^7.20.13",
-    "@cornerstonejs/adapters": "^2.2.20",
-    "@cornerstonejs/core": "^2.2.20",
+    "@cornerstonejs/adapters": "^2.7.3",
+    "@cornerstonejs/core": "^2.7.3",
     "@kitware/vtk.js": "32.1.1",
     "react-color": "^2.19.3"
   }

diff --git a/extensions/cornerstone-dicom-sr/package.json b/extensions/cornerstone-dicom-sr/package.json
@@ -46,9 +46,9 @@
   },
   "dependencies": {
     "@babel/runtime": "^7.20.13",
-    "@cornerstonejs/adapters": "^2.2.20",
-    "@cornerstonejs/core": "^2.2.20",
-    "@cornerstonejs/tools": "^2.2.20",
+    "@cornerstonejs/adapters": "^2.7.3",
+    "@cornerstonejs/core": "^2.7.3",
+    "@cornerstonejs/tools": "^2.7.3",
     "classnames": "^2.3.2"
   }
 }
diff --git a/extensions/cornerstone-dynamic-volume/package.json b/extensions/cornerstone-dynamic-volume/package.json
@@ -42,8 +42,8 @@
   },
   "dependencies": {
     "@babel/runtime": "^7.20.13",
-    "@cornerstonejs/core": "^2.2.20",
-    "@cornerstonejs/tools": "^2.2.20",
+    "@cornerstonejs/core": "^2.7.3",
+    "@cornerstonejs/tools": "^2.7.3",
     "classnames": "^2.3.2"
   }
 }
diff --git a/extensions/cornerstone/package.json b/extensions/cornerstone/package.json
@@ -38,7 +38,7 @@
     "@cornerstonejs/codec-libjpeg-turbo-8bit": "^1.2.2",
     "@cornerstonejs/codec-openjpeg": "^1.2.4",
     "@cornerstonejs/codec-openjph": "^2.4.5",
-    "@cornerstonejs/dicom-image-loader": "^2.2.20",
+    "@cornerstonejs/dicom-image-loader": "^2.7.3",
     "@icr/polyseg-wasm": "^0.4.0",
     "@ohif/core": "3.10.0-beta.14",
     "@ohif/ui": "3.10.0-beta.14",
@@ -55,9 +55,9 @@
   },
   "dependencies": {
     "@babel/runtime": "^7.20.13",
-    "@cornerstonejs/adapters": "^2.2.20",
-    "@cornerstonejs/core": "^2.2.20",
-    "@cornerstonejs/tools": "^2.2.20",
+    "@cornerstonejs/adapters": "^2.7.3",
+    "@cornerstonejs/core": "^2.7.3",
+    "@cornerstonejs/tools": "^2.7.3",
     "@icr/polyseg-wasm": "^0.4.0",
     "@kitware/vtk.js": "32.1.1",
     "html2canvas": "^1.4.1",

diff --git a/extensions/cornerstone/src/Viewport/Overlays/ViewportImageScrollbar.tsx b/extensions/cornerstone/src/Viewport/Overlays/ViewportImageScrollbar.tsx
@@ -44,13 +44,17 @@ function CornerstoneImageScrollbar({
       return;
     }
 
-    const imageIndex = viewport.getCurrentImageIdIndex();
-    const numberOfSlices = viewport.getNumberOfSlices();
+    try {
+      const imageIndex = viewport.getCurrentImageIdIndex();
+      const numberOfSlices = viewport.getNumberOfSlices();
 
-    setImageSliceData({
-      imageIndex: imageIndex,
-      numberOfSlices,
-    });
+      setImageSliceData({
+        imageIndex: imageIndex,
+        numberOfSlices,
+      });
+    } catch (error) {
+      console.warn(error);
+    }
   }, [viewportId, viewportData]);
 
   useEffect(() => {

diff --git a/extensions/cornerstone/src/utils/ActiveViewportBehavior.tsx b/extensions/cornerstone/src/utils/ActiveViewportBehavior.tsx
@@ -39,6 +39,7 @@ const ActiveViewportBehavior = memo(
       }
 
       const modalities = displaySets.map(displaySet => displaySet?.Modality);
+      const isDynamicVolume = displaySets.some(displaySet => displaySet?.isDynamicVolume);
 
       const { modalities: sourceModalities } = customizationService.getModeCustomization(
         'autoCineModalities',
@@ -50,7 +51,7 @@ const ActiveViewportBehavior = memo(
 
       const requiresCine = modalities.some(modality => sourceModalities.includes(modality));
 
-      if (requiresCine && !cineService.getState().isCineEnabled) {
+      if ((requiresCine || isDynamicVolume) && !cineService.getState().isCineEnabled) {
         cineService.setIsCineEnabled(true);
       }
     }, [

diff --git a/extensions/default/src/DicomWebDataSource/index.js b/extensions/default/src/DicomWebDataSource/index.js
@@ -392,7 +392,8 @@ function createDicomWebApi(dicomWebConfig, servicesManager) {
 
           if (Array.isArray(value) && typeof value[0] === 'object') {
             // Fix recursive values
-            value.forEach(child => addRetrieveBulkDataNaturalized(child, instance));
+            const validValues = value.filter(Boolean);
+            validValues.forEach(child => addRetrieveBulkDataNaturalized(child, instance));
             continue;
           }
 

diff --git a/extensions/measurement-tracking/package.json b/extensions/measurement-tracking/package.json
@@ -32,8 +32,8 @@
     "start": "yarn run dev"
   },
   "peerDependencies": {
-    "@cornerstonejs/core": "^2.2.20",
-    "@cornerstonejs/tools": "^2.2.20",
+    "@cornerstonejs/core": "^2.7.3",
+    "@cornerstonejs/tools": "^2.7.3",
     "@ohif/core": "3.10.0-beta.14",
     "@ohif/extension-cornerstone-dicom-sr": "3.10.0-beta.14",
     "@ohif/extension-default": "3.10.0-beta.14",

diff --git a/platform/app/package.json b/platform/app/package.json
@@ -53,7 +53,7 @@
     "@cornerstonejs/codec-libjpeg-turbo-8bit": "^1.2.2",
     "@cornerstonejs/codec-openjpeg": "^1.2.4",
     "@cornerstonejs/codec-openjph": "^2.4.5",
-    "@cornerstonejs/dicom-image-loader": "^2.2.20",
+    "@cornerstonejs/dicom-image-loader": "^2.7.3",
     "@emotion/serialize": "^1.1.3",
     "@ohif/core": "3.10.0-beta.14",
     "@ohif/extension-cornerstone": "3.10.0-beta.14",

diff --git a/platform/core/package.json b/platform/core/package.json
@@ -37,7 +37,7 @@
     "@cornerstonejs/codec-libjpeg-turbo-8bit": "^1.2.2",
     "@cornerstonejs/codec-openjpeg": "^1.2.4",
     "@cornerstonejs/codec-openjph": "^2.4.5",
-    "@cornerstonejs/dicom-image-loader": "^2.2.20",
+    "@cornerstonejs/dicom-image-loader": "^2.7.3",
     "@ohif/ui": "3.10.0-beta.14",
     "cornerstone-math": "0.1.9",
     "dicom-parser": "^1.8.21"

diff --git a/playwright.config.ts b/playwright.config.ts
@@ -2,19 +2,21 @@ import { defineConfig, devices } from '@playwright/test';
 
 export default defineConfig({
   testDir: './tests',
-  fullyParallel: true,
+  fullyParallel: !!process.env.CI,
   forbidOnly: !!process.env.CI,
   retries: process.env.CI ? 2 : 0,
   workers: process.env.CI ? 1 : undefined,
   snapshotPathTemplate: './tests/screenshots{/projectName}/{testFilePath}/{arg}{ext}',
   outputDir: './tests/test-results',
   reporter: [[process.env.CI ? 'blob' : 'html', { outputFolder: './tests/playwright-report' }]],
-  timeout: 720 * 1000,
+  globalTimeout: 800_000,
+  timeout: 800_000,
   use: {
     baseURL: 'http://localhost:3000',
     trace: 'on-first-retry',
     video: 'on',
     testIdAttribute: 'data-cy',
+    actionTimeout: 10_000,
   },
 
   projects: [
@@ -39,6 +41,6 @@ export default defineConfig({
     command: 'yarn test:e2e:serve',
     url: 'http://localhost:3000',
     reuseExistingServer: !process.env.CI,
-    timeout: 240 * 1000,
+    timeout: 360_000,
   },
 });
diff --git a/tests/3DFourUp.spec.ts b/tests/3DFourUp.spec.ts
@@ -1,5 +1,11 @@
 import { test } from '@playwright/test';
-import { visitStudy, checkForScreenshot, screenShotPaths, reduce3DViewportSize } from './utils';
+import {
+  visitStudy,
+  checkForScreenshot,
+  screenShotPaths,
+  reduce3DViewportSize,
+  attemptAction,
+} from './utils';
 
 test.beforeEach(async ({ page }) => {
   const studyInstanceUID = '1.3.6.1.4.1.14519.5.2.1.1706.8374.643249677828306008300337414785';
@@ -15,7 +21,9 @@ test.describe('3D four up Test', async () => {
       .filter({ hasText: /^3D four up$/ })
       .first()
       .click();
-    await reduce3DViewportSize(page);
+
+    await attemptAction(() => reduce3DViewportSize(page), 10, 100);
+
     await checkForScreenshot(
       page,
       page,

diff --git a/tests/3DMain.spec.ts b/tests/3DMain.spec.ts
@@ -1,5 +1,11 @@
 import { test } from '@playwright/test';
-import { visitStudy, checkForScreenshot, screenShotPaths, reduce3DViewportSize } from './utils';
+import {
+  visitStudy,
+  checkForScreenshot,
+  screenShotPaths,
+  reduce3DViewportSize,
+  attemptAction,
+} from './utils';
 
 test.beforeEach(async ({ page }) => {
   const studyInstanceUID = '1.3.6.1.4.1.14519.5.2.1.1706.8374.643249677828306008300337414785';
@@ -15,7 +21,7 @@ test.describe('3D main Test', async () => {
       .filter({ hasText: /^3D main$/ })
       .first()
       .click();
-    await reduce3DViewportSize(page);
+    await attemptAction(() => reduce3DViewportSize(page), 10, 100);
     await checkForScreenshot(
       page,
       page,

diff --git a/tests/3DOnly.spec.ts b/tests/3DOnly.spec.ts
@@ -1,5 +1,11 @@
 import { test } from '@playwright/test';
-import { visitStudy, checkForScreenshot, screenShotPaths, reduce3DViewportSize } from './utils';
+import {
+  visitStudy,
+  checkForScreenshot,
+  screenShotPaths,
+  reduce3DViewportSize,
+  attemptAction,
+} from './utils';
 
 test.beforeEach(async ({ page }) => {
   const studyInstanceUID = '1.3.6.1.4.1.14519.5.2.1.1706.8374.643249677828306008300337414785';
@@ -15,7 +21,7 @@ test.describe('3D only Test', async () => {
       .filter({ hasText: /^3D only$/ })
       .first()
       .click();
-    await reduce3DViewportSize(page);
+    await attemptAction(() => reduce3DViewportSize(page), 10, 100);
     await checkForScreenshot(
       page,
       page,

diff --git a/tests/3DPrimary.spec.ts b/tests/3DPrimary.spec.ts
@@ -1,5 +1,11 @@
 import { test } from '@playwright/test';
-import { visitStudy, checkForScreenshot, screenShotPaths, reduce3DViewportSize } from './utils';
+import {
+  visitStudy,
+  checkForScreenshot,
+  screenShotPaths,
+  reduce3DViewportSize,
+  attemptAction,
+} from './utils';
 
 test.beforeEach(async ({ page }) => {
   const studyInstanceUID = '1.3.6.1.4.1.14519.5.2.1.1706.8374.643249677828306008300337414785';
@@ -16,7 +22,7 @@ test.describe('3D primary Test', async () => {
       .first()
       .click();
 
-    await reduce3DViewportSize(page);
+    await attemptAction(() => reduce3DViewportSize(page), 10, 100);
     await checkForScreenshot(
       page,
       page,

diff --git a/tests/Crosshairs.spec.ts b/tests/Crosshairs.spec.ts
@@ -1,6 +1,11 @@
 import { Page, test } from '@playwright/test';
-import { visitStudy, checkForScreenshot, screenShotPaths, initilizeMousePositionTracker, getMousePosition } from './utils/index.js';
-
+import {
+  visitStudy,
+  checkForScreenshot,
+  screenShotPaths,
+  initilizeMousePositionTracker,
+  getMousePosition,
+} from './utils/index.js';
 
 const rotateCrosshairs = async (page: Page, id: string, lineNumber: number) => {
   const locator = await page.locator(id).locator('line').nth(lineNumber);
@@ -12,10 +17,10 @@ const rotateCrosshairs = async (page: Page, id: string, lineNumber: number) => {
   const position = await getMousePosition(page);
   await page.mouse.move(position.x, position.y + 100);
   await page.mouse.up();
-}
+};
 
 const increaseSlabThickness = async (page: Page, id: string, lineNumber: number, axis: string) => {
-  const locator = await page.locator(id).locator('line').nth(lineNumber)
+  const locator = await page.locator(id).locator('line').nth(lineNumber);
   await locator.click({ force: true });
   await locator.hover({ force: true });
   const circleLocator = await page.locator(id).locator('rect').first();
@@ -31,7 +36,7 @@ const increaseSlabThickness = async (page: Page, id: string, lineNumber: number,
       break;
   }
   await page.mouse.up();
-}
+};
 
 test.beforeEach(async ({ page }) => {
   const studyInstanceUID = '1.3.6.1.4.1.14519.5.2.1.1706.8374.643249677828306008300337414785';
@@ -73,7 +78,9 @@ test.describe('Crosshairs Test', async () => {
     await checkForScreenshot(page, page, screenShotPaths.crosshairs.crosshairsSlabThickness);
   });
 
-  test('should reset the crosshairs to the initial position when reset is clicked', async ({ page }) => {
+  test('should reset the crosshairs to the initial position when reset is clicked', async ({
+    page,
+  }) => {
     await page.getByTestId('Layout').click();
     await page.locator('div').filter({ hasText: /^MPR$/ }).first().click();
     await page.getByTestId('Crosshairs').click();
@@ -100,5 +107,4 @@ test.describe('Crosshairs Test', async () => {
 
     await checkForScreenshot(page, page, screenShotPaths.crosshairs.crosshairsNewDisplayset);
   });
-
 });
diff --git a/tests/utils/attemptAction.ts b/tests/utils/attemptAction.ts
@@ -0,0 +1,21 @@
+/**
+ *
+ * @param action  The action function to attempt
+ * @param attempts  The number of attempts to try the action
+ * @param delay delay between attempts
+ * @returns True if the action is successful, otherwise throws an error
+ */
+
+export const attemptAction = async (action: () => Promise<void>, attempts = 10, delay = 100) => {
+  for (let i = 1; i < attempts; i++) {
+    try {
+      await action();
+      return true;
+    } catch (error) {
+      if (i === attempts) {
+        throw new Error('Action failed.');
+      }
+      await new Promise(resolve => setTimeout(resolve, delay));
+    }
+  }
+};
diff --git a/tests/utils/index.ts b/tests/utils/index.ts
@@ -8,6 +8,7 @@ import { getSUV } from './getSUV';
 import { getTMTVModalityUnit } from './getTMTVModalityUnit';
 import { clearAllAnnotations } from './clearAllAnnotations';
 import { scrollVolumeViewport } from './scrollVolumeViewport';
+import { attemptAction } from './attemptAction';
 
 export {
   visitStudy,
@@ -21,4 +22,5 @@ export {
   getTMTVModalityUnit,
   clearAllAnnotations,
   scrollVolumeViewport,
+  attemptAction,
 };