@pi-r/redis 0.3.4 → 0.3.6

package/LICENSE

@@ -1,7 +1,7 @@
-Copyright 2024 An Pham
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
+Copyright 2023 An Pham
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,7 +1,5 @@
-# @pi-r/redis
-
-PEP 402 - Forever
-
-## LICENSE
-
+# @pi-r/redis
+
+## LICENSE
+
 MIT

package/client/index.d.ts

@@ -1,7 +1,7 @@
-import type { IDbSourceClient } from '@e-mc/db/types';
-
-import type { RedisDataSource } from '../types';
-
-declare const Redis: IDbSourceClient<RedisDataSource>;
-
+import type { IDbSourceClient } from '@e-mc/db/types';
+
+import type { RedisDataSource } from '../types';
+
+declare const Redis: IDbSourceClient<RedisDataSource>;
+
 export = Redis;

package/client/index.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DB_SOURCE_TYPE = exports.DB_SOURCE_CLIENT = exports.checkTimeout = exports.executeBatchQuery = exports.executeQuery = exports.setCredential = void 0;
-const redis = require("redis");
 const util_1 = require("@e-mc/db/util");
 const types_1 = require("@e-mc/types");
 const Db = require("@e-mc/db");
@@ -108,6 +107,7 @@ async function setCredential(item) {
         }
         const poolKey = getPoolKey(client);
         if (!(pool = POOL_STATE[poolKey]) || pool.closed) {
+            const db = require("redis");
             const config = this.getPoolConfig("redis", password);
             const poolOptions = client.isolationPoolOptions || (client.isolationPoolOptions = {});
             if (config) {
@@ -129,9 +129,9 @@ async function setCredential(item) {
                 }
             }
             try {
-                const target = new RedisPool(await getClient(redis, client, poolKey), poolKey, username && password ? { username, password } : undefined).add(item);
-                target.parent = POOL_STATE;
-                target.success = 1;
+                const redis = new RedisPool(await getClient(db, client, poolKey), poolKey, username && password ? { username, password } : undefined).add(item);
+                redis.parent = POOL_STATE;
+                redis.success = 1;
             }
             catch {
                 item.usePool = false;
@@ -154,6 +154,7 @@ async function executeBatchQuery(batch, options = '', outResult) {
     if (length === 0) {
         return [];
     }
+    const db = require("redis");
     let parallel, checkObject, connectOnce, errorQuery, sessionKey, outCacheMiss;
     if ((0, types_1.isPlainObject)(options)) {
         ({ parallel, checkObject, connectOnce, errorQuery, sessionKey, outCacheMiss } = options);
@@ -195,7 +196,7 @@ async function executeBatchQuery(batch, options = '', outResult) {
                     (credential.isolationPoolOptions || (credential.isolationPoolOptions = {})).max = size;
                 }
             }
-            clients.push(client = await getClient(redis, credential));
+            clients.push(client = await getClient(db, credential));
         }
         if (connectOnce) {
             redisClient = client;
@@ -230,7 +231,7 @@ async function executeBatchQuery(batch, options = '', outResult) {
         const targetObject = typeof checkObject === 'string' ? this.hasCoerce("redis", 'options', uuidKey) && (0, types_1.asFunction)(checkObject) : checkObject;
         const renewCache = ignoreCache === 0;
         const cacheValue = renewCache ? { sessionKey, renewCache } : sessionKey;
-        const command = (0, types_1.isPlainObject)(clientOptions.command) ? redis.commandOptions(clientOptions.command) : null;
+        const command = (0, types_1.isPlainObject)(clientOptions.command) ? db.commandOptions(clientOptions.command) : null;
         let queryString = '', rows;
         if (caching && ignoreCache !== true || ignoreCache === false || ignoreCache === 1 || renewCache) {
             if ((0, types_1.isObject)(search)) {
@@ -292,7 +293,7 @@ async function executeBatchQuery(batch, options = '', outResult) {
                             }
                             const failKey = () => failed((0, types_1.errorMessage)(f, "Invalid key", Db.asString(k) || "Unknown"));
                             const failValue = () => failed((0, types_1.errorMessage)(f, "Invalid value", Db.asString(v) || "Unknown"));
-                            const commandSet = (0, types_1.isPlainObject)(setOptions.command) && redis.commandOptions(setOptions.command);
+                            const commandSet = (0, types_1.isPlainObject)(setOptions.command) && db.commandOptions(setOptions.command);
                             let pending;
                             if ((f = f.toUpperCase()) === 'JSON') {
                                 if (typeof k !== 'string') {
@@ -453,7 +454,7 @@ async function executeBatchQuery(batch, options = '', outResult) {
                     try {
                         if (target === search) {
                             const reply = await (command ? client.ft.search(command, index || idx, query, clientOptions.search) : client.ft.search(index || idx, query, clientOptions.search));
-                            rows = reply.documents.map(doc => (doc.value.__id__ = doc.id) && doc.value);
+                            rows = reply.documents.map(doc => (doc.value['__id__'] = doc.id) && doc.value);
                         }
                         else {
                             ({ results: rows } = await (command ? client.ft.aggregate(command, index || idx, query, clientOptions.aggregate) : client.ft.aggregate(index || idx, query, clientOptions.aggregate)));
@@ -500,7 +501,7 @@ async function executeBatchQuery(batch, options = '', outResult) {
                                 break;
                             default:
                                 if (item.field) {
-                                    data = client.hGet(...command ? [command, key, item.field] : [key, item.field]);
+                                    data = await client.hGet(...command ? [command, key, item.field] : [key, item.field]);
                                 }
                                 else {
                                     data = await client.hGetAll(...command ? [command, key] : [key]);

package/client/pool.js

@@ -0,0 +1,36 @@
+"use strict";
+const DbPool = require('@e-mc/db/pool');
+const POOL_ACTIVE = new WeakSet();
+class RedisPool extends DbPool {
+    static asString(credential) {
+        if (credential.url) {
+            return JSON.stringify(credential);
+        }
+        return super.asString(credential);
+    }
+    static sanitize(credential) {
+        if (!POOL_ACTIVE.has(credential) || credential.uuidKey) {
+            return credential;
+        }
+        if ('socket' in credential || 'isolationPoolOptions' in credential) {
+            return { ...credential, socket: credential.socket?.tls ? { tls: true } : undefined, isolationPoolOptions: undefined };
+        }
+        return credential;
+    }
+    async getConnection(credential) {
+        if (credential) {
+            POOL_ACTIVE.add(credential);
+        }
+        return this.client;
+    }
+    async close() {
+        return this.client.disconnect();
+    }
+    isEmpty() {
+        return this.closed;
+    }
+    get closed() {
+        return !this.client.isOpen;
+    }
+}
+module.exports = RedisPool;

package/package.json

@@ -1,28 +1,28 @@
-{
-  "name": "@pi-r/redis",
-  "version": "0.3.4",
-  "description": "Redis client driver for E-mc.",
-  "main": "client/index.js",
-  "types": "client/index.d.ts",
-  "publishConfig": {
-    "access": "public"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/anpham6/pi-r.git",
-    "directory": "src/db/redis"
-  },
-  "keywords": [
-    "squared",
-    "e-mc",
-    "squared-functions"
-  ],
-  "author": "An Pham <anpham6@gmail.com>",
-  "license": "MIT",
-  "homepage": "https://github.com/anpham6/pi-r#readme",
-  "dependencies": {
-    "@e-mc/db": "^0.6.3",
-    "@e-mc/types": "^0.6.3",
-    "redis": "^4.6.13"
-  }
-}
+{
+  "name": "@pi-r/redis",
+  "version": "0.3.6",
+  "description": "Redis client driver for E-mc.",
+  "main": "client/index.js",
+  "types": "client/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/anpham6/pi-r.git",
+    "directory": "src/db/redis"
+  },
+  "keywords": [
+    "squared",
+    "e-mc",
+    "squared-functions"
+  ],
+  "author": "An Pham <anpham6@gmail.com>",
+  "license": "MIT",
+  "homepage": "https://github.com/anpham6/pi-r#readme",
+  "dependencies": {
+    "@e-mc/db": "^0.6.16",
+    "@e-mc/types": "^0.6.16",
+    "redis": "^4.6.15"
+  }
+}

package/types/index.d.ts

@@ -1,67 +1,67 @@
-import type { DbDataSource } from '@e-mc/types/lib/squared';
-
-import type { CascadeAction, ExecuteAction, ServerAuth } from '@e-mc/types/lib/db';
-
-import type { CommandOptions } from '@redis/client/dist/lib/command-options';
-import type { ClientCommandOptions } from '@redis/client/dist/lib/client';
-import type { RedisClientOptions } from '@redis/client';
-import type { RedisCommandArgument } from '@redis/client/dist/lib/commands';
-import type { RedisJSON } from '@redis/json/dist/commands';
-import type { AggregateOptions, RediSearchSchema, SearchOptions } from 'redis';
-
-export interface RedisDataSource extends DbDataSource<string, PlainObject, ArrayOf<RedisSetValue> | ArrayOf<RedisJSONValue>, string | RedisCredential, string>, CascadeAction, AuthValue {
-    source: "redis";
-    key?: ArrayOf<RedisCommandArgument>;
-    field?: RedisCommandArgument;
-    path?: string;
-    format?: RedisFormat | "HKEYS" | "HVALS";
-    search?: RedisQuery;
-    aggregate?: RedisQuery;
-    options?: {
-        client?: RedisClientOptions;
-        command?: RedisCommandOptions;
-        get?: PlainObject;
-        search?: SearchOptions;
-        aggregate?: AggregateOptions;
-    };
-    database?: number;
-}
-
-export type RedisCredential = ServerAuth;
-
-export interface RedisSetValue<T = "HASH" | undefined, U = RedisCommandArgument, V = RedisCommandValue | RedisHSETObject> {
-    format: T;
-    key?: U;
-    field?: V;
-    value?: V;
-    NX?: boolean;
-    XX?: boolean;
-    EX?: number;
-    PX?: number;
-    EXAT?: number;
-    PXAT?: number;
-    options?: {
-        set?: PlainObject;
-        expire?: { [K in RedisExpireCondition]?: boolean; };
-        command?: RedisCommandOptions;
-    };
-}
-
-export interface RedisJSONValue extends Omit<RedisSetValue<"JSON", string, RedisJSON>, "field" | "EX" | "PX" | "EXAT" | "PXAT"> {
-    path?: string;
-}
-
-export interface RedisQuery {
-    index?: string;
-    schema?: RediSearchSchema | string;
-    query?: string;
-    options?: PlainObject;
-}
-
-export type RedisFormat = "HASH" | "JSON";
-export type RedisExpireCondition = "NX" | "XX" | "GT" | "LT";
-export type RedisCommandValue = RedisCommandArgument | number;
-export type RedisCommandOptions = CommandOptions<ClientCommandOptions>;
-export type RedisHSETObject = Record<NumString, RedisCommandValue>;
-
+import type { DbDataSource } from '@e-mc/types/lib/squared';
+
+import type { CascadeAction, ExecuteAction, ServerAuth } from '@e-mc/types/lib/db';
+
+import type { CommandOptions } from '@redis/client/dist/lib/command-options';
+import type { ClientCommandOptions } from '@redis/client/dist/lib/client';
+import type { RedisClientOptions } from '@redis/client';
+import type { RedisCommandArgument } from '@redis/client/dist/lib/commands';
+import type { RedisJSON } from '@redis/json/dist/commands';
+import type { AggregateOptions, RediSearchSchema, SearchOptions } from 'redis';
+
+export interface RedisDataSource extends DbDataSource<string, PlainObject, ArrayOf<RedisSetValue> | ArrayOf<RedisJSONValue>, string | RedisCredential, string>, CascadeAction, AuthValue {
+    source: "redis";
+    key?: ArrayOf<RedisCommandArgument>;
+    field?: RedisCommandArgument;
+    path?: string;
+    format?: RedisFormat | "HKEYS" | "HVALS";
+    search?: RedisQuery;
+    aggregate?: RedisQuery;
+    options?: {
+        client?: RedisClientOptions;
+        command?: RedisCommandOptions;
+        get?: PlainObject;
+        search?: SearchOptions;
+        aggregate?: AggregateOptions;
+    };
+    database?: number;
+}
+
+export type RedisCredential = ServerAuth;
+
+export interface RedisSetValue<T = "HASH" | undefined, U = RedisCommandArgument, V = RedisCommandValue | RedisHSETObject> {
+    format: T;
+    key?: U;
+    field?: V;
+    value?: V;
+    NX?: boolean;
+    XX?: boolean;
+    EX?: number;
+    PX?: number;
+    EXAT?: number;
+    PXAT?: number;
+    options?: {
+        set?: PlainObject;
+        expire?: { [K in RedisExpireCondition]?: boolean; };
+        command?: RedisCommandOptions;
+    };
+}
+
+export interface RedisJSONValue extends Omit<RedisSetValue<"JSON", string, RedisJSON>, "field" | "EX" | "PX" | "EXAT" | "PXAT"> {
+    path?: string;
+}
+
+export interface RedisQuery {
+    index?: string;
+    schema?: RediSearchSchema | string;
+    query?: string;
+    options?: PlainObject;
+}
+
+export type RedisFormat = "HASH" | "JSON";
+export type RedisExpireCondition = "NX" | "XX" | "GT" | "LT";
+export type RedisCommandValue = RedisCommandArgument | number;
+export type RedisCommandOptions = CommandOptions<ClientCommandOptions>;
+export type RedisHSETObject = Record<NumString, RedisCommandValue>;
+
 export type { RedisCommandArgument, RedisJSON };