From 14cc44e820ed0d145b76ab1c495e4009f418feae Mon Sep 17 00:00:00 2001 From: David Baker Date: Fri, 12 Apr 2024 14:18:09 +0100 Subject: [PATCH] Add activity toggle for TAC (#12413) * Add activity toggle for TAC * Update test snapshots for new toggles * Add test for TAC activity setting set to false * Update snapshot for old notifications panel test too * Fix test * Rename setting * Rename variables too * Sort i18n keys * Use functional component --- .../views/settings/Notifications.tsx | 70 +++++------ .../notifications/NotificationSettings2.tsx | 7 ++ .../useUnreadThreadRooms.ts | 13 +- src/i18n/strings/en_EN.json | 2 + src/settings/Settings.tsx | 17 ++- .../__snapshots__/Notifications-test.tsx.snap | 56 +++++++++ .../Notifications2-test.tsx.snap | 112 +++++++++++++++++- .../spaces/useUnreadThreadRooms-test.tsx | 31 ++++- 8 files changed, 262 insertions(+), 46 deletions(-) diff --git a/src/components/views/settings/Notifications.tsx b/src/components/views/settings/Notifications.tsx index ec47cff714..fc86ee0952 100644 --- a/src/components/views/settings/Notifications.tsx +++ b/src/components/views/settings/Notifications.tsx @@ -58,6 +58,7 @@ import { Caption } from "../typography/Caption"; import { SettingsSubsectionHeading } from "./shared/SettingsSubsectionHeading"; import SettingsSubsection from "./shared/SettingsSubsection"; import { doesRoomHaveUnreadMessages } from "../../../Unread"; +import SettingsFlag from "../elements/SettingsFlag"; // TODO: this "view" component still has far too much application logic in it, // which should be factored out to other files. @@ -200,6 +201,18 @@ const maximumVectorState = ( return vectorState; }; +const NotificationActivitySettings = (): JSX.Element => { + return ( +
+ + +
+ ); +}; + +/** + * The old, deprecated notifications tab view, only displayed if the user has the labs flag disabled. + */ export default class Notifications extends React.PureComponent { private settingWatchers: string[]; @@ -731,43 +744,10 @@ export default class Notifications extends React.PureComponent { } private renderCategory(category: RuleClass): ReactNode { - if (category !== RuleClass.VectorOther && this.isInhibited) { + if (this.isInhibited) { return null; // nothing to show for the section } - let clearNotifsButton: JSX.Element | undefined; - if ( - category === RuleClass.VectorOther && - MatrixClientPeg.safeGet() - .getRooms() - .some((r) => doesRoomHaveUnreadMessages(r, true)) - ) { - clearNotifsButton = ( - - {_t("notifications|mark_all_read")} - - ); - } - - if (category === RuleClass.VectorOther && this.isInhibited) { - // only render the utility buttons (if needed) - if (clearNotifsButton) { - return ( -
-
{_t("notifications|class_other")}
- {clearNotifsButton} -
- ); - } - return null; - } - let keywordComposer: JSX.Element | undefined; if (category === RuleClass.VectorMentions) { const tags = filterBoolean(this.state.vectorKeywordRuleInfo?.rules.map((r) => r.pattern) || []); @@ -842,7 +822,6 @@ export default class Notifications extends React.PureComponent { {VectorStateToLabel[VectorState.Loud]} {fieldsetRows} - {clearNotifsButton} {keywordComposer} ); @@ -878,6 +857,25 @@ export default class Notifications extends React.PureComponent { return

{_t("settings|notifications|error_loading")}

; } + let clearNotifsButton: JSX.Element | undefined; + if ( + MatrixClientPeg.safeGet() + .getRooms() + .some((r) => doesRoomHaveUnreadMessages(r, true)) + ) { + clearNotifsButton = ( + + {_t("notifications|mark_all_read")} + + ); + } + return ( <> {this.renderTopSection()} @@ -885,6 +883,8 @@ export default class Notifications extends React.PureComponent { {this.renderCategory(RuleClass.VectorMentions)} {this.renderCategory(RuleClass.VectorOther)} {this.renderTargets()} + + {clearNotifsButton} ); } diff --git a/src/components/views/settings/notifications/NotificationSettings2.tsx b/src/components/views/settings/notifications/NotificationSettings2.tsx index bdc021e486..a15fdd1d8b 100644 --- a/src/components/views/settings/notifications/NotificationSettings2.tsx +++ b/src/components/views/settings/notifications/NotificationSettings2.tsx @@ -41,6 +41,7 @@ import { SettingsBanner } from "../shared/SettingsBanner"; import { SettingsSection } from "../shared/SettingsSection"; import SettingsSubsection from "../shared/SettingsSubsection"; import { NotificationPusherSettings } from "./NotificationPusherSettings"; +import SettingsFlag from "../../elements/SettingsFlag"; enum NotificationDefaultLevels { AllMessages = "all_messages", @@ -71,6 +72,9 @@ function useHasUnreadNotifications(): boolean { return cli.getRooms().some((room) => room.getUnreadNotificationCount() > 0); } +/** + * The new notification settings tab view, only displayed if the user has Features.NotificationSettings2 enabled + */ export default function NotificationSettings2(): JSX.Element { const cli = useMatrixClientContext(); @@ -352,6 +356,9 @@ export default function NotificationSettings2(): JSX.Element { label={_t("notifications|keyword")} placeholder={_t("notifications|keyword_new")} /> + + + diff --git a/src/components/views/spaces/threads-activity-centre/useUnreadThreadRooms.ts b/src/components/views/spaces/threads-activity-centre/useUnreadThreadRooms.ts index 72b5380fbd..725fcfd5be 100644 --- a/src/components/views/spaces/threads-activity-centre/useUnreadThreadRooms.ts +++ b/src/components/views/spaces/threads-activity-centre/useUnreadThreadRooms.ts @@ -43,13 +43,14 @@ type Result = { */ export function useUnreadThreadRooms(forceComputation: boolean): Result { const msc3946ProcessDynamicPredecessor = useSettingValue("feature_dynamic_room_predecessors"); + const settingTACOnlyNotifs = useSettingValue("Notifications.tac_only_notifications"); const mxClient = useMatrixClientContext(); const [result, setResult] = useState({ greatestNotificationLevel: NotificationLevel.None, rooms: [] }); const doUpdate = useCallback(() => { - setResult(computeUnreadThreadRooms(mxClient, msc3946ProcessDynamicPredecessor)); - }, [mxClient, msc3946ProcessDynamicPredecessor]); + setResult(computeUnreadThreadRooms(mxClient, msc3946ProcessDynamicPredecessor, settingTACOnlyNotifs)); + }, [mxClient, msc3946ProcessDynamicPredecessor, settingTACOnlyNotifs]); // The exhautive deps lint rule can't compute dependencies here since it's not a plain inline func. // We make this as simple as possible so its only dep is doUpdate itself. @@ -83,7 +84,11 @@ export function useUnreadThreadRooms(forceComputation: boolean): Result { * @param mxClient - MatrixClient * @param msc3946ProcessDynamicPredecessor */ -function computeUnreadThreadRooms(mxClient: MatrixClient, msc3946ProcessDynamicPredecessor: boolean): Result { +function computeUnreadThreadRooms( + mxClient: MatrixClient, + msc3946ProcessDynamicPredecessor: boolean, + settingTACOnlyNotifs: boolean, +): Result { // Only count visible rooms to not torment the user with notification counts in rooms they can't see. // This will include highlights from the previous version of the room internally const visibleRooms = mxClient.getVisibleRooms(msc3946ProcessDynamicPredecessor); @@ -98,7 +103,7 @@ function computeUnreadThreadRooms(mxClient: MatrixClient, msc3946ProcessDynamicP const notificationLevel = getThreadNotificationLevel(room); // If the room has an activity notification or less, we ignore it - if (notificationLevel <= NotificationLevel.Activity) { + if (settingTACOnlyNotifs && notificationLevel <= NotificationLevel.Activity) { continue; } diff --git a/src/i18n/strings/en_EN.json b/src/i18n/strings/en_EN.json index e1c6c23ac5..48e6e2f0ae 100644 --- a/src/i18n/strings/en_EN.json +++ b/src/i18n/strings/en_EN.json @@ -2846,6 +2846,7 @@ "show_redaction_placeholder": "Show a placeholder for removed messages", "show_stickers_button": "Show stickers button", "show_typing_notifications": "Show typing notifications", + "showbold": "Show all activity in the room list (dots or number of unread messages)", "sidebar": { "metaspaces_favourites_description": "Group all your favourite rooms and people in one place.", "metaspaces_home_all_rooms": "Show all rooms", @@ -2862,6 +2863,7 @@ "title": "Sidebar" }, "start_automatically": "Start automatically after system login", + "tac_only_notifications": "Only show notifications in the thread activity centre", "use_12_hour_format": "Show timestamps in 12 hour format (e.g. 2:30pm)", "use_command_enter_send_message": "Use Command + Enter to send a message", "use_command_f_search": "Use Command + F to search timeline", diff --git a/src/settings/Settings.tsx b/src/settings/Settings.tsx index 2297437479..6be0a6b46f 100644 --- a/src/settings/Settings.tsx +++ b/src/settings/Settings.tsx @@ -1,6 +1,6 @@ /* Copyright 2017 Travis Ralston -Copyright 2018 - 2023 The Matrix.org Foundation C.I.C. +Copyright 2018 - 2024 The Matrix.org Foundation C.I.C. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. @@ -586,14 +586,23 @@ export const SETTINGS: { [setting: string]: ISetting } = { supportedLevels: LEVELS_ROOM_OR_ACCOUNT, default: false, }, + // Used to be a feature, name kept for backwards compat "feature_hidebold": { - isFeature: true, - labsGroup: LabGroup.Rooms, - configDisablesSetting: true, supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS_WITH_CONFIG, displayName: _td("labs|hidebold"), default: false, }, + "Notifications.showbold": { + supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS_WITH_CONFIG, + displayName: _td("settings|showbold"), + default: false, + invertedSettingName: "feature_hidebold", + }, + "Notifications.tac_only_notifications": { + supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS_WITH_CONFIG, + displayName: _td("settings|tac_only_notifications"), + default: true, + }, "feature_ask_to_join": { isFeature: true, labsGroup: LabGroup.Rooms, diff --git a/test/components/views/settings/__snapshots__/Notifications-test.tsx.snap b/test/components/views/settings/__snapshots__/Notifications-test.tsx.snap index bf6c01e50b..25d06ffc23 100644 --- a/test/components/views/settings/__snapshots__/Notifications-test.tsx.snap +++ b/test/components/views/settings/__snapshots__/Notifications-test.tsx.snap @@ -35,5 +35,61 @@ exports[` main notification switches renders only enable notifi /> +
+
+ +
+
+
+
+
+ +
+
+
+
+
`; diff --git a/test/components/views/settings/notifications/__snapshots__/Notifications2-test.tsx.snap b/test/components/views/settings/notifications/__snapshots__/Notifications2-test.tsx.snap index 08e0d86027..84b9188a7c 100644 --- a/test/components/views/settings/notifications/__snapshots__/Notifications2-test.tsx.snap +++ b/test/components/views/settings/notifications/__snapshots__/Notifications2-test.tsx.snap @@ -641,6 +641,60 @@ exports[` correctly handles the loading/disabled state 1`] = ` role="list" />
+
+ +
+
+
+
+
+ +
+
+
+
matches the snapshot 1`] = `
+
+ +
+
+
+
+
+ +
+
+
+
matches the snapshot 1`] = ` class="mx_Checkbox mx_Checkbox_hasKind mx_Checkbox_kind_solid" >