From ee05f57e2d676772a1df85be322e44611d13e7da Mon Sep 17 00:00:00 2001 From: Mark VanLandingham Date: Thu, 7 Dec 2023 11:30:44 -0600 Subject: [PATCH] FEATURE: Site setting to display user avatars in user menu (#24514) --- .../components/user-menu/bookmarks-list.js | 6 ++- .../app/components/user-menu/icon-avatar.gjs | 12 ++++++ .../app/components/user-menu/menu-item.hbs | 6 ++- .../app/components/user-menu/menu-item.js | 8 ++++ .../app/components/user-menu/menu.hbs | 2 +- .../app/components/user-menu/menu.js | 8 ++++ .../app/components/user-menu/messages-list.js | 18 ++++++++- .../discourse/app/lib/user-menu/base-item.js | 19 ++++++++++ .../app/lib/user-menu/bookmark-item.js | 4 ++ .../app/lib/user-menu/message-item.js | 4 ++ .../app/lib/user-menu/notification-item.js | 4 ++ .../tests/acceptance/user-menu-test.js | 33 +++++++++++++++++ .../tests/fixtures/notification-fixtures.js | 6 +++ .../discourse/tests/fixtures/user-menu.js | 6 +++ .../components/user-menu/menu-item-test.js | 31 ++++++++++++---- .../stylesheets/common/base/menu-panel.scss | 37 +++++++++++++++++++ app/controllers/notifications_controller.rb | 4 ++ app/controllers/users_controller.rb | 13 +++++++ app/models/notification.rb | 22 +++++++++++ app/serializers/notification_serializer.rb | 11 +++++- app/serializers/site_serializer.rb | 9 +++++ config/locales/server.en.yml | 1 + config/site_settings.yml | 4 +- spec/models/notification_spec.rb | 30 +++++++++++++++ .../requests/notifications_controller_spec.rb | 19 +++++++++- spec/requests/users_controller_spec.rb | 12 ++++++ 26 files changed, 314 insertions(+), 15 deletions(-) create mode 100644 app/assets/javascripts/discourse/app/components/user-menu/icon-avatar.gjs diff --git a/app/assets/javascripts/discourse/app/components/user-menu/bookmarks-list.js b/app/assets/javascripts/discourse/app/components/user-menu/bookmarks-list.js index 0fbdde106d8..50878aa5fcf 100644 --- a/app/assets/javascripts/discourse/app/components/user-menu/bookmarks-list.js +++ b/app/assets/javascripts/discourse/app/components/user-menu/bookmarks-list.js @@ -73,7 +73,11 @@ export default class UserMenuBookmarksList extends UserMenuNotificationsList { await Bookmark.applyTransformations(bookmarks); content.push( ...bookmarks.map((bookmark) => { - return new UserMenuBookmarkItem({ bookmark }); + return new UserMenuBookmarkItem({ + bookmark, + siteSettings: this.siteSettings, + site: this.site, + }); }) ); diff --git a/app/assets/javascripts/discourse/app/components/user-menu/icon-avatar.gjs b/app/assets/javascripts/discourse/app/components/user-menu/icon-avatar.gjs new file mode 100644 index 00000000000..599d36443f7 --- /dev/null +++ b/app/assets/javascripts/discourse/app/components/user-menu/icon-avatar.gjs @@ -0,0 +1,12 @@ +import Component from "@glimmer/component"; +import avatar from "discourse/helpers/bound-avatar-template"; +import dIcon from "discourse-common/helpers/d-icon"; + +export default class IconAvatar extends Component { + +} diff --git a/app/assets/javascripts/discourse/app/components/user-menu/menu-item.hbs b/app/assets/javascripts/discourse/app/components/user-menu/menu-item.hbs index 53021381291..bd3ca7038c4 100644 --- a/app/assets/javascripts/discourse/app/components/user-menu/menu-item.hbs +++ b/app/assets/javascripts/discourse/app/components/user-menu/menu-item.hbs @@ -4,7 +4,11 @@ title={{this.linkTitle}} {{on "click" this.onClick}} > - {{d-icon this.icon}} + {{#if this.iconComponent}} + + {{else}} + {{d-icon this.icon}} + {{/if}}
{{#if this.label}} diff --git a/app/assets/javascripts/discourse/app/components/user-menu/menu-item.js b/app/assets/javascripts/discourse/app/components/user-menu/menu-item.js index 4dace94b2d3..b6a728fc70d 100644 --- a/app/assets/javascripts/discourse/app/components/user-menu/menu-item.js +++ b/app/assets/javascripts/discourse/app/components/user-menu/menu-item.js @@ -49,6 +49,14 @@ export default class UserMenuItem extends Component { return this.#item.topicId; } + get iconComponent() { + return this.#item.iconComponent; + } + + get iconComponentArgs() { + return this.#item.iconComponentArgs; + } + get #item() { return this.args.item; } diff --git a/app/assets/javascripts/discourse/app/components/user-menu/menu.hbs b/app/assets/javascripts/discourse/app/components/user-menu/menu.hbs index 25efaa7a1cc..7f55f10dd5d 100644 --- a/app/assets/javascripts/discourse/app/components/user-menu/menu.hbs +++ b/app/assets/javascripts/discourse/app/components/user-menu/menu.hbs @@ -1,5 +1,5 @@
diff --git a/app/assets/javascripts/discourse/app/components/user-menu/menu.js b/app/assets/javascripts/discourse/app/components/user-menu/menu.js index 72246b8c34a..a528ff1d854 100644 --- a/app/assets/javascripts/discourse/app/components/user-menu/menu.js +++ b/app/assets/javascripts/discourse/app/components/user-menu/menu.js @@ -196,6 +196,14 @@ export default class UserMenu extends Component { @tracked currentPanelComponent = DEFAULT_PANEL_COMPONENT; @tracked currentNotificationTypes; + get classNames() { + let classes = ["user-menu", "revamped", "menu-panel", "drop-down"]; + if (this.siteSettings.show_user_menu_avatars) { + classes.push("show-avatars"); + } + return classes.join(" "); + } + @cached get topTabs() { const tabs = []; diff --git a/app/assets/javascripts/discourse/app/components/user-menu/messages-list.js b/app/assets/javascripts/discourse/app/components/user-menu/messages-list.js index 6fcf7bcd314..401af5e2c01 100644 --- a/app/assets/javascripts/discourse/app/components/user-menu/messages-list.js +++ b/app/assets/javascripts/discourse/app/components/user-menu/messages-list.js @@ -77,6 +77,16 @@ export default class UserMenuMessagesList extends UserMenuNotificationsList { const topics = data.topics.map((t) => this.store.createRecord("topic", t)); await Topic.applyTransformations(topics); + if (this.siteSettings.show_user_menu_avatars) { + // Populate avatar_template for lastPoster + const usersById = new Map(data.users.map((u) => [u.id, u])); + topics.forEach((t) => { + t.last_poster_avatar_template = usersById.get( + t.lastPoster.user_id + ).avatar_template; + }); + } + const readNotifications = await Notification.initializeNotifications( data.read_notifications ); @@ -96,7 +106,13 @@ export default class UserMenuMessagesList extends UserMenuNotificationsList { }) ); } else { - content.push(new UserMenuMessageItem({ message: item })); + content.push( + new UserMenuMessageItem({ + message: item, + siteSettings: this.siteSettings, + site: this.site, + }) + ); } }); diff --git a/app/assets/javascripts/discourse/app/lib/user-menu/base-item.js b/app/assets/javascripts/discourse/app/lib/user-menu/base-item.js index a416815d42b..eec770271e0 100644 --- a/app/assets/javascripts/discourse/app/lib/user-menu/base-item.js +++ b/app/assets/javascripts/discourse/app/lib/user-menu/base-item.js @@ -1,7 +1,12 @@ +import UserMenuIconAvatar from "discourse/components/user-menu/icon-avatar"; import { wantsNewWindow } from "discourse/lib/intercept-click"; import DiscourseURL from "discourse/lib/url"; export default class UserMenuBaseItem { + constructor({ siteSettings, site }) { + this.site = site; + this.siteSettings = siteSettings; + } get className() {} get linkHref() { @@ -30,6 +35,20 @@ export default class UserMenuBaseItem { get topicId() {} + get avatarTemplate() {} + + get iconComponent() { + return this.siteSettings.show_user_menu_avatars ? UserMenuIconAvatar : null; + } + + get iconComponentArgs() { + return { + avatarTemplate: + this.avatarTemplate || this.site.system_user_avatar_template, + icon: this.icon, + }; + } + onClick({ event, closeUserMenu }) { if (wantsNewWindow(event)) { return; diff --git a/app/assets/javascripts/discourse/app/lib/user-menu/bookmark-item.js b/app/assets/javascripts/discourse/app/lib/user-menu/bookmark-item.js index 9f69b04f10a..bb0401f38b5 100644 --- a/app/assets/javascripts/discourse/app/lib/user-menu/bookmark-item.js +++ b/app/assets/javascripts/discourse/app/lib/user-menu/bookmark-item.js @@ -34,4 +34,8 @@ export default class UserMenuBookmarkItem extends UserMenuBaseItem { get topicId() { return this.bookmark.topic_id; } + + get avatarTemplate() { + return this.bookmark.user.avatar_template; + } } diff --git a/app/assets/javascripts/discourse/app/lib/user-menu/message-item.js b/app/assets/javascripts/discourse/app/lib/user-menu/message-item.js index fd0d619d500..09a7b8ce881 100644 --- a/app/assets/javascripts/discourse/app/lib/user-menu/message-item.js +++ b/app/assets/javascripts/discourse/app/lib/user-menu/message-item.js @@ -41,4 +41,8 @@ export default class UserMenuMessageItem extends UserMenuBaseItem { get topicId() { return this.message.id; } + + get avatarTemplate() { + return this.message.last_poster_avatar_template; + } } diff --git a/app/assets/javascripts/discourse/app/lib/user-menu/notification-item.js b/app/assets/javascripts/discourse/app/lib/user-menu/notification-item.js index c650d6a7240..caec6036122 100644 --- a/app/assets/javascripts/discourse/app/lib/user-menu/notification-item.js +++ b/app/assets/javascripts/discourse/app/lib/user-menu/notification-item.js @@ -58,6 +58,10 @@ export default class UserMenuNotificationItem extends UserMenuBaseItem { return this.notification.topic_id; } + get avatarTemplate() { + return this.notification.acting_user_avatar_template; + } + get #notificationName() { return this.site.notificationLookup[this.notification.notification_type]; } diff --git a/app/assets/javascripts/discourse/tests/acceptance/user-menu-test.js b/app/assets/javascripts/discourse/tests/acceptance/user-menu-test.js index 1d347cf7e4e..7e8a710a8c0 100644 --- a/app/assets/javascripts/discourse/tests/acceptance/user-menu-test.js +++ b/app/assets/javascripts/discourse/tests/acceptance/user-menu-test.js @@ -1101,3 +1101,36 @@ acceptance("User menu - Dismiss button", function (needs) { ); }); }); + +acceptance("User menu - avatars", function (needs) { + needs.user(); + + needs.settings({ + show_user_menu_avatars: true, + }); + + test("It shows user avatars for various notifications on all notifications pane", async function (assert) { + await visit("/"); + await click(".d-header-icons .current-user"); + assert.ok(exists("li.notification.edited .icon-avatar")); + assert.ok(exists("li.notification.replied .icon-avatar")); + }); + + test("It shows user avatars for messages", async function (assert) { + await visit("/"); + await click(".d-header-icons .current-user"); + await click("#user-menu-button-messages"); + + assert.ok(exists("li.notification.private-message .icon-avatar")); + assert.ok(exists("li.message .icon-avatar")); + }); + + test("It shows user avatars for bookmark items and bookmark reminder notification items", async function (assert) { + await visit("/"); + await click(".d-header-icons .current-user"); + await click("#user-menu-button-bookmarks"); + + assert.ok(exists("li.notification.bookmark-reminder .icon-avatar")); + assert.ok(exists("li.bookmark .icon-avatar")); + }); +}); diff --git a/app/assets/javascripts/discourse/tests/fixtures/notification-fixtures.js b/app/assets/javascripts/discourse/tests/fixtures/notification-fixtures.js index 4097c2de19a..efe9c522558 100644 --- a/app/assets/javascripts/discourse/tests/fixtures/notification-fixtures.js +++ b/app/assets/javascripts/discourse/tests/fixtures/notification-fixtures.js @@ -6,6 +6,7 @@ export default { { id: 5340, notification_type: NOTIFICATION_TYPES.edited, + acting_user_avatar_template: "/letter_avatar_proxy/v4/letter/o/f05b48/{size}.png", read: false, post_number: 1, topic_id: 130, @@ -23,6 +24,7 @@ export default { { id: 123, notification_type: NOTIFICATION_TYPES.replied, + acting_user_avatar_template: "/letter_avatar_proxy/v4/letter/o/f05b48/{size}.png", read: false, post_number: 1, topic_id: 1234, @@ -33,12 +35,14 @@ export default { { id: 456, notification_type: NOTIFICATION_TYPES.liked_consolidated, + acting_user_avatar_template: "/letter_avatar_proxy/v4/letter/o/f05b48/{size}.png", read: false, data: { display_username: "aquaman", count: "5" }, }, { id: 789, notification_type: NOTIFICATION_TYPES.group_message_summary, + acting_user_avatar_template: "/letter_avatar_proxy/v4/letter/o/f05b48/{size}.png", read: false, post_number: null, topic_id: null, @@ -53,6 +57,7 @@ export default { { id: 1234, notification_type: NOTIFICATION_TYPES.invitee_accepted, + acting_user_avatar_template: "/letter_avatar_proxy/v4/letter/o/f05b48/{size}.png", read: false, post_number: null, topic_id: null, @@ -62,6 +67,7 @@ export default { { id: 5678, notification_type: NOTIFICATION_TYPES.membership_request_accepted, + acting_user_avatar_template: "/letter_avatar_proxy/v4/letter/o/f05b48/{size}.png", read: false, post_number: null, topic_id: null, diff --git a/app/assets/javascripts/discourse/tests/fixtures/user-menu.js b/app/assets/javascripts/discourse/tests/fixtures/user-menu.js index 63b8bdc4b93..d30bb832532 100644 --- a/app/assets/javascripts/discourse/tests/fixtures/user-menu.js +++ b/app/assets/javascripts/discourse/tests/fixtures/user-menu.js @@ -5,6 +5,7 @@ export default { id: 1713, user_id: 1, notification_type: 24, + acting_user_avatar_template: "/letter_avatar_proxy/v4/letter/o/f05b48/{size}.png", read: false, high_priority: true, created_at: "2022-08-05T17:27:24.873Z", @@ -69,6 +70,7 @@ export default { id: 8315, user_id: 1, notification_type: 6, + acting_user_avatar_template: "/letter_avatar_proxy/v4/letter/o/f05b48/{size}.png", read: false, high_priority: true, created_at: "2022-08-05T17:27:24.873Z", @@ -139,5 +141,9 @@ export default { } ], read_notifications: [], + users: [{id: 13, + username: "mixtape", + avatar_template: "/letter_avatar_proxy/v4/letter/o/f05b48/{size}.png" + }] } } diff --git a/app/assets/javascripts/discourse/tests/integration/components/user-menu/menu-item-test.js b/app/assets/javascripts/discourse/tests/integration/components/user-menu/menu-item-test.js index 6add92d25b4..b243b5c074f 100644 --- a/app/assets/javascripts/discourse/tests/integration/components/user-menu/menu-item-test.js +++ b/app/assets/javascripts/discourse/tests/integration/components/user-menu/menu-item-test.js @@ -400,7 +400,7 @@ module( } ); -function getMessage(overrides = {}) { +function getMessage(overrides = {}, siteSettings, site) { const message = deepMerge( cloneJSON( PrivateMessagesFixture["/topics/private-messages/eviltrout.json"] @@ -409,7 +409,7 @@ function getMessage(overrides = {}) { overrides ); - return new UserMenuMessageItem({ message }); + return new UserMenuMessageItem({ message, siteSettings, site }); } module( @@ -422,7 +422,11 @@ module( test("item description is the fancy title of the message", async function (assert) { this.set( "item", - getMessage({ fancy_title: "This is a safe title!" }) + getMessage( + { fancy_title: "This is a safe title!" }, + this.siteSettings, + this.site + ) ); await render(template); assert.strictEqual( @@ -438,7 +442,7 @@ module( } ); -function getBookmark(overrides = {}) { +function getBookmark(overrides = {}, siteSettings, site) { const bookmark = deepMerge( { id: 6, @@ -480,7 +484,7 @@ function getBookmark(overrides = {}) { overrides ); - return new UserMenuBookmarkItem({ bookmark }); + return new UserMenuBookmarkItem({ bookmark, siteSettings, site }); } module( @@ -491,7 +495,7 @@ module( const template = hbs``; test("uses bookmarkable_url for the href", async function (assert) { - this.set("item", getBookmark()); + this.set("item", getBookmark({}, this.siteSettings, this.site)); await render(template); assert.ok( query("li.bookmark a").href.endsWith("/t/this-bookmarkable-url/227/1") @@ -501,7 +505,11 @@ module( test("item label is the bookmarked post author", async function (assert) { this.set( "item", - getBookmark({ user: { username: "bookmarkPostAuthor" } }) + getBookmark( + { user: { username: "bookmarkPostAuthor" } }, + this.siteSettings, + this.site + ) ); await render(template); assert.strictEqual( @@ -511,7 +519,14 @@ module( }); test("item description is the bookmark title", async function (assert) { - this.set("item", getBookmark({ title: "Custom bookmark title" })); + this.set( + "item", + getBookmark( + { title: "Custom bookmark title" }, + this.siteSettings, + this.site + ) + ); await render(template); assert.strictEqual( query("li.bookmark .item-description").textContent.trim(), diff --git a/app/assets/stylesheets/common/base/menu-panel.scss b/app/assets/stylesheets/common/base/menu-panel.scss index d7dd9317614..ed90ad22c2e 100644 --- a/app/assets/stylesheets/common/base/menu-panel.scss +++ b/app/assets/stylesheets/common/base/menu-panel.scss @@ -514,6 +514,7 @@ padding: 0; align-self: flex-start; width: 100%; + .d-icon { padding-top: 0.2em; margin-right: 0.5em; @@ -557,6 +558,42 @@ } } +.user-menu.show-avatars { + li { + a { + .icon-avatar { + display: flex; + position: relative; + overflow: visible; + margin-right: 0.5em; + flex-shrink: 0; + width: 2.25em; + height: 2.25em; + padding: 0.125em 0; + + .avatar { + width: 100%; + height: 100%; + } + .d-icon { + display: block; + position: absolute; + right: -0.675em; + bottom: -0.125em; + background: var(--secondary); + color: var(--primary-very-high); + padding: 0.25em; + border-radius: 100%; + font-size: var(--font-down-1); + } + } + & + div { + padding: 0.25em 0; + } + } + } +} + .hamburger-panel .menu-panel.slide-in { left: 0; diff --git a/app/controllers/notifications_controller.rb b/app/controllers/notifications_controller.rb index 471a40bca2c..002385cc6ef 100644 --- a/app/controllers/notifications_controller.rb +++ b/app/controllers/notifications_controller.rb @@ -57,6 +57,8 @@ class NotificationsController < ApplicationController notifications = Notification.filter_inaccessible_topic_notifications(current_user.guardian, notifications) + notifications = + Notification.populate_acting_user(notifications) if SiteSetting.show_user_menu_avatars json = { notifications: serialize_data(notifications, NotificationSerializer), @@ -86,6 +88,8 @@ class NotificationsController < ApplicationController notifications = notifications.offset(offset).limit(limit) notifications = Notification.filter_inaccessible_topic_notifications(current_user.guardian, notifications) + notifications = + Notification.populate_acting_user(notifications) if SiteSetting.show_user_menu_avatars render_json_dump( notifications: serialize_data(notifications, NotificationSerializer), total_rows_notifications: total_rows, diff --git a/app/controllers/users_controller.rb b/app/controllers/users_controller.rb index 947f7e7bdba..323543c0691 100644 --- a/app/controllers/users_controller.rb +++ b/app/controllers/users_controller.rb @@ -1897,6 +1897,9 @@ class UsersController < ApplicationController end if reminder_notifications.present? + if SiteSetting.show_user_menu_avatars + Notification.populate_acting_user(reminder_notifications) + end serialized_notifications = ActiveModel::ArraySerializer.new( reminder_notifications, @@ -1967,6 +1970,7 @@ class UsersController < ApplicationController end if unread_notifications.present? + Notification.populate_acting_user(unread_notifications) if SiteSetting.show_user_menu_avatars serialized_unread_notifications = ActiveModel::ArraySerializer.new( unread_notifications, @@ -1978,9 +1982,17 @@ class UsersController < ApplicationController if messages_list serialized_messages = serialize_data(messages_list, TopicListSerializer, scope: guardian, root: false)[:topics] + serialized_users = + if SiteSetting.show_user_menu_avatars + users = messages_list.topics.map { |t| t.posters.last.user }.flatten.compact.uniq(&:id) + serialize_data(users, BasicUserSerializer, scope: guardian, root: false) + else + [] + end end if read_notifications.present? + Notification.populate_acting_user(read_notifications) if SiteSetting.show_user_menu_avatars serialized_read_notifications = ActiveModel::ArraySerializer.new( read_notifications, @@ -1993,6 +2005,7 @@ class UsersController < ApplicationController unread_notifications: serialized_unread_notifications || [], read_notifications: serialized_read_notifications || [], topics: serialized_messages || [], + users: serialized_users || [], } end diff --git a/app/models/notification.rb b/app/models/notification.rb index 4fe1d393b73..98e372a55a3 100644 --- a/app/models/notification.rb +++ b/app/models/notification.rb @@ -1,6 +1,9 @@ # frozen_string_literal: true class Notification < ActiveRecord::Base + attr_accessor :acting_user + attr_accessor :acting_username + belongs_to :user belongs_to :topic @@ -349,6 +352,25 @@ class Notification < ActiveRecord::Base end end + def self.populate_acting_user(notifications) + usernames = + notifications.map do |notification| + notification.acting_username = + ( + notification.data_hash[:username] || notification.data_hash[:display_username] || + notification.data_hash[:mentioned_by_username] || + notification.data_hash[:invited_by_username] + )&.downcase + end + + users = User.where(username_lower: usernames.uniq).index_by(&:username_lower) + notifications.each do |notification| + notification.acting_user = users[notification.acting_username] + end + + notifications + end + def unread_high_priority? self.high_priority? && !read end diff --git a/app/serializers/notification_serializer.rb b/app/serializers/notification_serializer.rb index 63092363f28..486ccca078b 100644 --- a/app/serializers/notification_serializer.rb +++ b/app/serializers/notification_serializer.rb @@ -13,7 +13,8 @@ class NotificationSerializer < ApplicationSerializer :fancy_title, :slug, :data, - :is_warning + :is_warning, + :acting_user_avatar_template def slug Slug.for(object.topic.title) if object.topic.present? @@ -46,4 +47,12 @@ class NotificationSerializer < ApplicationSerializer def include_external_id? SiteSetting.enable_discourse_connect end + + def acting_user_avatar_template + object.acting_user.avatar_template_url + end + + def include_acting_user_avatar_template? + object.acting_user.present? + end end diff --git a/app/serializers/site_serializer.rb b/app/serializers/site_serializer.rb index 8693cd5d040..3b7c576f2d5 100644 --- a/app/serializers/site_serializer.rb +++ b/app/serializers/site_serializer.rb @@ -46,6 +46,7 @@ class SiteSerializer < ApplicationSerializer :denied_emojis, :tos_url, :privacy_policy_url, + :system_user_avatar_template, ) has_many :archetypes, embed: :objects, serializer: ArchetypeSerializer @@ -332,6 +333,14 @@ class SiteSerializer < ApplicationSerializer privacy_policy_url.present? end + def system_user_avatar_template + Discourse.system_user.avatar_template + end + + def include_system_user_avatar_template? + SiteSetting.show_user_menu_avatars + end + private def ordered_flags(flags) diff --git a/config/locales/server.en.yml b/config/locales/server.en.yml index 208dd1a4909..786a98c8178 100644 --- a/config/locales/server.en.yml +++ b/config/locales/server.en.yml @@ -2484,6 +2484,7 @@ en: experimental_form_templates: "EXPERIMENTAL: Enable the form templates feature. After enabled, manage the templates at Customize / Templates." page_loading_indicator: "Configure the loading indicator which appears during page navigations within Discourse. 'Spinner' is a full page indicator. 'Slider' shows a narrow bar at the top of the screen." + show_user_menu_avatars: "Show user avatars in the user menu" errors: invalid_css_color: "Invalid color. Enter a color name or hex value." diff --git a/config/site_settings.yml b/config/site_settings.yml index 8142c92606e..8320a50952c 100644 --- a/config/site_settings.yml +++ b/config/site_settings.yml @@ -395,7 +395,9 @@ basic: choices: - spinner - slider - + show_user_menu_avatars: + client: true + default: false login: invite_only: refresh: true diff --git a/spec/models/notification_spec.rb b/spec/models/notification_spec.rb index 1360acdbce3..6532c240d87 100644 --- a/spec/models/notification_spec.rb +++ b/spec/models/notification_spec.rb @@ -806,4 +806,34 @@ RSpec.describe Notification do expect(notification.shelved_notification).to be_nil end end + + describe ".populate_acting_user" do + fab!(:user1) { Fabricate(:user) } + fab!(:user2) { Fabricate(:user) } + fab!(:user3) { Fabricate(:user) } + fab!(:user4) { Fabricate(:user) } + fab!(:notification1) do + Fabricate(:notification, user: user, data: { username: user1.username }.to_json) + end + fab!(:notification2) do + Fabricate(:notification, user: user, data: { display_username: user2.username }.to_json) + end + fab!(:notification3) do + Fabricate(:notification, user: user, data: { mentioned_by_username: user3.username }.to_json) + end + fab!(:notification4) do + Fabricate(:notification, user: user, data: { invited_by_username: user4.username }.to_json) + end + + it "Sets the acting_user correctly for each notification" do + Notification.populate_acting_user( + [notification1, notification2, notification3, notification4], + ) + + expect(notification1.acting_user).to eq(user1) + expect(notification2.acting_user).to eq(user2) + expect(notification3.acting_user).to eq(user3) + expect(notification4.acting_user).to eq(user4) + end + end end diff --git a/spec/requests/notifications_controller_spec.rb b/spec/requests/notifications_controller_spec.rb index 3bb767d6642..1c725999536 100644 --- a/spec/requests/notifications_controller_spec.rb +++ b/spec/requests/notifications_controller_spec.rb @@ -32,7 +32,10 @@ RSpec.describe NotificationsController do context "when logged in" do context "as normal user" do fab!(:user) { sign_in(Fabricate(:user)) } - fab!(:notification) { Fabricate(:notification, user: user) } + fab!(:acting_user) { Fabricate(:user) } + fab!(:notification) do + Fabricate(:notification, user: user, data: { username: acting_user.username }.to_json) + end describe "#index" do it "should succeed for recent" do @@ -424,6 +427,20 @@ RSpec.describe NotificationsController do end end end + + context "with `show_user_menu_avatars` setting enabled" do + before { SiteSetting.show_user_menu_avatars = true } + + it "serializes acting_user_avatar_template into notifications" do + get "/notifications.json" + + notifications = response.parsed_body["notifications"] + expect(notifications).not_to be_empty + notifications.each do |notification| + expect(notification["acting_user_avatar_template"]).to be_present + end + end + end end it "should succeed" do diff --git a/spec/requests/users_controller_spec.rb b/spec/requests/users_controller_spec.rb index 9c10ad4d875..6afc9966e3d 100644 --- a/spec/requests/users_controller_spec.rb +++ b/spec/requests/users_controller_spec.rb @@ -7051,6 +7051,18 @@ RSpec.describe UsersController do expect(notifications.size).to eq(1) expect(notifications.first["data"]["bookmark_id"]).to eq(bookmark_with_reminder.id) end + + context "with `show_user_menu_avatars` setting enabled" do + before { SiteSetting.show_user_menu_avatars = true } + + it "serializes acting_user_avatar into notifications" do + get "/u/#{user.username}/user-menu-bookmarks" + expect(response.status).to eq(200) + + first_notification = response.parsed_body["notifications"].first + expect(first_notification["acting_user_avatar_template"]).to be_present + end + end end end