@dxos/util 0.4.7-next.f4b92be → 0.4.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/util",
-  "version": "0.4.7-next.f4b92be",
+  "version": "0.4.7",
   "description": "Temporary bucket for misc functions, which should graduate into separate packages.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -16,13 +16,13 @@
     "src"
   ],
   "dependencies": {
-    "@dxos/node-std": "0.4.7-next.f4b92be",
-    "@dxos/keys": "0.4.7-next.f4b92be",
-    "@dxos/debug": "0.4.7-next.f4b92be",
-    "@dxos/invariant": "0.4.7-next.f4b92be"
+    "@dxos/invariant": "0.4.7",
+    "@dxos/keys": "0.4.7",
+    "@dxos/node-std": "0.4.7",
+    "@dxos/debug": "0.4.7"
   },
   "devDependencies": {
-    "@dxos/crypto": "0.4.7-next.f4b92be"
+    "@dxos/crypto": "0.4.7"
   },
   "publishConfig": {
     "access": "public"

package/src/circular-buffer.test.ts

@@ -0,0 +1,33 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { describe, test, expect } from 'vitest';
+
+import { CircularBuffer } from './circular-buffer';
+
+describe('CircularBuffer', () => {
+  test('single element', () => {
+    const buffer = new CircularBuffer<number>(1);
+    for (let i = 0; i < 3; i++) {
+      buffer.push(i);
+      expect([...buffer]).toStrictEqual([i]);
+      expect(buffer.getLast()).toStrictEqual(i);
+    }
+  });
+
+  test('full cycle', () => {
+    const maxSize = 10;
+    const regularArray: number[] = [];
+    const buffer = new CircularBuffer<number>(maxSize);
+    for (let i = 0; i < maxSize * 2 + 2; i++) {
+      expect([...buffer]).toStrictEqual(regularArray);
+      buffer.push(i);
+      regularArray.push(i);
+      if (regularArray.length > maxSize) {
+        regularArray.splice(0, 1);
+      }
+      expect(buffer.getLast()).toStrictEqual(i);
+    }
+  });
+});

package/src/circular-buffer.ts

@@ -0,0 +1,54 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { invariant } from '@dxos/invariant';
+
+export class CircularBuffer<T> {
+  private readonly _buffer: T[];
+  private _nextIndex = 0;
+  private _elementCount = 0;
+
+  constructor(size: number) {
+    invariant(size >= 1);
+    this._buffer = new Array(size);
+  }
+
+  public push(element: T) {
+    this._buffer[this._nextIndex] = element;
+    this._nextIndex = (this._nextIndex + 1) % this._buffer.length;
+    this._elementCount = Math.min(this._buffer.length, this._elementCount + 1);
+  }
+
+  public getLast(): T | undefined {
+    if (this._elementCount === 0) {
+      return undefined;
+    }
+    if (this._nextIndex === 0) {
+      return this._buffer[this._buffer.length - 1];
+    }
+    return this._buffer[this._nextIndex - 1];
+  }
+
+  [Symbol.iterator](): IterableIterator<T> {
+    return this.values();
+  }
+
+  public *values(): IterableIterator<T> {
+    if (this._elementCount === 0) {
+      return;
+    }
+    if (this._elementCount < this._buffer.length) {
+      for (let i = 0; i < this._elementCount; i++) {
+        yield this._buffer[i];
+      }
+      return;
+    }
+    for (let i = this._nextIndex; i < this._buffer.length; i++) {
+      yield this._buffer[i];
+    }
+    for (let i = 0; i < this._nextIndex; i++) {
+      yield this._buffer[i];
+    }
+  }
+}

package/src/index.ts

@@ -31,3 +31,4 @@ export * from './for-each-async';
 export * from './weak';
 export * from './map-values';
 export * from './defer';
+export * from './circular-buffer';

package/src/instance-id.ts

@@ -37,7 +37,7 @@ export const getPrototypeSpecificInstanceId = (instance: any): number => {
 };
 
 export const getDebugName = (instance: any): string => {
-  if (instance === null) {
+  if (instance == null) {
     return 'null';
   }