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.

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

flaky test: "Backup and Restore should backup the account settings" #24668

Closed
chloeYue opened this issue May 21, 2024 · 1 comment · Fixed by #27565
Closed

flaky test: "Backup and Restore should backup the account settings" #24668

chloeYue opened this issue May 21, 2024 · 1 comment · Fixed by #27565
Assignees
Labels
flaky tests release-12.6.0 Issue or pull request that will be included in release 12.6.0 team-extension-platform

Comments

@chloeYue
Copy link
Contributor

chloeYue commented May 21, 2024

What is this about?

Failure:

https://app.circleci.com/pipelines/github/MetaMask/metamask-extension/101416/workflows/968f676b-e196-4168-bfb2-47509fe34a59/jobs/3775778

@chloeYue
Copy link
Contributor Author

This test is still flaky and needs investigation

@seaona seaona self-assigned this Oct 2, 2024
github-merge-queue bot pushed a commit that referenced this issue Oct 2, 2024
…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.
@metamaskbot metamaskbot added the release-12.6.0 Issue or pull request that will be included in release 12.6.0 label Oct 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
flaky tests release-12.6.0 Issue or pull request that will be included in release 12.6.0 team-extension-platform
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants