@aztec/foundation 0.67.1 → 0.68.0

package/src/log/pino-logger.ts

@@ -69,7 +69,46 @@ const [logLevel, logFilters] = parseEnv(process.env.LOG_LEVEL, defaultLogLevel);
 
 // Define custom logging levels for pino.
 const customLevels = { verbose: 25 };
-const pinoOpts = { customLevels, useOnlyCustomLevels: false, level: logLevel };
+
+// inspired by https://github.com/pinojs/pino/issues/726#issuecomment-605814879
+const levelToSeverityFormatter = (label: string, level: number): object => {
+  // Severity labels https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry#LogSeverity
+  let severity: string;
+
+  switch (label as pino.Level | keyof typeof customLevels) {
+    case 'trace':
+    case 'debug':
+      severity = 'DEBUG';
+      break;
+    case 'verbose':
+    case 'info':
+      severity = 'INFO';
+      break;
+    case 'warn':
+      severity = 'WARNING';
+      break;
+    case 'error':
+      severity = 'ERROR';
+      break;
+    case 'fatal':
+      severity = 'CRITICAL';
+      break;
+    default:
+      severity = 'DEFAULT';
+      break;
+  }
+
+  return { severity, level };
+};
+
+const pinoOpts: pino.LoggerOptions<keyof typeof customLevels> = {
+  customLevels,
+  useOnlyCustomLevels: false,
+  level: logLevel,
+  formatters: {
+    level: levelToSeverityFormatter,
+  },
+};
 
 export const levels = {
   labels: { ...pino.levels.labels, ...Object.fromEntries(Object.entries(customLevels).map(e => e.reverse())) },

package/src/promise/running-promise.ts

@@ -1,3 +1,4 @@
+import { createLogger } from '../log/pino-logger.js';
 import { InterruptibleSleep } from '../sleep/index.js';
 import { type PromiseWithResolvers, promiseWithResolvers } from './utils.js';
 
@@ -12,7 +13,11 @@ export class RunningPromise {
   private interruptibleSleep = new InterruptibleSleep();
   private requested: PromiseWithResolvers<void> | undefined = undefined;
 
-  constructor(private fn: () => void | Promise<void>, private pollingIntervalMS = 10000) {}
+  constructor(
+    private fn: () => void | Promise<void>,
+    private logger = createLogger('running-promise'),
+    private pollingIntervalMS = 10000,
+  ) {}
 
   /**
    * Starts the running promise.
@@ -23,7 +28,11 @@ export class RunningPromise {
     const poll = async () => {
       while (this.running) {
         const hasRequested = this.requested !== undefined;
-        await this.fn();
+        try {
+          await this.fn();
+        } catch (err) {
+          this.logger.error('Error in running promise', err);
+        }
 
         // If an immediate run had been requested *before* the function started running, resolve the request.
         if (hasRequested) {

package/src/retry/index.ts

@@ -64,7 +64,7 @@ export async function retry<Result>(
         throw err;
       }
       log.verbose(`${name} failed. Will retry in ${s}s...`);
-      !failSilently && log.error(err);
+      !failSilently && log.error(`Error while retrying ${name}`, err);
       await sleep(s * 1000);
       continue;
     }

package/src/serialize/field_reader.ts

@@ -140,4 +140,12 @@ export class FieldReader {
   }): T {
     return deserializer.fromFields(this);
   }
+
+  /**
+   * Returns whether the reader has finished reading all fields.
+   * @returns A bool.
+   */
+  public isFinished(): boolean {
+    return this.index === this.length;
+  }
 }

package/src/string/index.ts

@@ -25,3 +25,7 @@ export function pluralize(str: string, count: number | bigint, plural?: string):
 export function count(count: number | bigint, str: string, plural?: string): string {
   return `${count} ${pluralize(str, count, plural)}`;
 }
+
+export function truncate(str: string, length: number = 64): string {
+  return str.length > length ? str.slice(0, length) + '...' : str;
+}

package/src/testing/files/index.ts

@@ -0,0 +1,63 @@
+import { existsSync, readFileSync, writeFileSync } from 'fs';
+import { dirname, join, resolve } from 'path';
+
+import { createConsoleLogger } from '../../log/console.js';
+import { fileURLToPath } from '../../url/index.js';
+import { isGenerateTestDataEnabled } from '../test_data.js';
+
+/** Writes the contents specified to the target file if test data generation is enabled. */
+export function writeTestData(targetFileFromRepoRoot: string, contents: string | Buffer) {
+  if (!isGenerateTestDataEnabled()) {
+    return;
+  }
+  const targetFile = getPathToFile(targetFileFromRepoRoot);
+  const toWrite = typeof contents === 'string' ? contents : contents.toString('hex');
+  writeFileSync(targetFile, toWrite);
+  const logger = createConsoleLogger('aztec:testing:test_data');
+  logger(`Wrote test data to ${targetFile}`);
+}
+
+/**
+ * Looks for a variable assignment in the target file and updates the value, only if test data generation is enabled.
+ * Note that a magic inline comment would be a cleaner approach, like `/* TEST-DATA-START *\/` and `/* TEST-DATA-END *\/`,
+ * but running nargo fmt on it panics since the comment would be erased, so we roll with this for now.
+ * @remarks Requires AZTEC_GENERATE_TEST_DATA=1 to be set
+ */
+export function updateInlineTestData(targetFileFromRepoRoot: string, itemName: string, value: string) {
+  if (!isGenerateTestDataEnabled()) {
+    return;
+  }
+  const logger = createConsoleLogger('aztec:testing:test_data');
+  const targetFile = getPathToFile(targetFileFromRepoRoot);
+  const contents = readFileSync(targetFile, 'utf8').toString();
+  const regex = new RegExp(`let ${itemName} =[\\s\\S]*?;`, 'g');
+  if (!regex.exec(contents)) {
+    throw new Error(`Test data marker for ${itemName} not found in ${targetFile}`);
+  }
+
+  const updatedContents = contents.replaceAll(regex, `let ${itemName} = ${value};`);
+  writeFileSync(targetFile, updatedContents);
+  logger(`Updated test data in ${targetFile} for ${itemName} to ${value}`);
+}
+
+/**
+ * Updates the sample Prover.toml files in noir-projects/noir-protocol-circuits/crates/.
+ * @remarks Requires AZTEC_GENERATE_TEST_DATA=1 & generateProtocolCircuitTestData=true to be set
+ * To re-gen, run 'AZTEC_GENERATE_TEST_DATA=1 FAKE_PROOFS=1 yarn workspace @aztec/end-to-end test full.test'
+ */
+export function updateProtocolCircuitSampleInputs(circuitName: string, value: string) {
+  const logger = createConsoleLogger('aztec:testing:test_data');
+  const targetFileFromRepoRoot = `noir-projects/noir-protocol-circuits/crates/${circuitName}/Prover.toml`;
+  const targetFile = getPathToFile(targetFileFromRepoRoot);
+  writeFileSync(targetFile, value);
+  logger(`Updated test data in ${targetFile} for ${circuitName}`);
+}
+
+function getPathToFile(targetFileFromRepoRoot: string) {
+  const repoRoot = resolve(dirname(fileURLToPath(import.meta.url)), '../../../../../');
+  if (!existsSync(join(repoRoot, 'CODEOWNERS'))) {
+    throw new Error(`Path to repo root is incorrect (got ${repoRoot})`);
+  }
+
+  return join(repoRoot, targetFileFromRepoRoot);
+}

package/src/testing/index.ts

@@ -1,3 +1,3 @@
-export * from './test_data.js';
 export * from './snapshot_serializer.js';
 export * from './port_allocator.js';
+export * from './test_data.js';

package/src/testing/test_data.ts

@@ -1,25 +1,10 @@
-import { existsSync, readFileSync, writeFileSync } from 'fs';
-import { dirname, join, resolve } from 'path';
-
-import { createConsoleLogger } from '../log/console.js';
-import { fileURLToPath } from '../url/index.js';
-
 const testData: { [key: string]: unknown[] } = {};
-let generateProtocolCircuitTestData = false;
 
 /** Returns whether test data generation is enabled */
 export function isGenerateTestDataEnabled() {
   return ['1', 'true'].includes(process.env.AZTEC_GENERATE_TEST_DATA ?? '') && typeof expect !== 'undefined';
 }
 
-/**
- * This is separate so Prover.tomls don't get edited everytime any test is run,
- * Only full.test updates prover tomls, then switches this off.
- */
-export function switchGenerateProtocolCircuitTestData() {
-  generateProtocolCircuitTestData = !generateProtocolCircuitTestData;
-}
-
 /** Pushes test data with the given name, only if test data generation is enabled. */
 export function pushTestData<T>(itemName: string, data: T) {
   if (!isGenerateTestDataEnabled()) {
@@ -49,63 +34,3 @@ export function getTestData(itemName: string): unknown[] {
   const fullItemName = `${testName} ${itemName}`;
   return testData[fullItemName];
 }
-
-/** Writes the contents specified to the target file if test data generation is enabled. */
-export function writeTestData(targetFileFromRepoRoot: string, contents: string | Buffer) {
-  if (!isGenerateTestDataEnabled()) {
-    return;
-  }
-  const targetFile = getPathToFile(targetFileFromRepoRoot);
-  const toWrite = typeof contents === 'string' ? contents : contents.toString('hex');
-  writeFileSync(targetFile, toWrite);
-  const logger = createConsoleLogger('aztec:testing:test_data');
-  logger(`Wrote test data to ${targetFile}`);
-}
-
-/**
- * Looks for a variable assignment in the target file and updates the value, only if test data generation is enabled.
- * Note that a magic inline comment would be a cleaner approach, like `/* TEST-DATA-START *\/` and `/* TEST-DATA-END *\/`,
- * but running nargo fmt on it panics since the comment would be erased, so we roll with this for now.
- * @remarks Requires AZTEC_GENERATE_TEST_DATA=1 to be set
- */
-export function updateInlineTestData(targetFileFromRepoRoot: string, itemName: string, value: string) {
-  if (!isGenerateTestDataEnabled()) {
-    return;
-  }
-  const logger = createConsoleLogger('aztec:testing:test_data');
-  const targetFile = getPathToFile(targetFileFromRepoRoot);
-  const contents = readFileSync(targetFile, 'utf8').toString();
-  const regex = new RegExp(`let ${itemName} =[\\s\\S]*?;`, 'g');
-  if (!regex.exec(contents)) {
-    throw new Error(`Test data marker for ${itemName} not found in ${targetFile}`);
-  }
-
-  const updatedContents = contents.replaceAll(regex, `let ${itemName} = ${value};`);
-  writeFileSync(targetFile, updatedContents);
-  logger(`Updated test data in ${targetFile} for ${itemName} to ${value}`);
-}
-
-/**
- * Updates the sample Prover.toml files in noir-projects/noir-protocol-circuits/crates/.
- * @remarks Requires AZTEC_GENERATE_TEST_DATA=1 & generateProtocolCircuitTestData=true to be set
- * To re-gen, run 'AZTEC_GENERATE_TEST_DATA=1 FAKE_PROOFS=1 yarn workspace @aztec/end-to-end test full.test'
- */
-export function updateProtocolCircuitSampleInputs(circuitName: string, value: string) {
-  if (!isGenerateTestDataEnabled() || !generateProtocolCircuitTestData) {
-    return;
-  }
-  const logger = createConsoleLogger('aztec:testing:test_data');
-  const targetFileFromRepoRoot = `noir-projects/noir-protocol-circuits/crates/${circuitName}/Prover.toml`;
-  const targetFile = getPathToFile(targetFileFromRepoRoot);
-  writeFileSync(targetFile, value);
-  logger(`Updated test data in ${targetFile} for ${circuitName}`);
-}
-
-function getPathToFile(targetFileFromRepoRoot: string) {
-  const repoRoot = resolve(dirname(fileURLToPath(import.meta.url)), '../../../../');
-  if (!existsSync(join(repoRoot, 'CODEOWNERS'))) {
-    throw new Error(`Path to repo root is incorrect (got ${repoRoot})`);
-  }
-
-  return join(repoRoot, targetFileFromRepoRoot);
-}

package/src/timer/date.ts

@@ -0,0 +1,24 @@
+import { createLogger } from '../log/pino-logger.js';
+
+/** Returns current datetime. */
+export class DateProvider {
+  public now(): number {
+    return Date.now();
+  }
+}
+
+/** Returns current datetime and allows to override it. */
+export class TestDateProvider implements DateProvider {
+  private offset = 0;
+
+  constructor(private readonly logger = createLogger('foundation:test-date-provider')) {}
+
+  public now(): number {
+    return Date.now() + this.offset;
+  }
+
+  public setTime(timeMs: number) {
+    this.offset = timeMs - Date.now();
+    this.logger.warn(`Time set to ${timeMs}`);
+  }
+}

package/src/timer/index.ts

@@ -1,3 +1,4 @@
 export { TimeoutTask, executeTimeoutWithCustomError } from './timeout.js';
 export { Timer } from './timer.js';
 export { elapsed, elapsedSync } from './elapsed.js';
+export * from './date.js';