@lvce-editor/shared-process 0.15.31 → 0.15.32

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lvce-editor/shared-process",
-  "version": "0.15.31",
+  "version": "0.15.32",
   "description": "Utility package for @lvce-editor/server",
   "main": "index.js",
   "type": "module",
@@ -17,9 +17,9 @@
   },
   "dependencies": {
     "@babel/code-frame": "^7.22.5",
-    "@lvce-editor/extension-host": "0.15.31",
-    "@lvce-editor/extension-host-helper-process": "0.15.31",
-    "@lvce-editor/pty-host": "0.15.31",
+    "@lvce-editor/extension-host": "0.15.32",
+    "@lvce-editor/extension-host-helper-process": "0.15.32",
+    "@lvce-editor/pty-host": "0.15.32",
     "debug": "^4.3.4",
     "execa": "^7.1.1",
     "exit-hook": "^3.2.0",
@@ -28,7 +28,7 @@
     "lines-and-columns": "^2.0.3",
     "p-queue": "^7.3.4",
     "parse-json": "^7.0.0",
-    "tar-fs": "^2.1.1",
+    "tar-fs": "^3.0.3",
     "ws": "^8.13.0",
     "xdg-basedir": "^5.1.0"
   },

package/src/parts/Env/Env.js

@@ -1,3 +1,19 @@
 export const getFolder = () => {
   return process.env.FOLDER || process.cwd()
 }
+
+export const getAppImagePath = () => {
+  return process.env.APPIMAGE
+}
+
+export const getElectronRunAsNode = () => {
+  return process.env.ELECTRON_RUN_AS_NODE
+}
+
+export const getNodeEnv = () => {
+  return process.env.NODE_ENV
+}
+
+export const getRipGrepPath = () => {
+  return process.env.RIP_GREP_PATH
+}

package/src/parts/ErrorCodes/ErrorCodes.js

@@ -19,3 +19,4 @@ export const ERR_MODULE_NOT_FOUND = 'ERR_MODULE_NOT_FOUND'
 export const EXDEV = 'EXDEV'
 export const ERR_DLOPEN_FAILED = 'ERR_DLOPEN_FAILED'
 export const ESRCH = 'ESRCH'
+export const E_RIP_GREP_NOT_FOUND = 'E_RIP_GREP_NOT_FOUND'

package/src/parts/GetAppImagePath/GetAppImagePath.js

@@ -1,3 +1,5 @@
+import * as Env from '../Env/Env.js'
+
 export const getAppImagePath = () => {
-  return process.env.APPIMAGE
+  return Env.getAppImagePath()
 }

package/src/parts/GetErrorResponse/GetErrorResponse.js

@@ -4,13 +4,7 @@ import * as JsonRpcErrorCode from '../JsonRpcErrorCode/JsonRpcErrorCode.js'
 import * as JsonRpcErrorResponse from '../JsonRpcErrorResponse/JsonRpcErrorResponse.js'
 import * as PrettyError from '../PrettyError/PrettyError.js'
 import * as PrintPrettyError from '../PrintPrettyError/PrintPrettyError.js'
