ohif-viewer/rsbuild.config.ts
Bill Wallace 3dd5c70cb2
feat: Add customization URL parameter (#5992)
* Add customization URL parameter

* fix: Preserve should be customizeable

* Update customizations docs

* fix: Overlay items on patient name

* Add customization test

* Fix resolve to absolute path

* fix: Warn on no data in load

* Remove unused customization stuff

* fix: PR comments

* Update stored parameters to only use an array for mulitples

* Remove requires ohif.* special call out

* Remove strict mode

* PR comments

* Document segmentation examples

* Add three examples as requested

* PR comments

* lock

* Remove old customizatoin export

* fix: Ordering issues on customization loads

* fix: Use correct default for dev builds app config

* Fixes for conflicts

* chore: restore pnpm-lock.yaml to match master

The lockfile diff was incidental peer-descriptor churn and carried no
functional dependency change. It tripped the CircleCI security-audit gate
(which only runs when pnpm-lock.yaml is in the PR diff), surfacing a
pre-existing critical `decompress` transitive vuln that also exists on
master. Restoring master's lockfile removes the audit trigger.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* fix(ci): restore json5 lockfile entry; ignore unfixable decompress GHSA

The previous commit restored pnpm-lock.yaml from master, which dropped the
json5@2.2.3 entry that platform/core legitimately depends on (JSONC parsing
for the customization feature). That broke `--frozen-lockfile` install
(ERR_PNPM_OUTDATED_LOCKFILE). This restores the correct lockfile.

Because the lockfile must change (json5), the CircleCI security-audit gate
runs and previously failed on a critical `decompress` <=4.2.1 zip-slip
advisory. This is a pre-existing transitive vuln (present on master too) with
no published patch — decompress's latest release is 4.2.1, so no version
bump/override can resolve it. It reaches the tree only via @itk-wasm/dam, a
build/data-asset extraction tool under @cornerstonejs/labelmap-interpolation.

Add GHSA-mp2f-45pm-3cg9 to the existing pnpm-workspace.yaml auditConfig
ignoreGhsas accepted-risk list, matching how the repo already exempts other
build-tooling advisories. `pnpm audit --audit-level high` now passes locally
(1 critical ignored, 0 high).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* test(e2e): fix visitStudy URL encoding that broke mpr2 study load

The visitStudy rewrite (added for the ?customization= option) built the URL
with new URLSearchParams({ StudyInstanceUIDs: studyInstanceUID }), which
percent-encodes the value. mpr2.spec.ts embeds an extra param in the UID
string ('<uid>&hangingprotocolid=mpr'), so the & and = were encoded and the
whole thing collapsed into one invalid StudyInstanceUIDs value -> the study
could not be found ('studies are not available'), the viewer never rendered,
and the side-panel-header-right click timed out.

Restore master's raw concatenation for StudyInstanceUIDs (so embedded params
survive as separate query params) while still appending the customization
option separately. Only mpr2 embeds & in the UID, matching the single failure.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* PR comments

---------

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-07-07 15:30:27 -04:00

194 lines
6.7 KiB
TypeScript

