@jintianxiayu/cache-decorator 1.0.0 → 1.0.2

package/test/fixtures/cache-logger-child.mjs

@@ -1,108 +1,108 @@
-import assert from 'node:assert/strict';
-import { realpathSync } from 'node:fs';
-import { createRequire } from 'node:module';
-import { dirname, join, resolve } from 'node:path';
-import { fileURLToPath } from 'node:url';
-import cachePackage from '../../dist/index.js';
-import loggerPackage from '../../../logger/dist/index.js';
-
-const { Cache, CacheProviderRegistry, MemoryCacheProvider } = cachePackage;
-const { LoggerContext, LoggerFactory } = loggerPackage;
-const CACHE_LOGGER_NAME = '@jintianxiayu/cache-decorator';
-const profileLevel = process.argv[2];
-const fixtureDirectory = dirname(fileURLToPath(import.meta.url));
-const fixtureRequire = createRequire(import.meta.url);
-if (profileLevel !== 'debug' && profileLevel !== 'error') {
-    throw new Error('Expected cache Logger profile level: debug or error');
-}
-
-/** 将 legacy method decorator 应用到 JavaScript fixture 的指定方法。 */
-function decorateMethod(target, methodName, decorator) {
-    const descriptor = Object.getOwnPropertyDescriptor(target, methodName);
-    assert.ok(descriptor);
-    decorator(target, methodName, descriptor);
-    Object.defineProperty(target, methodName, descriptor);
-}
-
-/** 在应用初始化 Logger 后执行正常缓存和 Provider 失败调用。 */
-async function main() {
-    LoggerFactory.init({
-        root: {
-            level: 'error',
-            console: { enabled: false, colors: false, format: 'json' },
-            file: { enabled: false },
-        },
-        loggers: {
-            [CACHE_LOGGER_NAME]: {
-                level: profileLevel,
-                console: { enabled: true, colors: false, format: 'json' },
-                file: { enabled: false },
-            },
-        },
-        masking: { enabled: true },
-        processErrors: {
-            uncaughtException: false,
-            unhandledRejection: false,
-            exitOnError: false,
-        },
-    });
-
-    const cachePackageRoot = resolve(fixtureDirectory, '../..');
-    const requireFromCache = createRequire(join(cachePackageRoot, 'package.json'));
-    const directLoggerEntry = fixtureRequire.resolve('@jintianxiayu/logger');
-    const cacheLoggerEntry = requireFromCache.resolve('@jintianxiayu/logger');
-    assert.equal(realpathSync(directLoggerEntry), realpathSync(cacheLoggerEntry));
-    const namedLogger = LoggerFactory.getLogger(CACHE_LOGGER_NAME);
-
-    const memoryProvider = new MemoryCacheProvider();
-    const providerError = Object.assign(new Error('redis unavailable'), {
-        password: 'provider-password-secret',
-        email: 'provider@example.com',
-    });
-    const failingProvider = {
-        get: async () => {
-            throw providerError;
-        },
-        set: () => undefined,
-        delete: () => undefined,
-        clear: () => undefined,
-        deleteByPattern: () => undefined,
-    };
-
-    class SuccessService {
-        getUser() {
-            return { id: 17, password: 'business-value-secret' };
-        }
-    }
-    decorateMethod(SuccessService.prototype, 'getUser', Cache('fixture-users', { providerName: 'memory' }));
-
-    class FailureService {
-        getUser() {
-            throw new Error('business method must not run');
-        }
-    }
-    decorateMethod(FailureService.prototype, 'getUser', Cache('fixture-failure-users', { providerName: 'failing' }));
-
-    CacheProviderRegistry.register('memory', memoryProvider);
-    CacheProviderRegistry.register('failing', failingProvider);
-    try {
-        const result = await LoggerContext.withContext({ traceId: 'cache-fixture-trace' }, () =>
-            new SuccessService().getUser()
-        );
-        assert.deepEqual(result, { id: 17, password: 'business-value-secret' });
-
-        const failure = LoggerContext.withContext({ traceId: 'cache-fixture-trace' }, () =>
-            new FailureService().getUser()
-        );
-        await assert.rejects(failure, (error) => error === providerError);
-        assert.strictEqual(LoggerFactory.getLogger(CACHE_LOGGER_NAME), namedLogger);
-    } finally {
-        CacheProviderRegistry.clear();
-        await LoggerFactory.shutdown({ timeout: 2_000 });
-    }
-}
-
-main().catch((error) => {
-    process.stderr.write(`${error instanceof Error ? error.stack : String(error)}\n`);
-    process.exitCode = 1;
-});
+import assert from 'node:assert/strict';
+import { realpathSync } from 'node:fs';
+import { createRequire } from 'node:module';
+import { dirname, join, resolve } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import cachePackage from '../../dist/index.js';
+import loggerPackage from '../../../logger/dist/index.js';
+
+const { Cache, CacheProviderRegistry, MemoryCacheProvider } = cachePackage;
+const { LoggerContext, LoggerFactory } = loggerPackage;
+const CACHE_LOGGER_NAME = '@jintianxiayu/cache-decorator';
+const profileLevel = process.argv[2];
+const fixtureDirectory = dirname(fileURLToPath(import.meta.url));
+const fixtureRequire = createRequire(import.meta.url);
+if (profileLevel !== 'debug' && profileLevel !== 'error') {
+    throw new Error('Expected cache Logger profile level: debug or error');
+}
+
+/** 将 legacy method decorator 应用到 JavaScript fixture 的指定方法。 */
+function decorateMethod(target, methodName, decorator) {
+    const descriptor = Object.getOwnPropertyDescriptor(target, methodName);
+    assert.ok(descriptor);
+    decorator(target, methodName, descriptor);
+    Object.defineProperty(target, methodName, descriptor);
+}
+
+/** 在应用初始化 Logger 后执行正常缓存和 Provider 失败调用。 */
+async function main() {
+    LoggerFactory.init({
+        root: {
+            level: 'error',
+            console: { enabled: false, colors: false, format: 'json' },
+            file: { enabled: false },
+        },
+        loggers: {
+            [CACHE_LOGGER_NAME]: {
+                level: profileLevel,
+                console: { enabled: true, colors: false, format: 'json' },
+                file: { enabled: false },
+            },
+        },
+        masking: { enabled: true },
+        processErrors: {
+            uncaughtException: false,
+            unhandledRejection: false,
+            exitOnError: false,
+        },
+    });
+
+    const cachePackageRoot = resolve(fixtureDirectory, '../..');
+    const requireFromCache = createRequire(join(cachePackageRoot, 'package.json'));
+    const directLoggerEntry = fixtureRequire.resolve('@jintianxiayu/logger');
+    const cacheLoggerEntry = requireFromCache.resolve('@jintianxiayu/logger');
+    assert.equal(realpathSync(directLoggerEntry), realpathSync(cacheLoggerEntry));
+    const namedLogger = LoggerFactory.getLogger(CACHE_LOGGER_NAME);
+
+    const memoryProvider = new MemoryCacheProvider();
+    const providerError = Object.assign(new Error('redis unavailable'), {
+        password: 'provider-password-secret',
+        email: 'provider@example.com',
+    });
+    const failingProvider = {
+        get: async () => {
+            throw providerError;
+        },
+        set: () => undefined,
+        delete: () => undefined,
+        clear: () => undefined,
+        deleteByPattern: () => undefined,
+    };
+
+    class SuccessService {
+        getUser() {
+            return { id: 17, password: 'business-value-secret' };
+        }
+    }
+    decorateMethod(SuccessService.prototype, 'getUser', Cache('fixture-users', { providerName: 'memory' }));
+
+    class FailureService {
+        getUser() {
+            return { id: 18, source: 'business-bypass' };
+        }
+    }
+    decorateMethod(FailureService.prototype, 'getUser', Cache('fixture-failure-users', { providerName: 'failing' }));
+
+    CacheProviderRegistry.register('memory', memoryProvider);
+    CacheProviderRegistry.register('failing', failingProvider);
+    try {
+        const result = await LoggerContext.withContext({ traceId: 'cache-fixture-trace' }, () =>
+            new SuccessService().getUser()
+        );
+        assert.deepEqual(result, { id: 17, password: 'business-value-secret' });
+
+        const bypassResult = await LoggerContext.withContext({ traceId: 'cache-fixture-trace' }, () =>
+            new FailureService().getUser()
+        );
+        assert.deepEqual(bypassResult, { id: 18, source: 'business-bypass' });
+        assert.strictEqual(LoggerFactory.getLogger(CACHE_LOGGER_NAME), namedLogger);
+    } finally {
+        CacheProviderRegistry.clear();
+        await LoggerFactory.shutdown({ timeout: 2_000 });
+    }
+}
+
+main().catch((error) => {
+    process.stderr.write(`${error instanceof Error ? error.stack : String(error)}\n`);
+    process.exitCode = 1;
+});

