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

refactor!: move autonat into separate package #2107

Merged
merged 8 commits into from
Oct 23, 2023

Conversation

wemeetagain
Copy link
Member

@wemeetagain wemeetagain commented Oct 2, 2023

Description

Notes & open questions

  • @achingbrain How does the "Browser <script> tag" section of the readme work? is it stale?

Change checklist

  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation if necessary (this includes comments as well)
  • I have added tests that prove my fix is effective or that my feature works

@wemeetagain wemeetagain requested a review from a team as a code owner October 2, 2023 20:53
@wemeetagain
Copy link
Member Author

Implementation notes:

  • Add the dependencies / devDependencies in the new package.json.
  • Remove Components interface (and defaultComponents impl) used in tests
  • Update all docs / examples
  • Remove subpath exports, tsdoc entrypoints
  • Transfer proto generation scripts

Copy link

@whizzzkid whizzzkid 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 this could have been two independent PRs, one for error-code refactor and one for moving autoNAT into it's own package. It should work still, thanks!

packages/interface/src/errors.ts Outdated Show resolved Hide resolved
@maschad
Copy link
Member

maschad commented Oct 3, 2023

Let's hold off on merging any breaking changes until #2074 is merged

@achingbrain achingbrain mentioned this pull request Oct 3, 2023
Copy link
Member

@maschad maschad 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 we should move the error codes and messages into @libp2p/interface/errors first in a separate PR, given that touches more codepaths, if that is successfully merged then we know we can remove other packages more easily.

Copy link
Member

@achingbrain achingbrain left a comment

Choose a reason for hiding this comment

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

Comments inline. I've targeted the v1 release branch - please can you add some copy to the migration guide to cover these breaking changes.

chore: fix type errors

chore: move more autonat references

chore: fix documentation

chore: fix linter errors

chore: fix deps

chore: replace error codes and messages

chore: fix linter errors

chore: fix error import statements

chore: fix build error
@wemeetagain wemeetagain force-pushed the refactor/move-protocols-to-packages branch from f464828 to 36de279 Compare October 19, 2023 20:31
Copy link
Member

@maschad maschad left a comment

Choose a reason for hiding this comment

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

Looks good, left one comment.

doc/migrations/v0.46-v1.0.md Outdated Show resolved Hide resolved
Copy link
Member

@maschad maschad left a comment

Choose a reason for hiding this comment

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

almost there, just some minor corrections

doc/migrations/v0.46-v1.0.0.md Outdated Show resolved Hide resolved
doc/migrations/v0.46-v1.0.0.md Outdated Show resolved Hide resolved
doc/migrations/v0.46-v1.0.0.md Outdated Show resolved Hide resolved
doc/migrations/v0.46-v1.0.0.md Outdated Show resolved Hide resolved
doc/migrations/v0.46-v1.0.0.md Outdated Show resolved Hide resolved
@wemeetagain
Copy link
Member Author

Can you please take over this PR and fix up the migration guide the way you want?

@maschad maschad merged commit a01937c into release-v1.0 Oct 23, 2023
17 checks passed
@maschad maschad deleted the refactor/move-protocols-to-packages branch October 23, 2023 21:50
achingbrain pushed a commit that referenced this pull request Oct 31, 2023
achingbrain pushed a commit that referenced this pull request Oct 31, 2023
achingbrain pushed a commit that referenced this pull request Oct 31, 2023
achingbrain pushed a commit that referenced this pull request Oct 31, 2023
achingbrain pushed a commit that referenced this pull request Oct 31, 2023
achingbrain pushed a commit that referenced this pull request Oct 31, 2023
achingbrain pushed a commit that referenced this pull request Nov 3, 2023
achingbrain pushed a commit that referenced this pull request Nov 7, 2023
achingbrain pushed a commit that referenced this pull request Nov 8, 2023
achingbrain pushed a commit that referenced this pull request Nov 8, 2023
achingbrain pushed a commit that referenced this pull request Nov 8, 2023
achingbrain pushed a commit that referenced this pull request Nov 8, 2023
achingbrain pushed a commit that referenced this pull request Nov 10, 2023
maschad added a commit to maschad/js-libp2p that referenced this pull request Nov 10, 2023
achingbrain pushed a commit that referenced this pull request Nov 15, 2023
This was referenced Nov 15, 2023
@github-actions github-actions bot mentioned this pull request Nov 29, 2023
This was referenced Jan 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants