rename to formatObj

Author: Hweinstock

packages/core/src/codewhispererChat/controllers/chat/controller.ts

@@ -53,7 +53,7 @@ import { uiEventRecorder } from '../../../amazonq/util/eventRecorder'
 import { globals } from '../../../shared'
 import { telemetry } from '../../../shared/telemetry'
 import { isSsoConnection } from '../../../auth/connection'
-import * as util from 'util'
+import { formatObj } from '../../../shared/utilities/collectionUtils'
 
 export interface ChatControllerMessagePublishers {
     readonly processPromptChatMessage: MessagePublisher<PromptMessage>
@@ -652,7 +652,7 @@ export class ChatController {
         const request = triggerPayloadToChatRequest(triggerPayload)
         const session = this.sessionStorage.getSession(tabID)
         getLogger().info(
-            `request from tab: ${tabID} conversationID: ${session.sessionIdentifier} request: ${util.inspect(request, { depth: 12 })}`
+            `request from tab: ${tabID} conversationID: ${session.sessionIdentifier} request: ${formatObj(request, { depth: 12 })}`
         )
         let response: MessengerResponseType | undefined = undefined
         session.createNewTokenSource()
@@ -678,7 +678,7 @@ export class ChatController {
             getLogger().info(
                 `response to tab: ${tabID} conversationID: ${session.sessionIdentifier} requestID: ${
                     response.$metadata.requestId
-                } metadata: ${util.inspect(response.$metadata, { depth: 12 })}`
+                } metadata: ${formatObj(response.$metadata, { depth: 12 })}`
             )
             await this.messenger.sendAIResponse(response, session, tabID, triggerID, triggerPayload)
         } catch (e: any) {

packages/core/src/shared/utilities/collectionUtils.ts

@@ -343,7 +343,7 @@ type inspectOptions = Partial<{
  * @param obj object to show
  * @param opt options for showing (ex. depth, omitting keys)
  */
-export function inspect(obj: any, opt?: inspectOptions): string {
+export function formatObj(obj: any, opt?: inspectOptions): string {
     const options = {
         depth: opt?.depth ?? 3,
         omitKeys: opt?.omitKeys ?? [],

packages/core/src/test/shared/utilities/collectionUtils.test.ts

@@ -31,7 +31,7 @@ import {
     joinAll,
     isPresent,
     partialClone,
-    inspect,
+    formatObj,
 } from '../../../shared/utilities/collectionUtils'
 
 import { asyncGenerator } from '../../../shared/utilities/collectionUtils'
@@ -699,18 +699,18 @@ describe('CollectionUtils', async function () {
         })
 
         it('defaults to a depth of 3', function () {
-            assert.strictEqual(inspect(testData), '{ root: { A: { B: {} } } }')
+            assert.strictEqual(formatObj(testData), '{ root: { A: { B: {} } } }')
         })
 
         it('allows depth to be set manually', function () {
             assert.strictEqual(
-                inspect(testData, { depth: 6 }),
+                formatObj(testData, { depth: 6 }),
                 "{\n  root: {\n    A: {\n      B: { C: { D: { E: 'data' } } }\n    }\n  }\n}"
             )
         })
 
         it('omits keys specified', function () {
-            assert.strictEqual(inspect(testData, { omitKeys: ['D', 'C'] }), '{ root: { A: { B: {} } } }')
+            assert.strictEqual(formatObj(testData, { omitKeys: ['D', 'C'] }), '{ root: { A: { B: {} } } }')
         })
     })