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

100% Coverage web3-utills #7042

Merged
merged 21 commits into from
Jun 3, 2024
Merged

Conversation

Muhammad-Altabba
Copy link
Contributor

@Muhammad-Altabba Muhammad-Altabba commented May 15, 2024

Description

Fixes #7031
Coverage lines go up to 98%, the lines that are not covered is from formatters and that needs to be revisited and fixed to work as intended

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.

@Muhammad-Altabba Muhammad-Altabba linked an issue May 15, 2024 that may be closed by this pull request
Copy link

github-actions bot commented May 15, 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.38 kB → 630.32 kB (-67 B) -0.01%
Changeset
File Δ Size
../web3-utils/lib/commonjs/converters.js 📈 +962 B (+4.44%) 21.18 kB → 22.12 kB
../web3-utils/lib/commonjs/socket_provider.js 📈 +27 B (+0.19%) 13.69 kB → 13.72 kB
../web3-utils/lib/commonjs/json_rpc.js 📈 +1 B (+0.02%) 4.91 kB → 4.91 kB
../web3-utils/lib/commonjs/promise_helpers.js 📈 +1 B (+0.01%) 6.83 kB → 6.83 kB
../web3-utils/lib/commonjs/formatter.js 📉 -134 B (-1.00%) 13.11 kB → 12.98 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.09 kB → 611.03 kB (-67 B) -0.01%

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: b9617ee Previous: 51d216f Ratio
processingTx 9064 ops/sec (±3.95%) 9224 ops/sec (±3.84%) 1.02
processingContractDeploy 39316 ops/sec (±6.24%) 41118 ops/sec (±7.75%) 1.05
processingContractMethodSend 18824 ops/sec (±7.24%) 20556 ops/sec (±6.13%) 1.09
processingContractMethodCall 37602 ops/sec (±6.05%) 41085 ops/sec (±4.96%) 1.09
abiEncode 42235 ops/sec (±7.66%) 46586 ops/sec (±6.55%) 1.10
abiDecode 28950 ops/sec (±8.61%) 31710 ops/sec (±6.85%) 1.10
sign 1578 ops/sec (±0.79%) 1608 ops/sec (±0.76%) 1.02
verify 369 ops/sec (±0.64%) 374 ops/sec (±2.89%) 1.01

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

Copy link

codecov bot commented May 15, 2024

Codecov Report

Attention: Patch coverage is 92.85714% with 2 lines in your changes are missing coverage. Please review.

Project coverage is 93.98%. Comparing base (9086b98) to head (b9617ee).
Report is 1 commits behind head on 4.x.

Additional details and impacted files
@@            Coverage Diff             @@
##              4.x    #7042      +/-   ##
==========================================
+ Coverage   92.17%   93.98%   +1.81%     
==========================================
  Files         215      215              
  Lines        8335     8335              
  Branches     2301     2301              
==========================================
+ Hits         7683     7834     +151     
+ Misses        652      501     -151     
Flag Coverage Δ
UnitTests 93.98% <92.85%> (+1.81%) ⬆️

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

@@ -74,11 +72,7 @@ const findSchemaByDataPath = (
result = (result.properties as Record<string, JsonSchema>)[dataPart];
} else if (result.items && (result.items as JsonSchema).properties) {
const node = (result.items as JsonSchema).properties as Record<string, JsonSchema>;

if (!node) {
Copy link
Contributor

Choose a reason for hiding this comment

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

we remove this
this conditional can never be met,
} else if (result.items && (result.items as JsonSchema).properties) {
we make sure result.properties always exists

@@ -57,10 +57,8 @@ const findSchemaByDataPath = (

for (const dataPart of dataPath) {
if (result.oneOf && previousDataPath) {
const path = oneOfPath.find(function (element: [string, number]) {
Copy link
Contributor

Choose a reason for hiding this comment

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

changed this for readability

clearInterval(intervalId);
resolve(res as unknown as Exclude<T, undefined>);
reject(error);
Copy link
Contributor

Choose a reason for hiding this comment

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

this file was changed from prettier

@luu-alex
Copy link
Contributor

Some lines were not covered as formatter is not working 100% as intended, need to look into the formatter function before we cover more of those lines

@luu-alex
Copy link
Contributor

Looking into the format tests right now and trying to make them work

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.

Increase testing coverage - web3-utils
3 participants