@dronedeploy/rocos-js-sdk 2.6.1 → 3.0.0-alpha.20

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

@@ -0,0 +1,127 @@
+/**
+ * @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(),
+    },
+});
+// add mock to AbortSignal.timeout
+Object.defineProperty(AbortSignal, 'timeout', {
+    value: jest.fn().mockImplementation((timeout) => {
+        return new AbortController().signal;
+    }),
+});
+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/helpers/websandbox/frame/worker/types.d.ts

@@ -0,0 +1,11 @@
+export interface WorkerResult {
+    id: string;
+    result: unknown;
+    success: boolean;
+}
+export interface WorkerTask {
+    id: string;
+    code: string;
+    contextVariable: string;
+    context?: unknown;
+}

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,74 @@
+const WHITELIST = [
+    'TEMPORARY',
+    'PERSISTENT',
+    'console',
+    'self',
+    'onmessage',
+    'postMessage',
+    'global',
+    'allowed',
+    'Array',
+    'Boolean',
+    'Date',
+    'Function',
+    'Number',
+    'Object',
+    'RegExp',
+    'String',
+    'Error',
+    'EvalError',
+    'RangeError',
+    'ReferenceError',
+    'SyntaxError',
+    'TypeError',
+    'URIError',
+    'decodeURI',
+    'decodeURIComponent',
+    'encodeURI',
+    'encodeURIComponent',
+    'isFinite',
+    'isNaN',
+    'parseFloat',
+    'parseInt',
+    'Infinity',
+    'JSON',
+    'Math',
+    'NaN',
+    'undefined',
+];
+const windowProps = Object.getOwnPropertyNames(self);
+const protoProps = Object.getOwnPropertyNames(self.__proto__);
+const props = [...windowProps, ...protoProps];
+props.forEach((prop) => {
+    if (!WHITELIST.includes(prop)) {
+        Object.defineProperty(self, prop, {
+            get: () => {
+                throw new Error(`Security Exception: cannot access ${prop}`);
+            },
+            set: () => {
+                throw new Error(`Security Exception: cannot set ${prop}`);
+            },
+            configurable: false,
+        });
+    }
+});
+// Parses and calls function string with args
+onmessage = (event) => {
+    let result;
+    let success = true;
+    try {
+        const fn = Function(event.data.contextVariable, `"use strict";return (${event.data.code});`);
+        result = fn(event.data.context);
+    }
+    catch (e) {
+        result = e;
+        success = false;
+    }
+    const message = {
+        id: event.data.id,
+        result,
+        success,
+    };
+    postMessage(message);
+};
+export {};

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

@@ -0,0 +1,2 @@
+declare const source: string;
+export default source;

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

@@ -0,0 +1,4 @@
+// Auto-generated file
+/* eslint-disable */
+const source = `(()=>{"use strict";(()=>{const e=["TEMPORARY","PERSISTENT","console","self","onmessage","postMessage","global","allowed","Array","Boolean","Date","Function","Number","Object","RegExp","String","Error","EvalError","RangeError","ReferenceError","SyntaxError","TypeError","URIError","decodeURI","decodeURIComponent","encodeURI","encodeURIComponent","isFinite","isNaN","parseFloat","parseInt","Infinity","JSON","Math","NaN","undefined"];[...Object.getOwnPropertyNames(self),...Object.getOwnPropertyNames(self.__proto__)].forEach((r=>{e.includes(r)||Object.defineProperty(self,r,{get:()=>{throw new Error(\`Security Exception: cannot access \${r}\`)},set:()=>{throw new Error(\`Security Exception: cannot set \${r}\`)},configurable:!1})})),onmessage=e=>{let r,t=!0;try{r=Function(e.data.contextVariable,\`"use strict";return (\${e.data.code});\`)(e.data.context)}catch(e){r=e,t=!1}const o={id:e.data.id,result:r,success:t};postMessage(o)}})()})();`;
+export default source;

package/helpers/websandbox/index.d.ts

@@ -0,0 +1,2 @@
+import WebSandbox from './sandbox';
+export { WebSandbox };

package/helpers/websandbox/index.js

@@ -0,0 +1,2 @@
+import WebSandbox from './sandbox';
+export { WebSandbox };

package/helpers/websandbox/sandbox.d.ts

