neoris/openvidu
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

tests: Refactor request helpers for improved preference management and cleanup

Browse Source
This commit is contained in:
juancarmore 2025-05-11 14:06:03 +02:00
parent 3942dfa0af
commit 4d176600e1
2 changed files with 130 additions and 126 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

250
backend/tests/helpers/request-helpers.ts
View File

@ -1,6 +1,6 @@
/* eslint-disable @typescript-eslint/no-explicit-any */ /* eslint-disable @typescript-eslint/no-explicit-any */
import { expect } from '@jest/globals'; import { expect } from '@jest/globals';
import { ChildProcess, execSync, spawn } from 'child_process'; import { ChildProcess, spawn } from 'child_process';
import { Express } from 'express'; import { Express } from 'express';
import ms, { StringValue } from 'ms'; import ms, { StringValue } from 'ms';
import request, { Response } from 'supertest'; import request, { Response } from 'supertest';
@ -20,6 +20,7 @@ import { RecordingService, RoomService } from '../../src/services/index.js';
import { import {
AuthMode, AuthMode,
AuthType, AuthType,
MeetRecordingAccess,
MeetRoom, MeetRoom,
MeetRoomOptions, MeetRoomOptions,
UserRole, UserRole,
@ -44,9 +45,6 @@ export const sleep = (time: StringValue) => {
return new Promise((resolve) => setTimeout(resolve, ms(time))); return new Promise((resolve) => setTimeout(resolve, ms(time)));
}; };
/**
* Starts the test server
*/
export const startTestServer = (): Express => { export const startTestServer = (): Express => {
if (app) { if (app) {
return app; return app;
@ -57,9 +55,62 @@ export const startTestServer = (): Express => {
return app; return app;
}; };
/** export const getAppearancePreferences = async () => {
* Updates global security preferences checkAppIsRunning();
*/
const adminCookie = await loginUserAsRole(UserRole.ADMIN);
const response = await request(app)
.get(`${INTERNAL_CONFIG.INTERNAL_API_BASE_PATH_V1}/preferences/appearance`)
.set('Cookie', adminCookie)
.send();
return response;
};
export const updateAppearancePreferences = async (preferences: any) => {
checkAppIsRunning();
const adminCookie = await loginUserAsRole(UserRole.ADMIN);
const response = await request(app)
.put(`${INTERNAL_CONFIG.INTERNAL_API_BASE_PATH_V1}/preferences/appearance`)
.set('Cookie', adminCookie)
.send(preferences);
return response;
};
export const getWebbhookPreferences = async () => {
checkAppIsRunning();
const adminCookie = await loginUserAsRole(UserRole.ADMIN);
const response = await request(app)
.get(`${INTERNAL_CONFIG.INTERNAL_API_BASE_PATH_V1}/preferences/webhooks`)
.set('Cookie', adminCookie)
.send();
return response;
};
export const updateWebbhookPreferences = async (preferences: WebhookPreferences) => {
checkAppIsRunning();
const adminCookie = await loginUserAsRole(UserRole.ADMIN);
const response = await request(app)
.put(`${INTERNAL_CONFIG.INTERNAL_API_BASE_PATH_V1}/preferences/webhooks`)
.set('Cookie', adminCookie)
.send(preferences);
return response;
};
export const getSecurityPreferences = async () => {
checkAppIsRunning();
const adminCookie = await loginUserAsRole(UserRole.ADMIN);
const response = await request(app)
.get(`${INTERNAL_CONFIG.INTERNAL_API_BASE_PATH_V1}/preferences/security`)
.set('Cookie', adminCookie)
.send();
return response;
};
export const changeSecurityPreferences = async ({ export const changeSecurityPreferences = async ({
usersCanCreateRooms = true, usersCanCreateRooms = true,
authRequired = true, authRequired = true,
@ -105,9 +156,6 @@ export const loginUserAsRole = async (role: UserRole): Promise<string> => {
return accessTokenCookie; return accessTokenCookie;
}; };
/**
* Creates a room with the given prefix
*/
export const createRoom = async (options: MeetRoomOptions = {}): Promise<MeetRoom> => { export const createRoom = async (options: MeetRoomOptions = {}): Promise<MeetRoom> => {
checkAppIsRunning(); checkAppIsRunning();
@ -119,10 +167,6 @@ export const createRoom = async (options: MeetRoomOptions = {}): Promise<MeetRoo
return response.body; return response.body;
}; };
/**
* Performs a GET /rooms request with provided query parameters.
* Returns the parsed response.
*/
export const getRooms = async (query: Record<string, any> = {}) => { export const getRooms = async (query: Record<string, any> = {}) => {
checkAppIsRunning(); checkAppIsRunning();
@ -132,16 +176,6 @@ export const getRooms = async (query: Record<string, any> = {}) => {
.query(query); .query(query);
}; };
export const updateRoomPreferences = async (roomId: string, preferences: any) => {
checkAppIsRunning();
const userCookie = await loginUserAsRole(UserRole.ADMIN);
return await request(app)
.put(`${INTERNAL_CONFIG.INTERNAL_API_BASE_PATH_V1}/rooms/${roomId}`)
.set('Cookie', userCookie)
.send(preferences);
};
/** /**
* Retrieves information about a specific room from the API. * Retrieves information about a specific room from the API.
* *
@ -159,6 +193,32 @@ export const getRoom = async (roomId: string, fields?: string) => {
.query({ fields }); .query({ fields });
}; };
export const updateRoomPreferences = async (roomId: string, preferences: any) => {
checkAppIsRunning();
const adminCookie = await loginUserAsRole(UserRole.ADMIN);
return await request(app)
.put(`${INTERNAL_CONFIG.INTERNAL_API_BASE_PATH_V1}/rooms/${roomId}`)
.set('Cookie', adminCookie)
.send(preferences);
};
export const updateRecordingAccessPreferencesInRoom = async (roomId: string, recordingAccess: MeetRecordingAccess) => {
const response = await updateRoomPreferences(roomId, {
recordingPreferences: {
enabled: true,
allowAccessTo: recordingAccess
},
chatPreferences: {
enabled: true
},
virtualBackgroundPreferences: {
enabled: true
}
});
expect(response.status).toBe(200);
};
export const deleteRoom = async (roomId: string, query: Record<string, any> = {}) => { export const deleteRoom = async (roomId: string, query: Record<string, any> = {}) => {
checkAppIsRunning(); checkAppIsRunning();
@ -177,30 +237,6 @@ export const bulkDeleteRooms = async (roomIds: any[], force?: any) => {
.query({ roomIds: roomIds.join(','), force }); .query({ roomIds: roomIds.join(','), force });
}; };
/**
* 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']();
};
export const runReleaseActiveRecordingLock = async (roomId: string) => {
checkAppIsRunning();
const recordingService = container.get(RecordingService);
await recordingService.releaseRecordingLockIfNoEgress(roomId);
};
/**
* Deletes all rooms
*/
export const deleteAllRooms = async () => { export const deleteAllRooms = async () => {
checkAppIsRunning(); checkAppIsRunning();
@ -227,6 +263,27 @@ export const deleteAllRooms = async () => {
} while (nextPageToken); } 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']();
};
export const runReleaseActiveRecordingLock = async (roomId: string) => {
checkAppIsRunning();
const recordingService = container.get(RecordingService);
await recordingService.releaseRecordingLockIfNoEgress(roomId);
};
/** /**
* Generates a participant token for a room and returns the cookie containing the token * Generates a participant token for a room and returns the cookie containing the token
*/ */
@ -285,17 +342,6 @@ export const joinFakeParticipant = async (roomId: string, participantName: strin
await sleep('1s'); await sleep('1s');
}; };
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)
.send();
await sleep('1s');
return response;
};
export const disconnectFakeParticipants = async () => { export const disconnectFakeParticipants = async () => {
fakeParticipantsProcesses.forEach((process, participantName) => { fakeParticipantsProcesses.forEach((process, participantName) => {
process.kill(); process.kill();
@ -306,46 +352,14 @@ export const disconnectFakeParticipants = async () => {
await sleep('1s'); await sleep('1s');
}; };
export const updateAppearancePreferences = async (preferences: any) => { export const endMeeting = async (roomId: string, moderatorCookie: string) => {
checkAppIsRunning(); checkAppIsRunning();
const userCookie = await loginUserAsRole(UserRole.ADMIN);
const response = await request(app)
.put(`${INTERNAL_CONFIG.INTERNAL_API_BASE_PATH_V1}/preferences/appearance`)
.set('Cookie', userCookie)
.send(preferences);
return response;
};
export const getAppearancePreferences = async () => {
checkAppIsRunning();
const userCookie = await loginUserAsRole(UserRole.ADMIN);
const response = await request(app) const response = await request(app)
.get(`${INTERNAL_CONFIG.INTERNAL_API_BASE_PATH_V1}/preferences/appearance`) .delete(`${INTERNAL_CONFIG.INTERNAL_API_BASE_PATH_V1}/meetings/${roomId}`)
.set('Cookie', userCookie) .set('Cookie', moderatorCookie)
.send();
return response;
};
export const updateWebbhookPreferences = async (preferences: WebhookPreferences) => {
checkAppIsRunning();
const userCookie = await loginUserAsRole(UserRole.ADMIN);
const response = await request(app)
.put(`${INTERNAL_CONFIG.INTERNAL_API_BASE_PATH_V1}/preferences/webhooks`)
.set('Cookie', userCookie)
.send(preferences);
return response;
};
export const getWebbhookPreferences = async () => {
checkAppIsRunning();
const userCookie = await loginUserAsRole(UserRole.ADMIN);
const response = await request(app)
.get(`${INTERNAL_CONFIG.INTERNAL_API_BASE_PATH_V1}/preferences/webhooks`)
.set('Cookie', userCookie)
.send(); .send();
await sleep('1s');
return response; return response;
}; };
@ -407,14 +421,6 @@ export const getRecording = async (recordingId: string) => {
.set(INTERNAL_CONFIG.API_KEY_HEADER, MEET_API_KEY); .set(INTERNAL_CONFIG.API_KEY_HEADER, MEET_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_API_KEY);
};
export const getRecordingMedia = async (recordingId: string, range?: string) => { export const getRecordingMedia = async (recordingId: string, range?: string) => {
checkAppIsRunning(); checkAppIsRunning();
@ -429,6 +435,24 @@ export const getRecordingMedia = async (recordingId: string, range?: string) =>
return await req; return await req;
}; };
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_API_KEY);
};
export const bulkDeleteRecordings = async (recordingIds: any[]): Promise<Response> => {
checkAppIsRunning();
const response = await request(app)
.delete(`${INTERNAL_CONFIG.API_BASE_PATH_V1}/recordings`)
.query({ recordingIds: recordingIds.join(',') })
.set(INTERNAL_CONFIG.API_KEY_HEADER, MEET_API_KEY);
return response;
};
export const stopAllRecordings = async (moderatorCookie: string) => { export const stopAllRecordings = async (moderatorCookie: string) => {
checkAppIsRunning(); checkAppIsRunning();
@ -461,16 +485,6 @@ export const getAllRecordings = async (query: Record<string, any> = {}) => {
.query(query); .query(query);
}; };
export const bulkDeleteRecordings = async (recordingIds: any[]): Promise<Response> => {
checkAppIsRunning();
const response = await request(app)
.delete(`${INTERNAL_CONFIG.API_BASE_PATH_V1}/recordings`)
.query({ recordingIds: recordingIds.join(',') })
.set(INTERNAL_CONFIG.API_KEY_HEADER, MEET_API_KEY);
return response;
};
export const deleteAllRecordings = async () => { export const deleteAllRecordings = async () => {
checkAppIsRunning(); checkAppIsRunning();
@ -504,13 +518,3 @@ const checkAppIsRunning = () => {
throw new Error('App instance is not defined'); throw new Error('App instance is not defined');
} }
}; };
const runCommandSync = (command: string): string => {
try {
const stdout = execSync(command, { encoding: 'utf-8' });
return stdout;
} catch (error) {
console.error(`Error running command: ${error}`);
throw error;
}
};

6
backend/tests/helpers/test-scenarios.ts
View File

@ -1,6 +1,8 @@
import express, { Request, Response } from 'express';
import http from 'http';
import { StringValue } from 'ms'; import { StringValue } from 'ms';
import { MeetRoomHelper } from '../../src/helpers'; import { MeetRoomHelper } from '../../src/helpers';
import { MeetRoom, MeetWebhookEvent } from '../../src/typings/ce'; import { MeetRoom } from '../../src/typings/ce';
import { expectValidStartRecordingResponse } from './assertion-helpers'; import { expectValidStartRecordingResponse } from './assertion-helpers';
import { import {
createRoom, createRoom,
@ -10,8 +12,6 @@ import {
startRecording, startRecording,
stopRecording stopRecording
} from './request-helpers'; } from './request-helpers';
import express, { Request, Response } from 'express';
import http from 'http';
let mockWebhookServer: http.Server; let mockWebhookServer: http.Server;