@openmrs/rspack-config 10.0.1-pre.5324 → 10.0.1-pre.5364

package/dist/index.js

@@ -32,6 +32,9 @@ var __importStar = (this && this.__importStar) || (function () {
         return result;
     };
 })();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.optimizationConfig = exports.watchConfig = exports.assetRuleConfig = exports.scssRuleConfig = exports.cssRuleConfig = exports.scriptRuleConfig = exports.additionalConfig = exports.overrides = void 0;
 /**
@@ -74,6 +77,9 @@ exports.optimizationConfig = exports.watchConfig = exports.assetRuleConfig = exp
  */
 const fs_1 = require("fs");
 const path_1 = require("path");
+const browserslist_1 = __importDefault(require("browserslist"));
+const node_1 = require("browserslist/node");
+const browserslist_config_openmrs_1 = __importDefault(require("browserslist-config-openmrs"));
 const clean_webpack_plugin_1 = require("clean-webpack-plugin");
 const ts_checker_rspack_plugin_1 = require("ts-checker-rspack-plugin");
 // eslint-disable-next-line no-restricted-imports
@@ -127,6 +133,79 @@ function getFrameworkVersion() {
         return '5.x';
     }
 }
+/**
+ * The browserslist queries swc compiles this module against, falling back to OpenMRS's shared config
+ * when the module declares none, so that frontend RFC 0003 stays the single source of truth. Given no
+ * target at all swc down-levels to ES5, and every supported browser pays for transform helpers it
+ * doesn't need.
+ *
+ * `@openmrs/webpack-config` has a copy of this; keep them in step. `browser-targets.test.ts` compares
+ * what the two hand their loaders and fails if they drift.
+ *
+ * @param root The directory of the module being built
+ */
+function browserslistQueries(root) {
+    var _a, _b;
+    const warnings = [];
+    // deliberately unguarded
+    const loaded = browserslist_1.default.loadConfig({ path: root });
+    const configured = loaded === undefined ? [] : Array.isArray(loaded) ? loaded : [loaded];
+    if (loaded !== undefined && configured.length === 0) {
+        // warn when a browserlist config is empty
+        warnings.push(`This module declares a browserslist config, but it resolves to no queries for the ` +
+            `${(_b = (_a = process.env.BROWSERSLIST_ENV) !== null && _a !== void 0 ? _a : process.env.NODE_ENV) !== null && _b !== void 0 ? _b : production} environment. ` +
+            `Targeting ${browserslist_config_openmrs_1.default.join(', ')} instead.`);
+    }
+    const expanded = expandBrowserslistExtends(configured.length > 0 ? configured : browserslist_config_openmrs_1.default, root, warnings);
+    return { queries: expanded.length > 0 ? expanded : browserslist_config_openmrs_1.default, warnings };
+}
+function expandBrowserslistExtends(queries, root, warnings, seen = new Set()) {
+    // Split on commas because a browserslist config may be a single string of them
+    return queries.flatMap((query) => query
+        .split(',')
+        .flatMap((part) => {
+        const extended = /^extends\s+(.+)$/i.exec(part.trim());
+        if (!extended) {
+            return [part.trim()];
+        }
+        const name = extended[1].trim();
+        if (seen.has(name)) {
+            return [];
+        }
+        seen.add(name);
+        try {
+            // browserslist's own loader, rather than a bare `require` so we handle the same syntax
+            const resolved = (0, node_1.loadQueries)({ path: root }, name);
+            return expandBrowserslistExtends(Array.isArray(resolved) ? resolved : [resolved], root, warnings, seen);
+        }
+        catch (err) {
+            // Only browserslist's own verdict on a named config is survivable: not installed, or refused
+            // for its name.
+            const notInstalled = (err === null || err === void 0 ? void 0 : err.code) === 'MODULE_NOT_FOUND';
+            const refused = (err === null || err === void 0 ? void 0 : err.browserslist) === true;
+            if (!notInstalled && !refused) {
+                throw err;
+            }
+            warnings.push(`Could not load the browserslist config "${name}" (${err.message}). ` +
+                `Targeting ${browserslist_config_openmrs_1.default.join(', ')} instead.`);
+            return browserslist_config_openmrs_1.default;
+        }
+    })
+        .filter((part) => part.length > 0));
+}
+/** Reports how a module's browsers were worked out, where a developer will actually see it. */
+class BrowserslistWarningsPlugin {
+    constructor(messages) {
+        this.messages = messages;
+    }
+    apply(compiler) {
+        compiler.hooks.thisCompilation.tap('OpenmrsBrowserslistWarnings', (compilation) => {
+            for (const message of this.messages) {
+                compilation.warnings.push(new core_1.default.WebpackError(message));
+            }
+        });
+    }
+}
 function makeIdent(name) {
     if (name.includes('/')) {
         name = name.slice(name.indexOf('/'));
@@ -207,6 +286,7 @@ exports.default = (env, argv = {}) => {
     const outDir = (0, path_1.dirname)(browser || main);
     const srcFile = (0, path_1.resolve)(root, browser ? main : types);
     const ident = makeIdent(name);
+    const { queries: browserTargets, warnings: browserslistWarnings } = browserslistQueries(root);
     const frameworkVersion = getFrameworkVersion();
     const routes = (0, path_1.resolve)(root, 'src', 'routes.json');
     const hasRoutesDefined = fileExistsSync(routes);
@@ -240,6 +320,9 @@ exports.default = (env, argv = {}) => {
                     exclude: /node_modules/,
                     loader: 'builtin:swc-loader',
                     options: {
+                        env: {
+                            targets: browserTargets,
+                        },
                         jsc: {
                             parser: {
                                 syntax: 'typescript',
@@ -276,7 +359,9 @@ exports.default = (env, argv = {}) => {
                     type: 'asset/source',
                 },
             ],
-        }, mode, devtool: mode === production ? 'hidden-nosources-source-map' : 'source-map', devServer: {
+        }, mode, 
+        // governs rspack's own runtime and chunk-loading glue
+        target: ['web', `browserslist:${browserTargets.join(', ')}`], devtool: mode === production ? 'hidden-nosources-source-map' : 'source-map', devServer: {
             headers: {
                 'Access-Control-Allow-Origin': '*',
             },
@@ -294,6 +379,7 @@ exports.default = (env, argv = {}) => {
             },
             minimizer: [new core_1.default.SwcJsMinimizerRspackPlugin(), new core_1.default.LightningCssMinimizerRspackPlugin()],
         }, exports.optimizationConfig), plugins: [
+            browserslistWarnings.length > 0 && new BrowserslistWarningsPlugin(browserslistWarnings),
             new ts_checker_rspack_plugin_1.TsCheckerRspackPlugin(),
             new clean_webpack_plugin_1.CleanWebpackPlugin(),
             new webpack_bundle_analyzer_1.BundleAnalyzerPlugin({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/rspack-config",
-  "version": "10.0.1-pre.5324",
+  "version": "10.0.1-pre.5364",
   "license": "MPL-2.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -35,6 +35,8 @@
     "@rspack/cli": "1.7.9",
     "@rspack/core": "1.7.9",
     "@swc/core": "1.15.21",
+    "browserslist": "4.28.9",
+    "browserslist-config-openmrs": "^1.0.1",
     "clean-webpack-plugin": "4.0.0",
     "copy-webpack-plugin": "11.0.0",
     "css-loader": "5.2.7",

package/src/index.ts

@@ -38,6 +38,9 @@
  */
 import { existsSync, statSync } from 'fs';
 import { basename, dirname, resolve } from 'path';
+import browserslist from 'browserslist';
+import { loadQueries } from 'browserslist/node';
+import defaultBrowserslistQueries from 'browserslist-config-openmrs';
 import { CleanWebpackPlugin } from 'clean-webpack-plugin';
 import { TsCheckerRspackPlugin } from 'ts-checker-rspack-plugin';
 // eslint-disable-next-line no-restricted-imports
@@ -45,6 +48,7 @@ import { isArray, merge, mergeWith } from 'lodash';
 import { inc, parse } from 'semver';
 import { ModuleFederationPlugin } from '@module-federation/enhanced/rspack';
 import rspack, {
+  type Compiler,
   CopyRspackPlugin,
   DefinePlugin,
   type ModuleOptions,
@@ -108,6 +112,109 @@ function getFrameworkVersion() {
   }
 }
 
+/** What a module's browsers resolved to, plus anything worth telling the developer about getting there. */
+type BrowserPolicy = { queries: Array<string>; warnings: Array<string> };
+
+/**
+ * The browserslist queries swc compiles this module against, falling back to OpenMRS's shared config
+ * when the module declares none, so that frontend RFC 0003 stays the single source of truth. Given no
+ * target at all swc down-levels to ES5, and every supported browser pays for transform helpers it
+ * doesn't need.
+ *
+ * `@openmrs/webpack-config` has a copy of this; keep them in step. `browser-targets.test.ts` compares
+ * what the two hand their loaders and fails if they drift.
+ *
+ * @param root The directory of the module being built
+ */
+function browserslistQueries(root: string): BrowserPolicy {
+  const warnings: Array<string> = [];
+  // deliberately unguarded
+  const loaded = browserslist.loadConfig({ path: root });
+  const configured = loaded === undefined ? [] : Array.isArray(loaded) ? loaded : [loaded];
+
+  if (loaded !== undefined && configured.length === 0) {
+    // warn when a browserlist config is empty
+    warnings.push(
+      `This module declares a browserslist config, but it resolves to no queries for the ` +
+        `${process.env.BROWSERSLIST_ENV ?? process.env.NODE_ENV ?? production} environment. ` +
+        `Targeting ${defaultBrowserslistQueries.join(', ')} instead.`,
+    );
+  }
+
+  const expanded = expandBrowserslistExtends(
+    configured.length > 0 ? configured : defaultBrowserslistQueries,
+    root,
+    warnings,
+  );
+
+  return { queries: expanded.length > 0 ? expanded : defaultBrowserslistQueries, warnings };
+}
+
+function expandBrowserslistExtends(
+  queries: Array<string>,
+  root: string,
+  warnings: Array<string>,
+  seen = new Set<string>(),
+): Array<string> {
+  // Split on commas because a browserslist config may be a single string of them
+  return queries.flatMap((query) =>
+    query
+      .split(',')
+      .flatMap((part) => {
+        const extended = /^extends\s+(.+)$/i.exec(part.trim());
+
+        if (!extended) {
+          return [part.trim()];
+        }
+
+        const name = extended[1].trim();
+
+        if (seen.has(name)) {
+          return [];
+        }
+
+        seen.add(name);
+
+        try {
+          // browserslist's own loader, rather than a bare `require` so we handle the same syntax
+          const resolved = loadQueries({ path: root }, name);
+
+          return expandBrowserslistExtends(Array.isArray(resolved) ? resolved : [resolved], root, warnings, seen);
+        } catch (err) {
+          // Only browserslist's own verdict on a named config is survivable: not installed, or refused
+          // for its name.
+          const notInstalled = (err as { code?: string })?.code === 'MODULE_NOT_FOUND';
+          const refused = (err as { browserslist?: boolean })?.browserslist === true;
+
+          if (!notInstalled && !refused) {
+            throw err;
+          }
+
+          warnings.push(
+            `Could not load the browserslist config "${name}" (${(err as Error).message}). ` +
+              `Targeting ${defaultBrowserslistQueries.join(', ')} instead.`,
+          );
+
+          return defaultBrowserslistQueries;
+        }
+      })
+      .filter((part) => part.length > 0),
+  );
+}
+
+/** Reports how a module's browsers were worked out, where a developer will actually see it. */
+class BrowserslistWarningsPlugin {
+  constructor(private readonly messages: Array<string>) {}
+
+  apply(compiler: Compiler) {
+    compiler.hooks.thisCompilation.tap('OpenmrsBrowserslistWarnings', (compilation) => {
+      for (const message of this.messages) {
+        compilation.warnings.push(new rspack.WebpackError(message));
+      }
+    });
+  }
+}
+
 function makeIdent(name: string): string {
   if (name.includes('/')) {
     name = name.slice(name.indexOf('/'));
@@ -200,6 +307,7 @@ export default (env: Record<string, string>, argv: Record<string, string> = {})
   const outDir = dirname(browser || main);
   const srcFile = resolve(root, browser ? main : types);
   const ident = makeIdent(name);
+  const { queries: browserTargets, warnings: browserslistWarnings } = browserslistQueries(root);
   const frameworkVersion = getFrameworkVersion();
   const routes = resolve(root, 'src', 'routes.json');
   const hasRoutesDefined = fileExistsSync(routes);
@@ -240,6 +348,9 @@ export default (env: Record<string, string>, argv: Record<string, string> = {})
             exclude: /node_modules/,
             loader: 'builtin:swc-loader',
             options: {
+              env: {
+                targets: browserTargets,
+              },
               jsc: {
                 parser: {
                   syntax: 'typescript',
@@ -289,6 +400,8 @@ export default (env: Record<string, string>, argv: Record<string, string> = {})
       ],
     },
     mode,
+    // governs rspack's own runtime and chunk-loading glue
+    target: ['web', `browserslist:${browserTargets.join(', ')}`],
     devtool: mode === production ? 'hidden-nosources-source-map' : 'source-map',
     devServer: {
       headers: {
@@ -318,6 +431,7 @@ export default (env: Record<string, string>, argv: Record<string, string> = {})
       optimizationConfig,
     ),
     plugins: [
+      browserslistWarnings.length > 0 && new BrowserslistWarningsPlugin(browserslistWarnings),
       new TsCheckerRspackPlugin(),
       new CleanWebpackPlugin(),
       new BundleAnalyzerPlugin({