refactor: Cherry-pick latest log export changes into v0.85 (#2399)

Cherry-pick changes made to `LogExport.ts` in `main` into `v0.85` to
address [DH-19079](https://deephaven.atlassian.net/browse/DH-19079)
- fix: avoid exceeding call stack when exporting logs with large number
of queries (#2382)
- feat: Allow wildcards for logs blacklist (#2396)

[DH-19079]:
https://deephaven.atlassian.net/browse/DH-19079?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ

---------

Co-authored-by: dgodinez-dh <[email protected]>

Author: ericlln

packages/log/src/LogExport.test.ts

@@ -87,4 +87,94 @@ describe('getReduxDataString', () => {
     );
     expect(result).toBe(expected);
   });
+
+  it('should handle wildcards in blacklist paths', () => {
+    const reduxData = {
+      key1: 'not blacklisted',
+      key2: {
+        keyA: {
+          key1: 'blacklisted',
+        },
+        keyB: {
+          key1: 'blacklisted',
+        },
+        keyC: {
+          key1: 'blacklisted',
+        },
+      },
+    };
+    const result = getReduxDataString(reduxData, [['key2', '*', 'key1']]);
+    const expected = JSON.stringify(
+      {
+        key1: 'not blacklisted',
+        key2: {
+          keyA: {},
+          keyB: {},
+          keyC: {},
+        },
+      },
+      null,
+      2
+    );
+    expect(result).toBe(expected);
+  });
+
+  it('should handle nested wildcards in blacklist paths', () => {
+    const reduxData = {
+      key1: 'not blacklisted',
+      key2: {
+        keyA: {
+          key1: 'blacklisted',
+          key2: {
+            key3: 'blacklisted',
+          },
+        },
+        keyB: {
+          key1: 'blacklisted',
+          key2: {
+            key3: 'blacklisted',
+            key4: 'blacklisted',
+          },
+        },
+      },
+    };
+    const result = getReduxDataString(reduxData, [['key2', '*', '*']]);
+    const expected = JSON.stringify(
+      {
+        key1: 'not blacklisted',
+        key2: {
+          keyA: {},
+          keyB: {},
+        },
+      },
+      null,
+      2
+    );
+    expect(result).toBe(expected);
+  });
+
+  it('should handle wildcard blacklist paths with no matches', () => {
+    const reduxData = {
+      key1: 'not blacklisted',
+      key2: {
+        keyA: {
+          key1: 'not blacklisted',
+          key2: {
+            key3: 'not blacklisted',
+          },
+        },
+      },
+    };
+    const result = getReduxDataString(reduxData, [['*', '*', '*', '*', '*']]); // Matching more than the depth of the object
+    const expected = JSON.stringify(reduxData, null, 2);
+    expect(result).toBe(expected);
+  });
+
+  it('root wildcard should blacklist all', () => {
+    const reduxData = {
+      key1: 'should not be blacklisted',
+    };
+    const result = getReduxDataString(reduxData, [['*']]);
+    expect(result).toBe('{}');
+  });
 });

packages/log/src/LogExport.ts

@@ -3,11 +3,12 @@ import type LogHistory from './LogHistory';
 
 // List of objects to blacklist
 // '' represents the root object
+// * represents a wildcard key
 export const DEFAULT_PATH_BLACKLIST: string[][] = [
   ['api'],
   ['client'],
-  ['dashboardData', 'default', 'connection'],
-  ['dashboardData', 'default', 'sessionWrapper', 'dh'],
+  ['dashboardData', '*', 'connection'],
+  ['dashboardData', '*', 'sessionWrapper'],
   ['layoutStorage'],
   ['storage'],
 ];
@@ -26,14 +27,8 @@ function stringifyReplacer(blacklist: string[][]) {
     currPath.shift();
 
     // check blacklists
-    for (let i = 0; i < blacklist.length; i += 1) {
-      if (
-        currPath.length === blacklist[i].length &&
-        currPath.every((v, index) => v === blacklist[i][index])
-      ) {
-        // blacklist match
-        return undefined;
-      }
+    if (isOnBlackList(currPath, blacklist)) {
+      return undefined;
     }
 
     if (value instanceof Map) {
@@ -45,6 +40,21 @@ function stringifyReplacer(blacklist: string[][]) {
   };
 }
 
+function isOnBlackList(currPath: string[], blacklist: string[][]): boolean {
+  for (let i = 0; i < blacklist.length; i += 1) {
+    if (
+      currPath.length === blacklist[i].length &&
+      currPath.every(
+        (v, index) => blacklist[i][index] === '*' || v === blacklist[i][index]
+      )
+    ) {
+      // blacklist match
+      return true;
+    }
+  }
+  return false;
+}
+
 /**
  * Returns a new object that is safe to stringify
  * All circular references are replaced by the path to the value creating a circular ref
@@ -90,12 +100,17 @@ function makeSafeToStringify(
         // The ref could point to this object or just to another child
         const curPath = `${path}.${key}`;
         potentiallyCircularValues.set(valRecord, curPath);
-        output[key] = makeSafeToStringify(
-          val as Record<string, unknown>,
-          blacklist,
-          curPath,
-          potentiallyCircularValues
-        );
+        // Convert the path to an array and remove the root
+        const curPathArray = curPath.split('.').slice(1);
+        // If the path is on the blacklist, it will eventually be replaced by undefined, so avoid the recursive call
+        if (!isOnBlackList(curPathArray, blacklist)) {
+          output[key] = makeSafeToStringify(
+            val as Record<string, unknown>,
+            blacklist,
+            curPath,
+            potentiallyCircularValues
+          );
+        }
       }
     }
   });
@@ -138,7 +153,7 @@ function formatDate(date: Date): string {
  * @param logHistory Log history to include in the console.txt file
  * @param metadata Additional metadata to include in the metadata.json file
  * @param reduxData Redux data to include in the redux.json file
- * @param blacklist List of JSON paths to blacklist in redux data. A JSON path is a list representing the path to that value (e.g. client.data would be `['client', 'data']`)
+ * @param blacklist List of JSON paths to blacklist in redux data. A JSON path is a list representing the path to that value (e.g. client.data would be `['client', 'data']`). Wildcards (*) are accepted in the path.
  * @param fileNamePrefix The zip file name without the .zip extension. Ex: test will be saved as test.zip
  * @returns A promise that resolves successfully if the log archive is created and downloaded successfully, rejected if there's an error
  */