fix: Calendar status event status switch (RocketChat#39491)

Author: KevLehman

.changeset/red-windows-breathe.md

@@ -0,0 +1,5 @@
+---
+"@rocket.chat/meteor": patch
+---
+
+Fixes calendar events modifying the wrong status property when attempting to sync `busy` status.

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

@@ -285,15 +285,15 @@ export class CalendarService extends ServiceClassInternal implements ICalendarSe
 			return;
 		}
 
-		const user = await Users.findOneById(event.uid, { projection: { status: 1 } });
-		if (!user || user.status === UserStatus.OFFLINE) {
+		const user = await Users.findOneById(event.uid, { projection: { statusDefault: 1 } });
+		if (!user || user.statusDefault === UserStatus.OFFLINE) {
 			return;
 		}
 
 		const overlappingEvents = await CalendarEvent.findOverlappingEvents(event._id, event.uid, event.startTime, event.endTime)
 			.sort({ startTime: -1 })
 			.toArray();
-		const previousStatus = overlappingEvents.at(0)?.previousStatus ?? user.status;
+		const previousStatus = overlappingEvents.at(0)?.previousStatus ?? user.statusDefault;
 
 		if (previousStatus) {
 			await CalendarEvent.updateEvent(event._id, { previousStatus });
@@ -313,16 +313,16 @@ export class CalendarService extends ServiceClassInternal implements ICalendarSe
 			return;
 		}
 
-		const user = await Users.findOneById(event.uid, { projection: { status: 1 } });
+		const user = await Users.findOneById(event.uid, { projection: { statusDefault: 1 } });
 		if (!user) {
 			return;
 		}
 
 		// Only restore status if:
-		// 1. The current status is BUSY (meaning it was set by our system, not manually changed by user)
+		// 1. The current statusDefault is BUSY (meaning it was set by our system, not manually changed by user)
 		// 2. We have a previousStatus stored from before the event started
 
-		if (user.status === UserStatus.BUSY && event.previousStatus && event.previousStatus !== user.status) {
+		if (user.statusDefault === UserStatus.BUSY && event.previousStatus && event.previousStatus !== user.statusDefault) {
 			await applyStatusChange({
 				eventId: event._id,
 				uid: event.uid,
@@ -334,7 +334,7 @@ export class CalendarService extends ServiceClassInternal implements ICalendarSe
 			logger.debug({
 				msg: 'Not restoring status for user',
 				userId: event.uid,
-				currentStatus: user.status,
+				currentStatusDefault: user.statusDefault,
 				previousStatus: event.previousStatus,
 			});
 		}

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

@@ -20,33 +20,51 @@ export async function applyStatusChange({
 	status?: UserStatus;
 	shouldScheduleRemoval?: boolean;
 }): Promise<void> {
+	const user = await Users.findOneById(uid, { projection: { roles: 1, username: 1, name: 1, statusDefault: 1 } });
+
+	if (!user || user.statusDefault === UserStatus.OFFLINE) {
+		logger.debug({
+			msg: 'Cannot apply status change for event, user is offline or does not exist',
+			eventId,
+			uid,
+		});
+
+		return;
+	}
+
+	const newStatus = status ?? UserStatus.BUSY;
+	const previousStatus = user.statusDefault;
+
 	logger.debug({
 		msg: 'Applying status change for event',
 		eventId,
-		uid,
+		user: { _id: uid, statusDefault: user?.statusDefault },
 		startTime,
 		endTime,
-		status: status ?? UserStatus.BUSY,
+		newStatus,
+		previousStatus,
 	});
 
-	const user = await Users.findOneById(uid, { projection: { roles: 1, username: 1, name: 1, status: 1 } });
-	if (!user || user.status === UserStatus.OFFLINE) {
-		return;
+	let statusChanged = false;
+
+	if (newStatus === UserStatus.BUSY) {
+		await Users.updateStatusAndStatusDefault(uid, newStatus, newStatus);
+		statusChanged = true;
+	} else if (user.statusDefault === UserStatus.BUSY) {
+		await Users.updateStatusAndStatusDefault(uid, newStatus, newStatus);
+		statusChanged = true;
 	}
 
-	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 (statusChanged) {
+		await api.broadcast('presence.status', {
+			user: {
+				status: newStatus,
+				_id: uid,
+				roles: user.roles,
+				username: user.username,
+				name: user.name,
+			},
+			previousStatus,
+		});
+	}
 }

apps/meteor/tests/end-to-end/api/calendar.ts

@@ -4,9 +4,11 @@ import { expect } from 'chai';
 import { after, before, describe, it } from 'mocha';
 import type { Response } from 'supertest';
 
+import { sleep } from '../../../lib/utils/sleep';
 import { getCredentials, api, request, credentials } from '../../data/api-data';
 import { password } from '../../data/user';
 import { createUser, deleteUser, login } from '../../data/users.helper';
+import { IS_EE } from '../../e2e/config/constants';
 
 describe('[Calendar Events]', () => {
 	let user2: IUser;
@@ -663,4 +665,41 @@ describe('[Calendar Events]', () => {
 				.expect(400);
 		});
 	});
+
+	(IS_EE ? describe : describe.skip)('[Calendar Events Status Sync]', () => {
+		before(async () => {
+			await request.post('/api/v1/users.setStatus').set(userCredentials).send({ status: 'away' }).expect(200);
+		});
+
+		it('should set user status to busy during event and restore manual status after event ends', async () => {
+			const now = new Date();
+			const startTime = new Date(now.getTime() + 1000);
+			// Event cannot be less than 5 secs in duration, otherwise `processStatusChangesAtTime` would trigger both start/end status changes at the same time, due to the 5s offset
+			const endTime = new Date(startTime.getTime() + 6000);
+
+			const eventPayload = {
+				startTime: startTime.toISOString(),
+				endTime: endTime.toISOString(),
+				subject: 'Subject',
+				description: 'Description',
+				reminderMinutesBeforeStart: 1,
+				busy: true,
+			};
+
+			const createResponse = await request.post('/api/v1/calendar-events.create').set(userCredentials).send(eventPayload).expect(200);
+			const eventId = createResponse.body.id;
+
+			await sleep(3000);
+
+			const statusResponseDuring = await request.get('/api/v1/users.getStatus').set(userCredentials).expect(200);
+			expect(statusResponseDuring.body.status).to.equal('busy');
+
+			await sleep(5000);
+
+			const statusResponseAfter = await request.get('/api/v1/users.getStatus').set(userCredentials).expect(200);
+			expect(statusResponseAfter.body.status).to.equal('away');
+
+			await request.post('/api/v1/calendar-events.delete').set(userCredentials).send({ eventId }).expect(200);
+		});
+	});
 });