@lvce-editor/shared-process 0.22.1 → 0.22.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lvce-editor/shared-process",
-  "version": "0.22.1",
+  "version": "0.22.2",
   "main": "index.js",
   "type": "module",
   "keywords": [
@@ -17,23 +17,21 @@
     "node": ">=18"
   },
   "dependencies": {
-    "@lvce-editor/assert": "^1.0.1",
-    "@lvce-editor/extension-host": "0.22.1",
-    "@lvce-editor/extension-host-helper-process": "0.22.1",
+    "@lvce-editor/assert": "^1.1.0",
+    "@lvce-editor/extension-host-helper-process": "0.22.2",
     "@lvce-editor/json-rpc": "^1.0.0",
     "@lvce-editor/jsonc-parser": "^1.1.0",
-    "@lvce-editor/pretty-error": "^1.3.0",
-    "@lvce-editor/pty-host": "0.22.1",
+    "@lvce-editor/pretty-error": "^1.4.0",
+    "@lvce-editor/pty-host": "0.22.2",
     "@lvce-editor/verror": "^1.1.2",
+    "@lvce-editor/web-socket-server": "^1.1.0",
     "debug": "^4.3.4",
     "execa": "^8.0.1",
     "exit-hook": "^4.0.0",
     "got": "^13.0.0",
     "is-object": "^1.0.2",
     "p-queue": "^8.0.1",
-    "parse-json": "^8.1.0",
     "tar-fs": "^3.0.4",
-    "ws": "^8.16.0",
     "xdg-basedir": "^5.1.0"
   },
   "optionalDependencies": {

package/src/parts/ExtensionHostHelperProcessIpc/ExtensionHostHelperProcessIpc.js

@@ -1,12 +1,15 @@
 import * as IpcParent from '../IpcParent/IpcParent.js'
 import * as PlatformPaths from '../PlatformPaths/PlatformPaths.js'
+import * as Id from '../Id/Id.js'
 
 export const create = async ({ method }) => {
   const extensionHostHelperProcessPath = await PlatformPaths.getExtensionHostHelperProcessPath()
+  const id = Id.create()
   const ipc = await IpcParent.create({
     method,
     path: extensionHostHelperProcessPath,
     execArgv: ['--max-old-space-size=60', '--enable-source-maps'],
+    name: `Extension Host Helper Process ${id}`,
   })
   return ipc
 }

package/src/parts/ExtensionManagement/ExtensionManagement.js

@@ -31,51 +31,63 @@ export const disable = async (id) => {
 }
 
 export const getBuiltinExtensions = () => {
-  return ExtensionManifests.getAll([
-    {
-      type: ExtensionManifestInputType.Folder,
-      path: PlatformPaths.getBuiltinExtensionsPath(),
-    },
-  ])
+  return ExtensionManifests.getAll(
+    [
+      {
+        type: ExtensionManifestInputType.Folder,
+        path: PlatformPaths.getBuiltinExtensionsPath(),
+      },
+    ],
+    PlatformPaths.getBuiltinExtensionsPath(),
+  )
 }
 
 export const getInstalledExtensions = () => {
-  return ExtensionManifests.getAll([
-    {
-      type: ExtensionManifestInputType.Folder,
-      path: PlatformPaths.getExtensionsPath(),
-    },
-  ])
+  return ExtensionManifests.getAll(
+    [
+      {
+        type: ExtensionManifestInputType.Folder,
+        path: PlatformPaths.getExtensionsPath(),
+      },
+    ],
+    PlatformPaths.getBuiltinExtensionsPath(),
+  )
 }
 
 export const getExtensions = () => {
-  return ExtensionManifests.getAll([
-    {
-      type: ExtensionManifestInputType.OnlyExtension,
-      path: PlatformPaths.getOnlyExtensionPath(),
-    },
-    {
-      type: ExtensionManifestInputType.Folder,
-      path: PlatformPaths.getLinkedExtensionsPath(),
-    },
-    {
-      type: ExtensionManifestInputType.Folder,
-      path: PlatformPaths.getExtensionsPath(),
-    },
-    {
-      type: ExtensionManifestInputType.Folder,
-      path: PlatformPaths.getBuiltinExtensionsPath(),
-    },
-  ])
+  return ExtensionManifests.getAll(
+    [
+      {
+        type: ExtensionManifestInputType.OnlyExtension,
+        path: PlatformPaths.getOnlyExtensionPath(),
+      },
+      {
+        type: ExtensionManifestInputType.Folder,
+        path: PlatformPaths.getLinkedExtensionsPath(),
+      },
+      {
+        type: ExtensionManifestInputType.Folder,
+        path: PlatformPaths.getExtensionsPath(),
+      },
+      {
+        type: ExtensionManifestInputType.Folder,
+        path: PlatformPaths.getBuiltinExtensionsPath(),
+      },
+    ],
+    PlatformPaths.getBuiltinExtensionsPath(),
+  )
 }
 
 export const getDisabledExtensions = () => {
-  return ExtensionManifests.getAll([
-    {
-      type: ExtensionManifestInputType.Folder,
-      path: PlatformPaths.getDisabledExtensionsPath(),
-    },
-  ])
+  return ExtensionManifests.getAll(
+    [
+      {
+        type: ExtensionManifestInputType.Folder,
+        path: PlatformPaths.getDisabledExtensionsPath(),
+      },
+    ],
+    PlatformPaths.getBuiltinExtensionsPath(),
+  )
 }
 
 export * from '../ExtensionUninstall/ExtensionUninstall.js'

package/src/parts/ExtensionManifests/ExtensionManifests.js

@@ -21,7 +21,7 @@ const get = (input) => {
   return module.getExtensionManifests(input.path)
 }
 
-const deduplicateExtensions = (extensions) => {
+const deduplicateExtensions = (extensions, builtinExtensionsPath) => {
   const seen = Object.create(null)
   const uniqueExtensions = []
   for (const extension of extensions) {
@@ -29,14 +29,17 @@ const deduplicateExtensions = (extensions) => {
       continue
     }
     seen[extension.id] = true
+    if (extension.path.startsWith(builtinExtensionsPath)) {
+      extension.builtin = true
+    }
     uniqueExtensions.push(extension)
   }
   return uniqueExtensions
 }
 
-export const getAll = async (inputs) => {
+export const getAll = async (inputs, builtinExtensionsPath) => {
   const manifests = await Promise.all(inputs.map(get))
   const flatManifests = manifests.flat(1)
-  const uniqueExtensions = deduplicateExtensions(flatManifests)
+  const uniqueExtensions = deduplicateExtensions(flatManifests, builtinExtensionsPath)
   return uniqueExtensions
 }

package/src/parts/GetUtilityProcessPortData/GetUtilityProcessPortData.js

@@ -0,0 +1,10 @@
+export const getUtilityProcessPortData = (event) => {
+  const { data, ports } = event
+  if (ports.length === 0) {
+    return data
+  }
+  return {
+    ...data,
+    params: [...ports, ...data.params],
+  }
+}

package/src/parts/HandleElectronMessagePort/HandleElectronMessagePort.js

@@ -10,7 +10,6 @@ export const handleElectronMessagePort = async (messagePort, ...params) => {
     messagePort,
   })
   HandleIpc.handleIpc(ipc)
-  messagePort.start()
   // TODO find better way to associate configuration with ipc
   ipc.windowId = params[1]
 }

package/src/parts/HandleIpc/HandleIpc.js

@@ -19,4 +19,7 @@ export const handleIpc = (ipc) => {
     return JsonRpc.handleJsonRpcMessage(ipc, message, Command.execute, Callback.resolve, preparePrettyError, logError, RequiresSocket.requiresSocket)
   }
   ipc.on('message', handleMessage)
+  if (ipc.start) {
+    ipc.start()
+  }
 }

