Use real name instead of username for messages and direct messages list by alexbrazier · Pull Request #3851 · RocketChat/Rocket.Chat

alexbrazier · 2016-07-23T18:57:24Z

@RocketChat/core

Closes #1209
Closes #3453
Closes #3649

Use real name in most places, instead of username

Restore @ icon
Update messages when user changes name
Setting to turn on and off
Database migration

Changes

Change direct message list to use full name
Change messages in channels to show full name
Change members list to show full name
Change mention so it also searches for full name
Admin setting to turn on and off

…ure/display-name

graywolf336 · 2016-07-27T20:05:24Z

I can not speak for the rest of the team, but I believe the direct message icon should stay an ampersand sign @. Also, some installations of Rocket.Chat would prefer that the name is not used and would rather have the usernames (such as gaming servers), so an option to turn this on and off is preferred. Last but not least, what are the performances consequences for this, if any?

alexbrazier · 2016-07-27T21:41:59Z

@graywolf336: I think I actually agree with you about the @ sign, I don't think the dot looks right.

I think I will add an option to turn this on and off, as it is quite a big change, and as you say, not everyone will want it.

In terms of performance, there is no impact on speed, there is a small storage impact, as the username as well as the name is stored within the user object for messages. I feel that this impact is relatively small, and I opted for this rather than a speed impact (i.e. making more mongo queries). This also appears to be the technique recommended by mongodb, which is to store the data as you are going to use it, rather than make more requests.

rodrigok · 2016-08-02T23:30:00Z

@alexbrazier if you move back to @, add an option to select if users want to see usernames or names and update all messages when users change their names I will be happy to merge this PR 😄

alexbrazier · 2016-08-03T12:08:27Z

@rodrigok I will try to make those changes in the next few days. One of the tasks I set was to create a database migration to add the name to the database for old messages ... should I still do that, or do you think it is ok for old messages to show the username and the new ones to show the full name?

rodrigok · 2016-08-03T12:34:02Z

@alexbrazier I prefer to have the migration.

alexbrazier · 2016-08-05T20:54:55Z

@rodrigok I might need some help with the migration. I need to update all messages to add the name field to the user object, and I need to update the subscriptions for direct messages and set the other users name as the fname.

To do this we need to request all users and make the updates. I imagine this would be quite a lot of info to request all at once so it would have to be limited.
Is there a Meteor way to go about this, or a way it has been done before?

alexbrazier · 2016-09-11T20:19:39Z

I think this is done, except for the migration. @rodrigok Could I get some input on the database migration as for a large server it will have to get all the user full names and usernames and add them to the messages. Is there a good way of doing this?

rodrigok · 2017-04-01T20:12:53Z

 		};

