effect-orpc 0.2.2 → 0.3.0

package/src/effect-runtime.ts

@@ -1,21 +1,38 @@
-import { ORPCError } from "@orpc/contract";
+import { ORPCError, type Meta } from "@orpc/contract";
 import type {
   Context,
+  Middleware,
+  MiddlewareNextFnOptions,
+  MiddlewareOutputFn,
+  MiddlewareResult,
   ProcedureHandler,
   ProcedureHandlerOptions,
 } from "@orpc/server";
+import type { Promisable } from "@orpc/shared";
 import type { ManagedRuntime } from "effect";
-import { Cause, Effect, Exit, FiberRefs } from "effect";
+import { Cause, Effect, Exit, FiberRefs, Option } from "effect";
 
-import { getCurrentFiberRefs } from "./fiber-context-bridge";
+import { getCurrentFiberRefs, runWithFiberRefs } from "./fiber-context-bridge";
 import type { EffectErrorConstructorMap, EffectErrorMap } from "./tagged-error";
 import {
   createEffectErrorConstructorMap,
   isORPCTaggedError,
 } from "./tagged-error";
-import type { EffectProcedureHandler, EffectSpanConfig } from "./types";
+import type {
+  EffectMiddleware,
+  EffectMiddlewareOptions,
+  EffectMiddlewareOutput,
+  EffectMiddlewareResult,
+  EffectOptionalProvider,
+  EffectPipelineStep,
+  EffectProcedureHandler,
+  EffectProvider,
+  EffectSpanConfig,
+} from "./types";
+
+type EffectTag = import("effect").Context.Tag<any, any>;
 
