From 45e0f26c8bf0e49040711a04f0336b79e7bb581e Mon Sep 17 00:00:00 2001 From: Timothy Farrell Date: Fri, 23 Dec 2016 09:46:17 -0600 Subject: [PATCH] Initial commit. --- packages/portal/.editorconfig | 15 ++++ packages/portal/.eslintrc | 25 ++++++ packages/portal/.gitattributes | 1 + packages/portal/.gitignore | 2 + packages/portal/LICENSE.md | 135 +++++++++++++++++++++++++++++++ packages/portal/README.md | 8 ++ packages/portal/package.json | 41 ++++++++++ packages/portal/rollup.config.js | 19 +++++ packages/portal/src/index.js | 111 +++++++++++++++++++++++++ 9 files changed, 357 insertions(+) create mode 100644 packages/portal/.editorconfig create mode 100644 packages/portal/.eslintrc create mode 100644 packages/portal/.gitattributes create mode 100644 packages/portal/.gitignore create mode 100644 packages/portal/LICENSE.md create mode 100644 packages/portal/README.md create mode 100644 packages/portal/package.json create mode 100644 packages/portal/rollup.config.js create mode 100644 packages/portal/src/index.js diff --git a/packages/portal/.editorconfig b/packages/portal/.editorconfig new file mode 100644 index 0000000..86c8f59 --- /dev/null +++ b/packages/portal/.editorconfig @@ -0,0 +1,15 @@ +root = true + +[*] +indent_style = tab +end_of_line = lf +charset = utf-8 +trim_trailing_whitespace = true +insert_final_newline = true + +[package.json] +indent_style = space +indent_size = 2 + +[*.md] +trim_trailing_whitespace = false diff --git a/packages/portal/.eslintrc b/packages/portal/.eslintrc new file mode 100644 index 0000000..5bbdb80 --- /dev/null +++ b/packages/portal/.eslintrc @@ -0,0 +1,25 @@ +{ + 'parser': 'babel-eslint', + 'rules': { + 'linebreak-style': [2, 'unix'], + 'semi': [2, 'always'], + 'no-console': 0, + 'no-mixed-spaces-and-tabs': 2, + 'indent': [2, 4], + 'quotes': [2, 'single'], + 'quote-props': [2, 'consistent-as-needed'], + 'no-underscore-dangle': 0, + 'arrow-body-style': 0, + }, + 'env': { + 'es6': false, + 'browser': true + }, + 'presets': [ + 'es2015' + ], + 'plugins': [ + ], + 'whitelist': [ + ] +} diff --git a/packages/portal/.gitattributes b/packages/portal/.gitattributes new file mode 100644 index 0000000..176a458 --- /dev/null +++ b/packages/portal/.gitattributes @@ -0,0 +1 @@ +* text=auto diff --git a/packages/portal/.gitignore b/packages/portal/.gitignore new file mode 100644 index 0000000..f06235c --- /dev/null +++ b/packages/portal/.gitignore @@ -0,0 +1,2 @@ +node_modules +dist diff --git a/packages/portal/LICENSE.md b/packages/portal/LICENSE.md new file mode 100644 index 0000000..6816135 --- /dev/null +++ b/packages/portal/LICENSE.md @@ -0,0 +1,135 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, and distribution as defined + by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is + granting the License. + + "Legal Entity" shall mean the union of the acting entity and all other entities that control, are + controlled by, or are under common control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the direction or management of such + entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this + License. + + "Source" form shall mean the preferred form for making modifications, including but not limited + to software source code, documentation source, and configuration files. + + "Object" form shall mean any form resulting from mechanical transformation or translation of a + Source form, including but not limited to compiled object code, generated documentation, and + conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or Object form, made available under + the License, as indicated by a copyright notice that is included in or attached to the work (an + example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or + derived from) the Work and for which the editorial revisions, annotations, elaborations, or other + modifications represent, as a whole, an original work of authorship. For the purposes of this + License, Derivative Works shall not include works that remain separable from, or merely link (or + bind by name) to the interfaces of, the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including the original version of the Work and + any modifications or additions to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or + Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this + definition, "submitted" means any form of electronic, verbal, or written communication sent to + the Licensor or its representatives, including but not limited to communication on electronic + mailing lists, source code control systems, and issue tracking systems that are managed by, or on + behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding + communication that is conspicuously marked or otherwise designated in writing by the copyright + owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a + Contribution has been received by Licensor and subsequently incorporated within the Work. + +2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor + hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, + sublicense, and distribute the Work and such Derivative Works in Source or Object form. + +3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor + hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, use, offer to sell, sell, + import, and otherwise transfer the Work, where such license applies only to those patent claims + licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or + by combination of their Contribution(s) with the Work to which such Contribution(s) was + submitted. If You institute patent litigation against any entity (including a cross-claim or + counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work + constitutes direct or contributory patent infringement, then any patent licenses granted to You + under this License for that Work shall terminate as of the date such litigation is filed. + +4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof + in any medium, with or without modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or Derivative Works a copy of this License; + and + + (b) You must cause any modified files to carry prominent notices stating that You changed the + files; and + + (c) You must retain, in the Source form of any Derivative Works that You distribute, all + copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding + those notices that do not pertain to any part of the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative + Works that You distribute must include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not pertain to any part of the + Derivative Works, in at least one of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or documentation, if provided along with + the Derivative Works; or, within a display generated by the Derivative Works, if and wherever + such third-party notices normally appear. The contents of the NOTICE file are for informational + purposes only and do not modify the License. You may add Your own attribution notices within + Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the + Work, provided that such additional attribution notices cannot be construed as modifying the + License. + + You may add Your own copyright statement to Your modifications and may provide additional or + different license terms and conditions for use, reproduction, or distribution of Your + modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and + distribution of the Work otherwise complies with the conditions stated in this License. + +5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution + intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms + and conditions of this License, without any additional terms or conditions. Notwithstanding the + above, nothing herein shall supersede or modify the terms of any separate license agreement you + may have executed with Licensor regarding such Contributions. + +6. Trademarks. This License does not grant permission to use the trade names, trademarks, service + marks, or product names of the Licensor, except as required for reasonable and customary use in + describing the origin of the Work and reproducing the content of the NOTICE file. + +7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor + provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT + WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, + any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or + redistributing the Work and assume any risks associated with Your exercise of permissions under + this License. + +8. Limitation of Liability. In no event and under no legal theory, whether in tort (including + negligence), contract, or otherwise, unless required by applicable law (such as deliberate and + grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for + damages, including any direct, indirect, special, incidental, or consequential damages of any + character arising as a result of this License or out of the use or inability to use the Work + (including but not limited to damages for loss of goodwill, work stoppage, computer failure or + malfunction, or any and all other commercial damages or losses), even if such Contributor has + been advised of the possibility of such damages. + +9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works + thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, + indemnity, or other liability obligations and/or rights consistent with this License. However, in + accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, + not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each + Contributor harmless for any liability incurred by, or claims asserted against, such Contributor + by reason of your accepting any such warranty or additional liability. diff --git a/packages/portal/README.md b/packages/portal/README.md new file mode 100644 index 0000000..d351c41 --- /dev/null +++ b/packages/portal/README.md @@ -0,0 +1,8 @@ +# [Portal](https://gitlab.com/explorigin/portal) + +Portal is an tool to expose an API between Javascript contexts. For example, WebWorkers and the DOM +thread can expose methods to each other. + +## Credit + +Created by [Timothy Farrell](https://github.com/explorigin) diff --git a/packages/portal/package.json b/packages/portal/package.json new file mode 100644 index 0000000..9c6f5f0 --- /dev/null +++ b/packages/portal/package.json @@ -0,0 +1,41 @@ +{ + "name": "worker-portal", + "version": "0.6.0", + "description": "Expose an API to a Web Worker", + "main": "src/index.js", + "jsnext:main": "src/index.js", + "files": ["dist", "src"], + "scripts": { + "lint": "eslint src", + "clean": "rimraf dist", + "build:umd": "NODE_ENV=production rollup -c", + "build:umd:min": + "npm run build:umd && uglifyjs -m --screw-ie8 -c -o dist/worker-portal.min.js dist/worker-portal.js", + "build:umd:gzip": + "npm run build:umd:min && gzip -c9 dist/worker-portal.min.js > dist/worker-portal.min.js.gz", + "build": "npm run build:umd:gzip && ls -l dist/", + "prepublish": "npm run clean && npm run build" + }, + "repository": { + "type": "git", + "url": "https://gitlab.com/explorigin/worker-portal.git" + }, + "keywords": ["javascript", "worker", "webworker", "promise"], + "author": "Timothy Farrell (https://github.com/explorigin)", + "license": "Apache 2.0", + "bugs": { + "url": "https://gitlab.com/explorigin/worker-portal/issues" + }, + "homepage": "https://gitlab.com/explorigin/worker-portal", + "devDependencies": { + "babel-eslint": "^7.1.1", + "babel-preset-es2015-rollup": "^3.0.0", + "eslint": "3.2.0", + "eslint-plugin-flow-vars": "0.5.0", + "eslint-plugin-flowtype": "2.4.0", + "rimraf": "2.5.2", + "rollup-plugin-babel": "^2.7.1", + "rollup-plugin-json": "2.0.1", + "uglifyjs": "2.4.10" + } +} diff --git a/packages/portal/rollup.config.js b/packages/portal/rollup.config.js new file mode 100644 index 0000000..33475fb --- /dev/null +++ b/packages/portal/rollup.config.js @@ -0,0 +1,19 @@ +import json from 'rollup-plugin-json'; +import babel from 'rollup-plugin-babel'; + +const babelConfig = { + env: { + es6: true, + browser: true + }, + plugins: [], + presets: ['es2015-rollup'] +}; + +export default { + entry: 'src/index.js', + format: 'umd', + moduleName: 'WorkerPortal', + plugins: [json(), babel(babelConfig)], + dest: 'dist/worker-portal.js' +}; diff --git a/packages/portal/src/index.js b/packages/portal/src/index.js new file mode 100644 index 0000000..3144f8e --- /dev/null +++ b/packages/portal/src/index.js @@ -0,0 +1,111 @@ +// Copyright (c) 2016 Timothy Farrell +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +export function isWorker() { + try { + return self !== window; + } catch (e) { + return true; + } +} + +function tryJSON(type, destination, id, data) { + const packet = [type, destination, id, data]; + try { + return JSON.stringify(packet); + } catch (e) { + return packet; + } +} + +export function WorkerPortal(context, worker, serialize) { + const responseMap = new Map(); + const _worker = worker || self; + const contextIndex = Object.keys(context); + const _serialize = serialize + ? (type, destination, id, params) => serialize(type, destination, id, params, tryJSON) + : tryJSON; + let callCount = 0; + + function post(type, id, destination, params) { + _worker.postMessage(_serialize(type, destination, id, params)); + } + + _worker.onmessage = function dispatcher(evt) { + let data; + try { + data = JSON.parse(evt.data); + } catch (e) { + data = evt.data; + } + const [type, destination, id, params] = data; + + function _resolve(value) { + post(1, id, 0, value); + } + function _reject(e) { + post(1, id, 1, { message: e.message, name: e.name, stack: e.stack }); + } + + // If we have received an RPC response, satisfy the promise. + if (type) { + if (responseMap.has(id)) { + const responses = responseMap.get(id); + responseMap.delete(id); + responses[destination](params); + } + return; + } + + // If we have received an RPC call, execute and respond. + let thennable; + try { + thennable = context[contextIndex[destination]].apply(null, params); + } catch (e) { + _reject(e); + } + if (thennable && typeof thennable.then === 'function') { + thennable.then(_resolve).catch(_reject); + } else { + _resolve(thennable); + } + }; + function injectionPointFactory(fnId, fnName, callbackFactory) { + return () => + new Promise((resolve, reject) => { + const id = callCount; + callCount += 1; + responseMap.set(id, [callbackFactory ? callbackFactory(resolve) : resolve, reject]); + post(0, id, fnId, Array.from(arguments)); + }); + } + + function resolveExternalInterfaceFactory(resolve) { + return linkedFunctionNames => { + const externalInterface = {}; + linkedFunctionNames.forEach((fnName, index) => { + externalInterface[fnName] = injectionPointFactory(index, fnName); + }); + resolve(externalInterface); + return contextIndex; + }; + } + + return isWorker() + ? new Promise(resolve => { + contextIndex.splice(0, 0, '__init'); + context.__init = resolveExternalInterfaceFactory(resolve); + }) + : injectionPointFactory(0, '___init___', resolveExternalInterfaceFactory)(contextIndex); +}