feat: worker option (#255)

Author: evilebottnawi

babel.config.js

@@ -15,5 +15,20 @@ module.exports = (api) => {
         },
       ],
     ],
+    overrides: [
+      {
+        test: './src/runtime',
+        presets: [
+          [
+            '@babel/preset-env',
+            {
+              targets: {
+                node: '0.12',
+              },
+            },
+          ],
+        ],
+      },
+    ],
   };
 };

src/options.json

@@ -1,6 +1,29 @@
 {
   "type": "object",
   "properties": {
+    "worker": {
+      "anyOf": [
+        {
+          "type": "string",
+          "minLength": 1
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "properties": {
+            "type": {
+              "type": "string",
+              "minLength": 1
+            },
+            "options": {
+              "additionalProperties": true,
+              "type": "object"
+            }
+          },
+          "required": ["type"]
+        }
+      ]
+    },
     "name": {
       "type": "string"
     },
@@ -12,9 +35,6 @@
     },
     "publicPath": {
       "type": "string"
-    },
-    "workerType": {
-      "type": "string"
     }
   },
   "additionalProperties": false

src/runtime/inline.js

@@ -0,0 +1,48 @@
+/* eslint-env browser */
+/* eslint-disable no-undef, no-use-before-define, new-cap */
+
+module.exports = function inline(
+  content,
+  url,
+  workerConstructor,
+  workerOptions
+) {
+  try {
+    try {
+      let blob;
+
+      try {
+        // BlobBuilder = Deprecated, but widely implemented
+        const BlobBuilder =
+          BlobBuilder || WebKitBlobBuilder || MozBlobBuilder || MSBlobBuilder;
+
+        blob = new BlobBuilder();
+
+        blob.append(content);
+
+        blob = blob.getBlob();
+      } catch (e) {
+        // New API
+        blob = new Blob([content]);
+      }
+
+      const objectURL = URL.createObjectURL(blob);
+      const worker = new window[workerConstructor](objectURL, workerOptions);
+
+      URL.revokeObjectURL(objectURL);
+
+      return worker;
+    } catch (e) {
+      return new window[workerConstructor](
+        `data:application/javascript,${encodeURIComponent(content)}`,
+        workerOptions
+      );
+    }
+  } catch (e) {
+    if (!url) {
+      throw Error('Inline worker is not supported');
+    }
+
+    return new window[workerConstructor](url, workerOptions);
+  }
+};

src/supportWebpack4.js

@@ -1,4 +1,4 @@
-import getWorker from './workers';
+import { getWorker } from './utils';
 
 export default function runAsChild(worker, request, options, callback) {
   const subCache = `subcache ${__dirname} ${request}`;

src/supportWebpack5.js

@@ -1,4 +1,4 @@
-import getWorker from './workers';
+import { getWorker } from './utils';
 
 export default function runAsChild(worker, options, callback) {
   // eslint-disable-next-line import/no-unresolved, global-require

src/utils.js

@@ -0,0 +1,40 @@
+function getWorker(file, content, options) {
+  const publicPath =
+    typeof options.publicPath === 'undefined'
+      ? '__webpack_public_path__'
+      : JSON.stringify(options.publicPath);
+  const publicWorkerPath = `${publicPath} + ${JSON.stringify(file)}`;
+
+  let workerConstructor;
+  let workerOptions;
+
+  if (typeof options.worker === 'undefined') {
+    workerConstructor = 'Worker';
+  } else if (typeof options.worker === 'string') {
+    workerConstructor = options.worker;
+  } else {
+    ({ type: workerConstructor, options: workerOptions } = options.worker);
+  }
+
+  if (options.inline) {
+    const InlineWorkerPath = JSON.stringify(
+      `!!${require.resolve('./runtime/inline.js')}`
+    );
+
+    const fallbackWorkerPath =
+      options.fallback === false ? 'null' : publicWorkerPath;
+
+    return `require(${InlineWorkerPath})(${JSON.stringify(
+      content
+    )}, ${fallbackWorkerPath}, ${JSON.stringify(
+      workerConstructor
+    )}, ${JSON.stringify(workerOptions)})`;
+  }
+
+  return `new ${workerConstructor}(${publicWorkerPath}${
+    workerOptions ? `, ${JSON.stringify(workerOptions)}` : ''
+  })`;
+}
+
+// eslint-disable-next-line import/prefer-default-export
+export { getWorker };

src/workers/InlineWorker.js

@@ -0,0 +1,43 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`"workerType" option should support the "Worker" object value for inline workers: errors 1`] = `Array []`;
+
+exports[`"workerType" option should support the "Worker" object value for inline workers: result 1`] = `"{\\"postMessage\\":true,\\"onmessage\\":true}"`;
+
+exports[`"workerType" option should support the "Worker" object value for inline workers: warnings 1`] = `Array []`;
+
+exports[`"workerType" option should support the "Worker" object value: errors 1`] = `Array []`;
+
+exports[`"workerType" option should support the "Worker" object value: module 1`] = `
+"module.exports = function() {
+  return new Worker(__webpack_public_path__ + \\"test.worker.js\\", {\\"type\\":\\"classic\\",\\"name\\":\\"worker-name\\"});
+};"
+`;
+
+exports[`"workerType" option should support the "Worker" object value: result 1`] = `"{\\"postMessage\\":true,\\"onmessage\\":true}"`;
+
+exports[`"workerType" option should support the "Worker" object value: warnings 1`] = `Array []`;
+
+exports[`"workerType" option should support the "Worker" string value: errors 1`] = `Array []`;
+
+exports[`"workerType" option should support the "Worker" string value: module 1`] = `
+"module.exports = function() {
+  return new Worker(__webpack_public_path__ + \\"test.worker.js\\");
+};"
+`;
+
+exports[`"workerType" option should support the "Worker" string value: result 1`] = `"{\\"postMessage\\":true,\\"onmessage\\":true}"`;
+
+exports[`"workerType" option should support the "Worker" string value: warnings 1`] = `Array []`;
+
+exports[`"workerType" option should use "Worker" by default: errors 1`] = `Array []`;
+
+exports[`"workerType" option should use "Worker" by default: module 1`] = `
+"module.exports = function() {
+  return new Worker(__webpack_public_path__ + \\"test.worker.js\\");
+};"
+`;
+
+exports[`"workerType" option should use "Worker" by default: result 1`] = `"{\\"postMessage\\":true,\\"onmessage\\":true}"`;
+
+exports[`"workerType" option should use "Worker" by default: warnings 1`] = `Array []`;

src/workers/index.js

@@ -27,6 +27,25 @@ export default async function getResultFromBrowser(stats) {
 
   const browser = await puppeteer.launch();
   const page = await browser.newPage();
+
+  page
+    .on('console', (message) =>
+      // eslint-disable-next-line no-console
+      console.log(message)
+    )
+    .on('pageerror', ({ message }) =>
+      // eslint-disable-next-line no-console
+      console.log(message)
+    )
+    // .on('response', (response) =>
+    //   // eslint-disable-next-line no-console
+    //   console.log(`${response.status()} ${response.url()}`)
+    // )
+    .on('requestfailed', (request) =>
+      // eslint-disable-next-line no-console
+      console.log(`${request.failure().errorText} ${request.url()}`)
+    );
+
   await page.goto(`http://127.0.0.1:${port}/`);
   await page.waitForSelector('button');
   await page.click('button');