fix: Do not load pino-pretty in production bundles

Browser tests were broken since #10459 due to the static import of pino-pretty, which had some browser unfriendly stuff. This PR removes that import in favor of setting it up in a separate jest setup file, only run under jest. This follows the recommendation of pino-pretty of not importing it in production. Note that, for end-users who want pretty logging, pino-pretty will still kick in but as a transport, so it gets loaded in a nodejs worker thread by pino itself, and does not pollute the static imports. Another way of fixing this would have been adding the 'pino-pretty' exception in the webpack fallbacks, but it felt wrong to start adding so many deps in there. Another option would have been to dynamically import (as opposed to statically) pino-pretty, and use a webpackIgnore magic comment to skip it. But it's unclear whether this would have worked with other bundlers, and besides it would have added an async operation to our otherwise synchronous logger setup.
AztecProtocol · Dec 10, 2024 · d0828c0 · d0828c0
1 parent 323e2eb
commit d0828c0
Show file tree

Hide file tree

Showing 43 changed files with 188 additions and 47 deletions.
diff --git a/yarn-project/accounts/package.json b/yarn-project/accounts/package.json
@@ -72,7 +72,10 @@
         }
       ]
     ],
-    "testTimeout": 30000
+    "testTimeout": 30000,
+    "setupFiles": [
+      "../../foundation/src/jest/setup.mjs"
+    ]
   },
   "dependencies": {
     "@aztec/aztec.js": "workspace:^",

diff --git a/yarn-project/archiver/package.json b/yarn-project/archiver/package.json
@@ -62,7 +62,10 @@
         }
       ]
     ],
-    "testTimeout": 30000
+    "testTimeout": 30000,
+    "setupFiles": [
+      "../../foundation/src/jest/setup.mjs"
+    ]
   },
   "dependencies": {
     "@aztec/circuit-types": "workspace:^",

diff --git a/yarn-project/aztec-faucet/package.json b/yarn-project/aztec-faucet/package.json
@@ -56,7 +56,10 @@
         }
       ]
     ],
-    "testTimeout": 30000
+    "testTimeout": 30000,
+    "setupFiles": [
+      "../../foundation/src/jest/setup.mjs"
+    ]
   },
   "dependencies": {
     "@aztec/ethereum": "workspace:^",

diff --git a/yarn-project/aztec-node/package.json b/yarn-project/aztec-node/package.json
@@ -58,7 +58,10 @@
         }
       ]
     ],
-    "testTimeout": 30000
+    "testTimeout": 30000,
+    "setupFiles": [
+      "../../foundation/src/jest/setup.mjs"
+    ]
   },
   "dependencies": {
     "@aztec/archiver": "workspace:^",

diff --git a/yarn-project/aztec.js/package.json b/yarn-project/aztec.js/package.json
@@ -74,7 +74,10 @@
         }
       ]
     ],
-    "testTimeout": 30000
+    "testTimeout": 30000,
+    "setupFiles": [
+      "../../foundation/src/jest/setup.mjs"
+    ]
   },
   "dependencies": {
     "@aztec/circuit-types": "workspace:^",

diff --git a/yarn-project/aztec/package.json b/yarn-project/aztec/package.json
@@ -110,7 +110,10 @@
         }
       ]
     ],
-    "testTimeout": 30000
+    "testTimeout": 30000,
+    "setupFiles": [
+      "../../foundation/src/jest/setup.mjs"
+    ]
   },
   "engines": {
     "node": ">=18"

diff --git a/yarn-project/bb-prover/package.json b/yarn-project/bb-prover/package.json
@@ -63,7 +63,10 @@
         }
       ]
     ],
-    "testTimeout": 30000
+    "testTimeout": 30000,
+    "setupFiles": [
+      "../../foundation/src/jest/setup.mjs"
+    ]
   },
   "dependencies": {
     "@aztec/circuit-types": "workspace:^",

diff --git a/yarn-project/bot/package.json b/yarn-project/bot/package.json
@@ -50,7 +50,10 @@
         }
       ]
     ],
