Skip to content

refactor: migrate rooms.nameExists to new route pattern #39309

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Rohitgiri02 wants to merge 4 commits into from
Closed

refactor: migrate rooms.nameExists to new route pattern #39309

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
840b41b
migrated rooms.nameExists route to new chained openapi style
Rohitgiri02 Mar 3, 2026
c0f4f59
fixed api-test for rooms.nameExists route
Rohitgiri02 Mar 3, 2026
a145b65
Merge branch 'develop' into migrate/rooms-nameexists
Rohitgiri02 Mar 3, 2026
bfebb00
Merge branch 'develop' into migrate/rooms-nameexists
Rohitgiri02 Mar 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 34 additions & 21 deletions apps/meteor/app/api/server/v1/rooms.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ import { Messages, Rooms, Users, Uploads, Subscriptions } from '@rocket.chat/mod
import type { Notifications } from '@rocket.chat/rest-typings';
import {
ajv,
isGETRoomsNameExists,
isRoomsImagesProps,
isRoomsMuteUnmuteUserProps,
isRoomsExportProps,
Expand Down Expand Up @@ -104,23 +103,6 @@ export async function findRoomByIdOrName({
return room;
}

API.v1.addRoute(
'rooms.nameExists',
{
authRequired: true,
validateParams: isGETRoomsNameExists,
},
{
async get() {
const { roomName } = this.queryParams;

const room = await Rooms.findOneByName(roomName, { projection: { _id: 1 } });

return API.v1.success({ exists: !!room });
},
},
);

const roomDeleteEndpoint = API.v1.post(
'rooms.delete',
{
Expand Down Expand Up @@ -1004,6 +986,39 @@ const isRoomsFavoriteProps = ajv.compile<RoomsFavorite>(RoomsFavoriteSchema);
const isRoomsLeaveProps = ajv.compile<RoomsLeave>(isRoomsLeavePropsSchema);

export const roomEndpoints = API.v1
.get(
'rooms.nameExists',
{
authRequired: true,
query: ajv.compile<{ roomName: string }>({
type: 'object',
properties: {
roomName: { type: 'string' },
},
required: ['roomName'],
additionalProperties: false,
}),
response: {
200: ajv.compile<{ exists: boolean }>({
type: 'object',
properties: {
success: { type: 'boolean', enum: [true] },
exists: { type: 'boolean' },
},
required: ['success', 'exists'],
additionalProperties: false,
}),
400: validateBadRequestErrorResponse,
401: validateUnauthorizedErrorResponse,
},
},
async function action() {
const { roomName } = this.queryParams;
const room = await Rooms.findOneByName(roomName, { projection: { _id: 1 } });

return API.v1.success({ exists: !!room });
},
)
.get(
'rooms.roles',
{
Expand Down Expand Up @@ -1211,9 +1226,7 @@ export const roomEndpoints = API.v1
},
);

type RoomEndpoints = ExtractRoutesFromAPI<typeof roomEndpoints> &
ExtractRoutesFromAPI<typeof roomEndpoints> &
ExtractRoutesFromAPI<typeof roomDeleteEndpoint>;
type RoomEndpoints = ExtractRoutesFromAPI<typeof roomEndpoints> & ExtractRoutesFromAPI<typeof roomDeleteEndpoint>;

declare module '@rocket.chat/rest-typings' {
// eslint-disable-next-line @typescript-eslint/naming-convention, @typescript-eslint/no-empty-interface
Expand Down
1 change: 1 addition & 0 deletions apps/meteor/tests/end-to-end/api/rooms.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -690,6 +690,7 @@ describe('[Rooms]', () => {
it('should return 401 unauthorized when user is not logged in', (done) => {
void request
.get(api('rooms.nameExists'))
.query({ roomName: 'test' })
.expect('Content-Type', 'application/json')
.expect(401)
.expect((res) => {
Expand Down
23 changes: 0 additions & 23 deletions packages/rest-typings/src/v1/rooms.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -441,23 +441,6 @@ const RoomsSaveRoomSettingsSchema = {

export const isRoomsSaveRoomSettingsProps = ajv.compile<RoomsSaveRoomSettingsProps>(RoomsSaveRoomSettingsSchema);

type GETRoomsNameExists = {
roomName: string;
};

const GETRoomsNameExistsSchema = {
type: 'object',
properties: {
roomName: {
type: 'string',
},
},
required: ['roomName'],
additionalProperties: false,
};

export const isGETRoomsNameExists = ajv.compile<GETRoomsNameExists>(GETRoomsNameExistsSchema);

type RoomsIsMemberProps = { roomId: string } & ({ username: string } | { userId: string });

const RoomsIsMemberPropsSchema = {
Expand Down Expand Up @@ -804,12 +787,6 @@ export type RoomsEndpoints = {
POST: (params: { roomId: string; notifications: Notifications }) => void;
};

'/v1/rooms.nameExists': {
GET: (params: { roomName: string }) => {
exists: boolean;
};
};

'/v1/rooms.get': {
GET: (params: { updatedSince: string }) => {
update: IRoom[];
Expand Down
Loading