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

Increase eth-abi unit tests above 90% #6679

Merged
merged 1 commit into from
Jan 8, 2024

Conversation

avkos
Copy link
Contributor

@avkos avkos commented Jan 2, 2024

Description

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

Fixes #6594

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 Jan 2, 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

Asset Old size New size Diff Diff %
Total 0 590 KB 590 KB -
View detailed bundle breakdown

Added

Asset Old size New size Diff Diff %
web3.min.js 0 573 KB 573 KB -
../lib/commonjs/index.d.ts 0 8.63 KB 8.63 KB -
../lib/commonjs/accounts.d.ts 0 3.89 KB 3.89 KB -
../lib/commonjs/types.d.ts 0 2.45 KB 2.45 KB -
../lib/commonjs/web3.d.ts 0 1.14 KB 1.14 KB -
../lib/commonjs/abi.d.ts 0 999 bytes 999 bytes -
../lib/commonjs/eth.exports.d.ts 0 280 bytes 280 bytes -
../lib/commonjs/providers.exports.d.ts 0 148 bytes 148 bytes -
../lib/commonjs/version.d.ts 0 60 bytes 60 bytes -

Removed

No assets were removed

Bigger

No assets were bigger

Smaller

No assets were smaller

Unchanged

No assets were unchanged

Copy link

Deploying with  Cloudflare Pages  Cloudflare Pages

Latest commit: 65be925
Status: ✅  Deploy successful!
Preview URL: https://19819a12.web3-js-docs.pages.dev
Branch Preview URL: https://ok-6594-increase-eth-abi-e2e.web3-js-docs.pages.dev

View logs

Copy link

codecov bot commented Jan 2, 2024

Codecov Report

Merging #6679 (65be925) into 4.x (4358140) will increase coverage by 4.23%.
Report is 138 commits behind head on 4.x.
The diff coverage is 94.93%.

Additional details and impacted files
@@            Coverage Diff             @@
##              4.x    #6679      +/-   ##
==========================================
+ Coverage   87.37%   91.61%   +4.23%     
==========================================
  Files         197      214      +17     
  Lines        7548     8143     +595     
  Branches     2059     2183     +124     
==========================================
+ Hits         6595     7460     +865     
+ Misses        953      683     -270     
Flag Coverage Δ
UnitTests 91.61% <94.93%> (+4.23%) ⬆️

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

@avkos
Copy link
Contributor Author

avkos commented Jan 2, 2024

Coverage 96%
image

@@ -152,6 +152,10 @@ export const isOddHexstring = (param: unknown): boolean =>
export const formatOddHexstrings = (param: string): string =>
isOddHexstring(param) ? `0x0${param.substring(2)}` : param;

const paramTypeBytes = /^bytes([0-9]*)$/;
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Move them out of the function because they are constants and we do not need to create them every time we execute the function.


// Format BN to string
if (param instanceof BigInt) {
if (param instanceof BigInt || typeof param === 'bigint') {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've passed BigInt(1) and it was not an instance of BigInt. That is why I've added to check the type

@@ -179,7 +179,7 @@ export const formatParam = (type: string, _param: unknown): unknown => {
// Format correct width for u?int[0-9]*
let match = paramTypeNumber.exec(type);
if (match) {
const size = parseInt(match[2] ?? '256', 10);
const size = parseInt(match[2] ? match[2] : '256', 10);
Copy link
Contributor Author

Choose a reason for hiding this comment

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

if i pass int match[2] will be empty string ''. ?? this operator only works with nullish results

@avkos avkos changed the title Increase eth-abi e2e tests above 90% Increase eth-abi unit tests above 90% Jan 4, 2024
@avkos avkos merged commit 7c33cc0 into 4.x Jan 8, 2024
62 of 66 checks passed
@avkos avkos deleted the ok/6594-Increase-eth-abi-e2e-tests-above-90% branch January 8, 2024 14:28
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 eth-abi unit tests above 90%
3 participants