package/test/fixtures/cache-provider-failure-child.mjs

@@ -0,0 +1,70 @@
+import assert from 'node:assert/strict';
+import { join } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import cachePackage from '../../dist/index.js';
+
+const { Cache, CacheEvict, CacheProviderRegistry } = cachePackage;
+
+/** 将 legacy method decorator 应用到 JavaScript fixture 的指定方法。 */
+function decorateMethod(target, methodName, decorator) {
+    const descriptor = Object.getOwnPropertyDescriptor(target, methodName);
+    assert.ok(descriptor);
+    decorator(target, methodName, descriptor);
+    Object.defineProperty(target, methodName, descriptor);
+}
+
+/** 执行异步写入和删除拒绝场景，进程必须在 strict rejection 模式下正常退出。 */
+async function main() {
+    const writeError = new Error('async cache write failed');
+    const deleteError = new Error('async cache delete failed');
+    const writeProvider = {
+        get: () => undefined,
+        set: () => Promise.reject(writeError),
+        delete: () => undefined,
+        clear: () => undefined,
+        deleteByPattern: () => undefined,
+    };
+    const deleteProvider = {
+        get: () => undefined,
+        set: () => undefined,
+        delete: () => Promise.reject(deleteError),
+        clear: () => undefined,
+        deleteByPattern: () => undefined,
+    };
+
+    class UserService {
+        getUser() {
+            return 'business-value';
+        }
+
+        updateUser() {
+            return 'business-update';
+        }
+    }
+
+    decorateMethod(UserService.prototype, 'getUser', Cache('failure-fixture-users', { providerName: 'write' }));
+    decorateMethod(
+        UserService.prototype,
+        'updateUser',
+        CacheEvict('failure-fixture-users', { providerName: 'delete' })
+    );
+    CacheProviderRegistry.register('write', writeProvider);
+    CacheProviderRegistry.register('delete', deleteProvider);
+
+    try {
+        const service = new UserService();
+        assert.equal(await service.getUser(), 'business-value');
+        assert.equal(await service.updateUser(), 'business-update');
+        await new Promise((resolve) => setImmediate(resolve));
+    } finally {
+        CacheProviderRegistry.clear();
+    }
+}
+
+const currentFile = fileURLToPath(import.meta.url);
+if (currentFile === join(process.cwd(), 'test', 'fixtures', 'cache-provider-failure-child.mjs')) {
+    main().catch((error) => {
+        process.stderr.write(`${error instanceof Error ? error.stack : String(error)}\n`);
+        process.exitCode = 1;
+    });
+}

