@samet-it/be-redis-common 1.1.3 → 1.1.5

package/dist/channel/redis.channel.d.ts

@@ -3,6 +3,7 @@ import type { RedisChannelProps, RedisChannelLike, RedisChannelOpt } from "./ind
 import { type Entity } from "@samet-it/be-base-common";
 import { CacheChannel } from "@samet-it/be-cache-common";
 import type { KeyValue } from "@leyyo/common";
+import type { CacheExecOpt } from "@samet-it/be-cache-common/dist/connection";
 /**
  * Redis abstract channel class
  *
@@ -10,7 +11,7 @@ import type { KeyValue } from "@leyyo/common";
  * - 0-`ENT`: entity {@link Entity}
  * - 1-`ID`: id type {@link KeyValue}
  * */
-export declare abstract class RedisChannel<ENT extends Entity<ID>, ID extends KeyValue> extends CacheChannel<RedisConnectionLike, ENT, ID> implements RedisChannelLike<ENT, ID> {
+export declare class RedisChannel<ENT extends Entity<ID>, ID extends KeyValue> extends CacheChannel<RedisConnectionLike, ENT, ID> implements RedisChannelLike<ENT, ID> {
     /** @inheritDoc */
     protected _props: RedisChannelProps;
     /**
@@ -23,15 +24,21 @@ export declare abstract class RedisChannel<ENT extends Entity<ID>, ID extends Ke
     /** @inheritDoc */
     get props(): Readonly<RedisChannelProps>;
     /** @inheritDoc */
-    $get(...paths: Array<string>): Promise<Array<string>>;
+    $get(path: string, _opt?: CacheExecOpt): Promise<string | undefined>;
     /** @inheritDoc */
-    $set(map: Record<string, string>): Promise<number>;
+    $getMore(paths: Array<string>, _opt?: CacheExecOpt): Promise<Array<string | undefined>>;
     /** @inheritDoc */
-    $delete(...paths: string[]): Promise<number>;
+    $set(path: string, value: string, _opt?: CacheExecOpt): Promise<boolean>;
     /** @inheritDoc */
-    $addLinks(idPath: string, paths: string): Promise<number>;
+    $setMore(map: Record<string, string>, _opt?: CacheExecOpt): Promise<number>;
     /** @inheritDoc */
-    $expire(path: string, seconds: number): Promise<boolean>;
+    $delete(path: string, _opt?: CacheExecOpt): Promise<boolean>;
     /** @inheritDoc */
-    $getLinks(idPath: string): Promise<Array<string>>;
+    $deleteMore(paths: string[], _opt?: CacheExecOpt): Promise<number>;
+    /** @inheritDoc */
+    $addLinks(idPath: string, paths: Array<string>, _opt?: CacheExecOpt): Promise<number>;
+    /** @inheritDoc */
+    $expire(path: string, seconds: number, _opt?: CacheExecOpt): Promise<boolean>;
+    /** @inheritDoc */
+    $getLinks(idPath: string, _opt?: CacheExecOpt): Promise<Array<string>>;
 }

package/dist/channel/redis.channel.js

@@ -50,7 +50,26 @@ class RedisChannel extends be_cache_common_1.CacheChannel {
     // endregion getter
     // region native-calls
     /** @inheritDoc */
-    $get(...paths) {
+    $get(path, _opt) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { client, conn } = this._props;
+            if (!client) {
+                return undefined;
+            }
+            if (typeof path !== 'string') {
+                return undefined;
+            }
+            try {
+                return yield client.get(path);
+            }
+            catch (e) {
+                conn.checkError(e, { name: 'GET', method: '$get' });
+            }
+            return undefined;
+        });
+    }
+    /** @inheritDoc */
+    $getMore(paths, _opt) {
         return __awaiter(this, void 0, void 0, function* () {
             const { client, conn } = this._props;
             if (!client) {
@@ -60,19 +79,46 @@ class RedisChannel extends be_cache_common_1.CacheChannel {
                 return [];
             }
             if (paths.length == 1) {
-                const rec = (yield client.get(paths[0]));
-                return rec ? [rec] : [];
+                try {
+                    const rec = (yield client.get(paths[0]));
+                    return rec ? [rec] : [];
+                }
+                catch (e) {
+                    conn.checkError(e, { name: 'GET', method: '$getMore' });
+                    return [];
+                }
             }
             try {
                 return (yield client.mGet(paths));
             }
             catch (e) {
-                conn.checkError(e, { name: 'MGET', method: '$get' });
+                conn.checkError(e, { name: 'MGET', method: '$getMore' });
+                return [];
             }
         });
     }
     /** @inheritDoc */
-    $set(map) {
+    $set(path, value, _opt) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { client, conn } = this._props;
+            if (!client) {
+                return false;
+            }
+            if (typeof path !== 'string' || typeof value !== 'string') {
+                return false;
+            }
+            try {
+                yield client.set(path, value);
+                return true;
+            }
+            catch (e) {
+                conn.checkError(e, { name: 'SET', method: '$set' });
+            }
+            return false;
+        });
+    }
+    /** @inheritDoc */
+    $setMore(map, _opt) {
         return __awaiter(this, void 0, void 0, function* () {
             const { client, conn } = this._props;
             if (!client) {
@@ -91,7 +137,7 @@ class RedisChannel extends be_cache_common_1.CacheChannel {
                         yield client.set(key, map[key]);
                     }
                     catch (e) {
-                        conn.checkError(e, { name: 'SET', method: '$set' });
+                        conn.checkError(e, { name: 'SET', method: '$setMore' });
                     }
                     return 1;
                 default:
@@ -99,14 +145,34 @@ class RedisChannel extends be_cache_common_1.CacheChannel {
                         yield client.mSet(map);
                     }
                     catch (e) {
-                        conn.checkError(e, { name: 'MSET', method: '$set' });
+                        conn.checkError(e, { name: 'MSET', method: '$setMore' });
                     }
                     return keys.length;
             }
         });
     }
     /** @inheritDoc */
