Skip to content

Commit

Permalink
feat(OHIF):Allow modes and extensions to be added after commpile time. (
Browse files Browse the repository at this point in the history 
#2838)

Also works with the compile time add that the existing cli uses, so that both build types work.
Eric and I agreed this doesn't change existing functionality, but is almost entirely build issues/fixes.
  • Loading branch information
@wayfarer3130
wayfarer3130 authored Jul 15, 2022
1 parent d6c2da8 commit e97424c
Show file tree
Hide file tree
Showing 17 changed files with 291 additions and 47 deletions.
18 changes: 15 additions & 3 deletions platform/cli/templates/extension/.webpack/webpack.prod.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,23 +25,35 @@ const config = {
commonjs: 'react',
amd: 'react',
},
'@ohif/core': {
commonjs2: '@ohif/core',
commonjs: '@ohif/core',
amd: '@ohif/core',
root: '@ohif/core',
},
'@ohif/ui': {
commonjs2: '@ohif/ui',
commonjs: '@ohif/ui',
amd: '@ohif/ui',
root: '@ohif/ui',
},
},
],
module: {
rules: [
{
test: /(\.jsx|\.js)$/,
test: /(\.jsx|\.js|\.tsx|\.ts)$/,
loader: 'babel-loader',
exclude: /(node_modules|bower_components)/,
resolve: {
extensions: ['.js', '.jsx'],
extensions: ['.js', '.jsx', '.ts', '.tsx',],
},
},
],
},
resolve: {
modules: [path.resolve('./node_modules'), path.resolve('./src')],
extensions: ['.json', '.js', '.jsx'],
extensions: ['.json', '.js', '.jsx', '.tsx', '.ts',],
},
};

Expand Down
3 changes: 3 additions & 0 deletions platform/cli/templates/extension/babel.config.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ module.exports = {
modules: 'commonjs',
debug: false,
},
"@babel/preset-typescript",
],
'@babel/preset-react',
],
Expand All @@ -25,6 +26,7 @@ module.exports = {
// WebPack handles ES6 --> Target Syntax
['@babel/preset-env', { modules: false }],
'@babel/preset-react',
"@babel/preset-typescript",
],
ignore: ['**/*.test.jsx', '**/*.test.js', '__snapshots__', '__tests__'],
},
Expand All @@ -33,6 +35,7 @@ module.exports = {
// WebPack handles ES6 --> Target Syntax
['@babel/preset-env', { modules: false }],
'@babel/preset-react',
"@babel/preset-typescript",
],
plugins: ['react-hot-loader/babel'],
ignore: ['**/*.test.jsx', '**/*.test.js', '__snapshots__', '__tests__'],
Expand Down
0 ...form/cli/templates/extension/src/index.js → ...orm/cli/templates/extension/src/index.tsx
View file
File renamed without changes.
18 changes: 15 additions & 3 deletions platform/cli/templates/mode/.webpack/webpack.prod.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,23 +25,35 @@ const config = {
commonjs: 'react',
amd: 'react',
},
'@ohif/core': {
commonjs2: '@ohif/core',
commonjs: '@ohif/core',
amd: '@ohif/core',
root: '@ohif/core',
},
'@ohif/ui': {
commonjs2: '@ohif/ui',
commonjs: '@ohif/ui',
amd: '@ohif/ui',
root: '@ohif/ui',
},
},
],
module: {
rules: [
{
test: /(\.jsx|\.js)$/,
test: /(\.jsx|\.js|\.tsx|\.ts)$/,
loader: 'babel-loader',
exclude: /(node_modules|bower_components)/,
resolve: {
extensions: ['.js', '.jsx'],
extensions: ['.js', '.jsx', '.ts', '.tsx',],
},
},
],
},
resolve: {
modules: [path.resolve('./node_modules'), path.resolve('./src')],
extensions: ['.json', '.js', '.jsx'],
extensions: ['.json', '.js', '.jsx', '.tsx', '.ts',],
},
};

