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

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.4",
   "description": "Redis common component",
   "keywords": [
     "redis",
@@ -68,9 +68,9 @@
   },
   "dependencies": {
     "@leyyo/common": "^1.2.3",
-    "@leyyo/env": "^1.2.1",
+    "@leyyo/env": "^1.2.5",
     "@samet-it/be-base-common": "^1.1.3",
-    "@samet-it/be-cache-common": "^1.1.3",
+    "@samet-it/be-cache-common": "^1.1.4",
     "redis": "^5.10.0"
   }
 }