@objectstack/plugin-webhooks 7.5.0 → 7.6.0

package/src/webhook-outbox-plugin.ts

@@ -1,129 +1,74 @@
 // Copyright (c) 2026 ObjectStack. Licensed under the Apache-2.0 license.
 
 import type { Plugin, PluginContext } from '@objectstack/core';
-import { readEnvWithDeprecation } from '@objectstack/types';
-import type {
-    IClusterService,
-    IDataEngine,
-    IRealtimeService,
-} from '@objectstack/spec/contracts';
+import type { IDataEngine, IRealtimeService } from '@objectstack/spec/contracts';
+import type { EnqueueHttpInput } from '@objectstack/service-messaging';
 import { AutoEnqueuer, type AutoEnqueuerOptions } from './auto-enqueuer.js';
-import { WebhookDispatcher, type DispatcherOptions } from './dispatcher.js';
-import { MemoryWebhookOutbox } from './memory-outbox.js';
-import type { IWebhookOutbox } from './outbox.js';
-import {
-    DeliveryRetentionSweeper,
-    type DeliveryRetentionOptions,
-} from './retention.js';
-import { SqlWebhookOutbox } from './sql-outbox.js';
 import { SysWebhook } from './sys-webhook.object.js';
-import { SysWebhookDelivery } from './sys-webhook-delivery.object.js';
 
