fix: respect externals (#264)

webpack-contrib · Jul 28, 2020 · 1e761ed · 1e761ed
1 parent c117a7c
commit 1e761ed
Show file tree

Hide file tree

Showing 7 changed files with 124 additions and 4 deletions.
diff --git a/src/index.js b/src/index.js
@@ -4,11 +4,16 @@ import validateOptions from 'schema-utils';
 import NodeTargetPlugin from 'webpack/lib/node/NodeTargetPlugin';
 import SingleEntryPlugin from 'webpack/lib/SingleEntryPlugin';
 import WebWorkerTemplatePlugin from 'webpack/lib/webworker/WebWorkerTemplatePlugin';
+import ExternalsPlugin from 'webpack/lib/ExternalsPlugin';
 
 import schema from './options.json';
 import supportWebpack5 from './supportWebpack5';
 import supportWebpack4 from './supportWebpack4';
-import { getDefaultFilename, getDefaultChunkFilename } from './utils';
+import {
+  getDefaultFilename,
+  getDefaultChunkFilename,
+  getExternalsType,
+} from './utils';
 
 let FetchCompileWasmPlugin;
 let FetchCompileAsyncWasmPlugin;
@@ -56,7 +61,11 @@ export function pitch(request) {
     ? options.chunkFilename
     : getDefaultChunkFilename(compilerOptions.output.chunkFilename);
 
-  worker.options = { filename, chunkFilename, globalObject: 'self' };
+  worker.options = {
+    filename,
+    chunkFilename,
+    globalObject: 'self',
+  };
 
   worker.compiler = this._compilation.createChildCompiler(
     'worker',
@@ -79,6 +88,13 @@ export function pitch(request) {
     new FetchCompileAsyncWasmPlugin().apply(worker.compiler);
   }
 
+  if (compilerOptions.externals) {
+    new ExternalsPlugin(
+      getExternalsType(compilerOptions),
+      compilerOptions.externals
+    ).apply(worker.compiler);
+  }
+
   new SingleEntryPlugin(this.context, `!!${request}`, 'main').apply(
     worker.compiler
   );

diff --git a/src/utils.js b/src/utils.js
@@ -10,6 +10,28 @@ function getDefaultChunkFilename(chunkFilename) {
   return chunkFilename.replace(/\.([a-z]+)(\?.+)?$/i, '.worker.$1$2');
 }
 
+function getExternalsType(compilerOptions) {
+  // For webpack@4
+  if (compilerOptions.output.libraryTarget) {
+    return compilerOptions.output.libraryTarget;
+  }
+
+  // For webpack@5
+  if (compilerOptions.externalsType) {
+    return compilerOptions.externalsType;
+  }
+
+  if (compilerOptions.output.library) {
+    return compilerOptions.output.library.type;
+  }
+
+  if (compilerOptions.output.module) {
+    return 'module';
+  }
+
+  return 'var';
+}
+
 function getWorker(file, content, options) {
   const publicPath =
     typeof options.publicPath === 'undefined'
@@ -48,5 +70,9 @@ function getWorker(file, content, options) {
   })`;
 }
 
-// eslint-disable-next-line import/prefer-default-export
-export { getDefaultFilename, getDefaultChunkFilename, getWorker };
+export {
+  getDefaultFilename,
+  getDefaultChunkFilename,
+  getExternalsType,
+  getWorker,
+};
diff --git a/test/__snapshots__/loader.test.js.snap b/test/__snapshots__/loader.test.js.snap
@@ -1,5 +1,18 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
+exports[`worker-loader should work with "externals": errors 1`] = `Array []`;
+
+exports[`worker-loader should work with "externals": module 1`] = `
+"export default function() {
+  return new Worker(__webpack_public_path__ + \\"test.worker.js\\");
+};
+"
+`;
+
+exports[`worker-loader should work with "externals": result 1`] = `"{\\"postMessage\\":true,\\"onmessage\\":true}"`;
+
+exports[`worker-loader should work with "externals": warnings 1`] = `Array []`;
+
 exports[`worker-loader should work with WASM: errors 1`] = `Array []`;
 
 exports[`worker-loader should work with WASM: module 1`] = `

diff --git a/test/fixtures/external/entry.js b/test/fixtures/external/entry.js
@@ -0,0 +1,22 @@
+import Worker from './worker.js';
+
+const worker = new Worker();
+
+let result;
+
+worker.onmessage = function (event) {
+  if (!result) {
+    result = document.createElement("div");
+    result.setAttribute('id', 'result');
+
+    document.body.append(result);
+  }
+
+  result.innerText = JSON.stringify(event.data)
+};
+
+const button = document.getElementById('button');
+
+button.addEventListener('click', () => {
+  worker.postMessage({ postMessage: true })
+});
diff --git a/test/fixtures/external/index.html b/test/fixtures/external/index.html
@@ -0,0 +1,13 @@
+<!doctype html>
+<html>
+<head>
+  <meta charset="utf-8">
+  <title>Webpack App</title>
+  <meta name="viewport" content="width=device-width,initial-scale=1">
+</head>
+<body>
+
+<button id="button">Run Action</button>
+
+</body>
+</html>
diff --git a/test/fixtures/external/worker.js b/test/fixtures/external/worker.js
@@ -0,0 +1,9 @@
+import foo from 'my-custom-module';
+
+onmessage = function(event) {
+  const workerResult = event.data;
+
+  workerResult.onmessage = true;
+
+  postMessage(workerResult);
+};
diff --git a/test/loader.test.js b/test/loader.test.js
@@ -59,4 +59,25 @@ describe('worker-loader', () => {
     expect(getWarnings(stats)).toMatchSnapshot('warnings');
     expect(getErrors(stats)).toMatchSnapshot('errors');
   });
+
+  it('should work with "externals"', async () => {
+    const compiler = getCompiler(
+      './external/entry.js',
+      {},
+      {
+        externals: {
+          'my-custom-module': 'navigator',
+        },
+      }
+    );
+    const stats = await compile(compiler);
+    const result = await getResultFromBrowser(stats);
+
+    expect(getModuleSource('./external/worker.js', stats)).toMatchSnapshot(
+      'module'
+    );
+    expect(result).toMatchSnapshot('result');
+    expect(getWarnings(stats)).toMatchSnapshot('warnings');
+    expect(getErrors(stats)).toMatchSnapshot('errors');
+  });
 });