@dronedeploy/rocos-js-sdk 3.0.1-alpha.1 → 3.0.1-alpha.2

package/helpers/websandbox/frame/frame.source.js

@@ -1,5 +1,5 @@
 // Auto-generated file
 /* eslint-disable */
 import __WORKER_SOURCE__ from './worker/worker.source';
-const source = `(()=>{"use strict";var e={880:(e,t)=>{var s;Object.defineProperty(t,"__esModule",{value:!0}),function(e){e.RESPONSE="response",e.MESSAGE="message"}(s||(s={}));const r={allowedSenderOrigin:void 0,debugMode:!1};t.default=class{constructor(e,t,s,i,o={}){this.callbacks=new Map,this.serviceMethods=new Map,this.name=e,this.options={...r,...o},this.log("Created connection w/ allowedOrigin:",this.options.allowedSenderOrigin),this.serviceMethods=new Map(Object.entries(s));const[n]=crypto.getRandomValues(new Uint32Array(1));this.incrementalID=n,this.postMessageInternal=t,i((e=>this.onMessageListener(e)))}callRemoteMethod(e,...t){return this.log("Calling Remote Method",{name:e,args:t}),new Promise(((r,i)=>{const o=this.registerCallback(r,i);this.postMessage({callId:o,type:s.MESSAGE,methodName:e,arguments:t})}))}onMessageListener(e){this.log("Received message",e);const{data:t}=e,{allowedSenderOrigin:r}=this.options;switch(r&&e.origin!==r&&console.warn(\`Received message from invalid origin: \${e.origin}\`),t.type){case s.RESPONSE:return void this.popCallback(t.callId,t.success,t.result);case s.MESSAGE:this.callLocalMethod(t.methodName,t.arguments).then((e=>this.responseOtherSide(t.callId,e))).catch((e=>this.responseOtherSide(t.callId,e,!1)))}}async callLocalMethod(e,t){this.log("calling local method",e,t);const s=this.serviceMethods.get(e);if(!s)throw new Error(\`service method \${e} not found\`);return s(...t)}responseOtherSide(e,t,r=!0){this.log("responding to remote call",{id:e,result:t,success:r});const i=t=>{this.postMessage({callId:e,type:s.RESPONSE,success:r,result:t})};try{i(t)}catch(e){e instanceof DOMException&&i(JSON.parse(JSON.stringify(t)))}}registerCallback(e,t){const s=(++this.incrementalID).toString();return this.log("registering callback for id",s),this.callbacks.set(s,{success:e,failure:t}),s}popCallback(e,t,s){this.log("calling callback for id",e,{success:t,result:s});const r=this.callbacks.get(e);t?r?.success(s):r?.failure(s),this.callbacks.delete(e)}postMessage(e,t="*"){this.log("sending message",{data:e,targetOrigin:t}),this.postMessageInternal(e,t)}log(...e){this.options.debugMode&&console.debug(\`[\${this.name}]\`,...e)}}},306:function(e,t,s){var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});const i=r(s(880)),o=r(s(54)),n=new class{constructor(){const e=!!window?.debugMode;this.connection=new i.default("FRAME",window.parent.postMessage.bind(window.parent),{startTask:this.runCode.bind(this)},(e=>{window.addEventListener("message",e)}),{debugMode:e}),this.connection.callRemoteMethod("iframeInitialised"),this.workerManager=new o.default}async runCode(e){return this.workerManager.execute(e)}};t.default=n},54:function(e,t,s){var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});const i=r(s(420));t.default=i.default},420:(e,t)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.default=class{constructor(){this.worker=this.createWorker()}async execute(e){const t={...e,contextVariable:e.contextVariable??"ctx"},s=this.runTask(t),r=this.timeout(e.timeout??1e3);return Promise.race([s,r]).finally((()=>{this.removeMessageListener()}))}terminate(){this.removeMessageListener(),this.worker.terminate(),this.worker=this.createWorker()}runTask(e){return new Promise(((t,s)=>{const r=r=>{const{data:i}=r;i.id===e.id&&(this.stopTimer(),i.success?t(i.result):s(i.result))};this.worker.addEventListener("message",r),this.removeMessageListener=()=>this.worker.removeEventListener("message",r),this.worker.postMessage(e)}))}timeout(e){return new Promise(((t,s)=>{this.timerId=window.setTimeout((()=>{this.terminate(),s(new Error("maximum execution time exceeded"))}),e)}))}stopTimer(){clearTimeout(this.timerId)}createWorker(){const e=URL.createObjectURL(new Blob(["${__WORKER_SOURCE__.replace(/(['`"$])/g, '\\$1')}"],{type:"application/javascript"}));return new Worker(e)}removeMessageListener(){}}}},t={};!function s(r){var i=t[r];if(void 0!==i)return i.exports;var o=t[r]={exports:{}};return e[r].call(o.exports,o,o.exports,s),o.exports}(306)})();`;
+const source = `(()=>{"use strict";var e={880:(e,t)=>{var s;Object.defineProperty(t,"__esModule",{value:!0}),function(e){e.RESPONSE="response",e.MESSAGE="message"}(s||(s={}));const r={allowedSenderOrigin:void 0,debugMode:!1};t.default=class{constructor(e,t,s,i,o={}){this.callbacks=new Map,this.serviceMethods=new Map,this.name=e,this.options={...r,...o},this.log("Created connection w/ allowedOrigin:",this.options.allowedSenderOrigin),this.serviceMethods=new Map(Object.entries(s));const[n]=crypto.getRandomValues(new Uint32Array(1));this.incrementalID=n,this.postMessageInternal=t,i((e=>this.onMessageListener(e)))}callRemoteMethod(e,...t){return this.log("Calling Remote Method",{name:e,args:t}),new Promise(((r,i)=>{const o=this.registerCallback(r,i);this.postMessage({callId:o,type:s.MESSAGE,methodName:e,arguments:t})}))}onMessageListener(e){this.log("Received message",e);const{data:t}=e,{allowedSenderOrigin:r}=this.options;switch(r&&e.origin!==r&&console.warn(\`Received message from invalid origin: \${e.origin}\`),t.type){case s.RESPONSE:return void this.popCallback(t.callId,t.success,t.result);case s.MESSAGE:this.callLocalMethod(t.methodName,t.arguments).then((e=>this.responseOtherSide(t.callId,e))).catch((e=>this.responseOtherSide(t.callId,e,!1)))}}async callLocalMethod(e,t){this.log("calling local method",e,t);const s=this.serviceMethods.get(e);if(!s)throw new Error(\`service method \${e} not found\`);return s(...t)}responseOtherSide(e,t,r=!0){this.log("responding to remote call",{id:e,result:t,success:r});const i=t=>{this.postMessage({callId:e,type:s.RESPONSE,success:r,result:t})};try{i(t)}catch(e){e instanceof DOMException&&i(JSON.parse(JSON.stringify(t)))}}registerCallback(e,t){const s=(++this.incrementalID).toString();return this.log("registering callback for id",s),this.callbacks.set(s,{success:e,failure:t}),s}popCallback(e,t,s){this.log("calling callback for id",e,{success:t,result:s});const r=this.callbacks.get(e);t?r?.success(s):r?.failure(s),this.callbacks.delete(e)}postMessage(e,t="*"){this.log("sending message",{data:e,targetOrigin:t}),this.postMessageInternal(e,t)}log(...e){this.options.debugMode&&console.debug(\`[\${this.name}]\`,...e)}}},306:function(e,t,s){var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});const i=r(s(880)),o=r(s(54)),n=new class{constructor(){const e=!!window?.debugMode;this.connection=new i.default("FRAME",window.parent.postMessage.bind(window.parent),{startTask:this.runCode.bind(this)},(e=>{window.addEventListener("message",e)}),{debugMode:e}),this.connection.callRemoteMethod("iframeInitialised"),this.workerManager=new o.default}async runCode(e){return this.workerManager.execute(e)}};t.default=n},54:function(e,t,s){var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});const i=r(s(420));t.default=i.default},420:(e,t)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.default=class{constructor(){this.messageListeners=new Map,this.worker=this.createWorker()}async execute(e){const t={...e,contextVariable:e.contextVariable??"ctx"},s=this.runTask(t);let r;const i=new Promise(((t,s)=>{r=setTimeout((()=>{console.warn("sandbox level timeout exceeded, destroying and rebuilding"),this.terminate(),s(new Error("maximum execution time exceeded"))}),e.timeout)}));return Promise.race([s,i]).finally((()=>{this.removeMessageListener(e.id),clearTimeout(r)}))}terminate(){for(const e of this.messageListeners.values())this.worker.removeEventListener("message",e);this.worker.terminate(),this.worker=this.createWorker()}runTask(e){return new Promise(((t,s)=>{const r=r=>{const{data:i}=r;i.id===e.id&&(i.success?t(i.result):s(i.result))};this.messageListeners.set(e.id,r),this.worker.addEventListener("message",r),this.worker.postMessage(e)}))}createWorker(){const e=URL.createObjectURL(new Blob(["${__WORKER_SOURCE__.replace(/(['`"$])/g, '\\$1')}"],{type:"application/javascript"}));return new Worker(e)}removeMessageListener(e){const t=this.messageListeners.get(e);t&&this.worker.removeEventListener("message",t)}}}},t={};!function s(r){var i=t[r];if(void 0!==i)return i.exports;var o=t[r]={exports:{}};return e[r].call(o.exports,o,o.exports,s),o.exports}(306)})();`;
 export default source;

package/helpers/websandbox/frame/worker/manager.d.ts

@@ -1,13 +1,11 @@
 import { Task } from '../../types';
 export default class Manager {
     private worker;
-    private timerId?;
+    private messageListeners;
     constructor();
     execute(task: Task): Promise<unknown>;
     terminate(): void;
     private runTask;
-    private timeout;
-    private stopTimer;
     private createWorker;
     private removeMessageListener;
 }

package/helpers/websandbox/frame/worker/manager.js

@@ -2,6 +2,7 @@
 const WORKER_SOURCE = '__WORKER_SOURCE__';
 export default class Manager {
     constructor() {
+        this.messageListeners = new Map();
         this.worker = this.createWorker();
     }
     async execute(task) {
@@ -10,13 +11,22 @@ export default class Manager {
             contextVariable: task.contextVariable ?? 'ctx',
         };
         const result = this.runTask(workerTask);
-        const timeout = this.timeout(task.timeout ?? 1000);
+        let timerId;
+        const timeout = new Promise((_, reject) => {
+            timerId = setTimeout(() => {
+                this.terminate();
+                reject(new Error('maximum execution time exceeded'));
+            }, task.timeout);
+        });
         return Promise.race([result, timeout]).finally(() => {
-            this.removeMessageListener();
+            this.removeMessageListener(task.id);
+            clearTimeout(timerId);
         });
     }
     terminate() {
-        this.removeMessageListener();
+        for (const listener of this.messageListeners.values()) {
+            this.worker.removeEventListener('message', listener);
+        }
         this.worker.terminate();
         this.worker = this.createWorker();
     }
@@ -25,7 +35,6 @@ export default class Manager {
             const listener = (event) => {
                 const { data } = event;
                 if (data.id === task.id) {
-                    this.stopTimer();
                     if (data.success) {
                         resolve(data.result);
                     }
@@ -34,27 +43,20 @@ export default class Manager {
                     }
                 }
             };
+            this.messageListeners.set(task.id, listener);
             this.worker.addEventListener('message', listener);
-            this.removeMessageListener = () => this.worker.removeEventListener('message', listener);
             this.worker.postMessage(task);
         });
     }
-    timeout(timeoutMs) {
-        return new Promise((_, reject) => {
-            this.timerId = window.setTimeout(() => {
-                this.terminate();
-                reject(new Error('maximum execution time exceeded'));
-            }, timeoutMs);
-        });
-    }
-    stopTimer() {
-        clearTimeout(this.timerId);
-    }
     createWorker() {
         const blob = URL.createObjectURL(new Blob([WORKER_SOURCE], { type: 'application/javascript' }));
         return new Worker(blob);
     }
-    removeMessageListener() {
-        // replaced by constructor
+    removeMessageListener(id) {
+        const listener = this.messageListeners.get(id);
+        if (!listener) {
+            return;
+        }
+        this.worker.removeEventListener('message', listener);
     }
 }

package/helpers/websandbox/frame/worker/manager.spec.d.ts

@@ -0,0 +1,4 @@
+/**
+ * @jest-environment jsdom
+ */
+export {};

package/helpers/websandbox/frame/worker/manager.spec.js

@@ -0,0 +1,121 @@
+/**
+ * @jest-environment jsdom
+ */
+import WorkerManager from './manager';
+const WorkerMocks = {
+    postMessage: jest.fn(),
+    terminate: jest.fn(),
+    addEventListener: jest.fn(),
+    removeEventListener: jest.fn(),
+    onerror: jest.fn(),
+    onmessage: jest.fn(),
+    onmessageerror: jest.fn(),
+    dispatchEvent: jest.fn(),
+    clearAllMocks() {
+        this.postMessage.mockClear();
+        this.terminate.mockClear();
+        this.addEventListener.mockClear();
+        this.removeEventListener.mockClear();
+        this.onerror.mockClear();
+        this.onmessage.mockClear();
+        this.onmessageerror.mockClear();
+        this.dispatchEvent.mockClear();
+    },
+};
+class MockWorkerClass {
+    constructor() {
+        this.postMessage = WorkerMocks.postMessage;
+        this.terminate = WorkerMocks.terminate;
+        this.addEventListener = WorkerMocks.addEventListener;
+        this.removeEventListener = WorkerMocks.removeEventListener;
+        this.onerror = WorkerMocks.onerror;
+        this.onmessage = WorkerMocks.onmessage;
+        this.onmessageerror = WorkerMocks.onmessageerror;
+        this.dispatchEvent = WorkerMocks.dispatchEvent;
+    }
+}
+Object.defineProperty(window, 'Worker', {
+    value: MockWorkerClass,
+    writable: true,
+});
+Object.defineProperty(window, 'URL', {
+    value: {
+        createObjectURL: jest.fn(),
+    },
+});
+const task = {
+    id: 'test',
+    code: '1',
+    timeout: 1000,
+};
+const response = {
+    data: {
+        id: 'test',
+        success: true,
+        result: 'test',
+    },
+};
+describe('WorkerManager', () => {
+    beforeEach(() => {
+        WorkerMocks.clearAllMocks();
+    });
+    it('should send a task to the worker', async () => {
+        const listeners = [];
+        WorkerMocks.addEventListener.mockImplementation((_, listener) => {
+            listeners.push(listener);
+        });
+        WorkerMocks.postMessage.mockImplementation((msg) => {
+            listeners.forEach((listener) => {
+                listener(response);
+            });
+        });
+        const manager = new WorkerManager();
+        const result = await manager.execute(task);
+        expect(result).toEqual('test');
+    });
+    it('should handle listener for a single task', async () => {
+        const listeners = [];
+        WorkerMocks.addEventListener.mockImplementation((_, listener) => {
+            listeners.push(listener);
+        });
+        WorkerMocks.removeEventListener.mockImplementation((_, listener) => {
+            const index = listeners.indexOf(listener);
+            listeners.splice(index, 1);
+        });
+        const manager = new WorkerManager();
+        expect(listeners.length).toEqual(0);
+        const result = manager.execute(task);
+        expect(listeners.length).toEqual(1);
+        listeners[0](response);
+        await result;
+        expect(listeners.length).toEqual(0);
+    });
+    it('should handle listener for multiple simultaneous task', async () => {
+        const listeners = [];
+        WorkerMocks.addEventListener.mockImplementation((_, listener) => {
+            listeners.push(listener);
+        });
+        WorkerMocks.removeEventListener.mockImplementation((_, listener) => {
+            const index = listeners.indexOf(listener);
+            listeners.splice(index, 1);
+        });
+        const manager = new WorkerManager();
+        expect(listeners.length).toEqual(0);
+        const result1 = manager.execute(task);
+        const result2 = manager.execute(task);
+        expect(listeners.length).toEqual(2);
+        const result3 = manager.execute(task);
+        expect(listeners.length).toEqual(3);
+        const [listener1, listener2, listener3] = listeners;
+        listener1(response);
+        await result1;
+        expect(listeners.length).toEqual(2);
+        listener3(response);
+        await result3;
+        expect(listeners.length).toEqual(1);
+        listener2(response);
+        await result2;
+        expect(listeners.length).toEqual(0);
+        expect(WorkerMocks.removeEventListener).toHaveBeenCalledTimes(3);
+    });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dronedeploy/rocos-js-sdk",
-  "version": "3.0.1-alpha.1",
+  "version": "3.0.1-alpha.2",
   "description": "Javascript SDK for rocos",
   "main": "index.js",
   "types": "index.d.ts",