Merge pull request #56 from ImagingDataCommons/update/ohif-v3.9.0-bet…

…a.70 Update to OHIF v3.9.0 beta.71
ImagingDataCommons · Jul 30, 2024 · 980e2f7 · 980e2f7
2 parents 9de71f9 + 5286227
commit 980e2f7
Show file tree

Hide file tree

Showing 1,077 changed files with 47,125 additions and 7,892 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -53,11 +53,11 @@ commands:
             echo "Deployment project: ${PROJECT_ID}"
             echo "Deployment bucket: gs://${BUCKET}"
 
-## https://github.com/cypress-io/circleci-orb
-##
-#orbs:
-#  codecov: codecov/codecov@1.0.5
-#  cypress: cypress-io/cypress@3.3.1
+  ## https://github.com/cypress-io/circleci-orb
+  ##
+  #orbs:
+  #  codecov: codecov/codecov@1.0.5
+  #  cypress: cypress-io/cypress@3.3.1
 
   deployment_config:
     steps:
@@ -222,6 +222,7 @@ jobs:
         default: ''
         description: Directory containing package.json
         type: string
+    resource_class: large
     steps:
       - cypress/install:
           cypress-cache-key: << parameters.cypress-cache-key >>

diff --git a/.env.example b/.env.example
diff --git a/.github/workflows/playwright.yml b/.github/workflows/playwright.yml
@@ -0,0 +1,63 @@
+name: Playwright Tests
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+    branches: [main, master]
+jobs:
+  playwright-tests:
+    timeout-minutes: 60
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        shardIndex: [1, 2, 3, 4, 5]
+        shardTotal: [5]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 18
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+      - name: Install Playwright Browsers
+        run: npx playwright install --with-deps
+      - name: Run Playwright tests
+        run: export NODE_OPTIONS="--max_old_space_size=8192" && npx playwright test --shard=${{ matrix.shardIndex }}/${{ matrix.shardTotal }}
+
+      - name: Upload blob report to GitHub Actions Artifacts
+        if: ${{ !cancelled() }}
+        uses: actions/upload-artifact@v4
+        with:
+          name: blob-report-${{ matrix.shardIndex }}
+          path: blob-report
+          retention-days: 1
+
+  merge-reports:
+    if: ${{ !cancelled() }}
+    needs: [playwright-tests]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 18
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+
+      - name: Download blob reports from GitHub Actions Artifacts
+        uses: actions/download-artifact@v4
+        with:
+          path: all-blob-reports
+          pattern: blob-report-*
+          merge-multiple: true
+
+      - name: Merge into HTML Report
+        run: npx playwright merge-reports --reporter html ./all-blob-reports
+
+      - name: Upload HTML report
+        uses: actions/upload-artifact@v4
+        with:
+          name: html-report--attempt-${{ github.run_attempt }}
+          path: playwright-report
+          retention-days: 14
diff --git a/.gitignore b/.gitignore
@@ -10,6 +10,8 @@ junit.xml
 coverage/
 .docz/
 .yarn/
+.nx/
+addOns/yarn.lock
 
 # YALC (for Erik)
 .yalc
@@ -33,16 +35,24 @@ docker/dcm4che/dcm4che-arc
 
 # Cypress test results
 videos/
-screenshots/
+
 
 # Locize settings
 .locize
 
 # autogenerated files
 platform/app/src/pluginImports.js
 /Viewers.iml
-platform/app/.recipes/Nginx-Dcm4Che/dcm4che/dcm4che-arc/*
+platform/app/.recipes/Nginx-Dcm4Chee/logs/*
 platform/app/.recipes/OpenResty-Orthanc/logs/*
 .vercel
 
 .vs
+
+# PlayWright
+
+node_modules/
+tests/test-results/
+tests/playwright-report/
+/blob-report/
+/playwright/.cache/
diff --git a/.scripts/dicom-json-generator.js b/.scripts/dicom-json-generator.js
@@ -4,34 +4,42 @@
  * The JSON file can be used to load the study into the OHIF Viewer. You can get more detail
  * in the DICOM JSON Data source on docs.ohif.org
  *
- * Usage: node dicomStudyToJSONLaunch.js <studyFolder> <urlPrefix> <outputJSONPath>
+ * Usage: node dicomStudyToJSONLaunch.js <studyFolder> <urlPrefix> <outputJSONPath> <optional scheme>
  *
  * params:
- * - studyFolder: path to the study folder
+ * - studyFolder: path to the study folder which contains the DICOM files
  * - urlPrefix: prefix to the url that will be used to load the study into the viewer. For instance
  *   we use https://ohif-assets.s3.us-east-2.amazonaws.com/dicom-json/data as the urlPrefix for the
  *   example since the data is hosted on S3 and each study is in a folder. So the url in the generated
  *   json file for the first instance of the first series of the first study will be
  *   dicomweb:https://ohif-assets.s3.us-east-2.amazonaws.com/dicom-json/data/Series1/Instance1
+ *
+ *   as you see the dicomweb is a prefix that is used to load the data into the viewer, which is suited when
+ *   the .dcm file is hosted statically and can be accessed via a URL (like our example above)
+ *   However, you can specify a new scheme bellow.
+ *
  * - outputJSONPath: path to the output JSON file
+ * - scheme: default dicomweb if not provided
  */
 const dcmjs = require('dcmjs');
 const path = require('path');
 const fs = require('fs').promises;
 
 const args = process.argv.slice(2);
-const [studyDirectory, urlPrefix, outputPath] = args;
+const [studyDirectory, urlPrefix, outputPath, scheme = 'dicomweb'] = args;
 
