@samet-it/be-redis-common 1.1.2 → 1.1.4

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

@@ -2,7 +2,7 @@ import type { RedisConnectionLike } from "../connection";
 import type { RedisChannelProps, RedisChannelLike, RedisChannelOpt } from "./index.types";
 import { type Entity } from "@samet-it/be-base-common";
 import { CacheChannel } from "@samet-it/be-cache-common";
-import type { KeyValue, Opt } from "@leyyo/common";
+import type { KeyValue } from "@leyyo/common";
 /**
  * Redis abstract channel class
  *
@@ -20,13 +20,6 @@ export declare abstract class RedisChannel<ENT extends Entity<ID>, ID extends Ke
      * @param {RedisChannelOpt} opt - options
      * */
     protected constructor(conn: RedisConnectionLike, opt?: RedisChannelOpt);
-    /**
-     * @Check error
-     *
-     * @param {Error} e - error instance
-     * @param {Opt} params - parameters
-     * */
-    protected _checkError(e: Error, params?: Opt): void;
     /** @inheritDoc */
     get props(): Readonly<RedisChannelProps>;
     /** @inheritDoc */

package/dist/channel/redis.channel.js

@@ -10,7 +10,6 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RedisChannel = void 0;
-const be_base_common_1 = require("@samet-it/be-base-common");
 const be_cache_common_1 = require("@samet-it/be-cache-common");
 // noinspection JSUnusedGlobalSymbols
 /**
@@ -43,24 +42,6 @@ class RedisChannel extends be_cache_common_1.CacheChannel {
             this._props.isConnected = false;
         }));
     }
-    // region protected-methods
-    /**
-     * @Check error
-     *
-     * @param {Error} e - error instance
-     * @param {Opt} params - parameters
-     * */
-    _checkError(e, params) {
-        be_base_common_1.errorHandler.addStat(e);
-        if (e instanceof be_cache_common_1.CacheError) {
-            // todo append params
-            throw e;
-        }
-        else {
-            throw be_base_common_1.errorHandler.common.castForClass(be_cache_common_1.CacheError, e, params);
-        }
-    }
-    // endregion protected-methods
     // region getter
     /** @inheritDoc */
     get props() {
@@ -71,7 +52,7 @@ class RedisChannel extends be_cache_common_1.CacheChannel {
     /** @inheritDoc */
     $get(...paths) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { client } = this._props;
+            const { client, conn } = this._props;
             if (!client) {
                 return [];
             }
@@ -86,14 +67,14 @@ class RedisChannel extends be_cache_common_1.CacheChannel {
                 return (yield client.mGet(paths));
             }
             catch (e) {
-                this._checkError(e, { redis: 'MGET' });
+                conn.checkError(e, { name: 'MGET', method: '$get' });
             }
         });
     }
     /** @inheritDoc */
     $set(map) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { client } = this._props;
+            const { client, conn } = this._props;
             if (!client) {
                 return 0;
             }
@@ -110,7 +91,7 @@ class RedisChannel extends be_cache_common_1.CacheChannel {
                         yield client.set(key, map[key]);
                     }
                     catch (e) {
-                        this._checkError(e, { redis: 'SET' });
+                        conn.checkError(e, { name: 'SET', method: '$set' });
                     }
                     return 1;
                 default:
@@ -118,7 +99,7 @@ class RedisChannel extends be_cache_common_1.CacheChannel {
                         yield client.mSet(map);
                     }
                     catch (e) {
-                        this._checkError(e, { redis: 'MSET' });
+                        conn.checkError(e, { name: 'MSET', method: '$set' });
                     }
                     return keys.length;
             }
@@ -127,7 +108,7 @@ class RedisChannel extends be_cache_common_1.CacheChannel {
     /** @inheritDoc */
     $delete(...paths) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { client } = this._props;
+            const { client, conn } = this._props;
             if (!client) {
                 return 0;
             }
@@ -138,7 +119,7 @@ class RedisChannel extends be_cache_common_1.CacheChannel {
                 yield client.del(paths);
             }
             catch (e) {
-                this._checkError(e, { redis: 'DEL' });
+                conn.checkError(e, { name: 'DEL', method: '$delete' });
             }
             return paths.length;
         });
