@livestore/utils-dev 0.4.0-dev.3 → 0.4.0-dev.6

package/src/node/mod.ts

@@ -1,19 +1,9 @@
 import { performance } from 'node:perf_hooks'
 
 import * as OtelNodeSdk from '@effect/opentelemetry/NodeSdk'
-import { IS_BUN, isNonEmptyString, isNotUndefined, shouldNeverHappen } from '@livestore/utils'
-import type { CommandExecutor, PlatformError, Tracer } from '@livestore/utils/effect'
-import {
-  Command,
-  Config,
-  Effect,
-  FiberRef,
-  identity,
-  Layer,
-  LogLevel,
-  OtelTracer,
-  Schema,
-} from '@livestore/utils/effect'
+import { IS_BUN, isNonEmptyString } from '@livestore/utils'
+import type { Tracer } from '@livestore/utils/effect'
+import { Config, Effect, FiberRef, Layer, LogLevel, OtelTracer } from '@livestore/utils/effect'
 import { OtelLiveDummy } from '@livestore/utils/node'
 import * as otel from '@opentelemetry/api'
 import { OTLPMetricExporter } from '@opentelemetry/exporter-metrics-otlp-http'
@@ -23,8 +13,24 @@ import { BatchSpanProcessor } from '@opentelemetry/sdk-trace-base'
 
 export { OTLPMetricExporter } from '@opentelemetry/exporter-metrics-otlp-http'
 export { OTLPTraceExporter } from '@opentelemetry/exporter-trace-otlp-http'
-
+export * from './cmd.ts'
+export {
+  type DockerComposeArgs,
+  DockerComposeError,
+  type DockerComposeOperations,
+  DockerComposeService,
+  type LogsOptions,
+  type StartOptions,
+  startDockerComposeServicesScoped,
+} from './DockerComposeService/DockerComposeService.ts'
 export * as FileLogger from './FileLogger.ts'
+export * from './WranglerDevServer/process-tree-manager.ts'
+export {
+  type StartWranglerDevServerArgs,
+  type WranglerDevServer,
+  WranglerDevServerError,
+  WranglerDevServerService,
+} from './WranglerDevServer/WranglerDevServer.ts'
 
 export const OtelLiveHttp = ({
   serviceName,
@@ -169,100 +175,3 @@ export const getTracingBackendUrl = (span: otel.Span) =>
     // TODO make dynamic via env var
     return `${grafanaEndpoint}/explore?${searchParams.toString()}`
   })
-
-export const cmd: (
-  commandInput: string | (string | undefined)[],
-  options?:
-    | {
-        cwd?: string
-        stderr?: 'inherit' | 'pipe'
-        stdout?: 'inherit' | 'pipe'
-        shell?: boolean
-        env?: Record<string, string | undefined>
-      }
-    | undefined,
-) => Effect.Effect<CommandExecutor.ExitCode, PlatformError.PlatformError | CmdError, CommandExecutor.CommandExecutor> =
-  Effect.fn('cmd')(function* (commandInput, options) {
-    const cwd = options?.cwd ?? process.env.WORKSPACE_ROOT ?? shouldNeverHappen('WORKSPACE_ROOT is not set')
-    const [command, ...args] = Array.isArray(commandInput)
-      ? commandInput.filter(isNotUndefined)
-      : commandInput.split(' ')
-
-    const debugEnvStr = Object.entries(options?.env ?? {})
-      .map(([key, value]) => `${key}='${value}' `)
-      .join('')
-    const subshellStr = options?.shell ? ' (in subshell)' : ''
-    const commandDebugStr = debugEnvStr + [command, ...args].join(' ')
-
-    yield* Effect.logDebug(`Running '${commandDebugStr}' in '${cwd}'${subshellStr}`)
-    yield* Effect.annotateCurrentSpan({ 'span.label': commandDebugStr, cwd, command, args })
-
-    return yield* Command.make(command!, ...args).pipe(
-      // TODO don't forward abort signal to the command
-      Command.stdin('inherit'), // Forward stdin to the command
-      // inherit = Stream stdout to process.stdout, pipe = Stream stdout to process.stderr
-      Command.stdout(options?.stdout ?? 'inherit'),
-      // inherit = Stream stderr to process.stderr, pipe = Stream stderr to process.stdout
-      Command.stderr(options?.stderr ?? 'inherit'),
-      Command.workingDirectory(cwd),
-      options?.shell ? Command.runInShell(true) : identity,
-      Command.env(options?.env ?? {}),
-      Command.exitCode,
-      Effect.tap((exitCode) =>
-        exitCode === 0
-          ? Effect.void
-          : Effect.fail(
-              CmdError.make({
-                command: command!,
-                args,
-                cwd,
-                env: options?.env ?? {},
-                stderr: options?.stderr ?? 'inherit',
-              }),
-            ),
-      ),
-    )
-  })
-
-export const cmdText: (
-  commandInput: string | (string | undefined)[],
-  options?: {
-    cwd?: string
-    stderr?: 'inherit' | 'pipe'
-    runInShell?: boolean
-    env?: Record<string, string | undefined>
-  },
-) => Effect.Effect<string, PlatformError.PlatformError, CommandExecutor.CommandExecutor> = Effect.fn('cmdText')(
-  function* (commandInput, options) {
-    const cwd = options?.cwd ?? process.env.WORKSPACE_ROOT ?? shouldNeverHappen('WORKSPACE_ROOT is not set')
-    const [command, ...args] = Array.isArray(commandInput)
-      ? commandInput.filter(isNotUndefined)
-      : commandInput.split(' ')
-    const debugEnvStr = Object.entries(options?.env ?? {})
-      .map(([key, value]) => `${key}='${value}' `)
-      .join('')
-
-    const commandDebugStr = debugEnvStr + [command, ...args].join(' ')
-    const subshellStr = options?.runInShell ? ' (in subshell)' : ''
-
-    yield* Effect.logDebug(`Running '${commandDebugStr}' in '${cwd}'${subshellStr}`)
-    yield* Effect.annotateCurrentSpan({ 'span.label': commandDebugStr, command, cwd })
-
-    return yield* Command.make(command!, ...args).pipe(
-      // inherit = Stream stderr to process.stderr, pipe = Stream stderr to process.stdout
-      Command.stderr(options?.stderr ?? 'inherit'),
-      Command.workingDirectory(cwd),
-      options?.runInShell ? Command.runInShell(true) : identity,
-      Command.env(options?.env ?? {}),
-      Command.string,
-    )
-  },
-)
-
-export class CmdError extends Schema.TaggedError<CmdError>()('CmdError', {
-  command: Schema.String,
-  args: Schema.Array(Schema.String),
-  cwd: Schema.String,
-  env: Schema.Record({ key: Schema.String, value: Schema.String.pipe(Schema.UndefinedOr) }),
-  stderr: Schema.Literal('inherit', 'pipe'),
-}) {}