import { defineConfig } from '@rsbuild/core';
import { pluginReact } from '@rsbuild/plugin-react';
import { pluginNodePolyfill } from '@rsbuild/plugin-node-polyfill';
import path from 'path';
import writePluginImportsFile from './platform/app/.webpack/writePluginImportsFile';
// Module-resolution rules shared with the webpack/rspack build (webpack.base.js)
// so the two pipelines resolve identically.
import resolveConfig from './.webpack/resolveConfig';
import fs from 'fs';
const SRC_DIR = path.resolve(__dirname, './platform/app/src');
const DIST_DIR = path.resolve(__dirname, './platform/app/dist');
const PUBLIC_DIR = path.resolve(__dirname, './platform/app/public');
// Environment variables (similar to webpack.pwa.js)
// rsbuild is used only by the dev server (`dev:fast`), so default to the
// full-featured `config/dev.js` while still honoring an explicit APP_CONFIG.
const APP_CONFIG = process.env.APP_CONFIG || 'config/dev.js';
const PUBLIC_URL = process.env.PUBLIC_URL || '/';
// Add these constants
const NODE_ENV = process.env.NODE_ENV;
const BUILD_NUM = process.env.CIRCLE_BUILD_NUM || '0';
const VERSION_NUMBER = fs.readFileSync(path.join(__dirname, './version.txt'), 'utf8') || '';
const COMMIT_HASH = fs.readFileSync(path.join(__dirname, './commit.txt'), 'utf8') || '';
const PROXY_TARGET = process.env.PROXY_TARGET;
const PROXY_DOMAIN = process.env.PROXY_DOMAIN;
const PROXY_PATH_REWRITE_FROM = process.env.PROXY_PATH_REWRITE_FROM;
const PROXY_PATH_REWRITE_TO = process.env.PROXY_PATH_REWRITE_TO;
// Add port constant
const OHIF_PORT = Number(process.env.OHIF_PORT || 3000);
const OHIF_OPEN = process.env.OHIF_OPEN !== 'false';
// Ignore node_modules except @cornerstonejs (symlinked local development).
const WATCH_IGNORED = /node_modules[\\/](?!@cornerstonejs(?:[\\/]|$))/;
const WATCH_AGGREGATE_TIMEOUT = Number(process.env.WATCH_AGGREGATE_TIMEOUT || 1500);
export default defineConfig({
dev: {
lazyCompilation: false,
},
source: {
entry: {
index: `${SRC_DIR}/index.js`,
},
define: {
'process.env.NODE_ENV': JSON.stringify(process.env.NODE_ENV),
'process.env.NODE_DEBUG': JSON.stringify(process.env.NODE_DEBUG),
'process.env.DEBUG': JSON.stringify(process.env.DEBUG),
'process.env.PUBLIC_URL': JSON.stringify(process.env.PUBLIC_URL || '/'),
'process.env.BUILD_NUM': JSON.stringify(BUILD_NUM),
'process.env.VERSION_NUMBER': JSON.stringify(VERSION_NUMBER),
'process.env.COMMIT_HASH': JSON.stringify(COMMIT_HASH),
'process.env.USE_LOCIZE': JSON.stringify(process.env.USE_LOCIZE || ''),
'process.env.LOCIZE_PROJECTID': JSON.stringify(process.env.LOCIZE_PROJECTID || ''),
'process.env.LOCIZE_API_KEY': JSON.stringify(process.env.LOCIZE_API_KEY || ''),
'process.env.REACT_APP_I18N_DEBUG': JSON.stringify(process.env.REACT_APP_I18N_DEBUG || ''),
},
},
plugins: [pluginReact(), pluginNodePolyfill()],
tools: {
rspack: {
experiments: {
asyncWebAssembly: true,
},
// Leave __filename / __dirname references alone. rsbuild's default
// ('warn-mock') noisily warns whenever bundled deps reference them
// (e.g. Emscripten-compiled cornerstone codecs). Those references sit
// inside `if (ENVIRONMENT_IS_NODE)` branches that never execute in the
// browser, so leaving them un-substituted is harmless at runtime.
node: {
__filename: false,
__dirname: false,
},
module: {
rules: [
{
test: /\.css$/,
use: [
{
loader: 'postcss-loader',
options: {
postcssOptions: {
plugins: {
tailwindcss: {},
autoprefixer: {},
},
},
},
},
],
type: 'javascript/auto',
},
{
test: /\.wasm$/,
type: 'asset/resource',
},
],
},
resolve: {
// Extensions/modes are resolved from their source dirs (see the
// resolve.alias above), so their imports of shared OHIF packages
// (@ohif/ui-next, @ohif/core, ...) must resolve against platform/app's
// installed dependencies rather than only the importer-relative
// node_modules. Shared with webpack.base.js via ./.webpack/resolveConfig.
modules: resolveConfig.getModules(SRC_DIR),
fallback: {
buffer: require.resolve('buffer'),
},
},
watchOptions: {
ignored: WATCH_IGNORED,
followSymlinks: true,
aggregateTimeout: WATCH_AGGREGATE_TIMEOUT,
},
},
},
resolve: {
alias: {
// Resolve every extension/mode declared in pluginConfig.json to its
// source directory, so the dynamic import()s in the generated
// pluginImports.js link without the plugins being dependencies of
// platform/app. Merged in separately since it depends on pluginConfig.json.
...writePluginImportsFile.getPluginResolveAliases(),
// App-level aliases (@ohif/app, @, @components, ...) shared with the
// webpack/rspack build via ./.webpack/resolveConfig.
...resolveConfig.alias,
},
},
output: {
copy: [
// Copy plugin files (handled by writePluginImportsFile)
...(writePluginImportsFile(SRC_DIR, DIST_DIR) || []),
// Copy public directory except config and html-templates
{
from: path.resolve(__dirname, 'node_modules/onnxruntime-web/dist'),
to: `${DIST_DIR}/ort`,
force: true,
},
{
from: PUBLIC_DIR,
to: DIST_DIR,
globOptions: {
ignore: ['**/config/**', '**/html-templates/**', '.DS_Store'],
},
},
// Copy Google config
{
from: path.resolve(PUBLIC_DIR, 'config/google.js'),
to: 'google.js',
},
// Copy app config
{
from: path.resolve(PUBLIC_DIR, APP_CONFIG),
to: 'app-config.js',
},
],
},
html: {
template: path.resolve(PUBLIC_DIR, 'html-templates/index.html'),
templateParameters: {
PUBLIC_URL,
},
},
server: {
port: OHIF_PORT,
open: OHIF_OPEN,
// Configure proxy
proxy: {
'/dicomweb': {
target: 'http://localhost:5000',
},
// Add conditional proxy based on env vars
...(PROXY_TARGET && PROXY_DOMAIN
? {
[PROXY_TARGET]: {
target: PROXY_DOMAIN,
changeOrigin: true,
pathRewrite: {
[`^${PROXY_PATH_REWRITE_FROM}`]: PROXY_PATH_REWRITE_TO,
},
},
}
: {}),
},
// Configure history API fallback
historyApiFallback: {
disableDotRule: true,
index: `${PUBLIC_URL}index.html`,
},
},
});