imean-service-engine 1.2.2 → 1.3.0

package/dist/mod.cjs

@@ -1,12 +1,12 @@
 'use strict';
 
 var zod = require('zod');
+var ejson4 = require('ejson');
+var lruCache = require('lru-cache');
 var nodeServer = require('@hono/node-server');
-var ejson3 = require('ejson');
 var etcd3 = require('etcd3');
 var fs = require('fs-extra');
 var hono = require('hono');
-var lruCache = require('lru-cache');
 var api = require('@opentelemetry/api');
 var winston = require('winston');
 var prettier = require('prettier');
@@ -17,7 +17,7 @@ var dayjs = require('dayjs');
 
 function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
 
-var ejson3__default = /*#__PURE__*/_interopDefault(ejson3);
+var ejson4__default = /*#__PURE__*/_interopDefault(ejson4);
 var fs__default = /*#__PURE__*/_interopDefault(fs);
 var winston__default = /*#__PURE__*/_interopDefault(winston);
 var prettier__default = /*#__PURE__*/_interopDefault(prettier);
@@ -25,6 +25,38 @@ var crypto2__default = /*#__PURE__*/_interopDefault(crypto2);
 var dayjs__default = /*#__PURE__*/_interopDefault(dayjs);
 
 // mod.ts
+var CacheAdapter = class {
+};
+var RedisCacheAdapter = class extends CacheAdapter {
+  constructor(redis) {
+    super();
+    this.redis = redis;
+  }
+  async get(key) {
+    const value = await this.redis.get(key);
+    return value ? ejson4__default.default.parse(value) : null;
+  }
+  async set(key, value, ttl) {
+    return this.redis.set(key, ejson4__default.default.stringify(value), "EX", ttl / 1e3);
+  }
+};
+var MemoryCacheAdapter = class extends CacheAdapter {
+  cache;
+  constructor(options) {
+    super();
+    this.cache = new lruCache.LRUCache({
+      max: 1e3,
+      ttl: 1e3 * 60 * 10,
+      ...options
+    });
+  }
+  async get(key) {
+    return this.cache.get(key);
+  }
+  async set(key, value, ttl) {
+    this.cache.set(key, value, { ttl });
+  }
+};
 var ACTION_METADATA = Symbol("action:metadata");
 function Action(options) {
   options.params = options.params || [];
@@ -297,9 +329,6 @@ function getZodTypeString(schema, defaultOptional = false) {
         }).join("; ");
         return `{ ${props} }`;
       }
-      case "ZodEnum": {
-        return def.values.map((opt) => `"${opt}"`).join(" | ");
-      }
       case "ZodUnion": {
         return def.options.map((opt) => processType(opt)).join(" | ");
       }
