OTel Extraction + SWRCache + Viem Client Cache (#1391)

Co-authored-by: lightwalker-eth <126201998+lightwalker-eth@users.noreply.github.com>

Author: shrugs

apps/ensadmin/src/app/inspect/_components/render-requests-output.tsx

@@ -4,8 +4,8 @@ import { useEffect, useMemo, useState } from "react";
 import {
   type AcceleratableResponse,
   ClientError,
-  type ProtocolTrace,
   type TraceableResponse,
+  type TracingTrace,
 } from "@ensnode/ensnode-sdk";
 
 import { CodeBlock } from "@/components/code-block";
@@ -21,7 +21,7 @@ type QueryResult<K extends string> = UseQueryResult<
   { [key in K]: unknown } & AcceleratableResponse & TraceableResponse
 >;
 
-const renderTraceDuration = (trace: ProtocolTrace) => renderMicroseconds(getTraceDuration(trace));
+const renderTraceDuration = (trace: TracingTrace) => renderMicroseconds(getTraceDuration(trace));
 
 const MULTIPLE_THRESHOLD = 1.3; // accelerated requests must be 1.3x faster to be considered green
 

apps/ensadmin/src/components/identity/index.tsx

@@ -53,11 +53,7 @@ export function ResolveAndDisplayIdentity({
   // resolve the primary name for `identity` using ENSNode
   // TODO: extract out the concept of resolving an `Identity` into a provider that child
   //       components can then hook into.
-  const { identity: identityResult } = useResolvedIdentity({
-    identity,
-    namespaceId,
-    accelerate,
-  });
+  const { identity: identityResult } = useResolvedIdentity({ identity, accelerate });
 
   return (
     <DisplayIdentity

apps/ensadmin/src/components/tracing/renderer.tsx

@@ -6,9 +6,9 @@ import {
   ATTR_PROTOCOL_STEP,
   ATTR_PROTOCOL_STEP_RESULT,
   ForwardResolutionProtocolStep,
-  type ProtocolSpan,
-  type ProtocolTrace,
   ReverseResolutionProtocolStep,
+  type TracingSpan,
+  type TracingTrace,
 } from "@ensnode/ensnode-sdk";
 
 import { HoverCard, HoverCardContent, HoverCardTrigger } from "@/components/ui/hover-card";
@@ -20,7 +20,7 @@ import { cn } from "@/lib/utils";
 const asPercentInDuration = (value: number, duration: number) =>
   `${((value / duration) * 100).toFixed(2)}%`;
 
-const renderSpanAttributes = (span: ProtocolSpan) => {
+const renderSpanAttributes = (span: TracingSpan) => {
   const { [ATTR_PROTOCOL_STEP]: step, [ATTR_PROTOCOL_NAME]: protocol, ...rest } = span.attributes;
   switch (step) {
     case ReverseResolutionProtocolStep.Operation:
@@ -38,8 +38,8 @@ function RenderEvent({
   event,
   setParentOpen,
 }: {
-  span: ProtocolSpan;
-  event: ProtocolSpan["events"][number];
+  span: TracingSpan;
+  event: TracingSpan["events"][number];
   setParentOpen: (value: boolean) => void;
 }) {
   const left = asPercentInDuration(event.time - span.timestamp, span.duration);
@@ -91,7 +91,7 @@ function RenderEvent({
   );
 }
 
-function RenderSpan({ parent }: { parent: ProtocolTrace[number] }) {
+function RenderSpan({ parent }: { parent: TracingTrace[number] }) {
   const protocolStep = parent.attributes[ATTR_PROTOCOL_STEP] as
     | ForwardResolutionProtocolStep
     | ReverseResolutionProtocolStep;
@@ -170,7 +170,7 @@ function RenderSpan({ parent }: { parent: ProtocolTrace[number] }) {
   );
 }
 
-export function TraceRenderer({ trace }: { trace: ProtocolTrace }) {
+export function TraceRenderer({ trace }: { trace: TracingTrace }) {
   return (
     <div className="flex flex-col gap-4 rounded-lg">
       {/* for each root span */}

apps/ensadmin/src/lib/tracing.ts

@@ -1,4 +1,4 @@
-import type { ProtocolTrace } from "@ensnode/ensnode-sdk";
+import type { TracingTrace } from "@ensnode/ensnode-sdk";
 import { ForwardResolutionProtocolStep, ReverseResolutionProtocolStep } from "@ensnode/ensnode-sdk";
 
 const FORWARD_STEPS: Record<ForwardResolutionProtocolStep, { title: string; description: string }> =
@@ -78,6 +78,6 @@ export function getProtocolStepInfo(
   );
 }
 
-export function getTraceDuration(trace: ProtocolTrace) {
+export function getTraceDuration(trace: TracingTrace) {
   return Math.max(...trace.map((span) => span.duration), 0);
 }

apps/ensapi/package.json

@@ -25,10 +25,10 @@
     "@ensnode/ensnode-schema": "workspace:*",
     "@ensnode/ensnode-sdk": "workspace:*",
     "@ensnode/ponder-subgraph": "workspace:*",
-    "@namehash/ens-referrals": "workspace:*",
     "@hono/node-server": "^1.19.5",
     "@hono/otel": "^0.2.2",
     "@hono/zod-validator": "^0.7.2",
+    "@namehash/ens-referrals": "workspace:*",
     "@opentelemetry/api": "^1.9.0",
     "@opentelemetry/core": "^2.0.1",
     "@opentelemetry/exporter-metrics-otlp-proto": "^0.202.0",
@@ -39,14 +39,14 @@
     "@opentelemetry/sdk-trace-base": "^2.0.1",
     "@opentelemetry/sdk-trace-node": "^2.0.1",
     "@opentelemetry/semantic-conventions": "^1.34.0",
+    "@ponder/utils": "catalog:",
     "date-fns": "catalog:",
     "drizzle-orm": "catalog:",
     "hono": "catalog:",
     "p-memoize": "^8.0.0",
     "p-retry": "^7.1.0",
     "pg-connection-string": "catalog:",
     "pino": "catalog:",
-    "ponder": "catalog:",
     "ponder-enrich-gql-docs-middleware": "^0.1.3",
     "viem": "catalog:",
     "zod": "catalog:"

apps/ensapi/src/cache/indexing-status.cache.ts

@@ -38,6 +38,6 @@ export const indexingStatusCache = new SWRCache({
         throw error;
       }),
   ttl: 5, // 5 seconds
-  revalidationInterval: 10, // 10 seconds
+  proactiveRevalidationInterval: 10, // 10 seconds
   proactivelyInitialize: true,
 });

apps/ensapi/src/cache/referrer-leaderboard.cache.ts

@@ -44,26 +44,24 @@ const supportedOmnichainIndexingStatuses: OmnichainIndexingStatusId[] = [
 
 export const referrerLeaderboardCache = new SWRCache({
   fn: async () => {
-    const indexingStatus = await indexingStatusCache.readCache();
-    if (indexingStatus === null) {
+    const indexingStatus = await indexingStatusCache.read();
+    if (indexingStatus instanceof Error) {
       throw new Error(
         "Unable to generate referrer leaderboard. indexingStatusCache must have been successfully initialized.",
       );
     }
 
-    const omnichainIndexingStatus = indexingStatus.value.omnichainSnapshot.omnichainStatus;
-
+    const omnichainIndexingStatus = indexingStatus.omnichainSnapshot.omnichainStatus;
     if (!supportedOmnichainIndexingStatuses.includes(omnichainIndexingStatus)) {
       throw new Error(
         `Unable to generate referrer leaderboard. Omnichain indexing status is currently ${omnichainIndexingStatus} but must be ${supportedOmnichainIndexingStatuses.join(" or ")} to generate a referrer leaderboard.`,
       );
     }
 
     const latestIndexedBlockRef = getLatestIndexedBlockRef(
-      indexingStatus.value,
+      indexingStatus,
       rules.subregistryId.chainId,
     );
-
     if (latestIndexedBlockRef === null) {
       throw new Error(
         `Unable to generate referrer leaderboard. Latest indexed block ref for chain ${rules.subregistryId.chainId} is null.`,
@@ -84,6 +82,6 @@ export const referrerLeaderboardCache = new SWRCache({
     }
   },
   ttl: minutesToSeconds(1),
-  revalidationInterval: minutesToSeconds(2),
+  proactiveRevalidationInterval: minutesToSeconds(2),
   proactivelyInitialize: true,
 });

apps/ensapi/src/handlers/ensnode-api.ts

@@ -10,16 +10,13 @@ import {
 
 import { buildEnsApiPublicConfig } from "@/config/config.schema";
 import { factory } from "@/lib/hono-factory";
-import { makeLogger } from "@/lib/logger";
 
 import nameTokensApi from "./name-tokens-api";
 import registrarActionsApi from "./registrar-actions-api";
 import resolutionApi from "./resolution-api";
 
 const app = factory.createApp();
 
-const logger = makeLogger("ensnode-api");
-
 // include ENSApi Public Config endpoint
 app.get("/config", async (c) => {
   const ensApiPublicConfig = buildEnsApiPublicConfig(config);
@@ -34,14 +31,6 @@ app.get("/indexing-status", async (c) => {
   }
 
   if (c.var.indexingStatus instanceof Error) {
-    // no indexing status available in context
-    logger.error(
-      {
-        error: c.var.indexingStatus,
-      },
-      "Indexing status requested but is not available in context.",
-    );
-
     return c.json(
       serializeIndexingStatusResponse({
         responseCode: IndexingStatusResponseCodes.Error,

apps/ensapi/src/handlers/resolution-api.ts

@@ -13,7 +13,7 @@ import { factory } from "@/lib/hono-factory";
 import { resolveForward } from "@/lib/resolution/forward-resolution";
 import { resolvePrimaryNames } from "@/lib/resolution/multichain-primary-name-resolution";
 import { resolveReverse } from "@/lib/resolution/reverse-resolution";
-import { captureTrace } from "@/lib/tracing/protocol-tracing";
+import { runWithTrace } from "@/lib/tracing/tracing-api";
 import { canAccelerateMiddleware } from "@/middleware/can-accelerate.middleware";
 import { makeIsRealtimeMiddleware } from "@/middleware/is-realtime.middleware";
 
@@ -69,7 +69,7 @@ app.get(
     const { selection, trace: showTrace, accelerate } = c.req.valid("query");
     const canAccelerate = c.var.canAccelerate;
 
-    const { result, trace } = await captureTrace(() =>
+    const { result, trace } = await runWithTrace(() =>
       resolveForward(name, selection, { accelerate, canAccelerate }),
     );
 
@@ -117,7 +117,7 @@ app.get(
     const { trace: showTrace, accelerate } = c.req.valid("query");
     const canAccelerate = c.var.canAccelerate;
 
-    const { result, trace } = await captureTrace(() =>
+    const { result, trace } = await runWithTrace(() =>
       resolveReverse(address, chainId, { accelerate, canAccelerate }),
     );
 
@@ -163,7 +163,7 @@ app.get(
     const { chainIds, trace: showTrace, accelerate } = c.req.valid("query");
     const canAccelerate = c.var.canAccelerate;
 
-    const { result, trace } = await captureTrace(() =>
+    const { result, trace } = await runWithTrace(() =>
       resolvePrimaryNames(address, chainIds, { accelerate, canAccelerate }),
     );
 

apps/ensapi/src/index.ts

@@ -12,8 +12,8 @@ import { referrerLeaderboardCache } from "@/cache/referrer-leaderboard.cache";
 import { redactEnsApiConfig } from "@/config/redact";
 import { errorResponse } from "@/lib/handlers/error-response";
 import { factory } from "@/lib/hono-factory";
+import { sdk } from "@/lib/instrumentation";
 import logger from "@/lib/logger";
-import { sdk } from "@/lib/tracing/instrumentation";
 import { indexingStatusMiddleware } from "@/middleware/indexing-status.middleware";
 
 import ensanalyticsApi from "./handlers/ensanalytics-api";
@@ -32,7 +32,6 @@ app.use(async (ctx, next) => {
 app.use(cors({ origin: "*" }));
 
 // include automatic OpenTelemetry instrumentation for incoming requests
-// NOTE: required for protocol tracing
 app.use(otel());
 
 // add ENSIndexer Indexing Status Middleware to all routes for convenience
@@ -72,7 +71,7 @@ const server = serve(
       `ENSApi listening on port ${info.port} with config:\n${prettyPrintJson(redactEnsApiConfig(config))}`,
     );
 
-    // self-healthcheck to connect to ENSIndexer & warm Indexing Status / Can Accelerate cache
+    // self-healthcheck to connect to ENSIndexer & warm Indexing Status cache
     await app.request("/health");
   },
 );