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 misleading web3-providers tsconfig paths (Issue/3336) #3404

Closed
wants to merge 8 commits into from

Conversation

wirednkod
Copy link

@wirednkod wirednkod commented Mar 4, 2020

Description

Issue: The path defined for example in the tsconfig file of the web3-providers-http package is misleading and should get corrected if possible in a non-breaking manner.

Fixes #3336

Type of change

  • Bug fix (non-breaking change which fixes an issue)

Checklist:

  • I have selected the correct base branch.
  • I have performed a self-review of my own code.
  • My changes generate no new warnings.
  • I ran npm run dtslint with success and extended the tests and types if necessary.
  • I ran npm run test:unit with success.

@coveralls
Copy link

coveralls commented Mar 4, 2020

Coverage Status

Coverage remained the same at 90.254% when pulling ddc21aa on wirednkod:issue/3336 into 8c94ca8 on ethereum:1.x.

@cgewecke cgewecke added 1.x 1.0 related issues Types Incorrect or missing types labels Mar 9, 2020
@ryanio ryanio changed the title Issue/3336 Fix misleading web3-providers tsconfig paths (Issue/3336) Apr 10, 2020
ryanio
ryanio previously approved these changes Apr 10, 2020
Copy link
Collaborator

@ryanio ryanio left a comment

Choose a reason for hiding this comment

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

Hey @wirednkod thanks for this PR! It LGTM.

Did you by any chance check if any other packages have misleading paths outside the providers packages?

In a future PR would also love your help adding the missing types to the packages you identified in #3336 (comment) web3-core-requestmanager and web3-core-promievent.

@wirednkod
Copy link
Author

wirednkod commented Apr 11, 2020

@ryanio I did - Issue appeared only in the providers package. I'll open new PR for adding the missing types to the packages you identified in #3336 (comment) web3-core-requestmanager and web3-core-promievent.

@ryanio
Copy link
Collaborator

ryanio commented Apr 11, 2020

Thanks, that would be awesome!

For this PR do you mind adding a small one line Changelog.md entry?

Thanks again.

@wirednkod
Copy link
Author

wirednkod commented Apr 14, 2020 via email

@ryanio
Copy link
Collaborator

ryanio commented Apr 14, 2020

Thanks!

We are prepping the 1.2.7 rc release now so it looks like this PR may have to wait for 1.2.8, but we will be sure to get it in soon! Thanks again.

@nivida
Copy link
Contributor

nivida commented Apr 15, 2020

@ryanio This would probably break existing DApp's. I would test it with different module imports in TS and with different depending projects.

@GregTheGreek
Copy link
Contributor

I think @nivida may be correct here. Ultimately we did just merge #3652 which will eventually solve this issue.

@github-actions
Copy link

This PR has been automatically marked as stale beacause it has not had recent activity. It will be closed in 7 days if no further activity occurs. Thank you for your contributions. If you believe this was a mistake, please comment.

@github-actions github-actions bot added the Stale Has not received enough activity label Sep 25, 2020
@github-actions github-actions bot closed this Oct 18, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1.x 1.0 related issues Discussion Stale Has not received enough activity Types Incorrect or missing types
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Analysis of the defined paths for the provided types
6 participants