effect 4.0.0-beta.3 → 4.0.0-beta.30

package/src/unstable/process/ChildProcess.ts

@@ -41,7 +41,7 @@
  * @since 4.0.0
  */
 import type * as Duration from "../../Duration.ts"
-import * as Effect from "../../Effect.ts"
+import type * as Effect from "../../Effect.ts"
 import { dual } from "../../Function.ts"
 import { PipeInspectableProto, YieldableProto } from "../../internal/core.ts"
 import type { Pipeable } from "../../Pipeable.ts"
@@ -49,9 +49,8 @@ import type * as PlatformError from "../../PlatformError.ts"
 import * as Predicate from "../../Predicate.ts"
 import type * as Scope from "../../Scope.ts"
 import type * as Sink from "../../Sink.ts"
-import * as Stream from "../../Stream.ts"
-import type { ChildProcessHandle, ExitCode } from "./ChildProcessSpawner.ts"
-import { ChildProcessSpawner } from "./ChildProcessSpawner.ts"
+import type * as Stream from "../../Stream.ts"
+import { type ChildProcessHandle, ChildProcessSpawner } from "./ChildProcessSpawner.ts"
 
 const TypeId = "~effect/unstable/process/ChildProcess"
 
@@ -283,7 +282,7 @@ export interface KillOptions {
    * Defaults to `undefined`, which means that no timeout will be enforced by
    * default.
    */
-  readonly forceKillAfter?: Duration.DurationInput | undefined
+  readonly forceKillAfter?: Duration.Input | undefined
 }
 
 /**
@@ -414,7 +413,7 @@ export interface CommandOptions extends KillOptions {
    * the value of `globalThis.process.env`, prioritizing the values in `env`
    * when conflicts exist.
    */
