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

fix web3config setconfig #6555

Merged
merged 29 commits into from
Nov 6, 2023
Merged

fix web3config setconfig #6555

merged 29 commits into from
Nov 6, 2023

Conversation

luu-alex
Copy link
Contributor

@luu-alex luu-alex commented Oct 30, 2023

Description

#6503
This PR fixes:

  • setconfig properly being sent from one package context to another
  • Fixing the interaction of web3configs setconfig method, check issue to see proper interaction

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.

@github-actions
Copy link

github-actions bot commented Oct 30, 2023

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 587 KB 588 KB 588 bytes 0.10%
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 570 KB 571 KB 588 bytes 0.10%
../lib/commonjs/index.d.ts 8.56 KB 8.56 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%

@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Oct 30, 2023

Deploying with  Cloudflare Pages  Cloudflare Pages

Latest commit: 99432fd
Status: ✅  Deploy successful!
Preview URL: https://f7cb2c77.web3-js-docs.pages.dev
Branch Preview URL: https://6455.web3-js-docs.pages.dev

View logs

@luu-alex luu-alex changed the title 6455 fix web3config setconfig Oct 30, 2023
@codecov
Copy link

codecov bot commented Oct 31, 2023

Codecov Report

Merging #6555 (f2de1bf) into 4.x (72e9bbd) will decrease coverage by 0.08%.
The diff coverage is 80.85%.

❗ Current head f2de1bf differs from pull request most recent head 99432fd. Consider uploading reports for the commit 99432fd to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##              4.x    #6555      +/-   ##
==========================================
- Coverage   89.56%   89.48%   -0.08%     
==========================================
  Files         215      215              
  Lines        8251     8276      +25     
  Branches     2234     2242       +8     
==========================================
+ Hits         7390     7406      +16     
- Misses        861      870       +9     
Flag Coverage Δ
UnitTests 89.48% <80.85%> (-0.08%) ⬇️

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

@luu-alex
Copy link
Contributor Author

luu-alex commented Nov 2, 2023

need to write a few more tests for this

}
});

it('should be send transaction, change for defaultTransactionType and sucesfully send transaction with different type', async () => {
Copy link
Contributor

Choose a reason for hiding this comment

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

also add tests for other imp configs like contractDataInputFill at web3 level here for all possible values,

Copy link
Contributor Author

@luu-alex luu-alex Nov 5, 2023

Choose a reason for hiding this comment

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

i agree, will create another issue because we have alot of configs and will be time consuming
#6575

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.

@luu-alex
Copy link
Contributor Author

luu-alex commented Nov 6, 2023

@jdevcs changed the timings to be higher didn't work and moved them to async functions didn't either. these are inconsistent test cases and should be changed/investigated

@luu-alex luu-alex merged commit 11f20b2 into 4.x Nov 6, 2023
27 of 29 checks passed
@luu-alex luu-alex deleted the 6455 branch November 6, 2023 17:11
Copy link
Contributor

@Muhammad-Altabba Muhammad-Altabba left a comment

Choose a reason for hiding this comment

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

I think the CHANGELOG.md could be updated during another PR. But with giving the correct PR number.
Thanks,

Comment on lines +105 to +108
const keys = Object.keys(options) as (keyof Web3ConfigOptions)[];
for (const key of keys) {
this._triggerConfigChange(key, options[key])
}
Copy link
Contributor

Choose a reason for hiding this comment

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

Would you, please, mention this in the CHANGELOG.md.

Comment on lines +406 to +411
if (contractContext instanceof Web3Context) {
contractContext.on(Web3ConfigEvent.CONFIG_CHANGE, event => {
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
this.setConfig({ [event.name]: event.newValue });
});
}
Copy link
Contributor

Choose a reason for hiding this comment

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

Would you, please, update the CHANGELOG.md?

dkurukula pushed a commit to dkurukula/web3.js that referenced this pull request Nov 8, 2023
* add web3config

* fix config to emit properly

* fix lint

* fix testcases and change emit for contracts

* fix lint

* remove unneccesary code

* update tests

* remove test

* update changelog and format

* update changelog

* fix contracts creation in web3 package

* fix linter

* format

* format

* add validation

* add test and address feedback

* update changelog

* update tests

* update

* fix tests

* update test

* update time

* add promises to fix parallel tests

* revert
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.

4 participants