-    "testTimeout": 30000
+    "testTimeout": 30000,
+    "setupFiles": [
+      "../../foundation/src/jest/setup.mjs"
+    ]
   },
   "dependencies": {
     "@aztec/accounts": "workspace:^",

diff --git a/yarn-project/builder/package.json b/yarn-project/builder/package.json
@@ -66,7 +66,10 @@
         }
       ]
     ],
-    "testTimeout": 30000
+    "testTimeout": 30000,
+    "setupFiles": [
+      "../../foundation/src/jest/setup.mjs"
+    ]
   },
   "dependencies": {
     "@aztec/foundation": "workspace:^",

diff --git a/yarn-project/circuit-types/package.json b/yarn-project/circuit-types/package.json
@@ -64,7 +64,10 @@
         }
       ]
     ],
-    "testTimeout": 30000
+    "testTimeout": 30000,
+    "setupFiles": [
+      "../../foundation/src/jest/setup.mjs"
+    ]
   },
   "dependencies": {
     "@aztec/circuits.js": "workspace:^",

diff --git a/yarn-project/circuits.js/package.json b/yarn-project/circuits.js/package.json
@@ -98,6 +98,9 @@
         }
       ]
     ],
-    "testTimeout": 30000
+    "testTimeout": 30000,
+    "setupFiles": [
+      "../../foundation/src/jest/setup.mjs"
+    ]
   }
 }
diff --git a/yarn-project/cli-wallet/package.json b/yarn-project/cli-wallet/package.json
@@ -64,7 +64,10 @@
         }
       ]
     ],
-    "testTimeout": 30000
+    "testTimeout": 30000,
+    "setupFiles": [
+      "../../foundation/src/jest/setup.mjs"
+    ]
   },
   "dependencies": {
     "@aztec/accounts": "workspace:^",

diff --git a/yarn-project/cli/package.json b/yarn-project/cli/package.json
@@ -64,7 +64,10 @@
         }
       ]
     ],
-    "testTimeout": 30000
+    "testTimeout": 30000,
+    "setupFiles": [
+      "../../foundation/src/jest/setup.mjs"
+    ]
   },
   "dependencies": {
     "@aztec/archiver": "workspace:^",

diff --git a/yarn-project/end-to-end/package.json b/yarn-project/end-to-end/package.json
@@ -156,6 +156,9 @@
     },
     "testRegex": "./src/.*\\.test\\.(js|mjs|ts)$",
     "rootDir": "./src",
-    "testTimeout": 30000
+    "testTimeout": 30000,
+    "setupFiles": [
+      "../../foundation/src/jest/setup.mjs"
+    ]
   }
 }
diff --git a/yarn-project/end-to-end/src/shared/browser.ts b/yarn-project/end-to-end/src/shared/browser.ts
@@ -97,7 +97,7 @@ export const browserTestSuite = (
         pageLogger.info(msg.text());
       });
       page.on('pageerror', err => {
-        pageLogger.error(err.toString());
+        pageLogger.error(`Error on web page`, err);
       });
       await page.goto(`${webServerURL}/index.html`);
       while (!(await page.evaluate(() => !!window.AztecJs))) {

diff --git a/yarn-project/entrypoints/package.json b/yarn-project/entrypoints/package.json
@@ -60,7 +60,10 @@
         }
       ]
     ],
-    "testTimeout": 30000
+    "testTimeout": 30000,
+    "setupFiles": [
+      "../../foundation/src/jest/setup.mjs"
+    ]
   },
   "dependencies": {
     "@aztec/aztec.js": "workspace:^",

diff --git a/yarn-project/epoch-cache/package.json b/yarn-project/epoch-cache/package.json
@@ -87,7 +87,10 @@
         }
       ]
     ],
