pass services into caches through constructor

packages/backend/src/misc/QuantumKVCache.ts

@@ -3,10 +3,13 @@
  * SPDX-License-Identifier: AGPL-3.0-only
  */
 
-import { InternalEventService } from '@/core/InternalEventService.js';
 import { bindThis } from '@/decorators.js';
-import { InternalEventTypes } from '@/core/GlobalEventService.js';
-import { MemoryKVCache } from '@/misc/cache.js';
+import { InternalEventService } from '@/core/InternalEventService.js';
+import type { InternalEventTypes } from '@/core/GlobalEventService.js';
+import { MemoryKVCache, type MemoryCacheServices } from '@/misc/cache.js';
+import { makeKVPArray, type KVPArray } from '@/misc/kvp-array.js';
+import { renderInlineError } from '@/misc/render-inline-error.js';
+import { isRetryableSymbol } from '@/misc/is-retryable-error.js';
 
 export interface QuantumKVOpts<T> {
 	/**
@@ -35,6 +38,16 @@ export interface QuantumKVOpts<T> {
 	 * Implementations may be synchronous or async.
 	 */
 	onChanged?: (keys: string[], cache: QuantumKVCache<T>) => void | Promise<void>;
+
+	// TODO equality comparer
+}
+
+export interface QuantumCacheServices extends MemoryCacheServices {
+	/**
+	 * Event bus to attach to.
+	 * This can be mocked for easier testing under DI.
+	 */
+	readonly internalEventService: InternalEventService;
 }
 
 /**
@@ -42,7 +55,9 @@ export interface QuantumKVOpts<T> {
  * All nodes in the cluster are guaranteed to have a *subset* view of the current accurate state, though individual processes may have different items in their local cache.
  * This ensures that a call to get() will never return stale data.
  */
