@gaganref/confect-server 10.3.1-fork.6 → 10.3.1-fork.60

package/src/HttpRouter.ts

@@ -24,6 +24,8 @@ import type * as HttpApiGroup from "effect/http-api/HttpApiGroup";
 import type * as Etag from "effect/http/Etag";
 import type * as HttpPlatform from "effect/http/HttpPlatform";
 import * as HttpRouter from "effect/http/HttpRouter";
+import * as HttpMiddleware from "effect/http/HttpMiddleware";
+import type * as HttpServerRequest from "effect/http/HttpServerRequest";
 import * as HttpServer from "effect/http/HttpServer";
 import type * as ActionRunner from "./ActionRunner.js";
 import type * as Auth from "./Auth.js";
@@ -33,6 +35,7 @@ import type * as DatabaseSchema from "./DatabaseSchema.js";
 import type * as DataModel from "./DataModel.js";
 import type * as Handler from "./Handler.js";
 import * as ConvexConfigProvider from "./ConvexConfigProvider.js";
+import * as ObservabilityRuntime from "./internal/observability.js";
 import * as ConvexLogger from "./ConvexLogger.js";
 import type * as MutationRunner from "./MutationRunner.js";
 import type * as QueryRunner from "./QueryRunner.js";
@@ -116,9 +119,17 @@ export type Routes<Services_ = Services> = Layer.Layer<
  */
 export const make = <Id extends string, Groups extends HttpApiGroup.Constraint>(
   routes: Routes,
-  options?: { readonly api?: HttpApi.HttpApi<Id, Groups> | undefined },
+  options?: {
+    readonly observability?: Layer.Layer<never> | undefined;
+    readonly api?: HttpApi.HttpApi<Id, Groups> | undefined;
+  },
 ): ConvexHttpRouter =>
