snapshot of https://github.com/RocketChat/Rocket.Chat.git (develop, 2026-09-16; blobs > 131072B omitted)

apps/meteor/tests/unit/server/lib/users/setUsername.spec.ts

@@ -0,0 +1,336 @@
+import { expect } from 'chai';
+import proxyquire from 'proxyquire';
+import sinon from 'sinon';
+
+describe('setUsername', () => {
+	const userId = 'userId';
+	const username = 'validUsername';
+
+	const stubs = {
+		Users: {
+			findOneById: sinon.stub(),
+			setUsername: sinon.stub(),
+		},
+		Subscriptions: {
+			findUserFederatedRoomIds: sinon.stub(),
+		},
+		Accounts: {
+			sendEnrollmentEmail: sinon.stub(),
+		},
+		settings: {
+			get: sinon.stub(),
+		},
+		api: {
+			broadcast: sinon.stub(),
+		},
+		Invites: {
+			findOneById: sinon.stub(),
+		},
+		callbacks: {
+			run: sinon.stub(),
+			runAsync: sinon.stub(),
+		},
+		checkUsernameAvailability: sinon.stub(),
+		validateUsername: sinon.stub(),
+		saveUserIdentity: sinon.stub(),
+		joinDefaultChannels: sinon.stub(),
+		getAvatarSuggestionForUser: sinon.stub(),
+		setUserAvatar: sinon.stub(),
+		addUserToRoom: sinon.stub(),
+		notifyOnUserChange: sinon.stub(),
+		underscore: {
+			escape: sinon.stub(),
+		},
+		SystemLogger: sinon.stub(),
+	};
+
+	const { setUsernameWithValidation, _setUsername } = proxyquire.noCallThru().load('../../../../../server/lib/users/setUsername', {
+		'../../database/utils': { onceTransactionCommitedSuccessfully: async (cb: any, _sess: any) => cb() },
+		'meteor/meteor': { Meteor: { Error } },
+		'@rocket.chat/core-services': { api: stubs.api },
+		'@rocket.chat/models': { Users: stubs.Users, Invites: stubs.Invites, Subscriptions: stubs.Subscriptions },
+		'meteor/accounts-base': { Accounts: stubs.Accounts },
+		'underscore': stubs.underscore,
+		'../../settings': { settings: stubs.settings },
+		'../notifyListener': { notifyOnUserChange: stubs.notifyOnUserChange },
+		'../rooms/addUserToRoom': { addUserToRoom: stubs.addUserToRoom },
+		'./checkUsernameAvailability': { checkUsernameAvailability: stubs.checkUsernameAvailability },
+		'./getAvatarSuggestionForUser': { getAvatarSuggestionForUser: stubs.getAvatarSuggestionForUser },
+		'../rooms/joinDefaultChannels': { joinDefaultChannels: stubs.joinDefaultChannels },
+		'./saveUserIdentity': { saveUserIdentity: stubs.saveUserIdentity },
+		'./setUserAvatar': { setUserAvatar: stubs.setUserAvatar },
+		'./validateUsername': { validateUsername: stubs.validateUsername },
+		'../callbacks': { callbacks: stubs.callbacks },
+		'../logger/system': { SystemLogger: stubs.SystemLogger },
+	});
+
+	beforeEach(() => {
+		stubs.Subscriptions.findUserFederatedRoomIds.returns({
+			hasNext: sinon.stub().resolves(false),
+			close: sinon.stub().resolves(),
+		});
+	});
+
+	afterEach(() => {
+		stubs.Users.findOneById.reset();
+		stubs.Users.setUsername.reset();
+		stubs.Subscriptions.findUserFederatedRoomIds.reset();
+		stubs.Accounts.sendEnrollmentEmail.reset();
+		stubs.settings.get.reset();
+		stubs.api.broadcast.reset();
+		stubs.Invites.findOneById.reset();
+		stubs.callbacks.run.reset();
+		stubs.callbacks.runAsync.reset();
+		stubs.checkUsernameAvailability.reset();
+		stubs.validateUsername.reset();
+		stubs.saveUserIdentity.reset();
+		stubs.joinDefaultChannels.reset();
+		stubs.getAvatarSuggestionForUser.reset();
+		stubs.setUserAvatar.reset();
+		stubs.addUserToRoom.reset();
+		stubs.notifyOnUserChange.reset();
+		stubs.underscore.escape.reset();
+		stubs.SystemLogger.reset();
+	});
+
+	describe('setUsernameWithValidation', () => {
+		it('should throw an error if username is invalid', async () => {
+			try {
+				await setUsernameWithValidation(userId, '');
+			} catch (error: any) {
+				expect(error.message).to.equal('error-invalid-username');
+			}
+		});
+
+		it('should throw an error if user is not found', async () => {
+			stubs.Users.findOneById.withArgs(userId).returns(null);
+
+			try {
+				await setUsernameWithValidation(userId, username);
+			} catch (error: any) {
+				expect(stubs.Users.findOneById.calledOnce).to.be.true;
+				expect(error.message).to.equal('error-invalid-user');
+			}
+		});
+
+		it('should throw an error if username change is not allowed', async () => {
+			stubs.Users.findOneById.resolves({ username: 'oldUsername' });
+			stubs.settings.get.withArgs('Accounts_AllowUsernameChange').returns(false);
+
+			try {
+				await setUsernameWithValidation(userId, username);
+			} catch (error: any) {
+				expect(stubs.settings.get.calledOnce).to.be.true;
+				expect(error.message).to.equal('error-not-allowed');
+			}
+		});
+
+		it('should throw an error if username is not valid', async () => {
+			stubs.Users.findOneById.resolves({ username: null });
+			stubs.validateUsername.returns(false);
+
+			try {
+				await setUsernameWithValidation(userId, 'invalid-username');
+			} catch (error: any) {
+				expect(stubs.validateUsername.calledOnce).to.be.true;
+				expect(error.message).to.equal('username-invalid');
+			}
+		});
+
+		it('should throw an error if username is already in use', async () => {
+			stubs.Users.findOneById.resolves({ username: null });
+			stubs.validateUsername.returns(true);
+			stubs.checkUsernameAvailability.resolves(false);
+
+			try {
+				await setUsernameWithValidation(userId, 'existingUsername');
+			} catch (error: any) {
+				expect(stubs.checkUsernameAvailability.calledOnce).to.be.true;
+				expect(error.message).to.equal('error-field-unavailable');
+			}
+		});
+
+		it('should throw an error if local user is in federated rooms', async () => {
+			stubs.Users.findOneById.resolves({ _id: userId, username: null });
+			stubs.validateUsername.returns(true);
+			stubs.checkUsernameAvailability.resolves(true);
+			stubs.Subscriptions.findUserFederatedRoomIds.returns({
+				hasNext: sinon.stub().resolves(true),
+				close: sinon.stub().resolves(),
+			});
+
+			try {
+				await setUsernameWithValidation(userId, 'newUsername');
+			} catch (error: any) {
+				expect(stubs.Subscriptions.findUserFederatedRoomIds.calledOnce).to.be.true;
+				expect(error.message).to.equal('error-not-allowed');
+			}
+		});
+
+		it('should throw an error if user is federated', async () => {
+			stubs.Users.findOneById.resolves({
+				_id: userId,
+				username: null,
+				federated: true,
+				federation: { version: 1, mui: '@user:origin', origin: 'origin' },
+			});
+			stubs.validateUsername.returns(true);
+			stubs.checkUsernameAvailability.resolves(true);
+
+			try {
+				await setUsernameWithValidation(userId, 'newUsername');
+			} catch (error: any) {
+				expect(stubs.Subscriptions.findUserFederatedRoomIds.notCalled).to.be.true;
+				expect(error.message).to.equal('error-not-allowed');
+			}
+		});
+
+		it('should save the user identity when valid username is set', async () => {
+			stubs.Users.findOneById.resolves({ _id: userId, username: null });
+			stubs.settings.get.withArgs('Accounts_AllowUsernameChange').returns(true);
+			stubs.validateUsername.returns(true);
+			stubs.checkUsernameAvailability.resolves(true);
+			stubs.saveUserIdentity.resolves(true);
+
+			await setUsernameWithValidation(userId, 'newUsername');
+
+			expect(stubs.saveUserIdentity.calledOnce).to.be.true;
+		});
+	});
+
+	describe('_setUsername', () => {
+		it('should return false if userId or username is missing', async () => {
+			const result = await _setUsername(null, '', {});
+			expect(result).to.be.false;
+		});
+
+		it('should return false if username is invalid', async () => {
+			stubs.validateUsername.returns(false);
+
+			const result = await _setUsername(userId, 'invalid-username', {});
+			expect(result).to.be.false;
+		});
+
+		it('should return user if username is already set', async () => {
+			stubs.validateUsername.returns(true);
+			const mockUser = { username };
+
+			const result = await _setUsername(userId, username, mockUser);
+			expect(result).to.equal(mockUser);
+		});
+
+		it('should set username when user has no previous username', async () => {
+			const mockUser = { _id: userId, emails: [{ address: 'test@example.com' }] };
+			stubs.validateUsername.returns(true);
+			stubs.Users.findOneById.resolves(mockUser);
+			stubs.checkUsernameAvailability.resolves(true);
+
+			await _setUsername(userId, username, mockUser);
+
+			expect(stubs.Users.setUsername.calledOnceWith(userId, username));
+			expect(stubs.checkUsernameAvailability.calledOnceWith(username));
+			expect(stubs.api.broadcast.calledOnceWith('user.autoupdate', { user: mockUser }));
+		});
+
+		it('should set username when user has and old that is different from new', async () => {
+			const mockUser = { _id: userId, username: 'oldUsername', emails: [{ address: 'test@example.com' }] };
+			stubs.validateUsername.returns(true);
+			stubs.Users.findOneById.resolves(mockUser);
+			stubs.checkUsernameAvailability.resolves(true);
+
+			await _setUsername(userId, username, mockUser);
+
+			expect(stubs.Users.setUsername.calledOnceWith(userId, username));
+			expect(stubs.checkUsernameAvailability.calledOnceWith(username));
+			expect(stubs.api.broadcast.calledOnceWith('user.autoupdate', { user: mockUser }));
+		});
+
+		it('should set username when user has and old that is different from new', async () => {
+			const mockUser = { _id: userId, username: 'oldUsername', emails: [{ address: 'test@example.com' }] };
+			stubs.validateUsername.returns(true);
+			stubs.Users.findOneById.resolves(mockUser);
+			stubs.checkUsernameAvailability.resolves(true);
+
+			await _setUsername(userId, username, mockUser);
+
+			expect(stubs.Users.setUsername.calledOnceWith(userId, username));
+			expect(stubs.checkUsernameAvailability.calledOnceWith(username));
+			expect(stubs.api.broadcast.calledOnceWith('user.autoupdate', { user: mockUser }));
+		});
+
+		it('should join the default channels and run afterCreateUser on the first username', async () => {
+			const mockUser = { _id: userId, roles: ['user'] };
+			stubs.validateUsername.returns(true);
+			stubs.checkUsernameAvailability.resolves(true);
+
+			await _setUsername(userId, username, mockUser);
+
+			expect(stubs.joinDefaultChannels.calledOnceWith(userId)).to.be.true;
+			expect(stubs.callbacks.runAsync.calledWith('afterCreateUser')).to.be.true;
+			expect(stubs.callbacks.runAsync.withArgs('afterCreateUser').firstCall.args[1]).to.include({ username });
+		});
+
+		it('should not join the default channels when the username is only being changed', async () => {
+			const mockUser = { _id: userId, username: 'oldUsername', roles: ['user'] };
+			stubs.validateUsername.returns(true);
+			stubs.checkUsernameAvailability.resolves(true);
+
+			await _setUsername(userId, username, mockUser);
+
+			expect(stubs.joinDefaultChannels.notCalled).to.be.true;
+			expect(stubs.callbacks.runAsync.calledWith('afterCreateUser')).to.be.false;
+		});
+
+		it('should set avatar if Accounts_SetDefaultAvatar is enabled', async () => {
+			const mockUser = { _id: userId, username: null };
+			stubs.validateUsername.returns(true);
+			stubs.Users.findOneById.resolves(mockUser);
+			stubs.checkUsernameAvailability.resolves(true);
+			stubs.settings.get.withArgs('Accounts_SetDefaultAvatar').returns(true);
+			stubs.getAvatarSuggestionForUser.resolves({ gravatar: { blob: 'blobData', contentType: 'image/png' } });
+
+			await _setUsername(userId, username, mockUser);
+
+			expect(stubs.setUserAvatar.calledOnceWith(mockUser, 'blobData', 'image/png', 'gravatar')).to.be.true;
+		});
+
+		it('should not set avatar if Accounts_SetDefaultAvatar is disabled', async () => {
+			const mockUser = { _id: userId, username: null };
+			stubs.validateUsername.returns(true);
+			stubs.Users.findOneById.resolves(mockUser);
+			stubs.checkUsernameAvailability.resolves(true);
+			stubs.settings.get.withArgs('Accounts_SetDefaultAvatar').returns(false);
+
+			await _setUsername(userId, username, mockUser);
+
+			expect(stubs.setUserAvatar.called).to.be.false;
+		});
+
+		it('should not set avatar if no avatar suggestions are available', async () => {
+			const mockUser = { _id: userId, username: null };
+			stubs.validateUsername.returns(true);
+			stubs.Users.findOneById.resolves(mockUser);
+			stubs.checkUsernameAvailability.resolves(true);
+			stubs.settings.get.withArgs('Accounts_SetDefaultAvatar').returns(true);
+			stubs.getAvatarSuggestionForUser.resolves({});
+
+			await _setUsername(userId, username, mockUser);
+
+			expect(stubs.setUserAvatar.called).to.be.false;
+		});
+
+		it('should add user to room if inviteToken is present', async () => {
+			const mockUser = { _id: userId, username: null, inviteToken: 'invite token' };
+			stubs.validateUsername.returns(true);
+			stubs.Users.findOneById.resolves(mockUser);
+			stubs.checkUsernameAvailability.resolves(true);
+			stubs.settings.get.withArgs('Accounts_SetDefaultAvatar').returns(true);
+			stubs.getAvatarSuggestionForUser.resolves({ gravatar: { blob: 'blobData', contentType: 'image/png' } });
+			stubs.Invites.findOneById.resolves({ rid: 'room id' });
+
+			await _setUsername(userId, username, mockUser);
+
+			expect(stubs.addUserToRoom.calledOnceWith('room id', mockUser)).to.be.true;
+		});
+	});
+});