fix(calendar): address review comments and improve subject search

apps/meteor/app/api/server/v1/calendar.ts

@@ -1,5 +1,6 @@
 import { Calendar } from '@rocket.chat/core-services';
 import {
+	isCalendarEventSearchProps,
 	isCalendarEventListProps,
 	isCalendarEventCreateProps,
 	isCalendarEventImportProps,
@@ -25,6 +26,25 @@ API.v1.addRoute(
 	},
 );
 
+API.v1.addRoute(
+	'calendar-events.search',
+	{
+		authRequired: true,
+		validateParams: isCalendarEventSearchProps, 
+		rateLimiterOptions: { numRequestsAllowed: 3, intervalTimeInMS: 1000 },
+	},
+	{
+		async get() {
+			const { userId } = this;
+			const { text } = this.queryParams;
+
+			const data = await Calendar.searchBySubject(userId, text);
+			return API.v1.success({ data });
+		},
+	},
+);
+
+
 API.v1.addRoute(
 	'calendar-events.info',
 	{ authRequired: true, validateParams: isCalendarEventInfoProps, rateLimiterOptions: { numRequestsAllowed: 3, intervalTimeInMS: 1000 } },
@@ -142,4 +162,4 @@ API.v1.addRoute(
 			return API.v1.success();
 		},
 	},
-);
+);

apps/meteor/server/services/calendar/service.ts

@@ -99,6 +99,18 @@ export class CalendarService extends ServiceClassInternal implements ICalendarSe
 		return event._id;
 	}
 
+	public async searchBySubject(uid: IUser['_id'], text: string): Promise<ICalendarEvent[]> {
+		if (!text?.trim()) {
+			return [];
+		}
+
+		return CalendarEvent.findBySubject(uid, text, {
+			limit: 50,
+		}).toArray();
+	}
+
+
+
 	public async get(eventId: ICalendarEvent['_id']): Promise<ICalendarEvent | null> {
 		return CalendarEvent.findOne({ _id: eventId });
 	}

packages/core-services/src/types/ICalendarService.ts

@@ -7,9 +7,10 @@ export interface ICalendarService {
 	import(data: Omit<InsertionModel<ICalendarEvent>, 'notificationSent'>): Promise<ICalendarEvent['_id']>;
 	get(eventId: ICalendarEvent['_id']): Promise<ICalendarEvent | null>;
 	list(uid: IUser['_id'], date: Date): Promise<ICalendarEvent[]>;
+	searchBySubject(uid: IUser['_id'], text: string): Promise<ICalendarEvent[]>;
 	update(eventId: ICalendarEvent['_id'], data: Partial<ICalendarEvent>): Promise<UpdateResult | null>;
 	delete(eventId: ICalendarEvent['_id']): Promise<DeleteResult>;
 	setupNextNotification(): Promise<void>;
 	setupNextStatusChange(): Promise<void>;
 	cancelUpcomingStatusChanges(uid: IUser['_id'], endTime?: Date): Promise<void>;
-}
+}

packages/models/src/models/CalendarEvent.ts

@@ -4,6 +4,10 @@ import type { FindCursor, IndexDescription, Collection, Db, UpdateResult } from
 
 import { BaseRaw } from './BaseRaw';
 
+function escapeRegExp(text: string): string {
+	return text.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
+}
+
 export class CalendarEventRaw extends BaseRaw<ICalendarEvent> implements ICalendarEventModel {
 	constructor(db: Db, trash?: Collection<RocketChatRecordDeleted<ICalendarEvent>>) {
 		super(db, 'calendar_event', trash);
@@ -48,6 +52,20 @@ export class CalendarEventRaw extends BaseRaw<ICalendarEvent> implements ICalend
 		);
 	}
 
+	public findBySubject(uid: IUser['_id'], text: string): FindCursor<ICalendarEvent> {
+		const escapedText = escapeRegExp(text);
+
+		return this.find(
+			{
+				uid,
+				subject: { $regex: escapedText, $options: 'i' },
+			},
+			{
+				sort: { startTime: 1 },
+			},
+		);
+	}
+
 	public async updateEvent(
 		eventId: ICalendarEvent['_id'],
 		{
@@ -257,4 +275,4 @@ export class CalendarEventRaw extends BaseRaw<ICalendarEvent> implements ICalend
 			},
 		);
 	}
-}
+}

packages/rest-typings/src/v1/calendar/CalendarEventSearchProps.ts

@@ -0,0 +1,20 @@
+import type { JSONSchemaType } from 'ajv';
+import { ajv } from '../../Ajv';
+
+export type CalendarEventSearchProps = {
+	text: string;
+};
+
+const calendarEventSearchPropsSchema: JSONSchemaType<CalendarEventSearchProps> = {
+	type: 'object',
+	properties: {
+		text: {
+			type: 'string',
+			nullable: false,
+		},
+	},
+	required: ['text'],
+	additionalProperties: false,
+};
+
+export const isCalendarEventSearchProps = ajv.compile(calendarEventSearchPropsSchema);

packages/rest-typings/src/v1/calendar/index.ts

@@ -6,13 +6,15 @@ import type { CalendarEventImportProps } from './CalendarEventImportProps';
 import type { CalendarEventInfoProps } from './CalendarEventInfoProps';
 import type { CalendarEventListProps } from './CalendarEventListProps';
 import type { CalendarEventUpdateProps } from './CalendarEventUpdateProps';
+import type { CalendarEventSearchProps } from './CalendarEventSearchProps';
 
 export * from './CalendarEventCreateProps';
 export * from './CalendarEventDeleteProps';
 export * from './CalendarEventImportProps';
 export * from './CalendarEventInfoProps';
 export * from './CalendarEventUpdateProps';
 export * from './CalendarEventListProps';
+export * from './CalendarEventSearchProps';
 
 export type CalendarEndpoints = {
 	'/v1/calendar-events.create': {
@@ -38,4 +40,8 @@ export type CalendarEndpoints = {
 	'/v1/calendar-events.delete': {
 		POST: (params: CalendarEventDeleteProps) => void;
 	};
-};
+
+	'/v1/calendar-events.search': {
+		GET: (params: CalendarEventSearchProps) => { data: ICalendarEvent[] };
+	};
+};