@lvce-editor/ipc 2.0.0 → 3.0.0

package/dist/index.js

@@ -1,7 +1,831 @@
-export * as IpcChildWithElectronMessagePort from './parts/IpcChildWithElectronMessagePort/IpcChildWithElectronMessagePort.js'
-export * as IpcChildWithElectronUtilityProcess from './parts/IpcChildWithElectronUtilityProcess/IpcChildWithElectronUtilityProcess.js'
-export * as IpcChildWithNodeForkedProcess from './parts/IpcChildWithNodeForkedProcess/IpcChildWithNodeForkedProcess.js'
-export * as IpcChildWithWebSocket from './parts/IpcChildWithWebSocket/IpcChildWithWebSocket.js'
-export * as IpcParentWithElectronUtilityProcess from './parts/IpcParentWithElectronUtilityProcess/IpcParentWithElectronUtilityProcess.js'
-export * as IpcParentWithNodeForkedProcess from './parts/IpcParentWithNodeForkedProcess/IpcParentWithNodeForkedProcess.js'
-export * as IpcParentWithNodeWorker from './parts/IpcParentWithNodeWorker/IpcParentWithNodeWorker.js'
+import { VError } from '@lvce-editor/verror';
+import { string, array } from '@lvce-editor/assert';
+import { fork } from 'node:child_process';
+import { Worker } from 'node:worker_threads';
+
+const E_INCOMPATIBLE_NATIVE_MODULE = 'E_INCOMPATIBLE_NATIVE_MODULE';
+const E_MODULES_NOT_SUPPORTED_IN_ELECTRON = 'E_MODULES_NOT_SUPPORTED_IN_ELECTRON';
+const ERR_MODULE_NOT_FOUND = 'ERR_MODULE_NOT_FOUND';
+
+const NewLine = '\n';
+
+const splitLines = lines => {
+  return lines.split(NewLine);
+};
+
+const joinLines = lines => {
+  return lines.join(NewLine);
+};
+
+const RE_NATIVE_MODULE_ERROR = /^innerError Error: Cannot find module '.*.node'/;
+const RE_NATIVE_MODULE_ERROR_2 = /was compiled against a different Node.js version/;
+const RE_MESSAGE_CODE_BLOCK_START = /^Error: The module '.*'$/;
+const RE_MESSAGE_CODE_BLOCK_END = /^\s* at/;
+const RE_AT = /^\s+at/;
+const RE_AT_PROMISE_INDEX = /^\s*at async Promise.all \(index \d+\)$/;
+const isUnhelpfulNativeModuleError = stderr => {
+  return RE_NATIVE_MODULE_ERROR.test(stderr) && RE_NATIVE_MODULE_ERROR_2.test(stderr);
+};
+const isMessageCodeBlockStartIndex = line => {
+  return RE_MESSAGE_CODE_BLOCK_START.test(line);
+};
+const isMessageCodeBlockEndIndex = line => {
+  return RE_MESSAGE_CODE_BLOCK_END.test(line);
+};
+const getMessageCodeBlock = stderr => {
+  const lines = splitLines(stderr);
+  const startIndex = lines.findIndex(isMessageCodeBlockStartIndex);
+  const endIndex = startIndex + lines.slice(startIndex).findIndex(isMessageCodeBlockEndIndex, startIndex);
+  const relevantLines = lines.slice(startIndex, endIndex);
+  const relevantMessage = relevantLines.join(' ').slice('Error: '.length);
+  return relevantMessage;
+};
+const getNativeModuleErrorMessage = stderr => {
+  const message = getMessageCodeBlock(stderr);
+  return {
+    message: `Incompatible native node module: ${message}`,
+    code: E_INCOMPATIBLE_NATIVE_MODULE
+  };
+};
+const isModulesSyntaxError = stderr => {
+  if (!stderr) {
+    return false;
+  }
+  return stderr.includes('SyntaxError: Cannot use import statement outside a module');
+};
+const getModuleSyntaxError = stderr => {
+  return {
+    message: `ES Modules are not supported in electron`,
+    code: E_MODULES_NOT_SUPPORTED_IN_ELECTRON
+  };
+};
+const isModuleNotFoundError = stderr => {
+  if (!stderr) {
+    return false;
+  }
+  return stderr.includes('ERR_MODULE_NOT_FOUND');
+};
+const isModuleNotFoundMessage = line => {
+  return line.includes('ERR_MODULE_NOT_FOUND');
+};
+const getModuleNotFoundError = stderr => {
+  const lines = splitLines(stderr);
+  const messageIndex = lines.findIndex(isModuleNotFoundMessage);
+  const message = lines[messageIndex];
+  return {
+    message,
+    code: ERR_MODULE_NOT_FOUND
+  };
+};
+const isNormalStackLine = line => {
+  return RE_AT.test(line) && !RE_AT_PROMISE_INDEX.test(line);
+};
+const getDetails = lines => {
+  const index = lines.findIndex(isNormalStackLine);
+  if (index === -1) {
+    return {
+      actualMessage: joinLines(lines),
+      rest: []
+    };
+  }
+  let lastIndex = index - 1;
+  while (++lastIndex < lines.length) {
+    if (!isNormalStackLine(lines[lastIndex])) {
+      break;
+    }
+  }
+  return {
+    actualMessage: lines[index - 1],
+    rest: lines.slice(index, lastIndex)
+  };
+};
+const getHelpfulChildProcessError = (stdout, stderr) => {
+  if (isUnhelpfulNativeModuleError(stderr)) {
+    return getNativeModuleErrorMessage(stderr);
+  }
+  if (isModulesSyntaxError(stderr)) {
+    return getModuleSyntaxError();
+  }
+  if (isModuleNotFoundError(stderr)) {
+    return getModuleNotFoundError(stderr);
+  }
+  const lines = splitLines(stderr);
+  const {
+    actualMessage,
+    rest
+  } = getDetails(lines);
+  return {
+    message: `${actualMessage}`,
+    code: '',
+    stack: rest
+  };
+};
+
+class IpcError extends VError {
+  constructor(message, stdout = '', stderr = '') {
+    if (stdout || stderr) {
+      // @ts-ignore
+      const {
+        message,
+        code,
+        stack
+      } = getHelpfulChildProcessError(stdout, stderr);
+      const cause = new Error(message);
+      // @ts-ignore
+      cause.code = code;
+      cause.stack = stack;
+      super(cause, message);
+    } else {
+      super(message);
+    }
+    // @ts-ignore
+    this.name = 'IpcError';
+    // @ts-ignore
+    this.stdout = stdout;
+    // @ts-ignore
+    this.stderr = stderr;
+  }
+}
+
+const isMessagePortMain = value => {
+  return value && value.constructor && value.constructor.name === 'MessagePortMain';
+};
+
+const listen$3 = ({
+  messagePort
+}) => {
+  if (!isMessagePortMain(messagePort)) {
+    throw new IpcError('port must be of type MessagePortMain');
+  }
+  return messagePort;
+};
+const getActualData$1 = event => {
+  const {
+    data,
+    ports
+  } = event;
+  if (ports.length === 0) {
+    return data;
+  }
+  return {
+    ...data,
+    params: [...ports, ...data.params]
+  };
+};
+const wrap$6 = messagePort => {
+  return {
+    messagePort,
+    on(event, listener) {
+      if (event === 'message') {
+        const wrappedListener = event => {
+          const actualData = getActualData$1(event);
+          listener(actualData);
+        };
+        this.messagePort.on(event, wrappedListener);
+      } else if (event === 'close') {
+        this.messagePort.on('close', listener);
+      } else {
+        throw new Error('unsupported event type');
+      }
+    },
+    off(event, listener) {
+      this.messagePort.off(event, listener);
+    },
+    send(message) {
+      this.messagePort.postMessage(message);
+    },
+    dispose() {
+      this.messagePort.close();
+    },
+    start() {
+      this.messagePort.start();
+    }
+  };
+};
+
+const IpcChildWithElectronMessagePort = {
+  __proto__: null,
+  listen: listen$3,
+  wrap: wrap$6
+};
+
+const getUtilityProcessPortData = event => {
+  const {
+    data,
+    ports
+  } = event;
+  if (ports.length === 0) {
+    return data;
+  }
+  return {
+    ...data,
+    params: [...ports, ...data.params]
+  };
+};
+
+const listen$2 = () => {
+  // @ts-ignore
+  const {
+    parentPort
+  } = process;
+  if (!parentPort) {
+    throw new Error('parent port must be defined');
+  }
+  return parentPort;
+};
+const signal$1 = parentPort => {
+  parentPort.postMessage('ready');
+};
+const wrap$5 = parentPort => {
+  return {
+    parentPort,
+    on(event, listener) {
+      if (event === 'message') {
+        const wrappedListener = event => {
+          const actualData = getUtilityProcessPortData(event);
+          listener(actualData);
+        };
+        this.parentPort.on(event, wrappedListener);
+      } else if (event === 'close') {
+        this.parentPort.on('close', listener);
+      } else {
+        throw new Error('unsupported event type');
+      }
+    },
+    off(event, listener) {
+      this.parentPort.off(event, listener);
+    },
+    send(message) {
+      this.parentPort.postMessage(message);
+    },
+    sendAndTransfer(message, transfer) {
+      this.parentPort.postMessage(message, transfer);
+    },
+    dispose() {
+      this.parentPort.close();
+    }
+  };
+};
+
+const IpcChildWithElectronUtilityProcess = {
+  __proto__: null,
+  listen: listen$2,
+  signal: signal$1,
+  wrap: wrap$5
+};
+
+const listen$1 = async () => {
+  if (!process.send) {
+    throw new Error('process.send must be defined');
+  }
+  return process;
+};
+const signal = process => {
+  process.send('ready');
+};
+const getActualData = (message, handle) => {
+  if (handle) {
+    return {
+      ...message,
+      params: [...message.params, handle]
+    };
+  }
+  return message;
+};
+const wrap$4 = process => {
+  return {
+    process,
+    on(event, listener) {
+      if (event === 'message') {
+        const wrappedListener = (event, handle) => {
+          const actualData = getActualData(event, handle);
+          listener(actualData);
+        };
+        this.process.on(event, wrappedListener);
+      } else if (event === 'close') {
+        this.process.on('close', listener);
+      } else {
+        throw new Error('unsupported event type');
+      }
+    },
+    off(event, listener) {
+      this.process.off(event, listener);
+    },
+    send(message) {
+      this.process.send(message);
+    },
+    dispose() {}
+  };
+};
+
+const IpcChildWithNodeForkedProcess = {
+  __proto__: null,
+  listen: listen$1,
+  signal,
+  wrap: wrap$4
+};
+
+const Open = 1;
+const Close = 2;
+
+const withResolvers = () => {
+  /**
+   * @type {any}
+   */
+  let _resolve;
+  /**
+   * @type {any}
+   */
+  let _reject;
+  const promise = new Promise((resolve, reject) => {
+    _resolve = resolve;
+    _reject = reject;
+  });
+  return {
+    resolve: _resolve,
+    reject: _reject,
+    promise
+  };
+};
+
+const getFirstEvent = (eventEmitter, eventMap) => {
+  const {
+    resolve,
+    promise
+  } = withResolvers();
+  const listenerMap = Object.create(null);
+  const cleanup = value => {
+    for (const event of Object.keys(eventMap)) {
+      eventEmitter.off(event, listenerMap[event]);
+    }
+    resolve(value);
+  };
+  for (const [event, type] of Object.entries(eventMap)) {
+    const listener = event => {
+      cleanup({
+        type,
+        event
+      });
+    };
+    eventEmitter.on(event, listener);
+    listenerMap[event] = listener;
+  }
+  return promise;
+};
+
+const getFirstWebSocketEvent = async webSocket => {
+  const {
+    WebSocket
+  } = await import('ws');
+  switch (webSocket.readyState) {
+    case WebSocket.OPEN:
+      return {
+        type: Open,
+        event: undefined
+      };
+    case WebSocket.CLOSED:
+      return {
+        type: Close,
+        event: undefined
+      };
+  }
+  // @ts-ignore
+  const {
+    type,
+    event
+  } = await getFirstEvent(webSocket, {
+    open: Open,
+    close: Close
+  });
+  return {
+    type,
+    event
+  };
+};
+
+const isWebSocketOpen = async webSocket => {
+  const {
+    WebSocket
+  } = await import('ws');
+  return webSocket.readyState === WebSocket.OPEN;
+};
+
+const serialize = message => {
+  return JSON.stringify(message);
+};
+const deserialize = message => {
+  return JSON.parse(message.toString());
+};
+
+const handleUpgrade = async (...args) => {
+  const module = await import('@lvce-editor/web-socket-server');
+  // @ts-ignore
+  return module.handleUpgrade(...args);
+};
+
+const listen = async ({
+  request,
+  handle
+}) => {
+  if (!request) {
+    throw new IpcError('request must be defined');
+  }
+  if (!handle) {
+    throw new IpcError('handle must be defined');
+  }
+  const webSocket = await handleUpgrade(request, handle);
+  webSocket.pause();
+  if (!(await isWebSocketOpen(webSocket))) {
+    await getFirstWebSocketEvent(webSocket);
+  }
+  return webSocket;
+};
+const wrap$3 = webSocket => {
+  return {
+    webSocket,
+    /**
+     * @type {any}
+     */
+    wrappedListener: undefined,
+    on(event, listener) {
+      switch (event) {
+        case 'message':
+          const wrappedListener = message => {
+            const data = deserialize(message);
+            listener(data);
+          };
+          webSocket.on('message', wrappedListener);
+          break;
+        case 'close':
+          webSocket.on('close', listener);
+          break;
+        default:
+          throw new Error('unknown event listener type');
+      }
+    },
+    off(event, listener) {
+      this.webSocket.off(event, listener);
+    },
+    send(message) {
+      const stringifiedMessage = serialize(message);
+      this.webSocket.send(stringifiedMessage);
+    },
+    dispose() {
+      this.webSocket.close();
+    },
+    start() {
+      this.webSocket.resume();
+    }
+  };
+};
+
+const IpcChildWithWebSocket = {
+  __proto__: null,
+  listen,
+  wrap: wrap$3
+};
+
+const Exit = 1;
+const Error$1 = 2;
+const Message = 3;
+
+/**
+ *
+ * @param {any} utilityProcess
+ * @returns
+ */
+const getFirstUtilityProcessEvent = async utilityProcess => {
+  const {
+    resolve,
+    promise
+  } = withResolvers();
+  let stdout = '';
+  let stderr = '';
+  const cleanup = value => {
+    // @ts-ignore
+    utilityProcess.stderr.off('data', handleStdErrData);
+    // @ts-ignore
+    utilityProcess.stdout.off('data', handleStdoutData);
+    utilityProcess.off('message', handleMessage);
+    utilityProcess.off('exit', handleExit);
+    resolve(value);
+  };
+  const handleStdErrData = data => {
+    stderr += data;
+  };
+  const handleStdoutData = data => {
+    stdout += data;
+  };
+  const handleMessage = event => {
+    cleanup({
+      type: Message,
+      event,
+      stdout,
+      stderr
+    });
+  };
+  const handleExit = event => {
+    cleanup({
+      type: Exit,
+      event,
+      stdout,
+      stderr
+    });
+  };
+  // @ts-ignore
+  utilityProcess.stderr.on('data', handleStdErrData);
+  // @ts-ignore
+  utilityProcess.stdout.on('data', handleStdoutData);
+  utilityProcess.on('message', handleMessage);
+  utilityProcess.on('exit', handleExit);
+  // @ts-ignore
+  const {
+    type,
+    event
+  } = await promise;
+  return {
+    type,
+    event,
+    stdout,
+    stderr
+  };
+};
+
+const create$2 = async ({
+  path,
+  argv = [],
+  execArgv = [],
+  name
+}) => {
+  string(path);
+  const actualArgv = ['--ipc-type=electron-utility-process', ...argv];
+  // @ts-ignore
+  const {
+    utilityProcess
+  } = await import('electron');
+  const childProcess = utilityProcess.fork(path, actualArgv, {
+    execArgv,
+    stdio: 'pipe',
+    serviceName: name
+  });
+  // @ts-ignore
+  childProcess.stdout.pipe(process.stdout);
+  const {
+    type,
+    event,
+    stdout,
+    stderr
+  } = await getFirstUtilityProcessEvent(childProcess);
+  if (type === Exit) {
+    throw new IpcError(`Utility process exited before ipc connection was established`, stdout, stderr);
+  }
+  // @ts-ignore
+  childProcess.stderr.pipe(process.stderr);
+  return childProcess;
+};
+const wrap$2 = process => {
+  return {
+    process,
+    on(event, listener) {
+      this.process.on(event, listener);
+    },
+    send(message) {
+      this.process.postMessage(message);
+    },
+    sendAndTransfer(message, transfer) {
+      array(transfer);
+      this.process.postMessage(message, transfer);
+    },
+    dispose() {
+      this.process.kill();
+    }
+  };
+};
+
+const IpcParentWithElectronUtilityProcess = {
+  __proto__: null,
+  create: create$2,
+  wrap: wrap$2
+};
+
+class ChildProcessError extends Error {
+  constructor(stderr) {
+    // @ts-ignore
+    const {
+      message,
+      code,
+      stack
+    } = getHelpfulChildProcessError('', stderr);
+    super(message || 'child process error');
+    this.name = 'ChildProcessError';
+    if (code) {
+      // @ts-ignore
+      this.code = code;
+    }
+    if (stack) {
+      const lines = splitLines(this.stack);
+      const [firstLine, ...stackLines] = lines;
+      const newStackLines = [firstLine, ...stack, ...stackLines];
+      const newStack = joinLines(newStackLines);
+      this.stack = newStack;
+    }
+  }
+}
+
+const getFirstNodeChildProcessEvent = async childProcess => {
+  // @ts-ignore
+  const {
+    type,
+    event,
+    stdout,
+    stderr
+  } = await new Promise((resolve, reject) => {
+    let stderr = '';
+    let stdout = '';
+    const cleanup = value => {
+      if (childProcess.stdout && childProcess.stderr) {
+        childProcess.stderr.off('data', handleStdErrData);
+        childProcess.stdout.off('data', handleStdoutData);
+      }
+      childProcess.off('message', handleMessage);
+      childProcess.off('exit', handleExit);
+      childProcess.off('error', handleError);
+      resolve(value);
+    };
+    const handleStdErrData = data => {
+      stderr += data;
+    };
+    const handleStdoutData = data => {
+      stdout += data;
+    };
+    const handleMessage = event => {
+      cleanup({
+        type: Message,
+        event,
+        stdout,
+        stderr
+      });
+    };
+    const handleExit = event => {
+      cleanup({
+        type: Exit,
+        event,
+        stdout,
+        stderr
+      });
+    };
+    const handleError = event => {
+      cleanup({
+        type: Error$1,
+        event,
+        stdout,
+        stderr
+      });
+    };
+    if (childProcess.stdout && childProcess.stderr) {
+      childProcess.stderr.on('data', handleStdErrData);
+      childProcess.stdout.on('data', handleStdoutData);
+    }
+    childProcess.on('message', handleMessage);
+    childProcess.on('exit', handleExit);
+    childProcess.on('error', handleError);
+  });
+  return {
+    type,
+    event,
+    stdout,
+    stderr
+  };
+};
+
+const create$1 = async ({
+  path,
+  argv = [],
+  env,
+  execArgv = [],
+  stdio = 'inherit',
+  name = 'child process'
+}) => {
+  try {
+    string(path);
+    const actualArgv = ['--ipc-type=node-forked-process', ...argv];
+    const childProcess = fork(path, actualArgv, {
+      env,
+      execArgv,
+      stdio: 'pipe'
+    });
+    const {
+      type,
+      event,
+      stdout,
+      stderr
+    } = await getFirstNodeChildProcessEvent(childProcess);
+    if (type === Exit) {
+      throw new ChildProcessError(stderr);
+    }
+    if (type === Error$1) {
+      throw new Error(`child process had an error ${event}`);
+    }
+    if (stdio === 'inherit' && childProcess.stdout && childProcess.stderr) {
+      childProcess.stdout.pipe(process.stdout);
+      childProcess.stderr.pipe(process.stderr);
+    }
+    return childProcess;
+  } catch (error) {
+    throw new VError(error, `Failed to launch ${name}`);
+  }
+};
+const wrap$1 = childProcess => {
+  return {
+    childProcess,
+    on(event, listener) {
+      this.childProcess.on(event, listener);
+    },
+    off(event, listener) {
+      this.childProcess.off(event, listener);
+    },
+    send(message) {
+      this.childProcess.send(message);
+    },
+    sendAndTransfer(message, handle) {
+      this.childProcess.send(message, handle);
+    },
+    dispose() {
+      this.childProcess.kill();
+    },
+    pid: childProcess.pid
+  };
+};
+
+const IpcParentWithNodeForkedProcess = {
+  __proto__: null,
+  create: create$1,
+  wrap: wrap$1
+};
+
+const getFirstNodeWorkerEvent = worker => {
+  return getFirstEvent(worker, {
+    exit: Exit,
+    error: Error$1
+  });
+};
+
+const create = async ({
+  path,
+  argv = [],
+  env = process.env,
+  execArgv = []
+}) => {
+  string(path);
+  const actualArgv = ['--ipc-type=node-worker', ...argv];
+  const actualEnv = {
+    ...env,
+    ELECTRON_RUN_AS_NODE: '1'
+  };
+  const worker = new Worker(path, {
+    argv: actualArgv,
+    env: actualEnv,
+    execArgv
+  });
+  // @ts-ignore
+  const {
+    type,
+    event
+  } = await getFirstNodeWorkerEvent(worker);
+  if (type === Exit) {
+    throw new IpcError(`Worker exited before ipc connection was established`);
+  }
+  if (type === Error$1) {
+    throw new IpcError(`Worker threw an error before ipc connection was established: ${event}`);
+  }
+  if (event !== 'ready') {
+    throw new IpcError('unexpected first message from worker');
+  }
+  return worker;
+};
+const wrap = worker => {
+  return {
+    worker,
+    on(event, listener) {
+      this.worker.on(event, listener);
+    },
+    send(message) {
+      this.worker.postMessage(message);
+    },
+    sendAndTransfer(message, transfer) {
+      array(transfer);
+      this.worker.postMessage(message, transfer);
+    },
+    dispose() {
+      this.worker.terminate();
+    }
+  };
+};
+
+const IpcParentWithNodeWorker = {
+  __proto__: null,
+  create,
+  wrap
+};
+
+export { IpcChildWithElectronMessagePort, IpcChildWithElectronUtilityProcess, IpcChildWithNodeForkedProcess, IpcChildWithWebSocket, IpcParentWithElectronUtilityProcess, IpcParentWithNodeForkedProcess, IpcParentWithNodeWorker };