feat: gRPC transport logging

package.json

@@ -870,7 +870,7 @@
   "dependencies": {
     "@deephaven-enterprise/auth-nodejs": "^1.20240723.124-beta",
     "@deephaven-enterprise/query-utils": "^1.20240723.124-beta",
-    "@deephaven/jsapi-nodejs": "^0.103.0",
+    "@deephaven/jsapi-nodejs": "^0.104.0",
     "nanoid": "^5.0.7"
   },
   "devDependencies": {

src/common/constants.ts

@@ -9,6 +9,8 @@ export const CONFIG_KEY = {
   enterpriseServers: 'enterpriseServers',
 } as const;
 
+export const CENSORED_TEXT = '********' as const;
+
 export const DEFAULT_CONSOLE_TYPE = 'python' as const;
 // export const DHFS_SCHEME = 'dhfs';
 

src/controllers/ExtensionController.ts

@@ -34,6 +34,7 @@ import {
   isSupportedLanguageId,
   Logger,
   OutputChannelWithHistory,
+  sanitizeGRPCLogMessageArgs,
   Toaster,
 } from '../util';
 import {
@@ -107,6 +108,8 @@ export class ExtensionController implements Disposable {
     this.initializeWebViews();
     this.initializeServerUpdates();
 
+    this._context.subscriptions.push(NodeHttp2gRPCTransport);
+
     logger.info(
       'Congratulations, your extension "vscode-deephaven" is now active!'
     );
@@ -317,6 +320,14 @@ export class ExtensionController implements Disposable {
     Logger.addConsoleHandler();
     Logger.addOutputChannelHandler(this._outputChannelDebug);
 
+    const gRPCOutputChannelHandler = Logger.createOutputChannelHandler(
+      this._outputChannelDebug
+    );
+    NodeHttp2gRPCTransport.onLogMessage((logLevel, ...args: unknown[]) => {
+      args = sanitizeGRPCLogMessageArgs(args);
+      gRPCOutputChannelHandler(logLevel)('[NodeHttp2gRPCTransport]', ...args);
+    });
+
     this._toaster = new Toaster();
 
     this._context.subscriptions.push(

src/controllers/PanelController.ts

@@ -19,6 +19,7 @@ import {
 } from '../util';
 import { DhcService } from '../services';
 import {
+  CENSORED_TEXT,
   DEEPHAVEN_POST_MSG,
   DH_PANEL_VIEW_TYPE,
   OPEN_VARIABLE_PANELS_CMD,
@@ -161,7 +162,16 @@ export class PanelController extends ControllerBase {
         workerInfo,
       });
 
-      logger.debug('Posting LoginOptions response:', response);
+      logger.debug('Posting LoginOptions response:', {
+        ...response,
+        payload: {
+          ...response.payload,
+          payload: {
+            ...response.payload.payload,
+            token: CENSORED_TEXT,
+          },
+        },
+      });
 
       postResponseMessage(response);
 

src/util/Logger.ts

@@ -41,19 +41,50 @@ export class Logger {
     });
   };
 
+  /**
+   * Stringify an argument for logging.
+   * @param arg The argument to stringify.
+   * @returns The stringified argument.
+   */
+  static stringifyArg = (arg: unknown): string => {
+    if (arg instanceof Error) {
+      return arg.stack ?? arg.message;
+    }
+
+    if (typeof arg === 'string') {
+      return arg;
+    }
+
+    try {
+      return JSON.stringify(arg);
+    } catch {
+      return String(arg);
+    }
+  };
+
+  /**
+   * Create a log handler that logs to a `vscode.OutputChannel`.
+   * @param outputChannel The output channel to log to.
+   * @returns A log handler that logs to the output channel.
+   */
+  static createOutputChannelHandler = (
+    outputChannel: vscode.OutputChannel
+  ): ((level: LogLevel) => LogLevelHandler) => {
+    return (level: LogLevel): LogLevelHandler =>
+      (label, ...args) =>
+        outputChannel.appendLine(
+          `${label} ${level.toUpperCase()}: ${args.map(Logger.stringifyArg).join(' ')}`
+        );
+  };
+
   /**
    * Register a log handler that logs to a `vscode.OutputChannel`.
    * @param outputChannel
    */
   static addOutputChannelHandler = (
     outputChannel: vscode.OutputChannel
   ): void => {
-    const createHandler =
-      (level: LogLevel): LogLevelHandler =>
-      (label, ...args) =>
-        outputChannel.appendLine(
-          `${label} ${level.toUpperCase()}: ${args.map(a => (a instanceof Error ? (a.stack ?? a.message) : a)).join(' ')}`
-        );
+    const createHandler = Logger.createOutputChannelHandler(outputChannel);
 
     Logger.handlers.add({
       error: createHandler('error'),

src/util/dataUtils.ts

@@ -1,5 +1,18 @@
 import type { NonEmptyArray } from '../types';
 
+/**
+ * Type guard to determine if an object has a property.
+ * @param obj The object to check.
+ * @param prop The property to check for.
+ * @returns true if the property exists, false otherwise.
+ */
+export function hasProperty<TProp extends string>(
+  obj: unknown,
+  prop: TProp
+): obj is Record<TProp, unknown> {
+  return obj != null && typeof obj === 'object' && prop in obj;
+}
+
 /**
  * Type guard to check if an array is non-empty.
  * @param array

src/util/index.ts

@@ -7,6 +7,7 @@ export * from './Logger';
 export * from './OutputChannelWithHistory';
 export * from './panelUtils';
 export * from './promiseUtils';
+export * from './sanitizeUtils';
 export * from './selectionUtils';
 export * from './serverUtils';
 export * from './testUtils';

src/util/sanitizeUtils.ts

@@ -0,0 +1,61 @@
+import { CENSORED_TEXT } from '../common';
+import { hasProperty } from './dataUtils';
+
+/**
+ * Sanitize an auth header value.
+ * @param authHeaderValue Sanitize secret portion of known auth headers. If
+ * unrecognized, replace the whole thing.
+ * @returns The sanitized auth header value.
+ */
+export function sanitizeAuthHeaderValue(authHeaderValue: string): string {
+  if (
+    authHeaderValue.startsWith('io.deephaven.proto.auth.Token') ||
+    authHeaderValue.startsWith('Bearer')
+  ) {
+    return authHeaderValue.replace(/ \S+$/, ` ${CENSORED_TEXT}`);
+  }
+
+  return CENSORED_TEXT;
+}
+
+/**
+ * Sanitize an auth header.
+ * @param authorization The authorization header value. This can be a string
+ * or an array of strings. Any other data types will be treated as an empty
+ * string.
+ * @returns The sanitized auth header value.
+ */
+export function sanitizeAuthHeader(authorization: unknown): string | string[] {
+  if (typeof authorization === 'string') {
+    return sanitizeAuthHeaderValue(authorization);
+  }
+
+  if (Array.isArray(authorization)) {
+    return authorization.map(sanitizeAuthHeaderValue);
+  }
+
+  return CENSORED_TEXT;
+}
+
+/**
+ * Sanitize auth headers in a gRPC log message.
+ * @param args The arguments to sanitize.
+ * @returns The sanitized arguments.
+ */
+export function sanitizeGRPCLogMessageArgs([
+  arg0,
+  arg1,
+  ...args
+]: unknown[]): unknown[] {
+  if (arg0 === 'start' && hasProperty(arg1, 'authorization')) {
+    return [
+      arg0,
+      {
+        ...arg1,
+        authorization: sanitizeAuthHeader(arg1.authorization),
+      },
+    ];
+  }
+
+  return [arg0, arg1, ...args];
+}