/* eslint-disable @typescript-eslint/no-explicit-any */ import { expect } from '@jest/globals'; import { ChildProcess, spawn } from 'child_process'; import { Express } from 'express'; import ms, { StringValue } from 'ms'; import request, { Response } from 'supertest'; import { container } from '../../src/config/index.js'; import INTERNAL_CONFIG from '../../src/config/internal-config.js'; import { LIVEKIT_API_KEY, LIVEKIT_API_SECRET, MEET_INITIAL_ADMIN_PASSWORD, MEET_INITIAL_ADMIN_USER, MEET_INITIAL_API_KEY } from '../../src/environment.js'; import { createApp, registerDependencies } from '../../src/server.js'; import { RecordingService, RoomService } from '../../src/services/index.js'; import { AuthMode, AuthType, MeetRecordingAccess, MeetRecordingInfo, MeetRecordingStatus, MeetRoom, MeetRoomDeletionPolicyWithMeeting, MeetRoomDeletionPolicyWithRecordings, MeetRoomOptions, ParticipantRole, WebhookConfig } from '../../src/typings/ce/index.js'; const CREDENTIALS = { admin: { username: MEET_INITIAL_ADMIN_USER, password: MEET_INITIAL_ADMIN_PASSWORD } }; let app: Express; const fakeParticipantsProcesses = new Map(); export const sleep = (time: StringValue) => { return new Promise((resolve) => setTimeout(resolve, ms(time))); }; export const startTestServer = (): Express => { if (app) { return app; } registerDependencies(); app = createApp(); return app; }; export const generateApiKey = async (): Promise => { checkAppIsRunning(); const adminCookie = await loginUser(); const response = await request(app) .post(`${INTERNAL_CONFIG.INTERNAL_API_BASE_PATH_V1}/auth/api-keys`) .set('Cookie', adminCookie) .send(); expect(response.status).toBe(201); expect(response.body).toHaveProperty('key'); return response.body.key; }; export const getApiKeys = async () => { checkAppIsRunning(); const adminCookie = await loginUser(); const response = await request(app) .get(`${INTERNAL_CONFIG.INTERNAL_API_BASE_PATH_V1}/auth/api-keys`) .set('Cookie', adminCookie) .send(); return response; }; export const getRoomsAppearanceConfig = async () => { checkAppIsRunning(); const response = await request(app) .get(`${INTERNAL_CONFIG.INTERNAL_API_BASE_PATH_V1}/config/rooms/appearance`) .send(); return response; }; export const updateRoomsAppearanceConfig = async (config: any) => { checkAppIsRunning(); const adminCookie = await loginUser(); const response = await request(app) .put(`${INTERNAL_CONFIG.INTERNAL_API_BASE_PATH_V1}/config/rooms/appearance`) .set('Cookie', adminCookie) .send(config); return response; }; export const getWebbhookConfig = async () => { checkAppIsRunning(); const adminCookie = await loginUser(); const response = await request(app) .get(`${INTERNAL_CONFIG.INTERNAL_API_BASE_PATH_V1}/config/webhooks`) .set('Cookie', adminCookie) .send(); return response; }; export const updateWebbhookConfig = async (config: WebhookConfig) => { checkAppIsRunning(); const adminCookie = await loginUser(); const response = await request(app) .put(`${INTERNAL_CONFIG.INTERNAL_API_BASE_PATH_V1}/config/webhooks`) .set('Cookie', adminCookie) .send(config); return response; }; export const testWebhookUrl = async (url: string) => { checkAppIsRunning(); const response = await request(app) .post(`${INTERNAL_CONFIG.INTERNAL_API_BASE_PATH_V1}/config/webhooks/test`) .send({ url }); return response; }; export const getSecurityConfig = async () => { checkAppIsRunning(); const adminCookie = await loginUser(); const response = await request(app) .get(`${INTERNAL_CONFIG.INTERNAL_API_BASE_PATH_V1}/config/security`) .set('Cookie', adminCookie) .send(); return response; }; export const updateSecurityConfig = async (config: any) => { checkAppIsRunning(); const adminCookie = await loginUser(); const response = await request(app) .put(`${INTERNAL_CONFIG.INTERNAL_API_BASE_PATH_V1}/config/security`) .set('Cookie', adminCookie) .send(config); return response; }; export const changeSecurityConfig = async (authMode: AuthMode) => { const response = await updateSecurityConfig({ authentication: { authMethod: { type: AuthType.SINGLE_USER }, authModeToAccessRoom: authMode } }); expect(response.status).toBe(200); }; /** * Logs in a user and returns the access token cookie */ export const loginUser = async (): Promise => { checkAppIsRunning(); const response = await request(app) .post(`${INTERNAL_CONFIG.INTERNAL_API_BASE_PATH_V1}/auth/login`) .send(CREDENTIALS.admin) .expect(200); const cookies = response.headers['set-cookie'] as unknown as string[]; const accessTokenCookie = cookies.find((cookie) => cookie.startsWith(`${INTERNAL_CONFIG.ACCESS_TOKEN_COOKIE_NAME}=`) ) as string; return accessTokenCookie; }; export const getProfile = async (cookie: string) => { checkAppIsRunning(); return await request(app) .get(`${INTERNAL_CONFIG.INTERNAL_API_BASE_PATH_V1}/users/profile`) .set('Cookie', cookie) .send(); }; export const changePassword = async (currentPassword: string, newPassword: string, cookie: string) => { checkAppIsRunning(); return await request(app) .post(`${INTERNAL_CONFIG.INTERNAL_API_BASE_PATH_V1}/users/change-password`) .set('Cookie', cookie) .send({ currentPassword, newPassword }); }; export const createRoom = async (options: MeetRoomOptions = {}): Promise => { checkAppIsRunning(); const response = await request(app) .post(`${INTERNAL_CONFIG.API_BASE_PATH_V1}/rooms`) .set(INTERNAL_CONFIG.API_KEY_HEADER, MEET_INITIAL_API_KEY) .send(options) .expect(201); return response.body; }; export const getRooms = async (query: Record = {}) => { checkAppIsRunning(); return await request(app) .get(`${INTERNAL_CONFIG.API_BASE_PATH_V1}/rooms`) .set(INTERNAL_CONFIG.API_KEY_HEADER, MEET_INITIAL_API_KEY) .query(query); }; /** * Retrieves information about a specific room from the API. * * @param roomId - The unique identifier of the room to retrieve * @param fields - Optional fields to filter in the response * @returns A Promise that resolves to the room data * @throws Error if the app instance is not defined */ export const getRoom = async (roomId: string, fields?: string, cookie?: string, role?: ParticipantRole) => { checkAppIsRunning(); const req = request(app).get(`${INTERNAL_CONFIG.API_BASE_PATH_V1}/rooms/${roomId}`).query({ fields }); if (cookie && role) { req.set('Cookie', cookie).set(INTERNAL_CONFIG.PARTICIPANT_ROLE_HEADER, role); } else { req.set(INTERNAL_CONFIG.API_KEY_HEADER, MEET_INITIAL_API_KEY); } return await req; }; export const getRoomConfig = async (roomId: string) => { checkAppIsRunning(); return await request(app) .get(`${INTERNAL_CONFIG.API_BASE_PATH_V1}/rooms/${roomId}/config`) .set(INTERNAL_CONFIG.API_KEY_HEADER, MEET_INITIAL_API_KEY) .send(); }; export const updateRoomConfig = async (roomId: string, config: any) => { checkAppIsRunning(); return await request(app) .put(`${INTERNAL_CONFIG.API_BASE_PATH_V1}/rooms/${roomId}/config`) .set(INTERNAL_CONFIG.API_KEY_HEADER, MEET_INITIAL_API_KEY) .send({ config }); }; export const updateRecordingAccessConfigInRoom = async (roomId: string, recordingAccess: MeetRecordingAccess) => { const response = await updateRoomConfig(roomId, { recording: { enabled: true, allowAccessTo: recordingAccess }, chat: { enabled: true }, virtualBackground: { enabled: true } }); expect(response.status).toBe(200); }; export const updateRoomStatus = async (roomId: string, status: string) => { checkAppIsRunning(); return await request(app) .put(`${INTERNAL_CONFIG.API_BASE_PATH_V1}/rooms/${roomId}/status`) .set(INTERNAL_CONFIG.API_KEY_HEADER, MEET_INITIAL_API_KEY) .send({ status }); }; export const deleteRoom = async (roomId: string, query: Record = {}) => { checkAppIsRunning(); const result = await request(app) .delete(`${INTERNAL_CONFIG.API_BASE_PATH_V1}/rooms/${roomId}`) .set(INTERNAL_CONFIG.API_KEY_HEADER, MEET_INITIAL_API_KEY) .query(query); await sleep('1s'); return result; }; export const bulkDeleteRooms = async (roomIds: any[], withMeeting?: string, withRecordings?: string) => { checkAppIsRunning(); const result = await request(app) .delete(`${INTERNAL_CONFIG.API_BASE_PATH_V1}/rooms`) .set(INTERNAL_CONFIG.API_KEY_HEADER, MEET_INITIAL_API_KEY) .query({ roomIds: roomIds.join(','), withMeeting, withRecordings }); await sleep('1s'); return result; }; export const deleteAllRooms = async () => { checkAppIsRunning(); let nextPageToken: string | undefined; do { const response = await getRooms({ fields: 'roomId', maxItems: 100, nextPageToken }); expect(response.status).toBe(200); nextPageToken = response.body.pagination?.nextPageToken ?? undefined; const roomIds = response.body.rooms.map((room: { roomId: string }) => room.roomId); if (roomIds.length === 0) { break; } await bulkDeleteRooms( roomIds, MeetRoomDeletionPolicyWithMeeting.FORCE, MeetRoomDeletionPolicyWithRecordings.FORCE ); } while (nextPageToken); }; /** * Runs the room garbage collector to delete expired rooms. * * This function retrieves the RoomService from the dependency injection container * and calls its deleteExpiredRooms method to clean up expired rooms. * It then waits for 1 second before completing. */ export const runRoomGarbageCollector = async () => { checkAppIsRunning(); const roomService = container.get(RoomService); await (roomService as any)['deleteExpiredRooms'](); await sleep('1s'); }; export const runReleaseActiveRecordingLock = async (roomId: string) => { checkAppIsRunning(); const recordingService = container.get(RecordingService); await recordingService.releaseRecordingLockIfNoEgress(roomId); }; export const getRoomRoles = async (roomId: string) => { checkAppIsRunning(); const response = await request(app) .get(`${INTERNAL_CONFIG.INTERNAL_API_BASE_PATH_V1}/rooms/${roomId}/roles`) .send(); return response; }; export const getRoomRoleBySecret = async (roomId: string, secret: string) => { checkAppIsRunning(); const response = await request(app) .get(`${INTERNAL_CONFIG.INTERNAL_API_BASE_PATH_V1}/rooms/${roomId}/roles/${secret}`) .send(); return response; }; export const generateParticipantToken = async (participantOptions: any, cookie?: string) => { checkAppIsRunning(); // Disable authentication to generate the token await changeSecurityConfig(AuthMode.NONE); // Generate the participant token const response = await request(app) .post(`${INTERNAL_CONFIG.INTERNAL_API_BASE_PATH_V1}/participants/token`) .set('Cookie', cookie || '') .send(participantOptions); return response; }; /** * Generates a participant token for a room and returns the cookie containing the token */ export const generateParticipantTokenCookie = async ( roomId: string, secret: string, participantName: string, cookie?: string ): Promise => { // Generate the participant token const response = await generateParticipantToken( { roomId, secret, participantName }, cookie ); expect(response.status).toBe(200); // Return the participant token cookie const cookies = response.headers['set-cookie'] as unknown as string[]; const participantTokenCookie = cookies.find((cookie) => cookie.startsWith(`${INTERNAL_CONFIG.PARTICIPANT_TOKEN_COOKIE_NAME}=`) ) as string; return participantTokenCookie; }; export const refreshParticipantToken = async (participantOptions: any, cookie: string) => { checkAppIsRunning(); // Disable authentication to generate the token await changeSecurityConfig(AuthMode.NONE); const response = await request(app) .post(`${INTERNAL_CONFIG.INTERNAL_API_BASE_PATH_V1}/participants/token/refresh`) .set('Cookie', cookie) .send(participantOptions); return response; }; /** * Adds a fake participant to a LiveKit room for testing purposes. * * @param roomId The ID of the room to join * @param participantIdentity The identity for the fake participant */ export const joinFakeParticipant = async (roomId: string, participantIdentity: string) => { const process = spawn('lk', [ 'room', 'join', '--identity', participantIdentity, '--publish-demo', roomId, '--api-key', LIVEKIT_API_KEY, '--api-secret', LIVEKIT_API_SECRET ]); // Store the process to be able to terminate it later fakeParticipantsProcesses.set(`${roomId}-${participantIdentity}`, process); await sleep('1s'); }; /** * Updates the metadata for a participant in a LiveKit room. * * @param roomId The ID of the room * @param participantIdentity The identity of the participant * @param metadata The metadata to update */ export const updateParticipantMetadata = async (roomId: string, participantIdentity: string, metadata: any) => { await ensureLivekitCliInstalled(); spawn('lk', [ 'room', 'participants', 'update', '--room', roomId, '--identity', participantIdentity, '--metadata', JSON.stringify(metadata), '--api-key', LIVEKIT_API_KEY, '--api-secret', LIVEKIT_API_SECRET ]); await sleep('1s'); }; /** * Verifies that the LiveKit CLI tool 'lk' is installed and accessible * @throws Error if 'lk' command is not found */ const ensureLivekitCliInstalled = async (): Promise => { return new Promise((resolve, reject) => { const checkProcess = spawn('lk', ['--version'], { stdio: 'pipe' }); let hasResolved = false; const resolveOnce = (success: boolean, message?: string) => { if (hasResolved) return; hasResolved = true; if (success) { resolve(); } else { reject(new Error(message || 'LiveKit CLI check failed')); } }; checkProcess.on('error', (error) => { if (error.message.includes('ENOENT')) { resolveOnce(false, '❌ LiveKit CLI tool "lk" is not installed or not in PATH.'); } else { resolveOnce(false, `Failed to check LiveKit CLI: ${error.message}`); } }); checkProcess.on('exit', (code) => { if (code === 0) { resolveOnce(true); } else { resolveOnce(false, `LiveKit CLI exited with code ${code}`); } }); // Timeout after 5 seconds setTimeout(() => { checkProcess.kill(); resolveOnce(false, 'LiveKit CLI check timed out'); }, 5000); }); }; export const disconnectFakeParticipants = async () => { fakeParticipantsProcesses.forEach((process, participant) => { process.kill(); console.log(`Stopped process for participant '${participant}'`); }); fakeParticipantsProcesses.clear(); await sleep('1s'); }; export const updateParticipant = async ( roomId: string, participantIdentity: string, newRole: ParticipantRole, moderatorCookie: string ) => { checkAppIsRunning(); const response = await request(app) .put(`${INTERNAL_CONFIG.INTERNAL_API_BASE_PATH_V1}/meetings/${roomId}/participants/${participantIdentity}/role`) .set('Cookie', moderatorCookie) .set(INTERNAL_CONFIG.PARTICIPANT_ROLE_HEADER, ParticipantRole.MODERATOR) .send({ role: newRole }); return response; }; export const kickParticipant = async (roomId: string, participantIdentity: string, moderatorCookie: string) => { checkAppIsRunning(); const response = await request(app) .delete(`${INTERNAL_CONFIG.INTERNAL_API_BASE_PATH_V1}/meetings/${roomId}/participants/${participantIdentity}`) .set('Cookie', moderatorCookie) .set(INTERNAL_CONFIG.PARTICIPANT_ROLE_HEADER, ParticipantRole.MODERATOR) .send(); return response; }; export const endMeeting = async (roomId: string, moderatorCookie: string) => { checkAppIsRunning(); const response = await request(app) .delete(`${INTERNAL_CONFIG.INTERNAL_API_BASE_PATH_V1}/meetings/${roomId}`) .set('Cookie', moderatorCookie) .set(INTERNAL_CONFIG.PARTICIPANT_ROLE_HEADER, ParticipantRole.MODERATOR) .send(); await sleep('1s'); return response; }; export const generateRecordingToken = async (roomId: string, secret: string) => { checkAppIsRunning(); // Disable authentication to generate the token await changeSecurityConfig(AuthMode.NONE); const response = await request(app) .post(`${INTERNAL_CONFIG.INTERNAL_API_BASE_PATH_V1}/rooms/${roomId}/recording-token`) .send({ secret }); return response; }; /** * Generates a token for retrieving/deleting recordings from a room and returns the cookie containing the token */ export const generateRecordingTokenCookie = async (roomId: string, secret: string) => { // Generate the recording token const response = await generateRecordingToken(roomId, secret); expect(response.status).toBe(200); // Return the recording token cookie const cookies = response.headers['set-cookie'] as unknown as string[]; const recordingTokenCookie = cookies.find((cookie) => cookie.startsWith(`${INTERNAL_CONFIG.RECORDING_TOKEN_COOKIE_NAME}=`) ) as string; return recordingTokenCookie; }; export const startRecording = async (roomId: string, moderatorCookie = '') => { checkAppIsRunning(); return await request(app) .post(`${INTERNAL_CONFIG.INTERNAL_API_BASE_PATH_V1}/recordings`) .set('Cookie', moderatorCookie) .set(INTERNAL_CONFIG.PARTICIPANT_ROLE_HEADER, ParticipantRole.MODERATOR) .send({ roomId }); }; export const stopRecording = async (recordingId: string, moderatorCookie = '') => { checkAppIsRunning(); const response = await request(app) .post(`${INTERNAL_CONFIG.INTERNAL_API_BASE_PATH_V1}/recordings/${recordingId}/stop`) .set('Cookie', moderatorCookie) .set(INTERNAL_CONFIG.PARTICIPANT_ROLE_HEADER, ParticipantRole.MODERATOR) .send(); await sleep('2.5s'); return response; }; export const getRecording = async (recordingId: string) => { checkAppIsRunning(); return await request(app) .get(`${INTERNAL_CONFIG.API_BASE_PATH_V1}/recordings/${recordingId}`) .set(INTERNAL_CONFIG.API_KEY_HEADER, MEET_INITIAL_API_KEY); }; export const getRecordingMedia = async (recordingId: string, range?: string) => { checkAppIsRunning(); const req = request(app) .get(`${INTERNAL_CONFIG.API_BASE_PATH_V1}/recordings/${recordingId}/media`) .set(INTERNAL_CONFIG.API_KEY_HEADER, MEET_INITIAL_API_KEY); if (range) { req.set('range', range); } return await req; }; export const getRecordingUrl = async (recordingId: string, privateAccess = false) => { checkAppIsRunning(); return await request(app) .get(`${INTERNAL_CONFIG.API_BASE_PATH_V1}/recordings/${recordingId}/url`) .query({ privateAccess }) .set(INTERNAL_CONFIG.API_KEY_HEADER, MEET_INITIAL_API_KEY); }; export const deleteRecording = async (recordingId: string) => { checkAppIsRunning(); return await request(app) .delete(`${INTERNAL_CONFIG.API_BASE_PATH_V1}/recordings/${recordingId}`) .set(INTERNAL_CONFIG.API_KEY_HEADER, MEET_INITIAL_API_KEY); }; export const bulkDeleteRecordings = async (recordingIds: any[], recordingTokenCookie?: string): Promise => { checkAppIsRunning(); const req = request(app) .delete(`${INTERNAL_CONFIG.API_BASE_PATH_V1}/recordings`) .query({ recordingIds: recordingIds.join(',') }); if (recordingTokenCookie) { req.set('Cookie', recordingTokenCookie); } else { req.set(INTERNAL_CONFIG.API_KEY_HEADER, MEET_INITIAL_API_KEY); } return await req; }; export const downloadRecordings = async ( recordingIds: string[], asBuffer = true, recordingTokenCookie?: string ): Promise => { checkAppIsRunning(); const req = request(app) .get(`${INTERNAL_CONFIG.API_BASE_PATH_V1}/recordings/download`) .query({ recordingIds: recordingIds.join(',') }); if (recordingTokenCookie) { req.set('Cookie', recordingTokenCookie); } else { req.set(INTERNAL_CONFIG.API_KEY_HEADER, MEET_INITIAL_API_KEY); } if (asBuffer) { return await req.buffer().parse((res, cb) => { const data: Buffer[] = []; res.on('data', (chunk) => data.push(chunk)); res.on('end', () => cb(null, Buffer.concat(data))); }); } return await req; }; export const stopAllRecordings = async (moderatorCookie: string) => { checkAppIsRunning(); const response = await getAllRecordings(); const recordingIds: string[] = response.body.recordings .filter((rec: MeetRecordingInfo) => rec.status === MeetRecordingStatus.ACTIVE) .map((recording: { recordingId: string }) => recording.recordingId); if (recordingIds.length === 0) { return; } console.log(`Stopping ${recordingIds.length} recordings...`, recordingIds); const tasks = recordingIds.map((recordingId: string) => request(app) .post(`${INTERNAL_CONFIG.INTERNAL_API_BASE_PATH_V1}/recordings/${recordingId}/stop`) .set(INTERNAL_CONFIG.PARTICIPANT_ROLE_HEADER, ParticipantRole.MODERATOR) .set('Cookie', moderatorCookie) .send() ); const results = await Promise.all(tasks); // Check responses results.forEach((response) => { expect(response.status).toBe(202); }); await sleep('1s'); }; export const getAllRecordings = async (query: Record = {}) => { checkAppIsRunning(); return await request(app) .get(`${INTERNAL_CONFIG.API_BASE_PATH_V1}/recordings`) .set(INTERNAL_CONFIG.API_KEY_HEADER, MEET_INITIAL_API_KEY) .query(query); }; export const getAllRecordingsFromRoom = async (recordingTokenCookie: string) => { checkAppIsRunning(); return await request(app).get(`${INTERNAL_CONFIG.API_BASE_PATH_V1}/recordings`).set('Cookie', recordingTokenCookie); }; export const deleteAllRecordings = async () => { checkAppIsRunning(); let nextPageToken: string | undefined; do { const response: any = await getAllRecordings({ fields: 'recordingId', maxItems: 100, nextPageToken }); expect(response.status).toBe(200); nextPageToken = response.body.pagination?.nextPageToken ?? undefined; const recordingIds = response.body.recordings.map( (recording: { recordingId: string }) => recording.recordingId ); if (recordingIds.length === 0) { break; } await bulkDeleteRecordings(recordingIds); } while (nextPageToken); }; // PRIVATE METHODS const checkAppIsRunning = () => { if (!app) { throw new Error('App instance is not defined'); } };