package/src/parts/HandleMessagePortForExtensionHostHelperProcess/HandleMessagePortForExtensionHostHelperProcess.js

@@ -1,8 +1,24 @@
 import * as Assert from '../Assert/Assert.js'
+import * as ExtensionHostHelperProcessIpc from '../ExtensionHostHelperProcessIpc/ExtensionHostHelperProcessIpc.js'
+import * as HandleIpc from '../HandleIpc/HandleIpc.js'
+import * as IpcParentType from '../IpcParentType/IpcParentType.js'
+import * as JsonRpc from '../JsonRpc/JsonRpc.js'
 
-export const handleMessagePortForExtensionHostHelperProcess = async (port) => {
+// TODO connect this ipc to the renderer worker ipc
+// when renderer worker ipc closes, dispose all
+// matching extension host helper processes
+// unless the app is exiting, in which case the child processes
+// would get cleaned up automatically
+export const handleMessagePortForExtensionHostHelperProcess = async (rendererWorkerIpc, port) => {
   Assert.object(port)
-  // TODO
-  // 1. create extension host helper utility process
-  // 2. send message port to utility process
+  const ipc = await ExtensionHostHelperProcessIpc.create({
+    method: IpcParentType.ElectronUtilityProcess,
+  })
+  HandleIpc.handleIpc(ipc)
+  await JsonRpc.invokeAndTransfer(ipc, [port], 'HandleElectronMessagePort.handleElectronMessagePort')
+  const cleanup = () => {
+    ipc.dispose()
+    rendererWorkerIpc.off('close', cleanup)
+  }
+  rendererWorkerIpc.on('close', cleanup)
 }

package/src/parts/HandleNodeMessagePort/HandleNodeMessagePort.js

@@ -8,5 +8,4 @@ export const handleNodeMessagePort = async (messagePort) => {
     messagePort,
   })
   HandleIpc.handleIpc(ipc)
