Skip to content

Commit

Permalink
fix: flaky test `Backup and Restore should backup the account setting…
Browse files Browse the repository at this point in the history
…s` (#27565)

<!--
Please submit this PR as a draft initially.
Do not mark it as "Ready for review" until the template has been
completely filled out, and PR status checks have passed at least once.
-->

## **Description**

Race condition originated when trying to read the backup file. Checking
the ci artifacts we can see how [the backup file
](https://app.circleci.com/pipelines/github/MetaMask/metamask-extension/101416/workflows/968f676b-e196-4168-bfb2-47509fe34a59/jobs/3775778/artifacts)was
downloaded correctly, so the problem is somewhere in the read/access
point.
After checking the documentation I've seen that using `fs.access` before
reading a file is discouraged as it could cause a race condition:

![Screenshot from 2024-10-02
15-32-21](https://github.com/user-attachments/assets/0329ef67-e4da-483d-9cf8-c159734de0fe)


I've removed that step, and we are now reading the file directly, and
added a console.log in the catch block, to get more information in the
case the test fails in the reading step, so we can better debug.

We can keep monitoring the test in case it fails in the future. So far,
it hasn't failed after several local re-runs (and ci with extra x5)

[![Open in GitHub
Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/MetaMask/metamask-extension/pull/27565?quickstart=1)

## **Related issues**

Fixes: #24668

## **Manual testing steps**

1. Check ci
2. Run locally the test

## **Screenshots/Recordings**

<!-- If applicable, add screenshots and/or recordings to visualize the
before and after of your change. -->

### **Before**

<!-- [screenshots/recordings] -->

### **After**

<!-- [screenshots/recordings] -->

## **Pre-merge author checklist**

- [x] I've followed [MetaMask Contributor
Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask
Extension Coding
Standards](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/CODING_GUIDELINES.md).
- [x] I've completed the PR template to the best of my ability
- [x] I’ve included tests if applicable
- [x] I’ve documented my code using [JSDoc](https://jsdoc.app/) format
if applicable
- [x] I’ve applied the right labels on the PR (see [labeling
guidelines](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/LABELING_GUIDELINES.md)).
Not required for external contributors.

## **Pre-merge reviewer checklist**

- [ ] I've manually tested the PR (e.g. pull and build branch, run the
app, test code being changed).
- [ ] I confirm that this PR addresses all acceptance criteria described
in the ticket it closes and includes the necessary testing evidence such
as recordings and or screenshots.
  • Loading branch information
seaona authored Oct 2, 2024
1 parent 453e043 commit 879b1d9
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion test/e2e/tests/settings/backup-restore.spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,10 @@ const getBackupJson = async () => {

try {
const backup = `${downloadsFolder}/${userDataFileName}`;
await fs.access(backup);
const contents = await fs.readFile(backup);
return JSON.parse(contents.toString());
} catch (e) {
console.log('Error reading the backup file', e);
return null;
}
};
Expand Down

0 comments on commit 879b1d9

Please sign in to comment.