├── CODEOWNERS
├── renovate.json
├── .gitignore
├── .travis.yml
├── CONTRIBUTORS
├── Dockerfile
├── tests
    ├── fixtures
    │   ├── destructuring
    │   │   ├── build
    │   │   │   └── runner.html
    │   │   ├── a.js
    │   │   ├── entry.js
    │   │   └── rollup.config.js
    │   ├── simple-bundle
    │   │   ├── build
    │   │   │   └── runner.html
    │   │   ├── a.js
    │   │   ├── entry.js
    │   │   └── rollup.config.js
    │   └── module-worker
    │   │   ├── a.js
    │   │   ├── build
    │   │       └── runner.html
    │   │   ├── entry.js
    │   │   └── rollup.config.js
    ├── simple-bundle.test.js
    ├── destructuring.test.js
    └── module-worker.test.js
├── package.json
├── karma.conf.js
├── CONTRIBUTING
├── run_tests.js
├── index.js
├── README.md
└── LICENSE


/CODEOWNERS:
--------------------------------------------------------------------------------
1 | * @surma
2 | 


--------------------------------------------------------------------------------
/renovate.json:
--------------------------------------------------------------------------------
1 | {
2 |   "extends": ["config:base"]
3 | }
4 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | tests/fixtures/*/build/*.js
2 | node_modules
3 | package-lock.json
4 | 


--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
1 | sudo: required
2 | 
3 | services:
4 |   - docker
5 | 
6 | script:
7 |   - docker build -t omt .
8 |   - docker run --rm -v `pwd`:/usr/src omt
9 | 


--------------------------------------------------------------------------------
/CONTRIBUTORS:
--------------------------------------------------------------------------------
 1 | # People who have agreed to one of the CLAs and can contribute patches.
 2 | # The AUTHORS file lists the copyright holders; this file
 3 | # lists people.  For example, Google employees are listed here
 4 | # but not in AUTHORS, because Google holds the copyright.
 5 | #
 6 | # https://developers.google.com/open-source/cla/individual
 7 | # https://developers.google.com/open-source/cla/corporate
 8 | #
 9 | # Names should be added to this file as:
10 | #     Name <email address>
11 | Surma <surma@google.com>
12 | 


--------------------------------------------------------------------------------
/Dockerfile:
--------------------------------------------------------------------------------
 1 | FROM selenium/node-chrome:latest
 2 | 
 3 | USER root
 4 | 
 5 | RUN apt-get update -qqy \
 6 |   && rm -rf /var/lib/apt/lists/* /var/cache/apt/* \
 7 |   && rm /bin/sh && ln -s /bin/bash /bin/sh \
 8 |   && chown seluser /usr/local
 9 | 
10 | ENV NVM_DIR /usr/local/nvm
11 | RUN mkdir -p $NVM_DIR \
12 |   && wget -qO- https://raw.githubusercontent.com/creationix/nvm/v0.35.2/install.sh | bash \
13 |   && source $NVM_DIR/nvm.sh \
14 |   && nvm install v12
15 | 
16 | ENV CHROME_BIN /opt/google/chrome/chrome
17 | ENV INSIDE_DOCKER=1
18 | 
19 | WORKDIR /usr/src
20 | ENTRYPOINT source $NVM_DIR/nvm.sh && npm i && npm test


--------------------------------------------------------------------------------
/tests/fixtures/destructuring/build/runner.html:
--------------------------------------------------------------------------------
 1 | <!--
 2 | Copyright 2018 Google Inc. All Rights Reserved.
 3 | Licensed under the Apache License, Version 2.0 (the "License");
 4 | you may not use this file except in compliance with the License.
 5 | You may obtain a copy of the License at
 6 |     http://www.apache.org/licenses/LICENSE-2.0
 7 | Unless required by applicable law or agreed to in writing, software
 8 | distributed under the License is distributed on an "AS IS" BASIS,
 9 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
10 | See the License for the specific language governing permissions and
11 | limitations under the License.
12 | -->
13 | 
14 | <!doctype html>
15 | <script src="entry.js"></script>
16 | 


--------------------------------------------------------------------------------
/tests/fixtures/simple-bundle/build/runner.html:
--------------------------------------------------------------------------------
 1 | <!--
 2 | Copyright 2018 Google Inc. All Rights Reserved.
 3 | Licensed under the Apache License, Version 2.0 (the "License");
 4 | you may not use this file except in compliance with the License.
 5 | You may obtain a copy of the License at
 6 |     http://www.apache.org/licenses/LICENSE-2.0
 7 | Unless required by applicable law or agreed to in writing, software
 8 | distributed under the License is distributed on an "AS IS" BASIS,
 9 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
10 | See the License for the specific language governing permissions and
11 | limitations under the License.
12 | -->
13 | 
14 | <!doctype html>
15 | <script src="entry.js"></script>
16 | 


--------------------------------------------------------------------------------
/tests/fixtures/destructuring/a.js:
--------------------------------------------------------------------------------
 1 | /**
 2 |  * Copyright 2020 Google Inc. All Rights Reserved.
 3 |  * Licensed under the Apache License, Version 2.0 (the "License");
 4 |  * you may not use this file except in compliance with the License.
 5 |  * You may obtain a copy of the License at
 6 |  *     http://www.apache.org/licenses/LICENSE-2.0
 7 |  * Unless required by applicable law or agreed to in writing, software
 8 |  * distributed under the License is distributed on an "AS IS" BASIS,
 9 |  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
10 |  * See the License for the specific language governing permissions and
11 |  * limitations under the License.
12 |  */
13 | 
14 | export function f() {
15 |   return "a";
16 | }
17 | 


