misty.cafe/mistykey
1
0
Fork 0
Code Issues Pull requests 1 Projects Releases Packages Wiki Activity Actions

prefer type-only imports in testing utilities

Browse source
This commit is contained in:
Hazelnoot 2025-11-09 00:51:34 -05:00
parent e7015d4f8e
commit b013649a41
8 changed files with 27 additions and 25 deletions
Download patch file Download diff file Expand all files Collapse all files

4
packages/backend/src/global/CacheManagementService.ts
View file

@ -3,8 +3,7 @@
* SPDX-License-Identifier: AGPL-3.0-only
*/
import { Inject, Injectable, OnApplicationShutdown } from '@nestjs/common';
import * as Redis from 'ioredis';
import { Inject, Injectable, type OnApplicationShutdown } from '@nestjs/common';
import {
MemoryKVCache,
MemorySingleCache,
@ -26,6 +25,7 @@ import { DI } from '@/di-symbols.js';
import { TimeService, type TimerHandle } from '@/global/TimeService.js';
import { InternalEventService } from '@/global/InternalEventService.js';
import { callAllOn } from '@/misc/call-all.js';
import type * as Redis from 'ioredis';
// This is the one place that's *supposed* to new() up caches.
/* eslint-disable no-restricted-syntax */

23
packages/backend/src/global/InternalEventService.ts
View file

@ -4,13 +4,14 @@
*/
import { Inject, Injectable, OnApplicationShutdown } from '@nestjs/common';
import Redis from 'ioredis';
import { DI } from '@/di-symbols.js';
import { bindThis } from '@/decorators.js';
import type { GlobalEvents, InternalEventTypes } from '@/core/GlobalEventService.js';
import type { Config } from '@/config.js';
import { bindThis } from '@/decorators.js';
import type Redis from 'ioredis';
export type Listener<K extends keyof InternalEventTypes> = (value: InternalEventTypes[K], key: K, isLocal: boolean) => void | Promise<void>;
export type EventTypes = InternalEventTypes;
export type Listener<K extends keyof EventTypes> = (value: EventTypes[K], key: K, isLocal: boolean) => void | Promise<void>;
export interface ListenerProps {
ignoreLocal?: boolean,
@ -19,7 +20,7 @@ export interface ListenerProps {
@Injectable()
export class InternalEventService implements OnApplicationShutdown {
private readonly listeners = new Map<keyof InternalEventTypes, Map<Listener<keyof InternalEventTypes>, ListenerProps>>();
private readonly listeners = new Map<keyof EventTypes, Map<Listener<keyof EventTypes>, ListenerProps>>();
constructor(
@Inject(DI.redisForSub)
@ -35,7 +36,7 @@ export class InternalEventService implements OnApplicationShutdown {
}
@bindThis
public on<K extends keyof InternalEventTypes>(type: K, listener: Listener<K>, props?: ListenerProps): void {
public on<K extends keyof EventTypes>(type: K, listener: Listener<K>, props?: ListenerProps): void {
let set = this.listeners.get(type);
if (!set) {
set = new Map();
@ -43,16 +44,16 @@ export class InternalEventService implements OnApplicationShutdown {
}
// Functionally, this is just a set with metadata on the values.
set.set(listener as Listener<keyof InternalEventTypes>, props ?? {});
set.set(listener as Listener<keyof EventTypes>, props ?? {});
}
@bindThis
public off<K extends keyof InternalEventTypes>(type: K, listener: Listener<K>): void {
this.listeners.get(type)?.delete(listener as Listener<keyof InternalEventTypes>);
public off<K extends keyof EventTypes>(type: K, listener: Listener<K>): void {
this.listeners.get(type)?.delete(listener as Listener<keyof EventTypes>);
}
@bindThis
public async emit<K extends keyof InternalEventTypes>(type: K, value: InternalEventTypes[K]): Promise<void> {
public async emit<K extends keyof EventTypes>(type: K, value: EventTypes[K]): Promise<void> {
await this.emitInternal(type, value, true);
await this.redisForPub.publish(this.config.host, JSON.stringify({
channel: 'internal',
@ -61,7 +62,7 @@ export class InternalEventService implements OnApplicationShutdown {
}
@bindThis
private async emitInternal<K extends keyof InternalEventTypes>(type: K, value: InternalEventTypes[K], isLocal: boolean): Promise<void> {
private async emitInternal<K extends keyof EventTypes>(type: K, value: EventTypes[K], isLocal: boolean): Promise<void> {
const listeners = this.listeners.get(type);
if (!listeners) {
return;
@ -84,7 +85,7 @@ export class InternalEventService implements OnApplicationShutdown {
if (obj.channel === 'internal') {
const { type, body } = obj.message as GlobalEvents['internal']['payload'];
if (!isLocalInternalEvent(body) || body._pid !== process.pid) {
await this.emitInternal(type, body as InternalEventTypes[keyof InternalEventTypes], false);
await this.emitInternal(type, body as EventTypes[keyof EventTypes], false);
}
}
}

2
packages/backend/src/global/TimeService.ts
View file

@ -3,7 +3,7 @@
* SPDX-License-Identifier: AGPL-3.0-only
*/
import { Injectable, OnApplicationShutdown } from '@nestjs/common';
import { Injectable, type OnApplicationShutdown } from '@nestjs/common';
import { bindThis } from '@/decorators.js';
const timerTokenSymbol = Symbol('timerToken');

4
packages/backend/src/misc/cache.ts
View file

@ -3,9 +3,9 @@
* SPDX-License-Identifier: AGPL-3.0-only
*/
import * as Redis from 'ioredis';
import type * as Redis from 'ioredis';
import { bindThis } from '@/decorators.js';
import { TimeService } from '@/global/TimeService.js';
import type { TimeService } from '@/global/TimeService.js';
export interface RedisCacheServices extends MemoryCacheServices {
readonly redisClient: Redis.Redis

2
packages/backend/test/misc/FakeCacheManagementService.ts
View file

@ -3,11 +3,11 @@
* SPDX-License-Identifier: AGPL-3.0-only
*/
import * as Redis from 'ioredis';
import { Injectable } from '@nestjs/common';
import { GodOfTimeService } from './GodOfTimeService.js';
import { MockInternalEventService } from './MockInternalEventService.js';
import { MockRedis } from './MockRedis.js';
import type * as Redis from 'ioredis';
import type { QuantumKVOpts } from '@/misc/QuantumKVCache.js';
import type { RedisKVCacheOpts, RedisSingleCacheOpts, MemoryCacheOpts } from '@/misc/cache.js';
import type { TimeService } from '@/global/TimeService.js';

13
packages/backend/test/misc/FakeRedis.ts
View file

@ -3,7 +3,8 @@
* SPDX-License-Identifier: AGPL-3.0-only
*/
import * as Redis from 'ioredis';
import { Redis as RedisConstructor } from 'ioredis';
import type * as Redis from 'ioredis';
export type RedisKey = Redis.RedisKey;
export type RedisString = Buffer | string;
@ -14,7 +15,7 @@ export type RedisCallback<T = unknown> = Redis.Callback<T>;
export type Ok = 'OK';
export const ok = 'OK' as const;
export type FakeRedis = Redis.Redis;
export type FakeRedis = RedisConstructor;
export interface FakeRedisConstructor {
new (): FakeRedis;
}
@ -25,7 +26,7 @@ export interface FakeRedisConstructor {
export const FakeRedis: FakeRedisConstructor = createFakeRedis();
function createFakeRedis(): FakeRedisConstructor {
class FakeRedis implements Partial<Redis.Redis> {
class FakeRedis implements Partial<RedisConstructor> {
async connect(callback?: RedisCallback<void>): Promise<void> {
// no-op
callback?.(null);
@ -71,8 +72,8 @@ function createFakeRedis(): FakeRedisConstructor {
}
}
const fakeProto = FakeRedis.prototype as Partial<Redis.Redis>;
const redisProto = Redis.Redis.prototype as Partial<Redis.Redis>;
const fakeProto = FakeRedis.prototype as Partial<RedisConstructor>;
const redisProto = RedisConstructor.prototype as Partial<RedisConstructor>;
// Override all methods and accessors from Redis
for (const [key, property] of allProps(redisProto)) {
@ -102,7 +103,7 @@ function createFakeRedis(): FakeRedisConstructor {
// test
const test = new FakeRedis();
if (!(test instanceof Redis.Redis)) {
if (!(test instanceof RedisConstructor)) {
throw new Error('failed to extend');
}

2
packages/backend/test/misc/GodOfTimeService.ts
View file

@ -4,7 +4,7 @@
*/
import { Injectable } from '@nestjs/common';
import { TimeService, Timer } from '@/global/TimeService.js';
import { TimeService, type Timer } from '@/global/TimeService.js';
import { addPatch, type DatePatch } from '@/misc/patch-date.js';
/**

2
packages/backend/test/misc/MockRedis.ts
View file

@ -7,7 +7,7 @@ import { Injectable } from '@nestjs/common';
import { FakeRedis, ok, type RedisString } from './FakeRedis.js';
import type { RedisKey, RedisNumber, RedisValue, RedisCallback, Ok } from './FakeRedis.js';
import type { ChainableCommander } from 'ioredis';
import { TimeService, NativeTimeService } from '@/global/TimeService.js';
import { NativeTimeService, type TimeService } from '@/global/TimeService.js';
import { bindThis } from '@/decorators.js';
export interface MockRedisConstructor {