fixup! fixup! fixup! feat(deno): redis diagnostics channel based integration for deno (#21087)

Author: isaacs

packages/core/src/integrations/redis/redis-statement-serializer.ts

@@ -41,8 +41,8 @@ export function defaultDbStatementSerializer(
   if (!Array.isArray(cmdArgs) || cmdArgs.length === 0) return cmdName;
 
   const budget = SERIALIZATION_SUBSETS.find(({ regex }) => regex.test(cmdName))?.args ?? 0;
-  const argsToSerialize: Array<string | Uint8Array | number | unknown[]> =
-    budget >= 0 ? cmdArgs.slice(0, budget) : cmdArgs.slice();
+  const argsToSerialize: Array<string | number | unknown[]> = (budget >= 0 ? cmdArgs.slice(0, budget) : cmdArgs.slice())
+    .map(a => (a instanceof Uint8Array ? '<binary>' : a)) as Array<string | number | unknown[]>;
   if (cmdArgs.length > argsToSerialize.length) {
     argsToSerialize.push(`[${cmdArgs.length - budget} other arguments]`);
   }

packages/deno/src/denoVersion.ts

@@ -20,3 +20,6 @@ export const HTTP_CLIENT_DIAGNOSTICS_CHANNEL_SUPPORTED = gte(2, 7, 13);
 
 /** Whether `http.server.request.start` fires (Deno 2.8.0+). */
 export const HTTP_SERVER_DIAGNOSTICS_CHANNEL_SUPPORTED = gte(2, 8, 0);
+
+/** Whether `node:diagnostics_channel.tracingChannel` exists (Deno 1.44.3+). */
+export const TRACING_CHANNEL_SUPPORTED = gte(1, 44, 3);

packages/deno/src/integrations/redis.ts

@@ -1,4 +1,7 @@
-import { tracingChannel as nativeTracingChannel } from 'node:diagnostics_channel';
+// * import so that loading this module doesn't error on Deno versions
+// lacking `tracingChannel` (added in Deno 1.44.3).
+// On older runtimes the integration becomes a no-op.
+import * as dc from 'node:diagnostics_channel';
 import type {
   Integration,
   IntegrationFn,
@@ -34,7 +37,7 @@ const portableTracingChannel: RedisTracingChannelFactory = <T extends object>(
   name: string,
   transformStart: (data: T) => Span,
 ): RedisTracingChannel<T> => {
-  const channel = nativeTracingChannel<DataWithSpan<T>>(name);
+  const channel = dc.tracingChannel<DataWithSpan<T>>(name);
   return {
     subscribe(subs: Partial<RedisTracingChannelSubscribers<T>>): void {
       const userStart = subs.start as SubscriberFn<T> | undefined;
@@ -59,6 +62,9 @@ const _denoRedisIntegration = ((options: DenoRedisIntegrationOptions = {}) => {
   return {
     name: INTEGRATION_NAME,
     setupOnce() {
+      if (!dc.tracingChannel) {
+        return;
+      }
       setAsyncLocalStorageAsyncContextStrategy();
       subscribeRedisDiagnosticChannels(portableTracingChannel, options.responseHook);
     },

packages/deno/src/sdk.ts

@@ -16,7 +16,11 @@ import { DenoClient } from './client';
 import { breadcrumbsIntegration } from './integrations/breadcrumbs';
 import { denoContextIntegration } from './integrations/context';
 import { contextLinesIntegration } from './integrations/contextlines';
-import { HTTP_CLIENT_DIAGNOSTICS_CHANNEL_SUPPORTED, HTTP_SERVER_DIAGNOSTICS_CHANNEL_SUPPORTED } from './denoVersion';
+import {
+  HTTP_CLIENT_DIAGNOSTICS_CHANNEL_SUPPORTED,
+  HTTP_SERVER_DIAGNOSTICS_CHANNEL_SUPPORTED,
+  TRACING_CHANNEL_SUPPORTED,
+} from './denoVersion';
 import { denoServeIntegration } from './integrations/deno-serve';
 import { denoHttpIntegration } from './integrations/http';
 import { denoRedisIntegration } from './integrations/redis';
@@ -48,7 +52,8 @@ export function getDefaultIntegrations(_options: Options): Integration[] {
     ...(HTTP_CLIENT_DIAGNOSTICS_CHANNEL_SUPPORTED || HTTP_SERVER_DIAGNOSTICS_CHANNEL_SUPPORTED
       ? [denoHttpIntegration()]
       : []),
-    denoRedisIntegration(),
+    // node:diagnostics_channel.tracingChannel exists on Deno 1.44.3+.
+    ...(TRACING_CHANNEL_SUPPORTED ? [denoRedisIntegration()] : []),
     contextLinesIntegration(),
     normalizePathsIntegration(),
     globalHandlersIntegration(),

packages/node/src/utils/redisCache.ts

@@ -38,8 +38,10 @@ export function getCacheKeySafely(redisCommand: string, cmdArgs: IORedisCommandA
 
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     const processArg = (arg: string | Buffer | Uint8Array | number | any[]): string[] => {
-      if (typeof arg === 'string' || typeof arg === 'number' || Buffer.isBuffer(arg)) {
+      if (typeof arg === 'string' || typeof arg === 'number') {
         return [arg.toString()];
+      } else if (arg instanceof Uint8Array) {
+        return [new TextDecoder().decode(arg)];
       } else if (Array.isArray(arg)) {
         return flatten(arg.map(arg => processArg(arg)));
       } else {