-  makeWithLayer(routes, RegisteredFunction.baseActionLayer, options?.api);
+  makeWithLayer(
+    routes,
+    RegisteredFunction.baseActionLayer,
+    options?.api,
+    options?.observability,
+  );
 
 /**
  * Derive HTTP capabilities and ID scopes from the generated database schema.
@@ -131,7 +142,10 @@ export const forSchema =
   ) =>
   <Id extends string, Groups extends HttpApiGroup.Constraint>(
     routes: Routes<Handler.ActionServices<DatabaseSchema_>>,
-    options?: { readonly api?: HttpApi.HttpApi<Id, Groups> | undefined },
+    options?: {
+      readonly observability?: Layer.Layer<never> | undefined;
+      readonly api?: HttpApi.HttpApi<Id, Groups> | undefined;
+    },
   ): ConvexHttpRouter =>
     makeWithLayer<
       Handler.ActionServices<DatabaseSchema_>,
@@ -148,6 +162,8 @@ export const forSchema =
       ),
       (ctx) => RegisteredFunction.actionLayer(schema, ctx),
       options?.api,
+      options?.observability,
+      schema.target.kind === "component",
     );
 
 // Convex uses a component-relative path to select its HTTP action but passes
@@ -175,15 +191,38 @@ const makeWithLayer = <
   routes: Routes<Services_>,
   layer: (ctx: GenericActionCtx<DataModel_>) => Layer.Layer<Services_>,
   api: HttpApi.HttpApi<Id, Groups> | undefined,
+  observability?: Layer.Layer<never>,
+  siteRelative = false,
 ): ConvexHttpRouter => {
   applyMonkeyPatches();
 
+  const spanName = Layer.effect(
+    HttpMiddleware.SpanNameGenerator,
+    Effect.gen(function* () {
+      const prefix = siteRelative
+        ? (yield* Config.schema(
+            Schema.URLFromString,
+            "CONVEX_SITE_URL",
+          )).pathname.replace(/\/$/, "")
+        : "";
+      return (request: HttpServerRequest.HttpServerRequest) =>
+        convexHttpRouter.lookup(
+          new URL(request.originalUrl).pathname.slice(prefix.length) || "/",
+          request.method as (typeof ROUTABLE_HTTP_METHODS)[number],
+        )?.[2] ?? "/*";
+    }).pipe(Effect.orDie),
+  );
+
   // Provided (not just merged) so that route layers' own construction—e.g.
   // a `Layer.unwrap` reading `Config`—resolves configuration through the
   // Convex-aware provider; merged so that request fibers—endpoint handlers
   // and middleware—do too.
   const AppLayer = routes.pipe(
-    Layer.provideMerge(ConvexLogger.layer),
+    Layer.provideMerge(
+      observability === undefined
+        ? ConvexLogger.layer
+        : Layer.merge(ObservabilityRuntime.memoized(observability), spanName),
+    ),
     Layer.provideMerge(ConvexConfigProvider.layer),
     Layer.provide(HttpServer.layerServices),
   );
@@ -193,6 +232,17 @@ const makeWithLayer = <
   // exposes as a per-request context argument.
   const { handler } = HttpRouter.toWebHandler(AppLayer, {
     disableLogger: true,
+    /* oxlint-disable effecttsgo/any-unknown-in-error-context -- Keep Effect's erased HTTP boundary errors intact. */
+    ...(observability === undefined
+      ? {}
+      : {
+          middleware: (effect) =>
+            Effect.andThen(
+              Effect.annotateCurrentSpan("kind", "httpAction"),
+              effect,
+            ),
+        }),
+    /* oxlint-enable effecttsgo/any-unknown-in-error-context */
   });
 
   const httpAction = httpActionGeneric((ctx, request): Promise<Response> => {

package/src/MutationRunner.ts

@@ -1,4 +1,5 @@
-import * as Ref from "@confect/core/Ref";
+import * as ReservedArgument from "./internal/reservedArgument.js";
+import type * as Ref from "@confect/core/Ref";
 import type { GenericActionCtx } from "convex/server";
 import * as Context from "effect/Context";
 import * as Effect from "effect/Effect";
@@ -46,7 +47,7 @@ const make = (nativeRunMutation: GenericActionCtx<any>["runMutation"]) => {
             yield* MutationTransactionContext.MutationTransactionContext;
           return yield* controls.runMutation(mutation, actualArgs, options);
         }
-        return yield* Ref.runWithCodec(
+        return yield* ReservedArgument.runWithCodec(
           mutation,
           actualArgs,
           (ref, encodedArgs) => nativeRunMutation(ref, encodedArgs),

package/src/MutationTransactionContext.ts

@@ -1,3 +1,4 @@
+import * as ReservedArgument from "./internal/reservedArgument.js";
 import * as Ref from "@confect/core/Ref";
 import type {
   AdvancedRunQueryOptions,
@@ -32,7 +33,7 @@ const make = (
       args: Ref.Args<Mutation>,
       options: MutationOptions,
     ) =>
-      Ref.runWithCodec(mutation, args, (ref, encodedArgs) =>
+      ReservedArgument.runWithCodec(mutation, args, (ref, encodedArgs) =>
         ctx.runMutation(ref, encodedArgs, options),
       ),
   ),

package/src/OfficialComponent.ts

@@ -0,0 +1,168 @@
+import * as Ref from "@confect/core/Ref";
+import { getFunctionReference } from "@confect/core/RefInternal";
+import type {
+  DefaultFunctionArgs,
+  GenericActionCtx,
+  GenericDataModel,
+  GenericMutationCtx,
+  GenericQueryCtx,
+} from "convex/server";
+import * as Effect from "effect/Effect";
+import * as Option from "effect/Option";
+import * as Schema from "effect/Schema";
+import * as ActionCtx from "./ActionCtx.js";
+import type * as ActionRunner from "./ActionRunner.js";
+import * as MutationCtx from "./MutationCtx.js";
+import type * as MutationRunner from "./MutationRunner.js";
+import * as QueryCtx from "./QueryCtx.js";
+import type * as QueryRunner from "./QueryRunner.js";
+import * as ReservedArgument from "./internal/reservedArgument.js";
+
+/**
+ * An official component's method rejected. `cause` is the rejection as thrown.
+ */
+export class ComponentCallFailed extends Schema.TaggedError<ComponentCallFailed>()(
+  "ComponentCallFailed",
+  { component: Schema.String, method: Schema.String, cause: Schema.Defect() },
+) {}
+
+declare const unsupported: unique symbol;
+type Unsupported = typeof unsupported;
+type Needs<Param> = [GenericActionCtx<GenericDataModel>] extends [Param]
+  ? [GenericMutationCtx<GenericDataModel>] extends [Param]
+    ? [GenericQueryCtx<GenericDataModel>] extends [Param]
+      ? QueryRunner.QueryRunner
+      : MutationRunner.MutationRunner
+    : [GenericQueryCtx<GenericDataModel>] extends [Param]
+      ? Unsupported
+      : ActionRunner.ActionRunner
+  : Unsupported;
+
+type Method<Official> = {
+  [K in keyof Official & string]: Official[K] extends (
+    ctx: infer Ctx,
+    ...args: infer _Args
+  ) => Promise<unknown>
+    ? Needs<Ctx> extends Unsupported
+      ? never
+      : K
+    : never;
+}[keyof Official & string];
+
+type Call<F> = F extends (
+  ctx: infer Ctx,
+  ...args: infer Args
+) => Promise<infer A>
+  ? (...args: Args) => Effect.Effect<A, never, Needs<Ctx>>
+  : never;
+
+type Lifted<Official> = <M extends Method<Official>>(
+  method: M,
+  ...args: Parameters<Call<Official[M]>>
+) => ReturnType<Call<Official[M]>>;
+
+/**
+ * Lift official promise methods, deriving each capability from its ctx
+ * parameter. A rejection is caller misuse, a limit or a platform fault rather
+ * than a domain fact, so it dies.
+ */
+export const make = <Official extends object>(
+  component: string,
+  official: Official,
+): Lifted<Official> => {
+  const context = Effect.gen(function* () {
+    const action = yield* Effect.serviceOption(
+      ActionCtx.ActionCtx<GenericDataModel>(),
+    );
+    if (Option.isSome(action)) return action.value;
+    const mutation = yield* Effect.serviceOption(
+      MutationCtx.MutationCtx<GenericDataModel>(),
+    );
+    if (Option.isSome(mutation)) return mutation.value;
+    const query = yield* Effect.serviceOption(
+      QueryCtx.QueryCtx<GenericDataModel>(),
+    );
+    if (Option.isSome(query)) return query.value;
+    return yield* Effect.die(
+      new Error(`${component} called outside a Confect handler`),
+    );
+  });
+  const call = Effect.fn(`${component}.call`)(function* (
+    method: Method<Official>,
+    ...args: unknown[]
+  ) {
+    const ctx = yield* context;
+    // Method selects promise methods whose first argument accepts a native handler context.
+    const invoke = official[method] as (
+      native: typeof ctx,
+      ...args: unknown[]
+    ) => Promise<unknown>;
+    return yield* Effect.tryPromise({
+      try: () => invoke.call(official, ctx, ...args),
+      catch: (cause) => ComponentCallFailed.make({ component, method, cause }),
+    }).pipe(Effect.orDie);
+  });
+  // Confect installs the native ctx with the runner capability inferred by Needs.
+  return call as unknown as Lifted<Official>;
+};
+
+/**
+ * A function reference with its encoded arguments, ready for an official method
+ * that takes both.
+ */
+export interface Fn<R extends Ref.Any> {
+  readonly reference: Ref.FunctionReference<R>;
+  readonly args: DefaultFunctionArgs;
+}
+
+/**
+ * Choose whether an official component call forwards the caller's carrier.
+ */
+export interface EncodeCallOptions {
+  /**
+   * Forward the caller's carrier to reserving mutations and actions. Use `none`
+   * when the component replays or compares the stored arguments.
+   */
+  readonly carrier: "forward" | "none";
+}
+
+/**
+ * Encode a ref's arguments through its codecs to the wire record an official
+ * method expects, with an explicit carrier policy.
+ */
+export const encodeCall = <R extends Ref.Any>(
+  ref: R,
+  args: NoInfer<Ref.Args<R>>,
+  options: EncodeCallOptions,
+): Effect.Effect<Fn<R>> =>
+  (options.carrier === "forward"
+    ? ReservedArgument.encodeArgs(ref, args)
+    : Ref.encodeArgs(ref, args)
+  ).pipe(
+    Effect.flatMap(
+      Schema.decodeUnknownEffect(Schema.Record(Schema.String, Schema.Unknown)),
+    ),
+    Effect.map((encoded) => ({
+      reference: getFunctionReference(ref),
+      args: encoded,
+    })),
+    Effect.orDie,
+  );
+
+/**
+ * Encode a callback's real field without fabricating the rest of its arguments.
+ */
+export const encodeField = <
+  R extends Ref.AnyConfect,
+  K extends keyof Ref.Args<R> & keyof Ref.ArgsFields<R>,
+>(
+  ref: R,
+  key: K,
+  value: NoInfer<Ref.Args<R>[K]>,
+): Effect.Effect<unknown> => {
+  const fields = ref.args.fields as Record<
+    keyof Ref.ArgsFields<R>,
+    Schema.Codec<unknown, unknown>
+  >;
+  return Schema.encodeUnknownEffect(fields[key])(value).pipe(Effect.orDie);
+};