@pi-r/redis 0.2.2 → 0.3.0

package/client/index.js

@@ -1,11 +1,12 @@
 "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");
 const DbPool = require('@e-mc/db/pool');
-const REDIS_V4 = Db.checkSemVer("redis" /* STRINGS.PACKAGE_NAME */, 4);
+const REDIS_V4 = Db.checkSemVer("redis" /* STRINGS.MODULE_NAME */, 4);
 class RedisPool extends DbPool {
     getConnection() {
         return Promise.resolve(this.client);
@@ -39,16 +40,16 @@ function getClient(db, options, poolKey) {
         client.connect().then(() => resolve(client)).catch(err => reject(err));
     });
 }
-const removePoolProperties = (options) => {
+function removePoolProperties(options) {
     if (!options.uuidKey && ('socket' in options || 'isolationPoolOptions' in options)) {
         return { ...options, socket: options.socket?.tls ? { tls: true } : undefined, isolationPoolOptions: undefined };
     }
     return options;
-};
+}
 const getPoolKey = (options) => options.url + '_' + (options.username || '') + '_' + (options.password || '') + '_' + (options.database ?? '') + '_' + (options.socket?.tls ? '1' : '0') + '_' + (options.legacyMode ? '1' : '0');
 async function setCredential(item) {
     if (!REDIS_V4) {
-        throw (0, types_1.errorValue)("Upgrade client to latest version" /* ERR_DB.UPGRADE */, "redis" /* STRINGS.PACKAGE_NAME */ + '@' + Db.getPackageVersion("redis" /* STRINGS.PACKAGE_NAME */));
+        throw (0, types_1.errorValue)("Upgrade client to latest version" /* ERR_DB.UPGRADE */, "redis" /* STRINGS.MODULE_NAME */ + '@' + Db.getPackageVersion("redis" /* STRINGS.MODULE_NAME */));
     }
     const credential = this.getCredential(item);
     const options = item.options || (item.options = {});
@@ -105,7 +106,6 @@ async function setCredential(item) {
         }
         const poolKey = getPoolKey(client);
         if (!(pool = POOL_STATE[poolKey]) || pool.closed) {
-            const db = require("redis" /* STRINGS.PACKAGE_NAME */);
             const config = this.getPoolConfig("redis" /* STRINGS.MODULE_NAME */, password);
             const poolOptions = client.isolationPoolOptions || (client.isolationPoolOptions = {});
             if (config) {
@@ -127,9 +127,9 @@ async function setCredential(item) {
                 }
             }
             try {
-                const redis = new RedisPool(await getClient(db, client, poolKey), poolKey, username && password ? { username, password } : undefined).add(item);
-                redis.parent = POOL_STATE;
-                redis.success = 1;
+                const target = new RedisPool(await getClient(redis, client, poolKey), poolKey, username && password ? { username, password } : undefined).add(item);
+                target.parent = POOL_STATE;
+                target.success = 1;
             }
             catch {
                 item.usePool = false;
@@ -151,7 +151,6 @@ async function executeBatchQuery(batch, options = '', outResult) {
     if (length === 0) {
         return [];
     }
-    const db = require("redis" /* STRINGS.PACKAGE_NAME */);
     let parallel, checkObject, connectOnce, errorQuery, sessionKey, outCacheMiss;
     if ((0, types_1.isPlainObject)(options)) {
         ({ parallel, checkObject, connectOnce, errorQuery, sessionKey, outCacheMiss } = options);
@@ -193,7 +192,7 @@ async function executeBatchQuery(batch, options = '', outResult) {
                     (credential.isolationPoolOptions || (credential.isolationPoolOptions = {})).max = size;
                 }
             }
-            clients.push(client = await getClient(db, credential));
+            clients.push(client = await getClient(redis, credential));
         }
         if (connectOnce) {
             redisClient = client;
@@ -204,9 +203,9 @@ async function executeBatchQuery(batch, options = '', outResult) {
     };
     for (let i = 0; i < length; ++i) {
         const item = batch[i];
-        const { source, uri, key, format = 'HASH', search, update, options: clientOptions = {}, cacheObjectKey, ignoreCache } = item;
+        const { source, uri, key, format = 'HASH', search, aggregate, update, options: clientOptions = {}, cacheObjectKey, ignoreCache } = item;
         let credential = (redisCredential || onceCredential), error;
-        if (!credential && !(0, types_1.isPlainObject)(credential = clientOptions.client) && (error = (0, types_1.errorMessage)(source, "Invalid credentials" /* ERR_DB.CREDENTIALS */)) || !((0, types_1.isString)(key) || (0, types_1.isArray)(key) || (0, types_1.isPlainObject)(search) && ((0, types_1.isPlainObject)(search.schema) || (0, types_1.isString)(search.query))) && (error = (0, types_1.errorMessage)(source, "Missing database query" /* ERR_DB.QUERY */, uri))) {
+        if (!credential && !(0, types_1.isPlainObject)(credential = clientOptions.client) && (error = (0, types_1.errorMessage)(source, "Invalid credentials" /* ERR_DB.CREDENTIALS */)) || !((0, types_1.isString)(key) || (0, types_1.isArray)(key) || (0, types_1.isPlainObject)(search) && ((0, types_1.isPlainObject)(search.schema) || (0, types_1.isString)(search.query)) || (0, types_1.isPlainObject)(aggregate) && ((0, types_1.isPlainObject)(aggregate.schema) || (0, types_1.isString)(aggregate.query))) && (error = (0, types_1.errorMessage)(source, "Missing database query" /* ERR_DB.QUERY */, uri))) {
             ++redisCache;
             if (this.handleFail(error, item, { errorQuery })) {
                 if (!parallel) {
@@ -228,12 +227,15 @@ async function executeBatchQuery(batch, options = '', outResult) {
         const targetObject = typeof checkObject === 'string' ? this.hasCoerce("redis" /* STRINGS.MODULE_NAME */, '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) ? db.commandOptions(clientOptions.command) : null;
+        const command = (0, types_1.isPlainObject)(clientOptions.command) ? redis.commandOptions(clientOptions.command) : null;
         let queryString = '', rows;
         if (caching && ignoreCache !== true || ignoreCache === false || ignoreCache === 1 || renewCache) {
             if ((0, types_1.isObject)(search)) {
                 queryString = Db.asString(search, true);
             }
+            else if ((0, types_1.isObject)(aggregate)) {
+                queryString = Db.asString(aggregate, true);
+            }
             else if (!targetObject) {
                 queryString = Db.asString(key);
             }
@@ -287,7 +289,7 @@ async function executeBatchQuery(batch, options = '', outResult) {
                             }
                             const failKey = () => failed((0, types_1.errorMessage)(f, "Invalid key" /* ERR_DB.KEY */, Db.asString(k) || "Unknown" /* ERR_MESSAGE.UNKNOWN */));
                             const failValue = () => failed((0, types_1.errorMessage)(f, "Invalid value" /* ERR_DB.VALUE */, Db.asString(v) || "Unknown" /* ERR_MESSAGE.UNKNOWN */));
-                            const commandSet = (0, types_1.isPlainObject)(setOptions.command) && db.commandOptions(setOptions.command);
+                            const commandSet = (0, types_1.isPlainObject)(setOptions.command) && redis.commandOptions(setOptions.command);
                             let pending;
                             if ((f = f.toUpperCase()) === 'JSON') {
                                 if (typeof k !== 'string') {
@@ -437,22 +439,28 @@ async function executeBatchQuery(batch, options = '', outResult) {
                     });
                 }
                 commandType = this.commandType.SELECT;
-                if ((0, types_1.isObject)(search)) {
-                    const { query = '', schema, index } = search;
+                const target = (0, types_1.isObject)(search) ? search : (0, types_1.isObject)(aggregate) ? aggregate : null;
+                if (target) {
+                    const { query = '', schema, index } = target;
                     let idx = '';
                     if ((0, types_1.isObject)(schema)) {
                         idx = index || (0, types_1.generateUUID)();
-                        await (command ? client.ft.create(command, idx, schema, search.options) : client.ft.create(idx, schema, search.options));
+                        await (command ? client.ft.create(command, idx, schema, target.options) : client.ft.create(idx, schema, target.options));
                     }
                     try {
-                        const reply = await (command ? client.ft.search(command, index || idx, query) : client.ft.search(index || idx, query));
-                        rows = reply.documents.map(doc => (doc.value['__id__'] = doc.id) && doc.value);
+                        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);
+                        }
+                        else {
+                            ({ results: rows } = await (command ? client.ft.aggregate(command, index || idx, query, clientOptions.aggregate) : client.ft.aggregate(index || idx, query, clientOptions.aggregate)));
+                        }
                     }
                     catch (err) {
                         error = err;
                     }
                     if (idx && idx !== index) {
-                        client.ft.dropIndex(idx).catch(err => this.writeFail(['Unable to drop search index', idx], err, { type: 65536 /* LOG_TYPE.DB */, fatal: false }));
+                        client.ft.dropIndex(idx).catch(err => this.writeFail([`Unable to drop ${target === search ? 'search' : 'aggregate'} index`, idx], err, { type: 65536 /* LOG_TYPE.DB */, fatal: false }));
                     }
                     if (error instanceof Error) {
                         throw error;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pi-r/redis",
-  "version": "0.2.2",
+  "version": "0.3.0",
   "description": "Redis client driver for E-mc.",
   "main": "client/index.js",
   "types": "client/index.d.ts",
@@ -21,8 +21,8 @@
   "license": "MIT",
   "homepage": "https://github.com/anpham6/pi-r#readme",
   "dependencies": {
-    "@e-mc/db": "^0.5.3",
-    "@e-mc/types": "^0.5.3",
-    "redis": "^4.6.6"
+    "@e-mc/db": "^0.6.0",
+    "@e-mc/types": "^0.6.0",
+    "redis": "^4.6.7"
   }
 }

package/types/index.d.ts

@@ -7,7 +7,7 @@ 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 { RediSearchSchema } from 'redis';
+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";
@@ -15,16 +15,14 @@ export interface RedisDataSource extends DbDataSource<string, PlainObject, Array
     field?: RedisCommandArgument;
     path?: string;
     format?: RedisFormat | "HKEYS" | "HVALS";
-    search?: {
-        index?: string;
-        schema?: RediSearchSchema | string;
-        query?: string;
-        options?: PlainObject;
-    };
+    search?: RedisQuery;
+    aggregate?: RedisQuery;
     options?: {
         client?: RedisClientOptions;
-        get?: PlainObject;
         command?: RedisCommandOptions;
+        get?: PlainObject;
+        search?: SearchOptions;
+        aggregate?: AggregateOptions;
     };
     database?: number;
 }
@@ -53,6 +51,13 @@ export interface RedisJSONValue extends Omit<RedisSetValue<"JSON", string, Redis
     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;