Implement lab for encrypted state events (MSC3414/MSC4362) #30877

kaylendog · 2025-09-25T09:21:32Z

Checklist

I have read through review guidelines and CONTRIBUTING.md.
Tests written for new code (and old code if feasible).
New or updated public/exported symbols have accurate TSDoc documentation.
Linter and other CI checks pass.
I have licensed the changes to Element by completing the Contributor License Agreement (CLA)

Signed-off-by: Skye Elliot <[email protected]>

kaylendog · 2025-09-25T10:57:10Z

Two potential considerations:

What do clients without the flag enabled see when using a room with state event encryption enabled?
Can clients without the flag enabled still send encrypted state events if they are sent in a room with state encryption enabled?

Half-Shot · 2025-09-25T11:14:14Z

Can clients without the flag enabled still send encrypted state events if they are sent in a room with state encryption enabled?

IMO it would make sense that clients with this flag enabled can create / enable rooms to have encrypted state, but all supporting clients regardless of features should be able to interact in these rooms. So, they should probably attempt to send encrypted state if the room requires it.

kaylendog · 2025-09-25T11:20:30Z

Can clients without the flag enabled still send encrypted state events if they are sent in a room with state encryption enabled?

IMO it would make sense that clients with this flag enabled can create / enable rooms to have encrypted state, but all supporting clients regardless of features should be able to interact in these rooms. So, they should probably attempt to send encrypted state if the room requires it.

I agree! The last commit I made locks MatrixClient.enableEncryptedStateEvents to true, but the toggle switch on the create room dialogue is still locked behind the lab flag.

kaylendog · 2025-09-30T13:04:52Z

It will be quite challenging to improve coverage on src/createRoom.ts, since it relies on an event listener attached to RoomState. There doesn't seem to be any existing infrastructure for mocking this behaviour.

florianduros

First quick review :)

src/settings/Settings.tsx

src/settings/controllers/EncryptedStateEventsController.ts

test/test-utils/test-utils.ts

src/components/views/dialogs/CreateRoomDialog.tsx

florianduros · 2025-10-01T14:26:09Z

src/createRoom.ts

+                    const timeout = setTimeout(() => {
+                        logger.warn("Timed out while waiting for room to enable encryption");
+                        roomState.off(RoomStateEvent.Update, onRoomStateUpdate);
+                        resolve();
+                    }, 3000);


If we have to wait for this long, we need a spinner or some feedback to the user

There is an existing spinner, I could force it to be shown If state event encryption is enabled?

florianduros · 2025-10-01T14:26:46Z

src/createRoom.ts

+
+                    const roomState = resolvedRoom.getLiveTimeline().getState(Direction.Forward)!;
+
+                    // Soft fail, since the room will still be functional if the initial state is not encrypted.


Also if it fails, how do we inform the user?

richvdh

a few drive-by comments; sorry, haven't done a full review

richvdh · 2025-10-07T15:29:09Z

test/unit-tests/createRoom-test.ts

        });
    });