Expand Down
3 changes: 3 additions & 0 deletions platform/cli/templates/mode/babel.config.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ module.exports = {
modules: 'commonjs',
debug: false,
},
"@babel/preset-typescript",
],
'@babel/preset-react',
],
Expand All @@ -25,6 +26,7 @@ module.exports = {
// WebPack handles ES6 --> Target Syntax
['@babel/preset-env', { modules: false }],
'@babel/preset-react',
"@babel/preset-typescript",
],
ignore: ['**/*.test.jsx', '**/*.test.js', '__snapshots__', '__tests__'],
},
Expand All @@ -33,6 +35,7 @@ module.exports = {
// WebPack handles ES6 --> Target Syntax
['@babel/preset-env', { modules: false }],
'@babel/preset-react',
"@babel/preset-typescript",
],
plugins: ['react-hot-loader/babel'],
ignore: ['**/*.test.jsx', '**/*.test.js', '__snapshots__', '__tests__'],
Expand Down
3 changes: 2 additions & 1 deletion platform/cli/templates/mode/dependencies.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,12 @@
"@babel/plugin-transform-arrow-functions": "^7.2.0",
"@babel/plugin-transform-regenerator": "^7.4.5",
"@babel/plugin-transform-runtime": "^7.5.0",
"babel-plugin-inline-react-svg": "^2.0.1",
"@babel/preset-env": "^7.5.0",
"@babel/preset-react": "^7.0.0",
"@babel/preset-typescript": "^7.17.12",
"babel-eslint": "^8.0.3",
"babel-loader": "^8.0.0-beta.4",
"babel-plugin-inline-react-svg": "^2.0.1",
"clean-webpack-plugin": "^4.0.0",
"copy-webpack-plugin": "^10.2.0",
"cross-env": "^7.0.3",
Expand Down
0 platform/cli/templates/mode/src/index.js → platform/cli/templates/mode/src/index.tsx
View file
File renamed without changes.
22 changes: 8 additions & 14 deletions platform/viewer/.webpack/webpack.pwa.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ const ENTRY_TARGET = process.env.ENTRY_TARGET || `${SRC_DIR}/index.js`;
const Dotenv = require('dotenv-webpack');
const writePluginImportFile = require('./writePluginImportsFile.js');

writePluginImportFile(SRC_DIR);
const copyPluginFromExtensions = writePluginImportFile(SRC_DIR, DIST_DIR);

