add TestRunner & SingleRunner modules (#5827)

Author: tim-smart

.changeset/common-hands-cough.md

@@ -0,0 +1,5 @@
+---
+"@effect/workflow": minor
+---
+
+remove schedule option from Activity.retry

.changeset/gentle-humans-matter.md

@@ -0,0 +1,12 @@
+---
+"@effect/cluster": patch
+---
+
+add TestRunner & SingleRunner modules
+
+- `TestRunner` allows you to run a in-memory cluster for testing purposes.
+
+- `SingleRunner` allows you to run a single node cluster simple deployment
+  scenarios.
+  - Message storage is backed by a SQL database
+  - Multiple nodes are not supported

packages/cluster/src/SingleRunner.ts

@@ -0,0 +1,41 @@
+/**
+ * @since 1.0.0
+ */
+import type * as SqlClient from "@effect/sql/SqlClient"
+import type * as ConfigError from "effect/ConfigError"
+import * as Layer from "effect/Layer"
+import type * as MessageStorage from "./MessageStorage.js"
+import * as RunnerHealth from "./RunnerHealth.js"
+import * as Runners from "./Runners.js"
+import * as RunnerStorage from "./RunnerStorage.js"
+import * as Sharding from "./Sharding.js"
+import * as ShardingConfig from "./ShardingConfig.js"
+import * as SqlMessageStorage from "./SqlMessageStorage.js"
+import * as SqlRunnerStorage from "./SqlRunnerStorage.js"
+
+/**
+ * A sql backed single-node cluster, that can be used for running durable
+ * entities and workflows.
+ *
+ * @since 1.0.0
+ * @category Layers
+ */
+export const layer = (options?: {
+  readonly shardingConfig?: Partial<ShardingConfig.ShardingConfig["Type"]> | undefined
+  readonly runnerStorage?: "memory" | "sql" | undefined
+}): Layer.Layer<
+  | Sharding.Sharding
+  | Runners.Runners
+  | MessageStorage.MessageStorage,
+  ConfigError.ConfigError,
+  SqlClient.SqlClient
+> =>
+  Sharding.layer.pipe(
+    Layer.provideMerge(Runners.layerNoop),
+    Layer.provideMerge(SqlMessageStorage.layer),
+    Layer.provide([
+      options?.runnerStorage === "memory" ? RunnerStorage.layerMemory : Layer.orDie(SqlRunnerStorage.layer),
+      RunnerHealth.layerNoop
+    ]),
+    Layer.provide(ShardingConfig.layerFromEnv(options?.shardingConfig))
+  )

packages/cluster/src/TestRunner.ts

@@ -0,0 +1,28 @@
+/**
+ * @since 1.0.0
+ */
+import * as Layer from "effect/Layer"
+import * as MessageStorage from "./MessageStorage.js"
+import * as RunnerHealth from "./RunnerHealth.js"
+import * as Runners from "./Runners.js"
+import * as RunnerStorage from "./RunnerStorage.js"
+import * as Sharding from "./Sharding.js"
+import * as ShardingConfig from "./ShardingConfig.js"
+
+/**
+ * An in-memory cluster that can be used for testing purposes.
+ *
+ * MessageStorage is backed by an in-memory driver, and RunnerStorage is backed
+ * by an in-memory driver.
+ *
+ * @since 1.0.0
+ * @category Layers
+ */
+export const layer: Layer.Layer<
+  Sharding.Sharding | Runners.Runners | MessageStorage.MessageStorage | MessageStorage.MemoryDriver
+> = Sharding.layer.pipe(
+  Layer.provideMerge(Runners.layerNoop),
+  Layer.provideMerge(MessageStorage.layerMemory),
+  Layer.provide([RunnerStorage.layerMemory, RunnerHealth.layerNoop]),
+  Layer.provide(ShardingConfig.layer())
+)

packages/cluster/src/index.ts

@@ -148,6 +148,11 @@ export * as ShardingConfig from "./ShardingConfig.js"
  */
 export * as ShardingRegistrationEvent from "./ShardingRegistrationEvent.js"
 
+/**
+ * @since 1.0.0
+ */
+export * as SingleRunner from "./SingleRunner.js"
+
 /**
  * @since 1.0.0
  */
@@ -177,3 +182,8 @@ export * as SqlMessageStorage from "./SqlMessageStorage.js"
  * @since 1.0.0
  */
 export * as SqlRunnerStorage from "./SqlRunnerStorage.js"
+
+/**
+ * @since 1.0.0
+ */
+export * as TestRunner from "./TestRunner.js"

packages/workflow/src/Activity.ts

@@ -11,6 +11,7 @@ import { dual } from "effect/Function"
 import * as Schedule from "effect/Schedule"
 import * as Schema from "effect/Schema"
 import type { Scope } from "effect/Scope"
+import type * as Types from "effect/Types"
 import * as DurableDeferred from "./DurableDeferred.js"
 import { makeHashDigest } from "./internal/crypto.js"
 import * as Workflow from "./Workflow.js"
@@ -148,7 +149,15 @@ const retryOnInterrupt = (
  * @since 1.0.0
  * @category Error handling
  */
-export const retry: typeof Effect.retry = dual(
+export const retry: {
+  <E, O extends Types.NoExcessProperties<Omit<Effect.Retry.Options<E>, "schedule">, O>>(
+    options: O
+  ): <A, R>(self: Effect.Effect<A, E, R>) => Effect.Retry.Return<R, E, A, O>
+  <A, E, R, O extends Types.NoExcessProperties<Omit<Effect.Retry.Options<E>, "schedule">, O>>(
+    self: Effect.Effect<A, E, R>,
+    options: O
+  ): Effect.Retry.Return<R, E, A, O>
+} = dual(
   2,
   (effect: Effect.Effect<any, any, any>, options: {}) =>
     Effect.suspend(() => {