Skip to content

Commit

Permalink
bugfix for json-rpc-middleware-stream incorrect notification handling (
Browse files Browse the repository at this point in the history
…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]>
  • Loading branch information
2 people authored and staging-devin-ai-integration[bot] committed Jul 11, 2024
1 parent 97c65b1 commit 2b80d7c
Showing 1 changed file with 7 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,12 @@ import type {
JsonRpcMiddleware,
} from '@metamask/json-rpc-engine';
import SafeEventEmitter from '@metamask/safe-event-emitter';
import type {
JsonRpcNotification,
JsonRpcParams,
JsonRpcRequest,
PendingJsonRpcResponse,
import {
hasProperty,
type JsonRpcNotification,
type JsonRpcParams,
type JsonRpcRequest,
type PendingJsonRpcResponse,
} from '@metamask/utils';
import { Duplex } from 'readable-stream';

Expand Down Expand Up @@ -85,7 +86,7 @@ export default function createStreamMiddleware(options: Options = {}) {
) {
let errorObj: Error | null = null;
try {
const isNotification = !res.id;
const isNotification = !hasProperty(res, 'id');
if (isNotification) {
processNotification(res as unknown as JsonRpcNotification);
} else {
Expand Down

0 comments on commit 2b80d7c

Please sign in to comment.