+    it("creates a private with encryption", async () => {


Suggested change

it("creates a private with encryption", async () => {

it("creates a private room with encryption", async () => {

richvdh · 2025-10-07T15:31:22Z

src/createRoom.ts

+                // Set room avatar
+                if (opts.avatar) {
+                    let url: string;
+                    if (opts.avatar instanceof File) {
+                        ({ content_uri: url } = await client.uploadContent(opts.avatar));
+                    } else {
+                        url = opts.avatar;
+                    }
+                    await client.sendStateEvent(roomId, EventType.RoomAvatar, { url }, "");
+                }
+            }


looks like you could do with a test that hits this codepath

richvdh · 2025-10-07T15:33:53Z

src/createRoom.ts

    spinner?: boolean;
    guestAccess?: boolean;
    encryption?: boolean;
+    stateEncryption?: boolean;


new public field needs doc-comment, please

richvdh · 2025-10-07T15:52:44Z

src/createRoom.ts

+                await new Promise<void>((resolve, reject) => {
+                    if (resolvedRoom.hasEncryptionStateEvent()) {
+                        return resolve();
+                    }
+
+                    const roomState = resolvedRoom.getLiveTimeline().getState(Direction.Forward)!;
+
+                    // Soft fail, since the room will still be functional if the initial state is not encrypted.
+                    const timeout = setTimeout(() => {
+                        logger.warn("Timed out while waiting for room to enable encryption");
+                        roomState.off(RoomStateEvent.Update, onRoomStateUpdate);
+                        resolve();
+                    }, 3000);
+
+                    const onRoomStateUpdate = (state: RoomState): void => {
+                        if (state.getStateEvents(EventType.RoomEncryption, "")) {
+                            roomState.off(RoomStateEvent.Update, onRoomStateUpdate);
+                            clearTimeout(timeout);
+                            resolve();
+                        }
+                    };
+
+                    roomState.on(RoomStateEvent.Update, onRoomStateUpdate);
+                });


the createRoom function is way too long and complicated. Factor this bit (at least) out to a separate function?

richvdh · 2025-10-07T15:54:40Z

src/createRoom.ts

        });
    }

+    let stateEncryptedOpts: ICreateRoomOpts | undefined;


having a separate copy of the create opts feels like a confusing way to do things.

I think really, it's incorrect to pass the name in the ICreateRoomOpts (which is explicitly "a list of options to pass to the /createRoom API."); instead we should add a new name property to IOpts. (We could also add a sanity-check that throws an exception if someone attempts to set ICreateRoomOpts.name.) Suggest pulling this out to a separate PR.

Pulled it out here: #30981

kaylendog added 7 commits September 24, 2025 15:42

feat: Implemenet lab for encrypted state events (MSC3414)

8c73c33

Signed-off-by: Skye Elliot <[email protected]>

fix: Remove addition of optional encrypt_state_events field.

7d8f991

fix: Only include encrypt_state_events if we set it to true.

d86bea5

feat: Add stateEncryption flag to SecurityRoomSettingsTab.

e7104b7

tests: Fixup tests for state event encryption lab.

03d43ce

fix: Run yarn i18n to (hopefully) correct translations.

8a08134

Merge branch 'element-hq:develop' into kaylendog/msc3414

d51ba4b

github-actions bot deployed to Netlify September 25, 2025 09:25 View deployment

kaylendog self-assigned this Sep 25, 2025

kaylendog added Z-Labs Z-Parity T-Enhancement and removed Z-Parity labels Sep 25, 2025

github-actions bot deployed to EndToEndTests September 25, 2025 09:35 View deployment

Merge branch 'develop' into kaylendog/msc3414

d053a20

kaylendog marked this pull request as ready for review September 25, 2025 09:42

kaylendog requested review from a team as code owners September 25, 2025 09:42

kaylendog requested review from MidhunSureshR and florianduros September 25, 2025 09:42

github-actions bot deployed to Netlify September 25, 2025 09:45 View deployment

github-actions bot deployed to EndToEndTests September 25, 2025 09:56 View deployment

feat: Enable encrypted state events JS client flag by default.

f568949

kaylendog force-pushed the kaylendog/msc3414 branch from 47ec3fd to f568949 Compare September 25, 2025 11:06

github-actions bot deployed to Netlify September 25, 2025 11:09 View deployment

github-actions bot deployed to EndToEndTests September 25, 2025 11:22 View deployment

Merge branch 'develop' into kaylendog/msc3414

a2ff003

github-actions bot deployed to Netlify September 29, 2025 13:31 View deployment

github-actions bot deployed to EndToEndTests September 29, 2025 13:43 View deployment

fix: Erase correct options variable.

da30063

github-actions bot deployed to Netlify September 29, 2025 14:01 View deployment

github-actions bot deployed to EndToEndTests September 29, 2025 14:14 View deployment

fix: Clone createOpts rather than construct reference.

b691621

github-actions bot deployed to Netlify September 29, 2025 14:34 View deployment

github-actions bot deployed to EndToEndTests September 29, 2025 14:44 View deployment

kaylendog added 3 commits September 29, 2025 18:06

tests: Ensure room name is not included in initial_state.

ebd42c1

fix: De-async onChange method in encrypted state settings controller.

bed2888

Merge branch 'develop' into kaylendog/msc3414

fe4c48f

github-actions bot deployed to Netlify September 29, 2025 17:11 View deployment

github-actions bot deployed to EndToEndTests September 29, 2025 17:23 View deployment

feat: Re-introduce wait on room encryption state.

d11cb24

github-actions bot deployed to Netlify September 30, 2025 10:18 View deployment

github-actions bot deployed to EndToEndTests September 30, 2025 10:31 View deployment

fix: Linting error on import.

0808466

github-actions bot deployed to Netlify September 30, 2025 13:15 View deployment

github-actions bot deployed to EndToEndTests September 30, 2025 14:18 View deployment

florianduros requested changes Oct 1, 2025

View reviewed changes

richvdh reviewed Oct 7, 2025

View reviewed changes

kaylendog added 4 commits October 8, 2025 12:21

fix: Set shared history properly, spelling issues in translations.

0fc92d4

chore: Remove redundant if statement.

bb874c4

fix: Simplify E2EE state dialog caption logic.

d538135

feat: Refactor state encryption logic to helper function.

10f34e1

kaylendog mentioned this pull request Oct 9, 2025

Move room name, avatar, and topic to IOpts. #30981

Open

5 tasks

Merge remote-tracking branch 'upstream/develop' into kaylendog/msc3414

330ec69

github-actions bot requested a deployment to Netlify October 9, 2025 15:45 In progress

github-actions bot deployed to EndToEndTests October 9, 2025 16:01 View deployment


		const roomState = resolvedRoom.getLiveTimeline().getState(Direction.Forward)!;

		// Soft fail, since the room will still be functional if the initial state is not encrypted.

	it("creates a private with encryption", async () => {
	it("creates a private room with encryption", async () => {

Uh oh!

Implement lab for encrypted state events (MSC3414/MSC4362) #30877

Are you sure you want to change the base?

Implement lab for encrypted state events (MSC3414/MSC4362) #30877

Uh oh!

Conversation

kaylendog commented Sep 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Checklist

Uh oh!

kaylendog commented Sep 25, 2025

Uh oh!

Half-Shot commented Sep 25, 2025

Uh oh!

kaylendog commented Sep 25, 2025

Uh oh!

kaylendog commented Sep 30, 2025

Uh oh!

florianduros left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kaylendog Oct 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

richvdh left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

kaylendog commented Sep 25, 2025 •

edited

Loading

kaylendog Oct 8, 2025 •

edited

Loading