Add tests for AskInviteAnywayDialog (#10228)

Co-authored-by: Michael Weimann <michaelw@matrix.org>

src/components/views/dialogs/AskInviteAnywayDialog.tsx

@@ -1,5 +1,6 @@
 /*
 Copyright 2019 New Vector Ltd
+Copyright 2023 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.
@@ -14,14 +15,14 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-import React from "react";
+import React, { useCallback } from "react";
 
 import { _t } from "../../../languageHandler";
 import SettingsStore from "../../../settings/SettingsStore";
 import { SettingLevel } from "../../../settings/SettingLevel";
 import BaseDialog from "./BaseDialog";
 
-interface IProps {
+export interface AskInviteAnywayDialogProps {
     unknownProfileUsers: Array<{
         userId: string;
         errorText: string;
@@ -31,57 +32,58 @@ interface IProps {
     onFinished: (success: boolean) => void;
 }
 
-export default class AskInviteAnywayDialog extends React.Component<IProps> {
+export default function AskInviteAnywayDialog({
-    private onInviteClicked = (): void => {
+    onFinished,
-        this.props.onInviteAnyways();
+    onGiveUp,
-        this.props.onFinished(true);
+    onInviteAnyways,
-    };
+    unknownProfileUsers,
+}: AskInviteAnywayDialogProps): JSX.Element {
+    const onInviteClicked = useCallback((): void => {
+        onInviteAnyways();
+        onFinished(true);
+    }, [onInviteAnyways, onFinished]);
 
-    private onInviteNeverWarnClicked = (): void => {
+    const onInviteNeverWarnClicked = useCallback((): void => {
         SettingsStore.setValue("promptBeforeInviteUnknownUsers", null, SettingLevel.ACCOUNT, false);
-        this.props.onInviteAnyways();
+        onInviteAnyways();
-        this.props.onFinished(true);
+        onFinished(true);
-    };
+    }, [onInviteAnyways, onFinished]);
 
-    private onGiveUpClicked = (): void => {
+    const onGiveUpClicked = useCallback((): void => {
-        this.props.onGiveUp();
+        onGiveUp();
-        this.props.onFinished(false);
+        onFinished(false);
-    };
+    }, [onGiveUp, onFinished]);
 
-    public render(): React.ReactNode {
+    const errorList = unknownProfileUsers.map((address) => (
-        const errorList = this.props.unknownProfileUsers.map((address) => (
+        <li key={address.userId}>
-            <li key={address.userId}>
+            {address.userId}: {address.errorText}
-                {address.userId}: {address.errorText}
+        </li>
-            </li>
+    ));
-        ));
 
-        return (
+    return (
-            <BaseDialog
+        <BaseDialog
-                className="mx_RetryInvitesDialog"
+            className="mx_RetryInvitesDialog"
-                onFinished={this.onGiveUpClicked}
+            onFinished={onGiveUpClicked}
-                title={_t("The following users may not exist")}
+            title={_t("The following users may not exist")}
-                contentId="mx_Dialog_content"
+            contentId="mx_Dialog_content"
-            >
+        >
-                <div id="mx_Dialog_content">
+            <div id="mx_Dialog_content">
-                    <p>
+                <p>
-                        {_t(
+                    {_t(
-                            "Unable to find profiles for the Matrix IDs listed below - " +
+                        "Unable to find profiles for the Matrix IDs listed below - " +
-                                "would you like to invite them anyway?",
+                            "would you like to invite them anyway?",
-                        )}
+                    )}
-                    </p>
+                </p>
-                    <ul>{errorList}</ul>
+                <ul>{errorList}</ul>
-                </div>
+            </div>
 
-                <div className="mx_Dialog_buttons">
+            <div className="mx_Dialog_buttons">
-                    <button onClick={this.onGiveUpClicked}>{_t("Close")}</button>
+                <button onClick={onGiveUpClicked}>{_t("Close")}</button>
-                    <button onClick={this.onInviteNeverWarnClicked}>
+                <button onClick={onInviteNeverWarnClicked}>{_t("Invite anyway and never warn me again")}</button>
-                        {_t("Invite anyway and never warn me again")}
+                <button onClick={onInviteClicked} autoFocus={true}>
-                    </button>
+                    {_t("Invite anyway")}
-                    <button onClick={this.onInviteClicked} autoFocus={true}>
+                </button>
-                        {_t("Invite anyway")}
+            </div>
-                    </button>
+        </BaseDialog>
-                </div>
+    );
-            </BaseDialog>
-        );
-    }
 }

test/components/views/dialogs/AskInviteAnywayDialog-test.tsx

@@ -0,0 +1,93 @@
+/*
+Copyright 2023 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 { getByText, render, RenderResult } from "@testing-library/react";
+import userEvent from "@testing-library/user-event";
+import React from "react";
+
+import AskInviteAnywayDialog, {
+    AskInviteAnywayDialogProps,
+} from "../../../../src/components/views/dialogs/AskInviteAnywayDialog";
+import SettingsStore from "../../../../src/settings/SettingsStore";
+
+describe("AskInviteaAnywayDialog", () => {
+    const onFinished: jest.Mock<any, any> = jest.fn();
+    const onGiveUp: jest.Mock<any, any> = jest.fn();
+    const onInviteAnyways: jest.Mock<any, any> = jest.fn();
+
+    function renderComponent(props: Partial<AskInviteAnywayDialogProps> = {}): RenderResult {
+        return render(
+            <AskInviteAnywayDialog
+                onFinished={onFinished}
+                onGiveUp={onGiveUp}
+                onInviteAnyways={onInviteAnyways}
+                unknownProfileUsers={[
+                    {
+                        userId: "@alice:localhost",
+                        errorText: "🤷‍♂️",
+                    },
+                ]}
+                {...props}
+            />,
+        );
+    }
+
+    beforeEach(() => {
+        jest.resetAllMocks();
+    });
+
+    it("remembers to not warn again", async () => {
+        const { container } = renderComponent();
+
+        jest.spyOn(SettingsStore, "setValue").mockImplementation(async (): Promise<void> => {});
+
+        const neverWarnAgainBtn = getByText(container, /never warn/);
+        await userEvent.click(neverWarnAgainBtn);
+
+        expect(SettingsStore.setValue).toHaveBeenCalledWith(
+            "promptBeforeInviteUnknownUsers",
+            null,
+            expect.any(String),
+            false,
+        );
+        expect(onInviteAnyways).toHaveBeenCalledTimes(1);
+        expect(onFinished).toHaveBeenCalledWith(true);
+    });
+
+    it("invites anyway", async () => {
+        const { container } = renderComponent();
+
+        jest.spyOn(SettingsStore, "setValue");
+
+        const inviteAnywayBtn = getByText(container, "Invite anyway");
+        await userEvent.click(inviteAnywayBtn);
+
+        expect(onInviteAnyways).toHaveBeenCalledTimes(1);
+        expect(onFinished).toHaveBeenCalledWith(true);
+    });
+
+    it("gives up", async () => {
+        const { container } = renderComponent();
+
+        jest.spyOn(SettingsStore, "setValue");
+
+        const closeBtn = getByText(container, /Close/);
+        await userEvent.click(closeBtn);
+
+        expect(onGiveUp).toHaveBeenCalledTimes(1);
+        expect(onFinished).toHaveBeenCalledWith(false);
+    });
+});