@@ -0,0 +1,57 @@
+export interface SandboxOptions extends Required<RunCodeOptions> {
+    /** The selector or element to append the iframe to */
+    frameContainer: string | Element;
+    /** Whether to enable verbose logging */
+    debugMode: boolean;
+}
+export interface RunCodeOptions {
+    /** The name of the variable to use for the context object */
+    contextVariable?: string;
+    timeout?: {
+        /** The minimum time to wait for a task to complete
+         *
+         * The worker will attempt to kill the task after this time.
+         */
+        minimumMs: number;
+        /** The maximum time to wait for a task to complete
+         *
+         * The sandbox will be destroyed and rebuilt after this time.
+         */
+        maximumMs: number;
+    };
+    abortSignal?: AbortSignal | null;
+}
+export declare const BaseOptions: SandboxOptions;
+export interface SandboxMethods {
+    iframeInitialised: () => void;
+}
+/** A sandbox for running untrusted code in an iframe & embedded web worker.
+ *
+ * This is a wrapper around the iframe and web worker that provides a simple API for running code in the sandbox.
+ * It also provides a context object that can be used to pass data into the sandbox.
+ */
+export default class WebSandbox {
+    private readonly options;
+    private frame;
+    private connection?;
+    private initialised;
+    private frameAbortController;
+    static new(options?: Partial<SandboxOptions>): Promise<WebSandbox>;
+    private constructor();
+    /** Runs code in the sandbox. Can be either a string or a function */
+    run<T = unknown>(code: string | (() => T), context?: unknown, options?: RunCodeOptions): Promise<T>;
+    /** Destroys the sandbox.
+     *
+     * This will remove the iframe from the DOM and remove the message listener.
+     */
+    destroy(): void;
+    private initialise;
+    private validateOptions;
+    private destroyAndRebuild;
+    private removeMessageListener;
+    private runFunction;
+    private runCode;
+    private promisifyAbortSignal;
+    private createFrame;
+    private prepareFrameContent;
+}

package/helpers/websandbox/sandbox.js