-    "testTimeout": 30000
+    "testTimeout": 30000,
+    "setupFiles": [
+      "../../foundation/src/jest/setup.mjs"
+    ]
   },
   "engines": {
     "node": ">=18"

diff --git a/yarn-project/ethereum/package.json b/yarn-project/ethereum/package.json
@@ -86,9 +86,12 @@
         }
       ]
     ],
-    "testTimeout": 30000
+    "testTimeout": 30000,
+    "setupFiles": [
+      "../../foundation/src/jest/setup.mjs"
+    ]
   },
   "engines": {
     "node": ">=18"
   }
-}
+}
diff --git a/yarn-project/foundation/package.json b/yarn-project/foundation/package.json
@@ -97,7 +97,13 @@
         }
       ]
     ],
-    "testTimeout": 30000
+    "testTimeout": 30000,
+    "setupFilesAfterEnv": [
+      "../../foundation/src/jest/setup.mjs"
+    ],
+    "setupFiles": [
+      "../../foundation/src/jest/setup.mjs"
+    ]
   },
   "dependencies": {
     "@aztec/bb.js": "portal:../../barretenberg/ts",

diff --git a/yarn-project/foundation/src/jest/setup.mjs b/yarn-project/foundation/src/jest/setup.mjs
@@ -0,0 +1,8 @@
+import { overwriteLoggingStream, pinoPrettyOpts } from '@aztec/foundation/log';
+import pretty from 'pino-pretty';
+
+// Overwrite logging stream with pino-pretty. We define this as a separate
+// file so we don't mess up with dependencies in non-testing environments,
+// since pino-pretty messes up with browser bundles.
+// See also https://www.npmjs.com/package/pino-pretty?activeTab=readme#user-content-usage-with-jest
+overwriteLoggingStream(pretty(pinoPrettyOpts));
diff --git a/yarn-project/foundation/src/log/pino-logger.ts b/yarn-project/foundation/src/log/pino-logger.ts
@@ -1,7 +1,6 @@
 import { createColors } from 'colorette';
 import isNode from 'detect-node';
 import { pino, symbols } from 'pino';
-import pretty from 'pino-pretty';
 import { type Writable } from 'stream';
 import { inspect } from 'util';
 
@@ -68,7 +67,7 @@ const [logLevel, logFilters] = parseEnv(process.env.LOG_LEVEL, defaultLogLevel);
 // Transport options for pretty logging to stderr via pino-pretty.
 const useColor = true;
 const { bold, reset } = createColors({ useColor });
-const pinoPrettyOpts = {
+export const pinoPrettyOpts = {
   destination: 2,
   sync: true,
   colorize: useColor,
@@ -78,6 +77,7 @@ const pinoPrettyOpts = {
   customColors: 'fatal:bgRed,error:red,warn:yellow,info:green,verbose:magenta,debug:blue,trace:gray',
   minimumLevel: 'trace' as const,
 };
+
 const prettyTransport: pino.TransportSingleOptions = {
   target: 'pino-pretty',
   options: pinoPrettyOpts,
@@ -113,11 +113,13 @@ const otelTransport: pino.TransportSingleOptions = {
 
 function makeLogger() {
   if (!isNode) {
-    // We are on the browser
+    // We are on the browser.
     return pino({ ...pinoOpts, browser: { asObject: false } });
   } else if (process.env.JEST_WORKER_ID) {
-    // We are on jest, so we need sync logging. We stream to stderr with pretty.
-    return pino(pinoOpts, pretty(pinoPrettyOpts));
+    // We are on jest, so we need sync logging and stream to stderr.
+    // We expect jest/setup.mjs to kick in later and replace set up a pretty logger,
+    // but if for some reason it doesn't, at least we're covered with a default logger.
+    return pino(pinoOpts, pino.destination(2));
   } else {
     // Regular nodejs with transports on worker thread, using pino-pretty for console logging if LOG_JSON
     // is not set, and an optional OTLP transport if the OTLP endpoint is provided.
@@ -142,6 +144,14 @@ logger.verbose(
     : `Browser console logger initialized with level ${logLevel}`,
 );
 
+/**
+ * Overwrites the logging stream with a different destination.
+ * Used by jest/setup.mjs to set up a pretty logger.
+ */
+export function overwriteLoggingStream(stream: Writable): void {
+  (logger as any)[symbols.streamSym] = stream;
+}
+
 /**
  * Registers an additional destination to the pino logger.
  * Use only when working with destinations, not worker transports.

diff --git a/yarn-project/ivc-integration/package.json b/yarn-project/ivc-integration/package.json
@@ -59,7 +59,10 @@
         }
       ]
     ],
-    "testTimeout": 30000
+    "testTimeout": 30000,
+    "setupFiles": [
+      "../../foundation/src/jest/setup.mjs"
+    ]
   },
   "dependencies": {
     "@aztec/bb.js": "../../ts",

diff --git a/yarn-project/key-store/package.json b/yarn-project/key-store/package.json
@@ -54,7 +54,10 @@
         }
       ]
     ],
-    "testTimeout": 30000
+    "testTimeout": 30000,
+    "setupFiles": [
+      "../../foundation/src/jest/setup.mjs"
+    ]
   },
   "dependencies": {
     "@aztec/circuit-types": "workspace:^",

diff --git a/yarn-project/kv-store/package.json b/yarn-project/kv-store/package.json
@@ -91,6 +91,9 @@
     ],
     "testRegex": "./src/.*\\.test\\.(js|mjs|ts)$",
     "rootDir": "./src",
-    "testTimeout": 30000
+    "testTimeout": 30000,
+    "setupFiles": [
+      "../../foundation/src/jest/setup.mjs"
+    ]
   }
 }
diff --git a/yarn-project/merkle-tree/package.json b/yarn-project/merkle-tree/package.json
@@ -55,7 +55,10 @@
         }
       ]
     ],
-    "testTimeout": 30000
+    "testTimeout": 30000,
+    "setupFiles": [
+      "../../foundation/src/jest/setup.mjs"
+    ]
   },
   "dependencies": {
     "@aztec/circuit-types": "workspace:^",

diff --git a/yarn-project/noir-contracts.js/package.json b/yarn-project/noir-contracts.js/package.json
@@ -54,7 +54,10 @@
         }
       ]
     ],
-    "testTimeout": 30000
+    "testTimeout": 30000,
+    "setupFiles": [
+      "../../foundation/src/jest/setup.mjs"
+    ]
   },
   "dependencies": {
     "@aztec/aztec.js": "workspace:^",

diff --git a/yarn-project/noir-protocol-circuits-types/package.json b/yarn-project/noir-protocol-circuits-types/package.json
@@ -58,7 +58,10 @@
         }
       ]
     ],
-    "testTimeout": 30000
+    "testTimeout": 30000,
+    "setupFiles": [
+      "../../foundation/src/jest/setup.mjs"
+    ]
   },
   "dependencies": {
     "@aztec/circuits.js": "workspace:^",

diff --git a/yarn-project/p2p-bootstrap/package.json b/yarn-project/p2p-bootstrap/package.json
@@ -82,7 +82,10 @@
         }
       ]
     ],
-    "testTimeout": 30000
+    "testTimeout": 30000,
+    "setupFiles": [
+      "../../foundation/src/jest/setup.mjs"
+    ]
   },
   "engines": {
     "node": ">=18"

diff --git a/yarn-project/p2p/package.json b/yarn-project/p2p/package.json
@@ -60,7 +60,10 @@
         }
       ]
     ],
-    "testTimeout": 30000
+    "testTimeout": 30000,
+    "setupFiles": [
+      "../../foundation/src/jest/setup.mjs"
+    ]
   },
   "dependencies": {
     "@aztec/circuit-types": "workspace:^",