@cosmicdrift/kumiko-framework 0.328.0 → 0.328.1

package/src/entrypoint/index.ts

@@ -1,541 +0,0 @@
-// Canonical entrypoint factories for the three deploy shapes:
-//
-//   - `createApiEntrypoint` — HTTP + SSE receiver. Does NOT start the
-//     event-dispatcher or job-runner. One or more instances behind a load
-//     balancer handle user requests.
-//   - `createWorkerEntrypoint` — Event-dispatcher + job-runner, no HTTP.
-//     Single instance (or few, SKIP LOCKED serialises them) drains events
-//     post-commit and runs scheduled/triggered jobs.
-//   - `createAllInOneEntrypoint` — both in one process. Convenient for
-//     dev, samples, single-tenant self-hosts; NOT recommended for scaled
-//     prod deploys because CPU-intensive jobs would block request
-//     handling.
-//
-// Each factory returns a unified `{ lifecycle, start, stop }` so `main.ts`
-// wiring stays identical regardless of mode:
-//
-//   const entry = createApiEntrypoint(opts);
-//   attachSignalHandlers(entry.lifecycle);
-//   await entry.start();
-//   serve({
-//     fetch: (req, server) => entry.app.fetch(req, server.requestIP(req)?.address),
-//     port: 3000,
-//   });
-//
-// `entry.app.fetch` alone (without the 2nd arg) loses the caller's real
-// socket address — the client-ip resolver then sees no env, falls back to
-// "unknown", and every caller shares one IP-keyed rate-limit bucket (see
-// api/client-ip.ts). @cosmicdrift/kumiko-server-runtime's
-// `buildBunServeOptions(port, entry.app.fetch)` wires this same pattern
-// plus the SSE-safe idleTimeout default, for consumers that already
-// depend on that package.
-//
-// The `lifecycle` handle drives graceful-shutdown LIFO; the framework
-// registers its own shutdown hooks (eventDispatcher.stop, jobRunner.stop)
-// in the order they were built.
-//
-// SSE fanout across processes (split api/worker deploy, replicas > 1):
-// buildServer's default sseBroker is Redis-backed whenever REDIS_URL is
-// set (fw#2625) — a push on the worker's dispatcher reaches clients
-// connected to any API instance via Redis Pub/Sub, no per-instance
-// cursor needed. Without REDIS_URL, the in-memory broker still only
-// reaches clients on the same process.
-
-import type { Hono } from "hono";
-import type { AuthRoutesConfig } from "../api/auth-routes";
-import type { JwtHelper, JwtKeyring } from "../api/jwt";
-import type { KumikoServer, ServerOptions } from "../api/server";
-import { buildServer, withFileProviderResolver } from "../api/server";
-import type { SseBroker } from "../api/sse-broker";
-import type { PgClient } from "../db/connection";
-import type { EffectiveFeaturesResolver } from "../engine/tier-resolver-extension";
-import type { AppContext, JobRunIn, Registry, RunIn } from "../engine/types";
-import type { JobRunner, JobRunnerOptions } from "../jobs/job-runner";
-import { createJobRunner } from "../jobs/job-runner";
-import type { Lifecycle } from "../lifecycle";
-import { createLifecycle } from "../lifecycle";
-import type { ObservabilityOptions, ObservabilityProvider } from "../observability";
-import { createNoopProvider } from "../observability";
-import type { EventDedup, EventDispatcher } from "../pipeline";
-import type { Dispatcher, DispatcherOptions } from "../pipeline/dispatcher";
-import { dispatcherToWriteRef } from "../pipeline/dispatcher";
-import type { SystemHooks } from "../pipeline/lifecycle-pipeline";
-
-// Shared fields across all three modes. A caller that swaps between
-// modes can reuse the same options object.
-export type BaseEntrypointOptions = {
-  readonly registry: Registry;
-  readonly context: AppContext;
-  readonly jwtSecret: string | JwtKeyring;
-  readonly jwtIssuer?: string;
-  readonly observability?: ObservabilityProvider;
-  readonly observabilityOptions?: ObservabilityOptions;
-  readonly dispatcherOptions?: Omit<DispatcherOptions, "lifecycle">;
-  readonly systemHooks?: SystemHooks;
-  readonly eventDedup?: EventDedup;
-  // Optional pre-built lifecycle. If omitted, each factory builds its own.
-  // Pass one in when you want to register caller-specific shutdown hooks
-  // alongside the framework's.
-  readonly lifecycle?: Lifecycle;
-};
-
-// Shape the JobRunner block takes in every entrypoint mode. Extracted so
-// adding a new JobRunnerOption doesn't need three parallel changes.
-type JobsBlock = {
-  readonly redisUrl: string;
-  readonly queueNamePrefix?: string;
-  readonly getActiveTenantIds?: JobRunnerOptions["getActiveTenantIds"];
-  readonly onJobStart?: JobRunnerOptions["onJobStart"];
-  readonly onJobComplete?: JobRunnerOptions["onJobComplete"];
-  readonly onJobFailed?: JobRunnerOptions["onJobFailed"];
-};
-
-export type ApiEntrypointOptions = BaseEntrypointOptions & {
-  readonly auth?: AuthRoutesConfig;
-  readonly anonymousAccess?: ServerOptions["anonymousAccess"];
-  readonly sseBroker?: SseBroker;
-  readonly rateLimit?: ServerOptions["rateLimit"];
-  readonly maxRequestBytes?: ServerOptions["maxRequestBytes"];
-  readonly readiness?: ServerOptions["readiness"];
-  readonly metrics?: ServerOptions["metrics"];
-  readonly extraRoutes?: ServerOptions["extraRoutes"];
-  // Job-enqueue surface for the API process. Required whenever the registry
-  // defines event-triggered jobs: command-dispatcher fires handleEvent as
-  // an afterCommit-hook — without a jobRunner the enqueue silently drops.
-  //
-  // `runLocalJobs: true` additionally starts a BullMQ worker for the "api"
-  // lane inside this API process. Only useful for short, CPU-light jobs —
-  // a long-running handler on the API lane will starve request handlers.
-  readonly jobs?: JobsBlock & {
-    readonly runLocalJobs?: boolean;
-  };
-  // Event-dispatcher inside the API process — the MSP analog to
-  // `jobs.runLocalJobs`. Single-container deployments (runProdApp) have no
-  // worker process; without `runLocal: true` their multiStreamProjections
-  // NEVER apply (the read-side silently stays empty — 2026-06-11 incident).
-  // processLane becomes "both" so worker-lane MSPs run here too.
-  // Deployments with a dedicated worker keep this unset.
-  readonly eventDispatcher?: ServerOptions["eventDispatcher"] & {
-    readonly runLocal?: boolean;
-  };
-  readonly trustedProxyHops?: ServerOptions["trustedProxyHops"];
-};
-
-export type WorkerEntrypointOptions = BaseEntrypointOptions &
-  JobsBlock & {
-    // Tuning knobs for the event-dispatcher loop. Workers typically set a
-    // pgClient so LISTEN/NOTIFY drops the poll latency from seconds to TCP
-    // round-trip.
-    readonly eventDispatcher?: ServerOptions["eventDispatcher"];
-  };
-
-export type AllInOneEntrypointOptions = ApiEntrypointOptions & WorkerEntrypointOptions;
-
-export type ApiEntrypoint = {
-  readonly app: Hono;
-  readonly jwt: JwtHelper;
-  readonly sseBroker: SseBroker;
-  readonly lifecycle: Lifecycle;
-  readonly observability: ObservabilityProvider;
-  // Command-dispatcher behind /api/* — for writes outside the HTTP
-  // pipeline (provider-webhook routes, see KumikoServer.dispatcher).
-  readonly dispatcher: Dispatcher;
-  // Set when `eventDispatcher.runLocal: true` built a local poller —
-  // single-container mode. Undefined for API-only processes.
-  readonly eventDispatcher?: EventDispatcher;
-  readonly mode: "api";
-  // Starts the local BullMQ worker (runLocalJobs) and the local
-  // event-dispatcher (eventDispatcher.runLocal) when configured;
-  // no-op otherwise. Uniform call-site so `main.ts` doesn't branch on mode.
-  start(): Promise<void>;
-  stop(): Promise<void>;
-};
-
-export type WorkerEntrypoint = {
-  readonly lifecycle: Lifecycle;
-  readonly eventDispatcher: EventDispatcher;
-  readonly jobRunner: JobRunner;
-  readonly observability: ObservabilityProvider;
-  // Same dispatcher the API process exposes. App-wired background
-  // components that need the dispatcher directly (not JobContext.write)
-  // still persist through it.
-  readonly dispatcher: Dispatcher;
-  readonly mode: "worker";
-  // Starts event-dispatcher poll + BullMQ worker. SIGTERM triggers
-  // `lifecycle.drain()`, which stops both via registered hooks.
-  start(): Promise<void>;
-  stop(): Promise<void>;
-};
-
-export type AllInOneEntrypoint = Omit<ApiEntrypoint, "mode"> &
-  Omit<WorkerEntrypoint, "mode"> & {
-    readonly mode: "all-in-one";
-  };
-
-// --- Shared builders ------------------------------------------------------
-//
-// Three factories, three near-identical buildServer() + createJobRunner()
-// blocks. Extract once so adding a new ServerOptions field doesn't need
-// three parallel edits — one helper, one place to maintain.
-
-// Merge an internally-built jobRunner into the caller's dispatcherOptions
-// so the command-dispatcher fires handleEvent as an afterCommit-hook for
-// event-triggered jobs (dispatcher.ts:997). Without this plumbing,
-// `r.job({ trigger: { on: … } })` silently drops on every write — that
-// was the hidden Welle-2.5 gap.
-//
-// Caller-supplied `dispatcherOptions.jobRunner` wins (tests sometimes
-// inject a mock runner directly).
-function mergeDispatcherOptions(
-  caller: Omit<DispatcherOptions, "lifecycle"> | undefined,
-  jobRunner: JobRunner | undefined,
-): Omit<DispatcherOptions, "lifecycle"> | undefined {
-  if (!jobRunner) return caller;
-  if (caller?.jobRunner) return caller;
-  return { ...(caller ?? {}), jobRunner };
-}
-
-// Resolved once for the job-runner's context only — buildServer still gets
-// the caller's original `options.observability` (unresolved) since it
-// derives `shouldWrapRedis` from whether that was explicitly set.
-function resolveObservability(
-  observability: ObservabilityProvider | undefined,
-): ObservabilityProvider {
-  return observability ?? createNoopProvider();
-}
-
-function contextWithObservability(
-  context: AppContext,
-  observability: ObservabilityProvider,
-  effectiveFeatures: EffectiveFeaturesResolver | undefined,
-): AppContext {
-  return {
-    ...context,
-    // Same source of truth as buildServer's contextWithObservability
-    // (api/server.ts) — job handlers reading ctx.effectiveFeatures should
-    // see the same resolver as command handlers, not just dispatcherOptions.
-    ...(effectiveFeatures && { effectiveFeatures }),
-    tracer: observability.tracer,
-    meter: observability.meter,
-  };
-}
-
-// buildApiServer shapes ServerOptions from API-mode caller-options.
-// AllInOneEntrypointOptions extends ApiEntrypointOptions, so structural
-// subtyping makes the all-in-one path a valid caller without an explicit
-// union. `dispatcherOverride` lets API-mode slam `{disabled:true}` while
-// All-in-one passes the caller's real config through. `jobRunner`, when
-// present, is merged into dispatcherOptions so the command-dispatcher can
-// fire event-triggered jobs.
-function buildApiServer(
-  opts: ApiEntrypointOptions,
-  lifecycle: Lifecycle,
-  dispatcherOverride: ServerOptions["eventDispatcher"] | undefined,
-  jobRunner: JobRunner | undefined,
-  processLane: RunIn,
-): KumikoServer {
-  const dispatcherOptions = mergeDispatcherOptions(opts.dispatcherOptions, jobRunner);
-  return buildServer({
-    registry: opts.registry,
-    context: opts.context,
-    jwtSecret: opts.jwtSecret,
-    lifecycle,
-    processLane,
-    jwtIssuer: opts.jwtIssuer,
-    auth: opts.auth,
-    trustedProxyHops: opts.trustedProxyHops,
-    anonymousAccess: opts.anonymousAccess,
-    sseBroker: opts.sseBroker,
-    rateLimit: opts.rateLimit,
-    maxRequestBytes: opts.maxRequestBytes,
-    readiness: opts.readiness,
-    metrics: opts.metrics,
-    extraRoutes: opts.extraRoutes,
-    observability: opts.observability,
-    observabilityOptions: opts.observabilityOptions,
-    dispatcherOptions,
-    systemHooks: opts.systemHooks,
-    eventDedup: opts.eventDedup,
-    eventDispatcher: dispatcherOverride,
-  });
-}
-
-// Worker path is narrower — no HTTP-specific options. `eventDispatcher`
-// comes straight from the caller (LISTEN/NOTIFY wiring, pollIntervalMs).
-// `processLane` is "worker" — any MSP with runIn="api" gets filtered out
-// of this process's dispatcher.
-function buildWorkerServer(
-  opts: WorkerEntrypointOptions,
-  lifecycle: Lifecycle,
-  jobRunner: JobRunner,
-): KumikoServer {
-  const dispatcherOptions = mergeDispatcherOptions(opts.dispatcherOptions, jobRunner);
-  return buildServer({
-    registry: opts.registry,
-    context: opts.context,
-    jwtSecret: opts.jwtSecret,
-    lifecycle,
-    processLane: "worker",
-    observability: opts.observability,
-    observabilityOptions: opts.observabilityOptions,
-    dispatcherOptions,
-    systemHooks: opts.systemHooks,
-    eventDedup: opts.eventDedup,
-    eventDispatcher: opts.eventDispatcher,
-  });
-}
-
-// Build a lane-scoped JobRunner AND register its stop-hook on the lifecycle.
-// Hook order (LIFO): jobRunner runs BEFORE eventDispatcher so no in-flight
-// job tries to enqueue an event to an already-torn-down dispatcher.
-// buildServer registers the dispatcher hook earlier in the factory, so
-// this one lands later in registration order → runs first on drain.
-//
-// `consumerLane` = "api" | "worker" starts a BullMQ worker for that lane's
-// queue plus cron/boot scheduling for lane-matching jobs. `undefined`
-// builds an enqueuer-only runner: holds queue-clients for both lanes so
-// dispatch()/handleEvent() route per jobDef.runIn, but starts no local
-// consumer. Used by the API process when `runLocalJobs` is false.
-function buildJobRunnerWithHook(
-  registry: Registry,
-  context: AppContext,
-  jobs: JobsBlock,
-  consumerLane: JobRunIn | undefined,
-  lifecycle: Lifecycle,
-  hookName: string,
-): JobRunner {
-  const jobRunner = createJobRunner({
-    registry,
-    context,
-    redisUrl: jobs.redisUrl,
-    consumerLane,
-    queueNamePrefix: jobs.queueNamePrefix,
-    getActiveTenantIds: jobs.getActiveTenantIds,
-    onJobStart: jobs.onJobStart,
-    onJobComplete: jobs.onJobComplete,
-    onJobFailed: jobs.onJobFailed,
-  });
-  lifecycle.registerShutdownHook(hookName, async () => {
-    await jobRunner.stop();
-  });
-  return jobRunner;
-}
-
-// A worker-shaped process with no consumers (no SSE, no search adapter,
-// no MSPs) has nothing to drain — that's a caller-config bug, not a
-// usable process shape. Fail loud so ops sees it before prod takes
-// traffic from an API that enqueues events nobody consumes.
-function requireDispatcher(server: KumikoServer, mode: string): EventDispatcher {
-  if (!server.eventDispatcher) {
-    throw new Error(
-      `[entrypoint] ${mode} mode requires at least one event consumer (SSE broker, search adapter, or r.multiStreamProjection)`,
-    );
-  }
-  return server.eventDispatcher;
-}
-
-// --- API entrypoint -------------------------------------------------------
-
-export function createApiEntrypoint(options: ApiEntrypointOptions): ApiEntrypoint {
-  const lifecycle = options.lifecycle ?? createLifecycle({ startReady: true });
-  const observability = resolveObservability(options.observability);
-  const context = withFileProviderResolver(options.registry, options.context);
-
-  // Boot-validation (Welle 2.6.c) — fail loud before traffic arrives:
-  //   (a) Any jobs declared + no jobs-block → command-dispatcher would
-  //       silently drop every event-triggered enqueue. Fix: add jobs:
-  //       { redisUrl } so the API holds lane-queue-clients.
-  //   (b) A job with runIn="api" + runLocalJobs !== true → the API
-  //       process is the ONLY container that can consume "api"-lane
-  //       queues (workers only consume "worker"). Without runLocalJobs,
-  //       the job would enqueue and stay pending forever.
-  const allJobs = [...options.registry.getAllJobs().values()];
-  if (allJobs.length > 0 && !options.jobs) {
-    throw new Error(
-      `[entrypoint] createApiEntrypoint: registry declares ${allJobs.length} job(s) but no \`jobs\` block was passed. ` +
-        `Event-triggered writes would silently drop their enqueue. Add \`jobs: { redisUrl: ... }\` to createApiEntrypoint options.`,
-    );
-  }
-  if (options.jobs && !options.jobs.runLocalJobs) {
-    const apiOnlyJobs = allJobs.filter((j) => j.runIn === "api").map((j) => j.name);
-    if (apiOnlyJobs.length > 0) {
-      throw new Error(
-        `[entrypoint] createApiEntrypoint: ${apiOnlyJobs.length} job(s) declared runIn="api" but runLocalJobs is not set — these jobs would have no consumer. ` +
-          `Set \`jobs: { runLocalJobs: true, ... }\` or change the jobs' runIn to "worker". Affected: ${apiOnlyJobs.join(", ")}`,
-      );
-    }
-  }
-
-  // When the app declares any jobs, the API process needs a job-enqueuer
-  // so event-triggered jobs fired as afterCommit-hooks of a write reach
-  // the queue at all. `runLocalJobs: true` upgrades the enqueuer to a full
-  // runner that also consumes the "api" lane's queue in-process.
-  const apiJobRunner = options.jobs
-    ? buildJobRunnerWithHook(
-        options.registry,
-        contextWithObservability(
-          context,
-          observability,
-          options.dispatcherOptions?.effectiveFeatures,
-        ),
-        options.jobs,
-        options.jobs.runLocalJobs ? "api" : undefined,
-        lifecycle,
-        "jobRunner",
-      )
-    : undefined;
-
-  // Without `runLocal` the dispatcher is skipped entirely (`{disabled:true}`)
-  // — an API process behind a dedicated worker doesn't hold an idle poller.
-  // WITH `runLocal` this process fills every role (single-container), so
-  // processLane is "both": worker-lane MSPs must run here or they'd never
-  // apply anywhere.
-  const { runLocal: runLocalDispatcher, ...dispatcherTunables } = options.eventDispatcher ?? {};
-  const server = buildApiServer(
-    { ...options, context },
-    lifecycle,
-    runLocalDispatcher ? dispatcherTunables : { disabled: true },
-    apiJobRunner,
-    runLocalDispatcher ? "both" : "api",
-  );
-  apiJobRunner?.attachDispatcher(dispatcherToWriteRef(server.dispatcher));
-
-  return {
-    app: server.app,
-    jwt: server.jwt,
-    sseBroker: server.sseBroker,
-    lifecycle,
-    observability: server.observability,
-    dispatcher: server.dispatcher,
-    ...(server.eventDispatcher && { eventDispatcher: server.eventDispatcher }),
-    mode: "api",
-    async start() {
-      // Start the local BullMQ worker when runLocalJobs=true; enqueuer-only
-      // runners have a no-op .start() by design (JobRunner skips worker
-      // creation when consumerLane is undefined).
-      if (apiJobRunner) await apiJobRunner.start();
-      // Local event-dispatcher (runLocal): begins the poll loop so MSPs
-      // apply in-process. stop() is already lifecycle-registered by
-      // buildServer.
-      if (server.eventDispatcher) await server.eventDispatcher.start();
-    },
-    async stop() {
-      await lifecycle.drain();
-    },
-  };
-}
-
-// --- Worker entrypoint ----------------------------------------------------
-
-export function createWorkerEntrypoint(options: WorkerEntrypointOptions): WorkerEntrypoint {
-  const lifecycle = options.lifecycle ?? createLifecycle({ startReady: true });
-  const observability = resolveObservability(options.observability);
-  const context = withFileProviderResolver(options.registry, options.context);
-  const jobRunner = buildJobRunnerWithHook(
-    options.registry,
-    contextWithObservability(context, observability, options.dispatcherOptions?.effectiveFeatures),
-    options,
-    "worker",
-    lifecycle,
-    "jobRunner",
-  );
-  const server = buildWorkerServer({ ...options, context }, lifecycle, jobRunner);
-  jobRunner.attachDispatcher(dispatcherToWriteRef(server.dispatcher));
-  const eventDispatcher = requireDispatcher(server, "worker");
-
-  return {
-    lifecycle,
-    eventDispatcher,
-    jobRunner,
-    observability: server.observability,
-    dispatcher: server.dispatcher,
-    mode: "worker",
-    async start() {
-      await eventDispatcher.start();
-      await jobRunner.start();
-    },
-    async stop() {
-      await lifecycle.drain();
-    },
-  };
-}
-
-// --- All-in-one entrypoint ------------------------------------------------
-
-export function createAllInOneEntrypoint(options: AllInOneEntrypointOptions): AllInOneEntrypoint {
-  const lifecycle = options.lifecycle ?? createLifecycle({ startReady: true });
-  const observability = resolveObservability(options.observability);
-  const context = withFileProviderResolver(options.registry, options.context);
-  const jobRunnerContext = contextWithObservability(
-    context,
-    observability,
-    options.dispatcherOptions?.effectiveFeatures,
-  );
-
-  // All-in-one consumes BOTH lanes: two runners, each with a BullMQ worker
-  // for its own lane's queue. Both runners hold queue-clients for both
-  // lanes, so dispatch()/handleEvent() always route per jobDef.runIn —
-  // picking either runner as the dispatcher's enqueuer surface would work.
-  // The worker runner wins the dispatcherOptions slot by convention (that's
-  // where the majority of jobs live). Each runner handles cron/boot for
-  // its own lane in its own .start().
-  const workerJobRunner = buildJobRunnerWithHook(
-    options.registry,
-    jobRunnerContext,
-    options,
-    "worker",
-    lifecycle,
-    "jobRunner",
-  );
-  const apiJobRunner = buildJobRunnerWithHook(
-    options.registry,
-    jobRunnerContext,
-    options,
-    "api",
-    lifecycle,
-    "jobRunnerApi",
-  );
-
-  // Same builder as the API path — but WITH the caller's eventDispatcher
-  // config instead of `{disabled:true}`, so buildServer wires the poller
-  // alongside the HTTP app. processLane "both" disables MSP lane-filter
-  // entirely: all-in-one is a single process that fills every role, so
-  // every MSP (api-only, worker-only, both) must run here. `runLocal` is
-  // the API-mode flag — all-in-one is always local, strip it.
-  const { runLocal: _runLocal, ...allInOneDispatcherTunables } = options.eventDispatcher ?? {};
-  const server = buildApiServer(
-    { ...options, context },
-    lifecycle,
-    allInOneDispatcherTunables,
-    workerJobRunner,
-    "both",
-  );
-  workerJobRunner.attachDispatcher(dispatcherToWriteRef(server.dispatcher));
-  apiJobRunner.attachDispatcher(dispatcherToWriteRef(server.dispatcher));
-  const eventDispatcher = requireDispatcher(server, "all-in-one");
-
-  return {
-    app: server.app,
-    jwt: server.jwt,
-    sseBroker: server.sseBroker,
-    lifecycle,
-    eventDispatcher,
-    jobRunner: workerJobRunner,
-    observability: server.observability,
-    dispatcher: server.dispatcher,
-    mode: "all-in-one",
-    async start() {
-      await eventDispatcher.start();
-      await workerJobRunner.start();
-      await apiJobRunner.start();
-    },
-    async stop() {
-      await lifecycle.drain();
-    },
-  };
-}
-
-// Keep PgClient imported so TS sees the import as used when callers take
-// our re-exported ServerOptions.eventDispatcher type (which references it).
-// Pure re-export of the concrete type is enough to anchor it.
-export type { PgClient };