summaryrefslogtreecommitdiff
path: root/packages/backend/src/misc
diff options
context:
space:
mode:
authordakkar <dakkar@thenautilus.net>2024-08-06 17:51:51 +0100
committerdakkar <dakkar@thenautilus.net>2024-08-06 17:51:51 +0100
commit94dceb9e15474f85d94b7ea89a5e2197d4f9b6fc (patch)
tree6bb6da6dea6e802a5c5106a90564e11b01a31ddd /packages/backend/src/misc
parentappease the linter (diff)
parentmerge: Remove infinite caches to prevent memory leak (!587) (diff)
downloadsharkey-94dceb9e15474f85d94b7ea89a5e2197d4f9b6fc.tar.gz
sharkey-94dceb9e15474f85d94b7ea89a5e2197d4f9b6fc.tar.bz2
sharkey-94dceb9e15474f85d94b7ea89a5e2197d4f9b6fc.zip
Merge branch 'develop' into feature/misskey-2024.07
Diffstat (limited to 'packages/backend/src/misc')
-rw-r--r--packages/backend/src/misc/cache.ts129
1 files changed, 69 insertions, 60 deletions
diff --git a/packages/backend/src/misc/cache.ts b/packages/backend/src/misc/cache.ts
index bba64a06ef..d968069ca3 100644
--- a/packages/backend/src/misc/cache.ts
+++ b/packages/backend/src/misc/cache.ts
@@ -7,23 +7,23 @@ import * as Redis from 'ioredis';
import { bindThis } from '@/decorators.js';
export class RedisKVCache<T> {
- private redisClient: Redis.Redis;
- private name: string;
- private lifetime: number;
- private memoryCache: MemoryKVCache<T>;
- private fetcher: (key: string) => Promise<T>;
- private toRedisConverter: (value: T) => string;
- private fromRedisConverter: (value: string) => T | undefined;
+ private readonly lifetime: number;
+ private readonly memoryCache: MemoryKVCache<T>;
+ private readonly fetcher: (key: string) => Promise<T>;
+ private readonly toRedisConverter: (value: T) => string;
+ private readonly fromRedisConverter: (value: string) => T | undefined;
- constructor(redisClient: RedisKVCache<T>['redisClient'], name: RedisKVCache<T>['name'], opts: {
- lifetime: RedisKVCache<T>['lifetime'];
- memoryCacheLifetime: number;
- fetcher: RedisKVCache<T>['fetcher'];
- toRedisConverter: RedisKVCache<T>['toRedisConverter'];
- fromRedisConverter: RedisKVCache<T>['fromRedisConverter'];
- }) {
- this.redisClient = redisClient;
- this.name = name;
+ 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'];
+ },
+ ) {
this.lifetime = opts.lifetime;
this.memoryCache = new MemoryKVCache(opts.memoryCacheLifetime);
this.fetcher = opts.fetcher;
@@ -55,7 +55,13 @@ export class RedisKVCache<T> {
const cached = await this.redisClient.get(`kvcache:${this.name}:${key}`);
if (cached == null) return undefined;
- return this.fromRedisConverter(cached);
+
+ const value = this.fromRedisConverter(cached);
+ if (value !== undefined) {
+ this.memoryCache.set(key, value);
+ }
+
+ return value;
}
@bindThis
@@ -77,14 +83,14 @@ export class RedisKVCache<T> {
// Cache MISS
const value = await this.fetcher(key);
- this.set(key, value);
+ await this.set(key, value);
return value;
}
@bindThis
public async refresh(key: string) {
const value = await this.fetcher(key);
- this.set(key, value);
+ await this.set(key, value);
// TODO: イベント発行して他プロセスのメモリキャッシュも更新できるようにする
}
@@ -101,23 +107,23 @@ export class RedisKVCache<T> {
}
export class RedisSingleCache<T> {
- private redisClient: Redis.Redis;
- private name: string;
- private lifetime: number;
- private memoryCache: MemorySingleCache<T>;
- private fetcher: () => Promise<T>;
- private toRedisConverter: (value: T) => string;
- private fromRedisConverter: (value: string) => T | undefined;
+ private readonly lifetime: number;
+ private readonly memoryCache: MemorySingleCache<T>;
+ private readonly fetcher: () => Promise<T>;
+ private readonly toRedisConverter: (value: T) => string;
+ private readonly fromRedisConverter: (value: string) => T | undefined;
- constructor(redisClient: RedisSingleCache<T>['redisClient'], name: RedisSingleCache<T>['name'], opts: {
- lifetime: RedisSingleCache<T>['lifetime'];
- memoryCacheLifetime: number;
- fetcher: RedisSingleCache<T>['fetcher'];
- toRedisConverter: RedisSingleCache<T>['toRedisConverter'];
- fromRedisConverter: RedisSingleCache<T>['fromRedisConverter'];
- }) {
- this.redisClient = redisClient;
- this.name = name;
+ 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'];
+ },
+ ) {
this.lifetime = opts.lifetime;
this.memoryCache = new MemorySingleCache(opts.memoryCacheLifetime);
this.fetcher = opts.fetcher;
@@ -149,7 +155,13 @@ export class RedisSingleCache<T> {
const cached = await this.redisClient.get(`singlecache:${this.name}`);
if (cached == null) return undefined;
- return this.fromRedisConverter(cached);
+
+ const value = this.fromRedisConverter(cached);
+ if (value !== undefined) {
+ this.memoryCache.set(value);
+ }
+
+ return value;
}
@bindThis
@@ -171,14 +183,14 @@ export class RedisSingleCache<T> {
// Cache MISS
const value = await this.fetcher();
- this.set(value);
+ await this.set(value);
return value;
}
@bindThis
public async refresh() {
const value = await this.fetcher();
- this.set(value);
+ await this.set(value);
// TODO: イベント発行して他プロセスのメモリキャッシュも更新できるようにする
}
@@ -187,22 +199,12 @@ export class RedisSingleCache<T> {
// TODO: メモリ節約のためあまり参照されないキーを定期的に削除できるようにする?
export class MemoryKVCache<T> {
- /**
- * データを持つマップ
- * @deprecated これを直接操作するべきではない
- */
- public cache: Map<string, { date: number; value: T; }>;
- private lifetime: number;
- private gcIntervalHandle: NodeJS.Timeout;
+ private readonly cache = new Map<string, { date: number; value: T; }>();
+ private readonly gcIntervalHandle = setInterval(() => this.gc(), 1000 * 60 * 3); // 3m
- constructor(lifetime: MemoryKVCache<never>['lifetime']) {
- this.cache = new Map();
- this.lifetime = lifetime;
-
- this.gcIntervalHandle = setInterval(() => {
- this.gc();
- }, 1000 * 60 * 3);
- }
+ constructor(
+ private readonly lifetime: number,
+ ) {}
@bindThis
/**
@@ -287,10 +289,14 @@ export class MemoryKVCache<T> {
@bindThis
public gc(): void {
const now = Date.now();
+
for (const [key, { date }] of this.cache.entries()) {
- if ((now - date) > this.lifetime) {
- this.cache.delete(key);
- }
+ // The map is ordered from oldest to youngest.
+ // We can stop once we find an entry that's still active, because all following entries must *also* be active.
+ const age = now - date;
+ if (age < this.lifetime) break;
+
+ this.cache.delete(key);
}
}
@@ -298,16 +304,19 @@ export class MemoryKVCache<T> {
public dispose(): void {
clearInterval(this.gcIntervalHandle);
}
+
+ public get entries() {
+ return this.cache.entries();
+ }
}
export class MemorySingleCache<T> {
private cachedAt: number | null = null;
private value: T | undefined;
- private lifetime: number;
- constructor(lifetime: MemorySingleCache<never>['lifetime']) {
- this.lifetime = lifetime;
- }
+ constructor(
+ private lifetime: number,
+ ) {}
@bindThis
public set(value: T): void {