tapimo 0.9.0 → 0.10.0

package/src/internal/MetricSink.test.ts

@@ -1,4 +1,5 @@
 import * as Metrics from '../Metrics.js'
+import type * as Webhooks from '../Webhooks.js'
 import type * as Log from './Log.js'
 import * as MetricSink from './MetricSink.js'
 
@@ -453,3 +454,520 @@ describe('requests', () => {
     expect(JSON.stringify(mpp)).not.toMatch(/request_private|credential|payload|signature/)
   })
 })
+
+describe('webhooks', () => {
+  test('records recovery, poll-cycle, poll-stage, and failed-tick telemetry with bounded tags', () => {
+    const events: MetricEvent[] = []
+    const metrics = Metrics.from({
+      count(name, value, tags) {
+        events.push({ name, tags, type: 'count', value })
+      },
+      flush() {},
+      gauge(name, value, tags) {
+        events.push({ name, tags, type: 'gauge', value })
+      },
+      histogram(name, value, tags) {
+        events.push({ name, tags, type: 'histogram', value })
+      },
+    })
+    const sink = MetricSink.webhooks(metrics)
+
+    sink.record({
+      chainId: 4217,
+      dequeuedAt: 1_300,
+      enqueuedAt: 1_100,
+      trigger: 'alarm',
+      type: 'webhook:head-recovery',
+    })
+    sink.record({
+      chainId: 4217,
+      lagBlocks: 2,
+      type: 'webhook:head-progress',
+    })
+    sink.record({
+      chainId: 4217,
+      delayMs: 200,
+      trigger: 'direct',
+      type: 'webhook:poll-start',
+    })
+    sink.record({
+      chainId: 4217,
+      outcome: 'ok',
+      requestedBoundaryAdvanceBlocks: 10,
+      trigger: 'direct',
+      type: 'webhook:poll-cycle',
+    })
+    sink.record({
+      chainId: 4217,
+      failure: 'remote',
+      stage: 'finish',
+      trigger: 'direct',
+      type: 'webhook:poll-failure',
+    })
+    sink.record({
+      chainId: 4217,
+      durationMs: 42,
+      eventType: 'token:transfer',
+      outcome: 'ok',
+      stage: 'scan',
+      type: 'webhook:poll',
+    })
+    sink.record({
+      cursorLagBlocks: 7,
+      meta: { chainId: 4217, durationMs: 50, outcome: 'error' },
+      result: undefined,
+      type: 'webhook:tick',
+    })
+
+    expect(events).toMatchInlineSnapshot(`
+      [
+        {
+          "name": "webhook_head_recovery_queue_count",
+          "tags": {
+            "chain_id": "4217",
+            "trigger": "alarm",
+          },
+          "type": "count",
+          "value": 1,
+        },
+        {
+          "name": "webhook_head_recovery_queue_wait_ms",
+          "tags": {
+            "chain_id": "4217",
+            "trigger": "alarm",
+          },
+          "type": "histogram",
+          "value": 200,
+        },
+        {
+          "name": "webhook_head_progress_lag_blocks",
+          "tags": {
+            "chain_id": "4217",
+          },
+          "type": "gauge",
+          "value": 2,
+        },
+        {
+          "name": "webhook_poll_start_count",
+          "tags": {
+            "chain_id": "4217",
+            "trigger": "direct",
+          },
+          "type": "count",
+          "value": 1,
+        },
+        {
+          "name": "webhook_poll_start_delay_ms",
+          "tags": {
+            "chain_id": "4217",
+            "trigger": "direct",
+          },
+          "type": "histogram",
+          "value": 200,
+        },
+        {
+          "name": "webhook_poll_cycle_count",
+          "tags": {
+            "chain_id": "4217",
+            "outcome": "ok",
+            "trigger": "direct",
+          },
+          "type": "count",
+          "value": 1,
+        },
+        {
+          "name": "webhook_poll_requested_boundary_advance_blocks",
+          "tags": {
+            "chain_id": "4217",
+            "outcome": "ok",
+            "trigger": "direct",
+          },
+          "type": "histogram",
+          "value": 10,
+        },
+        {
+          "name": "webhook_poll_failure_count",
+          "tags": {
+            "chain_id": "4217",
+            "failure": "remote",
+            "stage": "finish",
+            "trigger": "direct",
+          },
+          "type": "count",
+          "value": 1,
+        },
+        {
+          "name": "webhook_poller_stage_duration_ms",
+          "tags": {
+            "chain_id": "4217",
+            "event_type": "token:transfer",
+            "outcome": "ok",
+            "stage": "scan",
+          },
+          "type": "histogram",
+          "value": 42,
+        },
+        {
+          "name": "webhook_poller_tick_count",
+          "tags": {
+            "chain_id": "4217",
+            "outcome": "error",
+          },
+          "type": "count",
+          "value": 1,
+        },
+        {
+          "name": "webhook_poller_tick_duration_ms",
+          "tags": {
+            "chain_id": "4217",
+            "outcome": "error",
+          },
+          "type": "histogram",
+          "value": 50,
+        },
+        {
+          "name": "webhook_subscription_cursor_lag_blocks",
+          "tags": {
+            "chain_id": "4217",
+          },
+          "type": "gauge",
+          "value": 7,
+        },
+      ]
+    `)
+  })
+
+  test('records scan boundaries with bounded workload dimensions', () => {
+    const events: MetricEvent[] = []
+    const metrics = Metrics.from({
+      count(name, value, tags) {
+        events.push({ name, tags, type: 'count', value })
+      },
+      flush() {},
+      gauge() {},
+      histogram(name, value, tags) {
+        events.push({ name, tags, type: 'histogram', value })
+      },
+    })
+    const sink = MetricSink.webhooks(metrics)
+
+    sink.record({
+      chainId: 4217,
+      concurrency: 8,
+      eventType: 'log:emitted',
+      maxWindowBlocks: 1_000,
+      phase: 'start',
+      rpcMethod: 'eth_getLogs',
+      subscriptionCount: 8,
+      subscriptionLimit: 256,
+      totalWindowBlocks: 8_000,
+      type: 'webhook:poll-scan',
+    })
+    sink.record({
+      chainId: 4217,
+      concurrency: 8,
+      durationMs: 250,
+      eventType: 'log:emitted',
+      failedSubscriptions: 1,
+      matchedItems: 700,
+      maxWindowBlocks: 1_000,
+      outcome: 'error',
+      phase: 'complete',
+      rpcMethod: 'eth_getLogs',
+      subscriptionCount: 8,
+      subscriptionLimit: 256,
+      totalWindowBlocks: 8_000,
+      type: 'webhook:poll-scan',
+    })
+
+    expect(events.map(({ name, tags, value }) => ({ name, tags, value }))).toMatchInlineSnapshot(`
+      [
+        {
+          "name": "webhook_poller_scan_checkpoint_count",
+          "tags": {
+            "chain_id": "4217",
+            "event_type": "log:emitted",
+            "phase": "start",
+          },
+          "value": 1,
+        },
+        {
+          "name": "webhook_poller_scan_concurrency",
+          "tags": {
+            "chain_id": "4217",
+            "event_type": "log:emitted",
+            "phase": "start",
+          },
+          "value": 8,
+        },
+        {
+          "name": "webhook_poller_scan_subscription_count",
+          "tags": {
+            "chain_id": "4217",
+            "event_type": "log:emitted",
+            "phase": "start",
+          },
+          "value": 8,
+        },
+        {
+          "name": "webhook_poller_scan_subscription_limit",
+          "tags": {
+            "chain_id": "4217",
+            "event_type": "log:emitted",
+            "phase": "start",
+          },
+          "value": 256,
+        },
+        {
+          "name": "webhook_poller_scan_max_window_blocks",
+          "tags": {
+            "chain_id": "4217",
+            "event_type": "log:emitted",
+            "phase": "start",
+          },
+          "value": 1000,
+        },
+        {
+          "name": "webhook_poller_scan_total_window_blocks",
+          "tags": {
+            "chain_id": "4217",
+            "event_type": "log:emitted",
+            "phase": "start",
+          },
+          "value": 8000,
+        },
+        {
+          "name": "webhook_poller_scan_checkpoint_count",
+          "tags": {
+            "chain_id": "4217",
+            "event_type": "log:emitted",
+            "phase": "complete",
+          },
+          "value": 1,
+        },
+        {
+          "name": "webhook_poller_scan_concurrency",
+          "tags": {
+            "chain_id": "4217",
+            "event_type": "log:emitted",
+            "phase": "complete",
+          },
+          "value": 8,
+        },
+        {
+          "name": "webhook_poller_scan_subscription_count",
+          "tags": {
+            "chain_id": "4217",
+            "event_type": "log:emitted",
+            "phase": "complete",
+          },
+          "value": 8,
+        },
+        {
+          "name": "webhook_poller_scan_subscription_limit",
+          "tags": {
+            "chain_id": "4217",
+            "event_type": "log:emitted",
+            "phase": "complete",
+          },
+          "value": 256,
+        },
+        {
+          "name": "webhook_poller_scan_max_window_blocks",
+          "tags": {
+            "chain_id": "4217",
+            "event_type": "log:emitted",
+            "phase": "complete",
+          },
+          "value": 1000,
+        },
+        {
+          "name": "webhook_poller_scan_total_window_blocks",
+          "tags": {
+            "chain_id": "4217",
+            "event_type": "log:emitted",
+            "phase": "complete",
+          },
+          "value": 8000,
+        },
+        {
+          "name": "webhook_poller_scan_duration_ms",
+          "tags": {
+            "chain_id": "4217",
+            "event_type": "log:emitted",
+            "phase": "complete",
+          },
+          "value": 250,
+        },
+        {
+          "name": "webhook_poller_scan_failed_subscription_count",
+          "tags": {
+            "chain_id": "4217",
+            "event_type": "log:emitted",
+            "phase": "complete",
+          },
+          "value": 1,
+        },
+        {
+          "name": "webhook_poller_scan_matched_item_count",
+          "tags": {
+            "chain_id": "4217",
+            "event_type": "log:emitted",
+            "phase": "complete",
+          },
+          "value": 700,
+        },
+        {
+          "name": "webhook_poller_rpc_scan_count",
+          "tags": {
+            "chain_id": "4217",
+            "event_type": "log:emitted",
+            "outcome": "error",
+            "rpc_method": "eth_getLogs",
+          },
+          "value": 1,
+        },
+      ]
+    `)
+  })
+
+  test('records delivery stages without subscription identity', () => {
+    const events: MetricEvent[] = []
+    const metrics = Metrics.from({
+      count(name, value, tags) {
+        events.push({ name, tags, type: 'count', value })
+      },
+      flush() {},
+      gauge() {},
+      histogram(name, value, tags) {
+        events.push({ name, tags, type: 'histogram', value })
+      },
+    })
+    const sink = MetricSink.webhooks(metrics)
+    const subscription = {
+      chainId: 4217,
+      createdAt: '2026-01-01T00:00:00.000Z',
+      destination: { type: 'url', url: 'https://hooks.example.com/endpoint' },
+      eventType: 'token:transfer',
+      failureCount: 0,
+      filters: {},
+      id: 'wh_private',
+      owner: { orgId: 'org_private', type: 'api_key' },
+      secret: 'whsec_private',
+      status: 'active',
+      updatedAt: '2026-01-01T00:00:00.000Z',
+    } satisfies Webhooks.Subscription
+    const envelope = {
+      chainId: 4217,
+      createdAt: '2026-01-01T00:00:00.000Z',
+      data: { ping: true },
+      id: 'evt_private',
+      subscriptionId: subscription.id,
+      type: 'ping',
+    } satisfies Webhooks.Envelope
+
+    sink.record({
+      envelope,
+      queueAttempt: 2,
+      result: { durationMs: 25, ok: true, status: 204 },
+      subscription,
+      timings: {
+        deliveryLogMs: 5,
+        envelopeToQueueMs: 3,
+        endToEndMs: 250,
+        eventToEnvelopeMs: 80,
+        processingMs: 67,
+        queueWaitMs: 100,
+        stateWriteMs: 10,
+        subscriptionReadMs: 4,
+      },
+      trigger: 'queue',
+      type: 'webhook:delivery',
+    })
+
+    expect(events.map(({ name, value }) => ({ name, value }))).toMatchInlineSnapshot(`
+      [
+        {
+          "name": "webhook_delivery_attempt_count",
+          "value": 1,
+        },
+        {
+          "name": "webhook_delivery_duration_ms",
+          "value": 25,
+        },
+        {
+          "name": "webhook_delivery_log_write_ms",
+          "value": 5,
+        },
+        {
+          "name": "webhook_delivery_envelope_to_queue_ms",
+          "value": 3,
+        },
+        {
+          "name": "webhook_delivery_end_to_end_ms",
+          "value": 250,
+        },
+        {
+          "name": "webhook_delivery_event_to_envelope_ms",
+          "value": 80,
+        },
+        {
+          "name": "webhook_delivery_processing_ms",
+          "value": 67,
+        },
+        {
+          "name": "webhook_delivery_queue_wait_ms",
+          "value": 100,
+        },
+        {
+          "name": "webhook_delivery_state_write_ms",
+          "value": 10,
+        },
+        {
+          "name": "webhook_delivery_subscription_read_ms",
+          "value": 4,
+        },
+      ]
+    `)
+    expect(events.find((event) => event.name === 'webhook_delivery_attempt_count')?.tags)
+      .toMatchInlineSnapshot(`
+        {
+          "attempt_bucket": "1",
+          "chain_id": "4217",
+          "destination_type": "url",
+          "event_type": "ping",
+          "outcome": "succeeded",
+          "queue_attempt_bucket": "2",
+          "queue_disposition": "acked",
+          "status_class": "2xx",
+          "trigger": "queue",
+        }
+      `)
+    expect(events.find((event) => event.name === 'webhook_delivery_queue_wait_ms')?.tags)
+      .toMatchInlineSnapshot(`
+        {
+          "chain_id": "4217",
+          "destination_type": "url",
+          "event_type": "ping",
+          "outcome": "succeeded",
+          "queue_attempt_bucket": "2",
+          "queue_disposition": "acked",
+        }
+      `)
+    expect(JSON.stringify(events)).not.toMatch(/evt_private|org_private|wh_private|whsec_private/)
+
+    sink.record({
+      envelope,
+      queueAttempt: 3,
+      result: { error: 'upstream unavailable', ok: false, status: 503 },
+      subscription,
+      trigger: 'queue',
+      type: 'webhook:delivery',
+    })
+
+    expect(events.at(-1)?.tags).toMatchObject({
+      queue_attempt_bucket: '3-5',
+      queue_disposition: 'retried',
+    })
+  })
+})