chore(e2e): speed up tests

Author: PaulHax

.github/workflows/e2e.yml

@@ -10,7 +10,7 @@ jobs:
     name: E2E Testing on ${{ matrix.os }}
     runs-on: ${{ matrix.os }}
     env:
-      DOWNLOAD_TIMEOUT: 220000
+      DOWNLOAD_TIMEOUT: 60000
       VITE_SHOW_SAMPLE_DATA: true
     steps:
       - uses: actions/checkout@v4

src/io/import/__tests__/configJson.spec.ts

@@ -0,0 +1,45 @@
+import { describe, it, expect } from 'vitest';
+import { config } from '@/src/io/import/configJson';
+
+describe('config schema', () => {
+  describe('shortcuts', () => {
+    it('should accept partial shortcuts', () => {
+      const result = config.safeParse({
+        shortcuts: {
+          polygon: 'Ctrl+p',
+          rectangle: 'b',
+        },
+      });
+
+      expect(result.success).to.be.true;
+      expect(result.data?.shortcuts).to.deep.equal({
+        polygon: 'Ctrl+p',
+        rectangle: 'b',
+      });
+    });
+
+    it('should reject invalid shortcut keys', () => {
+      const result = config.safeParse({
+        shortcuts: {
+          invalidKey: 'Ctrl+x',
+        },
+      });
+
+      expect(result.success).to.be.false;
+    });
+
+    it('should accept empty shortcuts', () => {
+      const result = config.safeParse({
+        shortcuts: {},
+      });
+
+      expect(result.success).to.be.true;
+    });
+
+    it('should accept config without shortcuts', () => {
+      const result = config.safeParse({});
+
+      expect(result.success).to.be.true;
+    });
+  });
+});

src/io/import/configJson.ts

@@ -21,7 +21,9 @@ const layouts = z.record(z.string(), layoutConfig).optional();
 // --------------------------------------------------------------------------
 // Keyboard shortcuts
 
-const shortcuts = z.record(zodEnumFromObjKeys(ACTIONS), z.string()).optional();
+const shortcuts = z
+  .partialRecord(zodEnumFromObjKeys(ACTIONS), z.string())
+  .optional();
 
 // --------------------------------------------------------------------------
 // Labels

tests/specs/layers.e2e.ts tests/specs/layers-and-rendering.e2e.tstests/specs/layers.e2e.ts renamed to tests/specs/layers-and-rendering.e2e.ts

@@ -3,7 +3,35 @@ import { volViewPage } from '../pageobjects/volview.page';
 import { openUrls } from './utils';
 import { PROSTATEX_DATASET, MRA_HEAD_NECK_DATASET } from './configTestUtils';
 
