Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace MatrixClient.isRoomEncrypted by MatrixClient.CryptoApi.isEncryptionEnabledInRoom in useIsEncrypted #28282

Merged
merged 5 commits into from
Nov 13, 2024
Merged

Replace MatrixClient.isRoomEncrypted by MatrixClient.CryptoApi.isEncryptionEnabledInRoom in useIsEncrypted #28282

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
08617d3
Replace `MatrixClient.isRoomEncrypted` by `MatrixClient.CryptoApi.isE…
florianduros Oct 23, 2024
8eb84c2
Merge branch 'develop' into florianduros/rip-out-legacy-crypto/migrat…
florianduros Nov 12, 2024
639de21
Catch error
florianduros Nov 12, 2024
c76f086
Return `null` when computed
florianduros Nov 12, 2024
0ee713a
Use `useRoomState` & `useAsyncMemo`
florianduros Nov 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 15 additions & 6 deletions src/hooks/useIsEncrypted.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,28 @@ SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only
Please see LICENSE files in the repository root for full details.
*/

import { useCallback, useState } from "react";
import { useCallback, useEffect, useState } from "react";
import { MatrixClient, MatrixEvent, Room, RoomStateEvent, EventType } from "matrix-js-sdk/src/matrix";

import { useTypedEventEmitter } from "./useEventEmitter";

// Hook to simplify watching whether a Matrix room is encrypted, returns undefined if room is undefined
export function useIsEncrypted(cli: MatrixClient, room?: Room): boolean | undefined {
const [isEncrypted, setIsEncrypted] = useState(room ? cli.isRoomEncrypted(room.roomId) : undefined);
// Hook to simplify watching whether a Matrix room is encrypted, returns undefined if room is undefined, return null when isRoomEncrypted is computed
florianduros marked this conversation as resolved.
Show resolved Hide resolved
export function useIsEncrypted(cli: MatrixClient, room?: Room): boolean | undefined | null {
const [isEncrypted, setIsEncrypted] = useState<boolean | null | undefined>(null);

useEffect(() => {
const func = async (): Promise<void> =>
room && setIsEncrypted(await cli.getCrypto()?.isEncryptionEnabledInRoom(room.roomId));
func();
florianduros marked this conversation as resolved.
Show resolved Hide resolved
}, [cli, room]);
const update = useCallback(
(event: MatrixEvent) => {
async (event: MatrixEvent) => {
if (room && event.getType() === EventType.RoomEncryption) {
setIsEncrypted(cli.isRoomEncrypted(room.roomId));
try {
setIsEncrypted(await cli.getCrypto()?.isEncryptionEnabledInRoom(room.roomId));
} catch {
setIsEncrypted(false);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if encrypted is true and the room didn't change but isEncryptionEnabledInRoom threw should we really be setting to false? This seems unexpected.

We probably also need to reset to null when room changes whilst func is calling the async function which could take multiple ticks

}
}
},
[cli, room],
Expand Down
13 changes: 2 additions & 11 deletions test/unit-tests/components/views/right_panel/RoomSummaryCard-test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ import * as settingsHooks from "../../../../../src/hooks/useSettings";
import Modal from "../../../../../src/Modal";
import RightPanelStore from "../../../../../src/stores/right-panel/RightPanelStore";
import { RightPanelPhases } from "../../../../../src/stores/right-panel/RightPanelStorePhases";
import { flushPromises, getMockClientWithEventEmitter, mockClientMethodsUser } from "../../../../test-utils";
import { flushPromises, stubClient } from "../../../../test-utils";
import { PollHistoryDialog } from "../../../../../src/components/views/dialogs/PollHistoryDialog";
import { RoomPermalinkCreator } from "../../../../../src/utils/permalinks/Permalinks";
import { _t } from "../../../../../src/languageHandler";
Expand Down Expand Up @@ -56,16 +56,7 @@ describe("<RoomSummaryCard />", () => {
};

beforeEach(() => {
mockClient = getMockClientWithEventEmitter({
...mockClientMethodsUser(userId),
getAccountData: jest.fn(),
isRoomEncrypted: jest.fn(),
getOrCreateFilter: jest.fn().mockResolvedValue({ filterId: 1 }),
getRoom: jest.fn(),
isGuest: jest.fn().mockReturnValue(false),
deleteRoomTag: jest.fn().mockResolvedValue({}),
setRoomTag: jest.fn().mockResolvedValue({}),
});
mockClient = mocked(stubClient());
room = new Room(roomId, mockClient, userId);
const roomCreateEvent = new MatrixEvent({
type: "m.room.create",
Expand Down
4 changes: 2 additions & 2 deletions test/unit-tests/components/views/right_panel/UserInfo-test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,7 @@ beforeEach(() => {
getUserDeviceInfo: jest.fn(),
userHasCrossSigningKeys: jest.fn().mockResolvedValue(false),
getUserVerificationStatus: jest.fn(),
isEncryptionEnabledInRoom: jest.fn().mockResolvedValue(false),
} as unknown as CryptoApi);

mockClient = mocked({
Expand All @@ -148,7 +149,6 @@ beforeEach(() => {
on: jest.fn(),
off: jest.fn(),
isSynapseAdministrator: jest.fn().mockResolvedValue(false),
isRoomEncrypted: jest.fn().mockReturnValue(false),
doesServerSupportUnstableFeature: jest.fn().mockReturnValue(false),
doesServerSupportExtendedProfiles: jest.fn().mockResolvedValue(false),
getExtendedProfileProperty: jest.fn().mockRejectedValue(new Error("Not supported")),
Expand Down Expand Up @@ -660,7 +660,7 @@ describe("<UserInfo />", () => {

describe("with an encrypted room", () => {
beforeEach(() => {
mockClient.isRoomEncrypted.mockReturnValue(true);
jest.spyOn(mockClient.getCrypto()!, "isEncryptionEnabledInRoom").mockResolvedValue(true);
});

it("renders unverified user info", async () => {
Expand Down
Loading