Add webpack-preserve-dynamic-require-plugin

Author: dmichon-msft

common/reviews/api/webpack-preserve-dynamic-require-plugin.api.md

@@ -0,0 +1,17 @@
+## API Report File for "@rushstack/webpack-preserve-dynamic-require-plugin"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import type * as webpack from 'webpack';
+
+// @public (undocumented)
+export class PreserveDynamicRequireWebpackPlugin {
+    // (undocumented)
+    apply(compiler: webpack.Compiler): void;
+}
+
+// (No @packageDocumentation comment for this package)
+
+```

rush.json

@@ -1027,6 +1027,12 @@
       "reviewCategory": "libraries",
       "shouldPublish": true
     },
+    {
+      "packageName": "@rushstack/webpack-preserve-dynamic-require-plugin",
+      "projectFolder": "webpack/preserve-dynamic-require-plugin",
+      "reviewCategory": "libraries",
+      "shouldPublish": true
+    },
     {
       "packageName": "@rushstack/set-webpack-public-path-plugin",
       "projectFolder": "webpack/set-webpack-public-path-plugin",

webpack/preserve-dynamic-require-plugin/.eslintrc.js

@@ -0,0 +1,10 @@
+// This is a workaround for https://github.com/eslint/eslint/issues/3458
+require('@rushstack/eslint-config/patch/modern-module-resolution');
+
+module.exports = {
+  extends: [
+    '@rushstack/eslint-config/profile/node-trusted-tool',
+    '@rushstack/eslint-config/mixins/friendly-locals'
+  ],
+  parserOptions: { tsconfigRootDir: __dirname }
+};

webpack/preserve-dynamic-require-plugin/.npmignore

@@ -0,0 +1,30 @@
+# THIS IS A STANDARD TEMPLATE FOR .npmignore FILES IN THIS REPO.
+
+# Ignore all files by default, to avoid accidentally publishing unintended files.
+*
+
+# Use negative patterns to bring back the specific things we want to publish.
+!/bin/**
+!/lib/**
+!/lib-*/**
+!/dist/**
+!ThirdPartyNotice.txt
+
+# Ignore certain patterns that should not get published.
+/dist/*.stats.*
+/lib/**/test/
+/lib-*/**/test/
+*.test.js
+
+# NOTE: These don't need to be specified, because NPM includes them automatically.
+#
+# package.json
+# README (and its variants)
+# CHANGELOG (and its variants)
+# LICENSE / LICENCE
+
+#--------------------------------------------
+# DO NOT MODIFY THE TEMPLATE ABOVE THIS LINE
+#--------------------------------------------
+
+# (Add your project-specific overrides here)

webpack/preserve-dynamic-require-plugin/README.md

@@ -0,0 +1,11 @@
+# @rushstack/webpack-preserve-dynamic-require-plugin
+
+## Overview
+
+This Webpack plugin instructs webpack to leave dynamic usage of `require` as-is in the bundled code. For example, if your code contains:
+```js
+function requireSomeUserThing(path) {
+  return require(path);
+}
+```
+The emitted bundle will preserve the call to `require(path)` instead of trying to process it.

webpack/preserve-dynamic-require-plugin/config/api-extractor.json

@@ -0,0 +1,19 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+
+  "mainEntryPointFilePath": "<projectFolder>/lib/index.d.ts",
+
+  "apiReport": {
+    "enabled": true,
+    "reportFolder": "../../../common/reviews/api"
+  },
+
+  "docModel": {
+    "enabled": true,
+    "apiJsonFilePath": "../../../common/temp/api/<unscopedPackageName>.api.json"
+  },
+
+  "dtsRollup": {
+    "enabled": true
+  }
+}

webpack/preserve-dynamic-require-plugin/config/jest.config.json

@@ -0,0 +1,3 @@
+{
+  "extends": "@rushstack/heft-node-rig/profiles/default/config/jest.config.json"
+}

webpack/preserve-dynamic-require-plugin/config/rig.json

@@ -0,0 +1,7 @@
+{
+  // The "rig.json" file directs tools to look for their config files in an external package.
+  // Documentation for this system: https://www.npmjs.com/package/@rushstack/rig-package
+  "$schema": "https://developer.microsoft.com/json-schemas/rig-package/rig.schema.json",
+
+  "rigPackageName": "@rushstack/heft-node-rig"
+}

webpack/preserve-dynamic-require-plugin/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@rushstack/webpack-preserve-dynamic-require-plugin",
+  "version": "0.8.11",
+  "description": "This plugin tells webpack to leave dynamic calls to \"require\" as-is instead of trying to bundle them.",
+  "main": "lib/index.js",
+  "typings": "dist/webpack-preserve-dynamic-require-plugin.d.ts",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/microsoft/rushstack.git",
+    "directory": "webpack/preserve-dynamic-require-plugin"
+  },
+  "engines": {
+    "node": ">=10.17.1"
+  },
+  "scripts": {
+    "build": "heft build --clean",
+    "_phase:build": "heft build --clean",
+    "_phase:test": "heft test --no-build"
+  },
+  "dependencies": {},
+  "devDependencies": {
+    "@rushstack/eslint-config": "workspace:*",
+    "@rushstack/heft": "workspace:*",
+    "@rushstack/heft-node-rig": "workspace:*",
+    "@types/heft-jest": "1.0.1",
+    "@types/node": "12.20.24",
+    "webpack": "~5.68.0"
+  },
+  "sideEffects": false
+}

webpack/preserve-dynamic-require-plugin/src/__snapshots__/index.test.ts.snap

@@ -0,0 +1,11 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`PreserveDynamicRequireWebpackPlugin Preserves dynamic require usage 1`] = `
+Map {
+  "/release/main.js" => "/******/ (() => { // webpackBootstrap
+var __webpack_exports__ = {};
+require(process.env.SOME_PATH);
+/******/ })()
+;",
+}
+`;

webpack/preserve-dynamic-require-plugin/src/index.test.ts

@@ -0,0 +1,95 @@
+jest.disableAutomock();
+import webpack from 'webpack';
+
+import { PreserveDynamicRequireWebpackPlugin } from './index';
+
+jest.setTimeout(1e9);
+
+describe(PreserveDynamicRequireWebpackPlugin.name, () => {
+  it('Preserves dynamic require usage', async () => {
+    const sources: Map<string, string> = new Map();
+    sources.set('/package.json', JSON.stringify({}));
+    sources.set('/file.js', 'require(process.env.SOME_PATH);');
+
+    const compiler: webpack.Compiler = webpack({
+      entry: {
+        main: '/file.js'
+      },
+      output: {
+        path: '/release',
+        filename: '[name].js'
+      },
+      context: '/',
+      mode: 'none',
+      plugins: [new PreserveDynamicRequireWebpackPlugin()]
+    });
+
+    const inputFs: typeof compiler.inputFileSystem = {
+      readFile(path: string, cb: (err?: NodeJS.ErrnoException | undefined, content?: string) => void): void {
+        cb(undefined, sources.get(path));
+      },
+      readdir(path: string, cb: (err?: NodeJS.ErrnoException | undefined, files?: string[]) => void): void {
+        cb(
+          undefined,
+          Array.from(sources.keys(), (key: string) => key.slice(1))
+        );
+      },
+      readlink(path: string, cb: (err?: NodeJS.ErrnoException | undefined, dest?: string) => void): void {
+        cb();
+      },
+      stat(path: string, cb: (err?: NodeJS.ErrnoException, stat?: unknown) => void): void {
+        if (sources.has(path)) {
+          return cb(undefined, {
+            isFile() {
+              return true;
+            },
+            isDirectory() {
+              return false;
+            }
+          });
+        } else if (path === '/') {
+          return cb(undefined, {
+            isFile() {
+              return false;
+            },
+            isDirectory() {
+              return true;
+            }
+          });
+        }
+        cb(new Error(`Unexpected stat call for ${path}`));
+      }
+    } as unknown as typeof compiler.inputFileSystem;
+
+    const results: Map<string, string> = new Map();
+
+    const outputFs: typeof compiler.outputFileSystem = {
+      mkdir(path: string, cb: (err?: NodeJS.ErrnoException) => void): void {
+        cb();
+      },
+      stat(path: string, cb: (err?: NodeJS.ErrnoException) => void): void {
+        const err: NodeJS.ErrnoException = new Error(`No such file`);
+        err.code = 'ENOENT';
+        cb(err);
+      },
+      writeFile(path: string, content: Buffer, cb: (err?: NodeJS.ErrnoException) => void): void {
+        results.set(path, content.toString('utf8'));
+        cb();
+      }
+    } as unknown as typeof compiler.outputFileSystem;
+
+    compiler.inputFileSystem = inputFs;
+    compiler.outputFileSystem = outputFs;
+
+    await new Promise<void>((resolve: () => void, reject: (err: Error) => void) =>
+      compiler.run((err?: Error | null) => {
+        if (err) {
+          return reject(err);
+        }
+        resolve();
+      })
+    );
+
+    expect(results).toMatchSnapshot();
+  });
+});

webpack/preserve-dynamic-require-plugin/src/index.ts

@@ -0,0 +1,33 @@
+import type * as webpack from 'webpack';
+
+const PLUGIN_NAME: 'PreserveDynamicRequireWebpackPlugin' = 'PreserveDynamicRequireWebpackPlugin';
+
+/**
+ * @public
+ */
+export class PreserveDynamicRequireWebpackPlugin {
+  public apply(compiler: webpack.Compiler): void {
+    compiler.hooks.thisCompilation.tap(PLUGIN_NAME, (compilation: webpack.Compilation) => {
+      function processDependencies(
+        block: Pick<webpack.AsyncDependenciesBlock, 'dependencies' | 'blocks'>
+      ): void {
+        const { dependencies } = block;
+        for (let i: number = dependencies.length - 1; i >= 0; i--) {
+          const dep: webpack.Dependency = dependencies[i];
+          // Disable processing of dynamic require
+          if (dep.constructor.name === 'CommonJsRequireContextDependency') {
+            dependencies.splice(i, 1);
+          }
+        }
+
+        for (const child of block.blocks) {
+          processDependencies(child);
+        }
+      }
+
+      compilation.hooks.succeedModule.tap(PLUGIN_NAME, (mod: webpack.Module) => {
+        processDependencies(mod);
+      });
+    });
+  }
+}

webpack/preserve-dynamic-require-plugin/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "./node_modules/@rushstack/heft-node-rig/profiles/default/tsconfig-base.json",
+  "compilerOptions": {
+    "target": "ES2019",
+    "types": ["heft-jest", "node"],
+    "noImplicitAny": false // Some typings are missing
+  }
+}