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

json-rpc-middleware-stream: Incorrect notification handling #4308

Closed
rekmarks opened this issue May 22, 2024 · 0 comments · Fixed by #4427
Closed

json-rpc-middleware-stream: Incorrect notification handling #4308

rekmarks opened this issue May 22, 2024 · 0 comments · Fixed by #4427
Assignees
Labels
bug Something isn't working team-wallet-framework

Comments

@rekmarks
Copy link
Member

json-rpc-middleware-stream detects notifications by checking if response.id is falsy, when it should rather check if hasProperty(response, 'id') is false (source). This ensures that it will never hit this case in processResponse(), whose purpose and JSON-RPC spec compliance I am uncertain of.

Either way, we should detect notifications via the absence of the id property, and not whether its value is falsy.

@rekmarks rekmarks added the bug Something isn't working label May 22, 2024
@kanthesha kanthesha self-assigned this Jun 14, 2024
kanthesha added a commit that referenced this issue Jun 18, 2024
…#4427)

## Explanation
json-rpc-middleware-stream detects notifications by checking if
response.id is falsy, when it should rather check if
hasProperty(response, 'id') is false.
<!--
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?
-->

## References
Fixes #4308 
<!--
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/json-rpc-middleware-stream`

- **FIXED**: Incorrect notification handling

## 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

Co-authored-by: legobeat <[email protected]>
staging-devin-ai-integration bot pushed a commit to Devin-Applications/core-devin that referenced this issue Jul 11, 2024
…MetaMask#4427)

## Explanation
json-rpc-middleware-stream detects notifications by checking if
response.id is falsy, when it should rather check if
hasProperty(response, 'id') is false.
<!--
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?
-->

## References
Fixes MetaMask#4308 
<!--
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/json-rpc-middleware-stream`

- **FIXED**: Incorrect notification handling

## 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

Co-authored-by: legobeat <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working team-wallet-framework
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants