logging: truncate long field names

Author: justinmk3

src/shared/clients/codecatalystClient.ts

@@ -29,7 +29,7 @@ import {
     ListSourceRepositoriesItem,
     ListSourceRepositoriesItems,
 } from 'aws-sdk/clients/codecatalyst'
-import { truncate } from '../utilities/textUtilities'
+import { truncateProps } from '../utilities/textUtilities'
 
 interface CodeCatalystConfig {
     readonly region: string
@@ -267,12 +267,17 @@ class CodeCatalystClientInternal {
                             'API request failed (time: %dms): %s\nparams: %O\nerror: %O\nheaders: %O',
                             timecost,
                             r.operation,
-                            r.params,
+                            truncateProps(r.params, 20, ['nextToken']),
                             errNoStack,
                             logHeaders
                         )
                     } else {
-                        log.error('API request failed (time: %dms):%O\nheaders: %O', timecost, req, logHeaders)
+                        log.error(
+                            'API request failed (time: %dms):%O\nheaders: %O',
+                            timecost,
+                            truncateProps(req, 20, ['nextToken']),
+                            logHeaders
+                        )
                     }
                     if (silent) {
                         if (defaultVal === undefined) {
@@ -285,19 +290,12 @@ class CodeCatalystClientInternal {
                     return
                 }
                 if (log.logLevelEnabled('verbose')) {
-                    const truncatedData = {
-                        ...data,
-                        nextToken: (data as any)?.nextToken ?? '',
-                    }
-                    if (truncatedData.nextToken && typeof truncatedData.nextToken === 'string') {
-                        truncatedData.nextToken = truncate(truncatedData.nextToken, 20)
-                    }
                     log.verbose(
                         'API request (time: %dms): %s\nparams: %O\nresponse: %O',
                         timecost,
                         r.operation ?? '?',
-                        r.params ?? '?',
-                        truncatedData
+                        r.params ? truncateProps(r.params, 20, ['nextToken']) : '?',
+                        truncateProps(data as object, 20, ['nextToken'])
                     )
                 }
                 resolve(data)

src/shared/utilities/textUtilities.ts

@@ -10,6 +10,63 @@ import { default as stripAnsi } from 'strip-ansi'
 import { isCloud9 } from '../extensionUtilities'
 import { getLogger } from '../logger'
 
+/**
+ * Truncates string `s` if it exceeds `len` chars.
+ *
+ * @param s String to truncate
+ * @param len Truncate top-level string properties exceeding this length
+ * @param suffix String appended to truncated value (default: "…")
+ */
+export function truncate(s: string, len: number, suffix?: string): string {
+    suffix = suffix ?? '…'
+    if (len <= 0) {
+        throw Error(`invalid len: ${len}`)
+    }
+    if (s === undefined || s.length <= len) {
+        return s
+    }
+    return `${s.substring(0, len)}${suffix}`
+}
+
+/**
+ * Creates a (shallow) clone of `obj` and truncates its top-level string properties.
+ *
+ * @param obj Object to copy and truncate
+ * @param len Truncate top-level string properties exceeding this length
+ * @param propNames Only truncate properties in this list
+ * @param suffix String appended to truncated values (default: "…")
+ */
+export function truncateProps(obj: object, len: number, propNames?: string[], suffix?: string): object {
+    if (len <= 0) {
+        throw Error(`invalid len: ${len}`)
+    }
+    // Shallow-copy to avoid modifying the original object.
+    const r = { ...obj }
+
+    if (propNames) {
+        for (const propName of propNames) {
+            try {
+                const val = (r as any)[propName]
+                if (val !== undefined && typeof val === 'string') {
+                    ;(r as any)[propName] = truncate(val, len, suffix)
+                }
+            } catch {
+                // Do nothing ("best effort").
+            }
+        }
+    } else {
+        for (const propName of Object.getOwnPropertyNames(r)) {
+            try {
+                ;(r as any)[propName] = truncate((r as any)[propName], len, suffix)
+            } catch {
+                // Do nothing ("best effort").
+            }
+        }
+    }
+
+    return r
+}
+
 export function removeAnsi(text: string): string {
     try {
         return stripAnsi(text)

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

@@ -4,7 +4,46 @@
  */
 
 import * as assert from 'assert'
-import { getRelativeDate, getStringHash, removeAnsi } from '../../../shared/utilities/textUtilities'
+import { getRelativeDate, getStringHash, removeAnsi, truncateProps } from '../../../shared/utilities/textUtilities'
+
+describe('textUtilities', async function () {
+    it('truncateProps()', async function () {
+        const testObj = {
+            a: 34234234234,
+            b: '123456789',
+            c: new Date(2023, 1, 1),
+            d: '123456789_abcdefg_ABCDEFG',
+            e: {
+                e1: [4, 3, 7],
+                e2: 'loooooooooo \n nnnnnnnnnnn \n gggggggg \n string',
+            },
+            f: () => {
+                throw Error()
+            },
+        }
+        const expected = {
+            ...testObj,
+            e: {
+                e1: [...testObj.e.e1],
+                e2: testObj.e.e2,
+            },
+        }
+
+        assert.deepStrictEqual(truncateProps(testObj, 25), expected)
+        assert.deepStrictEqual(truncateProps(testObj, 3, ['b']), {
+            ...expected,
+            b: '123…',
+        })
+        // Assert that original object didn't change.
+        assert.deepStrictEqual(truncateProps(testObj, 25), expected)
+
+        assert.deepStrictEqual(truncateProps(testObj, 3, ['a', 'b', 'd', 'f']), {
+            ...expected,
+            b: '123…',
+            d: '123…',
+        })
+    })
+})
 
 describe('removeAnsi', async function () {
     it('removes ansi code from text', async function () {