-  readonly env?: Record<string, string> | undefined
+  readonly env?: Record<string, string | undefined> | undefined
   /**
    * If set to `true`, the child process uses both the values in `env` as well
    * as the values in `globalThis.process.env`, prioritizing the values in `env`
@@ -515,7 +514,7 @@ const Proto = {
   ...YieldableProto,
   [TypeId]: TypeId,
   asEffect(this: Command) {
-    return spawn(this)
+    return ChildProcessSpawner.use((_) => _.spawn(this))
   }
 }
 
@@ -1118,207 +1117,6 @@ export const setEnv: {
   }
 )
 
-/**
- * Spawn a command and return a handle for interaction.
- *
- * Unlike `exec`, this does not wait for the process to complete. Instead,
- * it returns a handle that provides access to the process's stdin, stdout,
- * stderr streams and exit code.
- *
- * Note: For piped commands, only the first command in the pipeline is spawned
- * and a handle to it is returned.
- *
- * @example
- * ```ts
- * import { NodeServices } from "@effect/platform-node"
- * import { Console, Effect, Stream } from "effect"
- * import { ChildProcess } from "effect/unstable/process"
- *
- * const program = Effect.gen(function*() {
- *   const cmd = ChildProcess.make`long-running-process`
- *   const handle = yield* ChildProcess.spawn(cmd)
- *
- *   // Stream stdout
- *   yield* handle.stdout.pipe(
- *     Stream.decodeText(),
- *     Stream.runForEach(Console.log),
- *     Effect.forkChild
- *   )
- *
- *   // Wait for exit
- *   const exitCode = yield* handle.exitCode
- *   yield* Console.log(`Process exited with code ${exitCode}`)
- * }).pipe(Effect.provide(NodeServices.layer))
- * ```
- *
- * @since 4.0.0
- * @category Execution
- */
-export const spawn = (command: Command): Effect.Effect<
-  ChildProcessHandle,
-  PlatformError.PlatformError,
-  ChildProcessSpawner | Scope.Scope
-> => ChildProcessSpawner.use((_) => _.spawn(command))
-
-/**
- * @since 4.0.0
- * @category Execution
- */
-export const exitCode = (command: Command): Effect.Effect<
-  ExitCode,
-  PlatformError.PlatformError,
-  ChildProcessSpawner
-> => Effect.scoped(Effect.flatMap(spawn(command), (handle) => handle.exitCode))
-
-/**
- * @since 4.0.0
- * @category Execution
- */
-export const streamString: {
-  /**
-   * @since 4.0.0
-   * @category Execution
-   */
-  (
-    options?: {
-      readonly includeStderr?: boolean | undefined
-    }
-  ): (self: Command) => Stream.Stream<string, PlatformError.PlatformError, ChildProcessSpawner>
-  /**
-   * @since 4.0.0
-   * @category Execution
-   */
-  (
-    self: Command,
-    options?: {
-      readonly includeStderr?: boolean | undefined
-    }
-  ): Stream.Stream<string, PlatformError.PlatformError, ChildProcessSpawner>
-} = dual(
-  (args) => isCommand(args[0]),
-  (
-    self: Command,
-    options?: { readonly includeStderr?: boolean | undefined }
-  ): Stream.Stream<
-    string,
-    PlatformError.PlatformError,
-    ChildProcessSpawner
-  > =>
-    spawn(self).pipe(
-      Effect.map((handle) =>
-        Stream.decodeText(
-          options?.includeStderr === true ? handle.all : handle.stdout
-        )
-      ),
-      Stream.unwrap
-    )
-)
-
-/**
- * @since 4.0.0
- * @category Execution
- */
-export const streamLines: {
-  /**
-   * @since 4.0.0
-   * @category Execution
-   */
-  (
-    options?: {
-      readonly includeStderr?: boolean | undefined
-    }
-  ): (self: Command) => Stream.Stream<string, PlatformError.PlatformError, ChildProcessSpawner>
-  /**
-   * @since 4.0.0
-   * @category Execution
-   */
-  (
-    self: Command,
-    options?: {
-      readonly includeStderr?: boolean | undefined
-    }
-  ): Stream.Stream<string, PlatformError.PlatformError, ChildProcessSpawner>
-} = dual(
-  (args) => isCommand(args[0]),
-  (self: Command, options?: { readonly includeStderr?: boolean | undefined }): Stream.Stream<
-    string,
-    PlatformError.PlatformError,
-    ChildProcessSpawner
-  > => Stream.splitLines(streamString(self, options))
-)
-
-/**
- * @since 4.0.0
- * @category Execution
- */
-export const lines: {
-  /**
-   * @since 4.0.0
-   * @category Execution
-   */
-  (
-    options?: {
-      readonly includeStderr?: boolean | undefined
-    }
-  ): (self: Command) => Effect.Effect<Array<string>, PlatformError.PlatformError, ChildProcessSpawner>
-  /**
-   * @since 4.0.0
-   * @category Execution
-   */
-  (
-    self: Command,
-    options?: {
-      readonly includeStderr?: boolean | undefined
-    }
-  ): Effect.Effect<Array<string>, PlatformError.PlatformError, ChildProcessSpawner>
-} = dual(
-  (args) => isCommand(args[0]),
-  (
-    self: Command,
-    options?: { readonly includeStderr?: boolean | undefined }
-  ): Effect.Effect<
-    Array<string>,
-    PlatformError.PlatformError,
-    ChildProcessSpawner
-  > => Stream.runCollect(streamLines(self, options))
-)
-
-/**
- * @since 4.0.0
- * @category Execution
- */
-export const string: {
-  /**
-   * @since 4.0.0
-   * @category Execution
-   */
-  (
-    options?: {
-      readonly includeStderr?: boolean | undefined
-    }
-  ): (self: Command) => Effect.Effect<string, PlatformError.PlatformError, ChildProcessSpawner>
-  /**
-   * @since 4.0.0
-   * @category Execution
-   */
-  (
-    self: Command,
-    options?: {
-      readonly includeStderr?: boolean | undefined
-    }
-  ): Effect.Effect<string, PlatformError.PlatformError, ChildProcessSpawner>
-} = dual(
-  (args) => isCommand(args[0]),
-  (
-    self: Command,
-    options?: { readonly includeStderr?: boolean | undefined }
-  ): Effect.Effect<
-    string,
-    PlatformError.PlatformError,
-    ChildProcessSpawner
-  > => Stream.mkString(streamString(self, options))
-)
-
 const isTemplateString = (u: unknown): u is TemplateStringsArray =>
   Array.isArray(u) && "raw" in u && Array.isArray(u.raw)
 

package/src/unstable/process/ChildProcessSpawner.ts

@@ -7,13 +7,13 @@
  * @since 4.0.0
  */
 import * as Brand from "../../Brand.ts"
-import type * as Effect from "../../Effect.ts"
+import * as Effect from "../../Effect.ts"
 import * as Inspectable from "../../Inspectable.ts"
 import type * as PlatformError from "../../PlatformError.ts"
 import type * as Scope from "../../Scope.ts"
 import * as ServiceMap from "../../ServiceMap.ts"
 import type * as Sink from "../../Sink.ts"