const setHeaders = (res, path) => {
if (path.indexOf('.gz') !== -1) {
Expand All @@ -35,6 +35,8 @@ const setHeaders = (res, path) => {
}
if (path.indexOf('.pdf') !== -1) {
res.setHeader('Content-Type', 'application/pdf');
} else if (path.indexOf('/frames') !== -1) {
res.setHeader('Content-Type', 'multipart/related')
} else {
res.setHeader('Content-Type', 'application/json')
}
Expand Down Expand Up @@ -77,6 +79,7 @@ module.exports = (env, argv) => {
// Copy "Public" Folder to Dist
new CopyWebpackPlugin({
patterns: [
...copyPluginFromExtensions,
{
from: PUBLIC_DIR,
to: DIST_DIR,
Expand Down Expand Up @@ -108,13 +111,14 @@ module.exports = (env, argv) => {
PUBLIC_URL: PUBLIC_URL,
},
}),
// No longer maintained; but good for generating icons + manifest
// new FaviconsWebpackPlugin( path.join(PUBLIC_DIR, 'assets', 'icons-512.png')),
// Generate a service worker for fast local loads
new InjectManifest({
swDest: 'sw.js',
swSrc: path.join(SRC_DIR, 'service-worker.js'),
// Increase the limit to 4mb:
maximumFileSizeToCacheInBytes: 4 * 1024 * 1024,
maximumFileSizeToCacheInBytes: 5 * 1024 * 1024,
// Need to exclude the theme as it is updated independently
exclude: [/theme/],
}),
new CopyPlugin({
patterns: [
Expand All @@ -140,16 +144,6 @@ module.exports = (env, argv) => {
overlay: { errors: true, warnings: false },
},
'static': [
{
directory: path.join(require('os').homedir(), 'dicomweb'),
staticOptions: {
extensions: ['gz', 'br'],
index: "index.json.gz",
redirect: true,
setHeaders,
},
publicPath: '/dicomweb',
},
{
directory: '../../testdata',
staticOptions: {
Expand Down
52 changes: 49 additions & 3 deletions platform/viewer/.webpack/writePluginImportsFile.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ function constructLines(input, categoryName) {
addToWindowLines: [],
};

if (!input) return lines;

input.forEach(entry => {
const packageName = entry.packageName;

Expand All @@ -22,7 +24,7 @@ function constructLines(input, categoryName) {
`import ${defaultImportName} from '${packageName}';\n`
);
lines.addToWindowLines.push(
`window.${categoryName}.push(${defaultImportName});\n`
`${categoryName}.push(${defaultImportName});\n`
);

pluginCount++;
Expand All @@ -42,7 +44,11 @@ function getFormattedImportBlock(importLines) {
}

function getFormattedWindowBlock(addToWindowLines) {
let content = `window.extensions = [];\nwindow.modes = [];\n\n`;
let content = "const extensions = [];\n" +
"const modes = [];\n" +
"const modesFactory = [];\n" +
"window.extensions = extensions;\n" +
"window.modes = modes;\n\n";

addToWindowLines.forEach(addToWindowLine => {
content += addToWindowLine;
Expand All @@ -51,21 +57,49 @@ function getFormattedWindowBlock(addToWindowLines) {
return content;
}

function writePluginImportsFile(SRC_DIR) {
function getRuntimeLoadModesExtensions() {
return "\n\n// Add a dynamic runtime loader\n" +
"export default async () => {\n" +
" for(const modeFactory of modesFactory) {\n" +
" const newModes = await modeFactory(modes,extensions);\n" +
" newModes.forEach(newMode => modes.push(newMode));\n" +
"}\n}\n";
}

const createCopyPluginFromExtensions = (SRC_DIR, DIST_DIR, plugins) => {

return plugins.map(plugin => {
const from = `${SRC_DIR}/../node_modules/${plugin.packageName}/public/`;
const exists = fs.existsSync(from);
return exists ? {
from,
to: DIST_DIR,
toType: 'dir',
} : undefined;
}
).filter(x => !!x);
}

function writePluginImportsFile(SRC_DIR, DIST_DIR) {
let pluginImportsJsContent = autogenerationDisclaimer;

const extensionLines = constructLines(pluginConfig.extensions, 'extensions');
const modeLines = constructLines(pluginConfig.modes, 'modes');
const modesFactoryLines = constructLines(pluginConfig.modesFactory, 'modesFactory');

pluginImportsJsContent += getFormattedImportBlock([
...extensionLines.importLines,
...modeLines.importLines,
...modesFactoryLines.importLines,
]);
pluginImportsJsContent += getFormattedWindowBlock([
...extensionLines.addToWindowLines,
...modeLines.addToWindowLines,
...modesFactoryLines.addToWindowLines,
]);

pluginImportsJsContent += getRuntimeLoadModesExtensions();

fs.writeFileSync(
`${SRC_DIR}/pluginImports.js`,
pluginImportsJsContent,
Expand All @@ -77,6 +111,18 @@ function writePluginImportsFile(SRC_DIR) {
}
}
);

const copyPluginFromExtensions = createCopyPluginFromExtensions(
SRC_DIR, DIST_DIR,
[
...pluginConfig.modesFactory,
...pluginConfig.modes,
...pluginConfig.extensions,
...pluginConfig.umd,
]
)

return copyPluginFromExtensions;
}

module.exports = writePluginImportsFile;
3 changes: 2 additions & 1 deletion platform/viewer/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,8 @@
"@babel/runtime": "7.16.3",
"@ohif/core": "^3.0.0",
"@ohif/extension-cornerstone": "^3.0.0",
"@ohif/extension-default": "^3.0.0",
"@ohif/extension-cornerstone-dicom-sr": "^3.0.0",
"@ohif/extension-default": "^3.0.0",
"@ohif/extension-dicom-pdf": "^3.0.1",
"@ohif/extension-dicom-video": "^3.0.1",
"@ohif/i18n": "^1.0.0",
Expand All @@ -59,6 +59,7 @@
"@ohif/ui": "^2.0.0",
"@types/react": "^16.0.0",
"classnames": "^2.2.6",
"config-point": "^0.4.8",
"core-js": "^3.16.1",
"cornerstone-math": "^0.1.9",
"cornerstone-wado-image-loader": "^4.1.2",
Expand Down
4 changes: 4 additions & 0 deletions platform/viewer/pluginConfig.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,5 +34,9 @@
"packageName": "@ohif/mode-longitudinal",
"version": "3.0.0"
}
],
"modesFactory": [
],
"umd": [
]
}
Loading

0 comments on commit e97424c

Please sign in to comment.