@livestore/utils-dev 0.4.0-dev.8 → 0.4.0

package/src/node/workspace.ts

@@ -0,0 +1,46 @@
+import path from 'node:path'
+
+import { shouldNeverHappen } from '@livestore/utils'
+import { Context, Effect, Layer } from '@livestore/utils/effect'
+
+export type WorkspaceInfo = string
+
+/** Current working directory. */
+export class CurrentWorkingDirectory extends Context.Tag('CurrentWorkingDirectory')<
+  CurrentWorkingDirectory,
+  WorkspaceInfo
+>() {
+  /** Layer that captures the process cwd once. */
+  static live = Layer.effect(
+    CurrentWorkingDirectory,
+    Effect.sync(() => process.cwd()),
+  )
+
+  /** Override CWD for tests or nested invocations. */
+  static fromPath = (cwd: string) => Layer.succeed(CurrentWorkingDirectory, cwd)
+}
+
+/** Livestore workspace root (env required). */
+export class LivestoreWorkspace extends Context.Tag('LivestoreWorkspace')<LivestoreWorkspace, WorkspaceInfo>() {
+  /** Resolve from WORKSPACE_ROOT env. */
+  static live = Layer.effect(
+    LivestoreWorkspace,
+    Effect.sync(() => {
+      const root = process.env.WORKSPACE_ROOT ?? shouldNeverHappen('WORKSPACE_ROOT is not set')
+      return root
+    }),
+  )
+
+  /** Provide a fixed Livestore root. */
+  static fromPath = (root: string) => Layer.succeed(LivestoreWorkspace, root)
+
+  /** Derive a CurrentWorkingDirectory layer from the Livestore workspace root (with optional subpath) */
+  static toCwd = (/** Relative path to the Livestore workspace root */ subPath?: string) =>
+    Layer.effect(
+      CurrentWorkingDirectory,
+      Effect.gen(function* () {
+        const root = yield* LivestoreWorkspace
+        return path.join(root, subPath ?? '')
+      }),
+    )
+}

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

@@ -1,6 +1,11 @@
-import { Effect, FastCheck } from '@livestore/utils/effect'
+import { Effect, FastCheck, Schema } from '@livestore/utils/effect'
+
 import * as Vitest from './Vitest.ts'
 
+export class TestError extends Schema.TaggedError<TestError>()('TestError', {
+  message: Schema.String,
+}) {}
+
 // Demonstrate enhanced asProp functionality with clear shrinking progress
 // This showcases the fix for the "Run 26/6" bug and accurate shrinking detection
 
