@samet-it/be-redis-common 1.1.7 → 1.1.8

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

@@ -13,6 +13,10 @@ import type { KeyValue } from "@leyyo/common";
 export interface RedisChannelLike<ENT extends Entity<ID>, ID extends KeyValue> extends CacheChannelLike<RedisConnectionLike, ENT, ID> {
     /** @inheritDoc */
     get props(): Readonly<RedisChannelProps>;
+    /**
+     * Shortcut to {@link RedisConnProps#client}
+     * */
+    get client(): RedisClientType;
 }
 /**
  * Redis channel option
@@ -23,12 +27,6 @@ export interface RedisChannelOpt extends CacheChannelOpt {
  * Redis channel props
  * */
 export interface RedisChannelProps extends CacheChannelProps<RedisConnectionLike>, RedisChannelOpt {
-    /**
-     * Redis client
-     *
-     * @type {RedisClientType}
-     * */
-    client: RedisClientType;
 }
 /**
  * Redis direct channel options

package/dist/channel/redis-direct.channel.js

@@ -19,7 +19,7 @@ class RedisDirectChannel extends redis_channel_1.RedisChannel {
      * */
     constructor(conn, opt) {
         super(conn, opt);
-        this.logger = be_base_common_1.logger.of(`RedisDirect${opt.name ? '#' + opt.name : ''}`);
+        this.logger = be_base_common_1.logger.create(`RedisDirect${opt.name ? '#' + opt.name : ''}`);
     }
 }
 exports.RedisDirectChannel = RedisDirectChannel;

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

@@ -4,6 +4,7 @@ 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";
+import type { RedisClientType } from "redis";
 /**
  * Redis abstract channel class
  *
@@ -24,6 +25,8 @@ export declare class RedisChannel<ENT extends Entity<ID>, ID extends KeyValue> e
     /** @inheritDoc */
     get props(): Readonly<RedisChannelProps>;
     /** @inheritDoc */
+    get client(): RedisClientType;
+    /** @inheritDoc */
     $get(path: string, _opt?: CacheExecOpt): Promise<string | undefined>;
     /** @inheritDoc */
     $getMore(paths: Array<string>, _opt?: CacheExecOpt): Promise<Array<string | undefined>>;

package/dist/channel/redis.channel.js

@@ -29,41 +29,32 @@ class RedisChannel extends be_cache_common_1.CacheChannel {
      * */
     constructor(conn, opt) {
         super(conn, opt);
-        conn.onFirstConnected(() => __awaiter(this, void 0, void 0, function* () {
-            this._props.client = conn.props.client;
-            this._props.isConnected = true;
-        }));
-        conn.onConnected(() => __awaiter(this, void 0, void 0, function* () {
-            this._props.client = conn.props.client;
-            this._props.isConnected = true;
-        }));
-        conn.onDisconnected(() => __awaiter(this, void 0, void 0, function* () {
-            this._props.client = undefined;
-            this._props.isConnected = false;
-        }));
     }
     // region getter
     /** @inheritDoc */
     get props() {
         return this._props;
     }
+    /** @inheritDoc */
+    get client() {
+        return this._props.conn.client;
+    }
     // endregion getter
     // region native-calls
     /** @inheritDoc */
     $get(path, _opt) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { client, conn } = this._props;
-            if (!client) {
+            if (!this.isConnected) {
                 return undefined;
             }
             if (typeof path !== 'string') {
                 return undefined;
             }
             try {
-                return yield client.get(path);
+                return yield this.client.get(path);
             }
             catch (e) {
-                conn.checkError(e, { name: 'GET', method: '$get' });
+                this.checkError(e, { name: 'GET', method: '$get' });
             }
             return undefined;
         });
