MetaMask / MetaMask/eth-ledger-bridge-keyring

Safe-Proofing delayedPromise

Open
#162 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
84
Forks
122
PR merge metrics
No merged PRs in 30d

Description

If someone `init`'s the keyring twice, or calls `updateTransportMethod` twice quickly while the iframe is loading then you could run into situations where this `if` block runs (see [here](https://github.com/MetaMask/eth-ledger-bridge-keyring/blob/main/index.js#L458)) but when `this.delayedPromise.resolve(result)` or `this.delayedPromise.reject(e)` is called the object is deleted by a separate execution context.

Ways that this could be fixed:
* change `this.delayedPromise` to `this.delayedPromises: Array = []`, and then run something like:
```js
for (const delayedPromise of this.delayedPromises) {
this.updateTransportMethod(delayedPromise.transportType)
.then((res) => delayedPromise.resolve(res))
.catch(e => delayedPromise.reject(e))
}

this.delayedPromises = [];

// and then when the promise is added we do
this.delayedPromises.push({
// ...
})
```
* or, to allow for more flexibility, `this.delayedPromise` could be changed to something like `this.iframeOnloadHooks: Array` and the whole `this.updateTransportMethod` could be contained in the array, in case someone needs to add in a different onload call in later?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the if block in index.js around line 458 and trace how delayedPromise is created, resolved, rejected, and deleted during iframe loading. Reproduce repeated init calls and rapid updateTransportMethod calls, then verify that every delayed operation completes without accessing an object removed by another execution context.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
backend
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.