-describe('Add Layer button', () => {
+describe('Layers and Rendering', () => {
+  it('should show 3D rendering controls regardless of active view', async () => {
+    await openUrls([PROSTATEX_DATASET]);
+
+    await volViewPage.waitForViews();
+
+    const renderTab = volViewPage.renderingModuleTab;
+    await renderTab.click();
+
+    const view3D = await volViewPage.getView3D();
+
+    const volumeRenderingSection =
+      await volViewPage.getVolumeRenderingSection();
+    await expect(volumeRenderingSection).toExist();
+    await expect(volumeRenderingSection).toBeDisplayed();
+
+    const pwfCanvas = await $('div.pwf-editor canvas');
+    await expect(pwfCanvas).toExist();
+
+    await view3D!.click();
+    await expect(volumeRenderingSection).toBeDisplayed();
+
+    const view2D = await volViewPage.getView2D();
+    await view2D!.click();
+
+    await expect(volumeRenderingSection).toBeDisplayed();
+    await expect(pwfCanvas).toExist();
+  });
+
   it('should create overlay with 2 DICOM images', async () => {
     await openUrls([PROSTATEX_DATASET, MRA_HEAD_NECK_DATASET]);
 

tests/specs/rendering-controls-3d-view.e2e.ts

@@ -1,22 +1,29 @@
 import AppPage from '../pageobjects/volview.page';
 
-// handle pixel jitter in 3D view
-const THRESHOLD = 12; // percent
+const THRESHOLD = 12; // percent - handle pixel jitter in 3D view
+const RENDER_STABLE_TIMEOUT = 5000;
 
 describe('VolView', () => {
   it('should load and render a sample dataset', async () => {
     await AppPage.open();
     await AppPage.downloadProstateSample();
     await AppPage.waitForViews();
-    await browser.pause(5000);
 
     const layoutContainer = await $('.layout-container');
 
-    const result = await browser.checkElement(
-      layoutContainer,
-      'prostate_sample_views'
+    await browser.waitUntil(
+      async () => {
+        const result = await browser.checkElement(
+          layoutContainer,
+          'prostate_sample_views'
+        );
+        return (result as number) < THRESHOLD;
+      },
+      {
+        timeout: RENDER_STABLE_TIMEOUT,
+        interval: 500,
+        timeoutMsg: `Visual comparison exceeded ${THRESHOLD}% threshold after ${RENDER_STABLE_TIMEOUT}ms`,
+      }
     );
-
-    await expect(result).toBeLessThan(THRESHOLD);
   });
 });

tests/specs/sample-rendering.e2e.ts

@@ -3,6 +3,33 @@ import * as fs from 'fs';
 import type { Options, Capabilities } from '@wdio/types';
 import { projectRoot } from './tests/e2eTestUtils';
 
+const TEST_DATASETS = [
+  {
+    url: 'https://data.kitware.com/api/v1/file/6566aa81c5a2b36857ad1783/download',
+    name: 'CT000085.dcm',
+  },
+  {
+    url: 'https://data.kitware.com/api/v1/file/68e9807dbf0f869935e36481/download',
+    name: 'minimal.dcm',
+  },
+  {
+    url: 'https://data.kitware.com/api/v1/file/655d42a694ef39bf0a4a8bb3/download',
+    name: '1-001.dcm',
+  },
+  {
+    url: 'https://data.kitware.com/api/v1/item/63527c7311dab8142820a338/download',
+    name: 'prostate.zip',
+  },
+  {
+    url: 'https://data.kitware.com/api/v1/item/6352a2b311dab8142820a33b/download',
+    name: 'MRA-Head_and_Neck.zip',
+  },
+  {
+    url: 'https://data.kitware.com/api/v1/item/635679c311dab8142820a4f4/download',
+    name: 'fetus.zip',
+  },
+];
+
 export const WINDOW_SIZE = [1200, 800] as const;
 export const TEST_PORT = 4567;
 // for slow connections try:
@@ -39,8 +66,8 @@ export const config: Options.Testrunner = {
   // ===================
   logLevel: 'warn',
   bail: 0,
-  waitforTimeout: 30000,
-  connectionRetryTimeout: 120000,
+  waitforTimeout: 10000,
+  connectionRetryTimeout: 30000,
   connectionRetryCount: 3,
   services: [
     [
@@ -72,15 +99,26 @@ export const config: Options.Testrunner = {
   reporters: ['spec', 'html-nice'],
   mochaOpts: {
     ui: 'bdd',
-    timeout: 160 * 1000,
+    timeout: 60000,
   },
 
   //
   // Hooks
   //
 
-  onPrepare() {
+  async onPrepare() {
     fs.mkdirSync(TEMP_DIR, { recursive: true });
+
+    const downloads = TEST_DATASETS.map(async ({ url, name }) => {
+      const savePath = path.join(TEMP_DIR, name);
+      if (fs.existsSync(savePath)) {
+        return;
+      }
+      const response = await fetch(url);
+      const data = await response.arrayBuffer();
+      fs.writeFileSync(savePath, Buffer.from(data));
+    });
+    await Promise.all(downloads);
   },
 
   async before(