@@ -146,7 +127,7 @@ class RedisChannel extends be_cache_common_1.CacheChannel {
     /** @inheritDoc */
     $addLinks(idPath, paths) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { client } = this._props;
+            const { client, conn } = this._props;
             if (!client) {
                 return 0;
             }
@@ -157,7 +138,7 @@ class RedisChannel extends be_cache_common_1.CacheChannel {
                 yield client.sAdd(idPath, paths);
             }
             catch (e) {
-                this._checkError(e, { redis: 'SADD' });
+                conn.checkError(e, { name: 'SADD', method: '$addLinks' });
             }
             return paths.length;
         });
@@ -165,7 +146,7 @@ class RedisChannel extends be_cache_common_1.CacheChannel {
     /** @inheritDoc */
     $expire(path, seconds) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { client } = this._props;
+            const { client, conn } = this._props;
             if (!client) {
                 return false;
             }
@@ -173,7 +154,7 @@ class RedisChannel extends be_cache_common_1.CacheChannel {
                 return (yield client.expire(path, seconds)) > 0;
             }
             catch (e) {
-                this._checkError(e, { redis: 'EXPIRE' });
+                conn.checkError(e, { name: 'EXPIRE', method: '$expire' });
             }
         });
     }
@@ -181,7 +162,7 @@ class RedisChannel extends be_cache_common_1.CacheChannel {
     $getLinks(idPath) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a;
-            const { client } = this._props;
+            const { client, conn } = this._props;
             if (!client) {
                 return [];
             }
@@ -189,7 +170,7 @@ class RedisChannel extends be_cache_common_1.CacheChannel {
                 return (_a = (yield client.sMembers(idPath))) !== null && _a !== void 0 ? _a : [];
             }
             catch (e) {
-                this._checkError(e, { redis: 'SMEMBERS' });
+                conn.checkError(e, { name: 'SMEMBERS', method: '$getLinks' });
             }
         });
     }

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.d.ts

@@ -24,6 +24,11 @@ export declare abstract class RedisConnection extends CacheConnection<RedisExecO
     private static readonly TRY_COUNT;
     /** {@inheritDoc} */
     protected _props: RedisConnProps;
+    /**
+     * Constructor
+     *
+     * @param {RedisConnOpt} opt - options
+     * */
     protected constructor(opt?: RedisConnOpt);
     /** @inheritDoc */
     get props(): Readonly<RedisConnProps>;

package/dist/connection/redis.connection.js

@@ -46,11 +46,17 @@ exports.RedisConnection = void 0;
 const redis = __importStar(require("redis"));
 const config_1 = require("../config");
 const be_cache_common_1 = require("@samet-it/be-cache-common");
+const be_base_common_1 = require("@samet-it/be-base-common");
 /**
  * Redis connection abstract class
  * */
 class RedisConnection extends be_cache_common_1.CacheConnection {
     // endregion protected-property
+    /**
+     * Constructor
+     *
+     * @param {RedisConnOpt} opt - options
+     * */
     constructor(opt) {
         super(opt);
         this._props.tryCount = 0;
@@ -68,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
@@ -118,21 +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) {
-                this.logger.error(`on[error/*], maximum try`);
+            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);
                     }
@@ -140,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);
             }
@@ -165,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.2",
+  "version": "1.1.4",
   "description": "Redis common component",
   "keywords": [
     "redis",
@@ -67,10 +67,10 @@
     }
   },
   "dependencies": {
-    "@leyyo/common": "^1.2.1",
-    "@leyyo/env": "^1.2.1",
-    "@samet-it/be-base-common": "^1.1.1",
-    "@samet-it/be-cache-common": "^1.1.2",
+    "@leyyo/common": "^1.2.3",
+    "@leyyo/env": "^1.2.5",
+    "@samet-it/be-base-common": "^1.1.3",
+    "@samet-it/be-cache-common": "^1.1.4",
     "redis": "^5.10.0"
   }
 }