--------------------------------------------------------------------------------
/tests/fixtures/module-worker/a.js:
--------------------------------------------------------------------------------
 1 | /**
 2 |  * Copyright 2020 Google Inc. All Rights Reserved.
 3 |  * Licensed under the Apache License, Version 2.0 (the "License");
 4 |  * you may not use this file except in compliance with the License.
 5 |  * You may obtain a copy of the License at
 6 |  *     http://www.apache.org/licenses/LICENSE-2.0
 7 |  * Unless required by applicable law or agreed to in writing, software
 8 |  * distributed under the License is distributed on an "AS IS" BASIS,
 9 |  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
10 |  * See the License for the specific language governing permissions and
11 |  * limitations under the License.
12 |  */
13 | 
14 | export function f() {
15 |   return "a";
16 | }
17 | 


--------------------------------------------------------------------------------
/tests/fixtures/simple-bundle/a.js:
--------------------------------------------------------------------------------
 1 | /**
 2 |  * Copyright 2020 Google Inc. All Rights Reserved.
 3 |  * Licensed under the Apache License, Version 2.0 (the "License");
 4 |  * you may not use this file except in compliance with the License.
 5 |  * You may obtain a copy of the License at
 6 |  *     http://www.apache.org/licenses/LICENSE-2.0
 7 |  * Unless required by applicable law or agreed to in writing, software
 8 |  * distributed under the License is distributed on an "AS IS" BASIS,
 9 |  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
10 |  * See the License for the specific language governing permissions and
11 |  * limitations under the License.
12 |  */
13 | 
14 | export function f() {
15 |   return "a";
16 | }
17 | 


--------------------------------------------------------------------------------
/tests/fixtures/module-worker/build/runner.html:
--------------------------------------------------------------------------------
 1 | <!--
 2 | Copyright 2018 Google Inc. All Rights Reserved.
 3 | Licensed under the Apache License, Version 2.0 (the "License");
 4 | you may not use this file except in compliance with the License.
 5 | You may obtain a copy of the License at
 6 |     http://www.apache.org/licenses/LICENSE-2.0
 7 | Unless required by applicable law or agreed to in writing, software
 8 | distributed under the License is distributed on an "AS IS" BASIS,
 9 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
10 | See the License for the specific language governing permissions and
11 | limitations under the License.
12 | -->
13 | 
14 | <!doctype html>
15 | <script type="module" src="entry.js"></script>
16 | 


--------------------------------------------------------------------------------
/tests/fixtures/module-worker/entry.js:
--------------------------------------------------------------------------------
 1 | /**
 2 |  * Copyright 2020 Google Inc. All Rights Reserved.
 3 |  * Licensed under the Apache License, Version 2.0 (the "License");
 4 |  * you may not use this file except in compliance with the License.
 5 |  * You may obtain a copy of the License at
 6 |  *     http://www.apache.org/licenses/LICENSE-2.0
 7 |  * Unless required by applicable law or agreed to in writing, software
 8 |  * distributed under the License is distributed on an "AS IS" BASIS,
 9 |  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
10 |  * See the License for the specific language governing permissions and
11 |  * limitations under the License.
12 |  */
13 | 
14 | import workerAPI from "comlink:./a.js";
15 | 
16 | (async function() {
17 |   const v = await workerAPI.f();
18 |   window.parent.postMessage(v);
19 | })();
20 | 


--------------------------------------------------------------------------------
/tests/fixtures/simple-bundle/entry.js:
--------------------------------------------------------------------------------
 1 | /**
 2 |  * Copyright 2020 Google Inc. All Rights Reserved.
 3 |  * Licensed under the Apache License, Version 2.0 (the "License");
 4 |  * you may not use this file except in compliance with the License.
 5 |  * You may obtain a copy of the License at
 6 |  *     http://www.apache.org/licenses/LICENSE-2.0
 7 |  * Unless required by applicable law or agreed to in writing, software
 8 |  * distributed under the License is distributed on an "AS IS" BASIS,
 9 |  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
10 |  * See the License for the specific language governing permissions and
11 |  * limitations under the License.
12 |  */
13 | 
14 | import workerAPI from "comlink:./a.js";
15 | 
16 | (async function() {
17 |   const v = await workerAPI.f();
18 |   window.parent.postMessage(v);
19 | })();
20 | 


--------------------------------------------------------------------------------
/tests/fixtures/destructuring/entry.js:
--------------------------------------------------------------------------------
 1 | /**
 2 |  * Copyright 2020 Google Inc. All Rights Reserved.
 3 |  * Licensed under the Apache License, Version 2.0 (the "License");
 4 |  * you may not use this file except in compliance with the License.
 5 |  * You may obtain a copy of the License at
 6 |  *     http://www.apache.org/licenses/LICENSE-2.0
 7 |  * Unless required by applicable law or agreed to in writing, software
 8 |  * distributed under the License is distributed on an "AS IS" BASIS,
 9 |  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
10 |  * See the License for the specific language governing permissions and
11 |  * limitations under the License.
12 |  */
13 | 
14 | import workerAPI from "comlink:./a.js";
15 | 
16 | (async function () {
17 |   const { f } = workerAPI;
18 |   const v = await f();
19 |   window.parent.postMessage(v);
20 | })();
21 | 