-    $delete(...paths) {
+    $delete(path, _opt) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { client, conn } = this._props;
+            if (!client) {
+                return false;
+            }
+            if (typeof path !== 'string') {
+                return false;
+            }
+            try {
+                const result = yield client.del(path);
+                return result > 0;
+            }
+            catch (e) {
+                conn.checkError(e, { name: 'DEL', method: '$delete' });
+            }
+            return false;
+        });
+    }
+    /** @inheritDoc */
+    $deleteMore(paths, _opt) {
         return __awaiter(this, void 0, void 0, function* () {
             const { client, conn } = this._props;
             if (!client) {
@@ -119,13 +185,13 @@ class RedisChannel extends be_cache_common_1.CacheChannel {
                 yield client.del(paths);
             }
             catch (e) {
-                conn.checkError(e, { name: 'DEL', method: '$delete' });
+                conn.checkError(e, { name: 'DEL', method: '$deleteMore' });
             }
             return paths.length;
         });
     }
     /** @inheritDoc */
-    $addLinks(idPath, paths) {
+    $addLinks(idPath, paths, _opt) {
         return __awaiter(this, void 0, void 0, function* () {
             const { client, conn } = this._props;
             if (!client) {
@@ -144,7 +210,7 @@ class RedisChannel extends be_cache_common_1.CacheChannel {
         });
     }
     /** @inheritDoc */
-    $expire(path, seconds) {
+    $expire(path, seconds, _opt) {
         return __awaiter(this, void 0, void 0, function* () {
             const { client, conn } = this._props;
             if (!client) {
@@ -159,7 +225,7 @@ class RedisChannel extends be_cache_common_1.CacheChannel {
         });
     }
     /** @inheritDoc */
-    $getLinks(idPath) {
+    $getLinks(idPath, _opt) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a;
             const { client, conn } = this._props;

package/dist/config/index.types.d.ts

@@ -1,5 +1,9 @@
 import type { EnvBase } from "@leyyo/env";
 export interface RedisCommonConf extends EnvBase {
+    /**
+     * Redis Enabled
+     * */
+    readonly ENABLED: boolean;
     /**
      * Redis Protocol
      * */

package/dist/config/redis-common.config.js

@@ -8,11 +8,28 @@ const env_1 = require("@leyyo/env");
 exports.redisCommonConfig = env_1.envCore.configure
     .scope('RedisCommon', 'REDIS')
     .start()
-    .field('PROTOCOL').text().def('redis').end()
-    .field('HOST').text().required().end()
-    .field('PORT').integer().def(6379).end()
-    .field('USER').text().end()
-    .field('PASS').text().end()
-    .field('PREFIX').text().end()
-    .field('DB_NUMBER').integer().end()
+    // @formatter:off
+    .field('ENABLED').boolean().def(true).end()
+    .field('PROTOCOL')
+    .off(v => v.ENABLED)
+    .text().def('redis').end()
+    .field('HOST')
+    .off(v => v.ENABLED)
+    .text().required().end()
+    .field('PORT')
+    .off(v => v.ENABLED)
+    .integer().def(6379).end()
+    .field('USER')
+    .off(v => v.ENABLED)
+    .text().end()
+    .field('PASS')
+    .off(v => v.ENABLED)
+    .text().end()
+    .field('PREFIX')
+    .off(v => v.ENABLED)
+    .text().end()
+    .field('DB_NUMBER')
+    .off(v => v.ENABLED)
+    .integer().end()
+    // @formatter:on
     .finish();

package/dist/connection/redis.connection.js

@@ -74,18 +74,19 @@ class RedisConnection extends be_cache_common_1.CacheConnection {
      * Read credentials from environment
      * */
     _readFromEnv() {
-        var _a, _b, _c, _d, _e, _f;
+        var _a, _b, _c, _d, _e, _f, _g;
         const { _props: props } = this;
         let env = config_1.redisCommonConfig.valueShort;
         if (props.envVariant) {
             env = config_1.redisCommonConfig.configure.getVariation(props.envVariant).valueShort;
         }
-        this._props.protocol = (_a = this._props.protocol) !== null && _a !== void 0 ? _a : env.PROTOCOL;
-        this._props.host = (_b = this._props.host) !== null && _b !== void 0 ? _b : env.HOST;
-        this._props.port = (_c = this._props.port) !== null && _c !== void 0 ? _c : env.PORT;
-        this._props.username = (_d = this._props.username) !== null && _d !== void 0 ? _d : env.USER;
-        this._props.password = (_e = this._props.password) !== null && _e !== void 0 ? _e : env.PASS;
-        this._props.dbNumber = (_f = this._props.dbNumber) !== null && _f !== void 0 ? _f : env.DB_NUMBER;
+        props.enabled = (_a = props.enabled) !== null && _a !== void 0 ? _a : env.ENABLED;
+        props.protocol = (_b = props.protocol) !== null && _b !== void 0 ? _b : env.PROTOCOL;
+        props.host = (_c = props.host) !== null && _c !== void 0 ? _c : env.HOST;
+        props.port = (_d = props.port) !== null && _d !== void 0 ? _d : env.PORT;
+        props.username = (_e = props.username) !== null && _e !== void 0 ? _e : env.USER;
+        props.password = (_f = props.password) !== null && _f !== void 0 ? _f : env.PASS;
+        props.dbNumber = (_g = props.dbNumber) !== null && _g !== void 0 ? _g : env.DB_NUMBER;
     }
     /**
      * Build url from credentials
@@ -124,22 +125,27 @@ class RedisConnection extends be_cache_common_1.CacheConnection {
     /** {@inheritDoc} */
     connect() {
         return __awaiter(this, void 0, void 0, function* () {
-            if (this._props.isConnected) {
+            const { _props: props } = this;
+            const { enabled, isConnected, tryCount, producedUrl } = props;
+            if (!enabled) {
+                return false;
+            }
+            if (isConnected) {
                 return true;
             }
-            if (this._props.tryCount > RedisConnection.TRY_COUNT) {
-                const err = new be_cache_common_1.CacheError('Maximum try county', { count: this._props.tryCount });
-                this.logger.error(be_base_common_1.errorHandler.common.logText(err, 'connect', 'try', this._props.tryCount));
+            if (tryCount > RedisConnection.TRY_COUNT) {
+                const err = new be_cache_common_1.CacheError('Maximum try county', { tryCount });
+                this.logger.error(be_base_common_1.errorHandler.common.logText(err, 'connect', 'try', tryCount));
                 return false;
             }
             try {
-                this._props.client = redis.createClient({ url: this._props.producedUrl });
-                this._props.client
+                props.client = redis.createClient({ url: producedUrl });
+                props.client
                     .on("error", err => {
                     this.checkError(err, { silent: true, name: 'connection' });
-                    this._props.tryCount++;
-                    const old = this._props.isConnected;
-                    this._props.isConnected = false;
+                    props.tryCount++;
+                    const old = isConnected;
+                    props.isConnected = false;
                     if (old) {
                         this._triggerOnCase('disconnected', this._onDisconnected, false);
                     }
@@ -147,19 +153,19 @@ class RedisConnection extends be_cache_common_1.CacheConnection {
                 })
                     .on('connect', () => {
                     this.logger.info(`on[connect]`);
-                    this._props.isConnected = true;
-                    this._props.tryCount = 0;
+                    props.isConnected = true;
+                    props.tryCount = 0;
                     this._triggerOnCase('connected', this._onConnected, false);
-                    if (this._props.isFirst === undefined) {
+                    if (props.isFirst === undefined) {
                         this._triggerOnCase('first-connected', this._onFirstConnected, true);
-                        this._props.isFirst = false;
+                        props.isFirst = false;
                     }
                 })
                     .on('ready', () => this.logger.info('on[ready]'))
                     .on('close', () => this.logger.info('on[close]'))
                     .on('reconnecting', () => this.logger.info('on[reconnecting]'))
                     .on('end', () => this.logger.info('on[end]'));
-                yield this._props.client.connect();
+                yield props.client.connect();
                 this.logger.log('Connected');
                 setTimeout(() => this.ping(true).then(), 30000);
             }
@@ -172,11 +178,14 @@ class RedisConnection extends be_cache_common_1.CacheConnection {
     /** {@inheritDoc} */
     ping(next) {
         return __awaiter(this, void 0, void 0, function* () {
-            // this._props.client.destroy()
+            const { enabled, isConnected, client } = this._props;
+            if (!enabled) {
+                return false;
+            }
             let result = false;
-            if (this._props.isConnected) {
+            if (isConnected) {
                 try {
-                    yield this._props.client.ping();
+                    yield client.ping();
                     result = true;
                 }
                 catch (err) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@samet-it/be-redis-common",
-  "version": "1.1.3",
+  "version": "1.1.5",
   "description": "Redis common component",
   "keywords": [
     "redis",
@@ -67,10 +67,10 @@
     }
   },
   "dependencies": {
-    "@leyyo/common": "^1.2.3",
-    "@leyyo/env": "^1.2.1",
-    "@samet-it/be-base-common": "^1.1.3",
-    "@samet-it/be-cache-common": "^1.1.3",
+    "@leyyo/common": "^1.2.4",
+    "@leyyo/env": "^1.2.5",
+    "@samet-it/be-base-common": "^1.1.4",
+    "@samet-it/be-cache-common": "^1.1.5",
     "redis": "^5.10.0"
   }
 }