package/test/helpers/legacy-redis-cache.ts

@@ -1,22 +1,41 @@
-import Redis from 'ioredis';
-
-/**
- * 使用 0.1.3 的字符串/JSON 与秒级 TTL 协议写入兼容性数据。
- * @param client 由测试创建并持有的 ioredis 连接。
- * @param key 旧版本收到的原始缓存 key。
- * @param value 旧版本支持的字符串或 JSON 可序列化值。
- * @param ttl 可选的秒级 TTL；0 与 undefined 使用普通 SET。
- * @returns 旧版写入命令成功后完成。
- * @throws 无法序列化或 Redis 命令失败时传播错误。
- */
-export async function writeLegacyRedisCache(client: Redis, key: string, value: unknown, ttl?: number): Promise<void> {
-    const serialized = typeof value === 'string' ? value : JSON.stringify(value);
-    if (typeof serialized !== 'string') {
-        throw new TypeError('Legacy cache fixture value must serialize to a string');
-    }
-    if (ttl) {
-        await client.setex(key, ttl, serialized);
-        return;
-    }
-    await client.set(key, serialized);
-}
+import Redis from 'ioredis';
+
+/**
+ * 使用 0.1.3 的字符串/JSON 与秒级 TTL 协议写入兼容性数据。
+ * @param client 由测试创建并持有的 ioredis 连接。
+ * @param key 旧版本收到的原始缓存 key。
+ * @param value 旧版本支持的字符串或 JSON 可序列化值。
+ * @param ttl 可选的秒级 TTL；0 与 undefined 使用普通 SET。
+ * @returns 旧版写入命令成功后完成。
+ * @throws 无法序列化或 Redis 命令失败时传播错误。
+ */
+export async function writeLegacyRedisCache(client: Redis, key: string, value: unknown, ttl?: number): Promise<void> {
+    const serialized = typeof value === 'string' ? value : JSON.stringify(value);
+    if (typeof serialized !== 'string') {
+        throw new TypeError('Legacy cache fixture value must serialize to a string');
+    }
+    if (ttl) {
+        await client.setex(key, ttl, serialized);
+        return;
+    }
+    await client.set(key, serialized);
+}
+
+/**
+ * 使用旧版普通 JSON 读取规则恢复缓存值，不理解当前版本的异常 envelope。
+ * @param client 由测试创建并持有的 ioredis 连接。
+ * @param key 旧版本收到的原始缓存 key。
+ * @returns miss 时返回 undefined；合法 JSON 返回解析值，其余字符串保持原值。
+ * @throws Redis GET 命令失败时传播原始错误。
+ */
+export async function readLegacyRedisCache(client: Redis, key: string): Promise<unknown> {
+    const value = await client.get(key);
+    if (value === null) {
+        return undefined;
+    }
+    try {
+        return JSON.parse(value) as unknown;
+    } catch {
+        return value;
+    }
+}