@squiz/optimization-utils 7.0.0 → 7.1.0

package/dist/index.d.ts

@@ -1,5 +1,7 @@
 export * from './types/class-utilities-types';
 export * from './retries/Retries';
+export * from './queue/LRUQueue';
+export * from './queue/LRUQueueFactory';
 export * from './promises/PromiseMaxConcurrency';
 export * from './object/getProperty';
 export * from './metadata/CopyReflection';

package/dist/index.js

@@ -16,6 +16,8 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./types/class-utilities-types"), exports);
 __exportStar(require("./retries/Retries"), exports);
+__exportStar(require("./queue/LRUQueue"), exports);
+__exportStar(require("./queue/LRUQueueFactory"), exports);
 __exportStar(require("./promises/PromiseMaxConcurrency"), exports);
 __exportStar(require("./object/getProperty"), exports);
 __exportStar(require("./metadata/CopyReflection"), exports);

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,gEAA8C;AAC9C,oDAAkC;AAClC,mEAAiD;AACjD,uDAAqC;AACrC,4DAA0C;AAC1C,4DAA0C;AAC1C,gDAA8B;AAC9B,2DAAyC;AACzC,iEAA+C;AAC/C,mDAAiC;AACjC,iDAA+B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,gEAA8C;AAC9C,oDAAkC;AAClC,mDAAiC;AACjC,0DAAwC;AACxC,mEAAiD;AACjD,uDAAqC;AACrC,4DAA0C;AAC1C,4DAA0C;AAC1C,gDAA8B;AAC9B,2DAAyC;AACzC,iEAA+C;AAC/C,mDAAiC;AACjC,iDAA+B"}

package/dist/queue/LRUQueue.d.ts

@@ -0,0 +1,31 @@
+export type LRUQueueSetOptions<T> = {
+    keySelector: (value: T) => string;
+    /** Defaults to JSON.stringify when omitted. */
+    serialize?: (value: T) => string;
+    /** Defaults to JSON.parse when omitted. */
+    deserialize?: (payload: string) => T;
+};
+/**
+ * Least Recently Used (LRU) queue implementation using SQLite.
+ */
+export declare class LRUQueue<T> implements Disposable {
+    private readonly db;
+    private readonly keySelector;
+    private readonly serialize;
+    private readonly deserialize;
+    private readonly insertQueue;
+    private readonly selectOldestN;
+    private readonly markFetchedById;
+    private readonly selectPeekOldest;
+    private readonly selectPeekNewest;
+    private readonly selectCount;
+    get size(): number;
+    constructor({ keySelector, serialize, deserialize }: LRUQueueSetOptions<T>);
+    enqueue(...values: Array<T>): number;
+    dequeue(count?: number): Array<T>;
+    peekOldest(): T | undefined;
+    peekNewest(): T | undefined;
+    clone(): LRUQueue<T>;
+    toFile(filePath?: string): string;
+    [Symbol.dispose](): void;
+}

package/dist/queue/LRUQueue.js

