This repository has been archived by the owner on Sep 11, 2024. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 828
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Kill off references to deprecated
getStoredDevice and `getStoredDev…
…icesForUser` (#11152) * Use new `CryptoEvent.VerificationRequestReceived` event matrix-org/matrix-js-sdk#3514 deprecates `CryptoEvent.VerificationRequest` in favour of `CryptoEvent.VerificationRequestReceived`. Use the new event. * Factor out `getDeviceCryptoInfo` function I seem to be writing this logic several times, so let's factor it out. * Factor out `getUserDeviceIds` function Another utility function * VerificationRequestToast: `getStoredDevice` -> `getDeviceCryptoInfo` * SlashCommands: `getStoredDevice` -> `getDeviceCryptoInfo` * MemberTile: `getStoredDevicesForUser` -> `getUserDeviceIds` * Remove redundant mock of `getStoredDevicesForUser`
- Loading branch information
Showing
11 changed files
with
189 additions
and
34 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| /* | ||
| 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 { Device, MatrixClient } from "matrix-js-sdk/src/matrix"; | ||
|
|
||
| /** | ||
| * Get crypto information on a specific device. | ||
| * | ||
| * Only devices with Crypto support are returned. If the MatrixClient doesn't support cryptography, `undefined` is | ||
| * returned. | ||
| * | ||
| * @param client - Matrix Client. | ||
| * @param userId - ID of the user owning the device. | ||
| * @param deviceId - ID of the device. | ||
| * @param downloadUncached - If true, download the device list for users whose device list we are not | ||
| * currently tracking. Defaults to false. | ||
| * | ||
| * @returns Information on the device if it is known. | ||
| */ | ||
| export async function getDeviceCryptoInfo( | ||
| client: MatrixClient, | ||
| userId: string, | ||
| deviceId: string, | ||
| downloadUncached?: boolean, | ||
| ): Promise<Device | undefined> { | ||
| const crypto = client.getCrypto(); | ||
| if (!crypto) { | ||
| // no crypto support, no device. | ||
| return undefined; | ||
| } | ||
|
|
||
| const deviceMap = await crypto.getUserDeviceInfo([userId], downloadUncached); | ||
| return deviceMap.get(userId)?.get(deviceId); | ||
| } | ||
|
|
||
| /** | ||
| * Get the IDs of the given user's devices. | ||
| * | ||
| * Only devices with Crypto support are returned. If the MatrixClient doesn't support cryptography, an empty Set is | ||
| * returned. | ||
| * | ||
| * @param client - Matrix Client. | ||
| * @param userId - ID of the user to query. | ||
| */ | ||
|
|
||
| export async function getUserDeviceIds(client: MatrixClient, userId: string): Promise<Set<string>> { | ||
| const crypto = client.getCrypto(); | ||
| if (!crypto) { | ||
| return new Set(); | ||
| } | ||
|
|
||
| const deviceMap = await crypto.getUserDeviceInfo([userId]); | ||
| return new Set(deviceMap.get(userId)?.keys() ?? []); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,80 @@ | ||
| /* | ||
| 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 { Mocked, mocked } from "jest-mock"; | ||
| import { Device, MatrixClient } from "matrix-js-sdk/src/matrix"; | ||
|
|
||
| import { getDeviceCryptoInfo, getUserDeviceIds } from "../../../src/utils/crypto/deviceInfo"; | ||
| import { getMockClientWithEventEmitter, mockClientMethodsCrypto } from "../../test-utils"; | ||
|
|
||
| describe("getDeviceCryptoInfo()", () => { | ||
| let mockClient: Mocked<MatrixClient>; | ||
|
|
||
| beforeEach(() => { | ||
| mockClient = getMockClientWithEventEmitter({ ...mockClientMethodsCrypto() }); | ||
| }); | ||
|
|
||
| it("should return undefined on clients with no crypto", async () => { | ||
| jest.spyOn(mockClient, "getCrypto").mockReturnValue(undefined); | ||
| await expect(getDeviceCryptoInfo(mockClient, "@user:id", "device_id")).resolves.toBeUndefined(); | ||
| }); | ||
|
|
||
| it("should return undefined for unknown users", async () => { | ||
| 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 () => { | ||
| 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; | ||
| 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 () => { | ||
| jest.spyOn(mockClient, "getCrypto").mockReturnValue(undefined); | ||
| await expect(getUserDeviceIds(mockClient, "@user:id")).resolves.toEqual(new Set()); | ||
| }); | ||
|
|
||
| it("should return empty set for unknown users", async () => { | ||
| 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; | ||
| 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"]); | ||
| }); | ||
| }); |