@quillsql/node 0.9.16 → 0.9.18

package/dist/esm/models/Cache.d.ts

@@ -1,18 +1,13 @@
 export interface Mappable {
     get(key: string): Promise<string | null>;
     set(key: string, value: string, type?: string, ttl?: number): Promise<string | null>;
-    lRange(key: string, start: number, stop: number): Promise<string[]>;
-    rPush(key: string, elements: string[]): Promise<number>;
-    expire(key: string, seconds: number): Promise<number | boolean>;
-    del(...keys: string[]): Promise<number>;
-    multi(): CacheTransaction;
-}
-export interface CacheTransaction {
-    del(...keys: string[]): CacheTransaction;
-    rPush(key: string, elements: string[]): CacheTransaction;
-    expire(key: string, seconds: number): CacheTransaction;
-    set(key: string, value: string, type?: string, ttl?: number): CacheTransaction;
-    exec(): Promise<unknown>;
+    set(key: string, value: string, options: {
+        NX?: boolean;
+        XX?: boolean;
+        EX?: number;
+        PX?: number;
+    }): Promise<string | null>;
+    del(key: string): Promise<number>;
 }
 export interface CacheCredentials {
     username: string;

package/dist/esm/utils/Lock.d.ts

@@ -0,0 +1,13 @@
+import { Mappable } from "../models/Cache";
+export declare class Lock {
+    private readonly cacheLockKey;
+    private readonly lastCacheKey;
+    private readonly ttlSeconds;
+    private readonly cooldownMs;
+    constructor(clientId: string);
+    acquire(cache: Mappable): Promise<string>;
+    release(cache: Mappable, lockValue: string): Promise<void>;
+    releaseSafely(cache: Mappable, lockValue: string): Promise<void>;
+    persistCooldown(cache: Mappable): Promise<void>;
+    persistCooldownSafely(cache: Mappable): Promise<void>;
+}

package/dist/esm/utils/Lock.js

@@ -0,0 +1,73 @@
+// A 2-part lock: 
+// 1) Redis Distributed lock ( 1 machine can hold it at a time )
+// 2) 6-hour Cooldown 
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+export class Lock {
+    constructor(clientId) {
+        this.ttlSeconds = 90 * 60; // 90 minutes
+        this.cooldownMs = 6 * 60 * 60 * 1000; // 6 hours
+        this.cacheLockKey = `quill:sdk:cache:lock:${clientId}`;
+        this.lastCacheKey = `quill:sdk:cache:locktime:${clientId}`;
+    }
+    acquire(cache) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const lockValue = `${process.pid}:${Date.now()}:${Math.random().toString(36).slice(2)}`;
+            const acquired = yield cache.set(this.cacheLockKey, lockValue, { NX: true, EX: this.ttlSeconds });
+            if (!acquired) {
+                throw new Error(".cache() is being called by another instance already. Please try again later.");
+            }
+            const raw = yield cache.get(this.lastCacheKey);
+            const lastCacheRunAt = raw ? Number(raw) : NaN;
+            if (Number.isFinite(lastCacheRunAt) && Date.now() - lastCacheRunAt < this.cooldownMs) {
+                yield this.release(cache, lockValue);
+                throw new Error("Caching cooldown is active. Please try again later.");
+            }
+            return lockValue;
+        });
+    }
+    release(cache, lockValue) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            const acquiredAtMs = Number((_a = lockValue.split(":")[1]) !== null && _a !== void 0 ? _a : "0");
+            if (acquiredAtMs > 0 && Date.now() - acquiredAtMs >= (this.ttlSeconds - 60) * 1000)
+                return;
+            if ((yield cache.get(this.cacheLockKey)) !== lockValue)
+                return;
+            yield cache.del(this.cacheLockKey);
+        });
+    }
+    releaseSafely(cache, lockValue) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                yield this.release(cache, lockValue);
+            }
+            catch (error) {
+                console.warn("Failed to release cache lock", error);
+            }
+        });
+    }
+    persistCooldown(cache) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield cache.set(this.lastCacheKey, String(Date.now()), { EX: this.cooldownMs / 1000 });
+        });
+    }
+    persistCooldownSafely(cache) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                yield this.persistCooldown(cache);
+            }
+            catch (error) {
+                console.warn("Caching complete but failed to persist last cache run time", error);
+            }
+        });
+    }
+}
+//# sourceMappingURL=Lock.js.map

