descript-redis-cache 4.0.6 → 4.1.0

package/build/index.d.ts

@@ -1,4 +1,4 @@
-import type { CacheInterface } from 'descript';
+import type { CacheInterface, LoggerInterface } from 'descript';
 import type { ClusterNode, ClusterOptions, RedisOptions } from 'ioredis';
 import { Cluster, Redis } from 'ioredis';
 export interface Options {
@@ -8,15 +8,15 @@ export interface Options {
     generation?: number;
     /** read timeout in milliseconds (default: 100) */
     readTimeout?: number;
+    /** use two clients (reader and writer) with Sentinel (default: false) */
+    useReaderAndWriterWithSentinel?: boolean;
     /** redis config */
     redis: RedisOptions | {
         startupNodes: ClusterNode[];
         options?: ClusterOptions;
     };
 }
-interface Logger {
-    log(event: LoggerEvent): void;
-}
+type Logger = LoggerInterface<LoggerEvent>;
 interface Timers {
     start: number;
     end: number;
@@ -24,9 +24,6 @@ interface Timers {
 export type LoggerEvent = ({
     type: EVENT.REDIS_CACHE_INITIALIZED;
     options: Options;
-} | {
-    type: EVENT.REDIS_CACHE_ERROR;
-    error: Error;
 } | {
     type: EVENT.REDIS_CACHE_READ_START;
     key: string;
@@ -73,7 +70,7 @@ export type LoggerEvent = ({
     timers: Timers;
 } | {
     type: EVENT.REDIS_CACHE_WRITE_ERROR;
-    error: unknown;
+    error: Error;
     key: string;
     normalizedKey: string;
     timers: Timers;
@@ -92,7 +89,10 @@ export type LoggerEvent = ({
 export declare class Cache<Result> implements CacheInterface<Result> {
     #private;
     constructor(options: Options, logger?: Logger);
-    getClient(): Cluster | Redis;
+    getClient(): {
+        reader: Cluster | Redis;
+        writer: Cluster | Redis;
+    };
     get({ key }: {
         key: string;
     }): Promise<Result | undefined>;
@@ -104,7 +104,6 @@ export declare class Cache<Result> implements CacheInterface<Result> {
 }
 export declare enum EVENT {
     REDIS_CACHE_INITIALIZED = "REDIS_CACHE_INITIALIZED",
-    REDIS_CACHE_ERROR = "REDIS_CACHE_ERROR",
     REDIS_CACHE_JSON_PARSING_FAILED = "REDIS_CACHE_JSON_PARSING_FAILED",
     REDIS_CACHE_JSON_STRINGIFY_FAILED = "REDIS_CACHE_JSON_STRINGIFY_FAILED",
     REDIS_CACHE_READ_DONE = "REDIS_CACHE_READ_DONE",

package/build/index.js

@@ -10,7 +10,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
-var _Cache_instances, _Cache_client, _Cache_logger, _Cache_options, _Cache_normalizeKey, _Cache_log;
+var _Cache_instances, _Cache_writer, _Cache_reader, _Cache_logger, _Cache_options, _Cache_normalizeKey, _Cache_log;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.EVENT = exports.Cache = void 0;
 const node_crypto_1 = require("node:crypto");
@@ -19,7 +19,8 @@ const ioredis_1 = require("ioredis");
 class Cache {
     constructor(options, logger) {
         _Cache_instances.add(this);
-        _Cache_client.set(this, void 0);
+        _Cache_writer.set(this, void 0);
+        _Cache_reader.set(this, void 0);
         _Cache_logger.set(this, void 0);
         _Cache_options.set(this, void 0);
         __classPrivateFieldSet(this, _Cache_options, {
@@ -30,10 +31,27 @@ class Cache {
         }, "f");
         __classPrivateFieldSet(this, _Cache_logger, logger, "f");
         if ('startupNodes' in __classPrivateFieldGet(this, _Cache_options, "f").redis) {
-            __classPrivateFieldSet(this, _Cache_client, new ioredis_1.Cluster(__classPrivateFieldGet(this, _Cache_options, "f").redis.startupNodes, __classPrivateFieldGet(this, _Cache_options, "f").redis.options), "f");
+            __classPrivateFieldSet(this, _Cache_reader, new ioredis_1.Cluster(__classPrivateFieldGet(this, _Cache_options, "f").redis.startupNodes, __classPrivateFieldGet(this, _Cache_options, "f").redis.options), "f");
+            __classPrivateFieldSet(this, _Cache_writer, __classPrivateFieldGet(this, _Cache_reader, "f"), "f");
         }
         else {
-            __classPrivateFieldSet(this, _Cache_client, new ioredis_1.Redis(__classPrivateFieldGet(this, _Cache_options, "f").redis), "f");
+            if (__classPrivateFieldGet(this, _Cache_options, "f").useReaderAndWriterWithSentinel) {
+                // Client for write (always on master)
+                __classPrivateFieldSet(this, _Cache_writer, new ioredis_1.Redis({
+                    ...__classPrivateFieldGet(this, _Cache_options, "f").redis,
+                    role: 'master',
+                }), "f");
+                // Client for read (replica, only read-only commands)
+                __classPrivateFieldSet(this, _Cache_reader, new ioredis_1.Redis({
+                    ...__classPrivateFieldGet(this, _Cache_options, "f").redis,
+                    role: 'slave',
+                    readOnly: true,
+                }), "f");
+            }
+            else {
+                __classPrivateFieldSet(this, _Cache_reader, new ioredis_1.Redis(__classPrivateFieldGet(this, _Cache_options, "f").redis), "f");
+                __classPrivateFieldSet(this, _Cache_writer, __classPrivateFieldGet(this, _Cache_reader, "f"), "f");
+            }
         }
         __classPrivateFieldGet(this, _Cache_instances, "m", _Cache_log).call(this, {
             type: EVENT.REDIS_CACHE_INITIALIZED,
@@ -41,7 +59,10 @@ class Cache {
         });
     }
     getClient() {
-        return __classPrivateFieldGet(this, _Cache_client, "f");
+        return {
+            reader: __classPrivateFieldGet(this, _Cache_reader, "f"),
+            writer: __classPrivateFieldGet(this, _Cache_writer, "f"),
+        };
     }
     get({ key }) {
         const normalizedKey = __classPrivateFieldGet(this, _Cache_instances, "m", _Cache_normalizeKey).call(this, key);
@@ -68,7 +89,7 @@ class Cache {
                     id: EVENT.REDIS_CACHE_READ_TIMEOUT,
                 }));
             }, __classPrivateFieldGet(this, _Cache_options, "f").readTimeout);
-            __classPrivateFieldGet(this, _Cache_client, "f").get(normalizedKey, (error, data) => {
+            __classPrivateFieldGet(this, _Cache_reader, "f").get(normalizedKey, (error, data) => {
                 if (isTimeout) {
                     return;
                 }
@@ -173,7 +194,7 @@ class Cache {
                 return;
             }
             // maxage - seconds
-            __classPrivateFieldGet(this, _Cache_client, "f").set(normalizedKey, json, 'EX', maxage, (error, done) => {
+            __classPrivateFieldGet(this, _Cache_writer, "f").set(normalizedKey, json, 'EX', maxage, (error, done) => {
                 if (error) {
                     __classPrivateFieldGet(this, _Cache_instances, "m", _Cache_log).call(this, {
                         type: EVENT.REDIS_CACHE_WRITE_ERROR,
@@ -221,7 +242,7 @@ class Cache {
     }
 }
 exports.Cache = Cache;
-_Cache_client = new WeakMap(), _Cache_logger = new WeakMap(), _Cache_options = new WeakMap(), _Cache_instances = new WeakSet(), _Cache_normalizeKey = function _Cache_normalizeKey(key) {
+_Cache_writer = new WeakMap(), _Cache_reader = new WeakMap(), _Cache_logger = new WeakMap(), _Cache_options = new WeakMap(), _Cache_instances = new WeakSet(), _Cache_normalizeKey = function _Cache_normalizeKey(key) {
     const value = `g${__classPrivateFieldGet(this, _Cache_options, "f").generation}:${key}`;
     return (0, node_crypto_1.hash)('sha512', value);
 }, _Cache_log = function _Cache_log(event) {
@@ -232,7 +253,6 @@ _Cache_client = new WeakMap(), _Cache_logger = new WeakMap(), _Cache_options = n
 var EVENT;
 (function (EVENT) {
     EVENT["REDIS_CACHE_INITIALIZED"] = "REDIS_CACHE_INITIALIZED";
-    EVENT["REDIS_CACHE_ERROR"] = "REDIS_CACHE_ERROR";
     EVENT["REDIS_CACHE_JSON_PARSING_FAILED"] = "REDIS_CACHE_JSON_PARSING_FAILED";
     EVENT["REDIS_CACHE_JSON_STRINGIFY_FAILED"] = "REDIS_CACHE_JSON_STRINGIFY_FAILED";
     EVENT["REDIS_CACHE_READ_DONE"] = "REDIS_CACHE_READ_DONE";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "descript-redis-cache",
-  "version": "4.0.6",
+  "version": "4.1.0",
   "description": "plugin for descript to use redis as cache",
   "main": "./build/index.js",
   "types": "./build/index.d.ts",
@@ -41,7 +41,7 @@
     "@stylistic/eslint-plugin-ts": "^2.11.0",
     "@types/eslint__js": "^8.42.3",
     "@types/node": "^22.10.0",
-    "descript": "^4.0.5",
+    "descript": "^4.0.6",
     "eslint": "^9.15.0",
     "typescript": "^5.7.2",
     "typescript-eslint": "^8.16.0",