@@ -0,0 +1,175 @@
+import Connection from './connection';
+import frameSource from './frame';
+import { generateUUID } from '../generateUUID';
+export const BaseOptions = {
+    frameContainer: 'body',
+    debugMode: false,
+    contextVariable: 'ctx',
+    timeout: {
+        minimumMs: 1000,
+        maximumMs: 1500,
+    },
+    abortSignal: null,
+};
+/** A sandbox for running untrusted code in an iframe & embedded web worker.
+ *
+ * This is a wrapper around the iframe and web worker that provides a simple API for running code in the sandbox.
+ * It also provides a context object that can be used to pass data into the sandbox.
+ */
+export default class WebSandbox {
+    static async new(options = {}) {
+        const sandbox = new WebSandbox(options);
+        await sandbox.initialised;
+        return sandbox;
+    }
+    constructor(options) {
+        this.options = { ...BaseOptions, ...options };
+        this.frame = this.createFrame();
+        this.validateOptions(this.options);
+        this.initialised = this.initialise();
+        this.frameAbortController = new AbortController();
+        if (options.abortSignal) {
+            this.promisifyAbortSignal(options.abortSignal).catch(() => {
+                void this.destroyAndRebuild(this.frame.id);
+            });
+        }
+    }
+    /** Runs code in the sandbox. Can be either a string or a function */
+    async run(code, context, options) {
+        if (typeof code === 'function') {
+            return this.runFunction(code, context);
+        }
+        return this.runCode(code, context, options);
+    }
+    /** Destroys the sandbox.
+     *
+     * This will remove the iframe from the DOM and remove the message listener.
+     */
+    destroy() {
+        this.frameAbortController.abort();
+        this.frame.remove();
+        this.removeMessageListener();
+    }
+    initialise() {
+        return new Promise((resolve) => {
+            this.connection = new Connection('SANDBOX', this.frame.contentWindow.postMessage.bind(this.frame.contentWindow), {
+                iframeInitialised: () => resolve(),
+            }, (listener) => {
+                const sourceCheckListener = (event) => {
+                    if (event.source !== this.frame.contentWindow) {
+                        return;
+                    }
+                    return listener(event);
+                };
+                window.addEventListener('message', sourceCheckListener);
+                this.removeMessageListener = () => window.removeEventListener('message', sourceCheckListener);
+            }, { allowedSenderOrigin: 'null', debugMode: this.options.debugMode });
+        });
+    }
+    validateOptions(options) {
+        const minimumTimeout = options.timeout.minimumMs;
+        const maximumTimeout = options.timeout.maximumMs;
+        if (maximumTimeout < minimumTimeout) {
+            throw new Error(`maximum timeout (${maximumTimeout}ms) must be greater than or equal to minimum timeout (${minimumTimeout}ms)`);
+        }
+        if (minimumTimeout <= 0 || maximumTimeout <= 0) {
+            throw new Error('timeout values must be greater than 0');
+        }
+        if (maximumTimeout > 5000) {
+            throw new Error('maximum timeout must be less than or equal to 5000ms');
+        }
+    }
+    async destroyAndRebuild(frameId) {
+        if (this.frame.id !== frameId) {
+            return;
+        }
+        this.destroy();
+        this.frame = this.createFrame();
+        this.frameAbortController = new AbortController();
+        await this.initialise();
+    }
+    removeMessageListener() {
+        // replaced by constructor
+    }
+    async runFunction(fn, context, options) {
+        return this.runCode(`(${fn.toString()})()`, context, options);
+    }
+    async runCode(code, context, options) {
+        if (!this.connection) {
+            throw new Error('sandbox not initialised');
+        }
+        this.validateOptions({
+            ...this.options,
+            ...options,
+        });
+        const frameId = this.frame.id;
+        const timeout = this.promisifyAbortSignal(AbortSignal.timeout(options?.timeout?.maximumMs ?? this.options.timeout.maximumMs));
+        const frameAbortedSignal = this.promisifyAbortSignal(this.frameAbortController.signal);
+        const userAbortedSignal = options?.abortSignal ? this.promisifyAbortSignal(options.abortSignal) : null;
+        const taskId = generateUUID();
+        const task = this.connection.callRemoteMethod('startTask', {
+            id: taskId,
+            code,
+            context,
+            timeout: this.options.timeout.minimumMs,
+            contextVariable: options?.contextVariable ?? this.options.contextVariable,
+        });
+        const signals = [task, timeout, frameAbortedSignal, userAbortedSignal].filter((i) => i !== null);
+        return Promise.race(signals).catch(async (e) => {
+            if (e.name === 'TimeoutError') {
+                await this.destroyAndRebuild(frameId);
+            }
+            throw e;
+        });
+    }
+    promisifyAbortSignal(signal) {
+        return new Promise((_, reject) => {
+            // If the signal is already aborted, immediately throw in order to reject the promise.
+            if (signal.aborted) {
+                reject(signal.reason);
+            }
+            // Watch for 'abort' signals
+            signal.addEventListener('abort', () => {
+                // Stop the main operation
+                // Reject the promise with the abort reason.
+                reject(signal.reason);
+            });
+        });
+    }
+    createFrame() {
+        const containerSelector = this.options.frameContainer;
+        const container = typeof containerSelector === 'string' ? document.querySelector(containerSelector) : containerSelector;
+        if (!container) {
+            throw new Error('unable to find container for sandbox');
+        }
+        const iframe = document.createElement('iframe');
+        if (iframe.sandbox) {
+            iframe.sandbox.add('allow-scripts');
+        }
+        else {
+            iframe.setAttribute('sandbox', 'allow-scripts');
+        }
+        iframe.srcdoc = this.prepareFrameContent();
+        iframe.style.display = 'none';
+        iframe.id = generateUUID();
+        container.appendChild(iframe);
+        return iframe;
+    }
+    prepareFrameContent() {
+        let script = frameSource;
+        if (this.options.debugMode) {
+            script = `window.debugMode=true;${script}`;
+        }
+        return `
+      <!DOCTYPE html>
+      <html>
+        <head>
+          <meta charset="UTF-8">
+          <script>
+            ${script}
+          </script>
+        </head>
+      </html>
+    `;
+    }
+}

package/helpers/websandbox/types.d.ts

@@ -0,0 +1,13 @@
+type APIMethod = (...args: any[]) => unknown;
+export type API = Map<string, APIMethod>;
+export type APIDeclaration<T> = {
+    [K in keyof T]: T[K] extends APIMethod ? T[K] : never;
+};
+export interface Task {
+    id: string;
+    code: string;
+    context?: unknown;
+    timeout: number;
+    contextVariable?: string;
+}
+export {};

package/helpers/websandbox/types.js

@@ -0,0 +1 @@
+export {};

package/index.js