-import type * as Stream from "../../Stream.ts"
+import * as Stream from "../../Stream.ts"
 import type { Command, KillOptions } from "./ChildProcess.ts"
 
 /**
@@ -76,10 +76,16 @@ export interface ChildProcessHandle {
   readonly stdin: Sink.Sink<void, Uint8Array, never, PlatformError.PlatformError>
   /**
    * The standard output stream for the child process.
+   *
+   * Note: Using alongside `all` may cause interleaving of output and unexpected
+   * results.
    */
   readonly stdout: Stream.Stream<Uint8Array, PlatformError.PlatformError>
   /**
    * The standard error stream for the child process.
+   *
+   * Note: Using alongside `all` may cause interleaving of output and unexpected
+   * results.
    */
   readonly stderr: Stream.Stream<Uint8Array, PlatformError.PlatformError>
   /**
@@ -123,18 +129,32 @@ export const makeHandle = (params: Omit<ChildProcessHandle, typeof HandleTypeId>
   Object.assign(Object.create(HandleProto), params)
 
 /**
- * Service interface for spawning child processes.
+ * Create a new `ChildProcessSpawner` service from a `spawn` funciton
  *
  * @since 4.0.0
  * @category Models
  */
-export interface ChildProcessSpawner {
-  /**
-   * Spawn a command and return a handle for interaction.
-   */
-  readonly spawn: (
-    command: Command
-  ) => Effect.Effect<ChildProcessHandle, PlatformError.PlatformError, Scope.Scope>
+export const make = (spawn: ChildProcessSpawner["Service"]["spawn"]): ChildProcessSpawner["Service"] => {
+  const streamString: ChildProcessSpawner["Service"]["streamLines"] = (command, options) =>
+    spawn(command).pipe(
+      Effect.map((handle) =>
+        Stream.decodeText(
+          options?.includeStderr === true ? handle.all : handle.stdout
+        )
+      ),
+      Stream.unwrap
+    )
+  const streamLines: ChildProcessSpawner["Service"]["streamLines"] = (command, options) =>
+    Stream.splitLines(streamString(command, options))
+
+  return ChildProcessSpawner.of({
+    spawn,
+    exitCode: (command) => Effect.scoped(Effect.flatMap(spawn(command), (handle) => handle.exitCode)),
+    streamString,
+    streamLines,
+    lines: (command, options) => Stream.runCollect(streamLines(command, options)),
+    string: (command, options) => Stream.mkString(streamString(command, options))
+  })
 }
 
 /**
@@ -143,7 +163,48 @@ export interface ChildProcessSpawner {
  * @since 4.0.0
  * @category Service
  */
-export const ChildProcessSpawner: ServiceMap.Service<
-  ChildProcessSpawner,
-  ChildProcessSpawner
-> = ServiceMap.Service("effect/process/ChildProcessSpawner")
+export class ChildProcessSpawner extends ServiceMap.Service<ChildProcessSpawner, {
+  /**
+   * Spawn a command and return a handle for interaction.
+   */
+  spawn(
+    command: Command
+  ): Effect.Effect<ChildProcessHandle, PlatformError.PlatformError, Scope.Scope>
+
+  /**
+   * Run a command and return its exit code.
+   */
+  exitCode(
+    command: Command
+  ): Effect.Effect<ExitCode, PlatformError.PlatformError>
+
+  /**
+   * Stream the output of a command as strings. Optionally include stderr output
+   * interleaved with stdout.
+   */
+  streamString(command: Command, options?: {
+    readonly includeStderr?: boolean | undefined
+  }): Stream.Stream<string, PlatformError.PlatformError>
+
+  /**
+   * Stream the output of a command as lines. Optionally include stderr output
+   * interleaved with stdout.
+   */
+  streamLines(command: Command, options?: {
+    readonly includeStderr?: boolean | undefined
+  }): Stream.Stream<string, PlatformError.PlatformError>
+
+  /**
+   * Run a command and return the lines of its output as an array of strings.
+   */
+  lines(command: Command, options?: {
+    readonly includeStderr?: boolean | undefined
+  }): Effect.Effect<Array<string>, PlatformError.PlatformError>
+
+  /**
+   * Run a command and return its output as a string.
+   */
+  string(command: Command, options?: {
+    readonly includeStderr?: boolean | undefined
+  }): Effect.Effect<string, PlatformError.PlatformError>
+}>()("effect/process/ChildProcessSpawner") {}