mirror of
https://github.com/laurent22/joplin.git
synced 2024-12-24 10:27:10 +02:00
104 lines
3.3 KiB
TypeScript
104 lines
3.3 KiB
TypeScript
import * as vm from 'vm';
|
|
import Plugin from '@joplin/lib/services/plugins/Plugin';
|
|
import BasePluginRunner from '@joplin/lib/services/plugins/BasePluginRunner';
|
|
import executeSandboxCall from '@joplin/lib/services/plugins/utils/executeSandboxCall';
|
|
import Global from '@joplin/lib/services/plugins/api/Global';
|
|
import mapEventHandlersToIds, { EventHandlers } from '@joplin/lib/services/plugins/utils/mapEventHandlersToIds';
|
|
import uuid from '@joplin/lib/uuid';
|
|
const sandboxProxy = require('@joplin/lib/services/plugins/sandboxProxy');
|
|
|
|
function createConsoleWrapper(pluginId: string) {
|
|
const wrapper: any = {};
|
|
|
|
for (const n in console) {
|
|
// eslint-disable-next-line no-console
|
|
if (!console.hasOwnProperty(n)) continue;
|
|
wrapper[n] = (...args: any[]) => {
|
|
const newArgs = args.slice();
|
|
newArgs.splice(0, 0, `Plugin "${pluginId}":`);
|
|
return (console as any)[n](...newArgs);
|
|
};
|
|
}
|
|
|
|
return wrapper;
|
|
}
|
|
|
|
// The CLI plugin runner is more complex than it needs to be because it more or less emulates
|
|
// how it would work in a multi-process architecture, as in the desktop app (and probably how
|
|
// it would work in the mobile app too). This is mainly to allow doing integration testing.
|
|
//
|
|
// For example, all plugin calls go through a proxy, however they could made directly since
|
|
// the plugin script is running within the same process as the main app.
|
|
|
|
export default class PluginRunner extends BasePluginRunner {
|
|
|
|
private eventHandlers_: EventHandlers = {};
|
|
private activeSandboxCalls_: any = {};
|
|
|
|
constructor() {
|
|
super();
|
|
|
|
this.eventHandler = this.eventHandler.bind(this);
|
|
}
|
|
|
|
private async eventHandler(eventHandlerId: string, args: any[]) {
|
|
const cb = this.eventHandlers_[eventHandlerId];
|
|
return cb(...args);
|
|
}
|
|
|
|
private newSandboxProxy(pluginId: string, sandbox: Global) {
|
|
const target = async (path: string, args: any[]) => {
|
|
const callId = `${pluginId}::${path}::${uuid.createNano()}`;
|
|
this.activeSandboxCalls_[callId] = true;
|
|
const promise = executeSandboxCall(pluginId, sandbox, `joplin.${path}`, mapEventHandlersToIds(args, this.eventHandlers_), this.eventHandler);
|
|
// eslint-disable-next-line promise/prefer-await-to-then -- Old code before rule was applied
|
|
promise.finally(() => {
|
|
delete this.activeSandboxCalls_[callId];
|
|
});
|
|
return promise;
|
|
};
|
|
|
|
return {
|
|
joplin: sandboxProxy(target),
|
|
console: createConsoleWrapper(pluginId),
|
|
};
|
|
}
|
|
|
|
async run(plugin: Plugin, sandbox: Global): Promise<void> {
|
|
return new Promise((resolve: Function, reject: Function) => {
|
|
const onStarted = () => {
|
|
plugin.off('started', onStarted);
|
|
resolve();
|
|
};
|
|
|
|
plugin.on('started', onStarted);
|
|
|
|
const vmSandbox = vm.createContext(this.newSandboxProxy(plugin.id, sandbox));
|
|
|
|
try {
|
|
vm.runInContext(plugin.scriptText, vmSandbox);
|
|
} catch (error) {
|
|
reject(error);
|
|
}
|
|
});
|
|
}
|
|
|
|
public async waitForSandboxCalls(): Promise<void> {
|
|
const startTime = Date.now();
|
|
return new Promise((resolve: Function, reject: Function) => {
|
|
const iid = setInterval(() => {
|
|
if (!Object.keys(this.activeSandboxCalls_).length) {
|
|
clearInterval(iid);
|
|
resolve();
|
|
}
|
|
|
|
if (Date.now() - startTime > 4000) {
|
|
clearInterval(iid);
|
|
reject(new Error(`Timeout while waiting for sandbox calls to complete: ${JSON.stringify(this.activeSandboxCalls_)}`));
|
|
}
|
|
}, 10);
|
|
});
|
|
}
|
|
|
|
}
|