refactor(codewhisperer): recommendations logging #3888

Problem:
codewhisperer "recommendations" logging uses multiple logger calls and
the formatting is hard to read.

Solution:
- Use a single log statement.
- Indent the message parts so that related parts are visually grouped.

Before:

    2023-09-30 08:57:15 [DEBUG]: Request ID: ecc997a9-518a-47ae-a28b-ebbcd0aba39a,
                    timestamp(epoch): 1696089435380,
                    timezone: America/Los_Angeles,
                    datetime: 30/09/2023, 08:57:15,
                    vscode version: '1.82.2',
                    extension version: '1.92.0',
                    filename: 'samCliInvokerUtils.test.ts',
                    left context of line:  '...   SAM_CLI_TELEMETRY',
                    line number: 89,
                    character location: 34,
                    latency: 678.2888330221176 ms.
    2023-09-30 08:57:15 [VERBOSE]: Recommendations:
    2023-09-30 08:57:15 [VERBOSE]: [0]
     telemetryEnabled ? '1' : 'x',
                    AWS_REGION: 'us-east-1',
                    ...(telemetryEnabled ? {} : { SAM_CLI_TELEMETRY: 'x' })
                }
    2023-09-30 08:57:15 [VERBOSE]: [1]
     telemetryEnabled ? '1' : '0',
                    AWS_REGION: 'us-east-1',
                    ...(telemetryEnabled ? {} : { SAM_CLI_TELEMETRY: 'x' })
                }

After:

    2023-10-11 11:57:30 [DEBUG]: Request ID: 90c8184d-f67d-463a-a690-629dc2ffb8cb,
        timestamp(epoch): 1697050650338,
        timezone: America/Los_Angeles,
        datetime: 11/10/2023, 11:57:30,
        vscode version: '1.83.0',
        extension version: 'testPluginVersion',
        filename: 'Function.cs',
        left context of line:  '            ',
        line number: 23,
        character location: 12,
        latency: 786.2914998531342 ms.
        Recommendations:
        00: client.DefaultRequestHeaders.Accept.Add(new System.Net.Http.Headers.MediaTypeWithQualityHeaderValue("application/json"));
            client.DefaultRequestHeaders.Add("User-Agent", "AWS Lambda .Net Client");
        01: client.DefaultRequestHeaders.Add("User-Agent", "AWS Lambda .Net Client");
            client.DefaultRequestHeaders.Accept.Add(new System.Net.Http.Headers.MediaTypeWithQualityHeaderValue("application/json"));

Author: justinmk3

src/codewhisperer/service/recommendationHandler.ts

@@ -38,6 +38,7 @@ import { AuthUtil } from '../util/authUtil'
 import { CodeWhispererUserGroupSettings } from '../util/userGroupUtil'
 import { CWInlineCompletionItemProvider } from './inlineCompletionItemProvider'
 import { application } from '../util/codeWhispererApplication'
+import { indent } from '../../shared/utilities/textUtilities'
 
 /**
  * This class is for getRecommendation/listRecommendation API calls and its states
@@ -270,8 +271,9 @@ export class RecommendationHandler {
             }
         } finally {
             const timezone = Intl.DateTimeFormat().resolvedOptions().timeZone
-            getLogger().debug(
-                `Request ID: ${requestId},
+
+            let msg = indent(
+                `codewhisperer: request-id: ${requestId},
                 timestamp(epoch): ${Date.now()},
                 timezone: ${timezone},
                 datetime: ${new Date().toLocaleString([], { timeZone: timezone })},
@@ -281,12 +283,16 @@ export class RecommendationHandler {
                 left context of line:  '${session.leftContextOfCurrentLine}',
                 line number: ${session.startPos.line},
                 character location: ${session.startPos.character},
-                latency: ${latency} ms.`
-            )
-            getLogger().verbose('Recommendations:')
+                latency: ${latency} ms.
+                Recommendations:`,
+                4,
+                true
+            ).trimStart()
             recommendations.forEach((item, index) => {
-                getLogger().verbose(`[${index}]\n${item.content.trimRight()}`)
+                msg += `\n    ${index.toString().padStart(2, '0')}: ${indent(item.content, 8, true).trim()}`
             })
+            getLogger().debug(msg)
+
             if (invocationResult === 'Succeeded') {
                 CodeWhispererCodeCoverageTracker.getTracker(session.language)?.incrementServiceInvocationCount()
             }

src/shared/utilities/textUtilities.ts

@@ -30,6 +30,25 @@ export function truncate(s: string, n: number, suffix?: string): string {
     return n < 0 ? suffix + truncated : truncated + suffix
 }
 
+/**
+ * Indents a string.
+ *
+ * @param size Indent width (number of space chars).
+ * @param clear Clear existing whitespace, if any.
+ * @param s Text to indent.
+ */
+export function indent(s: string, size: number = 4, clear: boolean = false): string {
+    const n = Math.abs(size)
+    const spaces = ''.padEnd(n, ' ')
+    if (size < 0) {
+        throw Error() // TODO: implement "dedent" for negative size.
+    }
+    if (clear) {
+        return s.replace(/^[ \t]*([^\n])/, `${spaces}$1`).replace(/(\n+)[ \t]*([^ \t\n])/g, `$1${spaces}$2`)
+    }
+    return spaces + s.replace(/(\n+)(.)/g, `$1${spaces}$2`)
+}
+
 /**
  * Creates a (shallow) clone of `obj` and truncates its top-level string properties.
  *

src/test/shared/utilities/textUtilities.test.ts

@@ -10,6 +10,7 @@ import {
     removeAnsi,
     truncate,
     truncateProps,
+    indent,
 } from '../../../shared/utilities/textUtilities'
 
 describe('textUtilities', async function () {
@@ -59,6 +60,14 @@ describe('textUtilities', async function () {
         assert.deepStrictEqual(truncate('abc 123', 99), 'abc 123')
         assert.deepStrictEqual(truncate('abc 123', -99), 'abc 123')
     })
+
+    it('indent()', async function () {
+        assert.deepStrictEqual(indent('abc\n123', 2, false), '  abc\n  123')
+        assert.deepStrictEqual(indent('abc\n 123\n', 2, false), '  abc\n   123\n')
+        assert.deepStrictEqual(indent('abc\n 123\n', 2, true), '  abc\n  123\n')
+        assert.deepStrictEqual(indent('   abc\n\n  \n123\nfoo\n', 4, false), '       abc\n\n      \n    123\n    foo\n')
+        assert.deepStrictEqual(indent('   abc\n\n    \n123\nfoo\n', 4, true), '    abc\n\n    \n    123\n    foo\n')
+    })
 })
 
 describe('removeAnsi', async function () {