Snooze the bulk unverified sessions reminder on dismiss (#9706)

* test bulk unverified sessions toast behaviour

* unverified sessions toast text tweak

* only show bulk unverified sessions toast when current device is verified

* add Setting for BulkUnverifiedSessionsReminder

* add build config for BulkUnverifiedSessionsReminder

* add more assertions for show/hide toast, fix strict errors

* fix strict error

* add util methods for snoozing in local storage

* rename nag to reminder

* set and read snooze for toast

* test snooze

* remove debug

* strict fix

* remove unused code

src/DeviceListener.ts

@@ -48,6 +48,7 @@ import {
 } from "./utils/device/clientInformation";
 import SettingsStore, { CallbackFn } from "./settings/SettingsStore";
 import { UIFeature } from "./settings/UIFeature";
+import { isBulkUnverifiedDeviceReminderSnoozed } from "./utils/device/snoozeBulkUnverifiedDeviceReminder";
 
 const KEY_BACKUP_POLL_INTERVAL = 5 * 60 * 1000;
 
@@ -335,12 +336,15 @@ export default class DeviceListener {
         logger.debug("New unverified sessions: " + Array.from(newUnverifiedDeviceIds).join(','));
         logger.debug("Currently showing toasts for: " + Array.from(this.displayingToastsForDeviceIds).join(','));
 
+        const isBulkUnverifiedSessionsReminderSnoozed = isBulkUnverifiedDeviceReminderSnoozed();
+
         // Display or hide the batch toast for old unverified sessions
         // don't show the toast if the current device is unverified
         if (
             oldUnverifiedDeviceIds.size > 0
             && isCurrentDeviceTrusted
             && this.enableBulkUnverifiedSessionsReminder
+            && !isBulkUnverifiedSessionsReminderSnoozed
         ) {
             showBulkUnverifiedSessionsToast(oldUnverifiedDeviceIds);
         } else {

src/toasts/BulkUnverifiedSessionsToast.ts

@@ -20,6 +20,7 @@ import DeviceListener from '../DeviceListener';
 import GenericToast from "../components/views/toasts/GenericToast";
 import ToastStore from "../stores/ToastStore";
 import { Action } from "../dispatcher/actions";
+import { snoozeBulkUnverifiedDeviceReminder } from '../utils/device/snoozeBulkUnverifiedDeviceReminder';
 
 const TOAST_KEY = "reviewsessions";
 
@@ -34,6 +35,7 @@ export const showToast = (deviceIds: Set<string>) => {
 
     const onReject = () => {
         DeviceListener.sharedInstance().dismissUnverifiedSessions(deviceIds);
+        snoozeBulkUnverifiedDeviceReminder();
     };
 
     ToastStore.sharedInstance().addOrReplaceToast({

src/utils/device/snoozeBulkUnverifiedDeviceReminder.ts

@@ -0,0 +1,40 @@
+/*
+Copyright 2022 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.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+import { logger } from "matrix-js-sdk/src/logger";
+
+const SNOOZE_KEY = 'mx_snooze_bulk_unverified_device_nag';
+// one week
+const snoozePeriod = 1000 * 60 * 60 * 24 * 7;
+export const snoozeBulkUnverifiedDeviceReminder = () => {
+    try {
+        localStorage.setItem(SNOOZE_KEY, String(Date.now()));
+    } catch (error) {
+        logger.error('Failed to persist bulk unverified device nag snooze', error);
+    }
+};
+
+export const isBulkUnverifiedDeviceReminderSnoozed = () => {
+    try {
+        const snoozedTimestamp = localStorage.getItem(SNOOZE_KEY);
+
+        const parsedTimestamp = Number.parseInt(snoozedTimestamp || '', 10);
+
+        return Number.isInteger(parsedTimestamp) && (parsedTimestamp + snoozePeriod) > Date.now();
+    } catch (error) {
+        return false;
+    }
+};