Skip to content

Commit

Permalink
fix: Mutex never gets released on refresh function of AccountTrackerC…
Browse files Browse the repository at this point in the history
…ontroller (#4270)

## Explanation

<!--
Thanks for your contribution! Take a moment to answer these questions so
that reviewers have the information they need to properly understand
your changes:

* What is the current state of things and why does it need to change?


* What is the solution your changes offer and how does it work?


* Are there any changes whose purpose might not obvious to those
unfamiliar with the domain?
* If your primary goal was to update one package but you found you had
to update another one along the way, why did you do so?
* If you had to upgrade a dependency, why did you do so?
-->

Currently the mutex do not get released unless there is an error thrown
by the `getBalanceFromChain` function
Fixed by move the release of the murex to the finally block. It was also
removed unnecessary catch block.

Now the mutex gets released when the logic of refresh runs successfully 

### Fixed
- Ensure mutex is released when refresh succeeds
- Previously the `refresh` method would remain locked indefinitely after
it was run successfully. The mutex was only released upon failure.

## References

<!--
Are there any issues that this pull request is tied to? Are there other
links that reviewers should consult to understand these changes better?

For example:

* Fixes #12345
* Related to #67890
-->

## Changelog

<!--
If you're making any consumer-facing changes, list those changes here as
if you were updating a changelog, using the template below as a guide.

(CATEGORY is one of BREAKING, ADDED, CHANGED, DEPRECATED, REMOVED, or
FIXED. For security-related issues, follow the Security Advisory
process.)

Please take care to name the exact pieces of the API you've added or
changed (e.g. types, interfaces, functions, or methods).

If there are any breaking changes, make sure to offer a solution for
consumers to follow once they upgrade to the changes.

Finally, if you're only making changes to development scripts or tests,
you may replace the template below with "None".
-->

### `@metamask/assets-controllers`

- **FIXED**: Mutex released on the finally block of refresh function


## Checklist

- [ ] I've updated the test suite for new or updated code as appropriate
- [ ] I've updated documentation (JSDoc, Markdown, etc.) for new or
updated code as appropriate
- [ ] I've highlighted breaking changes using the "BREAKING" category
above as appropriate
  • Loading branch information
tommasini authored Jun 3, 2024
1 parent f8e343b commit 5251f3a
Showing 1 changed file with 1 addition and 2 deletions.
3 changes: 1 addition & 2 deletions packages/assets-controllers/src/AccountTrackerController.ts
Original file line number Diff line number Diff line change
Expand Up @@ -285,9 +285,8 @@ export class AccountTrackerController extends StaticIntervalPollingControllerV1<
[chainId]: accountsForChain,
},
});
} catch (err) {
} finally {
releaseLock();
throw err;
}
};

Expand Down

1 comment on commit 5251f3a

@dmrazzy
Copy link

@dmrazzy dmrazzy commented on 5251f3a Sep 1, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change m

Please sign in to comment.