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.

Sign up for GitHub

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

Jump to bottom

Listening events on v4 is not working #6082

Merged
merged 12 commits into from
May 16, 2023
Merged

Listening events on v4 is not working #6082

merged 12 commits into from
May 16, 2023

Conversation

avkos
Copy link
Contributor

@avkos avkos commented May 11, 2023 •
edited
Loading

Description

Fixes #5989

metamask mov

Please include a summary of the changes and be sure to follow our Contribution Guidelines.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist:

  • I have selected the correct base branch.
  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings.
  • Any dependent changes have been merged and published in downstream modules.
  • I ran npm run lint with success and extended the tests and types if necessary.
  • I ran npm run test:unit with success.
  • I ran npm run test:coverage and my test cases cover all the lines and branches of the added code.
  • I ran npm run build and tested dist/web3.min.js in a browser.
  • I have tested my code on the live network.
  • I have checked the Deploy Preview and it looks correct.
  • I have updated the CHANGELOG.md file in the root folder.
  • I have linked Issue(s) with this PR in "Linked Issues" menu.

@github-actions
Copy link

github-actions bot commented May 11, 2023 •
edited
Loading

Bundle Stats

Hey there, this message comes from a github action that helps you and reviewers to understand how these changes affect the size of this project's bundle.

As this PR is updated, I'll keep you updated on how the bundle size is impacted.

Total

Asset Old size New size Diff Diff %
Total 642 KB 643 KB 310 bytes 0.05%
View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

No assets were bigger

Smaller

No assets were smaller

Unchanged

Asset Old size New size Diff Diff %
web3.min.js 626 KB 626 KB 310 bytes 0.05%
../lib/commonjs/index.d.ts 8.43 KB 8.43 KB 0 0.00%
../lib/commonjs/accounts.d.ts 3.67 KB 3.67 KB 0 0.00%
../lib/commonjs/types.d.ts 2.37 KB 2.37 KB 0 0.00%
../lib/commonjs/abi.d.ts 1000 bytes 1000 bytes 0 0.00%
../lib/commonjs/web3.d.ts 808 bytes 808 bytes 0 0.00%
../lib/commonjs/eth.exports.d.ts 280 bytes 280 bytes 0 0.00%
../lib/commonjs/providers.exports.d.ts 148 bytes 148 bytes 0 0.00%
../lib/commonjs/version.d.ts 60 bytes 60 bytes 0 0.00%

@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented May 11, 2023 •
edited
Loading

Deploying with  Cloudflare Pages  Cloudflare Pages

Latest commit: 4c0ba61
Status: ✅  Deploy successful!
Preview URL: https://0f5e0a35.web3-js-docs.pages.dev
Branch Preview URL: https://ok-5989-listening-events-on.web3-js-docs.pages.dev

View logs

@codecov
Copy link

codecov bot commented May 11, 2023 •
edited
Loading

Codecov Report

Merging #6082 (4c0ba61) into 4.x (3006a57) will increase coverage by 0.05%.
The diff coverage is 53.84%.

Additional details and impacted files 
@@            Coverage Diff             @@
##              4.x    #6082      +/-   ##
==========================================
+ Coverage   87.62%   87.68%   +0.05%     
==========================================
  Files         199      199              
  Lines        7566     7578      +12     
  Branches     2045     2054       +9     
==========================================
+ Hits         6630     6645      +15     
+ Misses        936      933       -3
Flag Coverage Δ
UnitTests 87.68% <53.84%> (+0.05%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Components Coverage Δ
web3 ∅ <ø> (∅)
web3-core ∅ <ø> (∅)
web3-errors ∅ <ø> (∅)
web3-eth ∅ <ø> (∅)
web3-eth-abi ∅ <ø> (∅)
web3-eth-accounts ∅ <ø> (∅)
web3-eth-contract ∅ <ø> (∅)
web3-eth-ens ∅ <ø> (∅)
web3-eth-iban ∅ <ø> (∅)
web3-eth-personal ∅ <ø> (∅)
web3-net ∅ <ø> (∅)
web3-providers-http ∅ <ø> (∅)
web3-providers-ipc ∅ <ø> (∅)
web3-providers-ws ∅ <ø> (∅)
web3-rpc-methods ∅ <ø> (∅)
web3-utils ∅ <ø> (∅)
web3-validator ∅ <ø> (∅)

Muhammad-Altabba
Muhammad-Altabba reviewed May 11, 2023
View reviewed changes
Copy link
Contributor

@Muhammad-Altabba Muhammad-Altabba left a comment

Choose a reason for hiding this comment

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

Could we please have tests for the added logic?

@avkos
Copy link
Contributor Author

avkos commented May 11, 2023

Could we please have tests for the added logic?

Yes. I am working on it. but unfortunately, it will be not browser+metamask test, just unit test

@avkos avkos requested a review from spacesailor24 May 11, 2023 23:28
spacesailor24
spacesailor24 reviewed May 12, 2023
View reviewed changes
packages/web3-core/src/web3_subscriptions.ts
Comment on lines +86 to +92
if (
data &&
jsonRpc.isResponseWithNotification(
data as unknown as JsonRpcSubscriptionResult | JsonRpcNotification<Log>,
)
) {
this._processSubscriptionResult(data?.params.result);
Copy link
Contributor

Choose a reason for hiding this comment

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

Judging from this 1.x code, it seems like this code is to support legacy providers while data.data.result (what you have marked as // for old providers) is to support EIP-1193

However, to handle the legacy provider, it would appear that we're missing an event listener for data event, as messageListener is only triggered for message events

Copy link
Contributor Author

Choose a reason for hiding this comment

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

thanks. I've added support for old providers and change comment

@avkos avkos requested a review from spacesailor24 May 15, 2023 20:05
spacesailor24
spacesailor24 approved these changes May 16, 2023
View reviewed changes
Copy link
Contributor

@spacesailor24 spacesailor24 left a comment

Choose a reason for hiding this comment

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

Otherwise looks good, thank you

jdevcs
jdevcs approved these changes May 16, 2023
View reviewed changes
Copy link
Contributor

@jdevcs jdevcs left a comment

Choose a reason for hiding this comment

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

@avkos update change log before merging

@avkos avkos merged commit e550a9c into 4.x May 16, 2023
@avkos avkos deleted the ok/5989-Listening-events-on-v4-is-not-working branch May 16, 2023 20:25
@jdevcs jdevcs mentioned this pull request Jun 2, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@spacesailor24 spacesailor24 spacesailor24 approved these changes

@jdevcs jdevcs jdevcs approved these changes

@luu-alex luu-alex Awaiting requested review from luu-alex luu-alex is a code owner

@nikoulai nikoulai Awaiting requested review from nikoulai

@Muhammad-Altabba Muhammad-Altabba Awaiting requested review from Muhammad-Altabba Muhammad-Altabba is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Listening events on v4 is not working
4 participants
@avkos @spacesailor24 @Muhammad-Altabba @jdevcs