Better error handling in jump to date (#10405)

- Friendly error messages with details
 - Add a way to submit debug logs for actual errors (non-networking errors)
 - Don't jump someone back to a room they already navigated away from. Fixes bug mentioned in https://github.com/vector-im/element-web/issues/21263#issuecomment-1056809714

test/components/views/messages/DateSeparator-test.tsx

@@ -16,13 +16,24 @@ limitations under the License.
 
 import React from "react";
 import { mocked } from "jest-mock";
-import { render } from "@testing-library/react";
+import { fireEvent, render, screen } from "@testing-library/react";
+import { TimestampToEventResponse } from "matrix-js-sdk/src/client";
+import { ConnectionError, HTTPError, MatrixError } from "matrix-js-sdk/src/http-api";
 
+import dispatcher from "../../../../src/dispatcher/dispatcher";
+import { Action } from "../../../../src/dispatcher/actions";
+import { ViewRoomPayload } from "../../../../src/dispatcher/payloads/ViewRoomPayload";
+import { SdkContextClass } from "../../../../src/contexts/SDKContext";
 import { formatFullDateNoTime } from "../../../../src/DateUtils";
 import SettingsStore from "../../../../src/settings/SettingsStore";
 import { UIFeature } from "../../../../src/settings/UIFeature";
 import MatrixClientContext from "../../../../src/contexts/MatrixClientContext";
-import { getMockClientWithEventEmitter } from "../../../test-utils";
+import {
+    clearAllModals,
+    flushPromisesWithFakeTimers,
+    getMockClientWithEventEmitter,
+    waitEnoughCyclesForModal,
+} from "../../../test-utils";
 import DateSeparator from "../../../../src/components/views/messages/DateSeparator";
 
 jest.mock("../../../../src/settings/SettingsStore");
@@ -31,21 +42,16 @@ describe("DateSeparator", () => {
     const HOUR_MS = 3600000;
     const DAY_MS = HOUR_MS * 24;
     // Friday Dec 17 2021, 9:09am
-    const now = "2021-12-17T08:09:00.000Z";
-    const nowMs = 1639728540000;
+    const nowDate = new Date("2021-12-17T08:09:00.000Z");
+    const roomId = "!unused:example.org";
     const defaultProps = {
-        ts: nowMs,
-        now,
-        roomId: "!unused:example.org",
+        ts: nowDate.getTime(),
+        roomId,
     };
-    const RealDate = global.Date;
-    class MockDate extends Date {
-        constructor(date: string | number | Date) {
-            super(date || now);
-        }
-    }
 
-    const mockClient = getMockClientWithEventEmitter({});
+    const mockClient = getMockClientWithEventEmitter({
+        timestampToEvent: jest.fn(),
+    });
     const getComponent = (props = {}) =>
         render(
             <MatrixClientContext.Provider value={mockClient}>
@@ -55,11 +61,11 @@ describe("DateSeparator", () => {
 
     type TestCase = [string, number, string];
     const testCases: TestCase[] = [
-        ["the exact same moment", nowMs, "Today"],
-        ["same day as current day", nowMs - HOUR_MS, "Today"],
-        ["day before the current day", nowMs - HOUR_MS * 12, "Yesterday"],
-        ["2 days ago", nowMs - DAY_MS * 2, "Wednesday"],
-        ["144 hours ago", nowMs - HOUR_MS * 144, "Sat, Dec 11 2021"],
+        ["the exact same moment", nowDate.getTime(), "Today"],
+        ["same day as current day", nowDate.getTime() - HOUR_MS, "Today"],
+        ["day before the current day", nowDate.getTime() - HOUR_MS * 12, "Yesterday"],
+        ["2 days ago", nowDate.getTime() - DAY_MS * 2, "Wednesday"],
+        ["144 hours ago", nowDate.getTime() - HOUR_MS * 144, "Sat, Dec 11 2021"],
         [
             "6 days ago, but less than 144h",
             new Date("Saturday Dec 11 2021 23:59:00 GMT+0100 (Central European Standard Time)").getTime(),
@@ -68,16 +74,20 @@ describe("DateSeparator", () => {
     ];
 
     beforeEach(() => {
-        global.Date = MockDate as unknown as DateConstructor;
+        // Set a consistent fake time here so the test is always consistent
+        jest.useFakeTimers();
+        jest.setSystemTime(nowDate.getTime());
+
         (SettingsStore.getValue as jest.Mock) = jest.fn((arg) => {
             if (arg === UIFeature.TimelineEnableRelativeDates) {
                 return true;
             }
         });
+        jest.spyOn(SdkContextClass.instance.roomViewStore, "getRoomId").mockReturnValue(roomId);
     });
 
     afterAll(() => {
-        global.Date = RealDate;
+        jest.useRealTimers();
     });
 
     it("renders the date separator correctly", () => {
@@ -115,15 +125,183 @@ describe("DateSeparator", () => {
 
     describe("when feature_jump_to_date is enabled", () => {
         beforeEach(() => {
+            jest.clearAllMocks();
             mocked(SettingsStore).getValue.mockImplementation((arg): any => {
                 if (arg === "feature_jump_to_date") {
                     return true;
                 }
             });
+            jest.spyOn(dispatcher, "dispatch").mockImplementation(() => {});
         });
+
+        afterEach(async () => {
+            await clearAllModals();
+        });
+
         it("renders the date separator correctly", () => {
             const { asFragment } = getComponent();
             expect(asFragment()).toMatchSnapshot();
         });
+
+        [
+            {
+                timeDescriptor: "last week",
+                jumpButtonTestId: "jump-to-date-last-week",
+            },
+            {
+                timeDescriptor: "last month",
+                jumpButtonTestId: "jump-to-date-last-month",
+            },
+            {
+                timeDescriptor: "the beginning",
+                jumpButtonTestId: "jump-to-date-beginning",
+            },
+        ].forEach((testCase) => {
+            it(`can jump to ${testCase.timeDescriptor}`, async () => {
+                // Render the component
+                getComponent();
+
+                // Open the jump to date context menu
+                fireEvent.click(screen.getByTestId("jump-to-date-separator-button"));
+
+                // Jump to "x"
+                const returnedDate = new Date();
+                // Just an arbitrary date before "now"
+                returnedDate.setDate(nowDate.getDate() - 100);
+                const returnedEventId = "$abc";
+                mockClient.timestampToEvent.mockResolvedValue({
+                    event_id: returnedEventId,
+                    origin_server_ts: String(returnedDate.getTime()),
+                } satisfies TimestampToEventResponse);
+                const jumpToXButton = await screen.findByTestId(testCase.jumpButtonTestId);
+                fireEvent.click(jumpToXButton);
+
+                // Flush out the dispatcher which uses `window.setTimeout(...)` since we're
+                // using `jest.useFakeTimers()` in these tests.
+                await flushPromisesWithFakeTimers();
+
+                // Ensure that we're jumping to the event at the given date
+                expect(dispatcher.dispatch).toHaveBeenCalledWith({
+                    action: Action.ViewRoom,
+                    event_id: returnedEventId,
+                    highlighted: true,
+                    room_id: roomId,
+                    metricsTrigger: undefined,
+                } satisfies ViewRoomPayload);
+            });
+        });
+
+        it("should not jump to date if we already switched to another room", async () => {
+            // Render the component
+            getComponent();
+
+            // Open the jump to date context menu
+            fireEvent.click(screen.getByTestId("jump-to-date-separator-button"));
+
+            // Mimic the outcome of switching rooms while waiting for the jump to date
+            // request to finish. Imagine that we started jumping to "last week", the
+            // network request is taking a while, so we got bored, switched rooms; we
+            // shouldn't jump back to the previous room after the network request
+            // happens to finish later.
+            jest.spyOn(SdkContextClass.instance.roomViewStore, "getRoomId").mockReturnValue("!some-other-room");
+
+            // Jump to "last week"
+            mockClient.timestampToEvent.mockResolvedValue({
+                event_id: "$abc",
+                origin_server_ts: "0",
+            });
+            const jumpToLastWeekButton = await screen.findByTestId("jump-to-date-last-week");
+            fireEvent.click(jumpToLastWeekButton);
+
+            // Flush out the dispatcher which uses `window.setTimeout(...)` since we're
+            // using `jest.useFakeTimers()` in these tests.
+            await flushPromisesWithFakeTimers();
+
+            // We should not see any room switching going on (`Action.ViewRoom`)
+            expect(dispatcher.dispatch).not.toHaveBeenCalled();
+        });
+
+        it("should not show jump to date error if we already switched to another room", async () => {
+            // Render the component
+            getComponent();
+
+            // Open the jump to date context menu
+            fireEvent.click(screen.getByTestId("jump-to-date-separator-button"));
+
+            // Mimic the outcome of switching rooms while waiting for the jump to date
+            // request to finish. Imagine that we started jumping to "last week", the
+            // network request is taking a while, so we got bored, switched rooms; we
+            // shouldn't jump back to the previous room after the network request
+            // happens to finish later.
+            jest.spyOn(SdkContextClass.instance.roomViewStore, "getRoomId").mockReturnValue("!some-other-room");
+
+            // Try to jump to "last week" but we want an error to occur and ensure that
+            // we don't show an error dialog for it since we already switched away to
+            // another room and don't care about the outcome here anymore.
+            mockClient.timestampToEvent.mockRejectedValue(new Error("Fake error in test"));
+            const jumpToLastWeekButton = await screen.findByTestId("jump-to-date-last-week");
+            fireEvent.click(jumpToLastWeekButton);
+
+            // Wait the necessary time in order to see if any modal will appear
+            await waitEnoughCyclesForModal({
+                useFakeTimers: true,
+            });
+
+            // We should not see any error modal dialog
+            //
+            // We have to use `queryBy` so that it can return `null` for something that does not exist.
+            expect(screen.queryByTestId("jump-to-date-error-content")).not.toBeInTheDocument();
+        });
+
+        it("should show error dialog with submit debug logs option when non-networking error occurs", async () => {
+            // Render the component
+            getComponent();
+
+            // Open the jump to date context menu
+            fireEvent.click(screen.getByTestId("jump-to-date-separator-button"));
+
+            // Try to jump to "last week" but we want a non-network error to occur so it
+            // shows the "Submit debug logs" UI
+            mockClient.timestampToEvent.mockRejectedValue(new Error("Fake error in test"));
+            const jumpToLastWeekButton = await screen.findByTestId("jump-to-date-last-week");
+            fireEvent.click(jumpToLastWeekButton);
+
+            // Expect error to be shown. We have to wait for the UI to transition.
+            expect(await screen.findByTestId("jump-to-date-error-content")).toBeInTheDocument();
+
+            // Expect an option to submit debug logs to be shown when a non-network error occurs
+            expect(await screen.findByTestId("jump-to-date-error-submit-debug-logs-button")).toBeInTheDocument();
+        });
+
+        [
+            new ConnectionError("Fake connection error in test"),
+            new HTTPError("Fake http error in test", 418),
+            new MatrixError(
+                { errcode: "M_FAKE_ERROR_CODE", error: "Some fake error occured" },
+                518,
+                "https://fake-url/",
+            ),
+        ].forEach((fakeError) => {
+            it(`should show error dialog without submit debug logs option when networking error (${fakeError.name}) occurs`, async () => {
+                // Render the component
+                getComponent();
+
+                // Open the jump to date context menu
+                fireEvent.click(screen.getByTestId("jump-to-date-separator-button"));
+
+                // Try to jump to "last week" but we want a network error to occur
+                mockClient.timestampToEvent.mockRejectedValue(fakeError);
+                const jumpToLastWeekButton = await screen.findByTestId("jump-to-date-last-week");
+                fireEvent.click(jumpToLastWeekButton);
+
+                // Expect error to be shown. We have to wait for the UI to transition.
+                expect(await screen.findByTestId("jump-to-date-error-content")).toBeInTheDocument();
+
+                // The submit debug logs option should *NOT* be shown for network errors.
+                //
+                // We have to use `queryBy` so that it can return `null` for something that does not exist.
+                expect(screen.queryByTestId("jump-to-date-error-submit-debug-logs-button")).not.toBeInTheDocument();
+            });
+        });
     });
 });

test/components/views/messages/__snapshots__/DateSeparator-test.tsx.snap

@@ -44,6 +44,7 @@ exports[`DateSeparator when feature_jump_to_date is enabled renders the date sep
       aria-haspopup="true"
       aria-label="Jump to date"
       class="mx_AccessibleButton mx_DateSeparator_jumpToDateMenu mx_DateSeparator_dateContent"
+      data-testid="jump-to-date-separator-button"
       role="button"
       tabindex="0"
     >

test/components/views/right_panel/UserInfo-test.tsx

@@ -45,7 +45,7 @@ import * as mockVerification from "../../../../src/verification";
 import Modal from "../../../../src/Modal";
 import { E2EStatus } from "../../../../src/utils/ShieldUtils";
 import { DirectoryMember, startDmOnFirstMessage } from "../../../../src/utils/direct-messages";
-import { flushPromises } from "../../../test-utils";
+import { clearAllModals, flushPromises } from "../../../test-utils";
 
 jest.mock("../../../../src/utils/direct-messages", () => ({
     ...jest.requireActual("../../../../src/utils/direct-messages"),
@@ -417,7 +417,9 @@ describe("<UserOptionsSection />", () => {
         mockClient.setIgnoredUsers.mockClear();
     });
 
-    afterEach(() => Modal.closeCurrentModal("End of test"));
+    afterEach(async () => {
+        await clearAllModals();
+    });
 
     afterAll(() => {
         inviteSpy.mockRestore();

test/components/views/rooms/MessageComposer-test.tsx

@@ -21,6 +21,7 @@ import { act, render, screen } from "@testing-library/react";
 import userEvent from "@testing-library/user-event";
 
 import {
+    clearAllModals,
     createTestClient,
     filterConsole,
     flushPromises,
@@ -28,6 +29,7 @@ import {
     mkStubRoom,
     mockPlatformPeg,
     stubClient,
+    waitEnoughCyclesForModal,
 } from "../../../test-utils";
 import MessageComposer from "../../../../src/components/views/rooms/MessageComposer";
 import MatrixClientContext from "../../../../src/contexts/MatrixClientContext";
@@ -48,7 +50,6 @@ import { Action } from "../../../../src/dispatcher/actions";
 import { VoiceBroadcastInfoState, VoiceBroadcastRecording } from "../../../../src/voice-broadcast";
 import { mkVoiceBroadcastInfoStateEvent } from "../../../voice-broadcast/utils/test-utils";
 import { SdkContextClass } from "../../../../src/contexts/SDKContext";
-import Modal from "../../../../src/Modal";
 
 jest.mock("../../../../src/components/views/rooms/wysiwyg_composer", () => ({
     SendWysiwygComposer: jest.fn().mockImplementation(() => <div data-testid="wysiwyg-composer" />),
@@ -77,15 +78,9 @@ const setCurrentBroadcastRecording = (room: Room, state: VoiceBroadcastInfoState
     SdkContextClass.instance.voiceBroadcastRecordingsStore.setCurrent(recording);
 };
 
-const waitForModal = async (): Promise<void> => {
-    await flushPromises();
-    await flushPromises();
-};
-
 const shouldClearModal = async (): Promise<void> => {
     afterEach(async () => {
-        Modal.closeCurrentModal("force");
-        await waitForModal();
+        await clearAllModals();
     });
 };
 
@@ -434,7 +429,7 @@ describe("MessageComposer", () => {
                 setCurrentBroadcastRecording(room, VoiceBroadcastInfoState.Started);
                 wrapAndRender({ room });
                 await startVoiceMessage();
-                await waitForModal();
+                await waitEnoughCyclesForModal();
             });
 
             shouldClearModal();
@@ -450,7 +445,7 @@ describe("MessageComposer", () => {
                 setCurrentBroadcastRecording(room, VoiceBroadcastInfoState.Stopped);
                 wrapAndRender({ room });
                 await startVoiceMessage();
-                await waitForModal();
+                await waitEnoughCyclesForModal();
             });
 
             shouldClearModal();

test/components/views/settings/tabs/user/SessionManagerTab-test.tsx

@@ -31,6 +31,7 @@ import {
     IAuthData,
 } from "matrix-js-sdk/src/matrix";
 
+import { clearAllModals } from "../../../../../test-utils";
 import SessionManagerTab from "../../../../../../src/components/views/settings/tabs/user/SessionManagerTab";
 import MatrixClientContext from "../../../../../../src/contexts/MatrixClientContext";
 import {
@@ -161,7 +162,7 @@ describe("<SessionManagerTab />", () => {
         await flushPromises();
     };
 
-    beforeEach(() => {
+    beforeEach(async () => {
         jest.clearAllMocks();
         jest.spyOn(logger, "error").mockRestore();
         mockClient.getStoredDevice.mockImplementation((_userId, id) => {
@@ -199,7 +200,7 @@ describe("<SessionManagerTab />", () => {
 
         // sometimes a verification modal is in modal state when these tests run
         // make sure the coast is clear
-        Modal.closeCurrentModal("");
+        await clearAllModals();
     });
 
     it("renders spinner while devices load", () => {