@optimizely-opal/opal-tool-ocp-sdk 1.0.0-OCP-1442.1 → 1.0.0-OCP-1442.3

package/src/logging/ToolLogger.ts

@@ -6,7 +6,9 @@ import * as App from '@zaiusinc/app-sdk';
  */
 export class ToolLogger {
   private static readonly SENSITIVE_FIELDS = [
+    // Authentication / secrets
     'password',
+    'pass',
     'secret',
     'key',
     'token',
@@ -16,7 +18,34 @@ export class ToolLogger {
     'refresh_token',
     'api_key',
     'private_key',
-    'client_secret'
+    'client_secret',
+    'session_token',
+    'authorization',
+
+    // Payment-related
+    'card_number',
+    'credit_card',
+    'cvv',
+    'expiry_date',
+
+    // Personal info
+    'ssn', // social security number
+    'nid', // national ID
+    'passport',
+    'dob', // date of birth
+    'email',
+    'phone',
+    'address',
+
+    // Misc / environment
+    'otp',
+    'pin',
+    'security_answer',
+    'security_question',
+    'signing_key',
+    'encryption_key',
+    'jwt',
+    'bearer_token'
   ];
 
   private static readonly MAX_PARAM_LENGTH = 100;
@@ -31,8 +60,8 @@ export class ToolLogger {
     }
 
     if (typeof data === 'string') {
-      return data.length > this.MAX_PARAM_LENGTH
-        ? `${data.substring(0, this.MAX_PARAM_LENGTH)}... (truncated, ${data.length} chars total)`
+      return data.length > ToolLogger.MAX_PARAM_LENGTH
+        ? `${data.substring(0, ToolLogger.MAX_PARAM_LENGTH)}... (truncated, ${data.length} chars total)`
         : data;
     }
 
@@ -41,10 +70,10 @@ export class ToolLogger {
     }
 
     if (Array.isArray(data)) {
-      const truncated = data.slice(0, this.MAX_ARRAY_ITEMS);
-      const result = truncated.map((item) => this.redactSensitiveData(item, maxDepth - 1));
-      if (data.length > this.MAX_ARRAY_ITEMS) {
-        result.push(`... (${data.length - this.MAX_ARRAY_ITEMS} more items truncated)`);
+      const truncated = data.slice(0, ToolLogger.MAX_ARRAY_ITEMS);
+      const result = truncated.map((item) => ToolLogger.redactSensitiveData(item, maxDepth - 1));
+      if (data.length > ToolLogger.MAX_ARRAY_ITEMS) {
+        result.push(`... (${data.length - ToolLogger.MAX_ARRAY_ITEMS} more items truncated)`);
       }
       return result;
     }
@@ -53,12 +82,12 @@ export class ToolLogger {
       const result: any = {};
       for (const [key, value] of Object.entries(data)) {
         // Check if this field contains sensitive data
-        const isSensitive = this.isSensitiveField(key);
+        const isSensitive = ToolLogger.isSensitiveField(key);
 
         if (isSensitive) {
           result[key] = '[REDACTED]';
         } else {
-          result[key] = this.redactSensitiveData(value, maxDepth - 1);
+          result[key] = ToolLogger.redactSensitiveData(value, maxDepth - 1);
         }
       }
       return result;
@@ -72,7 +101,7 @@ export class ToolLogger {
    */
   private static isSensitiveField(fieldName: string): boolean {
     const lowerKey = fieldName.toLowerCase();
-    return this.SENSITIVE_FIELDS.some((sensitiveField) =>
+    return ToolLogger.SENSITIVE_FIELDS.some((sensitiveField) =>
       lowerKey.includes(sensitiveField)
     );
   }
@@ -85,23 +114,30 @@ export class ToolLogger {
       return null;
     }
 
-    return this.redactSensitiveData(params);
+    return ToolLogger.redactSensitiveData(params);
   }
 
   /**
    * Calculates content length of response data
    */
-  private static calculateContentLength(responseData?: any): number | string {
-    if (!responseData) {
+  private static calculateContentLength(response?: App.Response) {
+    if (!response) {
       return 0;
     }
 
     try {
-      const serialized = JSON.stringify(responseData);
-      return serialized.length;
+      if (response?.bodyJSON) {
+        const responseBodyJson = JSON.stringify(response.bodyJSON);
+        console.log('BodyJson length', responseBodyJson.length || 0);
+        return responseBodyJson.length;
+      }
     } catch {
+      console.log("Circular reference or JSON error, returning 'unknown'");
       return 'unknown';
     }
+
+    console.log('Body length', response.body?.length || 0);
+    return response.body?.length || 0;
   }
 
   /**
@@ -114,11 +150,11 @@ export class ToolLogger {
     const requestLog = {
       event: 'opal_tool_request',
       path: req.path,
-      parameters: this.createParameterSummary(params)
+      parameters: ToolLogger.createParameterSummary(params)
     };
 
     // Log with Zaius audience so developers only see requests for accounts they have access to
-    logger.info(LogVisibility.Zaius, requestLog);
+    logger.info(LogVisibility.Zaius, JSON.stringify(requestLog));
   }
 
   /**
@@ -129,18 +165,20 @@ export class ToolLogger {
     response: App.Response,
     processingTimeMs?: number
   ): void {
-
+    console.log('response', response);
+    console.log('response body json', response.bodyJSON);
+    console.log('response body', response.body);
     const responseLog = {
       event: 'opal_tool_response',
       path: req.path,
       duration: processingTimeMs ? `${processingTimeMs}ms` : undefined,
       status: response.status,
       contentType: response.headers?.get('content-type') || 'unknown',
-      contentLength: this.calculateContentLength(response.bodyJSON),
+      contentLength: ToolLogger.calculateContentLength(response),
       success: response.status >= 200 && response.status < 300
     };
 
     // Log with Zaius audience so developers only see requests for accounts they have access to
-    logger.info(LogVisibility.Zaius, responseLog);
+    logger.info(LogVisibility.Zaius, JSON.stringify(responseLog));
   }
 }