package/dist/esm/utils/Lock.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Lock.js","sourceRoot":"","sources":["../../../src/utils/Lock.ts"],"names":[],"mappings":"AAAA,kBAAkB;AAClB,gEAAgE;AAChE,sBAAsB;;;;;;;;;;AAItB,MAAM,OAAO,IAAI;IAMf,YAAY,QAAgB;QAHX,eAAU,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,aAAa;QACnC,eAAU,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,UAAU;QAG1D,IAAI,CAAC,YAAY,GAAG,wBAAwB,QAAQ,EAAE,CAAC;QACvD,IAAI,CAAC,YAAY,GAAG,4BAA4B,QAAQ,EAAE,CAAC;IAC7D,CAAC;IAEY,OAAO,CAAC,KAAe;;YAClC,MAAM,SAAS,GAAG,GAAG,OAAO,CAAC,GAAG,IAAI,IAAI,CAAC,GAAG,EAAE,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;YAExF,MAAM,QAAQ,GAAkB,MAAM,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,EAAE,SAAS,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,CAAC,UAAU,EAAE,CAAC,CAAA;YAChH,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACb,MAAM,IAAI,KAAK,CAAC,+EAA+E,CAAC,CAAC;YACpG,CAAC;YAED,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YAC/C,MAAM,cAAc,GAAG,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;YAC/C,IAAI,MAAM,CAAC,QAAQ,CAAC,cAAc,CAAC,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,cAAc,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;gBACrF,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;gBACrC,MAAM,IAAI,KAAK,CAAC,qDAAqD,CAAC,CAAC;YACzE,CAAC;YAED,OAAO,SAAS,CAAC;QACnB,CAAC;KAAA;IAEY,OAAO,CAAC,KAAe,EAAE,SAAiB;;;YACrD,MAAM,YAAY,GAAG,MAAM,CAAC,MAAA,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,mCAAI,GAAG,CAAC,CAAC;YAC5D,IAAI,YAAY,GAAG,CAAC,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,YAAY,IAAI,CAAC,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC,GAAG,IAAI;gBAAE,OAAO;YAC3F,IAAI,CAAC,MAAM,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,KAAK,SAAS;gBAAE,OAAO;YAC/D,MAAM,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QACrC,CAAC;KAAA;IAEY,aAAa,CAAC,KAAe,EAAE,SAAiB;;YAC3D,IAAI,CAAC;gBACH,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;YACvC,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,OAAO,CAAC,IAAI,CAAC,8BAA8B,EAAE,KAAK,CAAC,CAAC;YACtD,CAAC;QACH,CAAC;KAAA;IAEY,eAAe,CAAC,KAAe;;YAC1C,MAAM,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,IAAI,CAAC,UAAU,GAAG,IAAI,EAAE,CAAC,CAAC;QACzF,CAAC;KAAA;IAEY,qBAAqB,CAAC,KAAe;;YAChD,IAAI,CAAC;gBACH,MAAM,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;YACpC,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,OAAO,CAAC,IAAI,CAAC,4DAA4D,EAAE,KAAK,CAAC,CAAC;YACpF,CAAC;QACH,CAAC;KAAA;CACF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quillsql/node",
-  "version": "0.9.16",
+  "version": "0.9.18",
   "description": "Quill Server SDK for Node.js",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -18,7 +18,7 @@
     "mssql:dev": "nodemon ./examples/mssql-node/app.ts",
     "databricks:dev": "nodemon ./examples/databricks-node/app.ts",
     "integration-tests": "jest '.*\\.ispec\\.ts$'",
-    "test": "tsc src && jest --detectOpenHandles",
+    "test": "tsc -p tsconfig.json && jest --detectOpenHandles",
     "style-check": "prettier --check \"**/*.{ts,tsx,md}\"",
     "style-fix": "prettier --write \"**/*.{ts,tsx,md}\"",
     "lint-check": "eslint \"**/*.{ts,tsx}\"",