feat: parser options for preserving require and import (#7939)

crates/node_binding/binding.d.ts

@@ -1429,6 +1429,26 @@ export interface RawJavascriptParserOptions {
  worker?: Array<string>
  overrideStrict?: string
  importMeta?: boolean
+ /**
+ * This option is experimental in Rspack only and subject to change or be removed anytime.
+ * @experimental
+ */
+ requireAsExpression?: boolean
+ /**
+ * This option is experimental in Rspack only and subject to change or be removed anytime.
+ * @experimental
+ */
+ requireDynamic?: boolean
+ /**
+ * This option is experimental in Rspack only and subject to change or be removed anytime.
+ * @experimental
+ */
+ requireResolve?: boolean
+ /**
+ * This option is experimental in Rspack only and subject to change or be removed anytime.
+ * @experimental
+ */
+ importDynamic?: boolean
 }
 
 export interface RawLazyCompilationOption {

crates/rspack_binding_options/src/options/raw_module/mod.rs

@@ -272,6 +272,18 @@ pub struct RawJavascriptParserOptions {
  pub worker: Option<Vec<String>>,
  pub override_strict: Option<String>,
  pub import_meta: Option<bool>,
+ /// This option is experimental in Rspack only and subject to change or be removed anytime.
+ /// @experimental
+ pub require_as_expression: Option<bool>,
+ /// This option is experimental in Rspack only and subject to change or be removed anytime.
+ /// @experimental
+ pub require_dynamic: Option<bool>,
+ /// This option is experimental in Rspack only and subject to change or be removed anytime.
+ /// @experimental
+ pub require_resolve: Option<bool>,
+ /// This option is experimental in Rspack only and subject to change or be removed anytime.
+ /// @experimental
+ pub import_dynamic: Option<bool>,
 }
 
 impl From<RawJavascriptParserOptions> for JavascriptParserOptions {
@@ -307,6 +319,10 @@ impl From<RawJavascriptParserOptions> for JavascriptParserOptions {
  .override_strict
  .map(|e| OverrideStrict::from(e.as_str())),
  import_meta: value.import_meta,
+ require_as_expression: value.require_as_expression,
+ require_dynamic: value.require_dynamic,
+ require_resolve: value.require_resolve,
+ import_dynamic: value.import_dynamic,
  }
  }
 }

crates/rspack_core/src/external_module.rs

@@ -128,7 +128,6 @@ fn resolve_external_type<'a>(
  external_type: &'a str,
  dependency_meta: &'a DependencyMeta,
 ) -> &'a str {
