A free and open source instant messaging and VoIP chat app built for friends, groups, and communities.
// SPDX-License-Identifier: AGPL-3.0-or-later
import {createAPIApp} from '@app/api/App';
import {resetAdminSsoCachesForTests} from '@app/api/admin/AdminSsoSignIn';
import {resetSsoProviderCachesForTests} from '@app/api/auth/services/SsoService';
import {Config} from '@app/api/Config';
import {resetApiServicesForTesting} from '@app/api/CreateApiContext';
import {
resetCassandraQueryExecutorForTesting,
setCassandraQueryExecutorForTesting,
} from '@app/api/database/CassandraQueryExecution';
import {resetGuildVisitorCachesForTesting} from '@app/api/guild/visits/GuildVisitorAccess';
import {resetSharedListsForTests} from '@app/api/infrastructure/activity/SharedLists';
import {SearchProvider} from '@app/api/infrastructure/SearchProvider';
import {ipBanCache} from '@app/api/middleware/IpBanMiddleware';
import {
setInjectedBlueskyOAuthService,
setInjectedGatewayService,
setInjectedKVProvider,
setInjectedMediaService,
setInjectedWorkerService,
} from '@app/api/middleware/ServiceRegistry';
import {
getInstanceConfigRepository,
setInjectedStorageService,
setInjectedUnfurlerService,
} from '@app/api/middleware/ServiceSingletons';
import {setInjectedSearchProvider} from '@app/api/SearchFactory';
import type {ISearchProvider} from '@app/api/search/ISearchProvider';
import {drainSearchTasks} from '@app/api/search/SearchTaskTracker';
import {InMemoryCassandraQueryExecutor} from '@app/api/test/InMemoryCassandraQueryExecutor';
import {MockBlueskyOAuthService} from '@app/api/test/mocks/MockBlueskyOAuthService';
import {MockStorageService} from '@app/api/test/mocks/MockStorageService';
import {NoopLogger} from '@app/api/test/mocks/NoopLogger';
import {NoopUnfurlerService} from '@app/api/test/mocks/NoopUnfurlerService';
import {NoopGatewayService} from '@app/api/test/NoopGatewayService';
import {NoopOperatorPassWallPublisher} from '@app/api/test/NoopOperatorPassWallPublisher';
import {NoopWorkerService} from '@app/api/test/NoopWorkerService';
import {resetServiceStateForTesting} from '@app/api/test/ResetServiceState';
import {InMemorySearchProvider} from '@app/api/test/search/InMemorySearchProvider';
import {TestMediaService} from '@app/api/test/TestMediaService';
import type {HonoApp} from '@app/api/types/HonoEnv';
import type {IKVProvider} from '@pkgs/kv_client/src/IKVProvider';
import {MockKVProvider} from '@pkgs/kv_client/src/testing/MockKVProvider';
export interface ApiTestHarness {
app: HonoApp;
kvProvider: IKVProvider;
storageService: MockStorageService;
reset: () => Promise<void>;
resetData: () => Promise<void>;
shutdown: () => Promise<void>;
requestJson: (params: {
path: string;
method?: string;
body?: unknown;
headers?: Record<string, string>;
}) => Promise<Response>;
}
interface CreateApiTestHarnessOptions {
search?: 'disabled' | 'enabled';
registerRoutes?: (routes: HonoApp) => void;
}
export async function createApiTestHarness(options: CreateApiTestHarnessOptions = {}): Promise<ApiTestHarness> {
resetApiServicesForTesting();
await clearBannedIpsState();
setCassandraQueryExecutorForTesting(new InMemoryCassandraQueryExecutor());
const kvProvider = new MockKVProvider();
setInjectedKVProvider(kvProvider);
setInjectedGatewayService(new NoopGatewayService());
setInjectedWorkerService(new NoopWorkerService());
const storageService = new MockStorageService();
setInjectedStorageService(storageService);
const mediaService = new TestMediaService(storageService);
setInjectedMediaService(mediaService);
const harnessLogger = new NoopLogger();
let searchProvider: ISearchProvider | null = null;
if (options.search === 'enabled') {
searchProvider = new InMemorySearchProvider();
await searchProvider.initialize();
} else {
searchProvider = new SearchProvider(null);
await searchProvider.initialize();
}
setInjectedSearchProvider(searchProvider);
setInjectedUnfurlerService(new NoopUnfurlerService());
setInjectedBlueskyOAuthService(new MockBlueskyOAuthService());
await resetServiceStateForTesting();
const {
app,
initialize: initializeApp,
shutdown: shutdownApp,
} = await createAPIApp({
config: Config,
logger: harnessLogger,
operatorPassWallPublisher: new NoopOperatorPassWallPublisher(),
registerRoutes: options.registerRoutes,
});
try {
await initializeApp();
} catch (error) {
console.error('Failed to initialize API app for tests:', error);
throw error;
}
async function reset(): Promise<void> {
resetGuildVisitorCachesForTesting();
resetApiServicesForTesting();
resetCassandraQueryExecutorForTesting();
getInstanceConfigRepository().clearCacheForTesting();
kvProvider.reset();
setInjectedUnfurlerService(undefined);
resetSharedListsForTests();
resetSsoProviderCachesForTests();
resetAdminSsoCachesForTests();
}
async function resetData(): Promise<void> {
resetGuildVisitorCachesForTesting();
resetApiServicesForTesting();
resetCassandraQueryExecutorForTesting();
getInstanceConfigRepository().clearCacheForTesting();
kvProvider.reset();
setInjectedUnfurlerService(undefined);
}
async function shutdown(): Promise<void> {
try {
await drainSearchTasks();
} catch (_error) {}
try {
await shutdownApp();
} catch (_error) {}
resetCassandraQueryExecutorForTesting();
getInstanceConfigRepository().clearCacheForTesting();
if (searchProvider) {
try {
await searchProvider.shutdown();
} catch (_error) {}
}
setInjectedWorkerService(new NoopWorkerService());
setInjectedGatewayService(new NoopGatewayService());
setInjectedKVProvider(new MockKVProvider());
setInjectedUnfurlerService(undefined);
resetSharedListsForTests();
const fallbackStorageService = new MockStorageService();
setInjectedStorageService(fallbackStorageService);
setInjectedMediaService(new TestMediaService(fallbackStorageService));
setInjectedSearchProvider(new SearchProvider(null));
setInjectedBlueskyOAuthService(new MockBlueskyOAuthService());
await resetServiceStateForTesting();
resetApiServicesForTesting();
}
async function requestJson(params: {
path: string;
method?: string;
body?: unknown;
headers?: Record<string, string>;
}): Promise<Response> {
const {path, body, method = 'GET', headers} = params;
const mergedHeaders = new Headers(headers);
if (!mergedHeaders.has('content-type')) {
mergedHeaders.set('content-type', 'application/json');
}
if (!mergedHeaders.has('x-forwarded-for')) {
mergedHeaders.set('x-forwarded-for', '127.0.0.1');
}
let requestBody: string | undefined;
if (body !== undefined) {
requestBody = typeof body === 'string' ? body : JSON.stringify(body);
}
return app.request(path, {
method,
headers: mergedHeaders,
body: requestBody,
});
}
return {
app,
kvProvider,
storageService,
reset,
resetData,
shutdown,
requestJson,
};
}
async function clearBannedIpsState(): Promise<void> {
ipBanCache.resetCaches();
resetSharedListsForTests();
}