Micro Services: Fix logout issue (#19423)

client/lib/meteorCallWrapper.ts

@@ -6,6 +6,7 @@ import { APIClient } from '../../app/utils/client';
 
 const bypassMethods: string[] = [
 	'setUserStatus',
+	'logout',
 ];
 
 function shouldBypass({ method, params }: Meteor.IDDPMessage): boolean {

ee/server/services/account/Account.ts

@@ -1,10 +1,10 @@
 import {
-	IStampedToken,
 	_generateStampedLoginToken,
 	_hashStampedToken,
 	_hashLoginToken,
 	_tokenExpiration,
 	validatePassword,
+	IHashedStampedToken,
 } from './lib/utils';
 import { getCollection, Collections } from '../mongo';
 import { IUser } from '../../../../definition/IUser';
@@ -12,11 +12,25 @@ import { ServiceClass } from '../../../../server/sdk/types/ServiceClass';
 import { IAccount, ILoginResult } from '../../../../server/sdk/types/IAccount';
 
 
-const saveSession = async (uid: string, newToken: IStampedToken): Promise<void> => {
+const saveSession = async (uid: string, newToken: IHashedStampedToken): Promise<void> => {
 	const Users = await getCollection<IUser>(Collections.User);
 	await Users.updateOne({ _id: uid }, {
 		$push: {
-			'services.resume.loginTokens': _hashStampedToken(newToken),
+			'services.resume.loginTokens': newToken.hashedToken,
+		},
+	});
+};
+
+const removeSession = async (uid: string, loginToken: string): Promise<void> => {
+	const Users = await getCollection<IUser>(Collections.User);
+	await Users.updateOne({ _id: uid }, {
+		$pull: {
+			'services.resume.loginTokens': {
+				$or: [
+					{ hashedToken: loginToken },
+					{ token: loginToken },
+				],
+			},
 		},
 	});
 };
@@ -43,6 +57,7 @@ const loginViaResume = async (resume: string): Promise<false | ILoginResult> =>
 	return {
 		uid: user._id,
 		token: resume,
+		hashedToken,
 		tokenExpires: when ? _tokenExpiration(when) : undefined,
 		type: 'resume',
 	};
@@ -62,11 +77,14 @@ const loginViaUsername = async ({ username }: {username: string}, password: stri
 
 	const newToken = _generateStampedLoginToken();
 
-	await saveSession(user._id, newToken);
+	const hashedToken = _hashStampedToken(newToken);
+
+	await saveSession(user._id, hashedToken);
 
 	return {
 		uid: user._id,
 		token: newToken.token,
+		hashedToken: hashedToken.hashedToken,
 		tokenExpires: _tokenExpiration(newToken.when),
 		type: 'password',
 	};
@@ -86,4 +104,8 @@ export class Account extends ServiceClass implements IAccount {
 
 		return false;
 	}
+
+	async logout({ userId, token }: {userId: string; token: string}): Promise<void> {
+		return removeSession(userId, token);
+	}
 }

ee/server/services/ddp-streamer/Client.ts

@@ -26,9 +26,9 @@ export class Client extends EventEmitter {
 
 	public wait = false;
 
-	public userId: string;
+	public userId?: string;
 
-	public userToken: string;
+	public userToken?: string;
 
 	constructor(
 		public ws: WebSocket,

ee/server/services/ddp-streamer/Publication.ts

@@ -55,7 +55,7 @@ export class Publication extends EventEmitter implements IPublication {
 		this.server.removed(this.client, collection, id);
 	}
 
-	get userId(): string {
+	get userId(): string | undefined {
 		return this.client.userId;
 	}
 }

ee/server/services/ddp-streamer/configureServer.ts

@@ -1,6 +1,6 @@
 import { EventEmitter } from 'events';
 
-import { DDP_EVENTS } from './constants';
+import { DDP_EVENTS, WS_ERRORS } from './constants';
 import { Account, Presence, MeteorService } from '../../../../server/sdk';
 import { USER_STATUS } from '../../../../definition/UserStatus';
 import { Server } from './Server';
@@ -73,7 +73,7 @@ server.methods({
 		}
 
 		this.userId = result.uid;
-		this.userToken = result.token;
+		this.userToken = result.hashedToken;
 
 		this.emit(DDP_EVENTS.LOGGED);
 
@@ -86,20 +86,50 @@ server.methods({
 			type: result.type,
 		};
 	},
+	async logout() {
+		if (this.userToken && this.userId) {
+			await Account.logout({ userId: this.userId, token: this.userToken });
+		}
+
+		// TODO: run the handles on monolith to track SAU correctly
+		// accounts._successfulLogout(this.connection, this.userId);
+		this.userToken = undefined;
+		this.userId = undefined;
+
+		// Close connection after return success to the method call.
+		// This ensures all the subscriptions will be closed, meteor makes it manually
+		// here https://github.com/meteor/meteor/blob/2377ebe879d9b965d699f599392d4e8047eb7d78/packages/ddp-server/livedata_server.js#L781
+		// re doing the default subscriptions.
+		setTimeout(() => {
+			this.ws.close(WS_ERRORS.CLOSE_PROTOCOL_ERROR);
+		}, 1);
+	},
 	'UserPresence:setDefaultStatus'(status) {
 		const { userId } = this;
+		if (!userId) {
+			return;
+		}
 		return Presence.setStatus(userId, status);
 	},
 	'UserPresence:online'() {
 		const { userId, session } = this;
+		if (!userId) {
+			return;
+		}
 		return Presence.setConnectionStatus(userId, USER_STATUS.ONLINE, session);
 	},
 	'UserPresence:away'() {
 		const { userId, session } = this;
+		if (!userId) {
+			return;
+		}
 		return Presence.setConnectionStatus(userId, USER_STATUS.AWAY, session);
 	},
 	'setUserStatus'(status, statusText) {
 		const { userId } = this;
+		if (!userId) {
+			return;
+		}
 		return Presence.setStatus(userId, status, statusText);
 	},
 	// Copied from /app/livechat/server/methods/setUpConnection.js

ee/server/services/ecosystem.config.js

@@ -18,6 +18,8 @@ module.exports = {
 		instances: 1,
 		env: {
 			MOLECULER_LOG_LEVEL: 'info',
+			TRANSPORTER: 'nats://localhost:4222',
+			MONGO_URL: 'mongodb://localhost:3001/meteor',
 		},
 	})),
 };

server/modules/notifications/notifications.module.ts

@@ -95,6 +95,10 @@ export class NotificationsModule {
 
 		this.streamRoomMessage.allowWrite('none');
 		this.streamRoomMessage.allowRead(async function(eventName /* , args*/) {
+			if (!this.userId) {
+				return false;
+			}
+
 			const room = await Rooms.findOneById(eventName);
 			if (!room) {
 				return false;
@@ -114,6 +118,10 @@ export class NotificationsModule {
 
 		this.streamRoomMessage.allowRead('__my_messages__', 'all');
 		this.streamRoomMessage.allowEmit('__my_messages__', async function(_eventName, { rid }) {
+			if (!this.userId) {
+				return false;
+			}
+
 			try {
 				const room = await Rooms.findOneById(rid);
 				if (!room) {
@@ -180,6 +188,10 @@ export class NotificationsModule {
 				return false;
 			}
 
+			if (!this.userId) {
+				return false;
+			}
+
 			try {
 				// TODO consider using something to cache settings
 				const key = await Settings.getValueById('UI_Use_Real_Name') ? 'name' : 'username';
@@ -209,6 +221,10 @@ export class NotificationsModule {
 
 		this.streamRoomUsers.allowRead('none');
 		this.streamRoomUsers.allowWrite(async function(eventName, ...args) {
+			if (!this.userId) {
+				return false;
+			}
+
 			const [roomId, e] = eventName.split('/');
 			if (await Subscriptions.countByRoomIdAndUserId(roomId, this.userId) > 0) {
 				const subscriptions: ISubscription[] = await Subscriptions.findByRoomIdAndNotUserId(roomId, this.userId, { projection: { 'u._id': 1, _id: 0 } }).toArray();
@@ -282,6 +298,10 @@ export class NotificationsModule {
 
 		this.streamRoomData.allowWrite('none');
 		this.streamRoomData.allowRead(async function(rid) {
+			if (!this.userId) {
+				return false;
+			}
+
 			try {
 				const room = await Rooms.findOneById(rid);
 				if (!room) {

server/modules/streamer/streamer.module.ts

@@ -13,7 +13,7 @@ export const StreamerCentral = new StreamerCentralClass();
 export type Client = {
 	meteorClient: boolean;
 	ws: any;
-	userId: string;
+	userId?: string;
 	send: Function;
 }
 
@@ -23,13 +23,13 @@ export interface IPublication {
 	connection: Connection;
 	_session: {
 		sendAdded(publicationName: string, id: string, fields: Record<string, any>): void;
-		userId: string;
+		userId?: string;
 		socket?: {
 			send: Function;
 		};
 	};
 	ready: Function;
-	userId: string;
+	userId: string | undefined;
 	client: Client;
 }
 

server/sdk/types/IAccount.ts

@@ -3,10 +3,12 @@ import { IServiceClass } from './ServiceClass';
 export interface ILoginResult {
 	uid: string;
 	token: string;
+	hashedToken: string;
 	tokenExpires?: Date;
 	type: 'resume' | 'password';
 }
 
 export interface IAccount extends IServiceClass {
 	login({ resume, user, password }: {resume: string; user: {username: string}; password: string}): Promise<false | ILoginResult>;
+	logout({ userId, token }: {userId: string; token: string}): Promise<void>;
 }

server/sdk/types/IMeteor.ts

@@ -16,7 +16,7 @@ export interface IMeteor extends IServiceClass {
 
 	getLoginServiceConfiguration(): Promise<any[]>;
 
-	callMethodWithToken(userId: string, token: string, method: string, args: any[]): Promise<void | any>;
+	callMethodWithToken(userId: string | undefined, token: string | undefined, method: string, args: any[]): Promise<void | any>;
 
 	notifyGuestStatusChanged(token: string, status: string): Promise<void>;