Set up key backup using non-deprecated APIs (2nd take) by BillCarsonFr · Pull Request #12098 · matrix-org/matrix-react-sdk

BillCarsonFr · 2024-01-02T19:29:28Z

Checklist

Tests written for new code (and old code if feasible)
Linter and other CI checks pass
Sign-off given on the changes (see CONTRIBUTING.md)

Fixes element-hq/element-web#26323

Put back the changes that were on #12005 without the regression that causes unwanted backup resets

Here's what your changelog entry will look like:

🐛 Bug Fixes

Set up key backup using non-deprecated APIs (2nd take) (#12098). Fixes Element-R: "Set up key backup" button doesn't work element-hq/element-web#26323.

…log.tsx Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>

richvdh

a few more suggestions for clarity, but lgtm otherwise

richvdh · 2024-01-09T12:03:01Z

+            const secretStorageAlreadySetup = await cli.hasSecretStorageKey();
+
+            if (!secretStorageAlreadySetup) {
+                // bootstrap secret storage, that will also create a backup version


nit

Suggested change

// bootstrap secret storage, that will also create a backup version

// bootstrap secret storage; that will also create a backup version

richvdh · 2024-01-09T12:03:10Z

+            if (!secretStorageAlreadySetup) {
+                // bootstrap secret storage, that will also create a backup version
+                await accessSecretStorage(async (): Promise<void> => {
+                    // do nothing, all is now setup correctly


nit

Suggested change

// do nothing, all is now setup correctly

// do nothing, all is now set up correctly

richvdh · 2024-01-09T12:06:10Z

+                // Secret storage exists, we need to ensure that we can write to it before
+                // we create a new backup version. It ensures that we can write to it and keep it in sync.


Sorry, only just seeing this now. It rather duplicates the comment below.

Suggested change

// Secret storage exists, we need to ensure that we can write to it before

// we create a new backup version. It ensures that we can write to it and keep it in sync.

richvdh · 2024-01-09T12:08:36Z


+        secretStorage: {
+            get: jest.fn(),
+        } as unknown as ServerSideSecretStorage,


I'm surprised this typecast is necessary: it doesn't seem to be for any of the other properties. Can we get rid of it?

Suggested change

} as unknown as ServerSideSecretStorage,

},

(also remove the import of ServerSideSecretStorage)

richvdh · 2024-01-09T12:10:01Z

+        await currentDialogLocator.getByRole("button", { name: "Copy", exact: true }).click();
+
+        // copy the recovery key to use it later
+        securityKey = await app.getClipboard();


Suggested change

securityKey = await app.getClipboard();

const securityKey = await app.getClipboard();

richvdh · 2024-01-09T12:11:17Z

+
+        let securityKey = "";
+
+        const currentDialogLocator = page.locator(".mx_Dialog");


suggest moving this (const currentDialogLocator = page.locator(".mx_Dialog");) down to where it is used.

richvdh · 2024-01-09T12:12:37Z

+        // Create a backup
+        const tab = await app.settings.openUserSettings("Security & Privacy");
+
+        await expect(tab.getByRole("heading", { name: "Secure Backup" })).toBeVisible();
+
+        let securityKey = "";
+
+        const currentDialogLocator = page.locator(".mx_Dialog");
+
+        await tab.getByRole("button", { name: "Set up", exact: true }).click();


Lots of whitespace here, and I don't think it helps readability.

Suggested change

// Create a backup

const tab = await app.settings.openUserSettings("Security & Privacy");

await expect(tab.getByRole("heading", { name: "Secure Backup" })).toBeVisible();

let securityKey = "";

const currentDialogLocator = page.locator(".mx_Dialog");

await tab.getByRole("button", { name: "Set up", exact: true }).click();

// Create a backup

const tab = await app.settings.openUserSettings("Security & Privacy");

await expect(tab.getByRole("heading", { name: "Secure Backup" })).toBeVisible();

await tab.getByRole("button", { name: "Set up", exact: true }).click();

richvdh · 2024-01-09T12:12:50Z

+
+        await tab.getByRole("button", { name: "Set up", exact: true }).click();
+
+        // It's the first time and secure storage not setup, so it will create one


nit

Suggested change

// It's the first time and secure storage not setup, so it will create one

// It's the first time and secure storage is not set up, so it will create one

richvdh · 2024-01-09T12:14:47Z

+        await tab.getByRole("button", { name: "Delete Backup", exact: true }).click();
+
+        await expect(currentDialogLocator.getByRole("heading", { name: "Delete Backup" })).toBeVisible();
+
+        // Delete it
+        await currentDialogLocator.getByTestId("dialog-primary-button").click(); // Click "Delete Backup"


Again, too much whitespace. And the comment is in the wrong place.

Suggested change

await tab.getByRole("button", { name: "Delete Backup", exact: true }).click();

await expect(currentDialogLocator.getByRole("heading", { name: "Delete Backup" })).toBeVisible();

// Delete it

await currentDialogLocator.getByTestId("dialog-primary-button").click(); // Click "Delete Backup"

// Delete it

await tab.getByRole("button", { name: "Delete Backup", exact: true }).click();

await expect(currentDialogLocator.getByRole("heading", { name: "Delete Backup" })).toBeVisible();

await currentDialogLocator.getByTestId("dialog-primary-button").click(); // Click "Delete Backup"

richvdh · 2024-01-09T12:19:52Z

+        await currentDialogLocator.getByTestId("dialog-cancel-button").click();
+
+        // go back to the settings to check that no backup was created (the setup button should still be there)
+        const tab2 = await app.settings.openUserSettings("Security & Privacy");


why do we create a new tab2 here, but not the other two times we re-open the settings? Surely either we can re-use tab or we can't?

BillCarsonFr added 2 commits January 2, 2024 20:03

Ensure backup settings in playwright

c263b17

Fix verification by pass causing backup reset

c0cef0b

BillCarsonFr added T-Task Refactoring, enabling or disabling functionality, other engineering tasks T-Defect Bugs, crashes, hangs, vulnerabilities, or other reported problems labels Jan 2, 2024

BillCarsonFr requested a review from a team as a code owner January 2, 2024 19:29

BillCarsonFr requested review from florianduros and robintown January 2, 2024 19:29

BillCarsonFr changed the base branch from develop to valere/better_e2e_playwrigth_test January 2, 2024 19:30

github-actions Bot deployed to Netlify January 2, 2024 19:32 View deployment

BillCarsonFr marked this pull request as draft January 2, 2024 19:33

github-actions Bot deployed to EndToEndTests January 2, 2024 19:52 View deployment

fix force backup setup by default

1bc286c

github-actions Bot deployed to Netlify January 3, 2024 14:03 View deployment

BillCarsonFr requested review from richvdh and removed request for robintown January 3, 2024 14:06

fix test

70091ad

BillCarsonFr marked this pull request as ready for review January 3, 2024 14:13

github-actions Bot deployed to Netlify January 3, 2024 14:17 View deployment

github-actions Bot deployed to EndToEndTests January 3, 2024 14:36 View deployment

richvdh suggested changes Jan 3, 2024

View reviewed changes

Comment thread src/async-components/views/dialogs/security/CreateKeyBackupDialog.tsx Outdated

Comment thread src/async-components/views/dialogs/security/CreateKeyBackupDialog.tsx

Comment thread src/async-components/views/dialogs/security/CreateKeyBackupDialog.tsx Outdated

BillCarsonFr mentioned this pull request Jan 3, 2024

Revert "Set up key backup using non-deprecated APIs (#12005)" #12102

Merged

3 tasks

clarify when we need to bootstrap

795e214

github-actions Bot deployed to Netlify January 3, 2024 17:31 View deployment

jslint

d5a227c

github-actions Bot deployed to Netlify January 3, 2024 17:57 View deployment

github-actions Bot deployed to EndToEndTests January 3, 2024 18:21 View deployment

BillCarsonFr added 2 commits January 4, 2024 15:41

Merge branch 'develop' into valere/fix_reset_backup_after_verif

befa0f9

post merge fix

3a1305e

BillCarsonFr changed the base branch from valere/better_e2e_playwrigth_test to develop January 4, 2024 16:34

post rebase missing files

8c087e0

BillCarsonFr requested a review from a team as a code owner January 9, 2024 09:22

github-actions Bot deployed to Netlify January 9, 2024 09:26 View deployment

Update src/async-components/views/dialogs/security/CreateKeyBackupDia…

5114eb4

…log.tsx Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>

github-actions Bot deployed to Netlify January 9, 2024 09:30 View deployment

unneeded permission

f1e89cc

github-actions Bot deployed to Netlify January 9, 2024 09:44 View deployment

github-actions Bot deployed to EndToEndTests January 9, 2024 10:03 View deployment

Merge branch 'develop' into valere/fix_reset_backup_after_verif

9b2a902

BillCarsonFr requested a review from richvdh January 9, 2024 10:25

github-actions Bot deployed to Netlify January 9, 2024 10:28 View deployment

github-actions Bot deployed to EndToEndTests January 9, 2024 10:47 View deployment

richvdh approved these changes Jan 9, 2024

View reviewed changes

code review

0b82647

github-actions Bot deployed to Netlify January 9, 2024 14:24 View deployment

BillCarsonFr added 2 commits January 9, 2024 15:36

cleaning

2ae60bc

Merge branch 'develop' into valere/fix_reset_backup_after_verif

5c9494e

github-actions Bot deployed to Netlify January 9, 2024 14:40 View deployment

github-actions Bot deployed to EndToEndTests January 9, 2024 15:01 View deployment

BillCarsonFr added this pull request to the merge queue Jan 9, 2024

t3chguy removed this pull request from the merge queue due to a manual request Jan 9, 2024

t3chguy added this pull request to the merge queue Jan 9, 2024

github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Jan 9, 2024

t3chguy added this pull request to the merge queue Jan 9, 2024

github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Jan 9, 2024

t3chguy added this pull request to the merge queue Jan 10, 2024

github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Jan 10, 2024

t3chguy added this pull request to the merge queue Jan 10, 2024

Merged via the queue into develop with commit 0337bd1 Jan 10, 2024

t3chguy deleted the valere/fix_reset_backup_after_verif branch January 10, 2024 11:27

	// bootstrap secret storage, that will also create a backup version
	// bootstrap secret storage; that will also create a backup version

	// do nothing, all is now setup correctly
	// do nothing, all is now set up correctly

		// Secret storage exists, we need to ensure that we can write to it before
		// we create a new backup version. It ensures that we can write to it and keep it in sync.

	securityKey = await app.getClipboard();
	const securityKey = await app.getClipboard();


		let securityKey = "";

		const currentDialogLocator = page.locator(".mx_Dialog");


		await tab.getByRole("button", { name: "Set up", exact: true }).click();

		// It's the first time and secure storage not setup, so it will create one

Uh oh!

Conversation

BillCarsonFr commented Jan 2, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Checklist

🐛 Bug Fixes

Uh oh!

Uh oh!

Uh oh!

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!

richvdh Jan 9, 2024 • 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!

Choose a reason for hiding this comment

Uh oh!

richvdh Jan 9, 2024 • 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!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

BillCarsonFr commented Jan 2, 2024 •

edited

Loading

richvdh Jan 9, 2024 •

edited

Loading

richvdh Jan 9, 2024 •

edited

Loading