-if (args.length !== 3) {
-  console.error('Usage: node dicomStudyToJSONLaunch.js <studyFolder> <urlPrefix> <outputJSONPath>');
+if (args.length < 3 || args.length > 4) {
+  console.error(
+    'Usage: node dicomStudyToJSONLaunch.js <studyFolder> <urlPrefix> <outputJSONPath> [scheme]'
+  );
   process.exit(1);
 }
 
 const model = {
   studies: [],
 };
 
-async function convertDICOMToJSON(studyDirectory, urlPrefix, outputPath) {
+async function convertDICOMToJSON(studyDirectory, urlPrefix, outputPath, scheme) {
   try {
     const files = await recursiveReadDir(studyDirectory);
     console.debug('Processing...');
@@ -42,7 +50,7 @@ async function convertDICOMToJSON(studyDirectory, urlPrefix, outputPath) {
         const dicomDict = dcmjs.data.DicomMessage.readFile(arrayBuffer.buffer);
         const instance = dcmjs.data.DicomMetaDictionary.naturalizeDataset(dicomDict.dict);
 
-        instance.fileLocation = createImageId(file, urlPrefix, studyDirectory);
+        instance.fileLocation = createImageId(file, urlPrefix, studyDirectory, scheme);
         processInstance(instance);
       }
     }
@@ -77,10 +85,10 @@ async function recursiveReadDir(dir) {
   return results;
 }
 
-function createImageId(fileLocation, urlPrefix, studyDirectory) {
+function createImageId(fileLocation, urlPrefix, studyDirectory, scheme) {
   const relativePath = path.relative(studyDirectory, fileLocation);
   const normalizedPath = path.normalize(relativePath).replace(/\\/g, '/');
-  return `dicomweb:${urlPrefix}${normalizedPath}`;
+  return `${scheme}:${urlPrefix}${normalizedPath}`;
 }
 
 function processInstance(instance) {
@@ -262,4 +270,4 @@ function createInstanceMetaDataMultiFrame(instance) {
   return instances;
 }
 
-convertDICOMToJSON(studyDirectory, urlPrefix, outputPath);
+convertDICOMToJSON(studyDirectory, urlPrefix, outputPath, scheme);
diff --git a/.webpack/webpack.base.js b/.webpack/webpack.base.js
@@ -7,7 +7,7 @@ const fs = require('fs');
 const webpack = require('webpack');
 
 // ~~ PLUGINS
-const BundleAnalyzerPlugin = require('webpack-bundle-analyzer').BundleAnalyzerPlugin;
+// const BundleAnalyzerPlugin = require('webpack-bundle-analyzer').BundleAnalyzerPlugin;
 const TerserJSPlugin = require('terser-webpack-plugin');
 
 // ~~ PackageJSON
@@ -19,6 +19,8 @@ const loadWebWorkersRule = require('./rules/loadWebWorkers.js');
 const transpileJavaScriptRule = require('./rules/transpileJavaScript.js');
 const cssToJavaScript = require('./rules/cssToJavaScript.js');
 const stylusToJavaScript = require('./rules/stylusToJavaScript.js');
+const ReactRefreshWebpackPlugin = require('@pmmmwh/react-refresh-webpack-plugin');
+
 
 // ~~ ENV VARS
 const NODE_ENV = process.env.NODE_ENV;
@@ -98,6 +100,46 @@ module.exports = (env, argv, { SRC_DIR, ENTRY }) => {
     module: {
       noParse: [/(codec)/, /(dicomicc)/],
       rules: [
+        ...(isProdBuild ? [] : [{
+          test: /\.[jt]sx?$/,
+          exclude: /node_modules/,
+          loader: 'babel-loader',
+          options: {
+            plugins: ['react-refresh/babel'],
+          },
+        }]),
+        {
+          test: /\.svg?$/,
+          oneOf: [
+            {
+              use: [
+                {
+                  loader: '@svgr/webpack',
+                  options: {
+                    svgoConfig: {
+                      plugins: [
+                        {
+                          name: 'preset-default',
+                          params: {
+                            overrides: {
+                              removeViewBox: false
+                            },
+                          },
+                        },
+                      ]
+                    },
+                    prettier: false,
+                    svgo: true,
+                    titleProp: true,
+                  },
+                },
+              ],
+              issuer: {
+                and: [/\.(ts|tsx|js|jsx|md|mdx)$/],
+              },
+            },
+          ],
+        },
         {
           test: /\.js$/,
           enforce: 'pre',
@@ -142,8 +184,6 @@ module.exports = (env, argv, { SRC_DIR, ENTRY }) => {
         '@hooks': path.resolve(__dirname, '../platform/app/src/hooks'),
         '@routes': path.resolve(__dirname, '../platform/app/src/routes'),
         '@state': path.resolve(__dirname, '../platform/app/src/state'),
-        'dicom-microscopy-viewer':
-          'dicom-microscopy-viewer/dist/dynamic-import/dicomMicroscopyViewer.min.js',
         '@cornerstonejs/dicom-image-loader':
           '@cornerstonejs/dicom-image-loader/dist/dynamic-import/cornerstoneDICOMImageLoader.min.js',
       },
@@ -173,6 +213,7 @@ module.exports = (env, argv, { SRC_DIR, ENTRY }) => {
       new webpack.ProvidePlugin({
         Buffer: ['buffer', 'Buffer'],
       }),
+      ...(isProdBuild ? [] : [new ReactRefreshWebpackPlugin()]),
       // Uncomment to generate bundle analyzer
       // new BundleAnalyzerPlugin(),
     ],