feat: apps-engine presence bridge

Author: ricardogarim

apps/meteor/app/apps/server/bridges/users.ts

@@ -2,7 +2,7 @@ import type { IAppServerOrchestrator } from '@rocket.chat/apps';
 import { UserBridge } from '@rocket.chat/apps/dist/server/bridges/UserBridge';
 import type { IUserCreationOptions, IUser, UserType } from '@rocket.chat/apps-engine/definition/users';
 import { Presence } from '@rocket.chat/core-services';
-import type { UserStatus } from '@rocket.chat/core-typings';
+import type { PresenceSource, UserStatus } from '@rocket.chat/core-typings';
 import { Subscriptions, Users } from '@rocket.chat/models';
 import { Random } from '@rocket.chat/random';
 
@@ -173,6 +173,27 @@ export class AppUserBridge extends UserBridge {
 		return true;
 	}
 
+	protected async setActiveState(
+		userId: IUser['id'],
+		state: Pick<IUser, 'statusDefault' | 'statusSource' | 'statusText' | 'statusExpiresAt'>,
+		appId: string,
+	): Promise<void> {
+		this.orch.debugLog(`The App ${appId} is setting active state for user ${userId}`);
+
+		await Presence.setActiveState(userId, {
+			statusDefault: state.statusDefault as UserStatus,
+			statusText: state.statusText,
+			statusSource: state.statusSource as PresenceSource,
+			statusExpiresAt: state.statusExpiresAt,
+		});
+	}
+
+	protected async endActiveState(userId: IUser['id'], appId: string): Promise<void> {
+		this.orch.debugLog(`The App ${appId} is ending active state for user ${userId}`);
+
+		await Presence.endActiveState(userId);
+	}
+
 	protected async getActiveUserCount(): Promise<number> {
 		return Users.getActiveLocalUserCount();
 	}

packages/apps-engine/src/definition/accessors/IUserUpdater.ts

@@ -15,4 +15,9 @@ export interface IUserUpdater {
 	updateBio(user: IUser, bio: IUser['bio']): Promise<boolean>;
 	updateCustomFields(user: IUser, customFields: IUser['customFields']): Promise<boolean>;
 	deactivate(userId: IUser['id'], confirmRelinquish: boolean): Promise<boolean>;
+	setActiveState(
+		userId: IUser['id'],
+		state: Pick<IUser, 'statusDefault' | 'statusSource' | 'statusText' | 'statusExpiresAt'>,
+	): Promise<void>;
+	endActiveState(userId: IUser['id']): Promise<void>;
 }

packages/apps-engine/src/definition/users/IUser.ts

@@ -15,6 +15,9 @@ export interface IUser {
 	status: string;
 	statusConnection: UserStatusConnection;
 	statusText?: string;
+	statusDefault?: string;
+	statusSource?: 'internal' | 'external' | 'manual';
+	statusExpiresAt?: Date;
 	utcOffset: number;
 	createdAt: Date;
 	updatedAt: Date;

packages/apps/src/server/accessors/UserUpdater.ts

@@ -29,4 +29,15 @@ export class UserUpdater implements IUserUpdater {
 	public async deactivate(userId: IUser['id'], confirmRelinquish: boolean) {
 		return this.bridges.getUserBridge().doDeactivate(userId, confirmRelinquish, this.appId);
 	}
+
+	public async setActiveState(
+		userId: IUser['id'],
+		state: Pick<IUser, 'statusDefault' | 'statusSource' | 'statusText' | 'statusExpiresAt'>,
+	) {
+		return this.bridges.getUserBridge().doSetActiveState(userId, state, this.appId);
+	}
+
+	public async endActiveState(userId: IUser['id']) {
+		return this.bridges.getUserBridge().doEndActiveState(userId, this.appId);
+	}
 }

packages/apps/src/server/bridges/UserBridge.ts

@@ -64,6 +64,22 @@ export abstract class UserBridge extends BaseBridge {
 		}
 	}
 
+	public async doSetActiveState(
+		userId: IUser['id'],
+		state: Pick<IUser, 'statusDefault' | 'statusSource' | 'statusText' | 'statusExpiresAt'>,
+		appId: string,
+	): Promise<void> {
+		if (this.hasWritePermission(appId)) {
+			await this.setActiveState(userId, state, appId);
+		}
+	}
+
+	public async doEndActiveState(userId: IUser['id'], appId: string): Promise<void> {
+		if (this.hasWritePermission(appId)) {
+			await this.endActiveState(userId, appId);
+		}
+	}
+
 	protected abstract getById(id: string, appId: string): Promise<IUser>;
 
 	protected abstract getByUsername(username: string, appId: string): Promise<IUser>;
@@ -126,6 +142,14 @@ export abstract class UserBridge extends BaseBridge {
 	 */
 	protected abstract deactivate(userId: IUser['id'], confirmRelinquish: boolean, appId: string): Promise<boolean>;
 
+	protected abstract setActiveState(
+		userId: IUser['id'],
+		state: Pick<IUser, 'statusDefault' | 'statusSource' | 'statusText' | 'statusExpiresAt'>,
+		appId: string,
+	): Promise<void>;
+
+	protected abstract endActiveState(userId: IUser['id'], appId: string): Promise<void>;
+
 	private hasReadPermission(appId: string): boolean {
 		if (AppPermissionManager.hasPermission(appId, AppPermissions.user.read)) {
 			return true;