@lvce-editor/shared-process 0.11.4 → 0.11.5

package/config/defaultKeyBindings.json

@@ -742,5 +742,9 @@
     "key": "Enter",
     "command": "SimpleBrowser.go",
     "when": "focus.SimpleBrowserInput"
+  },
+  {
+    "key": "ctrl+r",
+    "command": "Window.reload"
   }
 ]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lvce-editor/shared-process",
-  "version": "0.11.4",
+  "version": "0.11.5",
   "description": "Utility package for @lvce-editor/server",
   "main": "index.js",
   "type": "module",
@@ -17,9 +17,9 @@
   },
   "dependencies": {
     "@babel/code-frame": "^7.18.6",
-    "@lvce-editor/extension-host": "0.11.4",
-    "@lvce-editor/extension-host-helper-process": "0.11.4",
-    "@lvce-editor/pty-host": "0.11.4",
+    "@lvce-editor/extension-host": "0.11.5",
+    "@lvce-editor/extension-host-helper-process": "0.11.5",
+    "@lvce-editor/pty-host": "0.11.5",
     "debug": "^4.3.4",
     "execa": "^6.1.0",
     "exit-hook": "^3.1.2",

package/src/parts/Cli/Cli.js

@@ -1,3 +1,6 @@
+import * as Logger from '../Logger/Logger.js'
+import * as Process from '../Process/Process.js'
+
 const getModule = (argv0) => {
   switch (argv0) {
     case 'install':
@@ -20,7 +23,7 @@ export const handleCliArgs = async (argv, console, process) => {
   try {
     await module.handleCliArgs(argv, console, process)
   } catch (error) {
-    console.error(error)
-    process.exitCode = 1
+    Logger.error(error)
+    Process.setExitCode(1)
   }
 }

package/src/parts/CliInstall/CliInstall.js

@@ -1,9 +1,10 @@
 import * as ExtensionInstall from '../ExtensionInstall/ExtensionInstall.js'
+import * as Logger from '../Logger/Logger.js'
 
 export const handleCliArgs = async (argv, console) => {
   const extension = argv[1]
   if (!extension) {
-    console.error('extension argument is required')
+    Logger.error('extension argument is required')
     return
   }
   await ExtensionInstall.install(extension)

package/src/parts/CliLink/CliLink.js

@@ -1,5 +1,7 @@
 import * as ExtensionLink from '../ExtensionLink/ExtensionLink.js'
 import * as ErrorCodes from '../ErrorCodes/ErrorCodes.js'
+import * as Logger from '../Logger/Logger.js'
+import * as Process from '../Process/Process.js'
 
 export const handleCliArgs = async (argv) => {
   try {
@@ -7,8 +9,8 @@ export const handleCliArgs = async (argv) => {
     await ExtensionLink.link(path)
   } catch (error) {
     if (error && error.code === ErrorCodes.E_MANIFEST_NOT_FOUND) {
-      console.error(error.message)
-      process.exitCode = 128
+      Logger.error(error.message)
+      Process.setExitCode(128)
       return
     }
     throw error

package/src/parts/CliUnlink/CliUnlink.js

@@ -1,6 +1,7 @@
 import * as ExtensionUnlink from '../ExtensionUnlink/ExtensionUnlink.js'
+import * as Process from '../Process/Process.js'
 
 export const handleCliArgs = async (argv, console, process) => {
-  const path = argv.length > 1 ? argv[1] : process.cwd()
+  const path = argv.length > 1 ? argv[1] : Process.cwd()
   await ExtensionUnlink.unlink(path)
 }

package/src/parts/Developer/Developer.js

@@ -1,6 +1,7 @@
 import { createWriteStream, writeFileSync } from 'node:fs'
 import { performance } from 'node:perf_hooks'
 import * as ExtensionHost from '../ExtensionHost/ExtensionHost.js'
+import * as Process from '../Process/Process.js'
 
 export const measureLatencyBetweenExtensionHostAndSharedProcess = async (
   socket,
@@ -63,7 +64,7 @@ export const getNodeStartupTiming = () => {
 
 export const sharedProcessMemoryUsage = () => {
   // TODO also print out number of watched files
-  return process.memoryUsage()
+  return Process.memoryUsage()
 }
 
 // TODO not sure if this is actually useful

package/src/parts/ErrorCodes/ErrorCodes.js

@@ -7,3 +7,15 @@ export const EEXIST = 'EEXIST'
 export const ENOTDIR = 'ENOTDIR'
 
 export const E_MANIFEST_NOT_FOUND = 'E_MANIFEST_NOT_FOUND'
+
+export const EPIPE = 'EPIPE'
+
+export const ERR_IPC_CHANNEL_CLOSED = 'ERR_IPC_CHANNEL_CLOSED'
+
+export const E_COLOR_THEME_NOT_FOUND = 'E_COLOR_THEME_NOT_FOUND'
+
+export const E_ICON_THEME_NOT_FOUND = 'E_ICON_THEME_NOT_FOUND'
+
+export const ECONNRESET = 'ECONNRESET'
+
+export const EPERM = 'EPERM'

package/src/parts/ErrorHandling/ErrorHandling.js

@@ -1,4 +1,7 @@
+import * as ErrorCodes from '../ErrorCodes/ErrorCodes.js'
+import * as PrettyError from '../PrettyError/PrettyError.js'
 import * as Socket from '../Socket/Socket.js'
+import * as Process from '../Process/Process.js'
 
 export const state = {
   seenErrors: [],
@@ -38,3 +41,39 @@ export const handleError = (error) => {
   })
   printPrettyError(prettyError)
 }
+
+// TODO handle structure: one shared process multiple extension hosts
+
+// TODO use named functions here
+
+const firstErrorLine = (error) => {
+  if (error.stack) {
+    return error.stack.slice(0, error.stack.indexOf('\n'))
+  }
+  if (error.message) {
+    return error.message
+  }
+  return `${error}`
+}
+
+export const handleUncaughtExceptionMonitor = (error, origin) => {
+  console.info(`[shared process] uncaught exception: ${firstErrorLine(error)}`)
+  if (error && error.code === ErrorCodes.EPIPE && !process.connected) {
+    // parent process is disposed, ignore
+    return
+  }
+  if (
+    error &&
+    error.code === ErrorCodes.ERR_IPC_CHANNEL_CLOSED &&
+    !Process.isConnected()
+  ) {
+    // parent process is disposed, ignore
+    return
+  }
+  // console.log(error)
+  const prettyError = PrettyError.prepare(error)
+  // console.error(prettyError.message)
+  console.error(prettyError.codeFrame)
+  console.error(prettyError.stack)
+  Process.exit(1)
+}

package/src/parts/ExtensionManagement/ExtensionManagementColorTheme.js

@@ -1,9 +1,10 @@
 import VError from 'verror'
 import * as Error from '../Error/Error.js'
+import * as ErrorCodes from '../ErrorCodes/ErrorCodes.js'
+import * as FileSystemWatch from '../FileSystemWatch/FileSystemWatch.js'
 import * as ReadJson from '../JsonFile/JsonFile.js'
 import * as Path from '../Path/Path.js'
 import * as ExtensionManagement from './ExtensionManagement.js'
-import * as FileSystemWatch from '../FileSystemWatch/FileSystemWatch.js'
 
 // TODO test this function
 // TODO very similar with getIconTheme
@@ -29,7 +30,7 @@ export const getColorThemeJson = async (colorThemeId) => {
   const colorThemePath = await getColorThemePath(extensions, colorThemeId)
   if (!colorThemePath) {
     throw new Error.OperationalError({
-      code: 'E_COLOR_THEME_NOT_FOUND',
+      code: ErrorCodes.E_COLOR_THEME_NOT_FOUND,
       message: `Color theme "${colorThemeId}" not found in extensions folder`,
     })
   }

package/src/parts/ExtensionManagement/ExtensionManagementIconTheme.js

@@ -1,5 +1,6 @@
 import VError from 'verror'
 import * as Error from '../Error/Error.js'
+import * as ErrorCodes from '../ErrorCodes/ErrorCodes.js'
 import * as ReadJson from '../JsonFile/JsonFile.js'
 import * as Path from '../Path/Path.js'
 import * as ExtensionManagement from './ExtensionManagement.js'
@@ -27,7 +28,7 @@ export const getIconTheme = async (iconThemeId) => {
     }
   }
   throw new Error.OperationalError({
-    code: 'E_ICON_THEME_NOT_FOUND',
+    code: ErrorCodes.E_ICON_THEME_NOT_FOUND,
     message: `Icon theme "${iconThemeId}" not found in extensions folder`,
   })
 }

package/src/parts/Logger/Logger.js

@@ -0,0 +1,50 @@
+import { Console } from 'node:console'
+import { createWriteStream } from 'node:fs'
+import { tmpdir } from 'node:os'
+
+// TODO mock this module when used in unit tests
+
+const state = {
+  /**
+   * @type {Console|undefined}
+   */
+  console: undefined,
+}
+
+const createConsole = () => {
+  const logFile = `${tmpdir()}/log-shared-process.txt`
+  const writeStream = createWriteStream(logFile)
+  const logger = new Console(writeStream)
+  return logger
+}
+
+const getOrCreateLogger = () => {
+  if (!state.console) {
+    state.console = createConsole()
+  }
+  return state.console
+}
+
+export const log = (...args) => {
+  const logger = getOrCreateLogger()
+  logger.log(...args)
+  console.log(...args)
+}
+
+export const info = (...args) => {
+  const logger = getOrCreateLogger()
+  logger.info(...args)
+  console.info(...args)
+}
+
+export const warn = (...args) => {
+  const logger = getOrCreateLogger()
+  logger.warn(...args)
+  console.warn(...args)
+}
+
+export const error = (...args) => {
+  const logger = getOrCreateLogger()
+  logger.error(...args)
+  console.error(...args)
+}

package/src/parts/ParentIpc/ParentIpc.js

@@ -3,6 +3,7 @@ import VError from 'verror'
 import * as Callback from '../Callback/Callback.js'
 import * as Command from '../Command/Command.js'
 import * as Debug from '../Debug/Debug.js'
+import * as ErrorCodes from '../ErrorCodes/ErrorCodes.js'
 import * as ExtensionHostHelperProcessIpc from '../ExtensionHostHelperProcessIpc/ExtensionHostHelperProcessIpc.js'
 import * as ExtensionHostIpc from '../ExtensionHostIpc/ExtensionHostIpc.js'
 import * as ExtensionHostRpc from '../ExtensionHostRpc/ExtensionHostRpc.js'
@@ -36,7 +37,7 @@ export const electronSend = (message) => {
 const handleWebSocketSharedProcess = (message, handle) => {
   // TODO when it is an extension host websocket, spawn extension host
   handle.on('error', (error) => {
-    if (error && error.code === 'ECONNRESET') {
+    if (error && error.code === ErrorCodes.ECONNRESET) {
       return
     }
     console.info('[info shared process: handle error]', error)

package/src/parts/Process/Process.js

@@ -5,3 +5,27 @@ export const crash = (message) => {
 export const crashAsync = async (message) => {
   throw new Error(message)
 }
+
+export const exit = (code) => {
+  process.exit(code)
+}
+
+export const setExitCode = (exitCode) => {
+  process.exitCode = exitCode
+}
+
+export const argv = process.argv
+
+export const cwd = () => {
+  return process.cwd()
+}
+
+export const memoryUsage = () => {
+  return process.memoryUsage()
+}
+
+export const isConnected = () => {
+  return process.connected
+}
+
+export const platform = process.platform

package/src/parts/Socket/Socket.js

@@ -41,7 +41,6 @@ const handleMessage = async (event) => {
 }
 
 const handleError = (error) => {
-  console.log('EEERRR')
   // console.error(error)
   throw new VError(error, 'Shared Process Socket Error')
 

package/src/sharedProcessMain.js

@@ -1,40 +1,12 @@
 import * as Command from './parts/Command/Command.js'
+import * as ErrorHandling from './parts/ErrorHandling/ErrorHandling.js'
 import * as Module from './parts/Module/Module.js'
 import * as ParentIpc from './parts/ParentIpc/ParentIpc.js'
-import * as PrettyError from './parts/PrettyError/PrettyError.js'
-
+import * as Process from './parts/Process/Process.js'
 // TODO handle structure: one shared process multiple extension hosts
 
 // TODO use named functions here
 
-const firstErrorLine = (error) => {
-  if (error.stack) {
-    return error.stack.slice(0, error.stack.indexOf('\n'))
-  }
-  if (error.message) {
-    return error.message
-  }
-  return `${error}`
-}
-
-const handleUncaughtExceptionMonitor = (error, origin) => {
-  console.info(`[shared process] uncaught exception: ${firstErrorLine(error)}`)
-  if (error && error.code === 'EPIPE' && !process.connected) {
-    // parent process is disposed, ignore
-    return
-  }
-  if (error && error.code === 'ERR_IPC_CHANNEL_CLOSED' && !process.connected) {
-    // parent process is disposed, ignore
-    return
-  }
-  // console.log(error)
-  const prettyError = PrettyError.prepare(error)
-  // console.error(prettyError.message)
-  console.error(prettyError.codeFrame)
-  console.error(prettyError.stack)
-  process.exit(1)
-}
-
 const handleDisconnect = () => {
   console.info('[shared process] disconnected')
 }
@@ -51,7 +23,7 @@ const knownCliArgs = ['install', 'list', 'link', 'unlink']
 
 const main = async () => {
   Command.setLoad(Module.load)
-  const argv = process.argv.slice(2)
+  const argv = Process.argv.slice(2)
   const argv0 = argv[0]
   if (knownCliArgs.includes(argv0)) {
     const module = await import('./parts/Cli/Cli.js')
@@ -64,7 +36,10 @@ const main = async () => {
   process.on('disconnect', handleDisconnect)
   process.on('SIGTERM', handleSigTerm)
 
-  process.on('uncaughtExceptionMonitor', handleUncaughtExceptionMonitor)
+  process.on(
+    'uncaughtExceptionMonitor',
+    ErrorHandling.handleUncaughtExceptionMonitor
+  )
   ParentIpc.listen()
 
   // ExtensionHost.start() // TODO start on demand, e.g. not when extensions should be disabled