Simplify references to VerificationRequest (#11045)

* Use new `VerificationRequest.getQRCodeBytes()` * Use new `VerificationRequest.otherDeviceId` * Remove references to `VerificationRequest.channel` * Replace references to `VerificationRequest.{requesting,receiving}UserId` Normally these are guarded by `request.initiatedByMe` so we can trivially replace it with `request.otherUserId` or `client.getUserId()`. In one place we actually need to apply some logic. * increase test coverage * Even more test coverage * Even more test coverage
2023-06-07 14:43:44 +00:00
parent ac2c9cef8d
commit 34439ee652
12 changed files with 310 additions and 33 deletions
@@ -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 React, { ComponentProps } from "react";
+import { Mocked } from "jest-mock";
+import { act, render, RenderResult } from "@testing-library/react";
+import {
+    VerificationRequest,
+    VerificationRequestEvent,
+} from "matrix-js-sdk/src/crypto/verification/request/VerificationRequest";
+import { DeviceInfo } from "matrix-js-sdk/src/crypto/deviceinfo";
+import { IMyDevice, MatrixClient } from "matrix-js-sdk/src/client";
+import { TypedEventEmitter } from "matrix-js-sdk/src/models/typed-event-emitter";
+
+import VerificationRequestToast from "../../../../src/components/views/toasts/VerificationRequestToast";
+import { flushPromises, getMockClientWithEventEmitter, mockClientMethodsUser } from "../../../test-utils";
+
+function renderComponent(
+    props: Partial<ComponentProps<typeof VerificationRequestToast>> & { request: VerificationRequest },
+): RenderResult {
+    const propsWithDefaults = {
+        toastKey: "test",
+        ...props,
+    };
+
+    return render(<VerificationRequestToast {...propsWithDefaults} />);
+}
+
+describe("VerificationRequestToast", () => {
+    let client: Mocked<MatrixClient>;
+
+    beforeEach(() => {
+        client = getMockClientWithEventEmitter({
+            ...mockClientMethodsUser(),
+            getStoredDevice: jest.fn(),
+            getDevice: jest.fn(),
+        });
+    });
+
+    it("should render a self-verification", async () => {
+        const otherDeviceId = "other_device";
+        const otherIDevice: IMyDevice = { device_id: otherDeviceId, last_seen_ip: "1.1.1.1" };
+        client.getDevice.mockResolvedValue(otherIDevice);
+
+        const otherDeviceInfo = new DeviceInfo(otherDeviceId);
+        otherDeviceInfo.unsigned = { device_display_name: "my other device" };
+        client.getStoredDevice.mockReturnValue(otherDeviceInfo);
+
+        const request = makeMockVerificationRequest({
+            isSelfVerification: true,
+            otherDeviceId,
+        });
+        const result = renderComponent({ request });
+        await act(async () => {
+            await flushPromises();
+        });
+        expect(result.container).toMatchSnapshot();
+    });
+
+    it("should render a cross-user verification", async () => {
+        const otherUserId = "@other:user";
+        const request = makeMockVerificationRequest({
+            isSelfVerification: false,
+            otherUserId,
+        });
+        const result = renderComponent({ request });
+        await act(async () => {
+            await flushPromises();
+        });
+        expect(result.container).toMatchSnapshot();
+    });
+});
+
+function makeMockVerificationRequest(props: Partial<VerificationRequest> = {}): Mocked<VerificationRequest> {
+    const request = new TypedEventEmitter<VerificationRequestEvent, any>();
+    Object.assign(request, {
+        ...props,
+    });
+    return request as unknown as Mocked<VerificationRequest>;
+}
@@ -0,0 +1,68 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`VerificationRequestToast should render a cross-user verification 1`] = `
+<div>
+  <div>
+    <div
+      class="mx_Toast_description"
+    >
+      @alice:domain (@other:user)
+    </div>
+    <div
+      aria-live="off"
+      class="mx_Toast_buttons"
+    >
+      <div
+        class="mx_AccessibleButton mx_AccessibleButton_hasKind mx_AccessibleButton_kind_danger_outline"
+        role="button"
+        tabindex="0"
+      >
+        Ignore (NaN)
+      </div>
+      <div
+        class="mx_AccessibleButton mx_AccessibleButton_hasKind mx_AccessibleButton_kind_primary"
+        role="button"
+        tabindex="0"
+      >
+        Verify Session
+      </div>
+    </div>
+  </div>
+</div>
+`;
+
+exports[`VerificationRequestToast should render a self-verification 1`] = `
+<div>
+  <div>
+    <div
+      class="mx_Toast_description"
+    >
+      my other device
+      <div
+        class="mx_Toast_detail"
+      >
+        other_device from 1.1.1.1
+      </div>
+    </div>
+    <div
+      aria-live="off"
+      class="mx_Toast_buttons"
+    >
+      <div
+        class="mx_AccessibleButton mx_AccessibleButton_hasKind mx_AccessibleButton_kind_danger_outline"
+        role="button"
+        tabindex="0"
+      >
+        Ignore (NaN)
+      </div>
+      <div
+        class="mx_AccessibleButton mx_AccessibleButton_hasKind mx_AccessibleButton_kind_primary"
+        role="button"
+        tabindex="0"
+      >
+        Verify Session
+      </div>
+    </div>
+  </div>
+</div>
+`;