add websocket methods #6479

luu-alex · 2023-10-04T16:30:19Z

Description

#6451

SocketProvider now contains public function getPendingRequestQueueSize, getSentRequestsQueueSize (WebSocketProvider.disconnect() should have an option to wait until _pendingRequestsQueue/_sentRequestsQueue are empty #6451)
Added safeDisconnect as a SocketProvider method to disconnect only when request queue size and send request queue size is 0 (WebSocketProvider.disconnect() should have an option to wait until _pendingRequestsQueue/_sentRequestsQueue are empty #6451)
Added testcases and unit tests

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:

github-actions · 2023-10-04T16:35:19Z

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	588 KB	589 KB	514 bytes	0.09%

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	571 KB	571 KB	514 bytes	0.09%
../lib/commonjs/index.d.ts	8.63 KB	8.63 KB	0	0.00%
../lib/commonjs/accounts.d.ts	3.67 KB	3.67 KB	0	0.00%
../lib/commonjs/types.d.ts	2.45 KB	2.45 KB	0	0.00%
../lib/commonjs/web3.d.ts	1.14 KB	1.14 KB	0	0.00%
../lib/commonjs/abi.d.ts	1000 bytes	1000 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 · 2023-10-04T16:41:20Z

Codecov Report

Merging #6479 (e28bba7) into 4.x (4358140) will increase coverage by 2.29%.
Report is 108 commits behind head on 4.x.
The diff coverage is 92.70%.

❗ Current head e28bba7 differs from pull request most recent head 0cd035d. Consider uploading reports for the commit 0cd035d to get more accurate results

Additional details and impacted files

@@            Coverage Diff             @@
##              4.x    #6479      +/-   ##
==========================================
+ Coverage   87.37%   89.66%   +2.29%     
==========================================
  Files         197      214      +17     
  Lines        7548     8208     +660     
  Branches     2059     2220     +161     
==========================================
+ Hits         6595     7360     +765     
+ Misses        953      848     -105

Flag	Coverage Δ
UnitTests	`89.66% <92.70%> (+2.29%)`	⬆️

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

jdevcs

as discussed in team call, for manual disconnect function call:
1- add an optional flag argument
2- based on that flag if data queue is not empty set interval and keep on checking until data queue is empty, when empty call disconnect and clear interval.

cloudflare-workers-and-pages · 2023-10-16T14:42:24Z

Deploying with Cloudflare Pages

Latest commit:	`0cd035d`
Status:	✅ Deploy successful!
Preview URL:	https://4049054d.web3-js-docs.pages.dev
Branch Preview URL:	https://6451.web3-js-docs.pages.dev

View logs

This reverts commit c80e256.

packages/web3-utils/src/socket_provider.ts

Muhammad-Altabba

Thanks @luu-alex,

I just have 2 small points at CHAINGLOG.md file.

Muhammad-Altabba · 2023-11-19T15:26:10Z

packages/web3-utils/CHANGELOG.md

+### Fixed
+
+-   Add `isContractInitOptions` method (#6455)


I think this should be still under Added section. But I noticed that the PR number was wrong (was 6455 but should be 6555), right?

Suggested change

### Fixed

- Add `isContractInitOptions` method (#6455)

- Add `isContractInitOptions` method (#6555)

### Fixed

Muhammad-Altabba · 2023-11-19T15:28:42Z

packages/web3-utils/CHANGELOG.md

We need the PR number rather than the issue number.

Suggested change

- `SocketProvider` now contains public function `getPendingRequestQueueSize`, `getSentRequestsQueueSize` and `clearQueues` (#6451)

- Added `safeDisconnect` as a `SocketProvider` method to disconnect only when request queue size and send request queue size is 0 (#6451)

- `SocketProvider` now contains public function `getPendingRequestQueueSize`, `getSentRequestsQueueSize` and `clearQueues` (#6479)

- Added `safeDisconnect` as a `SocketProvider` method to disconnect only when request queue size and send request queue size is 0 (#6479)

jdevcs · 2023-11-20T08:29:59Z

packages/web3/test/integration/ws.test.ts

+            } catch(error) {
+                // if it errors, fail test
+                // eslint-disable-next-line
+                expect(true).toBe(false)


pls use some standard way of checking like,

expect(myAsyncFunction()).resolves.not.toThrow() expect(myAsyncFunction()).resolves.not.toThrowError();

jdevcs · 2023-11-20T14:03:45Z

PR LGTM, except above change. thanks

rondales · 2024-01-01T20:42:17Z

Description

#6451

SocketProvider now contains public function getPendingRequestQueueSize, getSentRequestsQueueSize (WebSocketProvider.disconnect() should have an option to wait until _pendingRequestsQueue/_sentRequestsQueue are empty #6451)

Added safeDisconnect as a SocketProvider method to disconnect only when request queue size and send request queue size is 0 (WebSocketProvider.disconnect() should have an option to wait until _pendingRequestsQueue/_sentRequestsQueue are empty #6451)

Added testcases and unit tests

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.

add getPendingRequestQueueSize

715cfe2

luu-alex mentioned this pull request Oct 4, 2023

WebSocketProvider.disconnect() should have an option to wait until _pendingRequestsQueue/_sentRequestsQueue are empty #6451

Closed

jdevcs reviewed Oct 9, 2023

View reviewed changes

Merge branch '4.x' into 6451

e28bba7

github-actions bot deployed to web3-js-docs (Preview) October 16, 2023 14:41 View deployment

luu-alex added 3 commits November 6, 2023 13:45

Merge branch '4.x' into 6451

54e41cf

add safe disconnect

239913d

add getSentRequestsQueueSize and safeDisconnect

2ba48ff

github-actions bot deployed to web3-js-docs (Preview) November 9, 2023 00:21 View deployment

fix test

5e50f50

github-actions bot deployed to web3-js-docs (Preview) November 9, 2023 00:51 View deployment

luu-alex added 2 commits November 8, 2023 19:57

update test

1d0068f

eslint disable

db0ddc3

github-actions bot deployed to web3-js-docs (Preview) November 9, 2023 01:16 View deployment

luu-alex added 2 commits November 8, 2023 20:24

fix

e75cc74

update import

997c92a

github-actions bot deployed to web3-js-docs (Preview) November 9, 2023 01:45 View deployment

test

f60f044

github-actions bot deployed to web3-js-docs (Preview) November 9, 2023 02:21 View deployment

luu-alex added 2 commits November 10, 2023 14:52

add script

c80e256

add eslint disable

34f0bc2

github-actions bot deployed to web3-js-docs (Preview) November 10, 2023 20:18 View deployment

luu-alex added 2 commits November 12, 2023 09:26

Revert "add script"

74dc98f

This reverts commit c80e256.

add try catch:

42e8a45

github-actions bot deployed to web3-js-docs (Preview) November 12, 2023 14:55 View deployment

Alex added 2 commits November 12, 2023 10:08

Merge branch '4.x' into 6451

a32fbde

remove afterall

e19c21a

luu-alex marked this pull request as ready for review November 12, 2023 21:30

luu-alex requested review from avkos and Muhammad-Altabba as code owners November 12, 2023 21:30

luu-alex added 2 commits November 12, 2023 16:41

fix up

23079e7

add eslint disable

08e7634

github-actions bot deployed to web3-js-docs (Preview) November 12, 2023 21:55 View deployment

luu-alex changed the title ~~add getPendingRequestQueueSize~~ add websocket methods Nov 12, 2023

avkos requested changes Nov 13, 2023

View reviewed changes

packages/web3-utils/src/socket_provider.ts Outdated Show resolved Hide resolved

Muhammad-Altabba reviewed Nov 14, 2023

View reviewed changes

packages/web3-utils/src/socket_provider.ts Show resolved Hide resolved

luu-alex added 2 commits November 14, 2023 16:09

add clearqueues as public method

9f3aa15

lint fix

55d931b

github-actions bot deployed to web3-js-docs (Preview) November 14, 2023 21:48 View deployment

luu-alex requested a review from avkos November 14, 2023 22:01

avkos approved these changes Nov 15, 2023

View reviewed changes

luu-alex requested review from Muhammad-Altabba and jdevcs November 17, 2023 19:20

Muhammad-Altabba approved these changes Nov 19, 2023

View reviewed changes

jdevcs reviewed Nov 20, 2023

View reviewed changes

luu-alex added 2 commits November 20, 2023 11:22

address feedback

107854d

fix lint

e89c17a

github-actions bot deployed to web3-js-docs (Preview) November 20, 2023 16:40 View deployment

update changelog

0cd035d

github-actions bot deployed to web3-js-docs (Preview) November 20, 2023 17:02 View deployment

luu-alex merged commit ef6f04e into 4.x Nov 20, 2023
27 of 29 checks passed

luu-alex deleted the 6451 branch November 20, 2023 17:08

affiliatedkat mentioned this pull request May 7, 2024

[Snyk] Upgrade web3-core from 1.3.0 to 4.3.2 affiliatedkat/web3.js#49

Open

snyk-io bot mentioned this pull request May 21, 2024

[Snyk] Upgrade web3 from 4.3.0 to 4.8.0 Hawthorne001/rpgf_calculator#1

Open

Magd3 mentioned this pull request Jun 27, 2024

[Snyk] Upgrade web3 from 4.0.1 to 4.9.0 Magd3/Majd#2

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add websocket methods #6479

add websocket methods #6479

luu-alex commented Oct 4, 2023 •

edited

Loading

github-actions bot commented Oct 4, 2023 •

edited

Loading

codecov bot commented Oct 4, 2023 •

edited

Loading

jdevcs left a comment

cloudflare-workers-and-pages bot commented Oct 16, 2023 •

edited

Loading

Muhammad-Altabba left a comment

Muhammad-Altabba Nov 19, 2023

Muhammad-Altabba Nov 19, 2023

jdevcs Nov 20, 2023

jdevcs Nov 20, 2023

jdevcs commented Nov 20, 2023

rondales commented Jan 1, 2024

Description

Type of change

Checklist:

--   `SocketProvider` now contains public function `getPendingRequestQueueSize`, `getSentRequestsQueueSize` and `clearQueues` (#6451)
--   Added `safeDisconnect` as a `SocketProvider` method to disconnect only when request queue size and send request queue size is 0 (#6451)
+-   `SocketProvider` now contains public function `getPendingRequestQueueSize`, `getSentRequestsQueueSize` and `clearQueues` (#6479)
+-   Added `safeDisconnect` as a `SocketProvider` method to disconnect only when request queue size and send request queue size is 0 (#6479)

add websocket methods #6479

add websocket methods #6479

Conversation

luu-alex commented Oct 4, 2023 • edited Loading

Description

Type of change

Checklist:

github-actions bot commented Oct 4, 2023 • edited Loading

Bundle Stats

codecov bot commented Oct 4, 2023 • edited Loading

Codecov Report

jdevcs left a comment

Choose a reason for hiding this comment

cloudflare-workers-and-pages bot commented Oct 16, 2023 • edited Loading

Deploying with Cloudflare Pages

Muhammad-Altabba left a comment

Choose a reason for hiding this comment

Muhammad-Altabba Nov 19, 2023

Choose a reason for hiding this comment

Muhammad-Altabba Nov 19, 2023

Choose a reason for hiding this comment

jdevcs Nov 20, 2023

Choose a reason for hiding this comment

jdevcs Nov 20, 2023

Choose a reason for hiding this comment

jdevcs commented Nov 20, 2023

rondales commented Jan 1, 2024

Description

Type of change

Checklist:

luu-alex commented Oct 4, 2023 •

edited

Loading

github-actions bot commented Oct 4, 2023 •

edited

Loading

codecov bot commented Oct 4, 2023 •

edited

Loading

cloudflare-workers-and-pages bot commented Oct 16, 2023 •

edited

Loading