package/src/node-vitest/Vitest.test.ts

@@ -0,0 +1,101 @@
+import { Effect, FastCheck } from '@livestore/utils/effect'
+import * as Vitest from './Vitest.ts'
+
+// Demonstrate enhanced asProp functionality with clear shrinking progress
+// This showcases the fix for the "Run 26/6" bug and accurate shrinking detection
+
+Vitest.describe('Vitest.asProp', () => {
+  const IntArbitrary = FastCheck.integer({ min: 1, max: 100 })
+
+  // Always-passing test - should only show initial phase
+  Vitest.asProp(
+    Vitest.scopedLive,
+    'always-pass test (shows only initial runs)',
+    [IntArbitrary],
+    (properties, _ctx, enhanced) =>
+      Effect.gen(function* () {
+        const [value] = properties
+        if (value === undefined) {
+          return yield* Effect.fail(new Error('Value is undefined'))
+        }
+
+        console.log(
+          `✅ ALWAYS-PASS [${enhanced._tag.toUpperCase()}]: ` +
+            (enhanced._tag === 'initial'
+              ? `Run ${enhanced.runIndex + 1}/${enhanced.numRuns}`
+              : `Shrink #${enhanced.shrinkAttempt} (finding minimal counterexample)`) +
+            `, value=${value}, total=${enhanced.totalExecutions}`,
+        )
+
+        // This test always passes, so no shrinking will occur
+        return
+      }),
+    { fastCheck: { numRuns: 4 } },
+  )
+
+  // Failing test - should show initial + shrinking phases
+  let alreadyFailed = false
+  Vitest.asProp(
+    Vitest.scopedLive,
+    'failing test (shows initial runs + shrinking)',
+    [IntArbitrary],
+    (properties, ctx, enhanced) =>
+      Effect.gen(function* () {
+        const [value] = properties
+        if (value === undefined) {
+          return yield* Effect.fail(new Error('Value is undefined'))
+        }
+
+        const displayInfo =
+          enhanced._tag === 'initial'
+            ? `Run ${enhanced.runIndex + 1}/${enhanced.numRuns}`
+            : `Shrink #${enhanced.shrinkAttempt} (finding minimal counterexample)`
+
+        const status = value > 80 ? '💥' : '✅'
+        console.log(
+          `${status} FAILING-TEST [${enhanced._tag.toUpperCase()}]: ${displayInfo}, value=${value}, total=${enhanced.totalExecutions}`,
+        )
+
+        // Fail when value is greater than 80 to trigger shrinking
+        if (value > 80) {
+          alreadyFailed = true
+          return yield* Effect.fail(new Error(`Value ${value} is too large (> 80)`))
+        }
+
+        if (alreadyFailed && enhanced._tag === 'shrinking') {
+          ctx.skip("For the sake of this test, we don't want to fail but want to skip")
+          return
+        }
+
+        return
+      }),
+    { fastCheck: { numRuns: 3 } },
+  )
+
+  // Test with endOnFailure: true - should not show shrinking
+  Vitest.asProp(
+    Vitest.scopedLive,
+    'failing test with endOnFailure (no shrinking)',
+    [IntArbitrary],
+    (properties, _ctx, enhanced) =>
+      Effect.gen(function* () {
+        const [value] = properties
+        if (value === undefined) {
+          return yield* Effect.fail(new Error('Value is undefined'))
+        }
+
+        console.log(
+          `🚫 END-ON-FAILURE [${enhanced._tag.toUpperCase()}]: ` +
+            `Run ${enhanced.runIndex + 1}/${enhanced.numRuns}, value=${value}, total=${enhanced.totalExecutions}`,
+        )
+
+        // This will fail but shrinking is disabled
+        if (value > 50) {
+          yield* Effect.fail(new Error(`Value ${value} is too large (> 50) - but no shrinking!`))
+        }
+
+        return
+      }),
+    { fastCheck: { numRuns: 5, endOnFailure: true }, fails: true },
+  )
+})

