feat: set busy status on calendar appointments #35474

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.

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

Merged

kodiakhq merged 34 commits into develop from feat/set-busy-status-on-calendar-appointments

Mar 20, 2025

.changeset/lovely-ways-move.md

-Original file line number
+Diff line change
@@ -0,0 +1,8 @@
+    ---
+    '@rocket.chat/core-services': minor
+    '@rocket.chat/rest-typings': minor
+    '@rocket.chat/models': minor
+    '@rocket.chat/meteor': minor
+    ---
+    Adds automatic presence sync based on calendar events, updating the user’s status to “busy” when a meeting starts and reverting it afterward.

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

-Original file line number
+Diff line change
@@ Expand Up / @@ -50,11 +50,12 @@ API.v1.addRoute( @@
     	{
     		async post() {
     			const { userId: uid } = this;
-    			const { startTime, externalId, subject, description, meetingUrl, reminderMinutesBeforeStart } = this.bodyParams;
+    			const { startTime, endTime, externalId, subject, description, meetingUrl, reminderMinutesBeforeStart } = this.bodyParams;
     			const id = await Calendar.create({
     				uid,
     				startTime: new Date(startTime),
+    				...(endTime ? { endTime: new Date(endTime) } : {}),
     				externalId,
     				subject,
     				description,
@@ Expand Down @@

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

-Original file line number
+Diff line change
@@ -1,4 +1,4 @@
-    import { MeteorError, Team, api } from '@rocket.chat/core-services';
+    import { MeteorError, Team, api, Calendar } from '@rocket.chat/core-services';
     import type { IExportOperation, ILoginToken, IPersonalAccessToken, IUser, UserStatus } from '@rocket.chat/core-typings';
     import { Users, Subscriptions } from '@rocket.chat/models';
     import {
@@ Expand All / @@ -19,7 +19,7 @@ import { @@
     	isUsersCheckUsernameAvailabilityParamsGET,
     	isUsersSendConfirmationEmailParamsPOST,
     } from '@rocket.chat/rest-typings';
-    import { getLoginExpirationInMs } from '@rocket.chat/tools';
+    import { getLoginExpirationInMs, wrapExceptions } from '@rocket.chat/tools';
     import { Accounts } from 'meteor/accounts-base';
     import { Match, check } from 'meteor/check';
     import { Meteor } from 'meteor/meteor';
@@ Expand Down Expand Up / @@ -1337,6 +1337,8 @@ API.v1.addRoute( @@
     						user: { status, _id, username, statusText, roles, name },
     						previousStatus: user.status,
     					});
+    					void wrapExceptions(() => Calendar.cancelUpcomingStatusChanges(user._id)).suppress();
     				} else {
     					throw new Meteor.Error('error-invalid-status', 'Valid status types include online, away, offline, and busy.', {
     						method: 'users.setStatus',
@@ Expand Down @@

apps/meteor/ee/server/settings/outlookCalendar.ts

-Original file line number
+Diff line change
@@ Expand Up / @@ -35,6 +35,12 @@ export function addSettings(): void { @@
     						invalidValue: '',
     					},
     				);
+    				await this.add('Calendar_BusyStatus_Enabled', true, {
+    					type: 'boolean',
+    					public: true,
+    					invalidValue: false,
+    				});
     			},
     		);
     	});
@@ Expand Down @@

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

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -1,12 +1,17 @@
  
    import type { ICalendarService } from '@rocket.chat/core-services';

    import { ServiceClassInternal, api } from '@rocket.chat/core-services';

    import type { IUser, ICalendarEvent } from '@rocket.chat/core-typings';

    import { UserStatus } from '@rocket.chat/core-typings';

    import { cronJobs } from '@rocket.chat/cron';

    import { Logger } from '@rocket.chat/logger';

    import type { InsertionModel } from '@rocket.chat/model-typings';

    import { CalendarEvent } from '@rocket.chat/models';

    import type { UpdateResult, DeleteResult } from 'mongodb';

    import { cancelUpcomingStatusChanges } from './statusEvents/cancelUpcomingStatusChanges';

    import { removeCronJobs } from './statusEvents/removeCronJobs';

    import { setupAppointmentStatusChange } from './statusEvents/setupAppointmentStatusChange';

    import { getShiftedTime } from './utils/getShiftedTime';

    import { settings } from '../../../app/settings/server';

    import { getUserPreference } from '../../../app/utils/server/lib/getUserPreference';

    @@ -18,24 +23,28 @@ export class CalendarService extends ServiceClassInternal implements ICalendarSe
  
    	protected name = 'calendar';

    	public async create(data: Omit<InsertionModel<ICalendarEvent>, 'reminderTime' | 'notificationSent'>): Promise<ICalendarEvent['_id']> {

    		const { uid, startTime, subject, description, reminderMinutesBeforeStart, meetingUrl } = data;

    		const { uid, startTime, endTime, subject, description, reminderMinutesBeforeStart, meetingUrl, busy } = data;

    		const minutes = reminderMinutesBeforeStart ?? defaultMinutesForNotifications;

    		const reminderTime = minutes ? this.getShiftedTime(startTime, -minutes) : undefined;

    		const reminderTime = minutes ? getShiftedTime(startTime, -minutes) : undefined;

    		const insertData: InsertionModel<ICalendarEvent> = {

    			uid,

    			startTime,

    			...(endTime && { endTime }),

    			subject,

    			description,

    			meetingUrl,

    			reminderMinutesBeforeStart: minutes,

    			reminderTime,

    			notificationSent: false,

    			...(busy !== undefined && { busy }),

    		};

    		const insertResult = await CalendarEvent.insertOne(insertData);

    		await this.setupNextNotification();

    		if (busy !== false) {

    			await setupAppointmentStatusChange(insertResult.insertedId, uid, startTime, endTime, UserStatus.BUSY, true);

    		}

    		return insertResult.insertedId;

    	}

    @@ -46,18 +55,20 @@ export class CalendarService extends ServiceClassInternal implements ICalendarSe
  
    			return this.create(data);

    		}

    		const { uid, startTime, subject, description, reminderMinutesBeforeStart } = data;

    		const { uid, startTime, endTime, subject, description, reminderMinutesBeforeStart, busy } = data;

    		const meetingUrl = data.meetingUrl ? data.meetingUrl : await this.parseDescriptionForMeetingUrl(description);

    		const reminderTime = reminderMinutesBeforeStart ? this.getShiftedTime(startTime, -reminderMinutesBeforeStart) : undefined;

    		const reminderTime = reminderMinutesBeforeStart ? getShiftedTime(startTime, -reminderMinutesBeforeStart) : undefined;

    		const updateData: Omit<InsertionModel<ICalendarEvent>, 'uid' | 'notificationSent'> = {

    			startTime,

    			...(endTime && { endTime }),

    			subject,

    			description,

    			meetingUrl,

    			reminderMinutesBeforeStart,

    			reminderTime,

    			externalId,

    			...(busy !== undefined && { busy }),

    		};

    		const event = await this.findImportedEvent(externalId, uid);

    @@ -70,12 +81,18 @@ export class CalendarService extends ServiceClassInternal implements ICalendarSe
  
    			});

    			await this.setupNextNotification();

    			if (busy !== false) {

    				await setupAppointmentStatusChange(insertResult.insertedId, uid, startTime, endTime, UserStatus.BUSY, true);

    			}

    			return insertResult.insertedId;

    		}

    		const updateResult = await CalendarEvent.updateEvent(event._id, updateData);

    		if (updateResult.modifiedCount > 0) {

    			await this.setupNextNotification();

    			if (busy !== false) {

    				await setupAppointmentStatusChange(event._id, uid, startTime, endTime, UserStatus.BUSY, true);

    			}

    		}

    		return event._id;

    @@ -89,30 +106,58 @@ export class CalendarService extends ServiceClassInternal implements ICalendarSe
  
    		return CalendarEvent.findByUserIdAndDate(uid, date).toArray();

    	}

    	public async update(eventId: ICalendarEvent['_id'], data: Partial<ICalendarEvent>): Promise<UpdateResult> {

    		const { startTime, subject, description, reminderMinutesBeforeStart } = data;

    		const meetingUrl = data.meetingUrl ? data.meetingUrl : await this.parseDescriptionForMeetingUrl(description || '');

    		const reminderTime = reminderMinutesBeforeStart && startTime ? this.getShiftedTime(startTime, -reminderMinutesBeforeStart) : undefined;

    	public async update(eventId: ICalendarEvent['_id'], data: Partial<ICalendarEvent>): Promise<UpdateResult | null> {

    		const event = await this.get(eventId);

    		if (!event) {

    			return null;

    		}

    		const { startTime, endTime, subject, description, reminderMinutesBeforeStart, busy } = data;

    		const meetingUrl = await this.getMeetingUrl(data);

    		const reminderTime = reminderMinutesBeforeStart && startTime ? getShiftedTime(startTime, -reminderMinutesBeforeStart) : undefined;

    		const updateData: Partial<ICalendarEvent> = {

    			startTime,

    			...(endTime && { endTime }),

    			subject,

    			description,

    			meetingUrl,

    			reminderMinutesBeforeStart,

    			reminderTime,

    			...(busy !== undefined && { busy }),

    		};

    		const updateResult = await CalendarEvent.updateEvent(eventId, updateData);

    		if (updateResult.modifiedCount > 0) {

    			await this.setupNextNotification();

    			if (startTime || endTime) {

    				await removeCronJobs(eventId, event.uid);

    				const isBusy = busy !== undefined ? busy : event.busy !== false;

    				if (isBusy) {

    					const effectiveStartTime = startTime || event.startTime;

    					const effectiveEndTime = endTime || event.endTime;

    					// Only proceed if we have both valid start and end times

    					if (effectiveStartTime && effectiveEndTime) {

    						await setupAppointmentStatusChange(eventId, event.uid, effectiveStartTime, effectiveEndTime, UserStatus.BUSY, true);

    					}

    				}

    			}

    		}

    		return updateResult;

    	}

    	public async delete(eventId: ICalendarEvent['_id']): Promise<DeleteResult> {

    		const event = await this.get(eventId);

    		if (event) {

    			await removeCronJobs(eventId, event.uid);

    		}

    		return CalendarEvent.deleteOne({

    			_id: eventId,

    		});

    @@ -122,6 +167,22 @@ export class CalendarService extends ServiceClassInternal implements ICalendarSe
  
    		return this.doSetupNextNotification(false);

    	}

    	public async cancelUpcomingStatusChanges(uid: IUser['_id'], endTime = new Date()): Promise<void> {

    		return cancelUpcomingStatusChanges(uid, endTime);

    	}

    	private async getMeetingUrl(eventData: Partial<ICalendarEvent>): Promise<string | undefined> {

    		if (eventData.meetingUrl !== undefined) {

    			return eventData.meetingUrl;

    		}

    		if (eventData.description !== undefined) {

    			return this.parseDescriptionForMeetingUrl(eventData.description);

    		}

    		return undefined;

    	}

    	private async doSetupNextNotification(isRecursive: boolean): Promise<void> {

    		const date = await CalendarEvent.findNextNotificationDate();

    		if (!date) {

    @@ -139,19 +200,17 @@ export class CalendarService extends ServiceClassInternal implements ICalendarSe
  
    		await cronJobs.addAtTimestamp('calendar-reminders', date, async () => this.sendCurrentNotifications(date));

    	}

    	public async sendCurrentNotifications(date: Date): Promise<void> {

    	private async sendCurrentNotifications(date: Date): Promise<void> {

    		const events = await CalendarEvent.findEventsToNotify(date, 1).toArray();

    		for await (const event of events) {

    			await this.sendEventNotification(event);

    			await CalendarEvent.flagNotificationSent(event._id);

    		}

    		await this.doSetupNextNotification(true);

    	}

    	public async sendEventNotification(event: ICalendarEvent): Promise<void> {

    	private async sendEventNotification(event: ICalendarEvent): Promise<void> {

    		if (!(await getUserPreference(event.uid, 'notifyCalendarEvents'))) {

    			return;

    		}

    @@ -165,14 +224,14 @@ export class CalendarService extends ServiceClassInternal implements ICalendarSe
  
    		});

    	}

    	public async findImportedEvent(

    	private async findImportedEvent(

    		externalId: Required<ICalendarEvent>['externalId'],

    		uid: ICalendarEvent['uid'],

    	): Promise<ICalendarEvent | null> {

    		return CalendarEvent.findOneByExternalIdAndUserId(externalId, uid);

    	}

    	public async parseDescriptionForMeetingUrl(description: string): Promise<string | undefined> {

    	private async parseDescriptionForMeetingUrl(description: string): Promise<string | undefined> {

    		if (!description) {

    			return;

    		}

    @@ -224,10 +283,4 @@ export class CalendarService extends ServiceClassInternal implements ICalendarSe
  
    		return undefined;

    	}

    	private getShiftedTime(time: Date, minutes: number): Date {

    		const newTime = new Date(time.valueOf());

    		newTime.setMinutes(newTime.getMinutes() + minutes);

    		return newTime;

    	}

    }

apps/meteor/server/services/calendar/statusEvents/applyStatusChange.ts

-Original file line number
+Diff line change
@@ -0,0 +1,47 @@
+    import { api } from '@rocket.chat/core-services';
+    import { UserStatus } from '@rocket.chat/core-typings';
+    import type { ICalendarEvent, IUser } from '@rocket.chat/core-typings';
+    import { Users } from '@rocket.chat/models';
+    import { setupAppointmentStatusChange } from './setupAppointmentStatusChange';
+    export async function applyStatusChange({
+    	eventId,
+    	uid,
+    	startTime,
+    	endTime,
+    	status,
+    	shouldScheduleRemoval,
+    }: {
+    	eventId: ICalendarEvent['_id'];
+    	uid: IUser['_id'];
+    	startTime: Date;
+    	endTime?: Date;
+    	status?: UserStatus;
+    	shouldScheduleRemoval?: boolean;
+    }): Promise<void> {
+    	const user = await Users.findOneById(uid, { projection: { roles: 1, username: 1, name: 1, status: 1 } });
+    	if (!user || user.status === UserStatus.OFFLINE) {
+    		return;
+    	}
+    	const newStatus = status ?? UserStatus.BUSY;
+    	const previousStatus = user.status;
+    	await Users.updateStatusAndStatusDefault(uid, newStatus, newStatus);
+    	await api.broadcast('presence.status', {
+    		user: {
+    			status: newStatus,
+    			_id: uid,
+    			roles: user.roles,
+    			username: user.username,
+    			name: user.name,
+    		},
+    		previousStatus,
+    	});
+    	if (shouldScheduleRemoval && endTime) {
+    		await setupAppointmentStatusChange(eventId, uid, startTime, endTime, previousStatus, false);
+    	}
+    }

apps/meteor/server/services/calendar/statusEvents/cancelUpcomingStatusChanges.ts

-Original file line number
+Diff line change
@@ -0,0 +1,22 @@
+    import type { IUser } from '@rocket.chat/core-typings';
+    import { cronJobs } from '@rocket.chat/cron';
+    import { CalendarEvent } from '@rocket.chat/models';
+    import { generateCronJobId } from './generateCronJobId';
+    import { settings } from '../../../../app/settings/server';
+    export async function cancelUpcomingStatusChanges(uid: IUser['_id'], endTime = new Date()): Promise<void> {
+    	const hasBusyStatusSetting = settings.get<boolean>('Calendar_BusyStatus_Enabled');
+    	if (!hasBusyStatusSetting) {
+    		return;
+    	}
+    	const events = await CalendarEvent.findEligibleEventsForCancelation(uid, endTime).toArray();
+    	for await (const event of events) {
+    		const statusChangeJobId = generateCronJobId(event._id, event.uid, 'status');
+    		if (await cronJobs.has(statusChangeJobId)) {
+    			await cronJobs.remove(statusChangeJobId);
+    		}
+    	}
+    }

apps/meteor/server/services/calendar/statusEvents/generateCronJobId.ts

-Original file line number
+Diff line change
@@ -0,0 +1,13 @@
+    import type { ICalendarEvent, IUser } from '@rocket.chat/core-typings';
+    export function generateCronJobId(eventId: ICalendarEvent['_id'], uid: IUser['_id'], eventType: 'status' | 'reminder'): string {
+    	if (!eventId || !uid || !eventType || (eventType !== 'status' && eventType !== 'reminder')) {
+    		throw new Error('Missing required parameters. Please provide eventId, uid and eventType (status or reminder)');
+    	}
+    	if (eventType === 'status') {
+    		return `calendar-presence-status-${eventId}-${uid}`;
+    	}
+    	return `calendar-reminder-${eventId}-${uid}`;
+    }

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: set busy status on calendar appointments #35474

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!

Uh oh!