@@ -71,8 +62,7 @@ class RedisChannel extends be_cache_common_1.CacheChannel {
     /** @inheritDoc */
     $getMore(paths, _opt) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { client, conn } = this._props;
-            if (!client) {
+            if (!this.isConnected) {
                 return [];
             }
             if (paths.length < 1) {
@@ -80,19 +70,19 @@ class RedisChannel extends be_cache_common_1.CacheChannel {
             }
             if (paths.length == 1) {
                 try {
-                    const rec = (yield client.get(paths[0]));
+                    const rec = (yield this.client.get(paths[0]));
                     return rec ? [rec] : [];
                 }
                 catch (e) {
-                    conn.checkError(e, { name: 'GET', method: '$getMore' });
+                    this.checkError(e, { name: 'GET', method: '$getMore' });
                     return [];
                 }
             }
             try {
-                return (yield client.mGet(paths));
+                return (yield this.client.mGet(paths));
             }
             catch (e) {
-                conn.checkError(e, { name: 'MGET', method: '$getMore' });
+                this.checkError(e, { name: 'MGET', method: '$getMore' });
                 return [];
             }
         });
@@ -100,19 +90,18 @@ class RedisChannel extends be_cache_common_1.CacheChannel {
     /** @inheritDoc */
     $set(path, value, _opt) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { client, conn } = this._props;
-            if (!client) {
+            if (!this.isConnected) {
                 return false;
             }
             if (typeof path !== 'string' || typeof value !== 'string') {
                 return false;
             }
             try {
-                yield client.set(path, value);
+                yield this.client.set(path, value);
                 return true;
             }
             catch (e) {
-                conn.checkError(e, { name: 'SET', method: '$set' });
+                this.checkError(e, { name: 'SET', method: '$set' });
             }
             return false;
         });
@@ -120,8 +109,7 @@ class RedisChannel extends be_cache_common_1.CacheChannel {
     /** @inheritDoc */
     $setMore(map, _opt) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { client, conn } = this._props;
-            if (!client) {
+            if (!this.isConnected) {
                 return 0;
             }
             if (!map || typeof map !== 'object' || Array.isArray(map)) {
@@ -134,18 +122,18 @@ class RedisChannel extends be_cache_common_1.CacheChannel {
                 case 1:
                     const key = keys[0];
                     try {
-                        yield client.set(key, map[key]);
+                        yield this.client.set(key, map[key]);
                     }
                     catch (e) {
-                        conn.checkError(e, { name: 'SET', method: '$setMore' });
+                        this.checkError(e, { name: 'SET', method: '$setMore' });
                     }
                     return 1;
                 default:
                     try {
-                        yield client.mSet(map);
+                        yield this.client.mSet(map);
                     }
                     catch (e) {
-                        conn.checkError(e, { name: 'MSET', method: '$setMore' });
+                        this.checkError(e, { name: 'MSET', method: '$setMore' });
                     }
                     return keys.length;
             }
@@ -154,19 +142,18 @@ class RedisChannel extends be_cache_common_1.CacheChannel {
     /** @inheritDoc */
     $delete(path, _opt) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { client, conn } = this._props;
-            if (!client) {
+            if (!this.isConnected) {
                 return false;
             }
             if (typeof path !== 'string') {
                 return false;
             }
             try {
-                const result = yield client.del(path);
+                const result = yield this.client.del(path);
                 return result > 0;
             }
             catch (e) {
-                conn.checkError(e, { name: 'DEL', method: '$delete' });
+                this.checkError(e, { name: 'DEL', method: '$delete' });
             }
             return false;
         });
@@ -174,18 +161,17 @@ class RedisChannel extends be_cache_common_1.CacheChannel {
     /** @inheritDoc */
     $deleteMore(paths, _opt) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { client, conn } = this._props;
-            if (!client) {
+            if (!this.isConnected) {
                 return 0;
             }
             if (paths.length < 1) {
                 return 0;
             }
             try {
-                yield client.del(paths);
+                yield this.client.del(paths);
             }
             catch (e) {
-                conn.checkError(e, { name: 'DEL', method: '$deleteMore' });
+                this.checkError(e, { name: 'DEL', method: '$deleteMore' });
             }
             return paths.length;
         });
@@ -193,18 +179,17 @@ class RedisChannel extends be_cache_common_1.CacheChannel {
     /** @inheritDoc */
     $addLinks(idPath, paths, _opt) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { client, conn } = this._props;
-            if (!client) {
+            if (!this.isConnected) {
                 return 0;
             }
             if (paths.length < 1) {
                 return 0;
             }
             try {
-                yield client.sAdd(idPath, paths);
+                yield this.client.sAdd(idPath, paths);
             }
             catch (e) {
-                conn.checkError(e, { name: 'SADD', method: '$addLinks' });
+                this.checkError(e, { name: 'SADD', method: '$addLinks' });
             }
             return paths.length;
         });
@@ -212,15 +197,14 @@ class RedisChannel extends be_cache_common_1.CacheChannel {
     /** @inheritDoc */
     $expire(path, seconds, _opt) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { client, conn } = this._props;
-            if (!client) {
+            if (!this.isConnected) {
                 return false;
             }
             try {
-                return (yield client.expire(path, seconds)) > 0;
+                return (yield this.client.expire(path, seconds)) > 0;
             }
             catch (e) {
-                conn.checkError(e, { name: 'EXPIRE', method: '$expire' });
+                this.checkError(e, { name: 'EXPIRE', method: '$expire' });
             }
         });
     }
@@ -228,15 +212,14 @@ class RedisChannel extends be_cache_common_1.CacheChannel {
     $getLinks(idPath, _opt) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a;
-            const { client, conn } = this._props;
-            if (!client) {
+            if (!this.isConnected) {
                 return [];
             }
             try {
-                return (_a = (yield client.sMembers(idPath))) !== null && _a !== void 0 ? _a : [];
+                return (_a = (yield this.client.sMembers(idPath))) !== null && _a !== void 0 ? _a : [];
             }
             catch (e) {
-                conn.checkError(e, { name: 'SMEMBERS', method: '$getLinks' });
+                this.checkError(e, { name: 'SMEMBERS', method: '$getLinks' });
             }
         });
     }

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

@@ -10,6 +10,10 @@ import { KeyValue } from "@leyyo/common";
 export interface RedisConnectionLike extends CacheConnectionLike<RedisExecOpt> {
     /** @inheritDoc */
     get props(): Readonly<RedisConnProps>;
+    /**
+     * Shortcut to {@link RedisConnProps#client}
+     * */
+    get client(): RedisClientType;
 }
 /**
  * Redis direct connection interface

package/dist/connection/redis-direct.connection.js

@@ -15,7 +15,7 @@ class RedisDirectConnection extends redis_connection_1.RedisConnection {
      * */
     constructor(opt) {
         super(opt);
-        this.logger = be_base_common_1.logger.of(`RedisConnection${(opt === null || opt === void 0 ? void 0 : opt.name) ? '#' + (opt === null || opt === void 0 ? void 0 : opt.name) : ''}`);
+        this.logger = be_base_common_1.logger.create(`RedisConnection${(opt === null || opt === void 0 ? void 0 : opt.name) ? '#' + (opt === null || opt === void 0 ? void 0 : opt.name) : ''}`);
     }
     /** @inheritDoc */
     newChannel(opt) {

package/dist/connection/redis.connection.d.ts

@@ -1,5 +1,6 @@
 import type { RedisConnectionLike, RedisExecOpt, RedisConnProps, RedisConnOpt } from "./index.types";
 import { CacheConnection } from "@samet-it/be-cache-common";
+import type { RedisClientType } from "redis";
 /**
  * Redis connection abstract class
  * */
@@ -32,6 +33,8 @@ export declare abstract class RedisConnection extends CacheConnection<RedisExecO
     protected constructor(opt?: RedisConnOpt);
     /** @inheritDoc */
     get props(): Readonly<RedisConnProps>;
+    /** @inheritDoc */
+    get client(): RedisClientType;
     /**
      * Read credentials from environment
      * */

package/dist/connection/redis.connection.js

@@ -59,16 +59,23 @@ class RedisConnection extends be_cache_common_1.CacheConnection {
      * */
     constructor(opt) {
         super(opt);
+        if (!this.logger) {
+            this.logger = be_base_common_1.logger.create(this);
+        }
         this._props.tryCount = 0;
         this._readFromEnv();
         this._buildUrl();
     }
-    // region getter
+    // region getter-shortcut
     /** @inheritDoc */
     get props() {
         return this._props;
     }
-    // endregion getter
+    /** @inheritDoc */
+    get client() {
+        return this._props.client;
+    }
+    // endregion getter-shortcut
     // region protected-method
     /**
      * Read credentials from environment
@@ -80,7 +87,7 @@ class RedisConnection extends be_cache_common_1.CacheConnection {
         if (props.envVariant) {
             env = config_1.redisCommonConfig.configure.getVariation(props.envVariant).valueShort;
         }
-        props.enabled = (_a = props.enabled) !== null && _a !== void 0 ? _a : env.ENABLED;
+        props.isEnabled = (_a = props.isEnabled) !== 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;
@@ -126,25 +133,24 @@ class RedisConnection extends be_cache_common_1.CacheConnection {
     connect() {
         return __awaiter(this, void 0, void 0, function* () {
             const { _props: props } = this;
-            const { enabled, isConnected, tryCount, producedUrl } = props;
-            if (!enabled) {
+            if (!this.isEnabled) {
                 return false;
             }
-            if (isConnected) {
+            if (this.isConnected) {
                 return true;
             }
-            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));
+            if (this._props.tryCount > RedisConnection.TRY_COUNT) {
+                const err = new be_cache_common_1.CacheError('Maximum try county', { tryCount: this._props.tryCount });
+                this.logger.error(be_base_common_1.errorHandler.common.logText(err, 'connect', 'try', this._props.tryCount));
                 return false;
             }
             try {
-                props.client = redis.createClient({ url: producedUrl });
+                props.client = redis.createClient({ url: this._props.producedUrl });
                 props.client
                     .on("error", err => {
                     this.checkError(err, { silent: true, name: 'connection' });
                     props.tryCount++;
-                    const old = isConnected;
+                    const old = this.isConnected;
                     props.isConnected = false;
                     if (old) {
                         this._triggerOnCase('disconnected', this._onDisconnected, false);
@@ -166,7 +172,7 @@ class RedisConnection extends be_cache_common_1.CacheConnection {
                     .on('reconnecting', () => this.logger.info('on[reconnecting]'))
                     .on('end', () => this.logger.info('on[end]'));
                 yield props.client.connect();
-                this.logger.log('Connected');
+                this.logger.info('Connected');
                 setTimeout(() => this.ping(true).then(), 30000);
             }
             catch (e) {
@@ -178,14 +184,13 @@ class RedisConnection extends be_cache_common_1.CacheConnection {
     /** {@inheritDoc} */
     ping(next) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { enabled, isConnected, client } = this._props;
-            if (!enabled) {
+            if (!this.isEnabled) {
                 return false;
             }
             let result = false;
-            if (isConnected) {
+            if (this.isConnected) {
                 try {
-                    yield client.ping();
+                    yield this.client.ping();
                     result = true;
                 }
                 catch (err) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@samet-it/be-redis-common",
-  "version": "1.1.7",
+  "version": "1.1.8",
   "description": "Redis common component",
   "keywords": [
     "redis",
@@ -69,8 +69,8 @@
   "dependencies": {
     "@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.6",
+    "@samet-it/be-base-common": "^1.1.5",
+    "@samet-it/be-cache-common": "^1.1.7",
     "redis": "^5.10.0"
   }
 }