effect-orpc 0.3.0 → 0.4.0

package/src/tests/effect-builder.test.ts

@@ -12,9 +12,10 @@ import {
 import { beforeEach, describe, expect, expectTypeOf, it, vi } from "vitest";
 import z from "zod";
 
-import { EffectBuilder, makeEffectORPC } from "../effect-builder";
+import { EffectBuilder, eos, makeEffectORPC } from "../effect-builder";
 import { EffectDecoratedProcedure } from "../effect-procedure";
 import { withFiberContext } from "../node";
+import { makeEffectRuntimeRunner } from "../runtime-source";
 import { ORPCTaggedError, effectErrorMapToErrorMap } from "../tagged-error";
 import {
   baseErrorMap,
@@ -27,6 +28,7 @@ import {
 
 const mid = vi.fn();
 const runtime = ManagedRuntime.make(Layer.empty);
+const runner = makeEffectRuntimeRunner(runtime);
 
 const def = {
   config: {
@@ -43,6 +45,7 @@ const def = {
   outputValidationIndex: 88,
   route: baseRoute,
   dedupeLeadingMiddlewares: true,
+  runner,
   runtime,
 };
 
@@ -142,7 +145,7 @@ describe("effectBuilder", () => {
     const applied = builder.effect(effectFn);
 
     expect(applied).instanceOf(EffectDecoratedProcedure);
-    expect(applied["~effect"].runtime).toBe(runtime);
+    expect(applied["~effect"].runner.runtime).toBe(runtime);
     expect(applied["~effect"].handler).toBeInstanceOf(Function);
   });
 
@@ -271,7 +274,7 @@ describe("makeEffectORPC factory", () => {
     const effectBuilder = makeEffectORPC(runtime);
 
     expect(effectBuilder).instanceOf(EffectBuilder);
-    expect(effectBuilder["~effect"].runtime).toBe(runtime);
+    expect(effectBuilder["~effect"].runner.runtime).toBe(runtime);
     // Should inherit os's default definition
     expect(effectBuilder["~effect"].middlewares).toEqual(
       os["~orpc"].middlewares,
@@ -285,7 +288,7 @@ describe("makeEffectORPC factory", () => {
     const effectBuilder = makeEffectORPC(runtime, os);
 
     expect(effectBuilder).instanceOf(EffectBuilder);
-    expect(effectBuilder["~effect"].runtime).toBe(runtime);
+    expect(effectBuilder["~effect"].runner.runtime).toBe(runtime);
     expect(effectBuilder["~effect"].middlewares).toEqual(
       os["~orpc"].middlewares,
     );
@@ -294,6 +297,46 @@ describe("makeEffectORPC factory", () => {
     );
   });
 
+  it("exports an eos builder that works with provide", async () => {
+    class Counter extends Effect.Tag("EosCounter")<
+      Counter,
+      { increment: (n: number) => Effect.Effect<number> }
+    >() {}
+
+    const procedure = eos
+      .provide(
+        Layer.succeed(Counter, {
+          increment: (n: number) => Effect.succeed(n + 1),
+        }),
+      )
+      .input(z.number())
+      .effect(function* ({ input }) {
+        const counter = yield* Counter;
+        return yield* counter.increment(input as number);
+      });
+
+    expect(eos["~effect"].runner.runtime).toBeUndefined();
+    await expect(call(procedure, 5)).resolves.toBe(6);
+  });
+
+  it("does not own a ManagedRuntime when no source is provided", () => {
+    const effectBuilder = makeEffectORPC();
+
+    expect(effectBuilder["~effect"].runner.runtime).toBeUndefined();
+  });
+
+  it("does not own a ManagedRuntime when only a builder is provided", () => {
+    const effectBuilder = makeEffectORPC(os);
+
+    expect(effectBuilder["~effect"].runner.runtime).toBeUndefined();
+  });
+
+  it("does not own a ManagedRuntime when a Layer is provided", () => {
+    const effectBuilder = makeEffectORPC(Layer.empty);
+
+    expect(effectBuilder["~effect"].runner.runtime).toBeUndefined();
+  });
+
   it("creates working procedure with default os", async () => {
     const effectBuilder = makeEffectORPC(runtime);
 
@@ -427,11 +470,8 @@ describe("effect with services", () => {
       return yield* counter.increment(input as number);
     });
 
-    try {
-      await expect(call(procedure, 5)).resolves.toBe(6);
-    } finally {
-      await effectBuilder["~effect"].runtime.dispose();
-    }
+    expect(effectBuilder["~effect"].runner.runtime).toBeUndefined();
+    await expect(call(procedure, 5)).resolves.toBe(6);
   });
 
   it("can start without a runtime and provide a Layer", async () => {
@@ -451,11 +491,8 @@ describe("effect with services", () => {
       return yield* counter.increment(input as number);
     });
 
-    try {
-      await expect(call(procedure, 5)).resolves.toBe(6);
-    } finally {
-      await effectBuilder["~effect"].runtime.dispose();
-    }
+    expect(effectBuilder["~effect"].runner.runtime).toBeUndefined();
+    await expect(call(procedure, 5)).resolves.toBe(6);
   });
 
   it("can wrap a custom builder without a runtime and provide a Layer", async () => {
@@ -482,14 +519,11 @@ describe("effect with services", () => {
       };
     });
 
-    try {
-      await expect(call(procedure, 5)).resolves.toEqual({
-        fromCustomBuilder: true,
-        value: 6,
-      });
-    } finally {
-      await effectBuilder["~effect"].runtime.dispose();
-    }
+    expect(effectBuilder["~effect"].runner.runtime).toBeUndefined();
+    await expect(call(procedure, 5)).resolves.toEqual({
+      fromCustomBuilder: true,
+      value: 6,
+    });
   });
 
   it(".provide makes a request-scoped service available to handlers", async () => {

package/src/tests/effect-error-map.test.ts

@@ -193,10 +193,10 @@ describe("effectErrorMapToErrorMap", () => {
 
 describe("effectBuilder with EffectErrorMap", () => {
   const runtime = ManagedRuntime.make(Layer.empty);
-  const effectOs = makeEffectORPC(runtime);
+  const effectProcedure = makeEffectORPC(runtime);
 
   it("should support errors() with traditional format", () => {
-    const builder = effectOs.errors({
+    const builder = effectProcedure.errors({
       BAD_REQUEST: { status: 400, message: "Bad request" },
     });
 
@@ -206,7 +206,7 @@ describe("effectBuilder with EffectErrorMap", () => {
   });
 
   it("should support errors() with tagged error classes", () => {
-    const builder = effectOs.errors({
+    const builder = effectProcedure.errors({
       USER_NOT_FOUND_ERROR: UserNotFoundError,
       FORBIDDEN: PermissionDenied,
     });
@@ -218,7 +218,7 @@ describe("effectBuilder with EffectErrorMap", () => {
   });
 
   it("should support mixed error format", () => {
-    const builder = effectOs.errors({
+    const builder = effectProcedure.errors({
       BAD_REQUEST: { status: 400 },
       USER_NOT_FOUND_ERROR: UserNotFoundError,
     });
@@ -232,7 +232,7 @@ describe("effectBuilder with EffectErrorMap", () => {
   });
 
   it("should merge errors correctly", () => {
-    const builder = effectOs
+    const builder = effectProcedure
       .errors({ BAD_REQUEST: { status: 400 } })
       .errors({ USER_NOT_FOUND_ERROR: UserNotFoundError })
       .errors({ FORBIDDEN: PermissionDenied });
@@ -245,7 +245,7 @@ describe("effectBuilder with EffectErrorMap", () => {
   });
 
   it("should create procedure with effect handler", async () => {
-    const procedure = effectOs
+    const procedure = effectProcedure
       .errors({
         USER_NOT_FOUND_ERROR: UserNotFoundError,
         BAD_REQUEST: { status: 400 },
@@ -267,7 +267,7 @@ describe("effectBuilder with EffectErrorMap", () => {
   });
 
   it("should allow throwing tagged errors in effect handler", async () => {
-    const procedure = effectOs
+    const procedure = effectProcedure
       .errors({
         USER_NOT_FOUND_ERROR: UserNotFoundError,
       })
@@ -310,10 +310,10 @@ describe("effectBuilder with EffectErrorMap", () => {
 
 describe("effectDecoratedProcedure.errors()", () => {
   const runtime = ManagedRuntime.make(Layer.empty);
-  const effectOs = makeEffectORPC(runtime);
+  const effectProcedure = makeEffectORPC(runtime);
 
   it("should support adding errors to procedure", () => {
-    const procedure = effectOs
+    const procedure = effectProcedure
       .input(z.object({ id: z.string() }))
       .effect(function* ({ input }) {
         return { id: input.id };
@@ -326,7 +326,7 @@ describe("effectDecoratedProcedure.errors()", () => {
   });
 
   it("should merge errors on procedure", () => {
-    const procedure = effectOs
+    const procedure = effectProcedure
       .errors({ BAD_REQUEST: { status: 400 } })
       .input(z.object({ id: z.string() }))
       .effect(function* ({ input }) {

package/src/tests/effect-procedure.test.ts

@@ -4,6 +4,7 @@ import { beforeEach, describe, expect, it, vi } from "vitest";
 import z from "zod";
 
 import { EffectDecoratedProcedure } from "../effect-procedure";
+import { makeEffectRuntimeRunner } from "../runtime-source";
 import {
   baseErrorMap,
   baseMeta,
@@ -25,6 +26,7 @@ vi.mock("@orpc/server", async (importOriginal) => {
 });
 
 const runtime = ManagedRuntime.make(Layer.empty);
+const runner = makeEffectRuntimeRunner(runtime);
 
 const handler = vi.fn();
 const middleware = vi.fn();
@@ -40,6 +42,7 @@ const def = {
   meta: baseMeta,
   route: baseRoute,
   handler,
+  runner,
   runtime,
 };
 
@@ -80,7 +83,7 @@ describe("effectDecoratedProcedure", () => {
     });
 
     // Preserves runtime
-    expect(applied["~effect"].runtime).toBe(runtime);
+    expect(applied["~effect"].runner.runtime).toBe(runtime);
   });
 
   it(".meta", () => {
@@ -96,7 +99,7 @@ describe("effectDecoratedProcedure", () => {
     });
 
     // Preserves runtime
-    expect(applied["~effect"].runtime).toBe(runtime);
+    expect(applied["~effect"].runner.runtime).toBe(runtime);
   });
 
   it(".route", () => {
@@ -112,7 +115,7 @@ describe("effectDecoratedProcedure", () => {
     });
 
     // Preserves runtime
-    expect(applied["~effect"].runtime).toBe(runtime);
+    expect(applied["~effect"].runner.runtime).toBe(runtime);
   });
 
   describe(".use", () => {
@@ -129,7 +132,7 @@ describe("effectDecoratedProcedure", () => {
       });
 
       // Preserves runtime
-      expect(applied["~effect"].runtime).toBe(runtime);
+      expect(applied["~effect"].runner.runtime).toBe(runtime);
     });
 
     it("with map input", () => {
@@ -146,7 +149,7 @@ describe("effectDecoratedProcedure", () => {
       });
 
       // Preserves runtime
-      expect(applied["~effect"].runtime).toBe(runtime);
+      expect(applied["~effect"].runner.runtime).toBe(runtime);
     });
   });
 
@@ -207,7 +210,7 @@ describe("effectDecoratedProcedure chaining", () => {
       .route({ path: "/custom" });
 
     expect(applied).toBeInstanceOf(EffectDecoratedProcedure);
-    expect(applied["~effect"].runtime).toBe(runtime);
+    expect(applied["~effect"].runner.runtime).toBe(runtime);
     expect(applied["~effect"].errorMap).toHaveProperty("CUSTOM");
   });
 });

package/src/types/effect-builder-surface.ts

@@ -474,7 +474,7 @@ export interface EffectBuilderSurface<
   >;
   /**
    * Defines the handler of the procedure using an Effect.
-   * The Effect is executed using the ManagedRuntime provided during builder creation.
+   * The Effect is executed using the configured Effect runtime source.
    * The effect is automatically wrapped with `Effect.withSpan`.
    *
    * @see {@link https://orpc.dev/docs/procedure Procedure Docs}

package/src/types/index.ts

@@ -24,15 +24,10 @@ import type {
   RouterBuilder,
 } from "@orpc/server";
 import type { MaybeOptionalOptions } from "@orpc/shared";
-import type {
-  Context as EffectContext,
-  Effect,
-  Layer,
-  ManagedRuntime,
-  Option,
-} from "effect";
+import type { Context as EffectContext, Effect, Layer, Option } from "effect";
 import type { YieldWrap } from "effect/Utils";
 
+import type { EffectRuntimeRunner } from "../runtime-source";
 import type {
   EffectErrorConstructorMap,
   EffectErrorMap,
@@ -54,7 +49,7 @@ type EffectBuilderDefBase<
   >;
 
 /**
- * Extended builder definition that includes the Effect ManagedRuntime.
+ * Extended builder definition that includes Effect execution state.
  */
 export interface EffectBuilderDef<
   TInputSchema extends AnySchema,
@@ -69,7 +64,7 @@ export interface EffectBuilderDef<
   TEffectErrorMap,
   TMeta
 > {
-  runtime: ManagedRuntime.ManagedRuntime<TRequirementsProvided, TRuntimeError>;
+  runner: EffectRuntimeRunner<TRequirementsProvided, TRuntimeError>;
   /**
    * Optional span configuration for Effect tracing.
    */
@@ -83,7 +78,7 @@ export interface EffectBuilderDef<
 }
 
 /**
- * Extended procedure definition that includes the Effect ManagedRuntime.
+ * Extended procedure definition that includes Effect execution state.
  */
 export interface EffectProcedureDef<
   TInitialContext extends Context,
@@ -102,7 +97,7 @@ export interface EffectProcedureDef<
   EffectErrorMapToErrorMap<TEffectErrorMap>,
   TMeta
 > {
-  runtime: ManagedRuntime.ManagedRuntime<TRequirementsProvided, TRuntimeError>;
+  runner: EffectRuntimeRunner<TRequirementsProvided, TRuntimeError>;
   effectErrorMap: TEffectErrorMap;
   effectSteps?: readonly EffectPipelineStep[];
   effectHandler?: EffectProcedureHandlerConfig;

package/src/types/variants.ts

@@ -294,7 +294,7 @@ export interface EffectBuilderWithMiddlewares<
 
   /**
    * Defines the handler of the procedure using an Effect.
-   * The Effect is executed using the ManagedRuntime provided during builder creation.
+   * The Effect is executed using the configured Effect runtime source.
    * The effect is automatically wrapped with `Effect.withSpan`.
    *
    * @see {@link https://orpc.dev/docs/procedure Procedure Docs}
@@ -648,7 +648,7 @@ export interface EffectProcedureBuilder<
 
   /**
    * Defines the handler of the procedure using an Effect.
-   * The Effect is executed using the ManagedRuntime provided during builder creation.
+   * The Effect is executed using the configured Effect runtime source.
    * The effect is automatically wrapped with `Effect.withSpan`.
    *
    * @see {@link https://orpc.dev/docs/procedure Procedure Docs}
@@ -958,7 +958,7 @@ export interface EffectProcedureBuilderWithInput<
 
   /**
    * Defines the handler of the procedure using an Effect.
-   * The Effect is executed using the ManagedRuntime provided during builder creation.
+   * The Effect is executed using the configured Effect runtime source.
    * The effect is automatically wrapped with `Effect.withSpan`.
    *
    * @see {@link https://orpc.dev/docs/procedure Procedure Docs}
@@ -1234,7 +1234,7 @@ export interface EffectProcedureBuilderWithOutput<
 
   /**
    * Defines the handler of the procedure using an Effect.
-   * The Effect is executed using the ManagedRuntime provided during builder creation.
+   * The Effect is executed using the configured Effect runtime source.
    * The effect is automatically wrapped with `Effect.withSpan`.
    *
    * @see {@link https://orpc.dev/docs/procedure Procedure Docs}
@@ -1526,7 +1526,7 @@ export interface EffectProcedureBuilderWithInputOutput<
 
   /**
    * Defines the handler of the procedure using an Effect.
-   * The Effect is executed using the ManagedRuntime provided during builder creation.
+   * The Effect is executed using the configured Effect runtime source.
    * The effect is automatically wrapped with `Effect.withSpan`.
    *
    * @see {@link https://orpc.dev/docs/procedure Procedure Docs}