@@ -0,0 +1,180 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LRUQueue = void 0;
+const node_crypto_1 = require("node:crypto");
+const path = __importStar(require("node:path"));
+const node_path_1 = require("node:path");
+const node_sqlite_1 = require("node:sqlite");
+/**
+ * Least Recently Used (LRU) queue implementation using SQLite.
+ */
+class LRUQueue {
+    db;
+    keySelector;
+    serialize;
+    deserialize;
+    insertQueue;
+    selectOldestN;
+    markFetchedById;
+    selectPeekOldest;
+    selectPeekNewest;
+    selectCount;
+    get size() {
+        const row = this.selectCount.get();
+        return row?.c ?? 0;
+    }
+    constructor({ keySelector, serialize, deserialize }) {
+        this.db = new node_sqlite_1.DatabaseSync(':memory:');
+        this.db.exec(`
+      PRAGMA journal_mode = MEMORY;
+      PRAGMA synchronous = OFF;
+
+      CREATE TABLE queue (
+        id INTEGER PRIMARY KEY AUTOINCREMENT,
+        item_key TEXT NOT NULL UNIQUE,
+        payload TEXT NOT NULL,
+        fetched INTEGER NOT NULL DEFAULT 0
+          CHECK (fetched IN (0, 1))
+      );
+
+      CREATE INDEX idx_queue_pending ON queue (fetched, id);
+    `);
+        this.keySelector = keySelector;
+        this.serialize = serialize ?? ((value) => JSON.stringify(value));
+        this.deserialize =
+            deserialize ?? ((payload) => JSON.parse(payload));
+        this.insertQueue = this.db.prepare('INSERT OR IGNORE INTO queue (item_key, payload) VALUES (?, ?)');
+        this.selectOldestN = this.db.prepare(`SELECT id, payload FROM queue
+       WHERE fetched = 0 ORDER BY id ASC LIMIT ?`);
+        this.markFetchedById = this.db.prepare('UPDATE queue SET fetched = 1 WHERE id = ? AND fetched = 0');
+        this.selectPeekOldest = this.db.prepare(`SELECT payload FROM queue
+       WHERE fetched = 0 ORDER BY id ASC LIMIT 1`);
+        this.selectPeekNewest = this.db.prepare(`SELECT payload FROM queue
+       WHERE fetched = 0 ORDER BY id DESC LIMIT 1`);
+        this.selectCount = this.db.prepare('SELECT COUNT(*) AS c FROM queue WHERE fetched = 0');
+    }
+    enqueue(...values) {
+        let added = 0;
+        this.db.exec('BEGIN IMMEDIATE');
+        try {
+            for (const value of values) {
+                const key = this.keySelector(value);
+                const payload = this.serialize(value);
+                const insertResult = this.insertQueue.run(key, payload);
+                if (insertResult.changes === 0) {
+                    continue;
+                }
+                added++;
+            }
+            this.db.exec('COMMIT');
+        }
+        catch (error) {
+            this.db.exec('ROLLBACK');
+            throw error;
+        }
+        return added;
+    }
+    dequeue(count = 1) {
+        if (!Number.isInteger(count) || count < 0) {
+            throw new Error('count must be a non-negative integer');
+        }
+        if (count === 0) {
+            return [];
+        }
+        this.db.exec('BEGIN IMMEDIATE');
+        try {
+            const rows = this.selectOldestN.all(count);
+            if (rows.length === 0) {
+                this.db.exec('COMMIT');
+                return [];
+            }
+            for (const row of rows) {
+                this.markFetchedById.run(row.id);
+            }
+            this.db.exec('COMMIT');
+            return rows.map((row) => this.deserialize(row.payload));
+        }
+        catch (error) {
+            this.db.exec('ROLLBACK');
+            throw error;
+        }
+    }
+    peekOldest() {
+        const row = this.selectPeekOldest.get();
+        return row ? this.deserialize(row.payload) : undefined;
+    }
+    peekNewest() {
+        const row = this.selectPeekNewest.get();
+        return row ? this.deserialize(row.payload) : undefined;
+    }
+    clone() {
+        const cloned = new LRUQueue({
+            keySelector: this.keySelector,
+            serialize: this.serialize,
+            deserialize: this.deserialize,
+        });
+        const rows = this.db
+            .prepare('SELECT item_key, payload, fetched FROM queue ORDER BY id ASC')
+            .all();
+        if (rows.length === 0) {
+            return cloned;
+        }
+        const insert = cloned.db.prepare('INSERT INTO queue (item_key, payload, fetched) VALUES (?, ?, ?)');
+        cloned.db.exec('BEGIN IMMEDIATE');
+        try {
+            for (const row of rows) {
+                insert.run(row.item_key, row.payload, row.fetched);
+            }
+            cloned.db.exec('COMMIT');
+        }
+        catch (error) {
+            cloned.db.exec('ROLLBACK');
+            throw error;
+        }
+        return cloned;
+    }
+    toFile(filePath) {
+        const absolutePath = (0, node_path_1.resolve)(filePath ?? path.join(process.cwd(), `${(0, node_crypto_1.randomUUID)()}.sqlite`));
+        const escaped = absolutePath.replace(/'/g, `''`);
+        this.db.exec(`VACUUM INTO '${escaped}'`);
+        return absolutePath;
+    }
+    [Symbol.dispose]() {
+        this.db[Symbol.dispose]();
+    }
+}
+exports.LRUQueue = LRUQueue;
+//# sourceMappingURL=LRUQueue.js.map

package/dist/queue/LRUQueue.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LRUQueue.js","sourceRoot":"","sources":["../../src/queue/LRUQueue.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAAyC;AACzC,gDAAkC;AAClC,yCAAoC;AACpC,6CAA0D;AAU1D;;GAEG;AACH,MAAa,QAAQ;IACF,EAAE,CAAe;IACjB,WAAW,CAAuB;IAClC,SAAS,CAAuB;IAChC,WAAW,CAAyB;IAEpC,WAAW,CAAgB;IAC3B,aAAa,CAAgB;IAC7B,eAAe,CAAgB;IAC/B,gBAAgB,CAAgB;IAChC,gBAAgB,CAAgB;IAChC,WAAW,CAAgB;IAE5C,IAAI,IAAI;QACN,MAAM,GAAG,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,EAA+B,CAAC;QAEhE,OAAO,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC;IACrB,CAAC;IAED,YAAY,EAAE,WAAW,EAAE,SAAS,EAAE,WAAW,EAAyB;QACxE,IAAI,CAAC,EAAE,GAAG,IAAI,0BAAY,CAAC,UAAU,CAAC,CAAC;QACvC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC;;;;;;;;;;;;;KAaZ,CAAC,CAAC;QAEH,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,SAAS,GAAG,SAAS,IAAI,CAAC,CAAC,KAAQ,EAAU,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;QAC5E,IAAI,CAAC,WAAW;YACd,WAAW,IAAI,CAAC,CAAC,OAAe,EAAK,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAM,CAAC,CAAC;QAEpE,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,EAAE,CAAC,OAAO,CAChC,+DAA+D,CAChE,CAAC;QACF,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,EAAE,CAAC,OAAO,CAClC;iDAC2C,CAC5C,CAAC;QACF,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,EAAE,CAAC,OAAO,CACpC,2DAA2D,CAC5D,CAAC;QACF,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC,EAAE,CAAC,OAAO,CACrC;iDAC2C,CAC5C,CAAC;QACF,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC,EAAE,CAAC,OAAO,CACrC;kDAC4C,CAC7C,CAAC;QACF,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,EAAE,CAAC,OAAO,CAChC,mDAAmD,CACpD,CAAC;IACJ,CAAC;IAED,OAAO,CAAC,GAAG,MAAgB;QACzB,IAAI,KAAK,GAAG,CAAC,CAAC;QAEd,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QAChC,IAAI,CAAC;YACH,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;gBAC3B,MAAM,GAAG,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;gBACpC,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;gBACtC,MAAM,YAAY,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;gBAExD,IAAI,YAAY,CAAC,OAAO,KAAK,CAAC,EAAE,CAAC;oBAC/B,SAAS;gBACX,CAAC;gBAED,KAAK,EAAE,CAAC;YACV,CAAC;YAED,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACzB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YACzB,MAAM,KAAK,CAAC;QACd,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO,CAAC,KAAK,GAAG,CAAC;QACf,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;YAC1C,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;QAC1D,CAAC;QAED,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;YAChB,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QAChC,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,CAGvC,CAAC;YAEH,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACtB,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBAEvB,OAAO,EAAE,CAAC;YACZ,CAAC;YAED,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;gBACvB,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YACnC,CAAC;YAED,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAEvB,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC;QAC1D,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YACzB,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAED,UAAU;QACR,MAAM,GAAG,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,EAAqC,CAAC;QAE3E,OAAO,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACzD,CAAC;IAED,UAAU;QACR,MAAM,GAAG,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,EAAqC,CAAC;QAE3E,OAAO,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACzD,CAAC;IAED,KAAK;QACH,MAAM,MAAM,GAAG,IAAI,QAAQ,CAAI;YAC7B,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,WAAW,EAAE,IAAI,CAAC,WAAW;SAC9B,CAAC,CAAC;QAEH,MAAM,IAAI,GAAG,IAAI,CAAC,EAAE;aACjB,OAAO,CAAC,8DAA8D,CAAC;aACvE,GAAG,EAAmE,CAAC;QAE1E,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACtB,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,MAAM,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC,OAAO,CAC9B,iEAAiE,CAClE,CAAC;QAEF,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QAClC,IAAI,CAAC;YACH,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;gBACvB,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;YACrD,CAAC;YAED,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC3B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YAC3B,MAAM,KAAK,CAAC;QACd,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,MAAM,CAAC,QAAiB;QACtB,MAAM,YAAY,GAAG,IAAA,mBAAO,EAC1B,QAAQ,IAAI,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,GAAG,IAAA,wBAAU,GAAE,SAAS,CAAC,CAC/D,CAAC;QACF,MAAM,OAAO,GAAG,YAAY,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAEjD,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,gBAAgB,OAAO,GAAG,CAAC,CAAC;QAEzC,OAAO,YAAY,CAAC;IACtB,CAAC;IAED,CAAC,MAAM,CAAC,OAAO,CAAC;QACd,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;IAC5B,CAAC;CACF;AAzLD,4BAyLC"}

package/dist/queue/LRUQueueFactory.d.ts

@@ -0,0 +1,4 @@
+import { LRUQueue, LRUQueueSetOptions } from './LRUQueue';
+export declare class LRUQueueFactory {
+    create<T>(options: LRUQueueSetOptions<T>): LRUQueue<T>;
+}

package/dist/queue/LRUQueueFactory.js

@@ -0,0 +1,21 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LRUQueueFactory = void 0;
+const LRUQueue_1 = require("./LRUQueue");
+const inversify_1 = require("inversify");
+let LRUQueueFactory = class LRUQueueFactory {
+    create(options) {
+        return new LRUQueue_1.LRUQueue(options);
+    }
+};
+exports.LRUQueueFactory = LRUQueueFactory;
+exports.LRUQueueFactory = LRUQueueFactory = __decorate([
+    (0, inversify_1.injectable)()
+], LRUQueueFactory);
+//# sourceMappingURL=LRUQueueFactory.js.map

package/dist/queue/LRUQueueFactory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LRUQueueFactory.js","sourceRoot":"","sources":["../../src/queue/LRUQueueFactory.ts"],"names":[],"mappings":";;;;;;;;;AAAA,yCAA0D;AAC1D,yCAAuC;AAGhC,IAAM,eAAe,GAArB,MAAM,eAAe;IAC1B,MAAM,CAAI,OAA8B;QACtC,OAAO,IAAI,mBAAQ,CAAC,OAAO,CAAC,CAAC;IAC/B,CAAC;CACF,CAAA;AAJY,0CAAe;0BAAf,eAAe;IAD3B,IAAA,sBAAU,GAAE;GACA,eAAe,CAI3B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squiz/optimization-utils",
-  "version": "7.0.0",
+  "version": "7.1.0",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -35,7 +35,7 @@
   "devDependencies": {},
   "peerDependencies": {
     "inversify": "^7.11.0",
-    "@squiz/optimization-logger": "^1.11.0"
+    "@squiz/optimization-logger": "^1.11.3"
   },
   "author": "",
   "license": "ISC"