- // let external_type = self.external_type.as_str();
  match external_type {
  "module-import" => {
  if let Some(external_type) = dependency_meta.external_type.as_ref() {

crates/rspack_core/src/options/module.rs

@@ -235,6 +235,10 @@ pub struct JavascriptParserOptions {
  pub worker: Option<Vec<String>>,
  pub override_strict: Option<OverrideStrict>,
  pub import_meta: Option<bool>,
+ pub require_as_expression: Option<bool>,
+ pub require_dynamic: Option<bool>,
+ pub require_resolve: Option<bool>,
+ pub import_dynamic: Option<bool>,
 }
 
 #[derive(Debug, Clone, MergeFrom)]

crates/rspack_plugin_javascript/src/parser_plugin/common_js_imports_parse_plugin.rs

@@ -91,6 +91,10 @@ pub struct CommonJsImportsParserPlugin;
 
 impl CommonJsImportsParserPlugin {
  fn process_resolve(&self, parser: &mut JavascriptParser, call_expr: &CallExpr, weak: bool) {
+ if matches!(parser.javascript_options.require_resolve, Some(false)) {
+ return;
+ }
+
  if call_expr.args.len() != 1 {
  return;
  }
@@ -268,6 +272,10 @@ impl CommonJsImportsParserPlugin {
  }
  }
 
+ if matches!(parser.javascript_options.require_dynamic, Some(false)) && !param.is_string() {
+ return None;
+ }
+
  // FIXME: should support `LocalModuleDependency`
  if self
  .process_require_item(parser, call_expr.span, &param)
@@ -290,6 +298,10 @@ impl CommonJsImportsParserPlugin {
  parser: &mut JavascriptParser,
  ident: &Ident,
  ) -> Option<bool> {
+ if parser.javascript_options.require_as_expression == Some(false) {
+ return None;
+ }
+
  let start = ident.span().real_lo();
  let end = ident.span().real_hi();
  let mut dep = CommonJsRequireContextDependency::new(

crates/rspack_plugin_javascript/src/parser_plugin/import_parser_plugin.rs

@@ -146,6 +146,10 @@ impl JavascriptParserPlugin for ImportParserPlugin {
  parser.blocks.push(Box::new(block));
  Some(true)
  } else {
+ if matches!(parser.javascript_options.import_dynamic, Some(false)) {
+ return None;
+ }
+
  let ContextModuleScanResult {
  context,
  reg,

packages/rspack-test-tools/tests/__snapshots__/Defaults.test.js.snap

@@ -170,7 +170,11 @@ Object {
  "dynamicImportPrefetch": false,
  "dynamicImportPreload": false,
  "exprContextCritical": true,
+ "importDynamic": true,
  "importMeta": true,
+ "requireAsExpression": true,
+ "requireDynamic": true,
+ "requireResolve": true,
  "strictExportPresence": false,
  "url": true,
  "worker": Array [

packages/rspack-test-tools/tests/configCases/parsing/import-dynamic/index.js

@@ -0,0 +1,8 @@
+const dir = process.env.name
+
+import('./other.js')
+
+import('./' + dir + '/other.js')
+import(dir)
+
+

packages/rspack-test-tools/tests/configCases/parsing/import-dynamic/other.js

@@ -0,0 +1 @@
+module.exports = 'other';

packages/rspack-test-tools/tests/configCases/parsing/import-dynamic/rspack.config.js

@@ -0,0 +1,22 @@
+// TODO: move to webpack-test after merged into webpack
+
+/** @type {import("../../../../types").Configuration} */
+module.exports = {
+ entry: {
+ bundle0: "./index.js",
+ test: "./test.js"
+ },
+ module: {
+ parser: {
+ javascript: {
+ importDynamic: false
+ }
+ }
+ },
+ output: {
+ filename: "[name].js"
+ },
+ node: {
+ __dirname: false
+ }
+};

packages/rspack-test-tools/tests/configCases/parsing/import-dynamic/test.config.js

@@ -0,0 +1,6 @@
+module.exports = {
+ findBundle: function (i, options) {
+ return ["test.js"];
+ }
+};
+

packages/rspack-test-tools/tests/configCases/parsing/import-dynamic/test.js

@@ -0,0 +1,9 @@
+const fs = require("fs");
+const path = require("path");
+
+it("import() a dynamical expression should preserve as-is when `importDynamic` is disabled", () => {
+ const code = fs.readFileSync(path.join(__dirname, "./bundle0.js"), 'utf-8');
+ expect(code).not.toContain("import('./other.js')");
+ expect(code).toContain("import('./' + dir + '/other.js')");
+ expect(code).toContain("import(dir)");
+});

packages/rspack-test-tools/tests/configCases/parsing/require-as-expression/index.js

@@ -0,0 +1,9 @@
+require('./other.js')
+
+const resolve1 = require.resolve
+resolve1('./other.js')
+
+const lazyFn = (module, requireFn) => {}
+lazyFn('./other.js', require)
+
+

packages/rspack-test-tools/tests/configCases/parsing/require-as-expression/other.js

@@ -0,0 +1 @@
+module.exports = 'other';

packages/rspack-test-tools/tests/configCases/parsing/require-as-expression/rspack.config.js

@@ -0,0 +1,20 @@
+/** @type {import("../../../../types").Configuration} */
+module.exports = {
+ entry: {
+ bundle0: "./index.js",
+ test: "./test.js"
+ },
+ module: {
+ parser: {
+ javascript: {
+ requireAsExpression: false
+ }
+ }
+ },
+ output: {
+ filename: "[name].js"
+ },
+ node: {
+ __dirname: false
+ }
+};

packages/rspack-test-tools/tests/configCases/parsing/require-as-expression/test.config.js

@@ -0,0 +1,7 @@
+// TODO: move to webpack-test after merged into webpack
+
+module.exports = {
+ findBundle: function (i, options) {
+ return ["test.js"];
+ }
+};

packages/rspack-test-tools/tests/configCases/parsing/require-as-expression/test.js

@@ -0,0 +1,9 @@
+const fs = require("fs");
+const path = require("path");
+
+it("use require as a expression should preserve as-is when `requireAsExpression` is disabled", () => {
+ const code = fs.readFileSync(path.join(__dirname, "./bundle0.js"), 'utf-8');
+ expect(code).not.toContain("require('./other.js')");
+ expect(code).toContain("resolve1('./other.js')");
+ expect(code).toContain(`lazyFn('./other.js', require)`);
+});

packages/rspack-test-tools/tests/configCases/parsing/require-dynamic/index.js

@@ -0,0 +1,11 @@
+const dir = process.env.name
+
+const require1 = require(dir)
+
+const require2 = require('./other.js')
+
+const require3 = require('./foo/' + dir + '.js')
+
+const require4 = require(a + './foo/' + dir + '.js')
+
+const require5 = require(dir ? './foo/' + dir + '.js' : './foo/nested' + dir + 'js')

packages/rspack-test-tools/tests/configCases/parsing/require-dynamic/other.js

@@ -0,0 +1 @@
+module.exports = 'other';

packages/rspack-test-tools/tests/configCases/parsing/require-dynamic/rspack.config.js

@@ -0,0 +1,24 @@
+// TODO: move to webpack-test after merged into webpack
+
+/** @type {import("../../../../types").Configuration} */
+module.exports = {
+ entry: {
+ bundle0: "./index.js",
+ test: "./test.js"
+ },
+ module: {
+ parser: {
+ javascript: {
+ requireDynamic: false,
+ // To preserve `require(...)`, we need to use `requireAsExpression: false` alongside.
+ requireAsExpression: false
+ }
+ }
+ },
+ output: {
+ filename: "[name].js"
+ },
+ node: {
+ __dirname: false
+ }
+};

packages/rspack-test-tools/tests/configCases/parsing/require-dynamic/test.config.js

@@ -0,0 +1,5 @@
+module.exports = {
+ findBundle: function (i, options) {
+ return ["test.js"];
+ }
+};

packages/rspack-test-tools/tests/configCases/parsing/require-dynamic/test.js

@@ -0,0 +1,11 @@
+const fs = require("fs");
+const path = require("path");
+
+it("require a dynamical expression should preserve as-is when `requireDynamic` is disabled", () => {
+ const code = fs.readFileSync(path.join(__dirname, "./bundle0.js"), 'utf-8');
+ expect(code).toContain("require(dir)");
+ expect(code).not.toContain("require('./other.js')");
+ expect(code).toContain("require('./foo/' + dir + '.js')");
+ expect(code).toContain("require(a + './foo/' + dir + '.js')");
+ expect(code).toContain("require(dir ? './foo/' + dir + '.js' : './foo/nested' + dir + 'js')");
+});

packages/rspack-test-tools/tests/configCases/parsing/require-resolve/index.js

@@ -0,0 +1,19 @@
+const dir = process.env.DIR_READ_FROM_RUNTIME
+
+const resolve1 = require.resolve(dir)
+
+const resolve2 = require.resolve('./other.js')
+
+const resolve3 = require.resolve('./foo/' + dir + '.js')
+
+const resolve4 = require.resolve(process.env.RANDOM ? './foo/' + dir + '.js' : './bar/' + dir + 'js')
+
+
+// Can't handle, `require` will turn into expression
+// const resolve5 = require.resolve
+// resolve5('./other.js')
+
+// Can't handle, `require` will turn into `undefined`
+// const __require = require
+// const resolve6 = __require.resolve('./other.js')
+

packages/rspack-test-tools/tests/configCases/parsing/require-resolve/rspack.config.js

@@ -0,0 +1,25 @@
+// TODO: move to webpack-test after merged into webpack
+
+/** @type {import("../../../../types").Configuration} */
+module.exports = {
+ entry: {
+ bundle0: "./index.js",
+ test: "./test.js"
+ },
+ module: {
+ parser: {
+ javascript: {
+ requireResolve: false,
+ // To preserve `require.resolve`, we need to use `requireResolve: false` to preserve
+ // the `resolve` method and `requireAsExpression: false` to preserve `require`.
+ requireAsExpression: false
+ }
+ }
+ },
+ output: {
+ filename: "[name].js"
+ },
+ node: {
+ __dirname: false
+ }
+};

packages/rspack-test-tools/tests/configCases/parsing/require-resolve/test.config.js

@@ -0,0 +1,5 @@
+module.exports = {
+ findBundle: function (i, options) {
+ return ["test.js"];
+ }
+};

packages/rspack-test-tools/tests/configCases/parsing/require-resolve/test.js

@@ -0,0 +1,10 @@
+const fs = require("fs");
+const path = require("path");
+
+it("`require.resolve` should preserve as-is when `requireResolve` is disabled", () => {
+ const code = fs.readFileSync(path.join(__dirname, "./bundle0.js"), 'utf-8');
+ expect(code).toContain("require.resolve(dir)");
+ expect(code).toContain("require.resolve('./other.js')");
+ expect(code).toContain("require.resolve('./foo/' + dir + '.js')");
+ expect(code).toContain("require.resolve(process.env.RANDOM ? './foo/' + dir + '.js' : './bar/' + dir + 'js')");
+});