@aztec/foundation 0.47.1 → 0.49.2

package/src/{fifo/memory_fifo.ts → queue/base_memory_queue.ts}

@@ -1,18 +1,19 @@
 import { TimeoutError } from '../error/index.js';
 import { createDebugLogger } from '../log/index.js';
 
-/**
- * A simple fifo queue. It can grow unbounded. It can have multiple producers and consumers.
- * Putting an item onto the queue always succeeds, unless either end() or cancel() has been called in which case
- * the item being pushed is simply discarded.
- */
-export class MemoryFifo<T> {
+export abstract class BaseMemoryQueue<T> {
   private waiting: ((item: T | null) => void)[] = [];
-  private items: T[] = [];
   private flushing = false;
 
   constructor(private log = createDebugLogger('aztec:foundation:memory_fifo')) {}
 
+  protected abstract get items(): {
+    length: number;
+    get(): T | undefined;
+    put(item: T): void;
+    clear: () => void;
+  };
+
   /**
    * Returns the current number of items in the queue.
    * The length represents the size of the queue at the time of invocation and may change as new items are added or consumed.
@@ -36,7 +37,7 @@ export class MemoryFifo<T> {
    */
   public get(timeoutSec?: number): Promise<T | null> {
     if (this.items.length) {
-      return Promise.resolve(this.items.shift()!);
+      return Promise.resolve(this.items.get()!);
     }
 
     if (this.items.length === 0 && this.flushing) {
@@ -78,7 +79,7 @@ export class MemoryFifo<T> {
       this.waiting.shift()!(item);
       return true;
     } else {
-      this.items.push(item);
+      this.items.put(item);
       return true;
     }
   }
@@ -100,7 +101,7 @@ export class MemoryFifo<T> {
    */
   public cancel() {
     this.flushing = true;
-    this.items = [];
+    this.items.clear();
     this.waiting.forEach(resolve => resolve(null));
   }
 

package/src/queue/fifo_memory_queue.ts

@@ -0,0 +1,39 @@
+import { type DebugLogger } from '../log/logger.js';
+import { BaseMemoryQueue } from './base_memory_queue.js';
+
+/**
+ * A simple fifo queue. It can grow unbounded. It can have multiple producers and consumers.
+ * Putting an item onto the queue always succeeds, unless either end() or cancel() has been called in which case
+ * the item being pushed is simply discarded.
+ */
+export class FifoMemoryQueue<T> extends BaseMemoryQueue<T> {
+  private container = new FifoQueue<T>();
+
+  constructor(log?: DebugLogger) {
+    super(log);
+  }
+
+  protected override get items() {
+    return this.container;
+  }
+}
+
+class FifoQueue<T> {
+  private items: T[] = [];
+
+  public put(item: T): void {
+    this.items.push(item);
+  }
+
+  public get(): T | undefined {
+    return this.items.shift();
+  }
+
+  public get length(): number {
+    return this.items.length;
+  }
+
+  public clear() {
+    this.items = [];
+  }
+}

package/src/{fifo → queue}/index.ts

@@ -1,4 +1,5 @@
-export * from './memory_fifo.js';
+export * from './fifo_memory_queue.js';
+export * from './priority_memory_queue.js';
 export * from './serial_queue.js';
 export * from './bounded_serial_queue.js';
 export * from './semaphore.js';

package/src/queue/priority_memory_queue.ts

@@ -0,0 +1,20 @@
+import { BaseMemoryQueue } from './base_memory_queue.js';
+import { PriorityQueue } from './priority_queue.js';
+
+/**
+ * A priority queue. It can grow unbounded. It can have multiple producers and consumers.
+ * Putting an item onto the queue always succeeds, unless either end() or cancel() has been called in which case
+ * the item being pushed is simply discarded.
+ */
+export class PriorityMemoryQueue<T> extends BaseMemoryQueue<T> {
+  private container: PriorityQueue<T>;
+
+  constructor(comparator: (a: T, b: T) => number) {
+    super();
+    this.container = new PriorityQueue(comparator);
+  }
+
+  protected override get items() {
+    return this.container;
+  }
+}

package/src/queue/priority_queue.ts

@@ -0,0 +1,34 @@
+/**
+ * Priority queue implementation based on a custom comparator.
+ */
+export class PriorityQueue<T> {
+  private items: T[];
+
+  constructor(private comparator: (a: T, b: T) => number) {
+    this.items = [];
+  }
+
+  public put(item: T): void {
+    let i = 0;
+    while (i < this.items.length && this.comparator(item, this.items[i]) >= 0) {
+      i++;
+    }
+    this.items.splice(i, 0, item);
+  }
+
+  public get(): T | undefined {
+    return this.items.shift();
+  }
+
+  public peek(): T | undefined {
+    return this.items[0];
+  }
+
+  public clear() {
+    this.items = [];
+  }
+
+  public get length(): number {
+    return this.items.length;
+  }
+}

package/src/{fifo → queue}/semaphore.ts

@@ -1,10 +1,10 @@
-import { MemoryFifo } from './memory_fifo.js';
+import { FifoMemoryQueue } from './fifo_memory_queue.js';
 
 /**
  * Allows the acquiring of up to `size` tokens before calls to acquire block, waiting for a call to release().
  */
 export class Semaphore {
-  private readonly queue = new MemoryFifo<boolean>();
+  private readonly queue = new FifoMemoryQueue<boolean>();
 
   constructor(size: number) {
     new Array(size).fill(true).map(() => this.queue.put(true));

package/src/{fifo → queue}/serial_queue.ts

@@ -1,10 +1,10 @@
-import { MemoryFifo } from './memory_fifo.js';
+import { FifoMemoryQueue } from './fifo_memory_queue.js';
 
 /**
  * A more specialized fifo queue that enqueues functions to execute. Enqueued functions are executed in serial.
  */
 export class SerialQueue {
-  private readonly queue = new MemoryFifo<() => Promise<void>>();
+  private readonly queue = new FifoMemoryQueue<() => Promise<void>>();
   private runningPromise!: Promise<void>;
 
   /**

package/src/wasm/wasm_module.ts

@@ -1,8 +1,8 @@
 import { Buffer } from 'buffer';
 
 import { randomBytes } from '../crypto/index.js';
-import { MemoryFifo } from '../fifo/index.js';
 import { type LogFn, createDebugOnlyLogger } from '../log/index.js';
+import { FifoMemoryQueue } from '../queue/index.js';
 import { getEmptyWasiSdk } from './empty_wasi_sdk.js';
 
 /**
@@ -47,7 +47,7 @@ export class WasmModule implements IWasmModule {
   private memory!: WebAssembly.Memory;
   private heap!: Uint8Array;
   private instance?: WebAssembly.Instance;
-  private mutexQ = new MemoryFifo<boolean>();
+  private mutexQ = new FifoMemoryQueue<boolean>();
   private debug: LogFn;
 
   /**

package/dest/fifo/bounded_serial_queue.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"bounded_serial_queue.d.ts","sourceRoot":"","sources":["../../src/fifo/bounded_serial_queue.ts"],"names":[],"mappings":"AAIA;;;GAGG;AACH,qBAAa,kBAAkB;IAIK,OAAO,CAAC,GAAG;IAH7C,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAqB;IAC3C,OAAO,CAAC,SAAS,CAAY;gBAEjB,YAAY,EAAE,MAAM,EAAU,GAAG,oCAA6D;IAI1G;;;OAGG;IACI,KAAK;IAIZ;;;;;OAKG;IACI,MAAM;IAIb;;;;;OAKG;IACI,MAAM;IAIb;;;;;;;OAOG;IACI,GAAG;IAIV;;;;;OAKG;IACU,GAAG,CAAC,EAAE,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAexD;;;;OAIG;IACU,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAWtD;;OAEG;IACU,SAAS;CAGvB"}

package/dest/fifo/index.d.ts

@@ -1,5 +0,0 @@
-export * from './memory_fifo.js';
-export * from './serial_queue.js';
-export * from './bounded_serial_queue.js';
-export * from './semaphore.js';
-//# sourceMappingURL=index.d.ts.map

package/dest/fifo/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/fifo/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,gBAAgB,CAAC"}

package/dest/fifo/index.js

@@ -1,5 +0,0 @@
-export * from './memory_fifo.js';
-export * from './serial_queue.js';
-export * from './bounded_serial_queue.js';
-export * from './semaphore.js';
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvZmlmby9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxjQUFjLGtCQUFrQixDQUFDO0FBQ2pDLGNBQWMsbUJBQW1CLENBQUM7QUFDbEMsY0FBYywyQkFBMkIsQ0FBQztBQUMxQyxjQUFjLGdCQUFnQixDQUFDIn0=

package/dest/fifo/memory_fifo.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"memory_fifo.d.ts","sourceRoot":"","sources":["../../src/fifo/memory_fifo.ts"],"names":[],"mappings":"AAGA;;;;GAIG;AACH,qBAAa,UAAU,CAAC,CAAC;IAKX,OAAO,CAAC,GAAG;IAJvB,OAAO,CAAC,OAAO,CAAoC;IACnD,OAAO,CAAC,KAAK,CAAW;IACxB,OAAO,CAAC,QAAQ,CAAS;gBAEL,GAAG,oCAAoD;IAE3E;;;;;OAKG;IACI,MAAM;IAIb;;;;;;;;;;OAUG;IACI,GAAG,CAAC,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC;IA+BlD;;;;OAIG;IACI,GAAG,CAAC,IAAI,EAAE,CAAC,GAAG,OAAO;IAa5B;;;;OAIG;IACI,GAAG;IAKV;;;;OAIG;IACI,MAAM;IAMb;;;;;;;;OAQG;IACU,OAAO,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC;CAazD"}

package/dest/fifo/semaphore.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"semaphore.d.ts","sourceRoot":"","sources":["../../src/fifo/semaphore.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,qBAAa,SAAS;IACpB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAA6B;gBAEvC,IAAI,EAAE,MAAM;IAIxB;;;;;;OAMG;IACU,OAAO;IAIpB;;;;;OAKG;IACI,OAAO;CAGf"}

package/dest/fifo/serial_queue.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"serial_queue.d.ts","sourceRoot":"","sources":["../../src/fifo/serial_queue.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,qBAAa,WAAW;IACtB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAyC;IAC/D,OAAO,CAAC,cAAc,CAAiB;IAEvC;;;;;OAKG;IACI,KAAK;IAIZ;;;;;OAKG;IACI,MAAM;IAIb;;;;;;OAMG;IACI,MAAM;IAKb;;;;;OAKG;IACI,GAAG;IAKV;;;;;OAKG;IACI,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAgB/C;;OAEG;IACU,SAAS;CAGvB"}