--------------------------------------------------------------------------------
/tests/fixtures/destructuring/rollup.config.js:
--------------------------------------------------------------------------------
 1 | /**
 2 |  * Copyright 2020 Google Inc. All Rights Reserved.
 3 |  * Licensed under the Apache License, Version 2.0 (the "License");
 4 |  * you may not use this file except in compliance with the License.
 5 |  * You may obtain a copy of the License at
 6 |  *     http://www.apache.org/licenses/LICENSE-2.0
 7 |  * Unless required by applicable law or agreed to in writing, software
 8 |  * distributed under the License is distributed on an "AS IS" BASIS,
 9 |  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
10 |  * See the License for the specific language governing permissions and
11 |  * limitations under the License.
12 |  */
13 | 
14 | const omt = require("@surma/rollup-plugin-off-main-thread");
15 | const comlink = require("../../../");
16 | const resolve = require("@rollup/plugin-node-resolve").nodeResolve;
17 | 
18 | module.exports = {
19 |   input: `${__dirname}/entry.js`,
20 |   output: {
21 |     dir: `${__dirname}/build`,
22 |     format: "amd",
23 |   },
24 |   plugins: [resolve(), comlink(), omt()],
25 | };
26 | 


--------------------------------------------------------------------------------
/tests/fixtures/simple-bundle/rollup.config.js:
--------------------------------------------------------------------------------
 1 | /**
 2 |  * Copyright 2020 Google Inc. All Rights Reserved.
 3 |  * Licensed under the Apache License, Version 2.0 (the "License");
 4 |  * you may not use this file except in compliance with the License.
 5 |  * You may obtain a copy of the License at
 6 |  *     http://www.apache.org/licenses/LICENSE-2.0
 7 |  * Unless required by applicable law or agreed to in writing, software
 8 |  * distributed under the License is distributed on an "AS IS" BASIS,
 9 |  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
10 |  * See the License for the specific language governing permissions and
11 |  * limitations under the License.
12 |  */
13 | 
14 | const omt = require("@surma/rollup-plugin-off-main-thread");
15 | const comlink = require("../../../");
16 | const resolve = require("@rollup/plugin-node-resolve").nodeResolve;
17 | 
18 | module.exports = {
19 |   input: `${__dirname}/entry.js`,
20 |   output: {
21 |     dir: `${__dirname}/build`,
22 |     format: "amd"
23 |   },
24 |   plugins: [resolve(), comlink(), omt()]
25 | };
26 | 


--------------------------------------------------------------------------------
/tests/fixtures/module-worker/rollup.config.js:
--------------------------------------------------------------------------------
 1 | /**
 2 |  * Copyright 2020 Google Inc. All Rights Reserved.
 3 |  * Licensed under the Apache License, Version 2.0 (the "License");
 4 |  * you may not use this file except in compliance with the License.
 5 |  * You may obtain a copy of the License at
 6 |  *     http://www.apache.org/licenses/LICENSE-2.0
 7 |  * Unless required by applicable law or agreed to in writing, software
 8 |  * distributed under the License is distributed on an "AS IS" BASIS,
 9 |  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
10 |  * See the License for the specific language governing permissions and
11 |  * limitations under the License.
12 |  */
13 | 
14 | const omt = require("@surma/rollup-plugin-off-main-thread");
15 | const comlink = require("../../../");
16 | const resolve = require("@rollup/plugin-node-resolve").nodeResolve;
17 | 
18 | module.exports = {
19 |   input: `${__dirname}/entry.js`,
20 |   output: {
21 |     dir: `${__dirname}/build`,
22 |     format: "esm"
23 |   },
24 |   plugins: [resolve(), comlink({ useModuleWorker: true }), omt()]
25 | };
26 | 


--------------------------------------------------------------------------------
/tests/simple-bundle.test.js:
--------------------------------------------------------------------------------
 1 | /**
 2 |  * Copyright 2018 Google Inc. All Rights Reserved.
 3 |  * Licensed under the Apache License, Version 2.0 (the "License");
 4 |  * you may not use this file except in compliance with the License.
 5 |  * You may obtain a copy of the License at
 6 |  *     http://www.apache.org/licenses/LICENSE-2.0
 7 |  * Unless required by applicable law or agreed to in writing, software
 8 |  * distributed under the License is distributed on an "AS IS" BASIS,
 9 |  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
10 |  * See the License for the specific language governing permissions and
11 |  * limitations under the License.
12 |  */
13 | 
14 | describe("Comlink plugin", function() {
15 |   beforeEach(function() {
16 |     this.ifr = document.createElement("iframe");
17 |     document.body.append(this.ifr);
18 |   });
19 | 
20 |   afterEach(function() {
21 |     this.ifr.remove();
22 |   });
23 | 
24 |   it("proxies workers", function(done) {
25 |     window.addEventListener("message", function l(ev) {
26 |       if (ev.data === "a") {
27 |         window.removeEventListener("message", l);
28 |         done();
29 |       }
30 |     });
31 |     this.ifr.src = "/base/tests/fixtures/simple-bundle/build/runner.html";
32 |   });
33 | });
34 | 


--------------------------------------------------------------------------------
/tests/destructuring.test.js:
--------------------------------------------------------------------------------
 1 | /**
 2 |  * Copyright 2018 Google Inc. All Rights Reserved.
 3 |  * Licensed under the Apache License, Version 2.0 (the "License");
 4 |  * you may not use this file except in compliance with the License.
 5 |  * You may obtain a copy of the License at
 6 |  *     http://www.apache.org/licenses/LICENSE-2.0
 7 |  * Unless required by applicable law or agreed to in writing, software
 8 |  * distributed under the License is distributed on an "AS IS" BASIS,
 9 |  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
10 |  * See the License for the specific language governing permissions and
11 |  * limitations under the License.
12 |  */
13 | 
14 | describe("Comlink plugin", function () {
15 |   beforeEach(function () {
16 |     this.ifr = document.createElement("iframe");
17 |     document.body.append(this.ifr);
18 |   });
19 | 
20 |   afterEach(function () {
21 |     this.ifr.remove();
22 |   });
23 | 
24 |   it("can destructure exports", function (done) {
25 |     window.addEventListener("message", function l(ev) {
26 |       if (ev.data === "a") {
27 |         window.removeEventListener("message", l);
28 |         done();
29 |       }
30 |     });
31 |     this.ifr.src = "/base/tests/fixtures/destructuring/build/runner.html";
32 |   });
33 | });
34 | 