@@ -328,8 +357,8 @@ function getZodTypeString(schema, defaultOptional = false) {
       case "ZodUnknown": {
         return "unknown";
       }
-      case "ZodEnum ": {
-        return def.values.map((opt) => `"${opt}"`).join(" | ");
+      case "ZodEnum": {
+        return "(" + def.values.map((opt) => `"${opt}"`).join(" | ") + ")";
       }
       case "ZodDefault": {
         return processType(def.innerType);
@@ -455,7 +484,7 @@ var ActionHandler = class {
       let args;
       if (typeof req === "string") {
         try {
-          args = Object.values(ejson3__default.default.parse(req));
+          args = Object.values(ejson4__default.default.parse(req));
         } catch (error) {
           throw new Error(`Invalid request body: ${error.message}`);
         }
@@ -473,7 +502,7 @@ var ActionHandler = class {
           }
         });
       }
-      const requestHash = hashText(ejson3__default.default.stringify(args));
+      const requestHash = hashText(ejson4__default.default.stringify(args));
       span.setAttribute("requestHash", requestHash);
       return { args, requestHash };
     } finally {
@@ -483,8 +512,10 @@ var ActionHandler = class {
   async _handle(req) {
     const span = api.trace.getActiveSpan();
     const { args, requestHash } = await this._validate(req);
+    const cacheHash = typeof this.metadata.cache === "function" ? this.metadata.cache(...args) : requestHash;
+    const cacheKey = `${this.microservice.options.name}:cache:${this.moduleName}:${this.actionName}:${hashText(ejson4__default.default.stringify(cacheHash))}`;
+    span?.setAttribute("args", JSON.stringify(args));
     if (!this.metadata.stream && this.metadata.cache && !this.microservice.options.disableCache) {
-      const cacheKey = `${this.moduleName}.${this.actionName}.${requestHash}`;
       const cached = await this.microservice.cache.get(cacheKey);
       const now = Date.now();
       if (cached !== null && (!this.metadata.ttl || cached?.expireAt > now)) {
@@ -530,7 +561,6 @@ var ActionHandler = class {
         }
       }
       if (this.metadata.cache && !this.microservice.options.disableCache) {
-        const cacheKey = `${this.moduleName}.${this.actionName}.${requestHash}`;
         const now = Date.now();
         this.microservice.cache.set(
           cacheKey,
@@ -538,7 +568,7 @@ var ActionHandler = class {
             data: parsedResult,
             expireAt: this.metadata.ttl ? now + this.metadata.ttl : void 0
           },
-          { ttl: this.metadata.ttl }
+          this.metadata.ttl ?? 1e3
         );
       }
       return parsedResult;
@@ -567,7 +597,7 @@ var WebSocketHandler = class {
     this.sockets.add(ws);
   }
   async encodeMessage(message) {
-    const jsonStr = ejson3__default.default.stringify(message);
+    const jsonStr = ejson4__default.default.stringify(message);
     const data = new TextEncoder().encode(jsonStr);
     const compressed = await brotli.compress(data, 6);
     return compressed;
@@ -576,7 +606,7 @@ var WebSocketHandler = class {
     try {
       const decompressed = await brotli.decompress(new Uint8Array(data));
       const jsonStr = new TextDecoder().decode(decompressed);
-      return ejson3__default.default.parse(jsonStr);
+      return ejson4__default.default.parse(jsonStr);
     } catch (error) {
       console.error("Error decoding message", error);
       throw error;
@@ -637,7 +667,7 @@ var WebSocketHandler = class {
           false
         );
         ws.send(
-          ejson3__default.default.stringify({
+          ejson4__default.default.stringify({
             id: message.id,
             success: false,
             error: "Request timeout"
@@ -753,17 +783,15 @@ var Microservice = class {
     this.options = {
       prefix: "/api",
       name: "microservice",
+      cacheAdapter: new MemoryCacheAdapter(),
       ...options
     };
+    this.cache = this.options.cacheAdapter;
     this.fetch = this.app.request;
     this.waitingInitialization = this.initialize();
     ServiceContext.service = this;
   }
   async initialize() {
-    this.cache = new lruCache.LRUCache({
-      max: 1e3,
-      ttl: 1e3 * 60 * 10
-    });
     if (this.options.etcd) {
       this.initEtcd(this.options.etcd);
     }
@@ -1127,12 +1155,12 @@ Received SIGINT signal`);
             try {
               for await (const value of result) {
                 const response = { value, done: false };
-                const chunk = encoder.encode(ejson3__default.default.stringify(response) + "\n");
+                const chunk = encoder.encode(ejson4__default.default.stringify(response) + "\n");
                 controller.enqueue(chunk);
               }
               controller.enqueue(
                 encoder.encode(
-                  ejson3__default.default.stringify({ done: true }) + "\n"
+                  ejson4__default.default.stringify({ done: true }) + "\n"
                 )
               );
               controller.close();
@@ -1142,7 +1170,7 @@ Received SIGINT signal`);
                 done: true
               };
               controller.enqueue(
-                encoder.encode(ejson3__default.default.stringify(response) + "\n")
+                encoder.encode(ejson4__default.default.stringify(response) + "\n")
               );
               controller.close();
             }
@@ -1156,7 +1184,7 @@ Received SIGINT signal`);
           }
         });
       }
-      return ctx.text(ejson3__default.default.stringify({ success: true, data: result }));
+      return ctx.text(ejson4__default.default.stringify({ success: true, data: result }));
     } catch (error) {
       return ctx.json({ success: false, error: error.message });
     }
@@ -1217,8 +1245,11 @@ Object.defineProperty(exports, "dayjs", {
   get: function () { return dayjs__default.default; }
 });
 exports.Action = Action;
+exports.CacheAdapter = CacheAdapter;
+exports.MemoryCacheAdapter = MemoryCacheAdapter;
 exports.Microservice = Microservice;
 exports.Module = Module;
+exports.RedisCacheAdapter = RedisCacheAdapter;
 exports.Schedule = Schedule;
 exports.ScheduleMode = ScheduleMode;
 exports.ServiceContext = ServiceContext;

package/dist/mod.d.cts

@@ -1,25 +1,44 @@
 import { z } from 'zod';
 export * from 'zod';
+import { Redis, Cluster } from 'ioredis';
+import { LRUCache } from 'lru-cache';
 import { Lease, Etcd3 } from 'etcd3';
 import { Hono } from 'hono';
-import { LRUCache } from 'lru-cache';
 export { default as dayjs } from 'dayjs';
 import winston from 'winston';
 
+declare abstract class CacheAdapter {
+    abstract get(key: string): Promise<any>;
+    abstract set(key: string, value: any, ttl: number): Promise<any>;
+}
+declare class RedisCacheAdapter extends CacheAdapter {
+    private readonly redis;
+    constructor(redis: Redis | Cluster);
+    get(key: string): Promise<any>;
+    set(key: string, value: string, ttl: number): Promise<"OK">;
+}
+declare class MemoryCacheAdapter extends CacheAdapter {
+    private cache;
+    constructor(options?: LRUCache.Options<string, any, any>);
+    get(key: string): Promise<any>;
+    set(key: string, value: any, ttl: number): Promise<void>;
+}
+
+type CacheFn = (...args: any[]) => any;
 interface ActionOptions {
     params?: z.ZodType<any>[];
     returns?: z.ZodType<any>;
     idempotence?: boolean;
     description?: string;
     printError?: boolean;
-    cache?: boolean;
+    cache?: boolean | CacheFn;
     ttl?: number;
     stream?: boolean;
 }
 interface ActionMetadata extends ActionOptions {
     name: string;
     idempotence: boolean;
-    cache?: boolean;
+    cache?: boolean | CacheFn;
     ttl?: number;
     stream?: boolean;
 }
@@ -130,6 +149,7 @@ interface MicroserviceOptions {
         enabled?: boolean;
         timeout?: number;
     };
+    cacheAdapter?: CacheAdapter;
 }
 interface ModuleInfo extends ModuleOptions {
     actions: Record<string, ActionMetadata>;
@@ -176,7 +196,7 @@ declare class Microservice {
     modules: Map<string, ModuleInfo>;
     readonly fetch: typeof fetch;
     options: MicroserviceOptions;
-    cache: LRUCache<string, any>;
+    cache: CacheAdapter;
     serviceId: string;
     constructor(options: MicroserviceOptions);
     private initialize;
@@ -258,4 +278,4 @@ declare function Schedule(options: ScheduleOptions): Function;
 
 declare const logger: winston.Logger;
 
-export { Action, type ActionErrorEvent, type ActionMetadata, type ActionOptions, type EtcdConfig, type EventServiceInfo, Microservice, type MicroserviceOptions, Module, type ModuleInfo, type ModuleMetadata, type ModuleOptions, type PreStartChecker, Schedule, type ScheduleMetadata, ScheduleMode, type ScheduleOptions, ServiceContext, type ServiceInfo, type ServiceStats, type StatisticsEvent, type StreamResponse, logger, startCheck };
+export { Action, type ActionErrorEvent, type ActionMetadata, type ActionOptions, CacheAdapter, type CacheFn, type EtcdConfig, type EventServiceInfo, MemoryCacheAdapter, Microservice, type MicroserviceOptions, Module, type ModuleInfo, type ModuleMetadata, type ModuleOptions, type PreStartChecker, RedisCacheAdapter, Schedule, type ScheduleMetadata, ScheduleMode, type ScheduleOptions, ServiceContext, type ServiceInfo, type ServiceStats, type StatisticsEvent, type StreamResponse, logger, startCheck };

package/dist/mod.d.ts

@@ -1,25 +1,44 @@
 import { z } from 'zod';
 export * from 'zod';
+import { Redis, Cluster } from 'ioredis';
+import { LRUCache } from 'lru-cache';
 import { Lease, Etcd3 } from 'etcd3';
 import { Hono } from 'hono';
-import { LRUCache } from 'lru-cache';
 export { default as dayjs } from 'dayjs';
 import winston from 'winston';
 
+declare abstract class CacheAdapter {
+    abstract get(key: string): Promise<any>;
+    abstract set(key: string, value: any, ttl: number): Promise<any>;
+}
+declare class RedisCacheAdapter extends CacheAdapter {
+    private readonly redis;
+    constructor(redis: Redis | Cluster);
+    get(key: string): Promise<any>;
+    set(key: string, value: string, ttl: number): Promise<"OK">;
+}
+declare class MemoryCacheAdapter extends CacheAdapter {
+    private cache;
+    constructor(options?: LRUCache.Options<string, any, any>);
+    get(key: string): Promise<any>;
+    set(key: string, value: any, ttl: number): Promise<void>;
+}
+
+type CacheFn = (...args: any[]) => any;
 interface ActionOptions {
     params?: z.ZodType<any>[];
     returns?: z.ZodType<any>;
     idempotence?: boolean;
     description?: string;
     printError?: boolean;
-    cache?: boolean;
+    cache?: boolean | CacheFn;
     ttl?: number;
     stream?: boolean;
 }
 interface ActionMetadata extends ActionOptions {
     name: string;
     idempotence: boolean;
-    cache?: boolean;
+    cache?: boolean | CacheFn;
     ttl?: number;
     stream?: boolean;
 }
@@ -130,6 +149,7 @@ interface MicroserviceOptions {
         enabled?: boolean;
         timeout?: number;
     };
+    cacheAdapter?: CacheAdapter;
 }
 interface ModuleInfo extends ModuleOptions {
     actions: Record<string, ActionMetadata>;
@@ -176,7 +196,7 @@ declare class Microservice {
     modules: Map<string, ModuleInfo>;
     readonly fetch: typeof fetch;
     options: MicroserviceOptions;
-    cache: LRUCache<string, any>;
+    cache: CacheAdapter;
     serviceId: string;
     constructor(options: MicroserviceOptions);
     private initialize;
@@ -258,4 +278,4 @@ declare function Schedule(options: ScheduleOptions): Function;
 
 declare const logger: winston.Logger;
 
-export { Action, type ActionErrorEvent, type ActionMetadata, type ActionOptions, type EtcdConfig, type EventServiceInfo, Microservice, type MicroserviceOptions, Module, type ModuleInfo, type ModuleMetadata, type ModuleOptions, type PreStartChecker, Schedule, type ScheduleMetadata, ScheduleMode, type ScheduleOptions, ServiceContext, type ServiceInfo, type ServiceStats, type StatisticsEvent, type StreamResponse, logger, startCheck };
+export { Action, type ActionErrorEvent, type ActionMetadata, type ActionOptions, CacheAdapter, type CacheFn, type EtcdConfig, type EventServiceInfo, MemoryCacheAdapter, Microservice, type MicroserviceOptions, Module, type ModuleInfo, type ModuleMetadata, type ModuleOptions, type PreStartChecker, RedisCacheAdapter, Schedule, type ScheduleMetadata, ScheduleMode, type ScheduleOptions, ServiceContext, type ServiceInfo, type ServiceStats, type StatisticsEvent, type StreamResponse, logger, startCheck };

package/dist/mod.js

@@ -1,11 +1,11 @@
 import { z } from 'zod';
 export * from 'zod';
+import ejson4 from 'ejson';
+import { LRUCache } from 'lru-cache';
 import { serve } from '@hono/node-server';
-import ejson3 from 'ejson';
 import { Etcd3 } from 'etcd3';
 import fs from 'fs-extra';
 import { Hono } from 'hono';
-import { LRUCache } from 'lru-cache';
 import { trace, SpanStatusCode } from '@opentelemetry/api';
 import winston, { format } from 'winston';
 import prettier from 'prettier';
@@ -16,6 +16,38 @@ import { createNodeWebSocket } from '@hono/node-ws';
 export { default as dayjs } from 'dayjs';
 
 // mod.ts
+var CacheAdapter = class {
+};
+var RedisCacheAdapter = class extends CacheAdapter {
+  constructor(redis) {
+    super();
+    this.redis = redis;
+  }
+  async get(key) {
+    const value = await this.redis.get(key);
+    return value ? ejson4.parse(value) : null;
+  }
+  async set(key, value, ttl) {
+    return this.redis.set(key, ejson4.stringify(value), "EX", ttl / 1e3);
+  }
+};
+var MemoryCacheAdapter = class extends CacheAdapter {
+  cache;
+  constructor(options) {
+    super();
+    this.cache = new LRUCache({
+      max: 1e3,
+      ttl: 1e3 * 60 * 10,
+      ...options
+    });
+  }
+  async get(key) {
+    return this.cache.get(key);
+  }
+  async set(key, value, ttl) {
+    this.cache.set(key, value, { ttl });
+  }
+};
 var ACTION_METADATA = Symbol("action:metadata");
 function Action(options) {
   options.params = options.params || [];
@@ -288,9 +320,6 @@ function getZodTypeString(schema, defaultOptional = false) {
         }).join("; ");
         return `{ ${props} }`;
       }
-      case "ZodEnum": {
-        return def.values.map((opt) => `"${opt}"`).join(" | ");
-      }
       case "ZodUnion": {
         return def.options.map((opt) => processType(opt)).join(" | ");
       }
@@ -319,8 +348,8 @@ function getZodTypeString(schema, defaultOptional = false) {
       case "ZodUnknown": {
         return "unknown";
       }
-      case "ZodEnum ": {
-        return def.values.map((opt) => `"${opt}"`).join(" | ");
+      case "ZodEnum": {
+        return "(" + def.values.map((opt) => `"${opt}"`).join(" | ") + ")";
       }
       case "ZodDefault": {
         return processType(def.innerType);
@@ -446,7 +475,7 @@ var ActionHandler = class {
       let args;
       if (typeof req === "string") {
         try {
-          args = Object.values(ejson3.parse(req));
+          args = Object.values(ejson4.parse(req));
         } catch (error) {
           throw new Error(`Invalid request body: ${error.message}`);
         }
@@ -464,7 +493,7 @@ var ActionHandler = class {
           }
         });
       }
-      const requestHash = hashText(ejson3.stringify(args));
+      const requestHash = hashText(ejson4.stringify(args));
       span.setAttribute("requestHash", requestHash);
       return { args, requestHash };
     } finally {
@@ -474,8 +503,10 @@ var ActionHandler = class {
   async _handle(req) {
     const span = trace.getActiveSpan();
     const { args, requestHash } = await this._validate(req);
+    const cacheHash = typeof this.metadata.cache === "function" ? this.metadata.cache(...args) : requestHash;
+    const cacheKey = `${this.microservice.options.name}:cache:${this.moduleName}:${this.actionName}:${hashText(ejson4.stringify(cacheHash))}`;
+    span?.setAttribute("args", JSON.stringify(args));
     if (!this.metadata.stream && this.metadata.cache && !this.microservice.options.disableCache) {
-      const cacheKey = `${this.moduleName}.${this.actionName}.${requestHash}`;
       const cached = await this.microservice.cache.get(cacheKey);
       const now = Date.now();
       if (cached !== null && (!this.metadata.ttl || cached?.expireAt > now)) {
@@ -521,7 +552,6 @@ var ActionHandler = class {
         }
       }
       if (this.metadata.cache && !this.microservice.options.disableCache) {
-        const cacheKey = `${this.moduleName}.${this.actionName}.${requestHash}`;
         const now = Date.now();
         this.microservice.cache.set(
           cacheKey,
@@ -529,7 +559,7 @@ var ActionHandler = class {
             data: parsedResult,
             expireAt: this.metadata.ttl ? now + this.metadata.ttl : void 0
           },
-          { ttl: this.metadata.ttl }
+          this.metadata.ttl ?? 1e3
         );
       }
       return parsedResult;
@@ -558,7 +588,7 @@ var WebSocketHandler = class {
     this.sockets.add(ws);
   }
   async encodeMessage(message) {
-    const jsonStr = ejson3.stringify(message);
+    const jsonStr = ejson4.stringify(message);
     const data = new TextEncoder().encode(jsonStr);
     const compressed = await brotli.compress(data, 6);
     return compressed;
@@ -567,7 +597,7 @@ var WebSocketHandler = class {
     try {
       const decompressed = await brotli.decompress(new Uint8Array(data));
       const jsonStr = new TextDecoder().decode(decompressed);
-      return ejson3.parse(jsonStr);
+      return ejson4.parse(jsonStr);
     } catch (error) {
       console.error("Error decoding message", error);
       throw error;
@@ -628,7 +658,7 @@ var WebSocketHandler = class {
           false
         );
         ws.send(
-          ejson3.stringify({
+          ejson4.stringify({
             id: message.id,
             success: false,
             error: "Request timeout"
@@ -744,17 +774,15 @@ var Microservice = class {
     this.options = {
       prefix: "/api",
       name: "microservice",
+      cacheAdapter: new MemoryCacheAdapter(),
       ...options
     };
+    this.cache = this.options.cacheAdapter;
     this.fetch = this.app.request;
     this.waitingInitialization = this.initialize();
     ServiceContext.service = this;
   }
   async initialize() {
-    this.cache = new LRUCache({
-      max: 1e3,
-      ttl: 1e3 * 60 * 10
-    });
     if (this.options.etcd) {
       this.initEtcd(this.options.etcd);
     }
@@ -1118,12 +1146,12 @@ Received SIGINT signal`);
             try {
               for await (const value of result) {
                 const response = { value, done: false };
-                const chunk = encoder.encode(ejson3.stringify(response) + "\n");
+                const chunk = encoder.encode(ejson4.stringify(response) + "\n");
                 controller.enqueue(chunk);
               }
               controller.enqueue(
                 encoder.encode(
-                  ejson3.stringify({ done: true }) + "\n"
+                  ejson4.stringify({ done: true }) + "\n"
                 )
               );
               controller.close();
@@ -1133,7 +1161,7 @@ Received SIGINT signal`);
                 done: true
               };
               controller.enqueue(
-                encoder.encode(ejson3.stringify(response) + "\n")
+                encoder.encode(ejson4.stringify(response) + "\n")
               );
               controller.close();
             }
@@ -1147,7 +1175,7 @@ Received SIGINT signal`);
           }
         });
       }
-      return ctx.text(ejson3.stringify({ success: true, data: result }));
+      return ctx.text(ejson4.stringify({ success: true, data: result }));
     } catch (error) {
       return ctx.json({ success: false, error: error.message });
     }
@@ -1203,4 +1231,4 @@ async function startCheck(checkers, pass) {
   if (pass) await pass();
 }
 
-export { Action, Microservice, Module, Schedule, ScheduleMode, ServiceContext, logger_default as logger, startCheck };
+export { Action, CacheAdapter, MemoryCacheAdapter, Microservice, Module, RedisCacheAdapter, Schedule, ScheduleMode, ServiceContext, logger_default as logger, startCheck };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "imean-service-engine",
-  "version": "1.2.2",
+  "version": "1.3.0",
   "description": "microservice engine",
   "keywords": [
     "microservice",
@@ -50,7 +50,8 @@
     "zod": "^3.24.1"
   },
   "peerDependencies": {
-    "@opentelemetry/api": "^1.x"
+    "@opentelemetry/api": "^1.x",
+    "ioredis": "^5.6.0"
   },
   "devDependencies": {
     "@opentelemetry/auto-instrumentations-node": "^0.55.3",
@@ -65,9 +66,11 @@
     "@opentelemetry/winston-transport": "^0.10.0",
     "@types/ejson": "^2.2.2",
     "@types/fs-extra": "^11.0.4",
+    "@types/ioredis-mock": "^8.2.5",
     "@types/node": "^20.0.0",
     "@vitest/coverage-v8": "^3.0.4",
     "imean-service-client": "^1.5.0",
+    "ioredis-mock": "^8.9.0",
     "opentelemetry-instrumentation-fetch-node": "^1.2.3",
     "tslib": "^2.8.1",
     "tsup": "^8.0.1",