@sebspark/promise-cache 0.1.0 → 0.2.1

package/dist/index.d.mts

@@ -1,8 +1,26 @@
-declare class PromiseCache<T, U> {
+declare class PromiseCache<U> {
     private cache;
+    private readonly caseSensitive;
     private readonly ttl;
-    constructor(ttlInSeconds: number);
-    wrap(key: T, delegate: () => Promise<U>): Promise<U>;
+    /**
+     * Initialize a new PromiseCache.
+     * @param ttlInSeconds Default cache TTL.
+     * @param caseSensitive Set to true if you want to differentiate between keys with different casing.
+     */
+    constructor(ttlInSeconds: number, caseSensitive?: boolean);
+    /**
+     * Cache size.
+     * @returns The number of entries in the cache.
+     */
+    size(): Promise<number>;
+    /**
+     * A simple promise cache wrapper.
+     * @param key Cache key.
+     * @param delegate The function to execute if the key is not in the cache.
+     * @param ttlInSeconds Time to live in seconds.
+     * @returns The result of the delegate function.
+     */
+    wrap(key: string, delegate: () => Promise<U>, ttlInSeconds?: number): Promise<U>;
 }
 
 export { PromiseCache };

package/dist/index.d.ts

@@ -1,8 +1,26 @@
-declare class PromiseCache<T, U> {
+declare class PromiseCache<U> {
     private cache;
+    private readonly caseSensitive;
     private readonly ttl;
-    constructor(ttlInSeconds: number);
-    wrap(key: T, delegate: () => Promise<U>): Promise<U>;
+    /**
+     * Initialize a new PromiseCache.
+     * @param ttlInSeconds Default cache TTL.
+     * @param caseSensitive Set to true if you want to differentiate between keys with different casing.
+     */
+    constructor(ttlInSeconds: number, caseSensitive?: boolean);
+    /**
+     * Cache size.
+     * @returns The number of entries in the cache.
+     */
+    size(): Promise<number>;
+    /**
+     * A simple promise cache wrapper.
+     * @param key Cache key.
+     * @param delegate The function to execute if the key is not in the cache.
+     * @param ttlInSeconds Time to live in seconds.
+     * @returns The result of the delegate function.
+     */
+    wrap(key: string, delegate: () => Promise<U>, ttlInSeconds?: number): Promise<U>;
 }
 
 export { PromiseCache };

package/dist/index.js

@@ -24,23 +24,120 @@ __export(src_exports, {
 });
 module.exports = __toCommonJS(src_exports);
 
+// src/persistor.ts
+var import_redis = require("redis");
+var REDIS_HOST = process.env.REDIS_HOST || "redis";
+var REDIS_PORT = process.env.REDIS_PORT || 6379;
+var REDIS_URL = `redis://${REDIS_HOST}:${REDIS_PORT}`;
+var Persistor = class {
+  client;
+  constructor() {
+    this.client = (0, import_redis.createClient)({ url: REDIS_URL }).on(
+      "error",
+      (err) => console.error(`\u274C REDIS | Client Error | ${REDIS_URL}`, err)
+    ).on(
+      "connect",
+      () => console.info(`\u{1F4E6} REDIS | Connection Ready | ${REDIS_URL}`)
+    );
+  }
+  async size() {
+    if (!this.client) {
+      throw new Error("Client not initialized");
+    }
+    return await this.client.DBSIZE();
+  }
+  async get(key) {
+    if (!this.client) {
+      throw new Error("Client not initialized");
+    }
+    try {
+      const result = await this.client.get(key);
+      if (!result) {
+        return null;
+      }
+      return JSON.parse(result);
+    } catch (error) {
+      console.error(`Error getting data from redis: ${error}`);
+      throw error;
+    }
+  }
+  async set(key, { value, timestamp, ttl }) {
+    if (!this.client) {
+      throw new Error("Client not initialized");
+    }
+    try {
+      const serializedData = JSON.stringify({ value, ttl, timestamp });
+      await this.client.set(key, serializedData, {
+        EX: ttl / 1e3
+      });
+    } catch (error) {
+      console.error(`Error setting data in redis: ${error}`);
+      throw error;
+    }
+  }
+  async delete(key) {
+    if (!this.client) {
+      throw new Error("Client not initialized");
+    }
+    try {
+      await this.client.del(key);
+    } catch (error) {
+      console.error(`Error deleting data from redis: ${error}`);
+      throw error;
+    }
+  }
+};
+var persistor = new Persistor();
+
 // src/promiseCache.ts
 var PromiseCache = class {
   cache;
+  caseSensitive;
   ttl;
-  // Time to live in milliseconds
-  constructor(ttlInSeconds) {
-    this.cache = /* @__PURE__ */ new Map();
+  // Time to live in milliseconds.
+  /**
+   * Initialize a new PromiseCache.
+   * @param ttlInSeconds Default cache TTL.
+   * @param caseSensitive Set to true if you want to differentiate between keys with different casing.
+   */
+  constructor(ttlInSeconds, caseSensitive = false) {
+    this.cache = persistor;
+    this.caseSensitive = caseSensitive;
     this.ttl = ttlInSeconds * 1e3;
   }
-  async wrap(key, delegate) {
+  /**
+   * Cache size.
+   * @returns The number of entries in the cache.
+   */
+  async size() {
+    return await this.cache.size();
+  }
+  /**
+   * A simple promise cache wrapper.
+   * @param key Cache key.
+   * @param delegate The function to execute if the key is not in the cache.
+   * @param ttlInSeconds Time to live in seconds.
+   * @returns The result of the delegate function.
+   */
+  async wrap(key, delegate, ttlInSeconds) {
     const now = Date.now();
-    const cached = this.cache.get(key);
-    if (cached && now - cached.timestamp < this.ttl) {
+    const effectiveKey = this.caseSensitive ? key : key.toLowerCase();
+    const effectiveTTL = ttlInSeconds !== void 0 ? ttlInSeconds * 1e3 : this.ttl;
+    const cached = await this.cache.get(effectiveKey);
+    if (cached) {
+      if (cached.ttl !== effectiveTTL) {
+        console.error(
+          `WARNING: TTL mismatch for key: ${effectiveKey}. It is recommended to use the same TTL for the same key.`
+        );
+      }
       return cached.value;
     }
     const response = await delegate();
-    this.cache.set(key, { value: response, timestamp: now });
+    this.cache.set(effectiveKey, {
+      value: response,
+      timestamp: now,
+      ttl: effectiveTTL
+    });
     return response;
   }
 };

package/dist/index.mjs

@@ -1,20 +1,117 @@
+// src/persistor.ts
+import { createClient } from "redis";
+var REDIS_HOST = process.env.REDIS_HOST || "redis";
+var REDIS_PORT = process.env.REDIS_PORT || 6379;
+var REDIS_URL = `redis://${REDIS_HOST}:${REDIS_PORT}`;
+var Persistor = class {
+  client;
+  constructor() {
+    this.client = createClient({ url: REDIS_URL }).on(
+      "error",
+      (err) => console.error(`\u274C REDIS | Client Error | ${REDIS_URL}`, err)
+    ).on(
+      "connect",
+      () => console.info(`\u{1F4E6} REDIS | Connection Ready | ${REDIS_URL}`)
+    );
+  }
+  async size() {
+    if (!this.client) {
+      throw new Error("Client not initialized");
+    }
+    return await this.client.DBSIZE();
+  }
+  async get(key) {
+    if (!this.client) {
+      throw new Error("Client not initialized");
+    }
+    try {
+      const result = await this.client.get(key);
+      if (!result) {
+        return null;
+      }
+      return JSON.parse(result);
+    } catch (error) {
+      console.error(`Error getting data from redis: ${error}`);
+      throw error;
+    }
+  }
+  async set(key, { value, timestamp, ttl }) {
+    if (!this.client) {
+      throw new Error("Client not initialized");
+    }
+    try {
+      const serializedData = JSON.stringify({ value, ttl, timestamp });
+      await this.client.set(key, serializedData, {
+        EX: ttl / 1e3
+      });
+    } catch (error) {
+      console.error(`Error setting data in redis: ${error}`);
+      throw error;
+    }
+  }
+  async delete(key) {
+    if (!this.client) {
+      throw new Error("Client not initialized");
+    }
+    try {
+      await this.client.del(key);
+    } catch (error) {
+      console.error(`Error deleting data from redis: ${error}`);
+      throw error;
+    }
+  }
+};
+var persistor = new Persistor();
+
 // src/promiseCache.ts
 var PromiseCache = class {
   cache;
+  caseSensitive;
   ttl;
-  // Time to live in milliseconds
-  constructor(ttlInSeconds) {
-    this.cache = /* @__PURE__ */ new Map();
+  // Time to live in milliseconds.
+  /**
+   * Initialize a new PromiseCache.
+   * @param ttlInSeconds Default cache TTL.
+   * @param caseSensitive Set to true if you want to differentiate between keys with different casing.
+   */
+  constructor(ttlInSeconds, caseSensitive = false) {
+    this.cache = persistor;
+    this.caseSensitive = caseSensitive;
     this.ttl = ttlInSeconds * 1e3;
   }
-  async wrap(key, delegate) {
+  /**
+   * Cache size.
+   * @returns The number of entries in the cache.
+   */
+  async size() {
+    return await this.cache.size();
+  }
+  /**
+   * A simple promise cache wrapper.
+   * @param key Cache key.
+   * @param delegate The function to execute if the key is not in the cache.
+   * @param ttlInSeconds Time to live in seconds.
+   * @returns The result of the delegate function.
+   */
+  async wrap(key, delegate, ttlInSeconds) {
     const now = Date.now();
-    const cached = this.cache.get(key);
-    if (cached && now - cached.timestamp < this.ttl) {
+    const effectiveKey = this.caseSensitive ? key : key.toLowerCase();
+    const effectiveTTL = ttlInSeconds !== void 0 ? ttlInSeconds * 1e3 : this.ttl;
+    const cached = await this.cache.get(effectiveKey);
+    if (cached) {
+      if (cached.ttl !== effectiveTTL) {
+        console.error(
+          `WARNING: TTL mismatch for key: ${effectiveKey}. It is recommended to use the same TTL for the same key.`
+        );
+      }
       return cached.value;
     }
     const response = await delegate();
-    this.cache.set(key, { value: response, timestamp: now });
+    this.cache.set(effectiveKey, {
+      value: response,
+      timestamp: now,
+      ttl: effectiveTTL
+    });
     return response;
   }
 };

package/package.json

@@ -1,13 +1,11 @@
 {
   "name": "@sebspark/promise-cache",
-  "version": "0.1.0",
+  "version": "0.2.1",
   "license": "Apache-2.0",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
   "types": "dist/index.d.ts",
-  "files": [
-    "dist"
-  ],
+  "files": ["dist"],
   "scripts": {
     "build": "tsup-node src/index.ts --format esm,cjs --dts",
     "dev": "tsc --watch --noEmit",
@@ -17,5 +15,8 @@
   },
   "devDependencies": {
     "tsconfig": "*"
+  },
+  "dependencies": {
+    "redis": "^4.6.13"
   }
-}
+}