package/src/node-vitest/Vitest.ts

@@ -1,7 +1,18 @@
 import * as inspector from 'node:inspector'
 import type * as Vitest from '@effect/vitest'
 import { IS_CI } from '@livestore/utils'
-import { type Cause, Duration, Effect, identity, Layer, type OtelTracer, type Scope } from '@livestore/utils/effect'
+import {
+  type Cause,
+  Duration,
+  Effect,
+  type FastCheck as FC,
+  identity,
+  Layer,
+  type OtelTracer,
+  Predicate,
+  type Schema,
+  type Scope,
+} from '@livestore/utils/effect'
 import { OtelLiveDummy } from '@livestore/utils/node'
 import { OtelLiveHttp } from '../node/mod.ts'
 
@@ -9,12 +20,17 @@ export * from '@effect/vitest'
 
 export const DEBUGGER_ACTIVE = Boolean(process.env.DEBUGGER_ACTIVE ?? inspector.url() !== undefined)
 
-export const makeWithTestCtx =
-  <R1 = never, E1 = never>(ctxParams: WithTestCtxParams<R1, E1>) =>
-  (testContext: Vitest.TestContext) =>
+export const makeWithTestCtx: <R1, E1>(
+  ctxParams: WithTestCtxParams<R1, E1>,
+) => (
+  testContext: Vitest.TestContext,
+) => <A, E>(
+  self: Effect.Effect<A, E, Scope.Scope | NoInfer<R1> | OtelTracer.OtelTracer>,
+) => Effect.Effect<A, E1 | Cause.TimeoutException | E, Scope.Scope> =
+  (ctxParams) => (testContext: Vitest.TestContext) =>
     withTestCtx(testContext, ctxParams)
 
-export type WithTestCtxParams<R1 = never, E1 = never> = {
+export type WithTestCtxParams<R1, E1> = {
   suffix?: string
   makeLayer?: (testContext: Vitest.TestContext) => Layer.Layer<R1, E1, Scope.Scope>
   timeout?: Duration.DurationInput
@@ -43,7 +59,11 @@ export const withTestCtx =
     const layer = makeLayer?.(testContext)
 
     const otelLayer =
-      DEBUGGER_ACTIVE || forceOtel ? OtelLiveHttp({ serviceName: 'vitest-runner', skipLogUrl: false }) : OtelLiveDummy
+      DEBUGGER_ACTIVE || forceOtel
+        ? OtelLiveHttp({ rootSpanName: spanName, serviceName: 'vitest-runner', skipLogUrl: false })
+        : OtelLiveDummy
+
+    const combinedLayer = (layer ?? Layer.empty).pipe(Layer.provideMerge(otelLayer))
 
     return self.pipe(
       DEBUGGER_ACTIVE
@@ -53,10 +73,154 @@ export const withTestCtx =
             label: `${spanName} approaching timeout (timeout: ${Duration.format(timeout)})`,
           }),
       DEBUGGER_ACTIVE ? identity : Effect.timeout(timeout),
-      Effect.provide(otelLayer),
-      Effect.provide(layer ?? Layer.empty),
+      Effect.provide(combinedLayer),
       Effect.scoped, // We need to scope the effect manually here because otherwise the span is not closed
-      Effect.withSpan(spanName),
       Effect.annotateLogs({ suffix }),
     ) as any
   }