-
-const shouldLogError = (error) => {
-  if (error && error.code === ErrorCodes.ENOENT) {
-    return false
-  }
-  return true
-}
+import * as ShouldLogError from '../ShouldLogError/ShouldLogError.js'
 
 const getErrorProperty = (error, prettyError) => {
   if (error && error instanceof CommandNotFoundError) {
@@ -20,7 +14,7 @@ const getErrorProperty = (error, prettyError) => {
       data: error.stack,
     }
   }
-  if (!shouldLogError(error)) {
+  if (!ShouldLogError.shouldLogError(error)) {
     return {
       code: JsonRpcErrorCode.Custom,
       message: `${error}`,
@@ -43,7 +37,7 @@ const getErrorProperty = (error, prettyError) => {
 
 export const getErrorResponse = (message, error, ipc) => {
   const prettyError = PrettyError.prepare(error)
-  if (shouldLogError(error)) {
+  if (ShouldLogError.shouldLogError(error)) {
     PrintPrettyError.printPrettyError(prettyError, `[shared-process] `)
   }
   const errorProperty = getErrorProperty(error, prettyError)

package/src/parts/IsElectron/IsElectron.js

@@ -1,3 +1,5 @@
+import * as Env from '../Env/Env.js'
+
 export const isElectron = () => {
-  return Boolean(process.env.ELECTRON_RUN_AS_NODE)
+  return Boolean(Env.getElectronRunAsNode())
 }

package/src/parts/ModuleMap/ModuleMap.js

@@ -146,6 +146,7 @@ export const getModuleId = (commandId) => {
     case 'Platform.setEnvironmentVariables':
     case 'Platform.getCommit':
     case 'Platform.getVersion':
+    case 'Platform.getDate':
       return ModuleId.Platform
     case 'Preferences.getAll':
       return ModuleId.Preferences

package/src/parts/Platform/Platform.ipc.js

@@ -23,4 +23,5 @@ export const Commands = {
   getUserSettingsPath: Platform.getUserSettingsPath,
   getVersion: Platform.getVersion,
   setEnvironmentVariables: Platform.setEnvironmentVariables,
+  getDate: Platform.getDate,
 }

package/src/parts/Platform/Platform.js

@@ -165,9 +165,11 @@ export const getSetupName = () => {
   return 'Lvce-Setup'
 }
 
-export const version = '0.15.31'
+export const version = '0.15.32'
 
-export const commit = '85343c2'
+export const commit = '4913b6f'
+
+export const date = '2023-06-21T10:02:09.000Z'
 
 export const getVersion = () => {
   return version
@@ -176,3 +178,7 @@ export const getVersion = () => {
 export const getCommit = () => {
   return commit
 }
+
+export const getDate = () => {
+  return date
+}

package/src/parts/ProcessExitEventType/ProcessExitEventType.js

@@ -0,0 +1,2 @@
+export const Error = 1
+export const Exit = 2

package/src/parts/RipGrep/RipGrep.js

@@ -1,24 +1,34 @@
 import * as NodeChildProcess from 'node:child_process'
 import * as Assert from '../Assert/Assert.js'
+import * as Env from '../Env/Env.js'
 import * as Exec from '../Exec/Exec.js'
 import * as RgPath from '../RipGrepPath/RipGrepPath.js'
+import { VError } from '../VError/VError.js'
 
-export const ripGrepPath = process.env.RIP_GREP_PATH || RgPath.rgPath
+export const ripGrepPath = Env.getRipGrepPath() || RgPath.rgPath
 
 export const spawn = (args, options) => {
-  const childProcess = NodeChildProcess.spawn(RgPath.rgPath, args, options)
-  return {
-    on(event, listener) {
-      childProcess.on(event, listener)
-    },
-    once(event, listener) {
-      childProcess.once(event, listener)
-    },
-    stdout: childProcess.stdout,
-    stderr: childProcess.stderr,
-    kill() {
-      childProcess.kill()
-    },
+  try {
+    const childProcess = NodeChildProcess.spawn(RgPath.rgPath, args, options)
+    return {
+      childProcess,
+      on(event, listener) {
+        this.childProcess.on(event, listener)
+      },
+      off(event, listener) {
+        this.childProcess.off(event, listener)
+      },
+      once(event, listener) {
+        this.childProcess.once(event, listener)
+      },
+      stdout: childProcess.stdout,
+      stderr: childProcess.stderr,
+      kill() {
+        this.childProcess.kill()
+      },
+    }
+  } catch (error) {
+    throw new VError(error, `Failed to spawn ripgrep`)
   }
 }
 

package/src/parts/SearchFile/SearchFile.js

@@ -1,4 +1,5 @@
 import * as Assert from '../Assert/Assert.js'
+import * as Character from '../Character/Character.js'
 import * as IsEnoentError from '../IsEnoentError/IsEnoentError.js'
 import * as LimitString from '../LimitString/LimitString.js'
 import * as Logger from '../Logger/Logger.js'
@@ -10,25 +11,25 @@ import * as RipGrep from '../RipGrep/RipGrep.js'
 // do a delta comparison, so the first time it would send 100kB
 // but the second time only a few hundred bytes of changes
 
-export const searchFile = async (path, searchTerm, limit) => {
+export const searchFile = async ({ searchPath = '', limit = 100, ripGrepArgs = [] }) => {
   try {
-    Assert.string(path)
-    Assert.string(searchTerm)
+    Assert.string(searchPath)
+    Assert.array(ripGrepArgs)
     Assert.number(limit)
-    const { stdout, stderr } = await RipGrep.exec(['--files', '--sort-files'], {
-      cwd: path,
+    const { stdout, stderr } = await RipGrep.exec(ripGrepArgs, {
+      cwd: searchPath,
     })
     return LimitString.limitString(stdout, limit)
   } catch (error) {
     if (IsEnoentError.isEnoentError(error)) {
       Logger.info(`[shared-process] ripgrep could not be found at "${RipGrep.ripGrepPath}"`)
-      return ``
+      return Character.EmptyString
     }
     // @ts-ignore
-    if (error && error.stderr === '') {
-      return ``
+    if (error && error.stderr === Character.EmptyString) {
+      return Character.EmptyString
     }
     Logger.error(error)
-    return ``
+    return Character.EmptyString
   }
 }

package/src/parts/ShouldLogError/ShouldLogError.js

@@ -0,0 +1,8 @@
+import * as ErrorCodes from '../ErrorCodes/ErrorCodes.js'
+
+export const shouldLogError = (error) => {
+  if (error && error.code === ErrorCodes.ENOENT) {
+    return false
+  }
+  return true
+}

package/src/parts/TextSearch/TextSearch.js

@@ -2,11 +2,13 @@ import { Writable } from 'node:stream'
 import { pipeline } from 'node:stream/promises'
 import * as EncodingType from '../EncodingType/EncodingType.js'
 import * as GetNewLineIndex from '../GetNewLineIndex/GetNewLineIndex.js'
-import * as GetTextSearchRipGrepArgs from '../GetTextSearchRipGrepArgs/GetTextSearchRipGrepArgs.js'
+import * as ProcessExitEventType from '../ProcessExitEventType/ProcessExitEventType.js'
 import * as RipGrep from '../RipGrep/RipGrep.js'
 import * as RipGrepParsedLineType from '../RipGrepParsedLineType/RipGrepParsedLineType.js'
+import { TextSearchError } from '../TextSearchError/TextSearchError.js'
 import * as TextSearchResultType from '../TextSearchResultType/TextSearchResultType.js'
 import * as ToTextSearchResult from '../ToTextSearchResult/ToTextSearchResult.js'
+import * as WaitForProcessToExit from '../WaitForProcessToExit/WaitForProcessToExit.js'
 // TODO update vscode-ripgrep when https://github.com/mhinz/vim-grepper/issues/244, https://github.com/BurntSushi/ripgrep/issues/1892 is fixed
 
 // need to use '.' as last argument for ripgrep
@@ -103,32 +105,17 @@ const collectStdout = async (childProcess, maxSearchResults, charsBefore, charsA
   }
 }
 
-export const search = async (searchDir, searchString, { threads = 1, maxSearchResults = 20_000, isCaseSensitive = false } = {}) => {
+export const search = async ({ searchDir = '', maxSearchResults = 20_000, ripGrepArgs = [] } = {}) => {
   const charsBefore = 26
   const charsAfter = 50
-  const ripGrepArgs = GetTextSearchRipGrepArgs.getRipGrepArgs({
-    threads,
-    isCaseSensitive,
-    searchString,
-  })
   const childProcess = RipGrep.spawn(ripGrepArgs, {
     cwd: searchDir,
   })
   const pipeLinePromise = collectStdout(childProcess, maxSearchResults, charsBefore, charsAfter)
-  const closePromise = new Promise((resolve, reject) => {
-    // TODO use pipeline / transform stream maybe
-    const handleClose = () => {
-      resolve(undefined)
-    }
-    const handleError = (error) => {
-      // TODO check type of error
-      console.error(error)
-      resolve(undefined)
-    }
-
-    childProcess.once('close', handleClose)
-    childProcess.once('error', handleError)
-  })
-  await Promise.all([pipeLinePromise, closePromise])
-  return await pipeLinePromise
+  const closePromise = WaitForProcessToExit.waitForProcessToExit(childProcess)
+  const [pipeLineResult, exitResult] = await Promise.all([pipeLinePromise, closePromise])
+  if (exitResult.type === ProcessExitEventType.Error) {
+    throw new TextSearchError(exitResult.event)
+  }
+  return pipeLineResult
 }

package/src/parts/TextSearchError/TextSearchError.js

@@ -0,0 +1,15 @@
+import * as ErrorCodes from '../ErrorCodes/ErrorCodes.js'
+import * as IsEnoentError from '../IsEnoentError/IsEnoentError.js'
+
+export class TextSearchError extends Error {
+  constructor(cause) {
+    if (IsEnoentError.isEnoentError(cause)) {
+      super(`ripgrep path not found: ${cause}`)
+      this.code = ErrorCodes.E_RIP_GREP_NOT_FOUND
+    } else {
+      super(`ripgrep process error: ${cause}`)
+      this.code = cause.code
+    }
+    this.name = 'TextSearchError'
+  }
+}

package/src/parts/Trace/Trace.js

@@ -1,3 +1,5 @@
+import * as Env from '../Env/Env.js'
+
 export const LEVEL = {
   DEFAULT: 1,
   VERBOSE: 2,
@@ -8,7 +10,7 @@ export const state = {
 }
 
 export const trace =
-  process.env.NODE_ENV === 'test'
+  Env.getNodeEnv() === 'test'
     ? () => {}
     : (...args) => {
         console.info('[Trace]', ...args)

package/src/parts/WaitForProcessToExit/WaitForProcessToExit.js

@@ -0,0 +1,29 @@
+import * as ProcessExitEventType from '../ProcessExitEventType/ProcessExitEventType.js'
+
+export const waitForProcessToExit = async (childProcess) => {
+  const { type, event } = await new Promise((resolve, reject) => {
+    const cleanup = (value) => {
+      childProcess.off('close', handleClose)
+      childProcess.off('error', handleError)
+      resolve(value)
+    }
+    const handleClose = (event) => {
+      cleanup({
+        type: ProcessExitEventType.Exit,
+        event,
+      })
+    }
+    const handleError = (event) => {
+      cleanup({
+        type: ProcessExitEventType.Error,
+        event,
+      })
+    }
+    childProcess.on('close', handleClose)
+    childProcess.on('error', handleError)
+  })
+  return {
+    type,
+    event,
+  }
+}

package/src/parts/GetTextSearchRipGrepArgs/GetTextSearchRipGrepArgs.js

@@ -1,14 +0,0 @@
-export const getRipGrepArgs = ({ threads, isCaseSensitive, searchString }) => {
-  const ripGrepArgs = ['--smart-case', '--stats', '--json']
-  ripGrepArgs.push('--threads', `${threads}`)
-  if (isCaseSensitive) {
-    ripGrepArgs.push('--case-sensitive')
-  } else {
-    ripGrepArgs.push('--ignore-case')
-  }
-  ripGrepArgs.push('--fixed-strings')
-  ripGrepArgs.push('--')
-  ripGrepArgs.push(searchString)
-  ripGrepArgs.push('.')
-  return ripGrepArgs
-}