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

package/src/logging/ToolLogger.test.ts

@@ -21,6 +21,14 @@ describe('ToolLogger', () => {
     jest.clearAllMocks();
   });
 
+  // Helper function to check JSON string logs
+  const expectJsonLog = (expectedData: any) => {
+    expect(mockLogger.info).toHaveBeenCalledWith(
+      LogVisibility.Zaius,
+      JSON.stringify(expectedData)
+    );
+  };
+
   const createMockRequest = (overrides: any = {}): App.Request => {
     const defaultRequest = {
       path: '/test-tool',
@@ -59,16 +67,18 @@ describe('ToolLogger', () => {
 
       ToolLogger.logRequest(req);
 
+      const expectedLog = {
+        event: 'opal_tool_request',
+        path: '/test-tool',
+        parameters: {
+          name: 'test',
+          value: 'data'
+        }
+      };
+
       expect(mockLogger.info).toHaveBeenCalledWith(
         LogVisibility.Zaius,
-        expect.objectContaining({
-          event: 'opal_tool_request',
-          path: '/test-tool',
-          parameters: {
-            name: 'test',
-            value: 'data'
-          }
-        })
+        JSON.stringify(expectedLog)
       );
     });
 
@@ -79,14 +89,11 @@ describe('ToolLogger', () => {
 
       ToolLogger.logRequest(req);
 
-      expect(mockLogger.info).toHaveBeenCalledWith(
-        LogVisibility.Zaius,
-        expect.objectContaining({
-          event: 'opal_tool_request',
-          path: '/test-tool',
-          parameters: null
-        })
-      );
+      expectJsonLog({
+        event: 'opal_tool_request',
+        path: '/test-tool',
+        parameters: null
+      });
     });
 
     it('should use bodyJSON as parameters when no parameters field exists', () => {
@@ -99,15 +106,14 @@ describe('ToolLogger', () => {
 
       ToolLogger.logRequest(req);
 
-      expect(mockLogger.info).toHaveBeenCalledWith(
-        LogVisibility.Zaius,
-        expect.objectContaining({
-          parameters: {
-            name: 'direct',
-            action: 'test'
-          }
-        })
-      );
+      expectJsonLog({
+        event: 'opal_tool_request',
+        path: '/test-tool',
+        parameters: {
+          name: 'direct',
+          action: 'test'
+        }
+      });
     });
 
     it('should redact all sensitive field variations', () => {
@@ -132,25 +138,24 @@ describe('ToolLogger', () => {
 
       ToolLogger.logRequest(req);
 
-      expect(mockLogger.info).toHaveBeenCalledWith(
-        LogVisibility.Zaius,
-        expect.objectContaining({
-          parameters: {
-            username: 'john',
-            password: '[REDACTED]',
-            api_key: '[REDACTED]',
-            secret: '[REDACTED]',
-            token: '[REDACTED]',
-            auth: '[REDACTED]',
-            credentials: '[REDACTED]',
-            access_token: '[REDACTED]',
-            refresh_token: '[REDACTED]',
-            private_key: '[REDACTED]',
-            client_secret: '[REDACTED]',
-            normal_field: 'visible'
-          }
-        })
-      );
+      expectJsonLog({
+        event: 'opal_tool_request',
+        path: '/test-tool',
+        parameters: {
+          username: 'john',
+          password: '[REDACTED]',
+          api_key: '[REDACTED]',
+          secret: '[REDACTED]',
+          token: '[REDACTED]',
+          auth: '[REDACTED]',
+          credentials: '[REDACTED]',
+          access_token: '[REDACTED]',
+          refresh_token: '[REDACTED]',
+          private_key: '[REDACTED]',
+          client_secret: '[REDACTED]',
+          normal_field: 'visible'
+        }
+      });
     });
 
     it('should redact sensitive fields with case variations', () => {
@@ -170,20 +175,19 @@ describe('ToolLogger', () => {
 
       ToolLogger.logRequest(req);
 
-      expect(mockLogger.info).toHaveBeenCalledWith(
-        LogVisibility.Zaius,
-        expect.objectContaining({
-          parameters: {
-            PASSWORD: '[REDACTED]',
-            API_KEY: '[REDACTED]',
-            clientSecret: '[REDACTED]',
-            user_password: '[REDACTED]',
-            oauth_token: '[REDACTED]',
-            ssh_key: '[REDACTED]',
-            normal_field: 'visible'
-          }
-        })
-      );
+      expectJsonLog({
+        event: 'opal_tool_request',
+        path: '/test-tool',
+        parameters: {
+          PASSWORD: '[REDACTED]',
+          API_KEY: '[REDACTED]',
+          clientSecret: '[REDACTED]',
+          user_password: '[REDACTED]',
+          oauth_token: '[REDACTED]',
+          ssh_key: '[REDACTED]',
+          normal_field: 'visible'
+        }
+      });
     });
 
     it('should truncate long string values', () => {
@@ -199,15 +203,14 @@ describe('ToolLogger', () => {
 
       ToolLogger.logRequest(req);
 
-      expect(mockLogger.info).toHaveBeenCalledWith(
-        LogVisibility.Zaius,
-        expect.objectContaining({
-          parameters: {
-            description: `${'a'.repeat(100)}... (truncated, 150 chars total)`,
-            short_field: 'normal'
-          }
-        })
-      );
+      expectJsonLog({
+        event: 'opal_tool_request',
+        path: '/test-tool',
+        parameters: {
+          description: `${'a'.repeat(100)}... (truncated, 150 chars total)`,
+          short_field: 'normal'
+        }
+      });
     });
 
     it('should truncate large arrays', () => {
@@ -223,18 +226,17 @@ describe('ToolLogger', () => {
 
       ToolLogger.logRequest(req);
 
-      expect(mockLogger.info).toHaveBeenCalledWith(
-        LogVisibility.Zaius,
-        expect.objectContaining({
-          parameters: {
-            items: [
-              ...largeArray.slice(0, 10),
-              '... (5 more items truncated)'
-            ],
-            small_array: ['a', 'b']
-          }
-        })
-      );
+      expectJsonLog({
+        event: 'opal_tool_request',
+        path: '/test-tool',
+        parameters: {
+          items: [
+            ...largeArray.slice(0, 10),
+            '... (5 more items truncated)'
+          ],
+          small_array: ['a', 'b']
+        }
+      });
     });
 
     it('should handle nested objects with sensitive fields', () => {
@@ -260,26 +262,25 @@ describe('ToolLogger', () => {
 
       ToolLogger.logRequest(req);
 
-      expect(mockLogger.info).toHaveBeenCalledWith(
-        LogVisibility.Zaius,
-        expect.objectContaining({
-          parameters: {
-            user: {
-              name: 'John',
-              email: 'john@example.com',
+      expectJsonLog({
+        event: 'opal_tool_request',
+        path: '/test-tool',
+        parameters: {
+          user: {
+            name: 'John',
+            email: '[REDACTED]',
+            password: '[REDACTED]'
+          },
+          config: {
+            database: {
+              host: 'localhost',
+              port: 5432,
               password: '[REDACTED]'
             },
-            config: {
-              database: {
-                host: 'localhost',
-                port: 5432,
-                password: '[REDACTED]'
-              },
-              api_key: '[REDACTED]'
-            }
+            api_key: '[REDACTED]'
           }
-        })
-      );
+        }
+      });
     });
 
     it('should handle null and undefined values', () => {
@@ -298,19 +299,17 @@ describe('ToolLogger', () => {
 
       ToolLogger.logRequest(req);
 
-      expect(mockLogger.info).toHaveBeenCalledWith(
-        LogVisibility.Zaius,
-        expect.objectContaining({
-          parameters: {
-            nullValue: null,
-            undefinedValue: undefined,
-            emptyString: '',
-            zero: 0,
-            false: false,
-            password: '[REDACTED]'
-          }
-        })
-      );
+      expectJsonLog({
+        event: 'opal_tool_request',
+        path: '/test-tool',
+        parameters: {
+          nullValue: null,
+          emptyString: '',
+          zero: 0,
+          false: false,
+          password: '[REDACTED]'
+        }
+      });
     });
 
     it('should handle arrays in sensitive fields', () => {
@@ -325,15 +324,14 @@ describe('ToolLogger', () => {
 
       ToolLogger.logRequest(req);
 
-      expect(mockLogger.info).toHaveBeenCalledWith(
-        LogVisibility.Zaius,
-        expect.objectContaining({
-          parameters: {
-            credentials: '[REDACTED]',
-            public_list: ['item1', 'item2']
-          }
-        })
-      );
+      expectJsonLog({
+        event: 'opal_tool_request',
+        path: '/test-tool',
+        parameters: {
+          credentials: '[REDACTED]',
+          public_list: ['item1', 'item2']
+        }
+      });
     });
 
     it('should handle objects in sensitive fields', () => {
@@ -354,18 +352,17 @@ describe('ToolLogger', () => {
 
       ToolLogger.logRequest(req);
 
-      expect(mockLogger.info).toHaveBeenCalledWith(
-        LogVisibility.Zaius,
-        expect.objectContaining({
-          parameters: {
-            auth: '[REDACTED]',
-            public_config: {
-              timeout: 30,
-              retries: 3
-            }
+      expectJsonLog({
+        event: 'opal_tool_request',
+        path: '/test-tool',
+        parameters: {
+          auth: '[REDACTED]',
+          public_config: {
+            timeout: 30,
+            retries: 3
           }
-        })
-      );
+        }
+      });
     });
 
     it('should respect max depth to prevent infinite recursion', () => {
@@ -395,17 +392,19 @@ describe('ToolLogger', () => {
 
       ToolLogger.logResponse(req, response, 150);
 
+      const expectedLog = {
+        event: 'opal_tool_response',
+        path: '/test-tool',
+        duration: '150ms',
+        status: 200,
+        contentType: 'application/json',
+        contentLength: 34, // JSON.stringify({ result: 'success', data: 'test' }).length
+        success: true
+      };
+
       expect(mockLogger.info).toHaveBeenCalledWith(
         LogVisibility.Zaius,
-        expect.objectContaining({
-          event: 'opal_tool_response',
-          path: '/test-tool',
-          duration: '150ms',
-          status: 200,
-          contentType: 'application/json',
-          contentLength: 34, // JSON.stringify({ result: 'success', data: 'test' }).length
-          success: true
-        })
+        JSON.stringify(expectedLog)
       );
     });
 
@@ -415,16 +414,15 @@ describe('ToolLogger', () => {
 
       ToolLogger.logResponse(req, response, 75);
 
-      expect(mockLogger.info).toHaveBeenCalledWith(
-        LogVisibility.Zaius,
-        expect.objectContaining({
-          event: 'opal_tool_response',
-          path: '/test-tool',
-          duration: '75ms',
-          status: 400,
-          success: false
-        })
-      );
+      expectJsonLog({
+        event: 'opal_tool_response',
+        path: '/test-tool',
+        duration: '75ms',
+        status: 400,
+        contentType: 'application/json',
+        contentLength: 23,
+        success: false
+      });
     });
 
     it('should handle response without bodyJSON', () => {
@@ -434,13 +432,14 @@ describe('ToolLogger', () => {
 
       ToolLogger.logResponse(req, response);
 
-      expect(mockLogger.info).toHaveBeenCalledWith(
-        LogVisibility.Zaius,
-        expect.objectContaining({
-          contentLength: 0,
-          success: true
-        })
-      );
+      expectJsonLog({
+        event: 'opal_tool_response',
+        path: '/test-tool',
+        status: 204,
+        contentType: 'application/json',
+        contentLength: 0,
+        success: true
+      });
     });
 
     it('should handle response without processing time', () => {
@@ -449,12 +448,14 @@ describe('ToolLogger', () => {
 
       ToolLogger.logResponse(req, response);
 
-      expect(mockLogger.info).toHaveBeenCalledWith(
-        LogVisibility.Zaius,
-        expect.objectContaining({
-          duration: undefined
-        })
-      );
+      expectJsonLog({
+        event: 'opal_tool_response',
+        path: '/test-tool',
+        status: 200,
+        contentType: 'application/json',
+        contentLength: 15,
+        success: true
+      });
     });
 
     it('should handle unknown content type', () => {
@@ -464,12 +465,14 @@ describe('ToolLogger', () => {
 
       ToolLogger.logResponse(req, response);
 
-      expect(mockLogger.info).toHaveBeenCalledWith(
-        LogVisibility.Zaius,
-        expect.objectContaining({
-          contentType: 'unknown'
-        })
-      );
+      expectJsonLog({
+        event: 'opal_tool_response',
+        path: '/test-tool',
+        status: 200,
+        contentType: 'unknown',
+        contentLength: 15,
+        success: true
+      });
     });
 
     it('should handle content length calculation error', () => {
@@ -481,12 +484,14 @@ describe('ToolLogger', () => {
 
       ToolLogger.logResponse(req, response);
 
-      expect(mockLogger.info).toHaveBeenCalledWith(
-        LogVisibility.Zaius,
-        expect.objectContaining({
-          contentLength: 'unknown'
-        })
-      );
+      expectJsonLog({
+        event: 'opal_tool_response',
+        path: '/test-tool',
+        status: 200,
+        contentType: 'application/json',
+        contentLength: 'unknown',
+        success: true
+      });
     });
 
     it('should correctly identify success status codes', () => {
@@ -508,12 +513,14 @@ describe('ToolLogger', () => {
         const response = createMockResponse(status);
         ToolLogger.logResponse(req, response);
 
-        expect(mockLogger.info).toHaveBeenCalledWith(
-          LogVisibility.Zaius,
-          expect.objectContaining({
-            success: expected
-          })
-        );
+        expectJsonLog({
+          event: 'opal_tool_response',
+          path: '/test-tool',
+          status,
+          contentType: 'application/json',
+          contentLength: 2,
+          success: expected
+        });
       });
     });
 
@@ -534,12 +541,14 @@ describe('ToolLogger', () => {
 
         ToolLogger.logResponse(req, response);
 
-        expect(mockLogger.info).toHaveBeenCalledWith(
-          LogVisibility.Zaius,
-          expect.objectContaining({
-            contentType
-          })
-        );
+        expectJsonLog({
+          event: 'opal_tool_response',
+          path: '/test-tool',
+          status: 200,
+          contentType,
+          contentLength: 15,
+          success: true
+        });
       });
     });
   });
@@ -552,12 +561,11 @@ describe('ToolLogger', () => {
 
       ToolLogger.logRequest(req);
 
-      expect(mockLogger.info).toHaveBeenCalledWith(
-        LogVisibility.Zaius,
-        expect.objectContaining({
-          parameters: {}
-        })
-      );
+      expectJsonLog({
+        event: 'opal_tool_request',
+        path: '/test-tool',
+        parameters: {}
+      });
     });
 
     it('should handle request with only parameters field', () => {
@@ -571,14 +579,13 @@ describe('ToolLogger', () => {
 
       ToolLogger.logRequest(req);
 
-      expect(mockLogger.info).toHaveBeenCalledWith(
-        LogVisibility.Zaius,
-        expect.objectContaining({
-          parameters: {
-            field: 'value'
-          }
-        })
-      );
+      expectJsonLog({
+        event: 'opal_tool_request',
+        path: '/test-tool',
+        parameters: {
+          field: 'value'
+        }
+      });
     });
 
     it('should handle mixed data types in parameters', () => {
@@ -598,20 +605,19 @@ describe('ToolLogger', () => {
 
       ToolLogger.logRequest(req);
 
-      expect(mockLogger.info).toHaveBeenCalledWith(
-        LogVisibility.Zaius,
-        expect.objectContaining({
-          parameters: {
-            string: 'text',
-            number: 42,
-            boolean: true,
-            array: [1, 2, 3],
-            object: { nested: 'value' },
-            nullValue: null,
-            password: '[REDACTED]'
-          }
-        })
-      );
+      expectJsonLog({
+        event: 'opal_tool_request',
+        path: '/test-tool',
+        parameters: {
+          string: 'text',
+          number: 42,
+          boolean: true,
+          array: [1, 2, 3],
+          object: { nested: 'value' },
+          nullValue: null,
+          password: '[REDACTED]'
+        }
+      });
     });
   });
 });