tapimo 0.15.1 → 0.18.1

package/src/internal/Log.ts

@@ -1,5 +1,6 @@
 import type { MiddlewareHandler } from 'hono'
 import type { RequestIdVariables } from 'hono/request-id'
+import { matchedRoutes } from 'hono/route'
 import type { Hex } from 'ox'
 
 import * as ApiKey from '../ApiKey.js'
@@ -56,6 +57,8 @@ export type Environment = {
     EdgeCache.Variables &
     RequestIdVariables &
     Timing.Variables & {
+      /** Credential kind the request presented, set by auth middleware before resolution. */
+      credential?: Auth.CredentialKind | undefined
       /** Authenticated or anonymous caller, set by auth middleware. */
       principal?: Auth.Principal | undefined
     }
@@ -135,6 +138,8 @@ export type Entry = {
   cache?: 'hit' | undefined
   /** Tempo chain selected for the request. */
   chainId?: number | undefined
+  /** Credential kind the request presented, present even when resolution never completed. */
+  credential?: Auth.CredentialKind | undefined
   /** Total request duration in milliseconds. */
   duration: number
   /** Whether the original request exception was already reported. */
@@ -214,7 +219,7 @@ export type Entry = {
     | undefined
   /** Request id, also echoed in the `tempo-request-id` response header. */
   requestId: string
-  /** Matched handler path (bounded cardinality), e.g. `/v1/tokens/:address`; `/*` when a middleware (e.g. an edge-cache hit) short-circuited routing. */
+  /** Matched endpoint pattern, e.g. `/v1/tokens/:address`; early wildcard middleware responses use the next endpoint match, or retain the middleware path if none exists. */
   route: string
   /** JSON-RPC failures returned in an otherwise successful HTTP response. */
   rpc?: {
@@ -229,7 +234,7 @@ export type Entry = {
   }
   /** Bounded sponsorship rejection diagnostics, without request or response bodies. */
   sponsorship?: Sponsorship | undefined
-  /** HTTP response status code. JSON-RPC failures retain their protocol-native `200`. */
+  /** HTTP response status code; `499` when the client disconnected first. JSON-RPC failures retain their protocol-native `200`. */
   status: number
   /** Sanitized Vercel workload-identity shadow evaluations. */
   vercelOidc?: readonly VercelOidc.Result[] | undefined
@@ -242,7 +247,7 @@ export type Emit = (entry: Entry, cause?: Error) => Promise<void> | void
 
 /**
  * Emits one canonical structured log entry per request, after the response is
- * written. Register after `requestId()` and before the timing and edge-cache
+ * written or when the client disconnects before it (`499`, `client_canceled`). Register after `requestId()` and before the timing and edge-cache
  * layers so the entry covers edge-cache hits and includes the Server-Timing
  * metrics collected inside the request.
  *
@@ -258,151 +263,184 @@ export function middleware<environment extends Environment = Environment>(
   const fn = options.emit ?? emit
   return async (c, next) => {
     const start = performance.now()
-    await next()
-    const duration = performance.now() - start
-
-    const url = new URL(c.req.url)
-    url.searchParams.delete('key')
-    const query = ApiKey.redact(url.search.slice(1))
-    const status = c.res.status
-    // 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 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 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 routesTransferCountFailed = c.get('routesTransferCountFailed' as never) as
-      | true
-      | undefined
-    const mpp = c.get('mpp' as never) as Entry['mpp']
-    const provider =
-      error?.providerFailure ?? (c.get('providerFailure' as never) as Entry['provider'])
-    const providerFailures =
-      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(
-      (metric) => metric.name !== 'request',
-    )
-    const timings = metrics?.length
-      ? Object.fromEntries(
-          metrics.reduce((result, metric) => {
-            const duration = round(metric.duration)
-            const existing = result.get(metric.name)
-            if (existing === undefined || duration > existing) result.set(metric.name, duration)
-            return result
-          }, new Map<string, number>()),
-        )
-      : undefined
-    const activeTimings = c.get('activeTimings' as never) as Timing.Active[] | undefined
-    const pendingTimings = activeTimings?.length
-      ? Object.fromEntries(
-          activeTimings.reduce((result, timing) => {
-            const duration = round(performance.now() - timing.start)
-            const existing = result.get(timing.name)
-            if (existing === undefined || duration > existing) result.set(timing.name, duration)
-            return result
-          }, new Map<string, number>()),
+    let emitted = false
+    const record = (canceled: boolean) => {
+      if (emitted) return
+      emitted = true
+      const duration = performance.now() - start
+      // Prefer dispatched routes. Early wildcard middleware responses use the next concrete path or method-specific wildcard, preserving bounded labels.
+      const route = (() => {
+        const path = c.req.routePath
+        if (!path.endsWith('*')) return path
+        const routes = matchedRoutes(c)
+        if (routes[c.req.routeIndex]?.method !== 'ALL') return path
+        return (
+          routes
+            .slice(c.req.routeIndex + 1)
+            .find(({ method, path }) => method !== 'ALL' || !path.endsWith('*'))?.path ?? path
         )
-      : undefined
+      })()
 
-    const rateLimit = (() => {
-      const limit = c.res.headers.get('RateLimit-Limit')
-      const remaining = c.res.headers.get('RateLimit-Remaining')
-      const reset = c.res.headers.get('RateLimit-Reset')
-      const scope = c.res.headers.get('RateLimit-Scope')
-      if (limit === null || remaining === null) return undefined
-      return {
-        limit: Number(limit),
-        remaining: Number(remaining),
-        ...(reset === null ? {} : { reset: Number(reset) }),
-        ...(scope === null ? {} : { scope }),
-      }
-    })()
+      const url = new URL(c.req.url)
+      url.searchParams.delete('key')
+      const query = ApiKey.redact(url.search.slice(1))
+      const status = canceled ? 499 : c.res.status
+      // 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 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 = canceled
+        ? 'client_canceled'
+        : (c.get('errorCode' as never) as string | undefined)
+      const credential = c.get('credential' as never) as Auth.CredentialKind | undefined
+      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 routesTransferCountFailed = c.get('routesTransferCountFailed' as never) as
+        | true
+        | undefined
+      const mpp = c.get('mpp' as never) as Entry['mpp']
+      const provider =
+        error?.providerFailure ?? (c.get('providerFailure' as never) as Entry['provider'])
+      const providerFailures =
+        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(
+        (metric) => metric.name !== 'request',
+      )
+      const timings = metrics?.length
+        ? Object.fromEntries(
+            metrics.reduce((result, metric) => {
+              const duration = round(metric.duration)
+              const existing = result.get(metric.name)
+              if (existing === undefined || duration > existing) result.set(metric.name, duration)
+              return result
+            }, new Map<string, number>()),
+          )
+        : undefined
+      const activeTimings = c.get('activeTimings' as never) as Timing.Active[] | undefined
+      const pendingTimings = activeTimings?.length
+        ? Object.fromEntries(
+            activeTimings.reduce((result, timing) => {
+              const duration = round(performance.now() - timing.start)
+              const existing = result.get(timing.name)
+              if (existing === undefined || duration > existing) result.set(timing.name, duration)
+              return result
+            }, new Map<string, number>()),
+          )
+        : undefined
+
+      const rateLimit = (() => {
+        // A canceled request has no response headers to read.
+        if (canceled) return undefined
+        const limit = c.res.headers.get('RateLimit-Limit')
+        const remaining = c.res.headers.get('RateLimit-Remaining')
+        const reset = c.res.headers.get('RateLimit-Reset')
+        const scope = c.res.headers.get('RateLimit-Scope')
+        if (limit === null || remaining === null) return undefined
+        return {
+          limit: Number(limit),
+          remaining: Number(remaining),
+          ...(reset === null ? {} : { reset: Number(reset) }),
+          ...(scope === null ? {} : { scope }),
+        }
+      })()
 
-    const entry = {
-      ...(c.get('edgeCacheStatus' as never) === 'hit' ? { cache: 'hit' as const } : {}),
-      ...(chainId === undefined ? {} : { chainId }),
-      duration: round(duration),
-      ...(errorCaptured === undefined ? {} : { errorCaptured }),
-      ...(errorCode === undefined ? {} : { errorCode }),
-      ...(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' ||
-        vercelOidc?.some((result) => result.outcome === 'error')
-          ? 'error'
-          : status >= 400 || rpc || sponsorship || vercelOidc !== undefined
-            ? 'warn'
-            : 'info',
-      method: c.req.method,
-      ...(mpp === undefined ? {} : { mpp }),
-      path: url.pathname,
-      ...(principal?.payment === undefined ? {} : { payment: principal.payment.reason }),
-      ...(pendingTimings === undefined ? {} : { pendingTimings }),
-      ...(principal === undefined
-        ? {}
-        : {
-            principal: {
-              ...(principal.type === 'super_admin' ? { actor: principal.actor } : {}),
-              ...(principal.type === 'api_key'
-                ? { billingActive: principal.apiKey.billingActive === true }
-                : {}),
-              ...(principal.type === 'api_key' ? { environment: principal.environment } : {}),
-              id: principal.id,
-              ...(principal.type === 'api_key' ? { orgId: principal.orgId } : {}),
-              ...(principal.type === 'api_key' && principal.projectId !== undefined
-                ? { projectId: principal.projectId }
-                : {}),
-              type: principal.type,
-            },
-          }),
-      ...(provider === undefined ? {} : { provider }),
-      ...(providerFailures === undefined ? {} : { providerFailures }),
-      ...(query ? { query } : {}),
-      ...(rateLimit === undefined ? {} : { rateLimit }),
-      requestId: c.get('requestId' as never) as string,
-      route: c.req.routePath,
-      ...(rpc === undefined ? {} : { rpc }),
-      ...(sponsorship === undefined ? {} : { sponsorship }),
-      status,
-      ...(timings === undefined ? {} : { timings }),
-      ...(vercelOidc === undefined ? {} : { vercelOidc }),
-    } satisfies Entry
-    const result = fn(entry, cause)
+      const entry = {
+        ...(c.get('edgeCacheStatus' as never) === 'hit' ? { cache: 'hit' as const } : {}),
+        ...(chainId === undefined ? {} : { chainId }),
+        ...(credential === undefined ? {} : { credential }),
+        duration: round(duration),
+        ...(errorCaptured === undefined ? {} : { errorCaptured }),
+        ...(errorCode === undefined ? {} : { errorCode }),
+        ...(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' ||
+          vercelOidc?.some((result) => result.outcome === 'error')
+            ? 'error'
+            : status >= 400 || rpc || sponsorship || vercelOidc !== undefined
+              ? 'warn'
+              : 'info',
+        method: c.req.method,
+        ...(mpp === undefined ? {} : { mpp }),
+        path: url.pathname,
+        ...(principal?.payment === undefined ? {} : { payment: principal.payment.reason }),
+        ...(pendingTimings === undefined ? {} : { pendingTimings }),
+        ...(principal === undefined
+          ? {}
+          : {
+              principal: {
+                ...(principal.type === 'super_admin' ? { actor: principal.actor } : {}),
+                ...(principal.type === 'api_key'
+                  ? { billingActive: principal.apiKey.billingActive === true }
+                  : {}),
+                ...(principal.type === 'api_key' ? { environment: principal.environment } : {}),
+                id: principal.id,
+                ...(principal.type === 'api_key' ? { orgId: principal.orgId } : {}),
+                ...(principal.type === 'api_key' && principal.projectId !== undefined
+                  ? { projectId: principal.projectId }
+                  : {}),
+                type: principal.type,
+              },
+            }),
+        ...(provider === undefined ? {} : { provider }),
+        ...(providerFailures === undefined ? {} : { providerFailures }),
+        ...(query ? { query } : {}),
+        ...(rateLimit === undefined ? {} : { rateLimit }),
+        requestId: c.get('requestId' as never) as string,
+        route,
+        ...(rpc === undefined ? {} : { rpc }),
+        ...(sponsorship === undefined ? {} : { sponsorship }),
+        status,
+        ...(timings === undefined ? {} : { timings }),
+        ...(vercelOidc === undefined ? {} : { vercelOidc }),
+      } satisfies Entry
+      const result = fn(entry, cause)
 
-    if (result instanceof Promise) {
-      const promise = result.catch((error) => console.error('request log sink failed', error))
-      // Unit tests and non-Worker runtimes do not always provide an execution
-      // context. In Workers, waitUntil keeps async sinks alive without holding
-      // the response open; elsewhere the promise is deliberately fire-and-forget.
-      try {
-        c.executionCtx.waitUntil(promise)
-      } catch {
-        void promise
+      if (result instanceof Promise) {
+        const promise = result.catch((error) => console.error('request log sink failed', error))
+        // Unit tests and non-Worker runtimes do not always provide an execution
+        // context. In Workers, waitUntil keeps async sinks alive without holding
+        // the response open; elsewhere the promise is deliberately fire-and-forget.
+        try {
+          c.executionCtx.waitUntil(promise)
+        } catch {
+          void promise
+        }
       }
     }
+
+    // Workers abort the request signal when the client disconnects first. Without this,
+    // abandoned requests emit no log line or metric at all.
+    const signal = c.req.raw.signal
+    const cancel = () => record(true)
+    signal.addEventListener('abort', cancel, { once: true })
+    await next()
+    signal.removeEventListener('abort', cancel)
+    record(false)
   }
 }