tests: Add test suite for RoomStatusBarHistoryVisible.

Author: kaylendog

src/components/structures/RoomStatusBar.tsx

@@ -109,7 +109,7 @@ export default class RoomStatusBar extends React.PureComponent<IProps, IState> {
             unsentMessages: getUnsentMessages(this.props.room),
             isResending: false,
             roomHistoryVisibility: this.props.room.getHistoryVisibility(),
-            roomHasEncryptionStateEvent: false,
+            roomHasEncryptionStateEvent: this.props.room.hasEncryptionStateEvent(),
             acknowledgedHistoryVisibility: this.getUpdatedAcknowledgedHistoryVisibility(),
         };
     }

test/test-utils/test-utils.ts

@@ -9,14 +9,14 @@ Please see LICENSE files in the repository root for full details.
 import EventEmitter from "events";
 import { mocked, type MockedObject } from "jest-mock";
 import {
+    EventTimeline,
     MatrixEvent,
     type Room,
     type User,
     type IContent,
     type IEvent,
     type RoomMember,
     type MatrixClient,
-    type EventTimeline,
     type RoomState,
     EventType,
     type IEventRelation,

test/unit-tests/components/structures/RoomStatusBar-test.tsx

@@ -7,7 +7,7 @@ Please see LICENSE files in the repository root for full details.
 */
 
 import React from "react";
-import { render } from "jest-matrix-react";
+import { fireEvent, render } from "jest-matrix-react";
 import {
     type MatrixClient,
     PendingEventOrdering,
@@ -20,8 +20,12 @@ import {
 import RoomStatusBar, { getUnsentMessages } from "../../../../src/components/structures/RoomStatusBar";
 import MatrixClientContext from "../../../../src/contexts/MatrixClientContext";
 import { MatrixClientPeg } from "../../../../src/MatrixClientPeg";
-import { mkEvent, stubClient } from "../../../test-utils/test-utils";
+import { mkEvent, stubClient, upsertRoomStateEvents } from "../../../test-utils/test-utils";
 import { mkThread } from "../../../test-utils/threads";
+import { flushPromises } from "../../../test-utils";
+import SettingsStore from "../../../../src/settings/SettingsStore";
+import { SettingLevel } from "../../../../src/settings/SettingLevel";
+import { type Settings } from "../../../../src/settings/Settings";
 
 describe("RoomStatusBar", () => {
     const ROOM_ID = "!roomId:example.org";
@@ -35,6 +39,7 @@ describe("RoomStatusBar", () => {
         stubClient();
         client = MatrixClientPeg.safeGet();
         client.getSyncStateData = jest.fn().mockReturnValue({});
+        client.setRoomAccountData = jest.fn().mockResolvedValue({});
         room = new Room(ROOM_ID, client, client.getUserId()!, {
             pendingEventOrdering: PendingEventOrdering.Detached,
         });
@@ -147,4 +152,111 @@ describe("RoomStatusBar", () => {
             });
         });
     });
+
+    describe("Shared History Visibility Acknowledgement", () => {
+        let acknowledgedHistoryVisibility = false;
+
+        beforeAll(() => {
+            jest.spyOn(SettingsStore, "setValue").mockImplementation(
+                async (settingName: keyof Settings, roomId: string | null = null, level: SettingLevel, value: any) => {
+                    if (settingName == "acknowledgedHistoryVisibility") {
+                        acknowledgedHistoryVisibility = value;
+                    }
+                },
+            );
+            jest.spyOn(SettingsStore, "getValue").mockImplementation(
+                (settingName: keyof Settings, roomId: string | null = null, excludeDefault = false) => {
+                    if (settingName == "acknowledgedHistoryVisibility") {
+                        return acknowledgedHistoryVisibility;
+                    }
+                    return acknowledgedHistoryVisibility;
+                },
+            );
+        });
+
+        beforeEach(async () => {
+            await SettingsStore.setValue("acknowledgedHistoryVisibility", ROOM_ID, SettingLevel.ROOM_ACCOUNT, false);
+        });
+
+        it("should not render history visibility acknowledgement in unencrypted rooms", () => {
+            const { container } = getComponent();
+            expect(container).toMatchSnapshot();
+        });
+
+        it("should not render history visibility acknowledgement in encrypted rooms with joined history visibility", () => {
+            upsertRoomStateEvents(room, [
+                mkEvent({
+                    event: true,
+                    type: "m.room.encryption",
+                    user: "@user1:server",
+                    content: {},
+                }),
+                mkEvent({
+                    event: true,
+                    type: "m.room.history_visibility",
+                    content: {
+                        history_visibility: "joined",
+                    },
+                    user: "@user1:server",
+                }),
+            ]);
+
+            const { container } = getComponent();
+            expect(container).toMatchSnapshot();
+        });
+
+        it("should not render history visibility acknowledgement if it has previously been dismissed", async () => {
+            await SettingsStore.setValue("acknowledgedHistoryVisibility", ROOM_ID, SettingLevel.ROOM_ACCOUNT, true);
+            upsertRoomStateEvents(room, [
+                mkEvent({
+                    event: true,
+                    type: "m.room.encryption",
+                    user: "@user1:server",
+                    content: {},
+                }),
+                mkEvent({
+                    event: true,
+                    type: "m.room.history_visibility",
+                    user: "@user1:server",
+                    content: {
+                        history_visibility: "shared",
+                    },
+                }),
+            ]);
+
+            const { container } = getComponent();
+            expect(container).toMatchSnapshot();
+        });
+
+        it("should render dismissable history visibility acknowledgement in encrypted rooms with non-join history visibility", async () => {
+            upsertRoomStateEvents(room, [
+                mkEvent({
+                    event: true,
+                    type: "m.room.encryption",
+                    user: "@user1:server",
+                    content: {},
+                }),
+                mkEvent({
+                    event: true,
+                    type: "m.room.history_visibility",
+                    user: "@user1:server",
+                    content: {
+                        history_visibility: "shared",
+                    },
+                }),
+            ]);
+
+            const { container } = getComponent();
+            expect(container).toMatchSnapshot();
+
+            // assert dismiss button exists, and press it
+            const dismissButton = container.querySelector<HTMLDivElement>('div[role="button"]');
+            expect(dismissButton).not.toBeNull();
+            fireEvent.click(dismissButton!);
+
+            await flushPromises();
+
+            expect(container).toBeEmptyDOMElement();
+        });
+    });
 });

test/unit-tests/components/structures/__snapshots__/RoomStatusBar-test.tsx.snap

@@ -124,3 +124,70 @@ exports[`RoomStatusBar <RoomStatusBar /> unsent messages should render warning w
   </div>
 </div>
 `;
+
+exports[`RoomStatusBar Shared History Visibility Acknowledgement should not render history visibility acknowledgement if it has previously been dismissed 1`] = `<div />`;
+
+exports[`RoomStatusBar Shared History Visibility Acknowledgement should not render history visibility acknowledgement in encrypted rooms with joined history visibility 1`] = `<div />`;
+
+exports[`RoomStatusBar Shared History Visibility Acknowledgement should not render history visibility acknowledgement in unencrypted rooms 1`] = `<div />`;
+
+exports[`RoomStatusBar Shared History Visibility Acknowledgement should render dismissable history visibility acknowledgement in encrypted rooms with non-join history visibility 1`] = `
+<div>
+  <div
+    class="mx_RoomStatusBar mx_RoomStatusBar_historyVisibility"
+  >
+    <div
+      role="alert"
+    >
+      <div
+        class="mx_RoomStatusBar_historyVisibilityBadge"
+      >
+        <svg
+          fill="currentColor"
+          height="1em"
+          viewBox="0 0 24 24"
+          width="1em"
+          xmlns="http://www.w3.org/2000/svg"
+        >
+          <path
+            d="M11.288 7.288A.97.97 0 0 1 12 7q.424 0 .713.287Q13 7.576 13 8t-.287.713A.97.97 0 0 1 12 9a.97.97 0 0 1-.713-.287A.97.97 0 0 1 11 8q0-.424.287-.713m.001 4.001A.97.97 0 0 1 12 11q.424 0 .713.287.287.288.287.713v4q0 .424-.287.712A.97.97 0 0 1 12 17a.97.97 0 0 1-.713-.288A.97.97 0 0 1 11 16v-4q0-.424.287-.713"
+          />
+          <path
+            clip-rule="evenodd"
+            d="M22 12c0 5.523-4.477 10-10 10S2 17.523 2 12 6.477 2 12 2s10 4.477 10 10m-2 0a8 8 0 1 1-16 0 8 8 0 0 1 16 0"
+            fill-rule="evenodd"
+          />
+        </svg>
+      </div>
+      <div>
+        <div
+          class="mx_RoomStatusBar_historyVisibilityDescription"
+        >
+          Messages you send will be shared with new members invited to this room.
+        </div>
+        <a
+          class="mx_AccessibleButton mx_AccessibleButton_hasKind mx_AccessibleButton_kind_link_inline"
+          href="https://examplecom"
+          rel="noreferrer noopener"
+          role="button"
+          tabindex="0"
+          target="_blank"
+        >
+          Learn more
+        </a>
+      </div>
+      <div
+        class="mx_RoomStatusBar_historyVisibilityButtonBar"
+      >
+        <div
+          class="mx_AccessibleButton mx_RoomStatusBar_historyVisibilityButton mx_AccessibleButton_hasKind mx_AccessibleButton_kind_primary"
+          role="button"
+          tabindex="0"
+        >
+          Dismiss
+        </div>
+      </div>
+    </div>
+  </div>
+</div>
+`;