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

Refactor subscription's logic #6210

Conversation

Muhammad-Altabba
Copy link
Contributor

@Muhammad-Altabba Muhammad-Altabba commented Jun 18, 2023

Description

Identified issues:

  • Subscribing to multiple blockchain events causes every listener to be fired for every registered event
  • Unsubscribe at a Web3Subscription class will still have the id of the subscription at the Web3SubscriptionManager
  • A call to the provider is made for every subscription object. (This means, in case of multiple creating of subscription objects, multiple subscriptions are made at the provider for each subscription type).

Refactor subscription's logic

  • Web3Subscription constructor now accepts Web3SubscriptionManager (as an alternative to accepting Web3RequestManager that is now marked as deprecated)

  • Web3Subscription constructor overloading that accepts Web3SubscriptionManager is marked as deprecated

  • Moved subscribing to provider events from Web3Subscription to Web3SubscriptionManager

  • subscribe and unsubscribe called at Web3Subscription now is the same as calling them on Web3SubscriptionManager

  • Web3Subscription is lined now to Web3SubscriptionManager instead of directly to Web3RequestManager

  • Added the SimpleProvider interface which has only request(args) method that is compatible with EIP-1193

  • Added the Eip1193EventName type that contains the possible events names according to EIP-1193

  • The EIP1193Provider class has now all the events (for on and removeListener) according to EIP-1193

  • update test cases ...

Fixes: #6202

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.

 - Moved subscribing to provider events from  Web3Subscription to Web3SubscriptionManager
  - subscribe and un subscribe called at Web3Subscription now is the same as calling them on Web3SubscriptionManager
   - Web3Subscription is lined now to Web3SubscriptionManager instead of directly to Web3RequestManager
 - update test cases
 ...
@github-actions
Copy link

github-actions bot commented Jun 18, 2023

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 638 KB 639 KB 1.38 KB 0.22%
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 621 KB 623 KB 1.38 KB 0.22%
../lib/commonjs/index.d.ts 8.56 KB 8.56 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 811 bytes 811 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%

@codecov
Copy link

codecov bot commented Jun 18, 2023

Codecov Report

Merging #6210 (8727ea1) into 4.x (51a59f9) will increase coverage by 0.12%.
The diff coverage is 89.74%.

Additional details and impacted files
@@            Coverage Diff             @@
##              4.x    #6210      +/-   ##
==========================================
+ Coverage   87.46%   87.59%   +0.12%     
==========================================
  Files         197      197              
  Lines        7557     7593      +36     
  Branches     2060     2078      +18     
==========================================
+ Hits         6610     6651      +41     
+ Misses        947      942       -5     
Flag Coverage Δ
UnitTests 87.59% <89.74%> (+0.12%) ⬆️

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 ∅ <ø> (∅)

@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Jun 18, 2023

Deploying with  Cloudflare Pages  Cloudflare Pages

Latest commit: 8727ea1
Status: ✅  Deploy successful!
Preview URL: https://9773d5df.web3-js-docs.pages.dev
Branch Preview URL: https://6202-subscribe-to-2-events-w.web3-js-docs.pages.dev

View logs

 + update CHANGELOG
 + Fix some events types at `SocketProvider`
@Muhammad-Altabba Muhammad-Altabba merged commit e8d579c into 4.x Jun 24, 2023
@Muhammad-Altabba Muhammad-Altabba deleted the 6202-subscribe-to-2-events-with-single-web3-instance-seem-to-not-work-properly branch June 24, 2023 00:58
@jdevcs jdevcs mentioned this pull request Jun 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Subscribing to multiple blockchain events causes every listener to be fired for every registered event
3 participants