@@ -16,7 +21,7 @@ Vitest.describe('Vitest.asProp', () => {
       Effect.gen(function* () {
         const [value] = properties
         if (value === undefined) {
-          return yield* Effect.fail(new Error('Value is undefined'))
+          return yield* new TestError({ message: 'Value is undefined' })
         }
 
         console.log(
@@ -43,7 +48,7 @@ Vitest.describe('Vitest.asProp', () => {
       Effect.gen(function* () {
         const [value] = properties
         if (value === undefined) {
-          return yield* Effect.fail(new Error('Value is undefined'))
+          return yield* new TestError({ message: 'Value is undefined' })
         }
 
         const displayInfo =
@@ -59,10 +64,10 @@ Vitest.describe('Vitest.asProp', () => {
         // 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)`))
+          return yield* new TestError({ message: `Value ${value} is too large (> 80)` })
         }
 
-        if (alreadyFailed && enhanced._tag === 'shrinking') {
+        if (alreadyFailed === true && enhanced._tag === 'shrinking') {
           ctx.skip("For the sake of this test, we don't want to fail but want to skip")
           return
         }
@@ -81,7 +86,7 @@ Vitest.describe('Vitest.asProp', () => {
       Effect.gen(function* () {
         const [value] = properties
         if (value === undefined) {
-          return yield* Effect.fail(new Error('Value is undefined'))
+          return yield* new TestError({ message: 'Value is undefined' })
         }
 
         console.log(
@@ -91,7 +96,7 @@ Vitest.describe('Vitest.asProp', () => {
 
         // 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 yield* new TestError({ message: `Value ${value} is too large (> 50) - but no shrinking!` })
         }
 
         return

package/src/node-vitest/Vitest.ts

@@ -1,5 +1,7 @@
 import * as inspector from 'node:inspector'
+
 import type * as Vitest from '@effect/vitest'
+
 import { IS_CI } from '@livestore/utils'
 import {
   type Cause,
@@ -14,6 +16,7 @@ import {
   type Scope,
 } from '@livestore/utils/effect'
 import { OtelLiveDummy } from '@livestore/utils/node'
+
 import { OtelLiveHttp } from '../node/mod.ts'
 
 export * from '@effect/vitest'
@@ -47,7 +50,7 @@ export const withTestCtx =
     {
       suffix,
       makeLayer,
-      timeout = IS_CI ? 60_000 : 10_000,
+      timeout = IS_CI === true ? 60_000 : 10_000,
       forceOtel = false,
     }: {
       suffix?: string
@@ -67,24 +70,24 @@ export const withTestCtx =
     // provided layer from the effect dependencies
     | Exclude<R, ROut | OtelTracer.OtelTracer | Scope.Scope>
   > => {
-    const spanName = `${testContext.task.suite?.name}:${testContext.task.name}${suffix ? `:${suffix}` : ''}`
+    const spanName = `${testContext.task.suite?.name}:${testContext.task.name}${suffix !== undefined ? `:${suffix}` : ''}`
     const layer = makeLayer?.(testContext) ?? Layer.empty
 
     const otelLayer =
-      DEBUGGER_ACTIVE || forceOtel
+      DEBUGGER_ACTIVE === true || forceOtel === true
         ? OtelLiveHttp({ rootSpanName: spanName, serviceName: 'vitest-runner', skipLogUrl: false })
         : OtelLiveDummy
 
     const combinedLayer = layer.pipe(Layer.provideMerge(otelLayer))
 
     return self.pipe(
-      DEBUGGER_ACTIVE
+      DEBUGGER_ACTIVE === true
         ? identity
         : Effect.logWarnIfTakesLongerThan({
             duration: Duration.toMillis(timeout) * 0.8,
             label: `${spanName} approaching timeout (timeout: ${Duration.format(timeout)})`,
           }),
-      DEBUGGER_ACTIVE ? identity : Effect.timeout(timeout),
+      DEBUGGER_ACTIVE === true ? identity : Effect.timeout(timeout),
       Effect.provide(combinedLayer),
       Effect.scoped, // We need to scope the effect manually here because otherwise the span is not closed
       Effect.annotateLogs({ suffix }),
@@ -132,7 +135,7 @@ const normalizePropOptions = <Arbs extends Vitest.Vitest.Arbitraries>(
   }>
 } => {
   // If it's a number, treat as timeout and add our default fastCheck
-  if (!Predicate.isObject(propOptions)) {
+  if (Predicate.isObject(propOptions) === false) {
     return {
       timeout: propOptions,
       fastCheck: { numRuns: 100 },
@@ -140,7 +143,7 @@ const normalizePropOptions = <Arbs extends Vitest.Vitest.Arbitraries>(
   }
 
   // If no fastCheck property, add it with our default numRuns
-  if (!propOptions.fastCheck) {
+  if (propOptions.fastCheck == null) {
     return {
       ...propOptions,
       fastCheck: { numRuns: 100 },
@@ -148,7 +151,7 @@ const normalizePropOptions = <Arbs extends Vitest.Vitest.Arbitraries>(
   }
 
   // If fastCheck exists but no numRuns, add our default
-  if (propOptions.fastCheck && !propOptions.fastCheck.numRuns) {
+  if (propOptions.fastCheck !== undefined && propOptions.fastCheck.numRuns == null) {
     return {
       ...propOptions,
       fastCheck: {
@@ -205,31 +208,32 @@ export const asProp = <Arbs extends Vitest.Vitest.Arbitraries, A, E, R>(
     name,
     arbitraries,
     (properties, ctx) => {
-      if (ctx.signal.aborted) {
+      if (ctx.signal.aborted === true) {
         return ctx.skip('Test aborted')
       }
 
       totalExecutions++
       const isInShrinkingPhase = runIndex >= numRuns
 
-      if (isInShrinkingPhase) {
+      if (isInShrinkingPhase === true) {
         shrinkAttempts++
       }
 
-      const enhancedContext: EnhancedTestContext = isInShrinkingPhase
-        ? {
-            _tag: 'shrinking',
-            numRuns,
-            runIndex: runIndex++,
-            shrinkAttempt: shrinkAttempts,
-            totalExecutions,
-          }
-        : {
-            _tag: 'initial',
-            numRuns,
-            runIndex: runIndex++,
-            totalExecutions,
-          }
+      const enhancedContext: EnhancedTestContext =
+        isInShrinkingPhase === true
+          ? {
+              _tag: 'shrinking',
+              numRuns,
+              runIndex: runIndex++,
+              shrinkAttempt: shrinkAttempts,
+              totalExecutions,
+            }
+          : {
+              _tag: 'initial',
+              numRuns,
+              runIndex: runIndex++,
+              totalExecutions,
+            }
 
       return test(properties, ctx, enhancedContext)
     },

package/src/wrangler/WranglerDevServer.test.ts

@@ -1,7 +1,9 @@
+import { expect } from 'vitest'
+
+import { Vitest } from '@livestore/utils-dev/node-vitest'
 import { Effect, FetchHttpClient, Layer } from '@livestore/utils/effect'
 import { getFreePort, PlatformNode } from '@livestore/utils/node'
-import { Vitest } from '@livestore/utils-dev/node-vitest'
-import { expect } from 'vitest'
+
 import {
   type StartWranglerDevServerArgs,
   WranglerDevServerError,
@@ -59,7 +61,7 @@ Vitest.describe('WranglerDevServer', { timeout: testTimeout }, () => {
             WranglerDevServerTest({
               cwd: '/tmp',
               wranglerConfigPath: '/dev/null',
-              connectTimeout: '500 millis',
+              readiness: { connectTimeout: '500 millis' },
             }).pipe(Layer.provide(PlatformNode.NodeContext.layer)),
           ),
           Effect.flip,

package/src/wrangler/WranglerDevServer.ts

@@ -1,4 +1,5 @@
 import * as path from 'node:path'
+
 import * as Toml from '@iarna/toml'
 import { IS_CI } from '@livestore/utils'
 import { Cause, Duration, Effect, FileSystem, HttpClient, Schedule, Schema } from '@livestore/utils/effect'
@@ -8,7 +9,7 @@ import * as wrangler from 'wrangler'
 /**
  * Error type for WranglerDevServer operations
  */
-export class WranglerDevServerError extends Schema.TaggedError<WranglerDevServerError>()('WranglerDevServerError', {
+export class WranglerDevServerError extends Schema.TaggedError<WranglerDevServerError>('~@livestore/utils-dev/WranglerDevServerError')('WranglerDevServerError', {
   cause: Schema.Unknown,
   message: Schema.String,
   port: Schema.Number,
@@ -24,17 +25,35 @@ export interface WranglerDevServer {
 }
 
 /**
- * Configuration for starting WranglerDevServer
+ * Readiness and retry configuration for wrangler boot and HTTP health.
+ *
+ * Example: startupTimeout=20s, connectTimeout=5s, retrySchedule=recurs(1)
+ * - Give wrangler up to 20s to boot; if it succeeds, give the HTTP check up to 5s.
+ * - If wrangler fails/times out, retry boot once; each boot attempt gets its own 20s budget.
+ * connectTimeout should be shorter than startupTimeout because HTTP readiness should be fast after boot.
  */
+export interface WranglerReadinessOptions {
+  /** Max time to wait for wrangler to report ready before retrying. */
+  startupTimeout?: Duration.DurationInput
+  /** Max time for the HTTP connectivity check after wrangler reports ready. */
+  connectTimeout?: Duration.DurationInput
+  /** Retry policy for startup attempts (applies when startupTimeout elapses or wrangler throws). */
+  retrySchedule?: Schedule.Schedule<unknown>
+}
+
 export interface StartWranglerDevServerArgs {
+  /** Path to wrangler.toml (defaults to cwd/wrangler.toml). */
   wranglerConfigPath?: string
+  /** Working directory wrangler should use. */
   cwd: string
   /** The port to try first. The dev server may bind a different port if unavailable. */
   preferredPort?: number
   /** @default false */
   showLogs?: boolean
+  /** Optional inspector port for wrangler dev. */
   inspectorPort?: number
-  connectTimeout?: Duration.DurationInput
+  /** Readiness and retry configuration for bringing up wrangler and confirming connectivity. */
+  readiness?: WranglerReadinessOptions
 }
 
 /**
@@ -74,17 +93,37 @@ export class WranglerDevServerService extends Effect.Service<WranglerDevServerSe
       )
       const resolvedMainPath = yield* Effect.try(() => path.resolve(args.cwd, parsedConfig.main))
 
+      const readiness = args.readiness ?? {}
+      const startupTimeout = readiness.startupTimeout ?? Duration.seconds(IS_CI === true ? 30 : 10)
       const devServer = yield* Effect.promise(() =>
         wrangler.unstable_dev(resolvedMainPath, {
           config: configPath,
           port: preferredPort,
           inspectorPort: args.inspectorPort ?? 0,
           persistTo: path.join(args.cwd, '.wrangler/state'),
-          logLevel: showLogs ? 'info' : 'none',
+          logLevel: showLogs === true ? 'debug' : 'none',
           experimental: {
             disableExperimentalWarning: true,
           },
         }),
+      ).pipe(
+        Effect.timeout(startupTimeout),
+        Effect.mapError(
+          (cause) =>
+            new WranglerDevServerError({
+              cause,
+              message: `Failed to start wrangler dev server within ${Duration.format(startupTimeout)}`,
+              port: preferredPort,
+            }),
+        ),
+        Effect.tapError((error) =>
+          Effect.logError('Wrangler dev server failed to start', {
+            message: error.message,
+            preferredPort,
+            cwd: args.cwd,
+          }),
+        ),
+        Effect.retry(readiness.retrySchedule ?? Schedule.recurs(1)),
       )
 
       yield* Effect.addFinalizer(
@@ -111,12 +150,13 @@ export class WranglerDevServerService extends Effect.Service<WranglerDevServerSe
       const actualHost = devServer.address
       const url = `http://${actualHost}:${actualPort}`
 
-      // Use longer timeout in CI environments to account for slower startup times
-      const defaultTimeout = Duration.seconds(IS_CI ? 30 : 5)
+      // Use longer timeout in CI environments to account for slower HTTP readiness
+      const defaultConnectivityTimeout = Duration.seconds(IS_CI === true ? 30 : 5)
+      const connectivityTimeout = readiness.connectTimeout ?? defaultConnectivityTimeout
 
-      yield* verifyHttpConnectivity({ url, showLogs, connectTimeout: args.connectTimeout ?? defaultTimeout })
+      yield* verifyHttpConnectivity({ url, showLogs, connectTimeout: connectivityTimeout })
 
-      if (showLogs) {
+      if (showLogs === true) {
         yield* Effect.logDebug(
           `Wrangler dev server ready and accepting connections on port ${actualPort} (preferred: ${preferredPort})`,
         )
@@ -127,9 +167,10 @@ export class WranglerDevServerService extends Effect.Service<WranglerDevServerSe
         url,
       } satisfies WranglerDevServer
     }).pipe(
-      Effect.mapError(
-        (error) =>
-          new WranglerDevServerError({ cause: error, message: 'Failed to start wrangler dev server', port: -1 }),
+      Effect.mapError((error) =>
+        error instanceof WranglerDevServerError
+          ? error
+          : new WranglerDevServerError({ cause: error, message: 'Failed to start wrangler dev server', port: -1 }),
       ),
       Effect.withSpan('WranglerDevServerService', {
         attributes: { preferredPort: args.preferredPort ?? 'auto', cwd: args.cwd },
@@ -152,7 +193,7 @@ const verifyHttpConnectivity = ({
   Effect.gen(function* () {
     const client = yield* HttpClient.HttpClient
 
-    if (showLogs) {
+    if (showLogs === true) {
       yield* Effect.logDebug(`Verifying HTTP connectivity to ${url}`)
     }
 
@@ -173,7 +214,7 @@ const verifyHttpConnectivity = ({
             }),
           ),
       ),
-      Effect.tap(() => (showLogs ? Effect.logDebug(`HTTP connectivity verified for ${url}`) : Effect.void)),
+      Effect.tap(() => (showLogs === true ? Effect.logDebug(`HTTP connectivity verified for ${url}`) : Effect.void)),
       Effect.asVoid,
       Effect.withSpan('verifyHttpConnectivity'),
     )

package/src/wrangler/fixtures/wrangler.toml

@@ -8,4 +8,4 @@ class_name = "TestDO"
 
 [[migrations]]
 tag = "v1"
-new_sqlite_classes = ["TestDO"]
+new_sqlite_classes = ["TestDO"]