-export interface WebhookOutboxPluginOptions
-    extends Partial<Omit<DispatcherOptions, 'cluster' | 'outbox' | 'nodeId'>> {
-    /**
-     * Override the outbox backend. If omitted a fresh `MemoryWebhookOutbox`
-     * is used — fine for local development, **not for production**: each
-     * node will see only its own rows.
-     *
-     * Pass a factory if you need the kernel-resolved `IDataEngine`:
-     *
-     * ```ts
-     * outbox: (ctx) => new SqlWebhookOutbox(
-     *   ctx.getService('objectql'), { partitionCount: 8 },
-     * ),
-     * ```
-     */
-    outbox?: IWebhookOutbox | ((ctx: PluginContext) => IWebhookOutbox);
-
-    /**
-     * Stable node id. If omitted, uses `process.env.OS_NODE_ID`
-     * (legacy `OBJECTSTACK_NODE_ID` still honoured with deprecation warning)
-     * or a random UUID generated at plugin init.
-     */
-    nodeId?: string;
-
-    /**
-     * If `false`, the plugin registers the outbox/dispatcher services but
-     * does NOT auto-start the loop — useful for tests that want to step
-     * the dispatcher manually via `dispatcher.tick()`.
-     *
-     * Default: true.
-     */
-    autoStart?: boolean;
+/**
+ * Structural view of `@objectstack/service-messaging`'s HTTP-outbox surface
+ * (ADR-0018 M3) — declared locally so this plugin doesn't take a hard runtime
+ * import on the service. Webhook deliveries are enqueued onto the shared
+ * `sys_http_delivery` outbox and drained by the messaging `HttpDispatcher`.
+ */
+interface MessagingHttpSurface {
+    isHttpDeliveryReady(): boolean;
+    enqueueHttp(input: EnqueueHttpInput): Promise<string>;
+    redeliverHttp(id: string): Promise<{ id: string; status: string }>;
+}
 
+export interface WebhookOutboxPluginOptions {
     /**
-     * Auto-enqueue config. When enabled (default `true` if the realtime
-     * + data engine services are available), the plugin subscribes to
-     * `data.record.*` events emitted by the engine and automatically
-     * enqueues a delivery row for every matching `sys_webhook` row.
+     * Auto-enqueue config. When enabled (default `true` if the realtime + data
+     * engine services are available), the plugin subscribes to `data.record.*`
+     * events and enqueues a delivery onto the shared messaging HTTP outbox for
+     * every matching `sys_webhook` row.
      *
-     * Set `false` to disable and only use the imperative
-     * `outbox.enqueue()` API.
+     * Set `false` to disable and enqueue webhooks imperatively elsewhere.
      */
     autoEnqueue?: boolean | AutoEnqueuerOptions;
-
-    /**
-     * Retention sweep config. When enabled (default `true` if a SQL
-     * outbox is in use), a periodic timer prunes old `success` and
-     * `dead` rows from `sys_webhook_delivery`.
-     *
-     * Set `false` to disable (e.g. when using `MemoryWebhookOutbox`).
-     */
-    retention?: boolean | DeliveryRetentionOptions;
 }
 
 /**
- * Wires a persistent, cluster-aware webhook outbox into the kernel.
+ * Wires webhook fan-out on top of the shared outbound-HTTP delivery substrate
+ * (ADR-0018 M3).
  *
- * Registered services:
- *   - `webhook.outbox`     → `IWebhookOutbox` (enqueue / claim / ack / list)
- *   - `webhook.dispatcher` → `WebhookDispatcher` (manual `tick()` if needed)
- *   - `webhook.autoEnqueuer` → `AutoEnqueuer` when auto-enqueue is on
- *   - `webhook.retention`    → `DeliveryRetentionSweeper` when retention is on
+ * Webhooks are no longer their own delivery engine: the durable outbox, the
+ * cluster-coordinated dispatcher, the retry/backoff/dead-letter schedule, and
+ * the retention sweep all live in `@objectstack/service-messaging`
+ * (`sys_http_delivery` + `HttpDispatcher`). This plugin owns only the
+ * webhook-specific concerns:
+ *   - the `sys_webhook` configuration object,
+ *   - the {@link AutoEnqueuer} that turns `data.record.*` events into outbox
+ *     rows (`source: 'webhook'`), and
+ *   - the redeliver admin endpoint.
  *
- * End-to-end flow once auto-enqueue is enabled:
+ * End-to-end flow:
  *
  *   engine.insert('contact', {...})
  *     → engine publishes data.record.created via IRealtimeService
  *     → AutoEnqueuer matches active sys_webhook rows in O(1)
- *     → outbox.enqueue() runs fire-and-forget (not on the write path)
- *     → dispatcher claims and POSTs (cluster-coordinated)
+ *     → messaging.enqueueHttp() runs fire-and-forget (off the write path)
+ *     → messaging HttpDispatcher claims and POSTs (cluster-coordinated, retried)
  *
- * **Cluster requirement** — this plugin depends on the cluster service
- * (`ClusterServicePlugin`). With the default `memory` driver the
- * dispatcher works correctly inside a single process; with a real driver
- * (`@objectstack/service-cluster-redis`) it correctly coordinates work
- * across nodes.
+ * **Requires** `MessagingServicePlugin` (`@objectstack/service-messaging`),
+ * which is a foundational, always-on capability.
  */
 export class WebhookOutboxPlugin implements Plugin {
     name = 'com.objectstack.plugin-webhook-outbox';
-    version = '1.1.0';
+    version = '2.0.0';
     type = 'standard' as const;
-    dependencies = ['com.objectstack.service.cluster'];
+    dependencies = ['com.objectstack.service.messaging'];
 
-    private dispatcher: WebhookDispatcher | undefined;
     private autoEnqueuer: AutoEnqueuer | undefined;
-    private retention: DeliveryRetentionSweeper | undefined;
-    private outboxInstance: IWebhookOutbox | undefined;
 
     constructor(private readonly options: WebhookOutboxPluginOptions = {}) {}
 
     async init(ctx: PluginContext): Promise<void> {
-        const cluster = ctx.getService<IClusterService>('cluster');
-        if (!cluster) {
-            throw new Error(
-                'WebhookOutboxPlugin: required service "cluster" not found — register ClusterServicePlugin first',
-            );
-        }
-
-        // Register the schemas this plugin owns at runtime (ADR-0029 K2.a).
-        // Both `sys_webhook` (config) and `sys_webhook_delivery` (telemetry)
-        // are now defined and owned here — the webhook plugin ships its data
-        // model and behavior as one unit instead of importing `sys_webhook`
-        // from the @objectstack/platform-objects monolith. Registering them
-        // here means a stack just needs `plugins: [new WebhookOutboxPlugin(...)]`
-        // and both objects auto-appear in REST/Studio/Setup nav.
+        // Register the webhook config object (ADR-0029 K2.a). The delivery
+        // telemetry now lives in messaging's `sys_http_delivery`, so the nav's
+        // "Deliveries" entry points there (filtered to source=webhook in views).
         const manifest = ctx.getService<{ register(m: any): void }>('manifest');
         if (manifest && typeof manifest.register === 'function') {
             manifest.register({
@@ -132,14 +77,9 @@ export class WebhookOutboxPlugin implements Plugin {
                 version: this.version,
                 type: 'plugin',
                 scope: 'system',
-                name: 'Webhook Outbox Schemas',
-                description:
-                    'Registers sys_webhook (configuration) and sys_webhook_delivery (durable outbox telemetry).',
-                objects: [SysWebhook, SysWebhookDelivery],
-                // ADR-0029 D7 — contribute the Webhooks entries into the
-                // Setup app's `group_integrations` slot. The plugin owns these
-                // objects (K2.a), so it ships their menu too; when the plugin
-                // isn't installed the slot stays empty.
+                name: 'Webhook Schemas',
+                description: 'Registers sys_webhook (configuration). Deliveries use messaging\'s sys_http_delivery outbox.',
+                objects: [SysWebhook],
                 navigationContributions: [
                     {
                         app: 'setup',
@@ -147,19 +87,18 @@ export class WebhookOutboxPlugin implements Plugin {
                         priority: 100,
                         items: [
                             { id: 'nav_webhooks', type: 'object', label: 'Webhooks', objectName: 'sys_webhook', icon: 'webhook', requiresObject: 'sys_webhook' },
-                            { id: 'nav_webhook_deliveries', type: 'object', label: 'Webhook Deliveries', objectName: 'sys_webhook_delivery', icon: 'send', requiresObject: 'sys_webhook_delivery' },
+                            { id: 'nav_http_deliveries', type: 'object', label: 'HTTP Deliveries', objectName: 'sys_http_delivery', icon: 'send', requiresObject: 'sys_http_delivery' },
                         ],
                     },
                 ],
             });
         } else {
             ctx.logger.warn?.(
-                '[webhook-outbox] manifest service unavailable — sys_webhook / sys_webhook_delivery will NOT appear in REST or Studio nav. Register MetadataService before WebhookOutboxPlugin.',
+                '[webhook-outbox] manifest service unavailable — sys_webhook will NOT appear in REST or Studio nav. Register MetadataService before WebhookOutboxPlugin.',
             );
         }
 
-        // ADR-0029 D8 — contribute this plugin's object translations to the
-        // i18n service on kernel:ready (the i18n plugin may register later).
+        // ADR-0029 D8 — contribute object translations once i18n is up.
         if (typeof (ctx as any).hook === 'function') {
             (ctx as any).hook('kernel:ready', async () => {
                 try {
@@ -174,117 +113,27 @@ export class WebhookOutboxPlugin implements Plugin {
             });
         }
 
-        const outbox = this.resolveOutbox(ctx);
-        this.outboxInstance = outbox;
-        const nodeId =
-            this.options.nodeId ??
-            readEnvWithDeprecation('OS_NODE_ID', 'OBJECTSTACK_NODE_ID') ??
-            `node-${Math.random().toString(36).slice(2, 10)}`;
-
-        const dispatcher = new WebhookDispatcher({
-            nodeId,
-            cluster,
-            outbox,
-            partitionCount: this.options.partitionCount,
-            batchSize: this.options.batchSize,
-            intervalMs: this.options.intervalMs,
-            lockTtlMs: this.options.lockTtlMs,
-            claimTtlMs: this.options.claimTtlMs,
-            fetchImpl: this.options.fetchImpl,
-            onAttempt: this.options.onAttempt,
-            rng: this.options.rng,
-            logger: ctx.logger,
-        });
-        this.dispatcher = dispatcher;
-
-        ctx.registerService('webhook.outbox', outbox);
-        ctx.registerService('webhook.dispatcher', dispatcher);
-
-        if (this.options.autoStart !== false) {
-            dispatcher.start();
-        }
-
-        // Loud warning when running with the in-memory outbox in production —
-        // it loses data on restart and never shares rows across nodes. With
-        // the auto-pick logic above this only fires when no IDataEngine is
-        // available, but flag it loudly anyway.
-        const usingMemoryOutbox = outbox instanceof MemoryWebhookOutbox;
-        if (usingMemoryOutbox && process.env.NODE_ENV === 'production') {
-            ctx.logger.warn?.(
-                '[webhook-outbox] MemoryWebhookOutbox in production — webhook deliveries WILL be lost on process exit. Ensure ObjectQL is registered before WebhookOutboxPlugin so the SQL outbox can auto-select.',
-            );
-        }
-
-        // Auto-enqueue + retention need the kernel to be fully ready
-        // before ObjectQL / Realtime services are resolvable.
         const autoEnqueueOpt = this.options.autoEnqueue ?? true;
-        const retentionOpt = this.options.retention ?? true;
 
-        const needsReadyHook = autoEnqueueOpt !== false || retentionOpt !== false;
-        if (needsReadyHook && typeof (ctx as any).hook === 'function') {
+        if (typeof (ctx as any).hook === 'function') {
             (ctx as any).hook('kernel:ready', async () => {
                 await this.bootAutoEnqueue(ctx, autoEnqueueOpt);
-                this.bootRetention(ctx, retentionOpt);
-            });
-        }
-
-        // Admin REST endpoint — POST /api/v1/webhooks/redeliver { deliveryId }.
-        // Wired in `kernel:ready` so the auth + http services are guaranteed
-        // resolvable. Gated on a session cookie so anonymous callers cannot
-        // replay deliveries; finer-grained RBAC (e.g. "only admins") can be
-        // layered on later — for now any signed-in user with access to the
-        // Setup app can redeliver. The action is also `disabled`-gated by
-        // status on the Studio side so the button only lights up on
-        // success / failed / dead rows.
-        if (typeof (ctx as any).hook === 'function') {
-            (ctx as any).hook('kernel:ready', () => {
                 this.registerAdminRoutes(ctx);
             });
         }
 
-        ctx.logger.info?.('[webhook-outbox] initialised', {
-            nodeId,
-            partitions: this.options.partitionCount ?? 8,
-            interval: this.options.intervalMs ?? 250,
+        ctx.logger.info?.('[webhook-outbox] initialised (delivery via shared messaging HTTP outbox)', {
             autoEnqueue: autoEnqueueOpt !== false,
-            retention: retentionOpt !== false,
         });
     }
 
     async dispose(): Promise<void> {
         await this.autoEnqueuer?.stop();
-        this.retention?.stop();
-        await this.dispatcher?.stop();
     }
 
-    private resolveOutbox(ctx: PluginContext): IWebhookOutbox {
-        const opt = this.options.outbox;
-        if (opt) {
-            return typeof opt === 'function'
-                ? (opt as (c: PluginContext) => IWebhookOutbox)(ctx)
-                : opt;
-        }
-        // No explicit override — auto-pick the right backend for the host.
-        // SqlWebhookOutbox needs an `IDataEngine`; if one is resolvable
-        // (the usual case in CLI-served stacks), use it so durable rows
-        // in `sys_webhook_delivery` actually round-trip through the
-        // dispatcher and the redeliver REST endpoint. Memory is only a
-        // last-resort fallback for tests / edge environments without an
-        // engine.
-        const engine = this.tryGetService<IDataEngine>(ctx, ['objectql', 'data']);
-        if (engine) {
-            const partitionCount = this.options.partitionCount ?? 8;
-            const sql = new SqlWebhookOutbox(engine, { partitionCount });
-            ctx.logger.info?.(
-                '[webhook-outbox] auto-selected SqlWebhookOutbox (objectql engine detected)',
-                { partitionCount },
-            );
-            return sql;
-        }
-        ctx.logger.warn?.(
-            '[webhook-outbox] no IDataEngine available — falling back to MemoryWebhookOutbox. Deliveries will NOT survive process restart and the redeliver REST endpoint will not see rows written through ObjectQL.',
-        );
-        return new MemoryWebhookOutbox();
+    private getMessaging(ctx: PluginContext): MessagingHttpSurface | undefined {
+        const svc = this.tryGetService<MessagingHttpSurface>(ctx, ['messaging']);
+        return svc && typeof svc.enqueueHttp === 'function' ? svc : undefined;
     }
 
     private async bootAutoEnqueue(
@@ -294,49 +143,30 @@ export class WebhookOutboxPlugin implements Plugin {
         if (opt === false) return;
         const engine = this.tryGetService<IDataEngine>(ctx, ['objectql', 'data']);
         const realtime = this.tryGetService<IRealtimeService>(ctx, ['realtime']);
-        if (!engine || !realtime) {
+        const messaging = this.getMessaging(ctx);
+        if (!engine || !realtime || !messaging) {
             ctx.logger.warn?.(
-                '[webhook-auto-enqueuer] disabled — ObjectQL or Realtime service not available',
-                { hasEngine: !!engine, hasRealtime: !!realtime },
+                '[webhook-auto-enqueuer] disabled — ObjectQL, Realtime, or Messaging service not available',
+                { hasEngine: !!engine, hasRealtime: !!realtime, hasMessaging: !!messaging },
             );
             return;
         }
-        if (!this.outboxInstance) return;
+        if (!messaging.isHttpDeliveryReady()) {
+            ctx.logger.warn?.(
+                '[webhook-auto-enqueuer] messaging HTTP outbox not ready (no data engine / reliableDelivery off) — webhook deliveries will not be durable',
+            );
+        }
 
         const enqOpts = (typeof opt === 'object' ? opt : {}) as AutoEnqueuerOptions;
         this.autoEnqueuer = new AutoEnqueuer(
             engine,
             realtime,
-            this.outboxInstance,
+            (input) => messaging.enqueueHttp(input),
             { ...enqOpts, logger: ctx.logger },
         );
         await this.autoEnqueuer.start();
         ctx.registerService('webhook.autoEnqueuer', this.autoEnqueuer);
-        ctx.logger.info?.('[webhook-auto-enqueuer] started');
-    }
-
-    private bootRetention(
-        ctx: PluginContext,
-        opt: boolean | DeliveryRetentionOptions,
-    ): void {
-        if (opt === false) return;
-        // Only meaningful for SQL outbox — Memory has its own (process-lifetime) GC.
-        if (this.outboxInstance instanceof MemoryWebhookOutbox) return;
-        const engine = this.tryGetService<IDataEngine>(ctx, ['objectql', 'data']);
-        if (!engine) {
-            ctx.logger.warn?.(
-                '[webhook-retention] disabled — ObjectQL service not available',
-            );
-            return;
-        }
-        const retOpts = (typeof opt === 'object' ? opt : {}) as DeliveryRetentionOptions;
-        this.retention = new DeliveryRetentionSweeper(engine, {
-            ...retOpts,
-            logger: ctx.logger,
-        });
-        this.retention.start();
-        ctx.registerService('webhook.retention', this.retention);
-        ctx.logger.info?.('[webhook-retention] sweeper started');
+        ctx.logger.info?.('[webhook-auto-enqueuer] started (enqueues source=webhook onto sys_http_delivery)');
     }
 
     private tryGetService<T>(ctx: PluginContext, names: string[]): T | undefined {
@@ -352,33 +182,25 @@ export class WebhookOutboxPlugin implements Plugin {
     }
 
     /**
-     * Mount POST /api/v1/webhooks/redeliver on the host Hono app, if one
-     * is available. Silently no-ops in environments without an HTTP
-     * server (MSW, edge tests, pure library use). Auth is delegated to
-     * the better-auth session cookie — every authenticated user counts.
+     * Mount POST /api/v1/webhooks/redeliver on the host Hono app, if one is
+     * available. Delegates to `messaging.redeliverHttp(deliveryId)`. Auth is the
+     * better-auth session cookie — every authenticated user counts.
      */
     private registerAdminRoutes(ctx: PluginContext): void {
         const http = this.tryGetService<any>(ctx, ['http-server']);
         if (!http || typeof http.getRawApp !== 'function') {
-            ctx.logger.debug?.(
-                '[webhook-outbox] HTTP server not available; redeliver REST endpoint not mounted',
-            );
+            ctx.logger.debug?.('[webhook-outbox] HTTP server not available; redeliver endpoint not mounted');
             return;
         }
         const rawApp = http.getRawApp();
-        const outbox = this.outboxInstance;
-        if (!rawApp || !outbox) return;
+        const messaging = this.getMessaging(ctx);
+        if (!rawApp || !messaging) return;
 
         rawApp.post('/api/v1/webhooks/redeliver', async (c: any) => {
-            // Auth gate — require a signed-in session.
             const userId = await this.resolveSessionUserId(ctx, c);
             if (!userId) {
                 return c.json(
-                    {
-                        success: false,
-                        error: 'unauthenticated',
-                        message: 'Sign in to redeliver webhook deliveries.',
-                    },
+                    { success: false, error: 'unauthenticated', message: 'Sign in to redeliver webhook deliveries.' },
                     401,
                 );
             }
@@ -386,77 +208,39 @@ export class WebhookOutboxPlugin implements Plugin {
             try {
                 body = await c.req.json();
             } catch {
-                return c.json(
-                    {
-                        success: false,
-                        error: 'invalid_body',
-                        message: 'Request body must be JSON.',
-                    },
-                    400,
-                );
+                return c.json({ success: false, error: 'invalid_body', message: 'Request body must be JSON.' }, 400);
             }
-            const deliveryId =
-                typeof body?.deliveryId === 'string' ? body.deliveryId.trim() : '';
+            const deliveryId = typeof body?.deliveryId === 'string' ? body.deliveryId.trim() : '';
             if (!deliveryId) {
                 return c.json(
-                    {
-                        success: false,
-                        error: 'missing_delivery_id',
-                        message: 'Body must include `deliveryId: string`.',
-                    },
+                    { success: false, error: 'missing_delivery_id', message: 'Body must include `deliveryId: string`.' },
                     400,
                 );
             }
             try {
-                const row = await outbox.redeliver(deliveryId);
-                ctx.logger.info?.('[webhook-outbox] redelivered', {
-                    deliveryId,
-                    requestedBy: userId,
-                });
+                const row = await messaging.redeliverHttp(deliveryId);
+                ctx.logger.info?.('[webhook-outbox] redelivered', { deliveryId, requestedBy: userId });
                 return c.json({ success: true, data: { id: row.id, status: row.status } });
             } catch (err: any) {
                 const code = err?.code;
                 if (code === 'not_found') {
-                    return c.json(
-                        { success: false, error: 'not_found', message: err.message },
-                        404,
-                    );
+                    return c.json({ success: false, error: 'not_found', message: err.message }, 404);
                 }
                 if (code === 'not_eligible') {
-                    return c.json(
-                        { success: false, error: 'not_eligible', message: err.message },
-                        409,
-                    );
+                    return c.json({ success: false, error: 'not_eligible', message: err.message }, 409);
                 }
-                ctx.logger.error?.(
-                    '[webhook-outbox] redeliver failed',
-                    err as Error,
-                );
+                ctx.logger.error?.('[webhook-outbox] redeliver failed', err as Error);
                 return c.json(
-                    {
-                        success: false,
-                        error: 'internal_error',
-                        message: err?.message ?? String(err),
-                    },
+                    { success: false, error: 'internal_error', message: err?.message ?? String(err) },
                     500,
                 );
             }
         });
 
-        ctx.logger.info?.(
-            '[webhook-outbox] redeliver endpoint mounted at POST /api/v1/webhooks/redeliver',
-        );
+        ctx.logger.info?.('[webhook-outbox] redeliver endpoint mounted at POST /api/v1/webhooks/redeliver');
     }
 
-    /**
-     * Resolve the requesting user's id from a better-auth session cookie.
-     * Returns `undefined` for anonymous callers — the caller decides
-     * whether that's a 401.
-     */
-    private async resolveSessionUserId(
-        ctx: PluginContext,
-        c: any,
-    ): Promise<string | undefined> {
+    private async resolveSessionUserId(ctx: PluginContext, c: any): Promise<string | undefined> {
         try {
             const authService: any = this.tryGetService<any>(ctx, ['auth']);
             if (!authService) return undefined;

package/tsup.config.ts

@@ -3,7 +3,7 @@
 import { defineConfig } from 'tsup';
 
 export default defineConfig({
-    entry: ['src/index.ts', 'src/sql-outbox.ts', 'src/schema.ts'],
+    entry: ['src/index.ts', 'src/schema.ts'],
     splitting: true,
     sourcemap: true,
     clean: true,