Migrate batch of tests to vitest (#34106)

* Migrate autocomplete tests to vitest

* Migrate utils/beacon tests to vitest

* Migrate utils/device tests to vitest

* Migrate utils/crypto tests to vitest

* Migrate utils/localRoom tests to vitest

* Migrate notifications tests to vitest

* Fix types

* Make jest test happy

* Make sonar happier
This commit is contained in:
Michael Telatynski
2026-07-03 10:10:04 +00:00
committed by GitHub
parent 78273c569b
commit 275ea25eca
21 changed files with 195 additions and 147 deletions
@@ -0,0 +1,74 @@
/*
Copyright 2024 New Vector Ltd.
Copyright 2023 The Matrix.org Foundation C.I.C.
SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only OR LicenseRef-Element-Commercial
Please see LICENSE files in the repository root for full details.
*/
// @vitest-environment happy-dom
import { vi, describe, it, expect, beforeEach, type Mocked } from "vitest";
import { type Device, type MatrixClient } from "matrix-js-sdk/src/matrix";
import { getMockClientWithEventEmitter, mockClientMethodsCrypto } from "test-utils";
import { getDeviceCryptoInfo, getUserDeviceIds } from "./deviceInfo";
describe("getDeviceCryptoInfo()", () => {
let mockClient: Mocked<MatrixClient>;
beforeEach(() => {
mockClient = getMockClientWithEventEmitter({ ...mockClientMethodsCrypto() });
});
it("should return undefined on clients with no crypto", async () => {
vi.spyOn(mockClient, "getCrypto").mockReturnValue(undefined);
await expect(getDeviceCryptoInfo(mockClient, "@user:id", "device_id")).resolves.toBeUndefined();
});
it("should return undefined for unknown users", async () => {
vi.mocked(mockClient.getCrypto()!.getUserDeviceInfo).mockResolvedValue(new Map());
await expect(getDeviceCryptoInfo(mockClient, "@user:id", "device_id")).resolves.toBeUndefined();
});
it("should return undefined for unknown devices", async () => {
vi.mocked(mockClient.getCrypto()!.getUserDeviceInfo).mockResolvedValue(new Map([["@user:id", new Map()]]));
await expect(getDeviceCryptoInfo(mockClient, "@user:id", "device_id")).resolves.toBeUndefined();
});
it("should return the right result for known devices", async () => {
const mockDevice = { deviceId: "device_id" } as Device;
vi.mocked(mockClient.getCrypto()!.getUserDeviceInfo).mockResolvedValue(
new Map([["@user:id", new Map([["device_id", mockDevice]])]]),
);
await expect(getDeviceCryptoInfo(mockClient, "@user:id", "device_id")).resolves.toBe(mockDevice);
expect(mockClient.getCrypto()!.getUserDeviceInfo).toHaveBeenCalledWith(["@user:id"], undefined);
});
});
describe("getUserDeviceIds", () => {
let mockClient: Mocked<MatrixClient>;
beforeEach(() => {
mockClient = getMockClientWithEventEmitter({ ...mockClientMethodsCrypto() });
});
it("should return empty set on clients with no crypto", async () => {
vi.spyOn(mockClient, "getCrypto").mockReturnValue(undefined);
await expect(getUserDeviceIds(mockClient, "@user:id")).resolves.toEqual(new Set());
});
it("should return empty set for unknown users", async () => {
vi.mocked(mockClient.getCrypto()!.getUserDeviceInfo).mockResolvedValue(new Map());
await expect(getUserDeviceIds(mockClient, "@user:id")).resolves.toEqual(new Set());
});
it("should return the right result for known users", async () => {
const mockDevice = { deviceId: "device_id" } as Device;
vi.mocked(mockClient.getCrypto()!.getUserDeviceInfo).mockResolvedValue(
new Map([["@user:id", new Map([["device_id", mockDevice]])]]),
);
await expect(getUserDeviceIds(mockClient, "@user:id")).resolves.toEqual(new Set(["device_id"]));
expect(mockClient.getCrypto()!.getUserDeviceInfo).toHaveBeenCalledWith(["@user:id"]);
});
});
@@ -0,0 +1,64 @@
/*
Copyright 2024 New Vector Ltd.
Copyright 2023 The Matrix.org Foundation C.I.C.
SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only OR LicenseRef-Element-Commercial
Please see LICENSE files in the repository root for full details.
*/
// @vitest-environment happy-dom
import { vi, describe, it, expect, beforeEach } from "vitest";
import { getMockClientWithEventEmitter } from "test-utils";
import { shouldForceDisableEncryption } from "./shouldForceDisableEncryption";
describe("shouldForceDisableEncryption()", () => {
const mockClient = getMockClientWithEventEmitter({
getClientWellKnown: vi.fn(),
});
beforeEach(() => {
mockClient.getClientWellKnown.mockReturnValue(undefined);
});
it("should return false when there is no e2ee well known", () => {
expect(shouldForceDisableEncryption(mockClient)).toEqual(false);
});
it("should return false when there is no force_disable property", () => {
mockClient.getClientWellKnown.mockReturnValue({
"io.element.e2ee": {
// empty
},
});
expect(shouldForceDisableEncryption(mockClient)).toEqual(false);
});
it("should return false when force_disable property is falsy", () => {
mockClient.getClientWellKnown.mockReturnValue({
"io.element.e2ee": {
force_disable: false,
},
});
expect(shouldForceDisableEncryption(mockClient)).toEqual(false);
});
it("should return false when force_disable property is not equal to true", () => {
mockClient.getClientWellKnown.mockReturnValue({
"io.element.e2ee": {
force_disable: 1,
},
});
expect(shouldForceDisableEncryption(mockClient)).toEqual(false);
});
it("should return true when force_disable property is true", () => {
mockClient.getClientWellKnown.mockReturnValue({
"io.element.e2ee": {
force_disable: true,
},
});
expect(shouldForceDisableEncryption(mockClient)).toEqual(true);
});
});