@@ -1,19 +1,7 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./constants/grpc"), exports);
-__exportStar(require("./constants/timezones"), exports);
-__exportStar(require("./helpers"), exports);
-__exportStar(require("./models"), exports);
-__exportStar(require("./services"), exports);
-__exportStar(require("./IRocosSDK"), exports);
-__exportStar(require("./RocosSDK"), exports);
+export * from './constants/grpc';
+export * from './constants/timezones';
+export * from './helpers';
+export * from './models';
+export * from './services';
+export * from './IRocosSDK';
+export * from './RocosSDK';

package/logger/RocosLogger.js

@@ -1,63 +1,37 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RocosLogger = void 0;
-const prefix = __importStar(require("loglevel-plugin-prefix"));
-const loglevel_1 = __importDefault(require("loglevel"));
-loglevel_1.default.setDefaultLevel('silent');
-prefix.reg(loglevel_1.default);
-prefix.apply(loglevel_1.default, {
+import * as prefix from 'loglevel-plugin-prefix';
+import log from 'loglevel';
+log.setDefaultLevel('silent');
+prefix.reg(log);
+prefix.apply(log, {
     format(level, name, timestamp) {
         return `[${timestamp}] ${level.toUpperCase()} ${name}:`;
     },
 });
-class RocosLogger {
+export class RocosLogger {
     static getInstance(name) {
         if (name) {
-            const logger = loglevel_1.default.getLogger(name);
-            logger.setLevel(loglevel_1.default.getLevel());
+            const logger = log.getLogger(name);
+            logger.setLevel(log.getLevel());
             return logger;
         }
-        return loglevel_1.default;
+        return log;
     }
     static enableAll() {
-        loglevel_1.default.enableAll();
-        for (const name in loglevel_1.default.getLoggers()) {
-            loglevel_1.default.getLogger(name).enableAll();
+        log.enableAll();
+        for (const name in log.getLoggers()) {
+            log.getLogger(name).enableAll();
         }
     }
     static disableAll() {
-        loglevel_1.default.disableAll();
-        for (const name in loglevel_1.default.getLoggers()) {
-            loglevel_1.default.getLogger(name).disableAll();
+        log.disableAll();
+        for (const name in log.getLoggers()) {
+            log.getLogger(name).disableAll();
         }
     }
     static setLevel(level) {
-        loglevel_1.default.setLevel(level);
-        for (const name in loglevel_1.default.getLoggers()) {
-            loglevel_1.default.getLogger(name).setLevel(loglevel_1.default.getLevel());
+        log.setLevel(level);
+        for (const name in log.getLoggers()) {
+            log.getLogger(name).setLevel(log.getLevel());
         }
     }
 }
-exports.RocosLogger = RocosLogger;

package/models/CallsignStatus.d.ts

@@ -0,0 +1,6 @@
+export declare enum CallsignStatus {
+    UNKNOWN = "unknown",
+    ONLINE = "online",
+    OFFLINE = "offline",
+    ERROR = "error"
+}

package/models/CallsignStatus.js

@@ -0,0 +1,7 @@
+export var CallsignStatus;
+(function (CallsignStatus) {
+    CallsignStatus["UNKNOWN"] = "unknown";
+    CallsignStatus["ONLINE"] = "online";
+    CallsignStatus["OFFLINE"] = "offline";
+    CallsignStatus["ERROR"] = "error";
+})(CallsignStatus || (CallsignStatus = {}));

package/models/ExportDataQuery.js

@@ -1,7 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ExportDataQuery = void 0;
-class ExportDataQuery {
+export class ExportDataQuery {
     constructor(init) {
         this.filters = [];
         Object.assign(this, init);
@@ -14,4 +11,3 @@ class ExportDataQuery {
         };
     }
 }
-exports.ExportDataQuery = ExportDataQuery;

package/models/ExternalProject.js

@@ -1,6 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ExternalProject = void 0;
-class ExternalProject {
+export class ExternalProject {
 }
-exports.ExternalProject = ExternalProject;

package/models/IBaseService.d.ts

@@ -1,3 +1,4 @@
 export interface IBaseService {
     getStatus: () => boolean;
+    teardown?: (() => void) | (() => Promise<void>);
 }

package/models/IBaseService.js

@@ -1,2 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};

package/models/IConfigGroup.js

@@ -1,2 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};

package/models/IDebugLevel.d.ts

@@ -1,2 +1,2 @@
 import { LogLevelDesc } from 'loglevel';
-export declare type IDebugLevel = LogLevelDesc;
+export type IDebugLevel = LogLevelDesc;

package/models/IDebugLevel.js

@@ -1,2 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};

package/models/IExportDataQuery.js

@@ -1,2 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};