This repository has been archived by the owner on Sep 11, 2024. It is now read-only.
Set up key backup using non-deprecated APIs (2nd take) #12098
Merged
Conversation
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
BillCarsonFr
added
T-Task
BillCarsonFr
changed the base branch from
develop
to
valere/better_e2e_playwrigth_test
richvdh
suggested changes
Jan 3, 2024
src/async-components/views/dialogs/security/CreateKeyBackupDialog.tsx
Outdated
Show resolved
Hide resolved
src/async-components/views/dialogs/security/CreateKeyBackupDialog.tsx
Outdated
Show resolved
Hide resolved
3 tasks
BillCarsonFr
changed the base branch from
valere/better_e2e_playwrigth_test
to
develop
…log.tsx Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
richvdh
approved these changes
Jan 9, 2024
| const secretStorageAlreadySetup = await cli.hasSecretStorageKey(); | ||
|
|
||
| if (!secretStorageAlreadySetup) { | ||
| // bootstrap secret storage, that will also create a backup version |
There was a problem hiding this comment.
nit
Suggested change
| // bootstrap secret storage, that will also create a backup version | |
| // bootstrap secret storage; that will also create a backup version |
| if (!secretStorageAlreadySetup) { | ||
| // bootstrap secret storage, that will also create a backup version | ||
| await accessSecretStorage(async (): Promise<void> => { | ||
| // do nothing, all is now setup correctly |
There was a problem hiding this comment.
nit
Suggested change
| // do nothing, all is now setup correctly | |
| // do nothing, all is now set up correctly |
Comment on lines
88
to
89
| // 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. |
There was a problem hiding this comment.
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. |
test/test-utils/test-utils.ts
Outdated
| @@ -116,6 +117,10 @@ export function createTestClient(): MatrixClient { | |||
| bootstrapCrossSigning: jest.fn(), | |||
| hasSecretStorageKey: jest.fn(), | |||
|
|
|||
| secretStorage: { | |||
| get: jest.fn(), | |||
| } as unknown as ServerSideSecretStorage, | |||
There was a problem hiding this comment.
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, | |
| }, |
There was a problem hiding this comment.
(also remove the import of ServerSideSecretStorage)
| await currentDialogLocator.getByRole("button", { name: "Copy", exact: true }).click(); | ||
|
|
||
| // copy the recovery key to use it later | ||
| securityKey = await app.getClipboard(); |
There was a problem hiding this comment.
Suggested change
| securityKey = await app.getClipboard(); | |
| const securityKey = await app.getClipboard(); |
|
|
||
| let securityKey = ""; | ||
|
|
||
| const currentDialogLocator = page.locator(".mx_Dialog"); |
There was a problem hiding this comment.
suggest moving this (const currentDialogLocator = page.locator(".mx_Dialog");) down to where it is used.
Comment on lines
35
to
44
| // 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(); |
There was a problem hiding this comment.
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(); |
|
|
||
| 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 |
There was a problem hiding this comment.
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 |
Comment on lines
72
to
77
| 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" |
There was a problem hiding this comment.
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" |
| 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"); |
There was a problem hiding this comment.
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?
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Checklist
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