refactor: inline option (#267)

BREAKING CHANGE: the `fallback` option was removed in favor the `inline` option, the `inline` option accept only `fallback` and `no-fallback` values

Author: evilebottnawi

src/options.json

@@ -24,10 +24,6 @@
         }
       ]
     },
-    "filename": {
-      "type": "string",
-      "minLength": 1
-    },
     "publicPath": {
       "anyOf": [
         {
@@ -38,15 +34,16 @@
         }
       ]
     },
+    "filename": {
+      "type": "string",
+      "minLength": 1
+    },
     "chunkFilename": {
       "type": "string",
       "minLength": 1
     },
     "inline": {
-      "type": "boolean"
-    },
-    "fallback": {
-      "type": "boolean"
+      "enum": ["no-fallback", "fallback"]
     },
     "esModule": {
       "type": "boolean"

src/runtime/inline.js

@@ -1,29 +1,29 @@
 /* eslint-env browser */
 /* eslint-disable no-undef, no-use-before-define, new-cap */
 
-module.exports = function inline(
-  content,
-  url,
-  workerConstructor,
-  workerOptions
-) {
+const URL = window.URL || window.webkitURL;
+
+module.exports = (content, workerConstructor, workerOptions, url) => {
   try {
     try {
       let blob;
 
       try {
+        // New API
+        blob = new window.Blob([content]);
+      } catch (e) {
         // BlobBuilder = Deprecated, but widely implemented
         const BlobBuilder =
-          BlobBuilder || WebKitBlobBuilder || MozBlobBuilder || MSBlobBuilder;
+          window.BlobBuilder ||
+          window.WebKitBlobBuilder ||
+          window.MozBlobBuilder ||
+          window.MSBlobBuilder;
 
         blob = new BlobBuilder();
 
         blob.append(content);
 
         blob = blob.getBlob();
-      } catch (e) {
-        // New API
-        blob = new Blob([content]);
       }
 
       const objectURL = URL.createObjectURL(blob);

src/supportWebpack4.js

@@ -33,7 +33,7 @@ export default function runAsChild(worker, request, options, callback) {
         options
       );
 
-      if (options.fallback === false) {
+      if (options.inline === 'no-fallback') {
         delete this._compilation.assets[worker.file];
       }
 

src/supportWebpack5.js

@@ -24,7 +24,7 @@ export default function runAsChild(worker, options, callback) {
             return callback(getCacheError);
           }
 
-          if (options.fallback === false) {
+          if (options.inline === 'no-fallback') {
             delete this._compilation.assets[worker.file];
           }
 

src/utils.js

@@ -33,8 +33,6 @@ function getExternalsType(compilerOptions) {
 }
 
 function getWorker(file, content, options) {
-  const publicWorkerPath = `__webpack_public_path__ + ${JSON.stringify(file)}`;
-
   let workerConstructor;
   let workerOptions;
 
@@ -51,19 +49,22 @@ function getWorker(file, content, options) {
       `!!${require.resolve('./runtime/inline.js')}`
     );
 
-    const fallbackWorkerPath =
-      options.fallback === false ? 'null' : publicWorkerPath;
+    let fallbackWorkerPath;
+
+    if (options.inline === 'fallback') {
+      fallbackWorkerPath = `__webpack_public_path__ + ${JSON.stringify(file)}`;
+    }
 
     return `require(${InlineWorkerPath})(${JSON.stringify(
       content
-    )}, ${fallbackWorkerPath}, ${JSON.stringify(
-      workerConstructor
-    )}, ${JSON.stringify(workerOptions)})`;
+    )}, ${JSON.stringify(workerConstructor)}, ${JSON.stringify(
+      workerOptions
+    )}, ${fallbackWorkerPath})`;
   }
 
-  return `new ${workerConstructor}(${publicWorkerPath}${
-    workerOptions ? `, ${JSON.stringify(workerOptions)}` : ''
-  })`;
+  return `new ${workerConstructor}(__webpack_public_path__ + ${JSON.stringify(
+    file
+  )}${workerOptions ? `, ${JSON.stringify(workerOptions)}` : ''})`;
 }
 
 export {

test/__snapshots__/fallback-option.test.js.snap

@@ -13,21 +13,14 @@ exports[`"inline" option should not work by default: result 1`] = `"{\\"postMess
 
 exports[`"inline" option should not work by default: warnings 1`] = `Array []`;
 
-exports[`"inline" option should not work with "false" value: errors 1`] = `Array []`;
+exports[`"inline" option should not work with "no-fallback" value: errors 1`] = `Array []`;
 
-exports[`"inline" option should not work with "false" value: module 1`] = `
-"export default function() {
-  return new Worker(__webpack_public_path__ + \\"test.worker.js\\");
-};
-"
-`;
-
-exports[`"inline" option should not work with "false" value: result 1`] = `"{\\"postMessage\\":true,\\"onmessage\\":true}"`;
+exports[`"inline" option should not work with "no-fallback" value: result 1`] = `"{\\"postMessage\\":true,\\"onmessage\\":true}"`;
 
-exports[`"inline" option should not work with "false" value: warnings 1`] = `Array []`;
+exports[`"inline" option should not work with "no-fallback" value: warnings 1`] = `Array []`;
 
-exports[`"inline" option should work with "true" value: errors 1`] = `Array []`;
+exports[`"inline" option should work with "fallback" value: errors 1`] = `Array []`;
 
-exports[`"inline" option should work with "true" value: result 1`] = `"{\\"postMessage\\":true,\\"onmessage\\":true}"`;
+exports[`"inline" option should work with "fallback" value: result 1`] = `"{\\"postMessage\\":true,\\"onmessage\\":true}"`;
 
-exports[`"inline" option should work with "true" value: warnings 1`] = `Array []`;
+exports[`"inline" option should work with "fallback" value: warnings 1`] = `Array []`;

test/__snapshots__/inline-option.test.js.snap

@@ -9,7 +9,7 @@ import {
 
 describe('"inline" option', () => {
   it('should not work by default', async () => {
-    const compiler = getCompiler('./basic/entry.js', { inline: false });
+    const compiler = getCompiler('./basic/entry.js');
     const stats = await compile(compiler);
     const result = await getResultFromBrowser(stats);
 
@@ -22,25 +22,28 @@ describe('"inline" option', () => {
     expect(getErrors(stats)).toMatchSnapshot('errors');
   });
 
-  it('should work with "true" value', async () => {
-    const compiler = getCompiler('./basic/entry.js', { inline: true });
+  it('should not work with "no-fallback" value', async () => {
+    const compiler = getCompiler('./basic/entry.js', { inline: 'no-fallback' });
     const stats = await compile(compiler);
     const result = await getResultFromBrowser(stats);
+    const moduleSource = getModuleSource('./basic/worker.js', stats);
 
-    expect(stats.compilation.assets['test.worker.js']).toBeDefined();
+    expect(moduleSource.indexOf('inline.js') > 0).toBe(true);
+    expect(moduleSource.indexOf('__webpack_public_path__ + "test.worker.js"') === -1).toBe(true);
+    expect(stats.compilation.assets['test.worker.js']).toBeUndefined();
     expect(result).toMatchSnapshot('result');
     expect(getWarnings(stats)).toMatchSnapshot('warnings');
     expect(getErrors(stats)).toMatchSnapshot('errors');
   });
 
-  it('should not work with "false" value', async () => {
-    const compiler = getCompiler('./basic/entry.js', { inline: false });
+  it('should work with "fallback" value', async () => {
+    const compiler = getCompiler('./basic/entry.js', { inline: 'fallback' });
     const stats = await compile(compiler);
     const result = await getResultFromBrowser(stats);
+    const moduleSource = getModuleSource('./basic/worker.js', stats);
 
-    expect(getModuleSource('./basic/worker.js', stats)).toMatchSnapshot(
-      'module'
-    );
+    expect(moduleSource.indexOf('inline.js') > 0).toBe(true);
+    expect(moduleSource.indexOf('__webpack_public_path__ + "test.worker.js"') > 0).toBe(true);
     expect(stats.compilation.assets['test.worker.js']).toBeDefined();
     expect(result).toMatchSnapshot('result');
     expect(getWarnings(stats)).toMatchSnapshot('warnings');