@lvce-editor/json-rpc 1.4.0 → 2.1.0

package/dist/index.d.ts

@@ -6,24 +6,46 @@ export const invoke: (
   ...params: any[]
 ) => Promise<any>
 
-export const invokeAndTransfer: (
-  ipc: any,
-  transfer: any,
-  method: string,
-  ...params: any[]
-) => Promise<any>
+interface InvokeAndTransfer {
+  (ipc: any, transfer: any, method: string, ...params: any[]): Promise<any>
+  (ipc: any, method: string, ...params: any[]): Promise<any>
+}
+
+export const invokeAndTransfer: InvokeAndTransfer
 
 export const resolve: (id: number, message: any) => void
 
-export const handleJsonRpcMessage: (
-  ipc: any,
-  message: any,
-  execute: (method: string, ...params: any[]) => Promise<any>,
-  resolve: any,
-  preparePrettyError: (error: any) => any,
-  logError: (error: any) => void,
-  requiresSocket: (method: string) => void,
-) => Promise<void>
+interface HandleJsonRpcMessage {
+  (
+    ipc: any,
+    message: any,
+    execute: (method: string, ...params: any[]) => Promise<any>,
+    resolve: any,
+    preparePrettyError: (error: any) => any,
+    logError: (error: any) => void,
+    requiresSocket: (method: string) => void,
+  ): Promise<void>
+
+  ({
+    ipc,
+    message,
+    execute,
+    resolve,
+    preparePrettyError,
+    logError,
+    requiresSocket,
+  }: {
+    ipc: any
+    message: any
+    execute: (method: string, ...params: any[]) => Promise<any>
+    resolve?: any
+    preparePrettyError: (error: any) => any
+    logError: (error: any) => void
+    requiresSocket: (method: string) => void
+  }): Promise<void>
+}
+
+export const handleJsonRpcMessage: HandleJsonRpcMessage
 
 export const getErrorResponse: (
   message: any,

package/dist/index.js

@@ -150,7 +150,6 @@ const getErrorConstructor = (message, type) => {
   if (type) {
     switch (type) {
       case DomException:
-        // @ts-ignore
         return DOMException;
       case TypeError$1:
         return TypeError;
@@ -176,7 +175,6 @@ const getErrorConstructor = (message, type) => {
 
 const constructError = (message, type, name) => {
   const ErrorConstructor = getErrorConstructor(message, type);
-  // @ts-ignore
   if (ErrorConstructor === DOMException && name) {
     return new ErrorConstructor(message, name);
   }
@@ -194,6 +192,14 @@ const getNewLineIndex = (string, startIndex = undefined) => {
   return string.indexOf(NewLine, startIndex);
 };
 
+const getParentStack = error => {
+  let parentStack = error.stack || error.data || error.message || '';
+  if (parentStack.startsWith('    at')) {
+    parentStack = error.message + NewLine + parentStack;
+  }
+  return parentStack;
+};
+
 const joinLines = lines => {
   return lines.join(NewLine);
 };
@@ -205,18 +211,11 @@ const splitLines = lines => {
   return lines.split(NewLine);
 };
 
-const getParentStack = error => {
-  let parentStack = error.stack || error.data || error.message || '';
-  if (parentStack.startsWith('    at')) {
-    parentStack = error.message + NewLine + parentStack;
-  }
-  return parentStack;
-};
 const restoreJsonRpcError = error => {
   if (error && error instanceof Error) {
     return error;
   }
-  const currentStack = joinLines(splitLines(new Error().stack).slice(1));
+  const currentStack = joinLines(splitLines(new Error().stack || '').slice(1));
   if (error && error.code && error.code === MethodNotFound) {
     const restoredError = new JsonRpcError(error.message);
     const parentStack = getParentStack(error);
@@ -245,7 +244,6 @@ const restoreJsonRpcError = error => {
       }
     } else {
       if (error.stack) {
-        // TODO accessing stack might be slow
         const lowerStack = restoredError.stack || '';
         // @ts-ignore
         const indexNewLine = getNewLineIndex(lowerStack);
@@ -277,6 +275,78 @@ const unwrapJsonRpcResult = responseMessage => {
   throw new JsonRpcError('unexpected response message');
 };
 
+const isMessagePort = value => {
+  return typeof MessagePort !== 'undefined' && value instanceof MessagePort;
+};
+
+const isInstanceOf = (value, constructorName) => {
+  return value?.constructor?.name === constructorName;
+};
+
+const isMessagePortMain = value => {
+  return isInstanceOf(value, 'MessagePortMain');
+};
+
+const isOffscreenCanvas = value => {
+  return typeof OffscreenCanvas !== 'undefined' && value instanceof OffscreenCanvas;
+};
+
+const isSocket = value => {
+  return isInstanceOf(value, 'Socket');
+};
+
+const transferrables = [isMessagePort, isMessagePortMain, isOffscreenCanvas, isSocket];
+
+const isTransferrable = value => {
+  for (const fn of transferrables) {
+    if (fn(value)) {
+      return true;
+    }
+  }
+  return false;
+};
+
+const walkValue = (value, transferrables) => {
+  if (!value) {
+    return;
+  }
+  if (isTransferrable(value)) {
+    transferrables.push(value);
+  }
+  if (Array.isArray(value)) {
+    for (const item of value) {
+      walkValue(item, transferrables);
+    }
+    return;
+  }
+  if (typeof value === 'object') {
+    for (const property of Object.values(value)) {
+      walkValue(property, transferrables);
+    }
+  }
+};
+
+const getTransferrables = value => {
+  const transferrables = [];
+  walkValue(value, transferrables);
+  return transferrables;
+};
+
+const isSingleTransferrable = value => {
+  return isSocket(value);
+};
+
+const getTransferrableParams = value => {
+  const transferrables = getTransferrables(value);
+  if (transferrables.length === 0) {
+    return undefined;
+  }
+  if (isSingleTransferrable(transferrables[0])) {
+    return transferrables[0];
+  }
+  return transferrables;
+};
+
 const create$1 = (message, error) => {
   return {
     jsonrpc: Two,
@@ -335,7 +405,42 @@ const getResponse = async (message, ipc, execute, preparePrettyError, logError,
   }
 };
 
-const handleJsonRpcMessage = async (ipc, message, execute, resolve, preparePrettyError, logError, requiresSocket) => {
+const defaultPreparePrettyError = error => {
+  return error;
+};
+const defaultLogError = () => {
+  // ignore
+};
+const defaultRequiresSocket = () => {
+  return false;
+};
+const defaultResolve = resolve;
+const handleJsonRpcMessage = async (...args) => {
+  let message;
+  let ipc;
+  let execute;
+  let preparePrettyError;
+  let logError;
+  let resolve;
+  let requiresSocket;
+  if (args.length === 1) {
+    const arg = args[0];
+    message = arg.message;
+    ipc = arg.ipc;
+    execute = arg.execute;
+    preparePrettyError = arg.preparePrettyError || defaultPreparePrettyError;
+    logError = arg.logError || defaultLogError;
+    requiresSocket = arg.requiresSocket || defaultRequiresSocket;
+    resolve = arg.resolve || defaultResolve;
+  } else {
+    ipc = args[0];
+    message = args[1];
+    execute = args[2];
+    resolve = args[3];
+    preparePrettyError = args[4];
+    logError = args[5];
+    requiresSocket = args[6];
+  }
   if ('id' in message) {
     if ('method' in message) {
       const response = await getResponse(message, ipc, execute, preparePrettyError, logError, requiresSocket);
@@ -371,12 +476,21 @@ const invoke = async (ipc, method, ...params) => {
   const result = unwrapJsonRpcResult(responseMessage);
   return result;
 };
+
+// TODO deprecated old typings,
+// always use automatic transferrable detection
 const invokeAndTransfer = async (ipc, handle, method, ...params) => {
+  let transfer = handle;
+  if (typeof handle === 'string') {
+    params = [method, ...params];
+    method = handle;
+    transfer = getTransferrableParams(params);
+  }
   const {
     message,
     promise
   } = create$2(method, params);
-  ipc.sendAndTransfer(message, handle);
+  ipc.sendAndTransfer(message, transfer);
   const responseMessage = await promise;
   const result = unwrapJsonRpcResult(responseMessage);
   return result;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lvce-editor/json-rpc",
-  "version": "1.4.0",
+  "version": "2.1.0",
   "description": "JsonRpc implementation",
   "main": "dist/index.js",
   "type": "module",