@effect/platform-node 0.1.1 → 0.2.0

package/mjs/internal/stream.mjs

@@ -8,7 +8,12 @@ export const fromReadable = (evaluate, onError, {
   stream.once("error", err => {
     emit.fail(onError(err));
   });
-  stream.once("end", () => {
+  // The 'close' event is emitted after a process has ended and the stdio
+  // streams of a child process have been closed. This is distinct from
+  // the 'exit' event, since multiple processes might share the same
+  // stdio streams. The 'close' event will always emit after 'exit' was
+  // already emitted, or 'error' if the child failed to spawn.
+  stream.once("close", () => {
     emit.end();
   });
   stream.on("readable", () => {

package/mjs/internal/stream.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"stream.mjs","names":["Option","Effect","Stream","fromReadable","evaluate","onError","chunkSize","none","flatMap","_","repeatEffectOption","readChunk","unwrapScoped","map","stream","async","emit","once","err","fail","end","on","single","readable","acquireRelease","sync","removeAllListeners","closed","destroy","size","succeed","_tag","read","Number"],"sources":["../../src/internal/stream.ts"],"sourcesContent":[null],"mappings":"AAEA,OAAO,KAAKA,MAAM,MAAM,qBAAqB;AAC7C,OAAO,KAAKC,MAAM,MAAM,mBAAmB;AAG3C,OAAO,KAAKC,MAAM,MAAM,uBAAuB;AAG/C;AACA,OAAO,MAAMC,YAAY,GAAGA,CAC1BC,QAA2B,EAC3BC,OAA8B,EAC9B;EAAEC,SAAS,GAAGN,MAAM,CAACO,IAAI;AAAE,IAA0B,EAAE,KA+BrDL,MAAM,CAACM,OAAO,CAAEC,CAAC,IAAKP,MAAM,CAACQ,kBAAkB,CAACC,SAAS,CAAIF,CAAC,EAAEH,SAAS,CAAC,CAAC,CAAC,CAD5EJ,MAAM,CAACU,YAAY,CAnBnBX,MAAM,CAACY,GAAG,CAAEC,MAAM,IAChBZ,MAAM,CAACa,KAAK,CAAsBC,IAAI,IAAI;EACxCF,MAAM,CAACG,IAAI,CAAC,OAAO,EAAGC,GAAG,IAAI;IAC3BF,IAAI,CAACG,IAAI,CAACd,OAAO,CAACa,GAAG,CAAC,CAAC;EACzB,CAAC,CAAC;EAEFJ,MAAM,CAACG,IAAI,CAAC,KAAK,EAAE,MAAK;IACtBD,IAAI,CAACI,GAAG,EAAE;EACZ,CAAC,CAAC;EAEFN,MAAM,CAACO,EAAE,CAAC,UAAU,EAAE,MAAK;IACzBL,IAAI,CAACM,MAAM,CAACR,MAAM,CAAC;EACrB,CAAC,CAAC;EAEF,IAAIA,MAAM,CAACS,QAAQ,EAAE;IACnBP,IAAI,CAACM,MAAM,CAACR,MAAM,CAAC;;AAEvB,CAAC,EAAE,CAAC,CAAC,CACN,CA1BDb,MAAM,CAACuB,cAAc,CAACvB,MAAM,CAACwB,IAAI,CAACrB,QAAQ,CAAC,EAAGU,MAAM,IAClDb,MAAM,CAACwB,IAAI,CAAC,MAAK;EACfX,MAAM,CAACY,kBAAkB,EAAE;EAE3B,IAAI,CAACZ,MAAM,CAACa,MAAM,EAAE;IAClBb,MAAM,CAACc,OAAO,EAAE;;AAEpB,CAAC,CAAC,CAAC,GAsBN;AAEH,MAAMjB,SAAS,GAAGA,CAChBG,MAAgB,EAChBe,IAAyB,KAIvB5B,MAAM,CAACO,OAAO,CAAEC,CAAC,IAAMA,CAAC,GAAGR,MAAM,CAAC6B,OAAO,CAACrB,CAAC,CAAC,GAAGR,MAAM,CAACkB,IAAI,CAACnB,MAAM,CAACO,IAAI,EAAE,CAAE,CAAC,CAD3EN,MAAM,CAACwB,IAAI,CAAC,MAAOI,IAAI,CAACE,IAAI,KAAK,MAAM,GAAGjB,MAAM,CAACkB,IAAI,CAACC,MAAM,CAACJ,IAAI,CAAC,CAAC,GAAGf,MAAM,CAACkB,IAAI,EAAe,CAAC,CAElG"}
+{"version":3,"file":"stream.mjs","names":["Option","Effect","Stream","fromReadable","evaluate","onError","chunkSize","none","flatMap","_","repeatEffectOption","readChunk","unwrapScoped","map","stream","async","emit","once","err","fail","end","on","single","readable","acquireRelease","sync","removeAllListeners","closed","destroy","size","succeed","_tag","read","Number"],"sources":["../../src/internal/stream.ts"],"sourcesContent":[null],"mappings":"AAEA,OAAO,KAAKA,MAAM,MAAM,qBAAqB;AAC7C,OAAO,KAAKC,MAAM,MAAM,mBAAmB;AAG3C,OAAO,KAAKC,MAAM,MAAM,uBAAuB;AAG/C;AACA,OAAO,MAAMC,YAAY,GAAGA,CAC1BC,QAA2B,EAC3BC,OAA8B,EAC9B;EAAEC,SAAS,GAAGN,MAAM,CAACO,IAAI;AAAE,IAA0B,EAAE,KAoCrDL,MAAM,CAACM,OAAO,CAAEC,CAAC,IAAKP,MAAM,CAACQ,kBAAkB,CAACC,SAAS,CAAIF,CAAC,EAAEH,SAAS,CAAC,CAAC,CAAC,CAD5EJ,MAAM,CAACU,YAAY,CAxBnBX,MAAM,CAACY,GAAG,CAAEC,MAAM,IAChBZ,MAAM,CAACa,KAAK,CAAsBC,IAAI,IAAI;EACxCF,MAAM,CAACG,IAAI,CAAC,OAAO,EAAGC,GAAG,IAAI;IAC3BF,IAAI,CAACG,IAAI,CAACd,OAAO,CAACa,GAAG,CAAC,CAAC;EACzB,CAAC,CAAC;EAEF;EACA;EACA;EACA;EACA;EACAJ,MAAM,CAACG,IAAI,CAAC,OAAO,EAAE,MAAK;IACxBD,IAAI,CAACI,GAAG,EAAE;EACZ,CAAC,CAAC;EAEFN,MAAM,CAACO,EAAE,CAAC,UAAU,EAAE,MAAK;IACzBL,IAAI,CAACM,MAAM,CAACR,MAAM,CAAC;EACrB,CAAC,CAAC;EAEF,IAAIA,MAAM,CAACS,QAAQ,EAAE;IACnBP,IAAI,CAACM,MAAM,CAACR,MAAM,CAAC;;AAEvB,CAAC,EAAE,CAAC,CAAC,CACN,CA/BDb,MAAM,CAACuB,cAAc,CAACvB,MAAM,CAACwB,IAAI,CAACrB,QAAQ,CAAC,EAAGU,MAAM,IAClDb,MAAM,CAACwB,IAAI,CAAC,MAAK;EACfX,MAAM,CAACY,kBAAkB,EAAE;EAE3B,IAAI,CAACZ,MAAM,CAACa,MAAM,EAAE;IAClBb,MAAM,CAACc,OAAO,EAAE;;AAEpB,CAAC,CAAC,CAAC,GA2BN;AAEH,MAAMjB,SAAS,GAAGA,CAChBG,MAAgB,EAChBe,IAAyB,KAIvB5B,MAAM,CAACO,OAAO,CAAEC,CAAC,IAAMA,CAAC,GAAGR,MAAM,CAAC6B,OAAO,CAACrB,CAAC,CAAC,GAAGR,MAAM,CAACkB,IAAI,CAACnB,MAAM,CAACO,IAAI,EAAE,CAAE,CAAC,CAD3EN,MAAM,CAACwB,IAAI,CAAC,MAAOI,IAAI,CAACE,IAAI,KAAK,MAAM,GAAGjB,MAAM,CAACkB,IAAI,CAACC,MAAM,CAACJ,IAAI,CAAC,CAAC,GAAGf,MAAM,CAACkB,IAAI,EAAe,CAAC,CAElG"}

package/package.json

@@ -1,16 +1,16 @@
 {
   "name": "@effect/platform-node",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "license": "MIT",
   "repository": {
     "type": "git",
     "url": "https://github.com/effect-ts/platform.git"
   },
   "dependencies": {
-    "@effect/data": "^0.12.8",
-    "@effect/io": "^0.26.1",
-    "@effect/stream": "^0.22.1",
-    "@effect/platform": "^0.1.0"
+    "@effect/data": "^0.13.5",
+    "@effect/io": "^0.31.3",
+    "@effect/stream": "^0.25.1",
+    "@effect/platform": "^0.2.0"
   },
   "publishConfig": {
     "access": "public"

package/src/Command.ts

@@ -0,0 +1,114 @@
+/**
+ * @since 1.0.0
+ */
+
+export type {
+  /**
+   * @since 1.0.0
+   * @category model
+   */
+  Command,
+  /**
+   * @since 1.0.0
+   * @category model
+   */
+  CommandInput,
+  /**
+   * @since 1.0.0
+   * @category model
+   */
+  CommandOutput,
+  /**
+   * @since 1.0.0
+   * @category model
+   */
+  PipedCommand,
+  /**
+   * @since 1.0.0
+   * @category model
+   */
+  StandardCommand
+} from "@effect/platform/Command"
+
+export {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
+  env,
+  /**
+   * @since 1.0.0
+   * @category execution
+   */
+  exitCode,
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
+  feed,
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
+  flatten,
+  /**
+   * @since 1.0.0
+   * @category refinements
+   */
+  isCommand,
+  /**
+   * @since 1.0.0
+   * @category execution
+   */
+  lines,
+  /**
+   * @since 1.0.0
+   * @category constructors
+   */
+  make,
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
+  pipeTo,
+  /**
+   * @since 1.0.0
+   * @category execution
+   */
+  start,
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
+  stderr,
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
+  stdin,
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
+  stdout,
+  /**
+   * @since 1.0.0
+   * @category execution
+   */
+  stream,
+  /**
+   * @since 1.0.0
+   * @category execution
+   */
+  streamLines,
+  /**
+   * @since 1.0.0
+   * @category execution
+   */
+  string,
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
+  workingDirectory
+} from "@effect/platform/Command"

package/src/CommandExecutor.ts

@@ -0,0 +1,49 @@
+/**
+ * @since 1.0.0
+ */
+import type { Layer } from "@effect/io/Layer"
+import * as internal from "@effect/platform-node/internal/commandExecutor"
+import type { CommandExecutor } from "@effect/platform/CommandExecutor"
+import type { FileSystem } from "@effect/platform/FileSystem"
+
+export type {
+  /**
+   * @since 1.0.0
+   * @category models
+   */
+  ExitCode,
+  /**
+   * @since 1.0.0
+   * @category models
+   */
+  Process,
+  /**
+   * @since 1.0.0
+   * @category models
+   */
+  ProcessId,
+  /**
+   * @since 1.0.0
+   * @category symbols
+   */
+  ProcessTypeId,
+  /**
+   * @since 1.0.0
+   * @category models
+   */
+  Signal
+} from "@effect/platform/CommandExecutor"
+
+export {
+  /**
+   * @since 1.0.0
+   * @category tag
+   */
+  CommandExecutor
+} from "@effect/platform/CommandExecutor"
+
+/**
+ * @since 1.0.0
+ * @category layer
+ */
+export const layer: Layer<FileSystem, never, CommandExecutor> = internal.layer

package/src/NodeContext.ts

@@ -0,0 +1,26 @@
+/**
+ * @since 1.0.0
+ */
+import { pipe } from "@effect/data/Function"
+import * as Layer from "@effect/io/Layer"
+import * as CommandExecutor from "@effect/platform-node/CommandExecutor"
+import * as Console from "@effect/platform-node/Console"
+import * as FileSystem from "@effect/platform-node/FileSystem"
+import * as Path from "@effect/platform-node/Path"
+
+/**
+ * @since 1.0.0
+ * @category models
+ */
+export type NodeContext = Console.Console | CommandExecutor.CommandExecutor | FileSystem.FileSystem | Path.Path
+
+/**
+ * @since 1.0.0
+ * @category layer
+ */
+export const layer: Layer.Layer<never, never, NodeContext> = pipe(
+  Console.layer,
+  Layer.merge(FileSystem.layer),
+  Layer.merge(Path.layer),
+  Layer.merge(Layer.provideMerge(FileSystem.layer, CommandExecutor.layer))
+)

package/src/internal/commandExecutor.ts

@@ -0,0 +1,202 @@
+import { constUndefined, pipe } from "@effect/data/Function"
+import * as Option from "@effect/data/Option"
+import * as Effect from "@effect/io/Effect"
+import * as Layer from "@effect/io/Layer"
+import { handleErrnoException } from "@effect/platform-node/internal/error"
+import { fromWritable } from "@effect/platform-node/internal/sink"
+import { fromReadable } from "@effect/platform-node/internal/stream"
+import * as Command from "@effect/platform/Command"
+import * as CommandExecutor from "@effect/platform/CommandExecutor"
+import type * as Error from "@effect/platform/Error"
+import * as FileSystem from "@effect/platform/FileSystem"
+import * as Sink from "@effect/stream/Sink"
+import * as Stream from "@effect/stream/Stream"
+import * as ChildProcess from "node:child_process"
+
+const inputToStdioOption = (stdin: Option.Option<Command.Command.Input>): "pipe" | "inherit" =>
+  Option.match(stdin, { onNone: () => "inherit", onSome: () => "pipe" })
+
+const outputToStdioOption = (output: Command.Command.Output): "pipe" | "inherit" =>
+  typeof output === "string" ? output : "pipe"
+
+const toError = (err: unknown): Error => err instanceof globalThis.Error ? err : new globalThis.Error(String(err))
+
+const toPlatformError = (
+  method: string,
+  error: NodeJS.ErrnoException,
+  command: Command.Command
+): Error.PlatformError => {
+  const flattened = Command.flatten(command).reduce((acc, curr) => {
+    const command = `${curr.command} ${curr.args.join(" ")}`
+    return acc.length === 0 ? command : `${acc} | ${command}`
+  }, "")
+  return handleErrnoException("Command", method)(error, [flattened])
+}
+
+const runCommand = (fileSystem: FileSystem.FileSystem) =>
+  (command: Command.Command): Effect.Effect<never, Error.PlatformError, CommandExecutor.Process> => {
+    switch (command._tag) {
+      case "StandardCommand": {
+        return pipe(
+          // Validate that the directory is accessible
+          Option.match(command.cwd, {
+            onNone: () => Effect.unit,
+            onSome: (dir) => fileSystem.access(dir)
+          }),
+          Effect.zipRight(Effect.sync(() => globalThis.process.env)),
+          Effect.flatMap((env) =>
+            Effect.asyncInterrupt<never, Error.PlatformError, CommandExecutor.Process>((resume) => {
+              const handle = ChildProcess.spawn(command.command, command.args, {
+                stdio: [
+                  inputToStdioOption(command.stdin),
+                  outputToStdioOption(command.stdout),
+                  outputToStdioOption(command.stderr)
+                ],
+                cwd: Option.getOrElse(command.cwd, constUndefined),
+                env: { ...env, ...Object.fromEntries(command.env) }
+              })
+
+              // If starting the process throws an error, make sure to capture it
+              handle.on("error", (err) => {
+                handle.kill("SIGKILL")
+                resume(Effect.fail(toPlatformError("spawn", err, command)))
+              })
+
+              // If the process is assigned a process identifier, then we know it
+              // was spawned successfully
+              if (handle.pid) {
+                let stdin: Sink.Sink<never, Error.PlatformError, unknown, never, void> = Sink.drain()
+
+                if (handle.stdin !== null) {
+                  stdin = fromWritable(
+                    () => handle.stdin!,
+                    (err) => toPlatformError("toWritable", toError(err), command)
+                  )
+                }
+
+                const exitCode: CommandExecutor.Process["exitCode"] = Effect.asyncInterrupt((resume) => {
+                  handle.on("exit", (code, signal) => {
+                    if (code !== null) {
+                      resume(Effect.succeed(CommandExecutor.ExitCode(code)))
+                    } else {
+                      // If code is `null`, then `signal` must be defined. See the NodeJS
+                      // documentation for the `"exit"` event on a `child_process`.
+                      // https://nodejs.org/api/child_process.html#child_process_event_exit
+                      resume(
+                        Effect.fail(
+                          toPlatformError(
+                            "exitCode",
+                            new globalThis.Error(`Process interrupted due to receipt of signal: ${signal}`),
+                            command
+                          )
+                        )
+                      )
+                    }
+                  })
+                  // Make sure to terminate the running process if the fiber is
+                  // terminated
+                  return Effect.sync(() => {
+                    handle.kill("SIGKILL")
+                  })
+                })
+
+                const isRunning = Effect.sync(() =>
+                  handle.exitCode === null &&
+                  handle.signalCode === null &&
+                  !handle.killed
+                )
+
+                const kill: CommandExecutor.Process["kill"] = (signal = "SIGTERM") =>
+                  Effect.asyncInterrupt((resume) => {
+                    handle.kill(signal)
+                    handle.on("exit", () => {
+                      resume(Effect.unit)
+                    })
+                    // Make sure to terminate the running process if the fiber
+                    // is terminated
+                    return Effect.sync(() => {
+                      handle.kill("SIGKILL")
+                    })
+                  })
+
+                resume(Effect.sync<CommandExecutor.Process>(() => {
+                  const pid = CommandExecutor.ProcessId(handle.pid!)
+                  const stderr = fromReadable<Error.PlatformError, Uint8Array>(
+                    () => handle.stderr!,
+                    (err) => toPlatformError("fromReadable(stderr)", toError(err), command)
+                  )
+                  let stdout: Stream.Stream<never, Error.PlatformError, Uint8Array> = fromReadable<
+                    Error.PlatformError,
+                    Uint8Array
+                  >(
+                    () => handle.stdout!,
+                    (err) => toPlatformError("fromReadable(stdout)", toError(err), command)
+                  )
+                  // TODO: add Sink.isSink
+                  if (typeof command.stdout !== "string") {
+                    stdout = Stream.transduce(stdout, command.stdout)
+                  }
+                  return {
+                    [CommandExecutor.ProcessTypeId]: CommandExecutor.ProcessTypeId,
+                    pid,
+                    exitCode,
+                    isRunning,
+                    kill,
+                    stdin,
+                    stderr,
+                    stdout
+                  }
+                }))
+              }
+              return Effect.async<never, never, void>((resume) => {
+                if (handle.pid) {
+                  handle.kill("SIGTERM")
+                }
+                handle.on("exit", () => {
+                  resume(Effect.unit)
+                })
+              })
+            })
+          ),
+          Effect.tap((process) =>
+            Option.match(command.stdin, {
+              onNone: () => Effect.unit,
+              onSome: (stdin) => Effect.forkDaemon(Stream.run(stdin, process.stdin))
+            })
+          )
+        )
+      }
+      case "PipedCommand": {
+        const flattened = Command.flatten(command)
+        if (flattened.length === 1) {
+          return pipe(flattened[0], runCommand(fileSystem))
+        }
+        const head = flattened[0]
+        const tail = flattened.slice(1)
+        const initial = tail.slice(0, tail.length - 1)
+        const last = tail[tail.length - 1]
+        const stream = initial.reduce(
+          (stdin, command) =>
+            pipe(
+              Command.stdin(command, stdin),
+              runCommand(fileSystem),
+              Stream.flatMap((process) => process.stdout)
+            ),
+          pipe(
+            runCommand(fileSystem)(head),
+            Stream.flatMap((process) => process.stdout)
+          )
+        )
+        return pipe(Command.stdin(last, stream), runCommand(fileSystem))
+      }
+    }
+  }
+
+/** @internal */
+export const layer: Layer.Layer<FileSystem.FileSystem, never, CommandExecutor.CommandExecutor> = Layer.effect(
+  CommandExecutor.CommandExecutor,
+  pipe(
+    FileSystem.FileSystem,
+    Effect.map((fileSystem) => CommandExecutor.makeExecutor(runCommand(fileSystem)))
+  )
+)

package/src/internal/error.ts

@@ -0,0 +1,51 @@
+import type { PlatformError, SystemErrorReason } from "@effect/platform/Error"
+import { SystemError } from "@effect/platform/Error"
+import type { PathLike } from "node:fs"
+
+/** @internal */
+export const handleErrnoException = (module: SystemError["module"], method: string) =>
+  (
+    err: NodeJS.ErrnoException,
+    [path]: [path: PathLike | number, ...args: Array<any>]
+  ): PlatformError => {
+    let reason: SystemErrorReason = "Unknown"
+
+    switch (err.code) {
+      case "ENOENT":
+        reason = "NotFound"
+        break
+
+      case "EACCES":
+        reason = "PermissionDenied"
+        break
+
+      case "EEXIST":
+        reason = "AlreadyExists"
+        break
+
+      case "EISDIR":
+        reason = "BadResource"
+        break
+
+      case "ENOTDIR":
+        reason = "BadResource"
+        break
+
+      case "EBUSY":
+        reason = "Busy"
+        break
+
+      case "ELOOP":
+        reason = "BadResource"
+        break
+    }
+
+    return SystemError({
+      reason,
+      module,
+      method,
+      pathOrDescriptor: path as string | number,
+      syscall: err.syscall,
+      message: err.message
+    })
+  }