-  messagePort.start()
 }

package/src/parts/HandleWebSocket/HandleWebSocket.js

@@ -18,7 +18,6 @@ export const handleWebSocket = async (message, handle) => {
     handle.pause()
     const module = await HandleWebSocketModule.load(protocol)
     await module.handleWebSocket(message, handle, protocol)
-    handle.resume()
   } catch (error) {
     DestroyWebSocket.destroySocket(handle)
     throw new VError(error, `Failed to connect to websocket`)

package/src/parts/HandleWebSocketForSharedProcess/HandleWebSocketForSharedProcess.js

@@ -1,15 +1,17 @@
+import * as Assert from '../Assert/Assert.js'
 import * as HandleIpc from '../HandleIpc/HandleIpc.js'
 import * as HandleSocketError from '../HandleSocketError/HandleSocketError.js'
 import * as IpcChild from '../IpcChild/IpcChild.js'
 import * as IpcChildType from '../IpcChildType/IpcChildType.js'
-import * as WebSocketServer from '../WebSocketServer/WebSocketServer.js'
 
-export const handleWebSocket = async (message, handle) => {
+export const handleWebSocket = async (request, handle) => {
+  Assert.object(request)
+  Assert.object(handle)
   handle.on('error', HandleSocketError.handleSocketError)
-  const webSocket = await WebSocketServer.handleUpgrade(message, handle)
   const ipc = await IpcChild.listen({
     method: IpcChildType.WebSocket,
-    webSocket,
+    request,
+    handle,
   })
   HandleIpc.handleIpc(ipc)
 }

package/src/parts/IpcChildWithElectronMessagePort/IpcChildWithElectronMessagePort.js

@@ -44,5 +44,8 @@ export const wrap = (messagePort) => {
     dispose() {
       this.messagePort.close()
     },
+    start() {
+      this.messagePort.start()
+    },
   }
 }

package/src/parts/IpcChildWithElectronUtilityProcess/IpcChildWithElectronUtilityProcess.js

@@ -1,3 +1,5 @@
+import * as GetUtilityProcessPortData from '../GetUtilityProcessPortData/GetUtilityProcessPortData.js'
+
 export const listen = () => {
   // @ts-ignore
   const { parentPort } = process
@@ -11,24 +13,13 @@ export const signal = (parentPort) => {
   parentPort.postMessage('ready')
 }
 
-const getActualData = (event) => {
-  const { data, ports } = event
-  if (ports.length === 0) {
-    return data
-  }
-  return {
-    ...data,
-    params: [...ports, ...data.params],
-  }
-}
-
 export const wrap = (parentPort) => {
   return {
     parentPort,
     on(event, listener) {
       if (event === 'message') {
         const wrappedListener = (event) => {
-          const actualData = getActualData(event)
+          const actualData = GetUtilityProcessPortData.getUtilityProcessPortData(event)
           listener(actualData)
         }
         this.parentPort.on(event, wrappedListener)

package/src/parts/IpcChildWithNodeMessagePort/IpcChildWithNodeMessagePort.js

@@ -37,5 +37,8 @@ export const wrap = (messagePort) => {
     dispose() {
       this.messagePort.close()
     },
+    start() {
+      this.messagePort.start()
+    },
   }
 }

package/src/parts/IpcChildWithWebSocket/IpcChildWithWebSocket.js

@@ -1,7 +1,18 @@
 import * as GetFirstWebSocketEvent from '../GetFirstWebSocketEvent/GetFirstWebSocketEvent.js'
+import { IpcError } from '../IpcError/IpcError.js'
 import * as IsWebSocketOpen from '../IsWebSocketOpen/IsWebSocketOpen.js'
+import * as WebSocketSerialization from '../WebSocketSerialization/WebSocketSerialization.js'
+import * as WebSocketServer from '../WebSocketServer/WebSocketServer.js'
 
-export const listen = async ({ webSocket }) => {
+export 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 WebSocketServer.handleUpgrade(request, handle)
+  webSocket.pause()
   if (!IsWebSocketOpen.isWebSocketOpen(webSocket)) {
     const { type, event } = await GetFirstWebSocketEvent.getFirstWebSocketEvent(webSocket)
     console.log({ type, event })
@@ -9,11 +20,6 @@ export const listen = async ({ webSocket }) => {
   return webSocket
 }
 
-const getActualData = (message) => {
-  const data = JSON.parse(message.toString())
-  return data
-}
-
 export const wrap = (webSocket) => {
   return {
     webSocket,
@@ -25,14 +31,11 @@ export const wrap = (webSocket) => {
       switch (event) {
         case 'message':
           const wrappedListener = (message) => {
-            const data = getActualData(message)
+            const data = WebSocketSerialization.deserialize(message)
             listener(data)
           }
           webSocket.on('message', wrappedListener)
           break
-        case 'close':
-          webSocket.on('close', listener)
-          break
         default:
           throw new Error('unknown event listener type')
       }
@@ -41,11 +44,14 @@ export const wrap = (webSocket) => {
       this.webSocket.off(event, listener)
     },
     send(message) {
-      const stringifiedMessage = JSON.stringify(message)
+      const stringifiedMessage = WebSocketSerialization.serialize(message)
       this.webSocket.send(stringifiedMessage)
     },
     dispose() {
       this.webSocket.close()
     },
+    start() {
+      this.webSocket.resume()
+    },
   }
 }

package/src/parts/IpcParentWithElectronUtilityProcess/IpcParentWithElectronUtilityProcess.js

@@ -13,6 +13,7 @@ export const create = async (options) => {
   })
   // TODO use uuid instead of name
   const port = await TemporaryMessagePort.create(options.name)
+  port.name = options.name
   return port
 }
 
@@ -43,6 +44,7 @@ export const wrap = (port) => {
     off(event, listener) {},
     dispose() {
       this.port.close()
+      ParentIpc.invoke('TemporaryMessagePort.dispose', this.port.name)
     },
   }
 }

package/src/parts/Platform/Platform.js

@@ -61,11 +61,11 @@ export const getSetupName = () => {
   return 'Lvce-Setup'
 }
 
-export const version = '0.22.1'
+export const version = '0.22.2'
 
-export const commit = 'a466fc1'
+export const commit = 'c239d9c'
 
-export const date = '2024-01-04T17:28:33.000Z'
+export const date = '2024-01-06T23:18:20.000Z'
 
 export const getVersion = () => {
   return version

package/src/parts/RequiresSocket/RequiresSocket.js

@@ -10,6 +10,7 @@ const METHODS_THAT_REQUIRE_SOCKET = new Set([
   'IncrementalTextSearch.start',
   'ElectronApplicationMenu.setItems',
   'GetWindowId.getWindowId',
+  'HandleMessagePortForExtensionHostHelperProcess.handleMessagePortForExtensionHostHelperProcess',
 ])
 
 export const requiresSocket = (method) => {

package/src/parts/WebSocketSerialization/WebSocketSerialization.js

@@ -0,0 +1,7 @@
+export const serialize = (message) => {
+  return JSON.stringify(message)
+}
+
+export const deserialize = (message) => {
+  return JSON.parse(message.toString())
+}

package/src/parts/WebSocketServer/WebSocketServer.js

@@ -1,30 +1 @@
-import { Buffer } from 'node:buffer'
-import * as _ws from 'ws'
-import * as IsSocket from '../IsSocket/IsSocket.js'
-import * as Promises from '../Promises/Promises.js'
-
-// workaround for jest or node bug
-const WebSocketServer = _ws.WebSocketServer
-  ? _ws.WebSocketServer
-  : // @ts-ignore
-    _ws.default.WebSocketServer
-
-const webSocketServer = new WebSocketServer({
-  noServer: true,
-
-  // TODO not sure if ws compress is working at all
-  // perMessageDeflate: true
-})
-
-export const handleUpgrade = async (request, socket) => {
-  if (!IsSocket.isSocket(socket)) {
-    throw new TypeError(`socket must be of type Socket`)
-  }
-  const { resolve, promise } = Promises.withResolvers()
-  const upgradeCallback = (ws) => {
-    resolve(ws)
-  }
-  webSocketServer.handleUpgrade(request, socket, Buffer.alloc(0), upgradeCallback)
-  const webSocket = await promise
-  return webSocket
-}
+export * from '@lvce-editor/web-socket-server'