@midwayjs/cache-manager 4.0.0-beta.11 → 4.0.0-beta.12

package/dist/factory.d.ts

@@ -1,10 +1,15 @@
-import { IMidwayContainer, ServiceFactory, ServiceFactoryConfigOption } from '@midwayjs/core';
+import { IMidwayContainer, ServiceFactory, ServiceFactoryConfigOption, MidwayTraceService } from '@midwayjs/core';
 import { CacheManagerOptions, MidwayCache, MidwayMultiCache, MidwayUnionCache } from './interface';
 export declare class CachingFactory extends ServiceFactory<MidwayUnionCache> {
     protected cacheManagerConfig: ServiceFactoryConfigOption<CacheManagerOptions>;
     protected applicationContext: IMidwayContainer;
+    protected traceService: MidwayTraceService;
+    protected traceMetaResolver: any;
+    protected traceEnabled: any;
+    protected traceInjector: any;
     protected init(): Promise<void>;
     protected createClient(config: CacheManagerOptions<any>, clientName: string): Promise<void | MidwayUnionCache>;
+    protected bindTraceContext(cache: MidwayUnionCache, clientName: string): void;
     getName(): string;
     getCaching(cacheKey: string): MidwayCache;
     getMultiCaching(cacheKey: string): MidwayMultiCache;

package/dist/factory.js

@@ -15,6 +15,10 @@ const base_1 = require("./base");
 let CachingFactory = class CachingFactory extends core_1.ServiceFactory {
     cacheManagerConfig;
     applicationContext;
+    traceService;
+    traceMetaResolver;
+    traceEnabled;
+    traceInjector;
     async init() {
         await this.initClients(this.cacheManagerConfig);
     }
@@ -49,7 +53,9 @@ let CachingFactory = class CachingFactory extends core_1.ServiceFactory {
                     throw new core_1.MidwayCommonError('invalid cache config');
                 }
             }
-            return await (0, base_1.multiCaching)(newFactory);
+            const cache = await (0, base_1.multiCaching)(newFactory);
+            this.bindTraceContext(cache, clientName);
+            return cache;
         }
         else {
             // single cache
@@ -59,9 +65,65 @@ let CachingFactory = class CachingFactory extends core_1.ServiceFactory {
             if (!config.store) {
                 throw new core_1.MidwayCommonError(`cache instance "${clientName}" store is undefined, please check your configuration.`);
             }
-            return await (0, base_1.caching)(config.store, config['options']);
+            const cache = await (0, base_1.caching)(config.store, config['options']);
+            this.bindTraceContext(cache, clientName);
+            return cache;
         }
     }
+    bindTraceContext(cache, clientName) {
+        if (!cache || !this.traceService) {
+            return;
+        }
+        const wrapMethod = (target, methodName) => {
+            const rawMethod = target?.[methodName];
+            if (typeof rawMethod !== 'function') {
+                return;
+            }
+            target[methodName] = (...args) => {
+                const rawCarrier = typeof this.traceInjector === 'function'
+                    ? this.traceInjector({
+                        request: args,
+                        custom: {
+                            clientName,
+                            methodName,
+                        },
+                    })
+                    : {};
+                const carrier = rawCarrier && typeof rawCarrier === 'object' ? rawCarrier : {};
+                return this.traceService.runWithExitSpan(`cache.${methodName}`, {
+                    enable: this.traceEnabled !== false,
+                    carrier,
+                    attributes: {
+                        'midway.protocol': 'cache',
+                        'midway.cache.client': clientName,
+                        'midway.cache.method': methodName,
+                    },
+                    meta: this.traceMetaResolver,
+                    metaArgs: {
+                        carrier,
+                        request: args,
+                        custom: {
+                            clientName,
+                            methodName,
+                        },
+                    },
+                }, async () => {
+                    return rawMethod.apply(target, args);
+                });
+            };
+        };
+        [
+            'get',
+            'set',
+            'del',
+            'wrap',
+            'methodWrap',
+            'mget',
+            'mset',
+            'mdel',
+            'reset',
+        ].forEach(methodName => wrapMethod(cache, methodName));
+    }
     getName() {
         return 'cache-manager';
     }
@@ -81,6 +143,22 @@ __decorate([
     (0, core_1.ApplicationContext)(),
     __metadata("design:type", Object)
 ], CachingFactory.prototype, "applicationContext", void 0);
+__decorate([
+    (0, core_1.Inject)(),
+    __metadata("design:type", core_1.MidwayTraceService)
+], CachingFactory.prototype, "traceService", void 0);
+__decorate([
+    (0, core_1.Config)('cacheManager.tracing.meta'),
+    __metadata("design:type", Object)
+], CachingFactory.prototype, "traceMetaResolver", void 0);
+__decorate([
+    (0, core_1.Config)('cacheManager.tracing.enable'),
+    __metadata("design:type", Object)
+], CachingFactory.prototype, "traceEnabled", void 0);
+__decorate([
+    (0, core_1.Config)('cacheManager.tracing.injector'),
+    __metadata("design:type", Object)
+], CachingFactory.prototype, "traceInjector", void 0);
 __decorate([
     (0, core_1.Init)(),
     __metadata("design:type", Function),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@midwayjs/cache-manager",
-  "version": "4.0.0-beta.11",
+  "version": "4.0.0-beta.12",
   "description": "midway cache manager",
   "main": "dist/index.js",
   "typings": "index.d.ts",
@@ -28,9 +28,9 @@
     "node": ">=20"
   },
   "devDependencies": {
-    "@midwayjs/core": "^4.0.0-beta.11",
-    "@midwayjs/mock": "^4.0.0-beta.11",
-    "@midwayjs/redis": "^4.0.0-beta.11",
+    "@midwayjs/core": "^4.0.0-beta.12",
+    "@midwayjs/mock": "^4.0.0-beta.12",
+    "@midwayjs/redis": "^4.0.0-beta.12",
     "cache-manager": "6.0.0",
     "cache-manager-ioredis-yet": "2.1.2"
   },
@@ -38,5 +38,5 @@
     "lodash.clonedeep": "4.5.0",
     "lru-cache": "7.18.3"
   },
-  "gitHead": "6ef05719ca6e900f1ec34aff7a5c5a9614358c50"
+  "gitHead": "1c48179b7c827ba8ec9351e9b6c36ec1726d3e11"
 }