@openmrs/webpack-config 10.0.1-pre.5199 → 10.0.1-pre.5227

package/dist/index.js

@@ -50,11 +50,44 @@ const fork_ts_checker_webpack_plugin_1 = __importDefault(require("fork-ts-checke
 // eslint-disable-next-line no-restricted-imports
 const lodash_1 = require("lodash");
 const semver_1 = require("semver");
-const webpack_1 = require("webpack");
+const webpack_1 = require("@module-federation/enhanced/webpack");
+const webpack_2 = require("webpack");
 const webpack_bundle_analyzer_1 = require("webpack-bundle-analyzer");
 const webpack_stats_plugin_1 = require("webpack-stats-plugin");
 const production = 'production';
-const { ModuleFederationPlugin } = webpack_1.container;
+// Read from our own pin rather than `@module-federation/enhanced/package.json`, which its `exports` map
+// makes unreadable. `parse` rather than `coerce`, so that loosening the pin to a range disables the skew
+// warning instead of misreporting it: `coerce` turns `2.x` and `^2` into 2.0, which would warn forever.
+// eslint-disable-next-line @typescript-eslint/no-require-imports
+const moduleFederationPin = require('../package.json').dependencies['@module-federation/enhanced'];
+const moduleFederationVersion = (0, semver_1.parse)(moduleFederationPin);
+/**
+ * Prepended to this app's entry chunks. Without it, an app running under an app shell too old to
+ * publish the runtime globals fails with a `TypeError` from inside minified runtime code. All three
+ * globals are checked because `_OPENMRS_FEDERATION_ERROR_CODES` is what describes the failure, and a runtime
+ * minor differing from the app shell's warns. `@openmrs/rspack-config` has a copy of this; keep them in step.
+ */
+function buildFederationRuntimeGuard(appName, expectedMinor) {
+    const missingRuntime = "(function(){var g=typeof globalThis!=='undefined'?globalThis:self;" +
+        "if(typeof g._FEDERATION_RUNTIME_CORE==='undefined'||typeof g._OPENMRS_FEDERATION_SDK==='undefined'||typeof g._OPENMRS_FEDERATION_ERROR_CODES==='undefined'){" +
+        'throw new Error(' +
+        JSON.stringify(appName) +
+        " + ' cannot start: the OpenMRS app shell serving this page does not provide the Module Federation runtime. " +
+        'This app was built with newer OpenMRS tooling than the app shell, so either upgrade @openmrs/esm-app-shell, ' +
+        "or rebuild this app with tooling matching the app shell.');}";
+    // Skipped rather than always warning if the pin couldn't be coerced to a version.
+    const skew = expectedMinor
+        ? 'var from=g._FEDERATION_RUNTIME_CORE_FROM;' +
+            'if(from&&from.version&&String(from.version).split(".").slice(0,2).join(".")!==' +
+            JSON.stringify(expectedMinor) +
+            '){console.warn(' +
+            JSON.stringify(appName) +
+            " + ' was built against Module Federation " +
+            expectedMinor +
+            ".x but the app shell provides ' + from.version + '. Shared dependencies may not de-duplicate correctly.');}"
+        : '';
+    return missingRuntime + skew + '})();';
+}
 function getFrameworkVersion() {
     try {
         // eslint-disable-next-line @typescript-eslint/no-require-imports
@@ -238,15 +271,23 @@ exports.default = (env, argv = {}) => {
             new webpack_bundle_analyzer_1.BundleAnalyzerPlugin({
                 analyzerMode: env && env.analyze ? 'server' : 'disabled',
             }),
-            new webpack_1.DefinePlugin({
+            new webpack_2.DefinePlugin({
                 'process.env.FRAMEWORK_VERSION': JSON.stringify(frameworkVersion),
             }),
-            new ModuleFederationPlugin({
+            new webpack_1.ModuleFederationPlugin({
                 // Look in the `esm-dynamic-loading` framework package for an explanation of how modules
                 // get loaded into the application.
                 name,
                 library: { type: 'var', name: slugify(name) },
                 filename,
+                // Building on `@module-federation/enhanced` gives webpack remotes the MF 2.0 runtime, which they
+                // read from the globals the app shell publishes rather than embedding. See `@openmrs/rspack-config`.
+                experiments: {
+                    externalRuntime: true,
+                },
+                // Nothing consumes an mf-manifest or federated types here, so skip both plugins.
+                manifest: false,
+                dts: false,
                 exposes: {
                     './start': srcFile,
                 },
@@ -292,6 +333,19 @@ exports.default = (env, argv = {}) => {
                         },
                     ],
                 }),
+            // The two runtime packages a remote can safely borrow from the app shell; see the
+            // `ExternalsPlugin` block in `@openmrs/rspack-config` for why only these two are shareable,
+            // what still ships per remote, and why this is a plugin rather than an `externals` entry.
+            new webpack_2.ExternalsPlugin('global', {
+                '@module-federation/sdk': '_OPENMRS_FEDERATION_SDK',
+                '@module-federation/error-codes': '_OPENMRS_FEDERATION_ERROR_CODES',
+            }),
+            new webpack_2.BannerPlugin({
+                raw: true,
+                entryOnly: true,
+                test: /\.[cm]?js$/,
+                banner: buildFederationRuntimeGuard(name, moduleFederationVersion ? `${moduleFederationVersion.major}.${moduleFederationVersion.minor}` : undefined),
+            }),
             new webpack_stats_plugin_1.StatsWriterPlugin({
                 filename: `${filename}.buildmanifest.json`,
                 stats: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/webpack-config",
-  "version": "10.0.1-pre.5199",
+  "version": "10.0.1-pre.5227",
   "license": "MPL-2.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -30,6 +30,7 @@
   ],
   "homepage": "https://github.com/openmrs/openmrs-esm-core#readme",
   "dependencies": {
+    "@module-federation/enhanced": "2.8.1",
     "@swc/core": "1.15.21",
     "clean-webpack-plugin": "4.0.0",
     "copy-webpack-plugin": "11.0.0",
@@ -38,6 +39,7 @@
     "lodash": "4.17.21",
     "sass-embedded": "1.89.2",
     "sass-loader": "16.0.5",
+    "semver": "^7.7.3",
     "style-loader": "3.3.4",
     "swc-loader": "0.2.7",
     "webpack": "5.105.3",
@@ -47,6 +49,7 @@
   },
   "devDependencies": {
     "@types/lodash-es": "4.17.12",
+    "@types/semver": "^7.7.3",
     "typescript": "^5.8.3"
   },
   "stableVersion": "10.0.0"

package/src/index.ts

@@ -43,10 +43,12 @@ import CopyWebpackPlugin from 'copy-webpack-plugin';
 import ForkTsCheckerWebpackPlugin from 'fork-ts-checker-webpack-plugin';
 // eslint-disable-next-line no-restricted-imports
 import { isArray, merge, mergeWith } from 'lodash';
-import { inc } from 'semver';
+import { inc, parse } from 'semver';
+import { ModuleFederationPlugin } from '@module-federation/enhanced/webpack';
 import {
-  container,
+  BannerPlugin,
   DefinePlugin,
+  ExternalsPlugin,
   type ModuleOptions,
   type RuleSetRule,
   type WebpackOptionsNormalized as WebpackConfiguration,
@@ -60,7 +62,44 @@ type OpenmrsWebpackConfig = Omit<Partial<WebpackConfiguration>, 'module' | 'outp
 };
 
 const production = 'production';
-const { ModuleFederationPlugin } = container;
+
+// Read from our own pin rather than `@module-federation/enhanced/package.json`, which its `exports` map
+// makes unreadable. `parse` rather than `coerce`, so that loosening the pin to a range disables the skew
+// warning instead of misreporting it: `coerce` turns `2.x` and `^2` into 2.0, which would warn forever.
+// eslint-disable-next-line @typescript-eslint/no-require-imports
+const moduleFederationPin: string = require('../package.json').dependencies['@module-federation/enhanced'];
+const moduleFederationVersion = parse(moduleFederationPin);
+
+/**
+ * Prepended to this app's entry chunks. Without it, an app running under an app shell too old to
+ * publish the runtime globals fails with a `TypeError` from inside minified runtime code. All three
+ * globals are checked because `_OPENMRS_FEDERATION_ERROR_CODES` is what describes the failure, and a runtime
+ * minor differing from the app shell's warns. `@openmrs/rspack-config` has a copy of this; keep them in step.
+ */
+function buildFederationRuntimeGuard(appName: string, expectedMinor: string | undefined) {
+  const missingRuntime =
+    "(function(){var g=typeof globalThis!=='undefined'?globalThis:self;" +
+    "if(typeof g._FEDERATION_RUNTIME_CORE==='undefined'||typeof g._OPENMRS_FEDERATION_SDK==='undefined'||typeof g._OPENMRS_FEDERATION_ERROR_CODES==='undefined'){" +
+    'throw new Error(' +
+    JSON.stringify(appName) +
+    " + ' cannot start: the OpenMRS app shell serving this page does not provide the Module Federation runtime. " +
+    'This app was built with newer OpenMRS tooling than the app shell, so either upgrade @openmrs/esm-app-shell, ' +
+    "or rebuild this app with tooling matching the app shell.');}";
+
+  // Skipped rather than always warning if the pin couldn't be coerced to a version.
+  const skew = expectedMinor
+    ? 'var from=g._FEDERATION_RUNTIME_CORE_FROM;' +
+      'if(from&&from.version&&String(from.version).split(".").slice(0,2).join(".")!==' +
+      JSON.stringify(expectedMinor) +
+      '){console.warn(' +
+      JSON.stringify(appName) +
+      " + ' was built against Module Federation " +
+      expectedMinor +
+      ".x but the app shell provides ' + from.version + '. Shared dependencies may not de-duplicate correctly.');}"
+    : '';
+
+  return missingRuntime + skew + '})();';
+}
 
 function getFrameworkVersion() {
   try {
@@ -297,6 +336,14 @@ export default (env: Record<string, string>, argv: Record<string, string> = {})
         name,
         library: { type: 'var', name: slugify(name) },
         filename,
+        // Building on `@module-federation/enhanced` gives webpack remotes the MF 2.0 runtime, which they
+        // read from the globals the app shell publishes rather than embedding. See `@openmrs/rspack-config`.
+        experiments: {
+          externalRuntime: true,
+        },
+        // Nothing consumes an mf-manifest or federated types here, so skip both plugins.
+        manifest: false,
+        dts: false,
         exposes: {
           './start': srcFile,
         },
@@ -344,6 +391,22 @@ export default (env: Record<string, string>, argv: Record<string, string> = {})
             },
           ],
         }),
+      // The two runtime packages a remote can safely borrow from the app shell; see the
+      // `ExternalsPlugin` block in `@openmrs/rspack-config` for why only these two are shareable,
+      // what still ships per remote, and why this is a plugin rather than an `externals` entry.
+      new ExternalsPlugin('global', {
+        '@module-federation/sdk': '_OPENMRS_FEDERATION_SDK',
+        '@module-federation/error-codes': '_OPENMRS_FEDERATION_ERROR_CODES',
+      }),
+      new BannerPlugin({
+        raw: true,
+        entryOnly: true,
+        test: /\.[cm]?js$/,
+        banner: buildFederationRuntimeGuard(
+          name,
+          moduleFederationVersion ? `${moduleFederationVersion.major}.${moduleFederationVersion.minor}` : undefined,
+        ),
+      }),
       new StatsWriterPlugin({
         filename: `${filename}.buildmanifest.json`,
         stats: {