Add an icon for bot messages. Closes #1172 (#1729)

controllers/admin/chat.go

@@ -235,6 +235,7 @@ func SendIntegrationChatMessage(integration user.ExternalAPIUser, w http.Respons
 		DisplayName:  name,
 		DisplayColor: integration.DisplayColor,
 		CreatedAt:    integration.CreatedAt,
+		IsBot:        true,
 	}
 
 	if err := chat.Broadcast(&event); err != nil {

core/chat/persistence.go

@@ -99,6 +99,9 @@ func makeUserMessageEventFromRowData(row rowData) events.UserMessageEvent {
 		createdAt = *row.userCreatedAt
 	}
 
+	isBot := (row.userType != nil && *row.userType == "API")
+	scopeSlice := strings.Split(scopes, ",")
+
 	u := user.User{
 		ID:            *row.userID,
 		AccessToken:   "",
@@ -108,7 +111,8 @@ func makeUserMessageEventFromRowData(row rowData) events.UserMessageEvent {
 		DisabledAt:    row.userDisabledAt,
 		NameChangedAt: row.userNameChangedAt,
 		PreviousNames: previousUsernames,
-		Scopes:        strings.Split(scopes, ","),
+		Scopes:        scopeSlice,
+		IsBot:         isBot,
 	}
 
 	message := events.UserMessageEvent{
@@ -197,6 +201,7 @@ type rowData struct {
 	previousUsernames *string
 	userNameChangedAt *time.Time
 	userScopes        *string
+	userType          *string
 }
 
 func getChat(query string) []interface{} {
@@ -230,6 +235,7 @@ func getChat(query string) []interface{} {
 			&row.previousUsernames,
 			&row.userNameChangedAt,
 			&row.userScopes,
+			&row.userType,
 		); err != nil {
 			log.Errorln("There is a problem converting query to chat objects. Please report this:", query)
 			break
@@ -267,7 +273,7 @@ func GetChatModerationHistory() []interface{} {
 	}
 
 	// Get all messages regardless of visibility
-	query := "SELECT messages.id, user_id, body, title, subtitle, image, link, eventType, hidden_at, timestamp, display_name, display_color, created_at, disabled_at, previous_names, namechanged_at, scopes FROM messages INNER JOIN users ON messages.user_id = users.id ORDER BY timestamp DESC"
+	query := "SELECT messages.id, user_id, body, title, subtitle, image, link, eventType, hidden_at, timestamp, display_name, display_color, created_at, disabled_at, previous_names, namechanged_at, scopes, users.type FROM messages INNER JOIN users ON messages.user_id = users.id ORDER BY timestamp DESC"
 	result := getChat(query)
 
 	_historyCache = &result
@@ -278,7 +284,7 @@ func GetChatModerationHistory() []interface{} {
 // GetChatHistory will return all the chat messages suitable for returning as user-facing chat history.
 func GetChatHistory() []interface{} {
 	// Get all visible messages
-	query := fmt.Sprintf("SELECT messages.id,messages.user_id, messages.body, messages.title, messages.subtitle, messages.image, messages.link, messages.eventType, messages.hidden_at, messages.timestamp, users.display_name, users.display_color, users.created_at, users.disabled_at, users.previous_names, users.namechanged_at, users.scopes FROM messages LEFT JOIN users ON messages.user_id = users.id WHERE hidden_at IS NULL AND disabled_at IS NULL ORDER BY timestamp DESC LIMIT %d", maxBacklogNumber)
+	query := fmt.Sprintf("SELECT messages.id,messages.user_id, messages.body, messages.title, messages.subtitle, messages.image, messages.link, messages.eventType, messages.hidden_at, messages.timestamp, users.display_name, users.display_color, users.created_at, users.disabled_at, users.previous_names, users.namechanged_at, users.scopes, users.type FROM messages LEFT JOIN users ON messages.user_id = users.id WHERE hidden_at IS NULL AND disabled_at IS NULL ORDER BY timestamp DESC LIMIT %d", maxBacklogNumber)
 	m := getChat(query)
 
 	// Invert order of messages
@@ -298,7 +304,7 @@ func SetMessageVisibilityForUserID(userID string, visible bool) error {
 
 	// Get a list of IDs to send to the connected clients to hide
 	ids := make([]string, 0)
-	query := fmt.Sprintf("SELECT messages.id, user_id, body, title, subtitle, image, link, eventType, hidden_at, timestamp, display_name, display_color, created_at, disabled_at,  previous_names, namechanged_at, scopes FROM messages INNER JOIN users ON messages.user_id = users.id WHERE user_id IS '%s'", userID)
+	query := fmt.Sprintf("SELECT messages.id, user_id, body, title, subtitle, image, link, eventType, hidden_at, timestamp, display_name, display_color, created_at, disabled_at,  previous_names, namechanged_at, scopes, type FROM messages INNER JOIN users ON messages.user_id = users.id WHERE user_id IS '%s'", userID)
 	messages := getChat(query)
 
 	if len(messages) == 0 {

core/user/externalAPIUser.go

@@ -22,6 +22,7 @@ type ExternalAPIUser struct {
 	Scopes       []string   `json:"scopes"`
 	Type         string     `json:"type,omitempty"` // Should be API
 	LastUsedAt   *time.Time `json:"lastUsedAt,omitempty"`
+	IsBot        bool       `json:"isBot"`
 }
 
 const (
@@ -240,6 +241,7 @@ func makeExternalAPIUsersFromRows(rows *sql.Rows) ([]ExternalAPIUser, error) {
 			CreatedAt:    createdAt,
 			Scopes:       strings.Split(scopes, ","),
 			LastUsedAt:   lastUsedAt,
+			IsBot:        true,
 		}
 		integrations = append(integrations, integration)
 	}

core/user/user.go

@@ -16,8 +16,10 @@ import (
 
 var _datastore *data.Datastore
 
-const moderatorScopeKey = "MODERATOR"
-const minSuggestedUsernamePoolLength = 10
+const (
+	moderatorScopeKey              = "MODERATOR"
+	minSuggestedUsernamePoolLength = 10
+)
 
 // User represents a single chat user.
 type User struct {
@@ -29,7 +31,8 @@ type User struct {
 	DisabledAt    *time.Time `json:"disabledAt,omitempty"`
 	PreviousNames []string   `json:"previousNames"`
 	NameChangedAt *time.Time `json:"nameChangedAt,omitempty"`
-	Scopes        []string   `json:"scopes"`
+	Scopes        []string   `json:"scopes,omitempty"`
+	IsBot         bool       `json:"isBot"`
 }
 
 // IsEnabled will return if this single user is enabled.

test/automated/api/integrations.test.js

@@ -129,7 +129,6 @@ test('test fetch chat history using access token', async (done) => {
   done();
 });
 
-
 test('test fetch chat history failure using invalid access token', async (done) => {
   const res = await request
     .get('/api/integrations/chat')

webroot/js/components/chat/chat-message-view.js

@@ -51,7 +51,7 @@ export default class ChatMessageView extends Component {
       return null;
     }
 
-    const { displayName, displayColor, createdAt } = user;
+    const { displayName, displayColor, createdAt, isBot } = user;
     const isAuthorModerator = checkIsModerator(message);
 
     const isMessageModeratable =
@@ -88,6 +88,15 @@ export default class ChatMessageView extends Component {
         />`
       : null;
 
+    const isBotFlair = isBot
+      ? html`<img
+          title="Bot"
+          class="inline-block mr-1 w-4 h-4 relative"
+          style=${{ bottom: '1px' }}
+          src="/img/bot.svg"
+        />`
+      : null;
+
     return html`
       <div
         style=${backgroundStyle}
@@ -100,7 +109,7 @@ export default class ChatMessageView extends Component {
             class="message-author font-bold"
             title=${userMetadata}
           >
-            ${messageAuthorFlair} ${displayName}
+            ${isBotFlair} ${messageAuthorFlair} ${displayName}
           </div>
           ${isMessageModeratable &&
           html`<${ModeratorActions}

webroot/js/components/chat/message.js

@@ -99,7 +99,7 @@ export default function Message(props) {
     `;
     return html`<${SystemMessage} contents=${contents} />`;
   } else if (type === SOCKET_MESSAGE_TYPES.USER_JOINED) {
-    const { displayName } = user;
+    const { displayName, isBot } = user;
     const isAuthorModerator = checkIsModerator(message);
     const messageAuthorFlair = isAuthorModerator
       ? html`<img
@@ -108,6 +108,7 @@ export default function Message(props) {
           src="/img/moderator-nobackground.svg"
         />`
       : null;
+
     const contents = html`<div>
       <span class="font-bold">${messageAuthorFlair}${displayName}</span>
       ${' '}joined the chat.