+
+/**
+ * Shared properties for all enhanced test context phases
+ */
+export interface EnhancedTestContextBase {
+  numRuns: number
+  /** 0-based index */
+  runIndex: number
+  /** Total number of executions including initial runs and shrinking attempts */
+  totalExecutions: number
+}
+
+/**
+ * Enhanced context for property-based tests that includes shrinking phase information
+ */
+export type EnhancedTestContext =
+  | (EnhancedTestContextBase & {
+      _tag: 'initial'
+    })
+  | (EnhancedTestContextBase & {
+      _tag: 'shrinking'
+      /** Number of shrinking attempts */
+      shrinkAttempt: number
+    })
+
+/**
+ * Normalizes propOptions to ensure @effect/vitest receives correct fastCheck structure
+ */
+const normalizePropOptions = <Arbs extends Vitest.Vitest.Arbitraries>(
+  propOptions:
+    | number
+    | (Vitest.TestOptions & {
+        fastCheck?: FC.Parameters<{
+          [K in keyof Arbs]: Arbs[K] extends FC.Arbitrary<infer T> ? T : Schema.Schema.Type<Arbs[K]>
+        }>
+      }),
+): Vitest.TestOptions & {
+  fastCheck?: FC.Parameters<{
+    [K in keyof Arbs]: Arbs[K] extends FC.Arbitrary<infer T> ? T : Schema.Schema.Type<Arbs[K]>
+  }>
+} => {
+  // If it's a number, treat as timeout and add our default fastCheck
+  if (!Predicate.isObject(propOptions)) {
+    return {
+      timeout: propOptions,
+      fastCheck: { numRuns: 100 },
+    }
+  }
+
+  // If no fastCheck property, add it with our default numRuns
+  if (!propOptions.fastCheck) {
+    return {
+      ...propOptions,
+      fastCheck: { numRuns: 100 },
+    }
+  }
+
+  // If fastCheck exists but no numRuns, add our default
+  if (propOptions.fastCheck && !propOptions.fastCheck.numRuns) {
+    return {
+      ...propOptions,
+      fastCheck: {
+        ...propOptions.fastCheck,
+        numRuns: 100,
+      },
+    }
+  }
+
+  // If everything is properly structured, pass through
+  return propOptions
+}
+
+/**
+ * Equivalent to Vitest.prop but provides enhanced context including shrinking progress visibility
+ *
+ * This function enhances the standard property-based testing by providing clear information about
+ * whether FastCheck is in the initial testing phase or the shrinking phase, solving the confusion
+ * where tests show "Run 26/6" when FastCheck's shrinking algorithm is active.
+ *
+ * TODO: allow for upper timelimit instead of / additional to `numRuns`
+ *
+ * TODO: Upstream to Effect
+ */
+export const asProp = <Arbs extends Vitest.Vitest.Arbitraries, A, E, R>(
+  api: Vitest.Vitest.Tester<R>,
+  name: string,
+  arbitraries: Arbs,
+  test: Vitest.Vitest.TestFunction<
+    A,
+    E,
+    R,
+    [
+      { [K in keyof Arbs]: Arbs[K] extends FC.Arbitrary<infer T> ? T : Schema.Schema.Type<Arbs[K]> },
+      Vitest.TestContext,
+      EnhancedTestContext,
+    ]
+  >,
+  propOptions:
+    | number
+    | (Vitest.TestOptions & {
+        fastCheck?: FC.Parameters<{
+          [K in keyof Arbs]: Arbs[K] extends FC.Arbitrary<infer T> ? T : Schema.Schema.Type<Arbs[K]>
+        }>
+      }),
+) => {
+  const normalizedPropOptions = normalizePropOptions(propOptions)
+  const numRuns = normalizedPropOptions.fastCheck?.numRuns ?? 100
+  let runIndex = 0
+  let shrinkAttempts = 0
+  let totalExecutions = 0
+
+  return api.prop(
+    name,
+    arbitraries,
+    (properties, ctx) => {
+      if (ctx.signal.aborted) {
+        return ctx.skip('Test aborted')
+      }
+
+      totalExecutions++
+      const isInShrinkingPhase = runIndex >= numRuns
+
+      if (isInShrinkingPhase) {
+        shrinkAttempts++
+      }
+
+      const enhancedContext: EnhancedTestContext = isInShrinkingPhase
+        ? {
+            _tag: 'shrinking',
+            numRuns,
+            runIndex: runIndex++,
+            shrinkAttempt: shrinkAttempts,
+            totalExecutions,
+          }
+        : {
+            _tag: 'initial',
+            numRuns,
+            runIndex: runIndex++,
+            totalExecutions,
+          }
+
+      return test(properties, ctx, enhancedContext)
+    },
+    normalizedPropOptions,
+  )
+}