tapimo 0.14.0 → 0.15.0

package/src/internal/Log.test.ts

@@ -20,6 +20,36 @@ function stable(entry: Log.Entry) {
 }
 
 describe('middleware', () => {
+  test('reports recovered request errors without changing the response', async () => {
+    const causes: Error[] = []
+    const entries: Log.Entry[] = []
+    const api = app({
+      emit: (entry, cause) => {
+        entries.push(entry)
+        if (cause) causes.push(cause)
+      },
+    })
+    const error = new Error('transient snapshot failure')
+    api.get('/recovered', (c) => {
+      c.set('recoveredError', error)
+      return c.json({ ok: true }, 200)
+    })
+
+    const response = await api.request('/recovered')
+
+    expect(response.status).toBe(200)
+    expect(stable(entries[0]!)).toMatchInlineSnapshot(`
+      {
+        "level": "error",
+        "method": "GET",
+        "path": "/recovered",
+        "route": "/recovered",
+        "status": 200,
+      }
+    `)
+    expect(causes).toEqual([error])
+  })
+
   test('emits one canonical entry per request', async () => {
     const entries: Log.Entry[] = []
     const api = app({ emit: (entry) => void entries.push(entry) })
@@ -51,26 +81,26 @@ describe('middleware', () => {
     `)
   })
 
-  test('includes failed optional funding counts', async () => {
+  test('includes failed optional routes counts', async () => {
     const entries: Log.Entry[] = []
     const api = app({ emit: (entry) => void entries.push(entry) })
-    api.get('/v1/funding/transfers', (c) => {
-      c.set('fundingDepositCountFailed', true)
-      c.set('fundingTransferCountFailed', true)
+    api.get('/v1/routes/transfers', (c) => {
+      c.set('routesDepositCountFailed', true)
+      c.set('routesTransferCountFailed', true)
       return c.json({ data: [], nextCursor: null }, 200)
     })
 
-    await api.request('/v1/funding/transfers?include=totalCount')
+    await api.request('/v1/routes/transfers?include=totalCount')
 
     expect(stable(entries[0]!)).toMatchInlineSnapshot(`
       {
-        "fundingDepositCountFailed": true,
-        "fundingTransferCountFailed": true,
         "level": "info",
         "method": "GET",
-        "path": "/v1/funding/transfers",
+        "path": "/v1/routes/transfers",
         "query": "include=totalCount",
-        "route": "/v1/funding/transfers",
+        "route": "/v1/routes/transfers",
+        "routesDepositCountFailed": true,
+        "routesTransferCountFailed": true,
         "status": 200,
       }
     `)
@@ -99,6 +129,22 @@ describe('middleware', () => {
     }
   })
 
+  test('records timings seeded by an outer runtime', async () => {
+    const entries: Log.Entry[] = []
+    const api = app({ emit: (entry) => void entries.push(entry) })
+    api.get('/', (c) => c.json({ ok: true }, 200))
+    const request = new Request('http://localhost/')
+    Timing.seed(request, {
+      active: [{ name: 'worker', start: performance.now() }],
+      metrics: [{ duration: 3, name: 'edge_rate_limit' }],
+    })
+
+    await api.fetch(request)
+
+    expect(entries[0]?.timings?.['edge_rate_limit']).toBe(3)
+    expect(typeof entries[0]?.timings?.['worker']).toBe('number')
+  })
+
   test('includes the caller principal, never the raw token', async () => {
     const entries: Log.Entry[] = []
     const api = app({ emit: (entry) => void entries.push(entry) })
@@ -478,11 +524,11 @@ describe('middleware', () => {
     expect(entries[0]?.pendingTimings?.['transaction_activity_mpp']).toBeGreaterThanOrEqual(0)
   })
 
-  test('includes bounded funding provider attempts', async () => {
+  test('includes bounded route provider attempts', async () => {
     const entries: Log.Entry[] = []
     const api = app({ emit: (entry) => void entries.push(entry) })
-    api.get('/funding', (c) => {
-      c.set('fundingProviderAttempts', [
+    api.get('/routes', (c) => {
+      c.set('routesProviderAttempts', [
         {
           durationMs: 12.5,
           id: 'relay',
@@ -500,11 +546,15 @@ describe('middleware', () => {
       return c.json({ ok: true }, 200)
     })
 
-    await api.request('/funding')
+    await api.request('/routes')
 
     expect(stable(entries[0]!)).toMatchInlineSnapshot(`
       {
-        "fundingProviderAttempts": [
+        "level": "info",
+        "method": "GET",
+        "path": "/routes",
+        "route": "/routes",
+        "routesProviderAttempts": [
           {
             "durationMs": 12.5,
             "id": "relay",
@@ -519,10 +569,58 @@ describe('middleware', () => {
             "outcome": "failed",
           },
         ],
+        "status": 200,
+      }
+    `)
+  })
+
+  test('includes the bounded route quote result', async () => {
+    const entries: Log.Entry[] = []
+    const api = app({ emit: (entry) => void entries.push(entry) })
+    api.get('/routes', (c) => {
+      c.set('routesQuoteResult', {
+        candidateCount: 1,
+        outcome: 'available',
+        quotes: [
+          {
+            ageMs: 1_250,
+            customerValueLossBps: 100,
+            destinationChain: 'eip155:4217',
+            destinationToken: 'eip155:4217/erc20:0x20c000000000000000000000b9537d11c60e8b50',
+            futureSkewMs: 0,
+            provider: 'relay',
+            sourceChain: 'eip155:8453',
+            sourceToken: 'eip155:8453/erc20:0x833589fcd6edb6e08f4c7c32d4f71b54bda02913',
+          },
+        ],
+      })
+      return c.json({ ok: true }, 200)
+    })
+
+    await api.request('/routes')
+
+    expect(stable(entries[0]!)).toMatchInlineSnapshot(`
+      {
         "level": "info",
         "method": "GET",
-        "path": "/funding",
-        "route": "/funding",
+        "path": "/routes",
+        "route": "/routes",
+        "routesQuoteResult": {
+          "candidateCount": 1,
+          "outcome": "available",
+          "quotes": [
+            {
+              "ageMs": 1250,
+              "customerValueLossBps": 100,
+              "destinationChain": "eip155:4217",
+              "destinationToken": "eip155:4217/erc20:0x20c000000000000000000000b9537d11c60e8b50",
+              "futureSkewMs": 0,
+              "provider": "relay",
+              "sourceChain": "eip155:8453",
+              "sourceToken": "eip155:8453/erc20:0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
+            },
+          ],
+        },
         "status": 200,
       }
     `)

package/src/internal/Log.ts

@@ -5,8 +5,9 @@ import type { Hex } from 'ox'
 import * as ApiKey from '../ApiKey.js'
 import type * as Auth from './Auth.js'
 import type * as EdgeCache from './EdgeCache.js'
-import type * as FundingProvider from './funding/Provider.js'
+import type * as RoutesProvider from './routes/Provider.js'
 import type * as Timing from './Timing.js'
+import type * as VercelOidc from './VercelOidc.js'
 
 /** Hono variables read by the request logger and written by other layers. */
 export type Variables = {
@@ -16,27 +17,33 @@ export type Variables = {
   errorCaptured?: boolean | undefined
   /** Stable error code recorded by `Response.error` for the request log entry. */
   errorCode?: string | undefined
-  /** Whether the optional funding deposit count query failed. */
-  fundingDepositCountFailed?: true | undefined
+  /** Whether the optional route deposit count query failed. */
+  routesDepositCountFailed?: true | undefined
   /** Bounded MPP relay outcome emitted by the credential routes. */
   mpp?: Entry['mpp'] | undefined
-  /** Bounded outcomes for funding providers attempted by the request. */
-  fundingProviderAttempts?: Entry['fundingProviderAttempts'] | undefined
-  /** Whether the optional funding transfer count query failed. */
-  fundingTransferCountFailed?: true | undefined
+  /** Bounded outcomes for route providers attempted by the request. */
+  routesProviderAttempts?: Entry['routesProviderAttempts'] | undefined
+  /** Request-level route quote result used for reliability metrics. */
+  routesQuoteResult?: Entry['routesQuoteResult'] | undefined
+  /** Whether the optional route transfer count query failed. */
+  routesTransferCountFailed?: true | undefined
   /** Redacted provider failure details recorded by an upstream provider. */
   providerFailure?: Entry['provider'] | undefined
   /** Redacted provider failures when multiple upstream providers fail. */
   providerFailures?: Entry['providerFailures'] | undefined
+  /** Recovered request error that should still be logged and reported. */
+  recoveredError?: Error | undefined
   /** Bounded JSON-RPC failure metadata recorded by a composed RPC handler. */
   rpcResponse?: Entry['rpc'] | undefined
   /** Bounded sponsorship rejection details recorded by the relay app. */
   sponsorship?: Sponsorship | undefined
+  /** Sanitized failed Vercel workload-identity evaluations. */
+  vercelOidcResults?: readonly VercelOidc.Result[] | undefined
 }
 
 type ErrorMetadata = {
   /** Bounded provider attempts attached to a caught error. */
-  fundingProviderAttempts?: Entry['fundingProviderAttempts'] | undefined
+  routesProviderAttempts?: Entry['routesProviderAttempts'] | undefined
   /** Redacted first provider failure attached to a caught error. */
   providerFailure?: Entry['provider'] | undefined
   /** Redacted provider failures attached to a caught error. */
@@ -59,7 +66,7 @@ export type Level = 'error' | 'info' | 'warn'
 
 /** Redacted upstream provider failure details. */
 export type ProviderFailure = {
-  /** Chain whose upstream request failed, when the request selected one. */
+  /** Chain whose upstream request failed, when known. */
   chainId?: number | undefined
   /** Stable provider error code, when one is safe to retain. */
   code?: string | undefined
@@ -67,25 +74,19 @@ export type ProviderFailure = {
   failure: 'http' | 'network' | 'payload' | 'query' | 'rate_limit' | 'timeout' | 'unknown'
   /** Provider identifier. */
   id: string
+  /** Upstream error message, when one was returned. */
+  message?: string | undefined
   /** Provider operation identifier. */
   operation: string
   /** Upstream HTTP status, when a response was received. */
   status?: number | undefined
 }
 
-/** Bounded operational result for one funding quote provider attempt. */
-export type FundingProviderAttempt = {
-  /** Wall-clock duration of the provider attempt in milliseconds. */
-  durationMs: number
-  /** Failure class, present only when the provider attempt failed. */
-  failure?: ProviderFailure['failure'] | undefined
-  /** Provider identifier. */
-  id: FundingProvider.ProviderId
-  /** Stable upstream operation identifier. */
-  operation: FundingProvider.ProviderOperation
-  /** Provider attempt outcome. */
-  outcome: 'available' | 'failed' | 'thin' | 'unavailable'
-}
+/** Bounded operational result for one route provider call. */
+export type RoutesProviderAttempt = RoutesProvider.ProviderAttemptResult
+
+/** Request-level route quote result used for reliability metrics. */
+export type RoutesQuoteResult = RoutesProvider.QuoteRequestResult
 
 /** JSON-RPC methods that can request managed sponsorship. */
 export type SponsorshipMethod =
@@ -96,6 +97,7 @@ export type SponsorshipMethod =
 
 /** Stable client error codes for sponsorship rejections. */
 export type SponsorshipReason =
+  | 'attribution_id_invalid'
   | 'api_key_forbidden'
   | 'api_key_required'
   | 'billing_past_due'
@@ -139,12 +141,14 @@ export type Entry = {
   errorCaptured?: boolean | undefined
   /** Stable error code when the response is a JSON error envelope (e.g. `not_found`, `api_key_invalid`). */
   errorCode?: string | undefined
-  /** Whether the optional funding deposit count query failed. */
-  fundingDepositCountFailed?: true | undefined
-  /** Bounded funding provider attempts made while serving the request. */
-  fundingProviderAttempts?: readonly FundingProviderAttempt[] | undefined
-  /** Whether the optional funding transfer count query failed. */
-  fundingTransferCountFailed?: true | undefined
+  /** Whether the optional route deposit count query failed. */
+  routesDepositCountFailed?: true | undefined
+  /** Bounded route provider attempts made while serving the request. */
+  routesProviderAttempts?: readonly RoutesProviderAttempt[] | undefined
+  /** Request-level route quote result used for reliability metrics. */
+  routesQuoteResult?: RoutesQuoteResult | undefined
+  /** Whether the optional route transfer count query failed. */
+  routesTransferCountFailed?: true | undefined
   /** Log level: 5xx `error`; 4xx or JSON-RPC failure `warn`; otherwise `info`. */
   level: Level
   /** Request method. */
@@ -227,6 +231,8 @@ export type Entry = {
   sponsorship?: Sponsorship | undefined
   /** HTTP response status code. JSON-RPC failures retain their protocol-native `200`. */
   status: number
+  /** Sanitized Vercel workload-identity shadow evaluations. */
+  vercelOidc?: readonly VercelOidc.Result[] | undefined
   /** Longest upstream operation duration per Server-Timing name, in milliseconds (e.g. RPC and TIDX calls). */
   timings?: Record<string, number> | undefined
 }
@@ -262,19 +268,21 @@ export function middleware<environment extends Environment = Environment>(
     // Hono cannot resolve variable types through the generic `environment`,
     // so shared-variable reads are cast from the environment contract above
     // (the same pattern EdgeCache uses for its cross-layer reads).
-    const cause = c.error
+    const recoveredError = c.get('recoveredError' as never) as Error | undefined
+    const cause = c.error ?? recoveredError
     const error = cause as (Error & ErrorMetadata) | undefined
     const principal = c.get('principal' as never) as Auth.Principal | undefined
     const errorCaptured = c.get('errorCaptured' as never) as boolean | undefined
     const chainId = c.get('chainId' as never) as number | undefined
     const errorCode = c.get('errorCode' as never) as string | undefined
-    const fundingDepositCountFailed = c.get('fundingDepositCountFailed' as never) as
-      | true
+    const routesDepositCountFailed = c.get('routesDepositCountFailed' as never) as true | undefined
+    const routesProviderAttempts =
+      error?.routesProviderAttempts ??
+      (c.get('routesProviderAttempts' as never) as Entry['routesProviderAttempts'] | undefined)
+    const routesQuoteResult = c.get('routesQuoteResult' as never) as
+      | Entry['routesQuoteResult']
       | undefined
-    const fundingProviderAttempts =
-      error?.fundingProviderAttempts ??
-      (c.get('fundingProviderAttempts' as never) as Entry['fundingProviderAttempts'] | undefined)
-    const fundingTransferCountFailed = c.get('fundingTransferCountFailed' as never) as
+    const routesTransferCountFailed = c.get('routesTransferCountFailed' as never) as
       | true
       | undefined
     const mpp = c.get('mpp' as never) as Entry['mpp']
@@ -284,6 +292,7 @@ export function middleware<environment extends Environment = Environment>(
       error?.providerFailures ?? (c.get('providerFailures' as never) as Entry['providerFailures'])
     const rpc = c.get('rpcResponse' as never) as Entry['rpc']
     const sponsorship = c.get('sponsorship' as never) as Entry['sponsorship']
+    const vercelOidc = c.get('vercelOidcResults' as never) as Entry['vercelOidc']
     // The `request` total metric duplicates `duration` (measured here, one
     // layer further out), so only operation timings are kept.
     const metrics = (c.get('serverTiming' as never) as Timing.Metric[] | undefined)?.filter(
@@ -331,17 +340,20 @@ export function middleware<environment extends Environment = Environment>(
       duration: round(duration),
       ...(errorCaptured === undefined ? {} : { errorCaptured }),
       ...(errorCode === undefined ? {} : { errorCode }),
-      ...(fundingDepositCountFailed === undefined ? {} : { fundingDepositCountFailed }),
-      ...(fundingProviderAttempts === undefined ? {} : { fundingProviderAttempts }),
-      ...(fundingTransferCountFailed === undefined ? {} : { fundingTransferCountFailed }),
+      ...(routesDepositCountFailed === undefined ? {} : { routesDepositCountFailed }),
+      ...(routesProviderAttempts === undefined ? {} : { routesProviderAttempts }),
+      ...(routesQuoteResult === undefined ? {} : { routesQuoteResult }),
+      ...(routesTransferCountFailed === undefined ? {} : { routesTransferCountFailed }),
       level:
+        recoveredError !== undefined ||
         status >= 500 ||
         rpcServerError(rpc?.code) ||
         (rpc?.serverErrors ?? 0) > 0 ||
         (sponsorship?.internalErrors ?? 0) > 0 ||
-        mpp?.errorCode === 'unknown'
+        mpp?.errorCode === 'unknown' ||
+        vercelOidc?.some((result) => result.outcome === 'error')
           ? 'error'
-          : status >= 400 || rpc || sponsorship
+          : status >= 400 || rpc || sponsorship || vercelOidc !== undefined
             ? 'warn'
             : 'info',
       method: c.req.method,
@@ -376,6 +388,7 @@ export function middleware<environment extends Environment = Environment>(
       ...(sponsorship === undefined ? {} : { sponsorship }),
       status,
       ...(timings === undefined ? {} : { timings }),
+      ...(vercelOidc === undefined ? {} : { vercelOidc }),
     } satisfies Entry
     const result = fn(entry, cause)