--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "@surma/rollup-plugin-comlink",
 3 |   "version": "0.4.0",
 4 |   "private": false,
 5 |   "description": "Use workers seamlessly",
 6 |   "main": "index.js",
 7 |   "scripts": {
 8 |     "test": "node ./run_tests.js"
 9 |   },
10 |   "author": "Surma <surma@google.com>",
11 |   "license": "Apache-2.0",
12 |   "devDependencies": {
13 |     "@rollup/plugin-node-resolve": "^9.0.0",
14 |     "@surma/rollup-plugin-off-main-thread": "2.2.2",
15 |     "chai": "4.2.0",
16 |     "comlink": "^4.3.0",
17 |     "husky": "^4.3.0",
18 |     "karma": "^5.2.2",
19 |     "karma-chai": "0.1.0",
20 |     "karma-chrome-launcher": "^3.1.0",
21 |     "karma-firefox-launcher": "^1.3.0",
22 |     "karma-mocha": "^2.0.1",
23 |     "karma-safari-launcher": "1.0.0",
24 |     "karma-safaritechpreview-launcher": "2.0.2",
25 |     "lint-staged": "^10.4.0",
26 |     "mocha": "^8.1.3",
27 |     "prettier": "^2.1.2",
28 |     "rollup": "^2.28.2"
29 |   },
30 |   "repository": {
31 |     "type": "git",
32 |     "url": "https://github.com/surma/rollup-plugin-comlink"
33 |   },
34 |   "peerDependencies": {
35 |     "@surma/rollup-plugin-off-main-thread": ">=2",
36 |     "comlink": ">=4"
37 |   },
38 |   "husky": {
39 |     "hooks": {
40 |       "pre-commit": "lint-staged"
41 |     }
42 |   },
43 |   "lint-staged": {
44 |     "*.{js,css,md}": "prettier --write"
45 |   }
46 | }
47 | 


--------------------------------------------------------------------------------
/karma.conf.js:
--------------------------------------------------------------------------------
 1 | /**
 2 |  * Copyright 2018 Google Inc. All Rights Reserved.
 3 |  * Licensed under the Apache License, Version 2.0 (the "License");
 4 |  * you may not use this file except in compliance with the License.
 5 |  * You may obtain a copy of the License at
 6 |  *     http://www.apache.org/licenses/LICENSE-2.0
 7 |  * Unless required by applicable law or agreed to in writing, software
 8 |  * distributed under the License is distributed on an "AS IS" BASIS,
 9 |  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
10 |  * See the License for the specific language governing permissions and
11 |  * limitations under the License.
12 |  */
13 | 
14 | module.exports = function(config) {
15 |   const configuration = {
16 |     basePath: "",
17 |     frameworks: ["mocha", "chai"],
18 |     files: [
19 |       {
20 |         pattern: "tests/fixtures/**",
21 |         included: false
22 |       },
23 |       {
24 |         pattern: "tests/*.test.js"
25 |       }
26 |     ],
27 |     reporters: ["progress"],
28 |     port: 9876,
29 |     colors: true,
30 |     logLevel: config.LOG_INFO,
31 |     autoWatch: true,
32 |     singleRun: true,
33 |     concurrency: 1,
34 |     browsers: ["Chrome", "Firefox", "Safari"],
35 |     customLaunchers: {
36 |       DockerChrome: {
37 |         base: "ChromeHeadless",
38 |         flags: ["--no-sandbox"]
39 |       }
40 |     }
41 |   };
42 | 
43 |   if (process.env.INSIDE_DOCKER) configuration.browsers = ["DockerChrome"];
44 | 
45 |   config.set(configuration);
46 | };
47 | 