-export function toORPCErrorFromCause(
+function toORPCErrorFromCause(
   cause: Cause.Cause<unknown>,
 ): ORPCError<string, unknown> {
   return Cause.match(cause, {
@@ -59,7 +76,7 @@ export function createEffectProcedureHandler<
   TEffectErrorMap extends EffectErrorMap,
   TRequirementsProvided,
   TRuntimeError,
-  TMeta,
+  TMeta extends Meta,
 >(options: {
   runtime: ManagedRuntime.ManagedRuntime<TRequirementsProvided, TRuntimeError>;
   effectErrorMap: TEffectErrorMap;
@@ -71,6 +88,7 @@ export function createEffectProcedureHandler<
     TRequirementsProvided,
     any
   >;
+  effectSteps?: readonly EffectPipelineStep[];
   spanConfig?: EffectSpanConfig;
   defaultCaptureStackTrace: () => string | undefined;
 }): ProcedureHandler<
@@ -84,6 +102,7 @@ export function createEffectProcedureHandler<
     runtime,
     effectErrorMap,
     effectFn,
+    effectSteps = [],
     spanConfig,
     defaultCaptureStackTrace,
   } = options;
@@ -108,27 +127,440 @@ export function createEffectProcedureHandler<
     const captureStackTrace =
       spanConfig?.captureStackTrace ?? defaultCaptureStackTrace;
     const resolver = Effect.fnUntraced(effectFn as any);
-    const tracedEffect = Effect.withSpan(resolver(effectOpts), spanName, {
-      captureStackTrace,
+    const handlerEffect = resolver(effectOpts);
+    const tracedEffect = Effect.withSpan(
+      runEffectPipeline({
+        baseOptions: effectOpts,
+        effectErrorMap,
+        final: (context) =>
+          Effect.map(
+            context === effectOpts.context
+              ? handlerEffect
+              : resolver({ ...effectOpts, context }),
+            (output) => ({ output, context: {} }),
+          ),
+        input: opts.input,
+        steps: effectSteps,
+      }),
+      spanName,
+      { captureStackTrace },
+    );
+    const exit = await runtime.runPromiseExit(
+      withParentFiberRefs(tracedEffect),
+      { signal: opts.signal },
+    );
+
+    if (Exit.isFailure(exit)) {
+      throw toORPCErrorFromCause(exit.cause);
+    }
+
+    return exit.value.output as TOutput;
+  };
+}
+
+export function createEffectPipelineMiddleware<
+  TCurrentContext extends Context,
+  TOutput,
+  TEffectErrorMap extends EffectErrorMap,
+  TRequirementsProvided,
+  TRuntimeError,
+  TMeta extends Meta,
+>(options: {
+  runtime: ManagedRuntime.ManagedRuntime<TRequirementsProvided, TRuntimeError>;
+  effectErrorMap: TEffectErrorMap;
+  steps: readonly EffectPipelineStep[];
+}): Middleware<
+  TCurrentContext,
+  Record<never, never>,
+  unknown,
+  TOutput,
+  any,
+  TMeta
+> {
+  const { runtime, effectErrorMap, steps } = options;
+
+  return async (opts, input) => {
+    const baseOptions = makeEffectOptions<
+      TCurrentContext,
+      unknown,
+      TEffectErrorMap,
+      TMeta
+    >(opts, input, effectErrorMap);
+    const effect = runEffectPipeline({
+      baseOptions,
+      effectErrorMap,
+      final: (context) =>
+        withCurrentFiberContext(() =>
+          opts.next(
+            context === opts.context
+              ? undefined
+              : { context: context as Record<PropertyKey, unknown> },
+          ),
+        ) as any,
+      input,
+      steps,
     });
-    const parentFiberRefs = getCurrentFiberRefs();
-    const effectWithRefs = parentFiberRefs
-      ? Effect.fiberIdWith((fiberId) =>
-          Effect.flatMap(Effect.getFiberRefs, (fiberRefs) =>
-            Effect.setFiberRefs(
-              FiberRefs.joinAs(fiberRefs, fiberId, parentFiberRefs),
-            ).pipe(Effect.andThen(tracedEffect)),
+    const exit = await runtime.runPromiseExit(
+      withParentFiberRefs(effect as any),
+      { signal: opts.signal },
+    );
+
+    if (Exit.isFailure(exit)) throw toORPCErrorFromCause(exit.cause);
+
+    return exit.value as MiddlewareResult<Record<never, never>, TOutput>;
+  };
+}
+
+export function createEffectProviderMiddleware<
+  TCurrentContext extends Context,
+  TInput,
+  TEffectErrorMap extends EffectErrorMap,
+  TRequirementsProvided,
+  TRuntimeError,
+  TMeta extends Meta,
+  TTag extends EffectTag,
+>(options: {
+  runtime: ManagedRuntime.ManagedRuntime<TRequirementsProvided, TRuntimeError>;
+  effectErrorMap: TEffectErrorMap;
+  tag: TTag;
+  provider: EffectProvider<
+    TCurrentContext,
+    TInput,
+    TEffectErrorMap,
+    TRequirementsProvided,
+    TMeta,
+    TTag
+  >;
+}): Middleware<TCurrentContext, Record<never, never>, TInput, any, any, TMeta> {
+  const { runtime, effectErrorMap, tag, provider } = options;
+
+  return async (opts, input) => {
+    const effectOpts = makeEffectOptions<
+      TCurrentContext,
+      TInput,
+      TEffectErrorMap,
+      TMeta
+    >(opts, input, effectErrorMap);
+    const effect = Effect.flatMap(provider(effectOpts), (service) =>
+      Effect.provideService(
+        withCurrentFiberContext(() => opts.next()),
+        tag,
+        service,
+      ),
+    );
+    const exit = await runtime.runPromiseExit(withParentFiberRefs(effect), {
+      signal: opts.signal,
+    });
+
+    if (Exit.isFailure(exit)) throw toORPCErrorFromCause(exit.cause);
+
+    return exit.value;
+  };
+}
+
+export function createEffectOptionalProviderMiddleware<
+  TCurrentContext extends Context,
+  TInput,
+  TEffectErrorMap extends EffectErrorMap,
+  TRequirementsProvided,
+  TRuntimeError,
+  TMeta extends Meta,
+  TTag extends EffectTag,
+>(options: {
+  runtime: ManagedRuntime.ManagedRuntime<TRequirementsProvided, TRuntimeError>;
+  effectErrorMap: TEffectErrorMap;
+  tag: TTag;
+  provider: EffectOptionalProvider<
+    TCurrentContext,
+    TInput,
+    TEffectErrorMap,
+    TRequirementsProvided,
+    TMeta,
+    TTag
+  >;
+}): Middleware<TCurrentContext, Record<never, never>, TInput, any, any, TMeta> {
+  const { runtime, effectErrorMap, tag, provider } = options;
+
+  return async (opts, input) => {
+    const effectOpts = makeEffectOptions<
+      TCurrentContext,
+      TInput,
+      TEffectErrorMap,
+      TMeta
+    >(opts, input, effectErrorMap);
+    const effect = Effect.flatMap(provider(effectOpts), (service) =>
+      Option.match(service, {
+        onNone: () => withCurrentFiberContext(() => opts.next()),
+        onSome: (value) =>
+          Effect.provideService(
+            withCurrentFiberContext(() => opts.next()),
+            tag,
+            value,
           ),
-        )
-      : tracedEffect;
-    const exit = await runtime.runPromiseExit(effectWithRefs, {
+      }),
+    );
+    const exit = await runtime.runPromiseExit(withParentFiberRefs(effect), {
       signal: opts.signal,
     });
 
-    if (Exit.isFailure(exit)) {
-      throw toORPCErrorFromCause(exit.cause);
+    if (Exit.isFailure(exit)) throw toORPCErrorFromCause(exit.cause);
+
+    return exit.value;
+  };
+}
+
+// todo(utopy): make this check more comprehensive, maybe add a Symbol to the EffectMiddleware type
+export function isEffectMiddleware(
+  value: unknown,
+): value is EffectMiddleware<
+  Context,
+  Context,
+  unknown,
+  unknown,
+  EffectErrorMap,
+  unknown,
+  Meta
+> {
+  return (
+    typeof value === "function" &&
+    value.constructor?.name === "GeneratorFunction"
+  );
+}
+
+function makeEffectOptions<
+  TCurrentContext extends Context,
+  TInput,
+  TEffectErrorMap extends EffectErrorMap,
+  TMeta extends Meta,
+>(
+  opts: Parameters<
+    Middleware<TCurrentContext, any, TInput, any, any, TMeta>
+  >[0],
+  input: TInput,
+  effectErrorMap: TEffectErrorMap,
+): ProcedureHandlerOptions<
+  TCurrentContext,
+  TInput,
+  EffectErrorConstructorMap<TEffectErrorMap>,
+  TMeta & Record<never, never>
+> {
+  return {
+    context: opts.context,
+    input,
+    path: opts.path,
+    procedure: opts.procedure as any,
+    signal: opts.signal,
+    lastEventId: opts.lastEventId,
+    errors: createEffectErrorConstructorMap(effectErrorMap),
+  };
+}
+
+function runEffectPipeline<
+  TCurrentContext extends Context,
+  TInput,
+  TOutput,
+  TEffectErrorMap extends EffectErrorMap,
+  TRequirementsProvided,
+  TMeta extends Meta,
+>(options: {
+  baseOptions: ProcedureHandlerOptions<
+    TCurrentContext,
+    TInput,
+    EffectErrorConstructorMap<TEffectErrorMap>,
+    TMeta
+  >;
+  effectErrorMap: TEffectErrorMap;
+  final: (
+    context: TCurrentContext,
+  ) => Effect.Effect<
+    EffectMiddlewareResult<Record<never, never>, TOutput>,
+    unknown,
+    TRequirementsProvided
+  >;
+  input: TInput;
+  steps: readonly EffectPipelineStep[];
+}): Effect.Effect<
+  EffectMiddlewareResult<Context, TOutput>,
+  unknown,
+  TRequirementsProvided
+> {
+  const run = (
+    index: number,
+    context: TCurrentContext,
+  ): Effect.Effect<
+    EffectMiddlewareResult<Context, TOutput>,
+    unknown,
+    TRequirementsProvided
+  > => {
+    const step = options.steps[index];
+    if (!step) return options.final(context);
+
+    const stepOptions = { ...options.baseOptions, context };
+
+    if (step._tag === "provide") {
+      return Effect.flatMap(step.provider(stepOptions as any), (service) =>
+        Effect.provideService(run(index + 1, context), step.tag, service),
+      );
+    }
+
+    if (step._tag === "provideOptional") {
+      return Effect.flatMap(step.provider(stepOptions as any), (service) =>
+        Option.match(service, {
+          onNone: () => run(index + 1, context),
+          onSome: (value) =>
+            Effect.provideService(run(index + 1, context), step.tag, value),
+        }),
+      );
+    }
+
+    if (step._tag === "provideLayer") {
+      return Effect.provide(run(index + 1, context), step.layer);
     }
 
-    return exit.value as TOutput;
+    const nextTracker =
+      createMiddlewareNextTracker<EffectMiddlewareResult<Context, TOutput>>();
+    const effectOptions: EffectMiddlewareOptions<
+      TCurrentContext,
+      TOutput,
+      TEffectErrorMap,
+      TRequirementsProvided,
+      TMeta
+    > = {
+      context,
+      path: stepOptions.path,
+      procedure: stepOptions.procedure,
+      signal: stepOptions.signal,
+      lastEventId: stepOptions.lastEventId,
+      errors: createEffectErrorConstructorMap(options.effectErrorMap),
+      next: nextTracker.wrapNext(
+        (...rest: [MiddlewareNextFnOptions<Context>?]) => {
+          const nextContext = rest[0]?.context ?? {};
+          return Effect.map(
+            run(index + 1, { ...context, ...nextContext }),
+            (result) => ({
+              output: result.output,
+              context: nextContext,
+            }),
+          ) as Effect.Effect<EffectMiddlewareResult<Context, TOutput>>;
+        },
+      ),
+    };
+    const effectOutput = makeEffectMiddlewareOutput<
+      TOutput,
+      TEffectErrorMap,
+      TRequirementsProvided
+    >((output) => ({ output, context: {} }));
+    const middlewareEffect = Effect.fnUntraced(step.middleware)(
+      effectOptions,
+      options.input,
+      effectOutput,
+    ) as Effect.Effect<EffectMiddlewareResult<Context, TOutput> | void>;
+
+    return Effect.flatMap(middlewareEffect, (result) =>
+      resolveEffectMiddlewareContinuation({
+        autoNext: () => effectOptions.next(),
+        nextInvoked: nextTracker.nextInvoked,
+        nextResult: nextTracker.nextResult,
+        result,
+      }),
+    );
+  };
+
+  return run(0, options.baseOptions.context);
+}
+
+function createMiddlewareNextTracker<T>() {
+  let nextInvoked = false;
+  let nextResult: T | undefined;
+
+  return {
+    get nextInvoked() {
+      return nextInvoked;
+    },
+    get nextResult() {
+      return nextResult;
+    },
+    wrapNext<Fn extends (...args: any) => Effect.Effect<T, any, any>>(
+      nextFn: Fn,
+    ): Fn {
+      return ((...args: Parameters<Fn>) => {
+        nextInvoked = true;
+        return Effect.map(nextFn(...args), (result) => {
+          nextResult = result;
+          return result;
+        });
+      }) as Fn;
+    },
   };
 }
+
+function resolveEffectMiddlewareContinuation<
+  TContext extends Context,
+  TOutput,
+  TRequirementsProvided,
+>(options: {
+  result: EffectMiddlewareResult<TContext, TOutput> | void;
+  nextInvoked: boolean;
+  nextResult: EffectMiddlewareResult<TContext, TOutput> | undefined;
+  autoNext: () => Effect.Effect<
+    EffectMiddlewareResult<TContext, TOutput>,
+    unknown,
+    TRequirementsProvided
+  >;
+}): Effect.Effect<
+  EffectMiddlewareResult<TContext, TOutput>,
+  unknown,
+  TRequirementsProvided
+> {
+  const { result, nextInvoked, nextResult, autoNext } = options;
+
+  if (result !== undefined) {
+    return Effect.succeed(result);
+  }
+
+  if (nextInvoked) {
+    if (nextResult === undefined) {
+      return Effect.die(
+        new Error(
+          "Effect middleware invoked next() but did not return its result",
+        ),
+      );
+    }
+    return Effect.succeed(nextResult);
+  }
+
+  return autoNext();
+}
+
+function makeEffectMiddlewareOutput<
+  TOutput,
+  TEffectErrorMap extends EffectErrorMap,
+  TRequirementsProvided,
+>(
+  output: MiddlewareOutputFn<TOutput>,
+): EffectMiddlewareOutput<TOutput, TEffectErrorMap, TRequirementsProvided> {
+  return (value: TOutput) => withCurrentFiberContext(() => output(value));
+}
+
+function withCurrentFiberContext<T>(fn: () => Promisable<T>): Effect.Effect<T> {
+  return Effect.flatMap(Effect.getFiberRefs, (fiberRefs) =>
+    Effect.promise(() =>
+      runWithFiberRefs(fiberRefs, () => Promise.resolve(fn())),
+    ),
+  );
+}
+
+function withParentFiberRefs<A, E, R>(
+  effect: Effect.Effect<A, E, R>,
+): Effect.Effect<A, E, R> {
+  const parentFiberRefs = getCurrentFiberRefs();
+  return parentFiberRefs
+    ? Effect.fiberIdWith((fiberId) =>
+        Effect.flatMap(Effect.getFiberRefs, (fiberRefs) =>
+          Effect.setFiberRefs(
+            FiberRefs.joinAs(fiberRefs, fiberId, parentFiberRefs),
+          ).pipe(Effect.andThen(effect)),
+        ),
+      )
+    : effect;
+}

package/src/extension/create-node-proxy.ts

@@ -43,6 +43,12 @@ interface NodeProxyInternalConfig<
     result: unknown,
     receiver: unknown,
   ) => unknown;
+  wrapArgs?: (
+    context: NodeProxyContext<TTarget, TSource>,
+    prop: PropertyKey,
+    args: unknown[],
+    receiver: unknown,
+  ) => unknown[];
 }
 
 /**
@@ -93,6 +99,15 @@ export interface NodeProxyConfig<
     result: unknown,
     receiver: unknown,
   ) => unknown;
+  /**
+   * Rewrites arguments before forwarding upstream methods.
+   */
+  wrapArgs?: (
+    context: NodeProxyContext<TTarget, TSource>,
+    prop: PropertyKey,
+    args: unknown[],
+    receiver: unknown,
+  ) => unknown[];
 }
 
 function createNodeProxyContext<
@@ -124,7 +139,8 @@ function createBoundMethod<
   }
 
   const wrapped = (...args: unknown[]) => {
-    const result = Reflect.apply(value, context.upstream, args);
+    const nextArgs = config.wrapArgs?.(context, prop, args, receiver) ?? args;
+    const result = Reflect.apply(value, context.upstream, nextArgs);
     return config.wrapResult?.(context, prop, result, receiver) ?? result;
   };
 

package/src/extension/state.ts

@@ -1,7 +1,11 @@
 import type { ManagedRuntime } from "effect";
 
 import type { EffectErrorMap } from "../tagged-error";
-import type { EffectSpanConfig } from "../types";
+import type {
+  EffectPipelineStep,
+  EffectProcedureHandlerConfig,
+  EffectSpanConfig,
+} from "../types";
 
 export interface EffectExtensionState<
   TRequirementsProvided = any,
@@ -22,6 +26,12 @@ export interface EffectExtensionState<
    * @see {@link EffectSpanConfig}
    */
   spanConfig?: EffectSpanConfig;
+  /**
+   * Pending Effect-native provider / middleware steps that have not been flushed
+   * into the oRPC middleware chain.
+   */
+  effectSteps?: readonly EffectPipelineStep[];
+  effectHandler?: EffectProcedureHandlerConfig;
 }
 
 export interface EffectInternals<TUpstream extends object = object> {
@@ -62,25 +72,13 @@ export function getEffectInternals<TUpstream extends object>(
   return target[effectInternalsSymbol];
 }
 
-export function getEffectUpstream<TUpstream extends object>(
+function getEffectUpstream<TUpstream extends object>(
   target: EffectProxyTarget<TUpstream>,
 ): TUpstream {
   return getEffectInternals(target).upstream;
 }
 
-export function getEffectState(
-  target: EffectProxyTarget,
-): EffectExtensionState {
-  return getEffectInternals(target).state;
-}
-
-export function getEffectMethodCache(
-  target: EffectProxyTarget,
-): Map<PropertyKey, unknown> {
-  return getEffectInternals(target).methodCache;
-}
-
-export function hasEffectState(value: unknown): value is EffectProxyTarget {
+function hasEffectState(value: unknown): value is EffectProxyTarget {
   return (
     typeof value === "object" &&
     value !== null &&

package/src/fiber-context-bridge.ts

@@ -2,6 +2,10 @@ import type { FiberRefs } from "effect";
 
 export interface FiberContextBridge {
   readonly getCurrentFiberRefs: () => FiberRefs.FiberRefs | undefined;
+  readonly runWithFiberRefs?: <T>(
+    fiberRefs: FiberRefs.FiberRefs,
+    fn: () => Promise<T>,
+  ) => Promise<T>;
 }
 
 let bridge: FiberContextBridge | undefined;
@@ -15,3 +19,12 @@ export function installFiberContextBridge(
 export function getCurrentFiberRefs(): FiberRefs.FiberRefs | undefined {
   return bridge?.getCurrentFiberRefs();
 }
+
+export function runWithFiberRefs<T>(
+  fiberRefs: FiberRefs.FiberRefs,
+  fn: () => Promise<T>,
+): Promise<T> {
+  return bridge?.runWithFiberRefs
+    ? bridge.runWithFiberRefs(fiberRefs, fn)
+    : fn();
+}

package/src/node.ts

@@ -12,12 +12,13 @@ const fiberRefsStorage = new AsyncLocalStorage<FiberRefs.FiberRefs>();
 
 const bridge: FiberContextBridge = {
   getCurrentFiberRefs: () => fiberRefsStorage.getStore(),
+  runWithFiberRefs: (fiberRefs, fn) => fiberRefsStorage.run(fiberRefs, fn),
 };
 
 installFiberContextBridge(bridge);
 
 export function withFiberContext<T>(fn: () => Promise<T>): Effect.Effect<T> {
   return Effect.flatMap(Effect.getFiberRefs, (fiberRefs) =>
-    Effect.promise(() => fiberRefsStorage.run(fiberRefs, fn)),
+    Effect.promise(() => bridge.runWithFiberRefs!(fiberRefs, fn)),
   );
 }

package/src/runtime-source.ts

@@ -0,0 +1,18 @@
+import { Layer, ManagedRuntime } from "effect";
+
+export type EffectRuntimeSource<TRequirementsProvided, TRuntimeError> =
+  | ManagedRuntime.ManagedRuntime<TRequirementsProvided, TRuntimeError>
+  | Layer.Layer<TRequirementsProvided, TRuntimeError, never>;
+
+export function toManagedRuntime<TRequirementsProvided, TRuntimeError>(
+  source: EffectRuntimeSource<TRequirementsProvided, TRuntimeError>,
+): ManagedRuntime.ManagedRuntime<TRequirementsProvided, TRuntimeError> {
+  return ManagedRuntime.isManagedRuntime(source)
+    ? (source as ManagedRuntime.ManagedRuntime<
+        TRequirementsProvided,
+        TRuntimeError
+      >)
+    : ManagedRuntime.make(
+        source as Layer.Layer<TRequirementsProvided, TRuntimeError, never>,
+      );
+}

package/src/tagged-error.ts

@@ -371,15 +371,6 @@ export type EffectErrorMapItem =
   | ErrorMapItem<AnySchema>
   | AnyORPCTaggedErrorClass;
 
-export type ORPCTaggedErrorClassToErrorMapItem<T> =
-  T extends ORPCTaggedErrorClass<any, any, infer TData>
-    ? {
-        status?: number;
-        message?: string;
-        data?: TData;
-      }
-    : never;
-
 /**
  * Extended error map that supports both traditional oRPC errors and ORPCTaggedError classes.
  *