From cc23c18a16ef03d6243d4a3fd63531d979e867e7 Mon Sep 17 00:00:00 2001 From: Roman Vyakhirev Date: Tue, 10 Nov 2026 16:19:50 +0100 Subject: [PATCH 1/2] build: share mobx and mobx-react-lite between widgets Add withSharedLibs to @mendix/rollup-web-widgets. It builds mobx and mobx-react-lite as standalone AMD/ESM bundles at a versioned path (com/mendix/shared///) inside each MPK and points the widget bundles at them instead of inlining a copy. Widgets with the same library version ship identical files at the same path, so they collapse into one copy when deployed together; different versions sit side by side instead of overwriting each other. Use it in the Data Widgets widgets, file-uploader, image-cropper, date-time-picker and maps. --- .../datagrid-date-filter-web/package.json | 1 + .../rollup.config.mjs | 3 + .../datagrid-dropdown-filter-web/package.json | 1 + .../rollup.config.mjs | 3 + .../datagrid-number-filter-web/package.json | 1 + .../rollup.config.mjs | 3 + .../datagrid-text-filter-web/package.json | 1 + .../rollup.config.mjs | 3 + .../datagrid-web/package.json | 1 + .../{rollup.config.js => rollup.config.mjs} | 6 +- .../date-time-picker-web/rollup.config.mjs | 3 +- .../dropdown-sort-web/package.json | 1 + .../dropdown-sort-web/rollup.config.mjs | 3 + .../file-uploader-web/package.json | 1 + .../file-uploader-web/rollup.config.mjs | 12 +- .../pluggableWidgets/gallery-web/package.json | 1 + .../gallery-web/rollup.config.mjs | 3 + .../image-cropper-web/rollup.config.mjs | 3 +- .../maps-web/rollup.config.mjs | 3 +- .../selection-helper-web/package.json | 1 + .../selection-helper-web/rollup.config.mjs | 3 + .../shared/rollup-web-widgets/package.json | 9 + .../shared/rollup-web-widgets/sharedLibs.mjs | 224 ++++++++++++++++++ pnpm-lock.yaml | 51 +++- 24 files changed, 331 insertions(+), 10 deletions(-) create mode 100644 packages/pluggableWidgets/datagrid-date-filter-web/rollup.config.mjs create mode 100644 packages/pluggableWidgets/datagrid-dropdown-filter-web/rollup.config.mjs create mode 100644 packages/pluggableWidgets/datagrid-number-filter-web/rollup.config.mjs create mode 100644 packages/pluggableWidgets/datagrid-text-filter-web/rollup.config.mjs rename packages/pluggableWidgets/datagrid-web/{rollup.config.js => rollup.config.mjs} (63%) create mode 100644 packages/pluggableWidgets/dropdown-sort-web/rollup.config.mjs create mode 100644 packages/pluggableWidgets/gallery-web/rollup.config.mjs create mode 100644 packages/pluggableWidgets/selection-helper-web/rollup.config.mjs create mode 100644 packages/shared/rollup-web-widgets/sharedLibs.mjs diff --git a/packages/pluggableWidgets/datagrid-date-filter-web/package.json b/packages/pluggableWidgets/datagrid-date-filter-web/package.json index f3bac03d8d..fab0df7a94 100644 --- a/packages/pluggableWidgets/datagrid-date-filter-web/package.json +++ b/packages/pluggableWidgets/datagrid-date-filter-web/package.json @@ -54,6 +54,7 @@ "@mendix/eslint-config-web-widgets": "workspace:*", "@mendix/pluggable-widgets-tools": "*", "@mendix/prettier-config-web-widgets": "workspace:*", + "@mendix/rollup-web-widgets": "workspace:*", "@mendix/run-e2e": "workspace:*", "@mendix/widget-plugin-component-kit": "workspace:*", "@mendix/widget-plugin-hooks": "workspace:*", diff --git a/packages/pluggableWidgets/datagrid-date-filter-web/rollup.config.mjs b/packages/pluggableWidgets/datagrid-date-filter-web/rollup.config.mjs new file mode 100644 index 0000000000..03372ef256 --- /dev/null +++ b/packages/pluggableWidgets/datagrid-date-filter-web/rollup.config.mjs @@ -0,0 +1,3 @@ +import { withSharedLibs } from "@mendix/rollup-web-widgets/sharedLibs.mjs"; + +export default args => withSharedLibs(args, args.configDefaultConfig); diff --git a/packages/pluggableWidgets/datagrid-dropdown-filter-web/package.json b/packages/pluggableWidgets/datagrid-dropdown-filter-web/package.json index f1cab20101..372d61171d 100644 --- a/packages/pluggableWidgets/datagrid-dropdown-filter-web/package.json +++ b/packages/pluggableWidgets/datagrid-dropdown-filter-web/package.json @@ -53,6 +53,7 @@ "@mendix/eslint-config-web-widgets": "workspace:*", "@mendix/pluggable-widgets-tools": "*", "@mendix/prettier-config-web-widgets": "workspace:*", + "@mendix/rollup-web-widgets": "workspace:*", "@mendix/run-e2e": "workspace:*", "@mendix/widget-plugin-component-kit": "workspace:*", "@mendix/widget-plugin-hooks": "workspace:*", diff --git a/packages/pluggableWidgets/datagrid-dropdown-filter-web/rollup.config.mjs b/packages/pluggableWidgets/datagrid-dropdown-filter-web/rollup.config.mjs new file mode 100644 index 0000000000..03372ef256 --- /dev/null +++ b/packages/pluggableWidgets/datagrid-dropdown-filter-web/rollup.config.mjs @@ -0,0 +1,3 @@ +import { withSharedLibs } from "@mendix/rollup-web-widgets/sharedLibs.mjs"; + +export default args => withSharedLibs(args, args.configDefaultConfig); diff --git a/packages/pluggableWidgets/datagrid-number-filter-web/package.json b/packages/pluggableWidgets/datagrid-number-filter-web/package.json index d8ce00cbcc..9505a2a9a6 100644 --- a/packages/pluggableWidgets/datagrid-number-filter-web/package.json +++ b/packages/pluggableWidgets/datagrid-number-filter-web/package.json @@ -52,6 +52,7 @@ "@mendix/eslint-config-web-widgets": "workspace:*", "@mendix/pluggable-widgets-tools": "*", "@mendix/prettier-config-web-widgets": "workspace:*", + "@mendix/rollup-web-widgets": "workspace:*", "@mendix/run-e2e": "workspace:*", "@mendix/widget-plugin-component-kit": "workspace:*", "@mendix/widget-plugin-hooks": "workspace:*", diff --git a/packages/pluggableWidgets/datagrid-number-filter-web/rollup.config.mjs b/packages/pluggableWidgets/datagrid-number-filter-web/rollup.config.mjs new file mode 100644 index 0000000000..03372ef256 --- /dev/null +++ b/packages/pluggableWidgets/datagrid-number-filter-web/rollup.config.mjs @@ -0,0 +1,3 @@ +import { withSharedLibs } from "@mendix/rollup-web-widgets/sharedLibs.mjs"; + +export default args => withSharedLibs(args, args.configDefaultConfig); diff --git a/packages/pluggableWidgets/datagrid-text-filter-web/package.json b/packages/pluggableWidgets/datagrid-text-filter-web/package.json index 8d4edb8427..a3bac2a4e2 100644 --- a/packages/pluggableWidgets/datagrid-text-filter-web/package.json +++ b/packages/pluggableWidgets/datagrid-text-filter-web/package.json @@ -58,6 +58,7 @@ "@mendix/eslint-config-web-widgets": "workspace:*", "@mendix/pluggable-widgets-tools": "*", "@mendix/prettier-config-web-widgets": "workspace:*", + "@mendix/rollup-web-widgets": "workspace:*", "@mendix/run-e2e": "workspace:*", "@mendix/widget-plugin-test-utils": "workspace:*" } diff --git a/packages/pluggableWidgets/datagrid-text-filter-web/rollup.config.mjs b/packages/pluggableWidgets/datagrid-text-filter-web/rollup.config.mjs new file mode 100644 index 0000000000..03372ef256 --- /dev/null +++ b/packages/pluggableWidgets/datagrid-text-filter-web/rollup.config.mjs @@ -0,0 +1,3 @@ +import { withSharedLibs } from "@mendix/rollup-web-widgets/sharedLibs.mjs"; + +export default args => withSharedLibs(args, args.configDefaultConfig); diff --git a/packages/pluggableWidgets/datagrid-web/package.json b/packages/pluggableWidgets/datagrid-web/package.json index 6ca0ed1688..ef34d4d5c5 100644 --- a/packages/pluggableWidgets/datagrid-web/package.json +++ b/packages/pluggableWidgets/datagrid-web/package.json @@ -64,6 +64,7 @@ "@mendix/eslint-config-web-widgets": "workspace:*", "@mendix/pluggable-widgets-tools": "*", "@mendix/prettier-config-web-widgets": "workspace:*", + "@mendix/rollup-web-widgets": "workspace:*", "@mendix/run-e2e": "workspace:*", "@mendix/widget-plugin-test-utils": "workspace:*" } diff --git a/packages/pluggableWidgets/datagrid-web/rollup.config.js b/packages/pluggableWidgets/datagrid-web/rollup.config.mjs similarity index 63% rename from packages/pluggableWidgets/datagrid-web/rollup.config.js rename to packages/pluggableWidgets/datagrid-web/rollup.config.mjs index 7f48e8ef06..929aec1e6e 100644 --- a/packages/pluggableWidgets/datagrid-web/rollup.config.js +++ b/packages/pluggableWidgets/datagrid-web/rollup.config.mjs @@ -1,9 +1,11 @@ -module.exports = args => { +import { withSharedLibs } from "@mendix/rollup-web-widgets/sharedLibs.mjs"; + +export default args => { const [widgetAMD, widgetESM, editorPreview, editorConfig] = args.configDefaultConfig; // By default "react/jsx-runtime" is marked as external. // We remove it from external array to make it a normal dependency for editorPreview file. editorPreview.external = [/^mendix($|\/)/, /^react$/, /^react-dom$/]; - return [widgetAMD, widgetESM, editorPreview, editorConfig]; + return withSharedLibs(args, [widgetAMD, widgetESM, editorPreview, editorConfig]); }; diff --git a/packages/pluggableWidgets/date-time-picker-web/rollup.config.mjs b/packages/pluggableWidgets/date-time-picker-web/rollup.config.mjs index 688a1a7197..e07666fb64 100644 --- a/packages/pluggableWidgets/date-time-picker-web/rollup.config.mjs +++ b/packages/pluggableWidgets/date-time-picker-web/rollup.config.mjs @@ -1,5 +1,6 @@ import copyFiles from "@mendix/rollup-web-widgets/copyFiles.mjs"; +import { withSharedLibs } from "@mendix/rollup-web-widgets/sharedLibs.mjs"; export default args => { - return copyFiles(args); + return withSharedLibs(args, copyFiles(args)); }; diff --git a/packages/pluggableWidgets/dropdown-sort-web/package.json b/packages/pluggableWidgets/dropdown-sort-web/package.json index 774f8d3ff5..26fb2312fc 100644 --- a/packages/pluggableWidgets/dropdown-sort-web/package.json +++ b/packages/pluggableWidgets/dropdown-sort-web/package.json @@ -55,6 +55,7 @@ "@mendix/eslint-config-web-widgets": "workspace:*", "@mendix/pluggable-widgets-tools": "*", "@mendix/prettier-config-web-widgets": "workspace:*", + "@mendix/rollup-web-widgets": "workspace:*", "@mendix/run-e2e": "workspace:*", "@mendix/widget-plugin-test-utils": "workspace:*" } diff --git a/packages/pluggableWidgets/dropdown-sort-web/rollup.config.mjs b/packages/pluggableWidgets/dropdown-sort-web/rollup.config.mjs new file mode 100644 index 0000000000..03372ef256 --- /dev/null +++ b/packages/pluggableWidgets/dropdown-sort-web/rollup.config.mjs @@ -0,0 +1,3 @@ +import { withSharedLibs } from "@mendix/rollup-web-widgets/sharedLibs.mjs"; + +export default args => withSharedLibs(args, args.configDefaultConfig); diff --git a/packages/pluggableWidgets/file-uploader-web/package.json b/packages/pluggableWidgets/file-uploader-web/package.json index c266f27c8c..04ab8a6297 100644 --- a/packages/pluggableWidgets/file-uploader-web/package.json +++ b/packages/pluggableWidgets/file-uploader-web/package.json @@ -54,6 +54,7 @@ "@mendix/eslint-config-web-widgets": "workspace:*", "@mendix/pluggable-widgets-tools": "*", "@mendix/prettier-config-web-widgets": "workspace:*", + "@mendix/rollup-web-widgets": "workspace:*", "@mendix/widget-plugin-platform": "workspace:*", "@mendix/widget-plugin-test-utils": "workspace:*", "@rollup/plugin-json": "^6.1.0", diff --git a/packages/pluggableWidgets/file-uploader-web/rollup.config.mjs b/packages/pluggableWidgets/file-uploader-web/rollup.config.mjs index 39fb8030c2..eeba3b5357 100644 --- a/packages/pluggableWidgets/file-uploader-web/rollup.config.mjs +++ b/packages/pluggableWidgets/file-uploader-web/rollup.config.mjs @@ -1,9 +1,13 @@ import json from "@rollup/plugin-json"; +import { withSharedLibs } from "@mendix/rollup-web-widgets/sharedLibs.mjs"; export default args => { const result = args.configDefaultConfig; - return result.map((config, _index) => { - config.plugins = [...config.plugins, json()]; - return config; - }); + return withSharedLibs( + args, + result.map((config, _index) => { + config.plugins = [...config.plugins, json()]; + return config; + }) + ); }; diff --git a/packages/pluggableWidgets/gallery-web/package.json b/packages/pluggableWidgets/gallery-web/package.json index a9957f7e20..0ac70a4d25 100644 --- a/packages/pluggableWidgets/gallery-web/package.json +++ b/packages/pluggableWidgets/gallery-web/package.json @@ -59,6 +59,7 @@ "@mendix/eslint-config-web-widgets": "workspace:*", "@mendix/pluggable-widgets-tools": "*", "@mendix/prettier-config-web-widgets": "workspace:*", + "@mendix/rollup-web-widgets": "workspace:*", "@mendix/run-e2e": "workspace:*", "@mendix/widget-plugin-grid": "workspace:*", "@mendix/widget-plugin-platform": "workspace:*", diff --git a/packages/pluggableWidgets/gallery-web/rollup.config.mjs b/packages/pluggableWidgets/gallery-web/rollup.config.mjs new file mode 100644 index 0000000000..03372ef256 --- /dev/null +++ b/packages/pluggableWidgets/gallery-web/rollup.config.mjs @@ -0,0 +1,3 @@ +import { withSharedLibs } from "@mendix/rollup-web-widgets/sharedLibs.mjs"; + +export default args => withSharedLibs(args, args.configDefaultConfig); diff --git a/packages/pluggableWidgets/image-cropper-web/rollup.config.mjs b/packages/pluggableWidgets/image-cropper-web/rollup.config.mjs index 688a1a7197..e07666fb64 100644 --- a/packages/pluggableWidgets/image-cropper-web/rollup.config.mjs +++ b/packages/pluggableWidgets/image-cropper-web/rollup.config.mjs @@ -1,5 +1,6 @@ import copyFiles from "@mendix/rollup-web-widgets/copyFiles.mjs"; +import { withSharedLibs } from "@mendix/rollup-web-widgets/sharedLibs.mjs"; export default args => { - return copyFiles(args); + return withSharedLibs(args, copyFiles(args)); }; diff --git a/packages/pluggableWidgets/maps-web/rollup.config.mjs b/packages/pluggableWidgets/maps-web/rollup.config.mjs index d5aaff7b1e..92b6f92f3f 100644 --- a/packages/pluggableWidgets/maps-web/rollup.config.mjs +++ b/packages/pluggableWidgets/maps-web/rollup.config.mjs @@ -1,6 +1,7 @@ import { cpSync, existsSync, mkdirSync, rmSync, statSync } from "node:fs"; import { fileURLToPath } from "url"; import copyFiles from "@mendix/rollup-web-widgets/copyFiles.mjs"; +import { withSharedLibs } from "@mendix/rollup-web-widgets/sharedLibs.mjs"; import url from "@mendix/pluggable-widgets-tools/configs/rollup-plugin-assets.mjs"; // The maps widget package was wrongly named with an uppercase M in the past. We have to keep that @@ -94,5 +95,5 @@ export default args => { // Only the amd bundle extracts a stylesheet. fixCssAssetPaths(jsConfig); - return result; + return withSharedLibs(args, result); }; diff --git a/packages/pluggableWidgets/selection-helper-web/package.json b/packages/pluggableWidgets/selection-helper-web/package.json index b0e46c551e..3c72f94b9e 100644 --- a/packages/pluggableWidgets/selection-helper-web/package.json +++ b/packages/pluggableWidgets/selection-helper-web/package.json @@ -44,6 +44,7 @@ "@mendix/eslint-config-web-widgets": "workspace:*", "@mendix/pluggable-widgets-tools": "*", "@mendix/prettier-config-web-widgets": "workspace:*", + "@mendix/rollup-web-widgets": "workspace:*", "@mendix/widget-plugin-component-kit": "workspace:*", "@mendix/widget-plugin-grid": "workspace:*", "@mendix/widget-plugin-platform": "workspace:*", diff --git a/packages/pluggableWidgets/selection-helper-web/rollup.config.mjs b/packages/pluggableWidgets/selection-helper-web/rollup.config.mjs new file mode 100644 index 0000000000..03372ef256 --- /dev/null +++ b/packages/pluggableWidgets/selection-helper-web/rollup.config.mjs @@ -0,0 +1,3 @@ +import { withSharedLibs } from "@mendix/rollup-web-widgets/sharedLibs.mjs"; + +export default args => withSharedLibs(args, args.configDefaultConfig); diff --git a/packages/shared/rollup-web-widgets/package.json b/packages/shared/rollup-web-widgets/package.json index 58aeaa36dd..095f02ed98 100644 --- a/packages/shared/rollup-web-widgets/package.json +++ b/packages/shared/rollup-web-widgets/package.json @@ -9,6 +9,15 @@ "type": "git", "url": "https://github.com/mendix/web-widgets.git" }, + "dependencies": { + "@rollup/plugin-commonjs": "^29.0.3", + "@rollup/plugin-node-resolve": "^15.3.1", + "@rollup/plugin-replace": "^6.0.2", + "@rollup/plugin-terser": "^0.4.4", + "mobx": "6.12.3", + "mobx-react-lite": "4.0.7", + "rollup-plugin-license": "^3.6.0" + }, "devDependencies": { "@mendix/pluggable-widgets-tools": "*", "rollup-plugin-copy": "^3.5.0" diff --git a/packages/shared/rollup-web-widgets/sharedLibs.mjs b/packages/shared/rollup-web-widgets/sharedLibs.mjs new file mode 100644 index 0000000000..93085a384a --- /dev/null +++ b/packages/shared/rollup-web-widgets/sharedLibs.mjs @@ -0,0 +1,224 @@ +// Builds shared libraries once per version at com/mendix/shared/// and points widget bundles at them. +import { readFileSync } from "node:fs"; +import { createRequire } from "node:module"; +import { dirname, join, posix, relative, sep } from "node:path"; +import commonjs from "@rollup/plugin-commonjs"; +import { nodeResolve } from "@rollup/plugin-node-resolve"; +import replace from "@rollup/plugin-replace"; +import terser from "@rollup/plugin-terser"; +import license from "rollup-plugin-license"; +import { licenseCustomTemplate } from "@mendix/pluggable-widgets-tools/configs/helpers/rollup-helper.mjs"; + +const require = createRequire(import.meta.url); + +/** `deps`: other shared libraries this one imports. */ +const LIBRARIES = { + mobx: { deps: [] }, + "mobx-react-lite": { deps: ["mobx"] } +}; + +export const DEFAULT_SHARED_LIBS = ["mobx", "mobx-react-lite"]; + +/** Provided by the Mendix client. */ +const PLATFORM_EXTERNAL = [/^mendix($|\/)/, /^react$/, /^react\/jsx-runtime$/, /^react-dom$/, /^big.js$/]; + +/** PWT output root, zipped into the MPK. */ +const OUT_DIR = join("dist", "tmp", "widgets"); +const SHARED_DIR = join("com", "mendix", "shared"); + +/** + * @param {{ configProduction?: unknown }} args + * @param {import("rollup").RollupOptions[]} configs + * @param {string[]} [libs] + * @returns {import("rollup").RollupOptions[]} + */ +export function withSharedLibs(args, configs, libs = DEFAULT_SHARED_LIBS) { + const production = Boolean(args.configProduction); + const shared = libs.map(name => describeLibrary(name, libs)); + + const widgetEntries = configs.filter(isWidgetEntry); + if (widgetEntries.length === 0) { + throw new Error("withSharedLibs: no widget AMD/ESM entries found in the given configs."); + } + for (const config of widgetEntries) { + config.plugins = [...asArray(config.plugins), sharedLibsConsumer(shared)]; + } + + // Shared bundles first: the last config zips the MPK. + const byName = new Map(shared.map(lib => [lib.name, lib])); + return [...shared.map(lib => sharedLibBundle(lib, byName, production)), ...configs]; +} + +/** Runtime bundles only; editorPreview/editorConfig run in Studio Pro and keep bundling. */ +function isWidgetEntry(config) { + const format = config.output?.format; + return !Array.isArray(config.output) && (format === "amd" || format === "es"); +} + +function describeLibrary(name, selected) { + const library = LIBRARIES[name]; + if (!library) { + throw new Error(`withSharedLibs: unknown library "${name}", known: ${Object.keys(LIBRARIES).join(", ")}.`); + } + for (const dep of library.deps) { + if (!selected.includes(dep)) { + throw new Error(`withSharedLibs: "${name}" requires "${dep}" to be shared as well.`); + } + } + // Built from this package's (patched) copy so every widget emits identical files. + const pkgJsonPath = require.resolve(`${name}/package.json`); + const pkg = JSON.parse(readFileSync(pkgJsonPath, "utf8")); + const dir = join(SHARED_DIR, name, pkg.version); + return { + name, + version: pkg.version, + deps: library.deps, + input: join(dirname(pkgJsonPath), pkg.module ?? pkg.main), + dir, + amdFile: join(dir, "amd", `${name}.js`), + esmFile: join(dir, "esm", `${name}.mjs`) + }; +} + +/** Relative import from `fromFile` to `toFile` (both relative to OUT_DIR). */ +function importPath(fromFile, toFile) { + const rel = relative(dirname(fromFile), toFile).split(sep).join(posix.sep); + return rel.startsWith(".") ? rel : `./${rel}`; +} + +function fileFor(lib, format) { + return format === "es" ? lib.esmFile : lib.amdFile; +} + +/** Standalone AMD + ESM bundle for one library. */ +function sharedLibBundle(lib, byName, production) { + const output = format => { + const file = fileFor(lib, format); + const paths = {}; + for (const dep of lib.deps) { + paths[dep] = importPath(file, fileFor(byName.get(dep), format)); + } + return { format, file: join(OUT_DIR, file), paths }; + }; + + return { + input: lib.input, + external: [...PLATFORM_EXTERNAL, ...lib.deps], + plugins: [ + nodeResolve({ preferBuiltins: false, mainFields: ["module", "browser", "main"] }), + commonjs(), + replace({ + preventAssignment: true, + values: { "process.env.NODE_ENV": JSON.stringify(production ? "production" : "development") } + }), + production ? terser() : null, + production + ? license({ + thirdParty: { + includePrivate: true, + output: [ + { file: join(OUT_DIR, lib.dir, "dependencies.txt") }, + { file: join(OUT_DIR, lib.dir, "dependencies.json"), template: licenseCustomTemplate } + ] + } + }) + : null + ], + output: [output("es"), output("amd")] + }; +} + +/** Externalizes shared libraries; paths come from the final output file, so moved outputs (maps-web) work. */ +function sharedLibsConsumer(shared) { + const byName = new Map(shared.map(lib => [lib.name, lib])); + /** @type {Map>} */ + const importers = new Map(); + + return { + name: "mendix-shared-libs", + + options(options) { + const original = options.external; + return { + ...options, + external(id, importer, isResolved) { + if (!isResolved && byName.has(id)) { + if (importer) { + if (!importers.has(id)) { + importers.set(id, new Set()); + } + importers.get(id).add(importer); + } + return true; + } + return isExternal(original, id, importer, isResolved); + } + }; + }, + + buildEnd() { + // Widget must compile against the version it runs with. + for (const [name, files] of importers) { + const expected = byName.get(name).version; + for (const importer of files) { + const actual = installedVersion(name, importer); + if (actual && actual !== expected) { + this.error( + `"${name}" resolves to ${actual} from ${importer}, but the shared bundle is ${expected}. ` + + `Align the version with @mendix/rollup-web-widgets.` + ); + } + } + } + }, + + outputOptions(output) { + if (typeof output.paths === "function") { + throw new Error("withSharedLibs: output.paths as a function is not supported."); + } + const widgetFile = relative(OUT_DIR, output.file); + if (widgetFile.startsWith("..")) { + throw new Error(`withSharedLibs: widget output ${output.file} is outside of ${OUT_DIR}.`); + } + const paths = { ...output.paths }; + for (const lib of shared) { + paths[lib.name] = importPath(widgetFile, fileFor(lib, output.format)); + } + return { ...output, paths }; + } + }; +} + +function isExternal(external, id, importer, isResolved) { + if (typeof external === "function") { + return external(id, importer, isResolved); + } + return asArray(external).some(pattern => (pattern instanceof RegExp ? pattern.test(id) : pattern === id)); +} + +function installedVersion(name, importer) { + try { + let dir = dirname(createRequire(importer).resolve(name)); + while (dir !== dirname(dir)) { + try { + const pkg = JSON.parse(readFileSync(join(dir, "package.json"), "utf8")); + if (pkg.name === name) { + return pkg.version; + } + } catch { + // no package.json here + } + dir = dirname(dir); + } + } catch { + // not resolvable, nothing to compare + } + return undefined; +} + +function asArray(value) { + if (value == null) { + return []; + } + return Array.isArray(value) ? value : [value]; +} diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index cd1ab0e78c..c91759e858 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -1079,6 +1079,9 @@ importers: '@mendix/prettier-config-web-widgets': specifier: workspace:* version: link:../../shared/prettier-config-web-widgets + '@mendix/rollup-web-widgets': + specifier: workspace:* + version: link:../../shared/rollup-web-widgets '@mendix/run-e2e': specifier: workspace:* version: link:../../../automation/run-e2e @@ -1122,6 +1125,9 @@ importers: '@mendix/prettier-config-web-widgets': specifier: workspace:* version: link:../../shared/prettier-config-web-widgets + '@mendix/rollup-web-widgets': + specifier: workspace:* + version: link:../../shared/rollup-web-widgets '@mendix/run-e2e': specifier: workspace:* version: link:../../../automation/run-e2e @@ -1162,6 +1168,9 @@ importers: '@mendix/prettier-config-web-widgets': specifier: workspace:* version: link:../../shared/prettier-config-web-widgets + '@mendix/rollup-web-widgets': + specifier: workspace:* + version: link:../../shared/rollup-web-widgets '@mendix/run-e2e': specifier: workspace:* version: link:../../../automation/run-e2e @@ -1220,6 +1229,9 @@ importers: '@mendix/prettier-config-web-widgets': specifier: workspace:* version: link:../../shared/prettier-config-web-widgets + '@mendix/rollup-web-widgets': + specifier: workspace:* + version: link:../../shared/rollup-web-widgets '@mendix/run-e2e': specifier: workspace:* version: link:../../../automation/run-e2e @@ -1287,6 +1299,9 @@ importers: '@mendix/prettier-config-web-widgets': specifier: workspace:* version: link:../../shared/prettier-config-web-widgets + '@mendix/rollup-web-widgets': + specifier: workspace:* + version: link:../../shared/rollup-web-widgets '@mendix/run-e2e': specifier: workspace:* version: link:../../../automation/run-e2e @@ -1407,6 +1422,9 @@ importers: '@mendix/prettier-config-web-widgets': specifier: workspace:* version: link:../../shared/prettier-config-web-widgets + '@mendix/rollup-web-widgets': + specifier: workspace:* + version: link:../../shared/rollup-web-widgets '@mendix/run-e2e': specifier: workspace:* version: link:../../../automation/run-e2e @@ -1512,6 +1530,9 @@ importers: '@mendix/prettier-config-web-widgets': specifier: workspace:* version: link:../../shared/prettier-config-web-widgets + '@mendix/rollup-web-widgets': + specifier: workspace:* + version: link:../../shared/rollup-web-widgets '@mendix/widget-plugin-platform': specifier: workspace:* version: link:../../shared/widget-plugin-platform @@ -1576,6 +1597,9 @@ importers: '@mendix/prettier-config-web-widgets': specifier: workspace:* version: link:../../shared/prettier-config-web-widgets + '@mendix/rollup-web-widgets': + specifier: workspace:* + version: link:../../shared/rollup-web-widgets '@mendix/run-e2e': specifier: workspace:* version: link:../../../automation/run-e2e @@ -2403,6 +2427,9 @@ importers: '@mendix/prettier-config-web-widgets': specifier: workspace:* version: link:../../shared/prettier-config-web-widgets + '@mendix/rollup-web-widgets': + specifier: workspace:* + version: link:../../shared/rollup-web-widgets '@mendix/widget-plugin-component-kit': specifier: workspace:* version: link:../../shared/widget-plugin-component-kit @@ -2902,10 +2929,32 @@ importers: version: 2.5.22(prettier@3.9.10) packages/shared/rollup-web-widgets: + dependencies: + '@rollup/plugin-commonjs': + specifier: ^29.0.3 + version: 29.0.3(rollup@4.62.3) + '@rollup/plugin-node-resolve': + specifier: ^15.3.1 + version: 15.3.1(rollup@4.62.3) + '@rollup/plugin-replace': + specifier: ^6.0.2 + version: 6.0.3(rollup@4.62.3) + '@rollup/plugin-terser': + specifier: ^0.4.4 + version: 0.4.4(rollup@4.62.3) + mobx: + specifier: 6.12.3 + version: 6.12.3(patch_hash=39c55279e8f75c9a322eba64dd22e1a398f621c64bbfc3632e55a97f46edfeb9) + mobx-react-lite: + specifier: 4.0.7 + version: 4.0.7(patch_hash=47fd2d1b5c35554ddd4fa32fcaa928a16fda9f82dca0ff68bcdc1f7c3e5f9d1a)(mobx@6.12.3(patch_hash=39c55279e8f75c9a322eba64dd22e1a398f621c64bbfc3632e55a97f46edfeb9))(react-dom@18.3.1(react@18.3.1))(react@18.3.1) + rollup-plugin-license: + specifier: ^3.6.0 + version: 3.7.1(picomatch@4.0.5)(rollup@4.62.3) devDependencies: '@mendix/pluggable-widgets-tools': specifier: 11.13.0 - version: 11.13.0(patch_hash=1879adf9f5f058d67d2e08e79916d5adce82416899758529f812f4207c064fed)(@jest/transform@30.3.0)(@jest/types@30.4.1)(@types/babel__core@7.20.5)(@types/node@26.6.6)(canvas@3.2.3)(eslint@10.13.0(jiti@2.6.1))(jest-util@30.4.1)(prettier@3.9.10)(react-dom@18.3.1(react@18.3.1))(react@18.3.1)(tslib@2.8.1) + version: 11.13.0(patch_hash=1879adf9f5f058d67d2e08e79916d5adce82416899758529f812f4207c064fed)(@jest/transform@30.3.0)(@jest/types@30.4.1)(@types/babel__core@7.20.5)(@types/node@26.6.6)(canvas@3.2.3)(eslint@10.13.0(jiti@2.6.1))(jest-util@30.4.1)(picomatch@4.0.5)(prettier@3.9.10)(react-dom@18.3.1(react@18.3.1))(react@18.3.1)(tslib@2.8.1) rollup-plugin-copy: specifier: ^3.5.0 version: 3.5.0 From 5ee71fad7546c843c8d2e37225da0adce384cbab Mon Sep 17 00:00:00 2001 From: Roman Vyakhirev Date: Sun, 15 Nov 2026 01:56:16 +0100 Subject: [PATCH 2/2] test(rollup-web-widgets): cover withSharedLibs path rewriting and version check --- .../__tests__/sharedLibs.spec.mjs | 113 ++++++++++++++++++ .../shared/rollup-web-widgets/package.json | 3 + packages/shared/rollup-web-widgets/turbo.json | 9 ++ 3 files changed, 125 insertions(+) create mode 100644 packages/shared/rollup-web-widgets/__tests__/sharedLibs.spec.mjs create mode 100644 packages/shared/rollup-web-widgets/turbo.json diff --git a/packages/shared/rollup-web-widgets/__tests__/sharedLibs.spec.mjs b/packages/shared/rollup-web-widgets/__tests__/sharedLibs.spec.mjs new file mode 100644 index 0000000000..cc12788e43 --- /dev/null +++ b/packages/shared/rollup-web-widgets/__tests__/sharedLibs.spec.mjs @@ -0,0 +1,113 @@ +import assert from "node:assert/strict"; +import { mkdirSync, mkdtempSync, rmSync, writeFileSync } from "node:fs"; +import { tmpdir } from "node:os"; +import { join } from "node:path"; +import { after, describe, it } from "node:test"; +import { withSharedLibs } from "../sharedLibs.mjs"; + +const OUT = join("dist", "tmp", "widgets"); +const MOBX_ESM = "shared/mobx/6.12.3/esm/mobx.mjs"; +const MOBX_AMD = "shared/mobx/6.12.3/amd/mobx.js"; + +function widgetConfigs(dir = "com/mendix/widget/web/datagrid") { + return [ + { input: "src/W.tsx", output: { format: "amd", file: join(OUT, dir, "W.js") }, plugins: [] }, + { input: "src/W.tsx", output: { format: "es", file: join(OUT, dir, "W.mjs") }, plugins: [] }, + { input: "src/W.editorPreview.tsx", output: { format: "commonjs", file: join(OUT, "W.editorPreview.js") } }, + { input: "src/W.editorConfig.ts", output: { format: "commonjs", file: join(OUT, "W.editorConfig.js") } } + ]; +} + +const consumerOf = config => config.plugins.find(p => p.name === "mendix-shared-libs"); +const pathsFor = config => consumerOf(config).outputOptions(config.output).paths; + +describe("withSharedLibs", () => { + it("prepends shared bundles and only changes the runtime entries", () => { + const configs = withSharedLibs({}, widgetConfigs()); + + assert.equal(configs.length, 6); + assert.match(configs[0].output[0].file, /shared\/mobx\/6\.12\.3\/esm\/mobx\.mjs$/); + assert.match(configs[1].output[0].file, /shared\/mobx-react-lite\/4\.0\.7\/esm\/mobx-react-lite\.mjs$/); + assert.ok(consumerOf(configs[2]) && consumerOf(configs[3])); + assert.equal(configs[4].plugins, undefined); + assert.equal(configs[5].plugins, undefined); + }); + + it("points widget imports at the shared bundles", () => { + const [, , amd, esm] = withSharedLibs({}, widgetConfigs()); + + assert.equal(pathsFor(esm).mobx, `../../../${MOBX_ESM}`); + assert.equal(pathsFor(amd).mobx, `../../../${MOBX_AMD}`); + }); + + it("computes paths from the final output file (maps-web moves it)", () => { + const [, , amd, esm] = withSharedLibs({}, widgetConfigs()); + const moved = join(process.cwd(), OUT, "com/mendix/widget/custom/Maps"); + esm.output.file = join(moved, "Maps.mjs"); + amd.output.file = join(moved, "Maps.js"); + + assert.equal(pathsFor(esm).mobx, `../../../${MOBX_ESM}`); + assert.equal(pathsFor(amd)["mobx-react-lite"], "../../../shared/mobx-react-lite/4.0.7/amd/mobx-react-lite.js"); + }); + + it("points mobx-react-lite at the shared mobx", () => { + const [, mrl] = withSharedLibs({}, widgetConfigs()); + + assert.ok(mrl.external.includes("mobx")); + assert.equal(mrl.output[0].paths.mobx, "../../../mobx/6.12.3/esm/mobx.mjs"); + assert.equal(mrl.output[1].paths.mobx, "../../../mobx/6.12.3/amd/mobx.js"); + }); + + it("keeps the widget's own externals", () => { + const configs = widgetConfigs(); + configs[1].external = [/^react$/]; + const esm = withSharedLibs({}, configs)[3]; + const { external } = consumerOf(esm).options(esm); + + assert.equal(external("mobx", "/src/W.tsx", false), true); + assert.equal(external("react", "/src/W.tsx", false), true); + assert.equal(external("classnames", "/src/W.tsx", false), false); + }); + + it("rejects unknown libraries and missing shared dependencies", () => { + assert.throws(() => withSharedLibs({}, widgetConfigs(), ["lodash"]), /unknown library "lodash"/); + assert.throws(() => withSharedLibs({}, widgetConfigs(), ["mobx-react-lite"]), /requires "mobx"/); + assert.throws(() => withSharedLibs({}, widgetConfigs().slice(2)), /no widget AMD\/ESM entries/); + }); + + describe("version check", () => { + const root = mkdtempSync(join(tmpdir(), "shared-libs-")); + after(() => rmSync(root, { recursive: true, force: true })); + + function importerWithMobx(version) { + const dir = join(root, version); + mkdirSync(join(dir, "node_modules", "mobx"), { recursive: true }); + mkdirSync(join(dir, "src"), { recursive: true }); + writeFileSync( + join(dir, "node_modules", "mobx", "package.json"), + JSON.stringify({ name: "mobx", version, main: "index.js" }) + ); + writeFileSync(join(dir, "node_modules", "mobx", "index.js"), ""); + return join(dir, "src", "W.tsx"); + } + + function build(importer) { + const esm = withSharedLibs({}, widgetConfigs())[3]; + const plugin = consumerOf(esm); + plugin.options(esm).external("mobx", importer, false); + plugin.buildEnd.call({ + error: message => { + throw new Error(message); + } + }); + } + + it("fails when a widget resolves another mobx version", () => { + assert.throws(() => build(importerWithMobx("6.13.0")), /resolves to 6\.13\.0 .* shared bundle is 6\.12\.3/); + }); + + it("passes when the versions match", () => { + assert.doesNotThrow(() => build(importerWithMobx("6.12.3"))); + }); + }); +}); diff --git a/packages/shared/rollup-web-widgets/package.json b/packages/shared/rollup-web-widgets/package.json index 095f02ed98..29e2740995 100644 --- a/packages/shared/rollup-web-widgets/package.json +++ b/packages/shared/rollup-web-widgets/package.json @@ -9,6 +9,9 @@ "type": "git", "url": "https://github.com/mendix/web-widgets.git" }, + "scripts": { + "test": "node --test \"__tests__/*.spec.mjs\"" + }, "dependencies": { "@rollup/plugin-commonjs": "^29.0.3", "@rollup/plugin-node-resolve": "^15.3.1", diff --git a/packages/shared/rollup-web-widgets/turbo.json b/packages/shared/rollup-web-widgets/turbo.json new file mode 100644 index 0000000000..2d7954928d --- /dev/null +++ b/packages/shared/rollup-web-widgets/turbo.json @@ -0,0 +1,9 @@ +{ + "$schema": "https://turborepo.org/schema.json", + "extends": ["//"], + "tasks": { + "test": { + "inputs": ["*.mjs", "__tests__/**", "package.json"] + } + } +}