--------------------------------------------------------------------------------
/CONTRIBUTING:
--------------------------------------------------------------------------------
 1 | Want to contribute? Great! First, read this page (including the small print at the end).
 2 | 
 3 | ### Before you contribute
 4 | Before we can use your code, you must sign the
 5 | [Google Individual Contributor License Agreement]
 6 | (https://cla.developers.google.com/about/google-individual)
 7 | (CLA), which you can do online. The CLA is necessary mainly because you own the
 8 | copyright to your changes, even after your contribution becomes part of our
 9 | codebase, so we need your permission to use and distribute your code. We also
10 | need to be sure of various other things—for instance that you'll tell us if you
11 | know that your code infringes on other people's patents. You don't have to sign
12 | the CLA until after you've submitted your code for review and a member has
13 | approved it, but you must do it before we can put your code into our codebase.
14 | Before you start working on a larger contribution, you should get in touch with
15 | us first through the issue tracker with your idea so that we can help out and
16 | possibly guide you. Coordinating up front makes it much easier to avoid
17 | frustration later on.
18 | 
19 | ### Code reviews
20 | All submissions, including submissions by project members, require review. We
21 | use Github pull requests for this purpose.
22 | 
23 | ### The small print
24 | Contributions made by corporations are covered by a different agreement than
25 | the one above, the
26 | [Software Grant and Corporate Contributor License Agreement]
27 | (https://cla.developers.google.com/about/google-corporate).
28 | 


--------------------------------------------------------------------------------
/tests/module-worker.test.js:
--------------------------------------------------------------------------------
 1 | /**
 2 |  * Copyright 2018 Google Inc. All Rights Reserved.
 3 |  * Licensed under the Apache License, Version 2.0 (the "License");
 4 |  * you may not use this file except in compliance with the License.
 5 |  * You may obtain a copy of the License at
 6 |  *     http://www.apache.org/licenses/LICENSE-2.0
 7 |  * Unless required by applicable law or agreed to in writing, software
 8 |  * distributed under the License is distributed on an "AS IS" BASIS,
 9 |  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
10 |  * See the License for the specific language governing permissions and
11 |  * limitations under the License.
12 |  */
13 | 
14 | function jsBlobFromString(s) {
15 |   return URL.createObjectURL(new Blob([s], { type: "text/javascript" }));
16 | }
17 | 
18 | // If `new Worker()` checks the `type` prop on the options object
19 | // we can be fairly sure that the browser supports module workers.
20 | // If so, replace we can switch `maybeIt` from ignoring tests (`xit`)
21 | // to actually running the tests (`it`).
22 | let maybeIt = xit;
23 | let wasRead = false;
24 | const detector = {
25 |   get type() {
26 |     wasRead = true;
27 |     return "module";
28 |   }
29 | };
30 | new Worker(jsBlobFromString("export default 4"), detector).terminate();
31 | if (wasRead) {
32 |   maybeIt = it;
33 | }
34 | 
35 | describe("Comlink plugin", function() {
36 |   beforeEach(function() {
37 |     this.ifr = document.createElement("iframe");
38 |     document.body.append(this.ifr);
39 |   });
40 | 
41 |   afterEach(function() {
42 |     this.ifr.remove();
43 |   });
44 | 
45 |   maybeIt("proxies module workers", function(done) {
46 |     window.addEventListener("message", function l(ev) {
47 |       if (ev.data === "a") {
48 |         window.removeEventListener("message", l);
49 |         done();
50 |       }
51 |     });
52 |     this.ifr.src = "/base/tests/fixtures/module-worker/build/runner.html";
53 |   });
54 | });
55 | 


--------------------------------------------------------------------------------
/run_tests.js:
--------------------------------------------------------------------------------
 1 | /**
 2 |  * Copyright 2018 Google Inc. All Rights Reserved.
 3 |  * Licensed under the Apache License, Version 2.0 (the "License");
 4 |  * you may not use this file except in compliance with the License.
 5 |  * You may obtain a copy of the License at
 6 |  *     http://www.apache.org/licenses/LICENSE-2.0
 7 |  * Unless required by applicable law or agreed to in writing, software
 8 |  * distributed under the License is distributed on an "AS IS" BASIS,
 9 |  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
10 |  * See the License for the specific language governing permissions and
11 |  * limitations under the License.
12 |  */
13 | 
14 | const rollup = require("rollup");
15 | const path = require("path");
16 | const omt = require(".");
17 | const fs = require("fs");
18 | 
19 | const karma = require("karma");
20 | const myKarmaConfig = require("./karma.conf.js");
21 | 
22 | async function fileExists(file) {
23 |   try {
24 |     const stat = await fs.promises.stat(file);
25 |     return stat.isFile();
26 |   } catch (e) {
27 |     return false;
28 |   }
29 | }
30 | 
31 | async function init() {
32 |   await Promise.all(
33 |     [
34 |       "./tests/fixtures/simple-bundle/entry.js",
35 |       "./tests/fixtures/module-worker/entry.js",
36 |       "./tests/fixtures/destructuring/entry.js"
37 |     ].map(async input => {
38 |       const pathName = path.dirname(input);
39 |       const outputOptions = {
40 |         dir: path.join(pathName, "build"),
41 |         format: "es"
42 |       };
43 |       const rollupConfigPath = "./" + path.join(pathName, "rollup.config.js");
44 |       let rollupConfig = require(rollupConfigPath);
45 |       const bundle = await rollup.rollup(rollupConfig);
46 |       await bundle.write(rollupConfig.output);
47 |     })
48 |   );
49 | 
50 |   const karmaConfig = { port: 9876 };
51 |   myKarmaConfig({
52 |     set(config) {
53 |       Object.assign(karmaConfig, config);
54 |     }
55 |   });
56 |   const server = new karma.Server(karmaConfig, code => {
57 |     console.log(`Karma exited with code ${code}`);
58 |     process.exit(code);
59 |   });
60 |   server.start();
61 | }
62 | init();
63 | 


--------------------------------------------------------------------------------
/index.js:
--------------------------------------------------------------------------------
 1 | /**
 2 |  * Copyright 2020 Google Inc. All Rights Reserved.
 3 |  * Licensed under the Apache License, Version 2.0 (the "License");
 4 |  * you may not use this file except in compliance with the License.
 5 |  * You may obtain a copy of the License at
 6 |  *     http://www.apache.org/licenses/LICENSE-2.0
 7 |  * Unless required by applicable law or agreed to in writing, software
 8 |  * distributed under the License is distributed on an "AS IS" BASIS,
 9 |  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
10 |  * See the License for the specific language governing permissions and
11 |  * limitations under the License.
12 |  */
13 | 
14 | const { readFileSync } = require("fs");
15 | const { join } = require("path");
16 | 
17 | const defaultOpts = {
18 |   marker: "comlink",
19 |   useModuleWorker: false,
20 | };
21 | 
22 | function generateLoaderModule(path, { useModuleWorker = false } = {}) {
23 |   return `
24 | 		import workerPath from ${JSON.stringify(`omt:${path}`)};
25 | 		import {wrap} from "comlink";
26 | 
27 | 		export default wrap(new Worker(new URL(workerPath, import.meta.url)${
28 |       useModuleWorker ? `, {type: "module"}` : ""
29 |     }));
30 | 	`;
31 | }
32 | 
33 | function generateWorkerWrapper(path) {
34 |   return `
35 | 		import * as m from ${JSON.stringify(path)};
36 | 		import {expose} from "comlink";
37 | 
38 | 		expose(m);
39 | 	`;
40 | }
41 | 
42 | module.exports = function (opts = {}) {
43 |   opts = Object.assign({}, defaultOpts, opts);
44 | 
45 |   const prefix = opts.marker + ":";
46 |   const suffix = "?" + opts.marker;
47 | 
48 |   return {
49 |     name: "comlink",
50 | 
51 |     async resolveId(id, importer) {
52 |       if (!id.startsWith(prefix)) return;
53 | 
54 |       const path = id.slice(prefix.length);
55 |       const newId = (await this.resolve(path, importer)).id;
56 | 
57 |       if (!newId) throw Error(`Cannot find module '${path}'`);
58 | 
59 |       return prefix + newId;
60 |     },
61 | 
62 |     outputOptions({ format }) {
63 |       if ((format === "esm" || format === "es") && !opts.useModuleWorker) {
64 |         this.error(
65 |           `Can only use {format: "${format}"} with {useModuleWorker: true}`
66 |         );
67 |         return;
68 |       }
69 |       if (format === "amd" && opts.useModuleWorker) {
70 |         this.error(
71 |           `Can only use {useModuleWorker: true} with {format: "${format}"}`
72 |         );
73 |         return;
74 |       }
75 |       if (format !== "amd" && format !== "esm" && format != "es") {
76 |         this.error(
77 |           "Output format MUST be `amd`. `esm` is also allowed, but has very little browser support."
78 |         );
79 |         return;
80 |       }
81 |     },
82 | 
83 |     load(id) {
84 |       if (id.endsWith(suffix) && !id.startsWith("omt:")) {
85 |         const wrapper = generateWorkerWrapper(id.slice(0, -suffix.length));
86 |         return wrapper;
87 |       }
88 |       if (!id.startsWith(prefix)) return;
89 | 
90 |       const realId = id.slice(prefix.length) + suffix;
91 |       const loader = generateLoaderModule(realId, opts);
92 |       return loader;
93 |     },
94 |   };
95 | };
96 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | # rollup-plugin-comlink
  2 | 
  3 | Use workers seamlessly
  4 | 
  5 | Workers are JavaScript’s version of threads. [Workers are important to use][when workers] as the main thread is already overloaded, especially on slower or older devices.
  6 | 
  7 | [`@surma/rollup-plugin-off-main-thread`][omt plugin] teaches Rollup about Workers. This plugin makes their use seamless using [Comlink].
  8 | 
  9 | ## Usage
 10 | 
 11 | To avoid having to make new releases of this plugin with every release of [Comlink] or my [OMT plugin], both of these modules have been declared as peer dependencies. This means you will have to explicitely add them to your dependency list:
 12 | 
 13 | ```
 14 | $ npm install --save @surma/rollup-plugin-comlink @surma/rollup-plugin-off-main-thread comlink
 15 | ```
 16 | 
 17 | ### Config
 18 | 
 19 | ```js
 20 | // rollup.config.js
 21 | import comlink from "@surma/rollup-plugin-comlink";
 22 | import omt from "@surma/rollup-plugin-off-main-thread";
 23 | 
 24 | export default {
 25 |   input: ["src/main.js"],
 26 |   output: {
 27 |     dir: "dist",
 28 |     // You _must_ use either “amd” or “esm” as your format.
 29 |     // But note that only very few browsers have native support for
 30 |     // modules in workers.
 31 |     format: "amd",
 32 |   },
 33 |   plugins: [comlink(), omt()],
 34 | };
 35 | ```
 36 | 
 37 | ### Example
 38 | 
 39 | ```js
 40 | // worker.js
 41 | export function doMath(a, b) {
 42 |   return a + b;
 43 | }
 44 | ```
 45 | 
 46 | > **Note:** Importing individual exports currently does _not_ work. `comlink:` modules only have one default export.
 47 | 
 48 | ```js
 49 | // main.js
 50 | 
 51 | import workerAPI from "comlink:./worker.js";
 52 | 
 53 | (async function () {
 54 |   const result = await workerAPI.doMath(40, 2);
 55 |   console.assert(result == 42);
 56 | })();
 57 | ```
 58 | 
 59 | ### Options
 60 | 
 61 | ```js
 62 | {
 63 |   // ...
 64 |   plugins: [comlink(options), omt()];
 65 | }
 66 | ```
 67 | 
 68 | - `marker`: A string that is used as a prefix to mark a worker import. Default is `comlink`.
 69 | - `useModuleWorkers`: Use module workers (requires `{format: "esm"}`).
 70 | 
 71 | ## TypeScript
 72 | 
 73 | TypeScript can be taught to handle these pseudo-imports correctly and forward the types appropriately.
 74 | 
 75 | ```ts
 76 | // main.ts
 77 | import workerAPI from "comlink:./worker.js";
 78 | 
 79 | console.log(await workerAPI.sayHello("surma"));
 80 | // This would fail to compile:
 81 | // console.log(await workerAPI.doesNotExit("surma"));
 82 | ```
 83 | 
 84 | ```ts
 85 | // worker.ts
 86 | export function sayHello(name: string): string {
 87 |   return `Hello ${name}!`;
 88 | }
 89 | ```
 90 | 
 91 | ```ts
 92 | // worker-modules.d.ts
 93 | declare module "comlink:./worker.js" {
 94 |   // Do *not* move this to a top-level import, as it will turn this
 95 |   // .d.ts file from an ambient module into a local module.
 96 |   const wrap: import("comlink").Remote<typeof import("./worker.js")>;
 97 |   export default wrap;
 98 | }
 99 | ```
100 | 
101 | ---
102 | 
103 | License Apache-2.0
104 | 
105 | [when workers]: https://surma.dev/things/when-workers
106 | [comlink]: https://github.com/GoogleChromeLabs/comlink
107 | [omt plugin]: https://github.com/surma/rollup-plugin-off-main-thread
108 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 | 
  2 |                                  Apache License
  3 |                            Version 2.0, January 2004
  4 |                         http://www.apache.org/licenses/
  5 | 
  6 |    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
  7 | 
  8 |    1. Definitions.
  9 | 
 10 |       "License" shall mean the terms and conditions for use, reproduction,
 11 |       and distribution as defined by Sections 1 through 9 of this document.
 12 | 
 13 |       "Licensor" shall mean the copyright owner or entity authorized by
 14 |       the copyright owner that is granting the License.
 15 | 
 16 |       "Legal Entity" shall mean the union of the acting entity and all
 17 |       other entities that control, are controlled by, or are under common
 18 |       control with that entity. For the purposes of this definition,
 19 |       "control" means (i) the power, direct or indirect, to cause the
 20 |       direction or management of such entity, whether by contract or
 21 |       otherwise, or (ii) ownership of fifty percent (50%) or more of the
 22 |       outstanding shares, or (iii) beneficial ownership of such entity.
 23 | 
 24 |       "You" (or "Your") shall mean an individual or Legal Entity
 25 |       exercising permissions granted by this License.
 26 | 
 27 |       "Source" form shall mean the preferred form for making modifications,
 28 |       including but not limited to software source code, documentation
 29 |       source, and configuration files.
 30 | 
 31 |       "Object" form shall mean any form resulting from mechanical
 32 |       transformation or translation of a Source form, including but
 33 |       not limited to compiled object code, generated documentation,
 34 |       and conversions to other media types.
 35 | 
 36 |       "Work" shall mean the work of authorship, whether in Source or
 37 |       Object form, made available under the License, as indicated by a
 38 |       copyright notice that is included in or attached to the work
 39 |       (an example is provided in the Appendix below).
 40 | 
 41 |       "Derivative Works" shall mean any work, whether in Source or Object
 42 |       form, that is based on (or derived from) the Work and for which the
 43 |       editorial revisions, annotations, elaborations, or other modifications
 44 |       represent, as a whole, an original work of authorship. For the purposes
 45 |       of this License, Derivative Works shall not include works that remain
 46 |       separable from, or merely link (or bind by name) to the interfaces of,
 47 |       the Work and Derivative Works thereof.
 48 | 
 49 |       "Contribution" shall mean any work of authorship, including
 50 |       the original version of the Work and any modifications or additions
 51 |       to that Work or Derivative Works thereof, that is intentionally
 52 |       submitted to Licensor for inclusion in the Work by the copyright owner
 53 |       or by an individual or Legal Entity authorized to submit on behalf of
 54 |       the copyright owner. For the purposes of this definition, "submitted"
 55 |       means any form of electronic, verbal, or written communication sent
 56 |       to the Licensor or its representatives, including but not limited to
 57 |       communication on electronic mailing lists, source code control systems,
 58 |       and issue tracking systems that are managed by, or on behalf of, the
 59 |       Licensor for the purpose of discussing and improving the Work, but
 60 |       excluding communication that is conspicuously marked or otherwise
 61 |       designated in writing by the copyright owner as "Not a Contribution."
 62 | 
 63 |       "Contributor" shall mean Licensor and any individual or Legal Entity
 64 |       on behalf of whom a Contribution has been received by Licensor and
 65 |       subsequently incorporated within the Work.
 66 | 
 67 |    2. Grant of Copyright License. Subject to the terms and conditions of
 68 |       this License, each Contributor hereby grants to You a perpetual,
 69 |       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 70 |       copyright license to reproduce, prepare Derivative Works of,
 71 |       publicly display, publicly perform, sublicense, and distribute the
 72 |       Work and such Derivative Works in Source or Object form.
 73 | 
 74 |    3. Grant of Patent License. Subject to the terms and conditions of
 75 |       this License, each Contributor hereby grants to You a perpetual,
 76 |       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 77 |       (except as stated in this section) patent license to make, have made,
 78 |       use, offer to sell, sell, import, and otherwise transfer the Work,
 79 |       where such license applies only to those patent claims licensable
 80 |       by such Contributor that are necessarily infringed by their
 81 |       Contribution(s) alone or by combination of their Contribution(s)
 82 |       with the Work to which such Contribution(s) was submitted. If You
 83 |       institute patent litigation against any entity (including a
 84 |       cross-claim or counterclaim in a lawsuit) alleging that the Work
 85 |       or a Contribution incorporated within the Work constitutes direct
 86 |       or contributory patent infringement, then any patent licenses
 87 |       granted to You under this License for that Work shall terminate
 88 |       as of the date such litigation is filed.
 89 | 
 90 |    4. Redistribution. You may reproduce and distribute copies of the
 91 |       Work or Derivative Works thereof in any medium, with or without
 92 |       modifications, and in Source or Object form, provided that You
 93 |       meet the following conditions:
 94 | 
 95 |       (a) You must give any other recipients of the Work or
 96 |           Derivative Works a copy of this License; and
 97 | 
 98 |       (b) You must cause any modified files to carry prominent notices
 99 |           stating that You changed the files; and
100 | 
101 |       (c) You must retain, in the Source form of any Derivative Works
102 |           that You distribute, all copyright, patent, trademark, and
103 |           attribution notices from the Source form of the Work,
104 |           excluding those notices that do not pertain to any part of
105 |           the Derivative Works; and
106 | 
107 |       (d) If the Work includes a "NOTICE" text file as part of its
108 |           distribution, then any Derivative Works that You distribute must
109 |           include a readable copy of the attribution notices contained
110 |           within such NOTICE file, excluding those notices that do not
111 |           pertain to any part of the Derivative Works, in at least one
112 |           of the following places: within a NOTICE text file distributed
113 |           as part of the Derivative Works; within the Source form or
114 |           documentation, if provided along with the Derivative Works; or,
115 |           within a display generated by the Derivative Works, if and
116 |           wherever such third-party notices normally appear. The contents
117 |           of the NOTICE file are for informational purposes only and
118 |           do not modify the License. You may add Your own attribution
119 |           notices within Derivative Works that You distribute, alongside
120 |           or as an addendum to the NOTICE text from the Work, provided
121 |           that such additional attribution notices cannot be construed
122 |           as modifying the License.
123 | 
124 |       You may add Your own copyright statement to Your modifications and
125 |       may provide additional or different license terms and conditions
126 |       for use, reproduction, or distribution of Your modifications, or
127 |       for any such Derivative Works as a whole, provided Your use,
128 |       reproduction, and distribution of the Work otherwise complies with
129 |       the conditions stated in this License.
130 | 
131 |    5. Submission of Contributions. Unless You explicitly state otherwise,
132 |       any Contribution intentionally submitted for inclusion in the Work
133 |       by You to the Licensor shall be under the terms and conditions of
134 |       this License, without any additional terms or conditions.
135 |       Notwithstanding the above, nothing herein shall supersede or modify
136 |       the terms of any separate license agreement you may have executed
137 |       with Licensor regarding such Contributions.
138 | 
139 |    6. Trademarks. This License does not grant permission to use the trade
140 |       names, trademarks, service marks, or product names of the Licensor,
141 |       except as required for reasonable and customary use in describing the
142 |       origin of the Work and reproducing the content of the NOTICE file.
143 | 
144 |    7. Disclaimer of Warranty. Unless required by applicable law or
145 |       agreed to in writing, Licensor provides the Work (and each
146 |       Contributor provides its Contributions) on an "AS IS" BASIS,
147 |       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148 |       implied, including, without limitation, any warranties or conditions
149 |       of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150 |       PARTICULAR PURPOSE. You are solely responsible for determining the
151 |       appropriateness of using or redistributing the Work and assume any
152 |       risks associated with Your exercise of permissions under this License.
153 | 
154 |    8. Limitation of Liability. In no event and under no legal theory,
155 |       whether in tort (including negligence), contract, or otherwise,
156 |       unless required by applicable law (such as deliberate and grossly
157 |       negligent acts) or agreed to in writing, shall any Contributor be
158 |       liable to You for damages, including any direct, indirect, special,
159 |       incidental, or consequential damages of any character arising as a
160 |       result of this License or out of the use or inability to use the
161 |       Work (including but not limited to damages for loss of goodwill,
162 |       work stoppage, computer failure or malfunction, or any and all
163 |       other commercial damages or losses), even if such Contributor
164 |       has been advised of the possibility of such damages.
165 | 
166 |    9. Accepting Warranty or Additional Liability. While redistributing
167 |       the Work or Derivative Works thereof, You may choose to offer,
168 |       and charge a fee for, acceptance of support, warranty, indemnity,
169 |       or other liability obligations and/or rights consistent with this
170 |       License. However, in accepting such obligations, You may act only
171 |       on Your own behalf and on Your sole responsibility, not on behalf
172 |       of any other Contributor, and only if You agree to indemnify,
173 |       defend, and hold each Contributor harmless for any liability
174 |       incurred by, or claims asserted against, such Contributor by reason
175 |       of your accepting any such warranty or additional liability.
176 | 
177 |    END OF TERMS AND CONDITIONS
178 | 
179 |    APPENDIX: How to apply the Apache License to your work.
180 | 
181 |       To apply the Apache License to your work, attach the following
182 |       boilerplate notice, with the fields enclosed by brackets "[]"
183 |       replaced with your own identifying information. (Don't include
184 |       the brackets!)  The text should be enclosed in the appropriate
185 |       comment syntax for the file format. We also recommend that a
186 |       file or class name and description of purpose be included on the
187 |       same "printed page" as the copyright notice for easier
188 |       identification within third-party archives.
189 | 
190 |    Copyright 2018 Google Inc.
191 | 
192 |    Licensed under the Apache License, Version 2.0 (the "License");
193 |    you may not use this file except in compliance with the License.
194 |    You may obtain a copy of the License at
195 | 
196 |        http://www.apache.org/licenses/LICENSE-2.0
197 | 
198 |    Unless required by applicable law or agreed to in writing, software
199 |    distributed under the License is distributed on an "AS IS" BASIS,
200 |    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201 |    See the License for the specific language governing permissions and
202 |    limitations under the License.
203 | 


--------------------------------------------------------------------------------