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 test coverage to web3-core #7091

Merged
merged 9 commits into from
Jun 11, 2024
Merged

add test coverage to web3-core #7091

merged 9 commits into from
Jun 11, 2024

Conversation

luu-alex
Copy link
Contributor

@luu-alex luu-alex commented Jun 7, 2024

Description

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

Type of change

#7033

  • 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 Jun 7, 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 630.32 kB → 629.89 kB (-434 B) -0.07%
Changeset
File Δ Size
../web3-core/lib/commonjs/web3_request_manager.js 📉 -341 B (-2.01%) 16.54 kB → 16.21 kB
../web3-core/lib/commonjs/web3_subscriptions.js 📉 -472 B (-8.19%) 5.63 kB → 5.17 kB
View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

No assets were bigger

Smaller

Asset File Size % Changed
web3.min.js 611.03 kB → 610.6 kB (-434 B) -0.07%

Unchanged

Asset File Size % Changed
../lib/commonjs/index.d.ts 8.69 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.35 kB 0%
../lib/commonjs/web3_eip6963.d.ts 1.2 kB 0%
../lib/commonjs/abi.d.ts 999 B 0%
../lib/commonjs/eth.exports.d.ts 280 B 0%
../lib/commonjs/providers.exports.d.ts 183 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: 26e094f Previous: b234c1c Ratio
processingTx 9331 ops/sec (±4.08%) 9042 ops/sec (±4.12%) 0.97
processingContractDeploy 40316 ops/sec (±6.79%) 38054 ops/sec (±6.81%) 0.94
processingContractMethodSend 20073 ops/sec (±6.02%) 18746 ops/sec (±7.29%) 0.93
processingContractMethodCall 40971 ops/sec (±4.85%) 39055 ops/sec (±5.29%) 0.95
abiEncode 44978 ops/sec (±6.79%) 43251 ops/sec (±6.96%) 0.96
abiDecode 30857 ops/sec (±7.36%) 29622 ops/sec (±6.71%) 0.96
sign 1634 ops/sec (±0.78%) 1542 ops/sec (±4.29%) 0.94
verify 366 ops/sec (±0.60%) 363 ops/sec (±1.04%) 0.99

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

Copy link

codecov bot commented Jun 7, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.73%. Comparing base (7af8090) to head (db1a4a9).
Report is 3 commits behind head on 4.x.

Current head db1a4a9 differs from pull request most recent head 26e094f

Please upload reports for the commit 26e094f to get more accurate results.

Additional details and impacted files
@@            Coverage Diff             @@
##              4.x    #7091      +/-   ##
==========================================
+ Coverage   93.98%   94.73%   +0.74%     
==========================================
  Files         215      215              
  Lines        8335     8325      -10     
  Branches     2301     2295       -6     
==========================================
+ Hits         7834     7887      +53     
+ Misses        501      438      -63     
Flag Coverage Δ
UnitTests 94.73% <ø> (+0.74%) ⬆️

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

@@ -438,15 +437,6 @@ export class Web3RequestManager<
throw new ResponseError(response, 'Got batch response for a normal request.');
}

if (
(jsonRpc.isResponseWithError(response) || jsonRpc.isResponseWithResult(response)) &&
Copy link
Contributor Author

@luu-alex luu-alex Jun 7, 2024

Choose a reason for hiding this comment

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

removed, This conditional can never happen as we check jsonRpc.isResponseWithError(response) and jsonRpc.isResponseWithResult(response) seperately

@@ -82,16 +81,6 @@ export abstract class Web3Subscription<
super();
const { requestManager } = options as { requestManager: Web3RequestManager<API> };
const { subscriptionManager } = options as { subscriptionManager: Web3SubscriptionManager };
if (requestManager && subscriptionManager) {
Copy link
Contributor Author

@luu-alex luu-alex Jun 7, 2024

Choose a reason for hiding this comment

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

removed, in the constructor
only one of requestManager or subscriptionManager must be defined

'Only requestManager or subscriptionManager should be provided at Subscription constructor',
);
}
if (!requestManager && !subscriptionManager) {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

removed, in the constructor
either requestManager or subscriptionManager must be defined

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.

lgtm, except a change suggested

Copy link
Contributor

@avkos avkos left a comment

Choose a reason for hiding this comment

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

LGTM except Junaid comment

@luu-alex luu-alex merged commit 7a51c33 into 4.x Jun 11, 2024
15 of 18 checks passed
@luu-alex luu-alex deleted the web3-core-coverage branch June 11, 2024 13:59
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