@lvce-editor/ipc 10.0.2 → 10.0.4

package/dist/electron.js

@@ -37,6 +37,102 @@ const Exit = 1;
 const Error$1 = 2;
 const Message = 3;
 
+const walkValue = (value, transferrables, isTransferrable) => {
+  if (!value) {
+    return;
+  }
+  if (isTransferrable(value)) {
+    transferrables.push(value);
+    return;
+  }
+  if (Array.isArray(value)) {
+    for (const item of value) {
+      walkValue(item, transferrables, isTransferrable);
+    }
+    return;
+  }
+  if (typeof value === 'object') {
+    for (const property of Object.values(value)) {
+      walkValue(property, transferrables, isTransferrable);
+    }
+    return;
+  }
+};
+
+const isMessagePort = value => {
+  return value && value instanceof MessagePort;
+};
+
+const isMessagePortMain = value => {
+  return value && value.constructor && value.constructor.name === 'MessagePortMain';
+};
+
+const isOffscreenCanvas = value => {
+  return typeof OffscreenCanvas !== 'undefined' && value instanceof OffscreenCanvas;
+};
+
+const isInstanceOf = (value, constructorName) => {
+  return value?.constructor?.name === constructorName;
+};
+
+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 getTransferrables = value => {
+  const transferrables = [];
+  walkValue(value, transferrables, isTransferrable);
+  return transferrables;
+};
+
+const removeValues = (value, toRemove) => {
+  if (!value) {
+    return value;
+  }
+  if (Array.isArray(value)) {
+    const newItems = [];
+    for (const item of value) {
+      if (!toRemove.includes(item)) {
+        newItems.push(removeValues(item, toRemove));
+      }
+    }
+    return newItems;
+  }
+  if (typeof value === 'object') {
+    const newObject = Object.create(null);
+    for (const [key, property] of Object.entries(value)) {
+      if (!toRemove.includes(property)) {
+        newObject[key] = removeValues(property, toRemove);
+      }
+    }
+    return newObject;
+  }
+  return value;
+};
+
+// workaround for electron not supporting transferrable objects
+// as parameters. If the transferrable object is a parameter, in electron
+// only an empty objected is received in the main process
+const fixElectronParameters = value => {
+  const transfer = getTransferrables(value);
+  const newValue = removeValues(value, transfer);
+  return {
+    newValue,
+    transfer
+  };
+};
+
 const withResolvers = () => {
   let _resolve;
   const promise = new Promise(resolve => {
@@ -340,65 +436,6 @@ class IpcError extends VError {
   }
 }
 
-const walkValue = (value, transferrables, isTransferrable) => {
-  if (!value) {
-    return;
-  }
-  if (isTransferrable(value)) {
-    transferrables.push(value);
-    return;
-  }
-  if (Array.isArray(value)) {
-    for (const item of value) {
-      walkValue(item, transferrables, isTransferrable);
-    }
-    return;
-  }
-  if (typeof value === 'object') {
-    for (const property of Object.values(value)) {
-      walkValue(property, transferrables, isTransferrable);
-    }
-    return;
-  }
-};
-
-const isMessagePort = value => {
-  return value && value instanceof MessagePort;
-};
-
-const isMessagePortMain = value => {
-  return value && value.constructor && value.constructor.name === 'MessagePortMain';
-};
-
-const isOffscreenCanvas = value => {
-  return typeof OffscreenCanvas !== 'undefined' && value instanceof OffscreenCanvas;
-};
-
-const isInstanceOf = (value, constructorName) => {
-  return value?.constructor?.name === constructorName;
-};
-
-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 getTransferrables = value => {
-  const transferrables = [];
-  walkValue(value, transferrables, isTransferrable);
-  return transferrables;
-};
-
 // @ts-ignore
 const create$2 = async ({
   path,
@@ -447,8 +484,11 @@ class IpcParentWithElectronUtilityProcess extends Ipc {
     this._rawIpc.postMessage(message);
   }
   sendAndTransfer(message) {
-    const transfer = getTransferrables(message);
-    this._rawIpc.postMessage(message, transfer);
+    const {
+      newValue,
+      transfer
+    } = fixElectronParameters(message);
+    this._rawIpc.postMessage(newValue, transfer);
   }
   dispose() {
     this._rawIpc.kill();
@@ -496,6 +536,21 @@ class ChildProcessError extends Error {
   }
 }
 
+// workaround for node not supporting transferrable objects
+// as parameters. If the transferrable object is a parameter,
+// it is received as a plain object is received in the receiving process
+const fixNodeParameters = value => {
+  const transfer = getTransferrables(value);
+  if (transfer.length === 0) {
+    throw new Error('no transferrables found');
+  }
+  const newValue = removeValues(value, transfer);
+  return {
+    newValue,
+    transfer: transfer[0]
+  };
+};
+
 // @ts-ignore
 const getFirstNodeChildProcessEvent = async childProcess => {
   // @ts-ignore
@@ -569,14 +624,6 @@ const getFirstNodeChildProcessEvent = async childProcess => {
   };
 };
 
-const getTransferrablesNode = value => {
-  const transferrables = getTransferrables(value);
-  if (transferrables.length === 0) {
-    throw new Error(`no transferrables found`);
-  }
-  return transferrables[0];
-};
-
 // @ts-ignore
 const create$1 = async ({
   path,
@@ -629,8 +676,11 @@ class IpcParentWithNodeForkedProcess extends Ipc {
     this._rawIpc.send(message);
   }
   sendAndTransfer(message) {
-    const transfer = getTransferrablesNode(message);
-    this._rawIpc.send(message, transfer);
+    const {
+      newValue,
+      transfer
+    } = fixNodeParameters(message);
+    this._rawIpc.send(newValue, transfer);
   }
   dispose() {
     this._rawIpc.kill();
@@ -761,8 +811,11 @@ const wrap = worker => {
     },
     // @ts-ignore
     sendAndTransfer(message) {
-      const transfer = getTransferrablesNode(message);
-      this.worker.postMessage(message, transfer);
+      const {
+        newValue,
+        transfer
+      } = fixNodeParameters(message);
+      this.worker.postMessage(newValue, transfer);
     },
     dispose() {
       this.worker.terminate();

package/dist/index.js

@@ -275,7 +275,7 @@ const listen$8 = ({
 const signal$6 = messagePort => {
   messagePort.start();
 };
-const getActualData = event => {
+const getActualData$1 = event => {
   const {
     data,
     ports
@@ -293,7 +293,7 @@ class IpcChildWithElectronMessagePort extends Ipc {
     super(port);
   }
   getData(event) {
-    return getActualData(event);
+    return getActualData$1(event);
   }
   send(message) {
     this._rawIpc.postMessage(message);
@@ -524,6 +524,16 @@ const getTransferrablesNode = value => {
   return transferrables[0];
 };
 
+const getActualData = (message, handle) => {
+  if (handle) {
+    return {
+      ...message,
+      params: [handle, ...message.params]
+    };
+  }
+  return message;
+};
+
 const listen$4 = async () => {
   if (!process.send) {
     throw new Error('process.send must be defined');
@@ -537,8 +547,8 @@ class IpcChildWithNodeForkedProcess extends Ipc {
   constructor(process) {
     super(process);
   }
-  getData(message) {
-    return message;
+  getData(message, handle) {
+    return getActualData(message, handle);
   }
   onClose(callback) {
     this._rawIpc.on('close', callback);
@@ -630,9 +640,9 @@ const wrap$5 = parentPort => {
   return {
     parentPort,
     on(event, listener) {
-      const wrappedListener = message => {
+      const wrappedListener = (message, handle) => {
         const event = {
-          data: message,
+          data: getActualData(message, handle),
           target: this
         };
         listener(event);
@@ -1004,8 +1014,11 @@ class IpcParentWithElectronUtilityProcess extends Ipc {
     this._rawIpc.postMessage(message);
   }
   sendAndTransfer(message) {
-    const transfer = getTransferrables(message);
-    this._rawIpc.postMessage(message, transfer);
+    const {
+      newValue,
+      transfer
+    } = fixElectronParameters(message);
+    this._rawIpc.postMessage(newValue, transfer);
   }
   dispose() {
     this._rawIpc.kill();
@@ -1053,6 +1066,21 @@ class ChildProcessError extends Error {
   }
 }
 
+// workaround for node not supporting transferrable objects
+// as parameters. If the transferrable object is a parameter,
+// it is received as a plain object is received in the receiving process
+const fixNodeParameters = value => {
+  const transfer = getTransferrables(value);
+  if (transfer.length === 0) {
+    throw new Error('no transferrables found');
+  }
+  const newValue = removeValues(value, transfer);
+  return {
+    newValue,
+    transfer: transfer[0]
+  };
+};
+
 // @ts-ignore
 const getFirstNodeChildProcessEvent = async childProcess => {
   // @ts-ignore
@@ -1178,8 +1206,11 @@ class IpcParentWithNodeForkedProcess extends Ipc {
     this._rawIpc.send(message);
   }
   sendAndTransfer(message) {
-    const transfer = getTransferrablesNode(message);
-    this._rawIpc.send(message, transfer);
+    const {
+      newValue,
+      transfer
+    } = fixNodeParameters(message);
+    this._rawIpc.send(newValue, transfer);
   }
   dispose() {
     this._rawIpc.kill();
@@ -1269,8 +1300,11 @@ const wrap = worker => {
     },
     // @ts-ignore
     sendAndTransfer(message) {
-      const transfer = getTransferrablesNode(message);
-      this.worker.postMessage(message, transfer);
+      const {
+        newValue,
+        transfer
+      } = fixNodeParameters(message);
+      this.worker.postMessage(newValue, transfer);
     },
     dispose() {
       this.worker.terminate();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lvce-editor/ipc",
-  "version": "10.0.2",
+  "version": "10.0.4",
   "description": "Inter Process Communication for Lvce Editor",
   "main": "dist/index.js",
   "type": "module",