Absorb the matrix-react-sdk repository (#28192)

Co-authored-by: github-merge-queue <118344674+github-merge-queue@users.noreply.github.com> Co-authored-by: github-merge-queue <github-merge-queue@users.noreply.github.com> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Florian Duros <florian.duros@ormaz.fr> Co-authored-by: Kim Brose <kim.brose@nordeck.net> Co-authored-by: Florian Duros <florianduros@element.io> Co-authored-by: R Midhun Suresh <hi@midhun.dev> Co-authored-by: dbkr <986903+dbkr@users.noreply.github.com> Co-authored-by: ElementRobot <releases@riot.im> Co-authored-by: dbkr <dbkr@users.noreply.github.com> Co-authored-by: David Baker <dbkr@users.noreply.github.com> Co-authored-by: Michael Telatynski <7t3chguy@gmail.com> Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> Co-authored-by: David Langley <davidl@element.io> Co-authored-by: Michael Weimann <michaelw@matrix.org> Co-authored-by: Timshel <Timshel@users.noreply.github.com> Co-authored-by: Sahil Silare <32628578+sahil9001@users.noreply.github.com> Co-authored-by: Will Hunt <will@half-shot.uk> Co-authored-by: Hubert Chathi <hubert@uhoreg.ca> Co-authored-by: Andrew Ferrazzutti <andrewf@element.io> Co-authored-by: Robin <robin@robin.town> Co-authored-by: Tulir Asokan <tulir@maunium.net>
2024-10-16 13:31:55 +01:00
parent 2b99496025
commit c05c429803
3280 changed files with 586617 additions and 905 deletions
--- a/test/unit-tests/utils/device/clientInformation-test.ts
+++ b/test/unit-tests/utils/device/clientInformation-test.ts
@@ -0,0 +1,121 @@
+/*
+Copyright 2024 New Vector Ltd.
+Copyright 2022 The Matrix.org Foundation C.I.C.
+
+SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only
+Please see LICENSE files in the repository root for full details.
+*/
+
+import { MatrixEvent } from "matrix-js-sdk/src/matrix";
+
+import BasePlatform from "../../../../src/BasePlatform";
+import { IConfigOptions } from "../../../../src/IConfigOptions";
+import { getDeviceClientInformation, recordClientInformation } from "../../../../src/utils/device/clientInformation";
+import { getMockClientWithEventEmitter } from "../../../test-utils";
+import { DEFAULTS } from "../../../../src/SdkConfig";
+import { DeepReadonly } from "../../../../src/@types/common";
+
+describe("recordClientInformation()", () => {
+    const deviceId = "my-device-id";
+    const version = "1.2.3";
+    const isElectron = window.electron;
+
+    const mockClient = getMockClientWithEventEmitter({
+        getDeviceId: jest.fn().mockReturnValue(deviceId),
+        setAccountData: jest.fn(),
+    });
+
+    const sdkConfig: DeepReadonly<IConfigOptions> = {
+        ...DEFAULTS,
+        brand: "Test Brand",
+        element_call: { url: "", use_exclusively: false, brand: "Element Call" },
+    };
+
+    const platform = {
+        getAppVersion: jest.fn().mockResolvedValue(version),
+    } as unknown as BasePlatform;
+
+    beforeEach(() => {
+        jest.clearAllMocks();
+        window.electron = undefined;
+    });
+
+    afterAll(() => {
+        // restore global
+        window.electron = isElectron;
+    });
+
+    it("saves client information without url for electron clients", async () => {
+        window.electron = {} as Electron;
+
+        await recordClientInformation(mockClient, sdkConfig, platform);
+
+        expect(mockClient.setAccountData).toHaveBeenCalledWith(`io.element.matrix_client_information.${deviceId}`, {
+            name: sdkConfig.brand,
+            version,
+            url: undefined,
+        });
+    });
+
+    it("saves client information with url for non-electron clients", async () => {
+        await recordClientInformation(mockClient, sdkConfig, platform);
+
+        expect(mockClient.setAccountData).toHaveBeenCalledWith(`io.element.matrix_client_information.${deviceId}`, {
+            name: sdkConfig.brand,
+            version,
+            url: "localhost",
+        });
+    });
+});
+
+describe("getDeviceClientInformation()", () => {
+    const deviceId = "my-device-id";
+
+    const mockClient = getMockClientWithEventEmitter({
+        getAccountData: jest.fn(),
+    });
+
+    beforeEach(() => {
+        jest.resetAllMocks();
+    });
+
+    it("returns an empty object when no event exists for the device", () => {
+        expect(getDeviceClientInformation(mockClient, deviceId)).toEqual({});
+
+        expect(mockClient.getAccountData).toHaveBeenCalledWith(`io.element.matrix_client_information.${deviceId}`);
+    });
+
+    it("returns client information for the device", () => {
+        const eventContent = {
+            name: "Element Web",
+            version: "1.2.3",
+            url: "test.com",
+        };
+        const event = new MatrixEvent({
+            type: `io.element.matrix_client_information.${deviceId}`,
+            content: eventContent,
+        });
+        mockClient.getAccountData.mockReturnValue(event);
+        expect(getDeviceClientInformation(mockClient, deviceId)).toEqual(eventContent);
+    });
+
+    it("excludes values with incorrect types", () => {
+        const eventContent = {
+            extraField: "hello",
+            name: "Element Web",
+            // wrong format
+            version: { value: "1.2.3" },
+            url: "test.com",
+        };
+        const event = new MatrixEvent({
+            type: `io.element.matrix_client_information.${deviceId}`,
+            content: eventContent,
+        });
+        mockClient.getAccountData.mockReturnValue(event);
+        // invalid fields excluded
+        expect(getDeviceClientInformation(mockClient, deviceId)).toEqual({
+            name: eventContent.name,
+            url: eventContent.url,
+        });
+    });
+});