-export class QuantumKVCache<T> implements Iterable<[key: string, value: T]> {
+export class QuantumKVCache<T> implements Iterable<readonly [key: string, value: T]> {
+	private readonly internalEventService: InternalEventService;
+
 	private readonly memoryCache: MemoryKVCache<T>;
 
 	public readonly fetcher: QuantumKVOpts<T>['fetcher'];
@@ -50,20 +65,22 @@ export class QuantumKVCache<T> implements Iterable<[key: string, value: T]> {
 	public readonly onChanged: QuantumKVOpts<T>['onChanged'];
 
 	/**
-	 * @param internalEventService Service bus to synchronize events.
 	 * @param name Unique name of the cache - must be the same in all processes.
+	 * @param services DI services - internalEventService is required
 	 * @param opts Cache options
 	 */
 	constructor(
-		private readonly internalEventService: InternalEventService,
-		private readonly name: string,
+		// TODO validate to make sure this is unique
+		public readonly name: string,
+		services: QuantumCacheServices,
 		opts: QuantumKVOpts<T>,
 	) {
-		this.memoryCache = new MemoryKVCache(opts.lifetime);
+		this.memoryCache = new MemoryKVCache(opts.lifetime, services);
 		this.fetcher = opts.fetcher;
 		this.bulkFetcher = opts.bulkFetcher;
 		this.onChanged = opts.onChanged;
 
+		this.internalEventService = services.internalEventService;
 		this.internalEventService.on('quantumCacheUpdated', this.onQuantumCacheUpdated, {
 			// Ignore our own events, otherwise we'll immediately erase any set value.
 			ignoreLocal: true,

packages/backend/src/misc/cache.ts

@@ -5,8 +5,25 @@
 
 import * as Redis from 'ioredis';
 import { bindThis } from '@/decorators.js';
+import { TimeService, NativeTimeService } from '@/core/TimeService.js';
+
+// This matches the default DI implementation, but as a shared instance to avoid wasting memory.
+const defaultTimeService: TimeService = new NativeTimeService();
+
+export interface RedisCacheServices extends MemoryCacheServices {
+	readonly redisClient: Redis.Redis
+}
+
+export interface RedisKVCacheOpts<T> {
+	lifetime: number;
+	memoryCacheLifetime: number;
+	fetcher?: RedisKVCache<T>['fetcher'];
+	toRedisConverter?: RedisKVCache<T>['toRedisConverter'];
+	fromRedisConverter?: RedisKVCache<T>['fromRedisConverter'];
+}
 
 export class RedisKVCache<T> {
+	private readonly redisClient: Redis.Redis;
 	private readonly lifetime: number;
 	private readonly memoryCache: MemoryKVCache<T>;
 	public readonly fetcher: (key: string) => Promise<T>;
@@ -14,18 +31,13 @@ export class RedisKVCache<T> {
 	public readonly fromRedisConverter: (value: string) => T | undefined;
 
 	constructor(
-		private redisClient: Redis.Redis,
-		private name: string,
-		opts: {
-			lifetime: RedisKVCache<T>['lifetime'];
-			memoryCacheLifetime: number;
-			fetcher?: RedisKVCache<T>['fetcher'];
-			toRedisConverter?: RedisKVCache<T>['toRedisConverter'];
-			fromRedisConverter?: RedisKVCache<T>['fromRedisConverter'];
-		},
+		public name: string,
+		services: RedisCacheServices,
+		opts: RedisKVCacheOpts<T>,
 	) {
+		this.redisClient = services.redisClient;
 		this.lifetime = opts.lifetime;
-		this.memoryCache = new MemoryKVCache(opts.memoryCacheLifetime);
+		this.memoryCache = new MemoryKVCache(opts.memoryCacheLifetime, services);
 		this.fetcher = opts.fetcher ?? (() => { throw new Error('fetch not supported - use get/set directly'); });
 		this.toRedisConverter = opts.toRedisConverter ?? ((value) => JSON.stringify(value));
 		this.fromRedisConverter = opts.fromRedisConverter ?? ((value) => JSON.parse(value));
@@ -115,7 +127,16 @@ export class RedisKVCache<T> {
 	}
 }
 
+export interface RedisSingleCacheOpts<T> {
+	lifetime: number;
+	memoryCacheLifetime: number;
+	fetcher?: RedisSingleCache<T>['fetcher'];
+	toRedisConverter?: RedisSingleCache<T>['toRedisConverter'];
+	fromRedisConverter?: RedisSingleCache<T>['fromRedisConverter'];
+}
+
 export class RedisSingleCache<T> {
+	private readonly redisClient: Redis.Redis;
 	private readonly lifetime: number;
 	private readonly memoryCache: MemorySingleCache<T>;
 	public readonly fetcher: () => Promise<T>;
@@ -123,18 +144,13 @@ export class RedisSingleCache<T> {
 	public readonly fromRedisConverter: (value: string) => T | undefined;
 
 	constructor(
-		private redisClient: Redis.Redis,
-		private name: string,
-		opts: {
-			lifetime: number;
-			memoryCacheLifetime: number;
-			fetcher?: RedisSingleCache<T>['fetcher'];
-			toRedisConverter?: RedisSingleCache<T>['toRedisConverter'];
-			fromRedisConverter?: RedisSingleCache<T>['fromRedisConverter'];
-		},
+		public name: string,
+		services: RedisCacheServices,
+		opts: RedisSingleCacheOpts<T>,
 	) {
+		this.redisClient = services.redisClient;
 		this.lifetime = opts.lifetime;
-		this.memoryCache = new MemorySingleCache(opts.memoryCacheLifetime);
+		this.memoryCache = new MemorySingleCache(opts.memoryCacheLifetime, services);
 
 		this.fetcher = opts.fetcher ?? (() => { throw new Error('fetch not supported - use get/set directly'); });
 		this.toRedisConverter = opts.toRedisConverter ?? ((value) => JSON.stringify(value));
@@ -219,17 +235,25 @@ export class RedisSingleCache<T> {
 		this.clear();
 	}
 }
+
+export interface MemoryCacheServices {
+	readonly timeService?: TimeService;
 }
 
 // TODO: メモリ節約のためあまり参照されないキーを定期的に削除できるようにする？
 
 export class MemoryKVCache<T> {
 	private readonly cache = new Map<string, { date: number; value: T; }>();
-	private readonly gcIntervalHandle = setInterval(() => this.gc(), 1000 * 60 * 3); // 3m
+	private readonly gcIntervalHandle: symbol;
+	private readonly timeService: TimeService;
 
 	constructor(
 		private readonly lifetime: number,
-	) {}
+		services?: MemoryCacheServices,
+	) {
+		this.timeService = services?.timeService ?? defaultTimeService;
+		this.gcIntervalHandle = this.timeService.startTimer(() => this.gc(), 1000 * 60 * 3, { repeated: true }); // 3m
+	}
 
 	@bindThis
 	/**
@@ -238,7 +262,7 @@ export class MemoryKVCache<T> {
 	 */
 	public set(key: string, value: T): void {
 		this.cache.set(key, {
-			date: Date.now(),
+			date: this.timeService.now,
 			value,
 		});
 	}
@@ -247,7 +271,7 @@ export class MemoryKVCache<T> {
 	public get(key: string): T | undefined {
 		const cached = this.cache.get(key);
 		if (cached == null) return undefined;
-		if ((Date.now() - cached.date) > this.lifetime) {
+		if ((this.timeService.now - cached.date) > this.lifetime) {
 			this.cache.delete(key);
 			return undefined;
 		}
@@ -257,7 +281,7 @@ export class MemoryKVCache<T> {
 	public has(key: string): boolean {
 		const cached = this.cache.get(key);
 		if (cached == null) return false;
-		if ((Date.now() - cached.date) > this.lifetime) {
+		if ((this.timeService.now - cached.date) > this.lifetime) {
 			this.cache.delete(key);
 			return false;
 		}
@@ -323,7 +347,7 @@ export class MemoryKVCache<T> {
 
 	@bindThis
 	public gc(): void {
-		const now = Date.now();
+		const now = this.timeService.now;
 
 		for (const [key, { date }] of this.cache.entries()) {
 			// The map is ordered from oldest to youngest.
@@ -346,7 +370,7 @@ export class MemoryKVCache<T> {
 	@bindThis
 	public dispose(): void {
 		this.clear();
-		clearInterval(this.gcIntervalHandle);
+		this.timeService.stopTimer(this.gcIntervalHandle);
 	}
 
 	public get size() {
@@ -359,23 +383,27 @@ export class MemoryKVCache<T> {
 }
 
 export class MemorySingleCache<T> {
+	private readonly timeService: TimeService;
 	private cachedAt: number | null = null;
 	private value: T | undefined;
 
 	constructor(
 		private lifetime: number,
-	) {}
+		services?: MemoryCacheServices,
+	) {
+		this.timeService = services?.timeService ?? defaultTimeService;
+	}
 
 	@bindThis
 	public set(value: T): void {
-		this.cachedAt = Date.now();
+		this.cachedAt = this.timeService.now;
 		this.value = value;
 	}
 
 	@bindThis
 	public get(): T | undefined {
 		if (this.cachedAt == null) return undefined;
-		if ((Date.now() - this.cachedAt) > this.lifetime) {
+		if ((this.timeService.now - this.cachedAt) > this.lifetime) {
 			this.value = undefined;
 			this.cachedAt = null;
 			return undefined;