Update based on feedback

Author: minhanh-phan

src/core.ts

@@ -130,7 +130,7 @@ export class APIPromise<T> extends Promise<WithRequestID<T>> {
    * instance, you can use {@link withResponse()}.
    *
    * 👋 Getting the wrong TypeScript type for `Response`?
-   * Try setting `"moduleResolution": "NodeNext"` if you can,
+   * Try setting `'moduleResolution': 'NodeNext'` if you can,
    * or add one of these imports before your first `import … from 'openai'`:
    * - `import 'openai/shims/node'` (if you're running on Node)
    * - `import 'openai/shims/web'` (otherwise)
@@ -149,7 +149,7 @@ export class APIPromise<T> extends Promise<WithRequestID<T>> {
    *
    *
    * 👋 Getting the wrong TypeScript type for `Response`?
-   * Try setting `"moduleResolution": "NodeNext"` if you can,
+   * Try setting `'moduleResolution': 'NodeNext'` if you can,
    * or add one of these imports before your first `import … from 'openai'`:
    * - `import 'openai/shims/node'` (if you're running on Node)
    * - `import 'openai/shims/web'` (otherwise)
@@ -1117,7 +1117,7 @@ export function hasOwn(obj: Object, key: string): boolean {
 }
 
 /**
- * Copies headers from "newHeaders" onto "targetHeaders",
+ * Copies headers from 'newHeaders' onto 'targetHeaders',
  * using lower-case for all properties,
  * ignoring any keys with undefined values,
  * and deleting any keys with null values.
@@ -1138,28 +1138,33 @@ function applyHeadersMut(targetHeaders: Headers, newHeaders: Headers): void {
   }
 }
 
+const SENSITIVE_HEADERS = new Set(['authorization', 'api-key']);
+
 export function debug(action: string, ...args: any[]) {
-  const sensitiveHeaders = ["authorization", "api-key"];
   if (typeof process !== 'undefined' && process?.env?.['DEBUG'] === 'true') {
-    for (const arg of args) {
+    const modifiedArgs = args.map((arg) => {
       if (!arg) {
-        break;
+        return arg;
       }
-      // Check for sensitive headers in request body "headers"
-      if (arg["headers"]) {
-        for (const header in arg["headers"]){
-          if (sensitiveHeaders.includes(header.toLowerCase())){
-            arg["headers"][header] = "REDACTED";
+
+      const modifiedArg = { ...arg };
+      // Check for sensitive headers in request body 'headers' object
+      if (modifiedArg['headers']) {
+        for (const header in modifiedArg['headers']){
+          if (SENSITIVE_HEADERS.has(header.toLowerCase())){
+            modifiedArg['headers'][header] = 'REDACTED';
           }
         }
       }
       // Check for sensitive headers in headers object
-      for (const header in arg){
-        if (sensitiveHeaders.includes(header.toLowerCase())){
-          arg[header] = "REDACTED";
+      for (const header in modifiedArg){
+        if (SENSITIVE_HEADERS.has(header.toLowerCase())){
+          modifiedArg[header] = 'REDACTED';
         }
       }
-    }
+      return modifiedArg;
+    })
+    console.log(`OpenAI:DEBUG:${action}`, ...modifiedArgs);
   }
 }
 

tests/index.test.ts

@@ -2,7 +2,7 @@
 
 import OpenAI from 'openai';
 import { APIUserAbortError } from 'openai';
-import { Headers } from 'openai/core';
+import { debug, Headers } from 'openai/core';
 import defaultFetch, { Response, type RequestInit, type RequestInfo } from 'node-fetch';
 
 describe('instantiate client', () => {
@@ -411,3 +411,60 @@ describe('retries', () => {
     expect(count).toEqual(3);
   });
 });
+
+describe('Debug', () => {
+  const env = process.env;
+  const spy = jest.spyOn(console, 'log');
+
+  beforeEach(() => {
+    jest.resetModules();
+    process.env = { ...env };
+    process.env['DEBUG']= 'true';
+  });
+
+  afterEach(() => {
+    process.env = env;
+  });
+
+  test('body request object with Authorization header', function(){
+    // Test request body includes headers object with Authorization
+    const headersTest = {
+      headers: {
+        Authorization: 'fakeAuthorization'
+      }
+    }
+    debug('request', headersTest);
+    expect(spy).toHaveBeenCalledWith('OpenAI:DEBUG:request', {
+      headers: {
+        Authorization: 'REDACTED'
+      }
+    });
+  });
+  
+  test('body request object with api-key header', function(){
+    // Test request body includes headers object with api-ley
+    const apiKeyTest = {
+      headers: {
+        'api-key': 'fakeKey'
+      }
+    }
+    debug('request', apiKeyTest);
+    expect(spy).toHaveBeenCalledWith('OpenAI:DEBUG:request', {
+      headers: {
+        'api-key': 'REDACTED'
+      }
+    });
+  });
+  
+  test('header object with Authorization header', function(){
+    // Test headers object with authorization header
+    const authorizationTest = {
+      authorization: 'fakeValue'
+    }
+    debug('request', authorizationTest);
+    expect(spy).toHaveBeenCalledWith('OpenAI:DEBUG:request', {
+      authorization: 'REDACTED'
+    });
+  });
+
+});

tests/qs/utils.test.ts

@@ -1,4 +1,3 @@
-import { debug } from 'openai/core';
 import { combine, merge, is_buffer, assign_single_source } from 'openai/internal/qs/utils';
 
 describe('merge()', function () {
@@ -168,50 +167,3 @@ test('is_buffer()', function () {
   // t.equal(is_buffer(buffer), true, 'real Buffer instance is a buffer');
   expect(is_buffer(buffer)).toEqual(true);
 });
-
-test("debug()", function(){
-  const originalDebugValue = process.env["DEBUG"];
-
-  const spy = jest.spyOn(console, "log");
-
-  // Debug enabled
-  process.env["DEBUG"]= "true";
-
-  // Test request body includes headers object with Authorization
-  const headersTest = {
-    headers: {
-      Authorization: "fakeAuthorization"
-    }
-  }
-  debug("request", headersTest);
-  expect(spy).toHaveBeenCalledWith("OpenAI:DEBUG:request", {
-    headers: {
-      Authorization: "REDACTED"
-    }
-  });
-
-  // Test request body includes headers object with api-ley
-  const apiKeyTest = {
-    headers: {
-      "api-key": "fakeKey"
-    }
-  }
-  debug("request", apiKeyTest);
-  expect(spy).toHaveBeenCalledWith("OpenAI:DEBUG:request", {
-    headers: {
-      "api-key": "REDACTED"
-    }
-  });
-
-  // Test headers object with authorization header
-  const authorizationTest = {
-    authorization: "fakeValue"
-  }
-  debug("request", authorizationTest);
-  expect(spy).toHaveBeenCalledWith("OpenAI:DEBUG:request", {
-    authorization: "REDACTED"
-  });
-
-  process.env["DEBUG"] = originalDebugValue;
-
-})