+		if (crowdUser.displayname) {
+			RocketChat._setRealName(user._id, crowdUser.displayname);


user._id is not defined right?

Changed to id which is defined in the function params

rodrigok · 2017-04-01T20:16:48Z

@@ -0,0 +1,24 @@
+RocketChat._setRealName = (userId, name) ->


Can we convert to JS?

And, why not inside the user's model?

It's how setUsername is done, so I just copied that. I think its because it has to make more requests to other models, so it's not self contained within one model.

rodrigok · 2017-04-01T20:26:25Z

 	roomName(roomData) {
-		const room = ChatSubscription.findOne({ rid: roomData._id }, { fields: { name: 1 } });
-		return room && room.name;
+		return ChatSubscription.findOne({ rid: roomData._id }, { fields: { name: 1, fname: 1 } });


What happens when room is undefined?

roomData or the returned result of ChatSubscription? Is there a case where it might be undefined?

Probably will not happen

rodrigok · 2017-04-01T20:27:39Z

@@ -0,0 +1,170 @@
+Template.membersList.helpers


This file was converted to JS, can you delete?

rodrigok · 2017-04-01T20:35:50Z


 		const map = (record) => {
-			return record._user.username;
+			return {


This is an API change, can you describe on HISTORY.md that will change from an array of strings to an array of objects?

rodrigok · 2017-04-01T20:39:11Z

@@ -0,0 +1,72 @@
+Template.accountBox.helpers


This file was converted, can you delete?

rodrigok · 2017-04-01T20:40:02Z

@@ -0,0 +1,125 @@
+Template.chatRoomItem.helpers


This file was converted, can you delete?

rodrigok · 2017-04-01T20:53:49Z

What about users without name? We have more than 500 users without name in our demo.

Almost all came from linkedin OAuth, we need to fix that

alexbrazier · 2017-04-01T21:06:48Z

+	},
+	displayName() {
+		if (RocketChat.settings.get('UI_Use_Real_Name')) {
+			return this.user.name;


Fallback to username if name doesn't exist

alexbrazier · 2017-04-01T21:12:15Z

 				<div class="info">
-					<h3 title="{{username}}"><i class="status-{{status}}"></i> {{username}}</h3>
-					<p class="secondary-font-color">{{name}}</p>
+					<h3 title="{{name}}"><i class="status-{{status}}"></i> {{name}}</h3>


Handle case where no name

Handled in js (if no name then returns Unnamed)

alexbrazier · 2017-04-01T21:14:17Z

 					</div>
 					<div class="data">
-						<h4>{{username}}</h4>
+						<h4 data-username="{{username}}">{{fname}}</h4>


Handle case when no name set

alexbrazier · 2017-04-01T21:15:43Z

@rodrigok Thanks for reviewing.

I didn't realise that you could register without a name. As it is currently I think it would just set the name field in the messages to undefined, and in most cases it will fallback to using the username, but I have left a couple of comments where this needs to be fixed.

rodrigok · 2017-04-01T21:29:41Z

@alexbrazier In this particular case it's a bug, but you can turn off the name requirement for registration.

alexbrazier

@rodrigok I have made the changes requested. Is there anything else that needs to be done?

alexbrazier · 2017-04-01T22:26:09Z

@@ -0,0 +1,24 @@
+RocketChat._setRealName = (userId, name) ->


It's how setUsername is done, so I just copied that. I think its because it has to make more requests to other models, so it's not self contained within one model.

alexbrazier · 2017-04-01T22:26:48Z

 		};

+		if (crowdUser.displayname) {
+			RocketChat._setRealName(user._id, crowdUser.displayname);


Changed to id which is defined in the function params

alexbrazier · 2017-04-01T22:31:39Z

@@ -0,0 +1,170 @@
+Template.membersList.helpers


alexbrazier · 2017-04-01T22:32:47Z

+	},
+	displayName() {
+		if (RocketChat.settings.get('UI_Use_Real_Name')) {
+			return this.user.name;


alexbrazier · 2017-04-01T22:34:53Z

 				<div class="info">
-					<h3 title="{{username}}"><i class="status-{{status}}"></i> {{username}}</h3>
-					<p class="secondary-font-color">{{name}}</p>
+					<h3 title="{{name}}"><i class="status-{{status}}"></i> {{name}}</h3>


Handled in js (if no name then returns Unnamed)

alexbrazier · 2017-04-01T22:35:06Z

@@ -0,0 +1,72 @@
+Template.accountBox.helpers


alexbrazier · 2017-04-01T22:35:52Z

@@ -0,0 +1,125 @@
+Template.chatRoomItem.helpers


alexbrazier · 2017-04-01T22:46:32Z


 		const map = (record) => {
-			return record._user.username;
+			return {


alexbrazier · 2017-04-01T22:49:40Z

 	roomName(roomData) {
-		const room = ChatSubscription.findOne({ rid: roomData._id }, { fields: { name: 1 } });
-		return room && room.name;
+		return ChatSubscription.findOne({ rid: roomData._id }, { fields: { name: 1, fname: 1 } });


roomData or the returned result of ChatSubscription? Is there a case where it might be undefined?

subesokun · 2017-04-05T19:31:15Z

Awesome, thanks a lot! Looking very much forward for this feature to be shipped :) @alexbrazier, great job!

danpospisil · 2017-04-07T15:00:04Z

Thanks guys!!!

alexmsierra · 2017-04-07T15:06:14Z

Huge thank you. Awaiting this for a long time.

kushlces · 2017-04-10T16:28:57Z

Seriously! Massive thanks!!!!!

pH142857 · 2018-04-12T10:02:19Z

Hi, I'm new to the Github interface but I can see that the last action on this PR was a year ago, yet it is still marked as "ready to be merged" in the labels and I still don't see names displayed in the conversations and lists on Rocket Chat (only usernames). Anyone cares to tell me what's going on?

givisok · 2018-04-12T13:02:09Z

@pH142857 Hi. Usernames shows in conversation. That pull request was already merged.

mddvul22 · 2018-04-12T13:02:16Z

@pH142857 Have you set "Use Real Name" to "True" in the "User Interface" section of the Layout Admin settings?

pH142857 · 2018-04-12T13:23:08Z

Oh I thought it was supposed to be the default behaviour, and I also thought there would be another label than "ready to be merge" to signify the merge. I checked the option and it now works, thanks to both of you, that was quick ! :)

alexbrazier added 5 commits June 14, 2016 22:08

Start changing usernames to actual names

b30d63b

Merge branch 'develop' into feature/display-name

eec5ea8

Merge branch 'develop' of github.com:RocketChat/Rocket.Chat into feat…

29f9ceb

…ure/display-name

More changes to use actual names instead of usernames

d8a2682

Fix linting error

2c1d6e5

rodrigok added the stat: waiting response label Aug 3, 2016

rodrigok added stat: in progress and removed stat: waiting response labels Aug 3, 2016

alexbrazier added 3 commits August 4, 2016 21:51

Restore @ icon for direct messages

b7a6bc8

Merge remote-tracking branch 'origin' into feature/display-name

5377d89

Update messages and subscriptions on name change

553ab70

bhbarbosa mentioned this pull request Sep 6, 2016

Improvements regarding display of username #4210

Closed

4 tasks

alexbrazier added 5 commits September 8, 2016 22:15

Merge branch 'develop' into feature/display-name

9472a6b

Fix issues caused by merge

1d3c9c9

Add setting to use real name

fed2c79

Merge branch 'develop' into feature/display-name

12e0606

Show real name in spotlight search

5720b9e

alexbrazier added 6 commits September 13, 2016 22:45

Merge branch 'develop' into feature/display-name

2d0570a

Add migration to add user name to messages

c436466

Improve messages migration

f7c6cf3

Update subscriptions in migration

14e388c

Improve subscriptions

51f65d9

Merge branch 'develop' into feature/display-name

bc4200e

rodrigok requested changes Apr 1, 2017

View reviewed changes

alexbrazier commented Apr 1, 2017

View reviewed changes

alexbrazier added 2 commits April 1, 2017 23:39

Merge branch 'develop' into feature/display-name

1d7c70e

PR changes/fixes

18fd157

alexbrazier commented Apr 1, 2017

View reviewed changes

rodrigok approved these changes Apr 3, 2017

View reviewed changes

rodrigok added Ready to Merge and removed stat: in progress labels Apr 3, 2017

Update getUsersOfRoom.js

cf6f43b

rodrigok modified the milestones: 0.55.0, Short-term Apr 3, 2017

engelgabriel merged commit 890c4a2 into RocketChat:develop Apr 4, 2017

sampaiodiego mentioned this pull request Apr 4, 2017

Move room display name logic to roomType definition #6585

Merged

engelgabriel mentioned this pull request Apr 6, 2017

#324 Add Option to Show Full Names in Channel User List #6173

Closed

engelgabriel mentioned this pull request Apr 13, 2017

Creating New DM Issue - Cannot search users by First Name for new Direct Messages since V 0.51.0 - still present up to current version 0.54.2 #6006

Closed

This was referenced Apr 18, 2017

[NEW] Show full name in mentions if use full name setting enabled #6690

Merged

Usernames are still being displayed with use real name setting enabled #6725

Closed

[FIX] Sort by real name if use real name setting is enabled #6758

Merged

Conversation

alexbrazier commented Jul 23, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Uh oh!

graywolf336 commented Jul 27, 2016

Uh oh!

alexbrazier commented Jul 27, 2016

Uh oh!

rodrigok commented Aug 2, 2016

Uh oh!

alexbrazier commented Aug 3, 2016

Uh oh!

rodrigok commented Aug 3, 2016

Uh oh!

alexbrazier commented Aug 5, 2016

Uh oh!

alexbrazier commented Sep 11, 2016

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rodrigok commented Apr 1, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

alexbrazier commented Apr 1, 2017

Uh oh!

rodrigok commented Apr 1, 2017

Uh oh!

alexbrazier left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

alexbrazier commented Jul 23, 2016 •

edited

Loading