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

add migration websocket doc changes #7318

Merged
merged 1 commit into from
Oct 15, 2024
Merged

Conversation

luu-alex
Copy link
Contributor

@luu-alex luu-alex commented Oct 9, 2024

Description

Added subtitles to make it easier to read, changed 4.x to v4 because thats the nomenclature we agreed to with a while but it still exists in the docs.
Added the migration change of the behavior of websockets, not terminating vs terminating in v4.

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.

Copy link

github-actions bot commented Oct 9, 2024

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

Files count Total bundle size % Changed
10 640.83 kB 0%

Changeset

No files were changed

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 File Size % Changed
web3.min.js 621.34 kB 0%
../lib/commonjs/index.d.ts 8.72 kB 0%
../lib/commonjs/accounts.d.ts 3.89 kB 0%
../lib/commonjs/types.d.ts 2.67 kB 0%
../lib/commonjs/web3.d.ts 1.38 kB 0%
../lib/commonjs/web3_eip6963.d.ts 1.28 kB 0%
../lib/commonjs/abi.d.ts 1.06 kB 0%
../lib/commonjs/eth.exports.d.ts 280 B 0%
../lib/commonjs/providers.exports.d.ts 148 B 0%
../lib/commonjs/version.d.ts 60 B 0%

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Benchmark

Benchmark suite Current: 9b8069c Previous: f701406 Ratio
processingTx 21899 ops/sec (±6.37%) 22830 ops/sec (±7.43%) 1.04
processingContractDeploy 38365 ops/sec (±8.85%) 39939 ops/sec (±7.35%) 1.04
processingContractMethodSend 15522 ops/sec (±7.49%) 15792 ops/sec (±6.76%) 1.02
processingContractMethodCall 26813 ops/sec (±6.68%) 27711 ops/sec (±6.25%) 1.03
abiEncode 42550 ops/sec (±7.00%) 42219 ops/sec (±7.33%) 0.99
abiDecode 30074 ops/sec (±6.62%) 29744 ops/sec (±7.55%) 0.99
sign 1463 ops/sec (±3.69%) 1498 ops/sec (±3.49%) 1.02
verify 356 ops/sec (±0.96%) 365 ops/sec (±0.60%) 1.03

This comment was automatically generated by workflow using github-action-benchmark.

Copy link

codecov bot commented Oct 9, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.44%. Comparing base (f701406) to head (9b8069c).
Report is 2 commits behind head on 4.x.

Additional details and impacted files
@@           Coverage Diff           @@
##              4.x    #7318   +/-   ##
=======================================
  Coverage   94.44%   94.44%           
=======================================
  Files         216      216           
  Lines        8463     8463           
  Branches     2340     2340           
=======================================
  Hits         7993     7993           
  Misses        470      470           
Flag Coverage Δ
UnitTests 94.44% <ø> (ø)

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

@luu-alex luu-alex marked this pull request as ready for review October 9, 2024 16:16
@luu-alex luu-alex requested a review from krzysu October 9, 2024 16:17
@luu-alex luu-alex merged commit 7008e5c into 4.x Oct 15, 2024
53 checks passed
@luu-alex luu-alex deleted the add/disconnect-migrate-docs branch October 15, 2024 13:14
@krzysu
Copy link
Contributor

krzysu commented Oct 15, 2024

In the past few days, I’ve encountered the issue explained in this docs update twice (websocket connection not closed at the end of a program). However, I noticed that the update was only added to the migration guide, which is somewhat buried in the documentation structure. I believe we should include the same information about closing WebSocket connections on the providers page, specifically here, to make it more accessible: https://docs.web3js.org/guides/web3_providers_guide/#websocket-provider
wdyt?

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.

3 participants