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

feat(libp2p): deprecate mplex #3689

Merged
merged 12 commits into from
Apr 4, 2023
Merged

Conversation

tcoratger
Copy link
Contributor

@tcoratger tcoratger commented Mar 27, 2023

Description

mplex module (no flow control and no streams limit) is deprecated to encourage yamux usage.

Resolves #3677.

Change checklist

  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation
  • A changelog entry has been made in the appropriate crates

@tcoratger tcoratger changed the title Deprecate mplex feat: Deprecate mplex Mar 27, 2023
@tcoratger tcoratger changed the title feat: Deprecate mplex update: Deprecate mplex Mar 27, 2023
@tcoratger tcoratger changed the title update: Deprecate mplex feat: Deprecate mplex Mar 27, 2023
Copy link
Contributor

@thomaseizinger thomaseizinger left a comment

Choose a reason for hiding this comment

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

Thank you! I've done a first pass :)

Let me know if you have any questions.

@mergify
Copy link
Contributor

mergify bot commented Mar 29, 2023

This pull request has merge conflicts. Could you please resolve them @tcoratger? 🙏

@thomaseizinger thomaseizinger changed the title feat: Deprecate mplex feat(libp2p): deprecate mplex Mar 29, 2023
@mergify
Copy link
Contributor

mergify bot commented Apr 3, 2023

This pull request has merge conflicts. Could you please resolve them @tcoratger? 🙏

@@ -10,4 +10,4 @@ async-std = { version = "1.12", features = ["attributes"] }
async-trait = "0.1"
env_logger = "0.10"
futures = "0.3.28"
libp2p = { path = "../../libp2p", features = ["async-std", "dns", "kad", "mplex", "noise", "tcp", "websocket", "yamux"] }
Copy link
Contributor

Choose a reason for hiding this comment

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

You need to undo this line to make the IPFS integration test work again.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@thomaseizinger Done, maybe for future PR: you said in the comments above that you didn't want to use deprecated modules like this in the examples. In this context, shouldn't mplex be replaced by yamux here?

Copy link
Contributor

@thomaseizinger thomaseizinger Apr 3, 2023

Choose a reason for hiding this comment

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

Yes correct. In this case, we still use development_transport for this example. I'd like to change how this function is being used but we still need to hash out a design. See #3657.

The option here would either be to use inline development_transport into the example or use the deprecated feature here. To keep the scope of the PR small, I'd say using it here is fine enough. We don't explicitly show the use of mplex in here so I don't think it is that bad. With the next breaking change, we will remove mplex from the development_transport and the world will be better :)

thomaseizinger
thomaseizinger previously approved these changes Apr 3, 2023
Copy link
Contributor

@thomaseizinger thomaseizinger left a comment

Choose a reason for hiding this comment

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

Thank you for your contribution and patience!

I'll queue this for merging.

@mergify
Copy link
Contributor

mergify bot commented Apr 4, 2023

This pull request has merge conflicts. Could you please resolve them @tcoratger? 🙏

@mergify mergify bot dismissed thomaseizinger’s stale review April 4, 2023 09:20

Approvals have been dismissed because the PR was updated after the send-it label was applied.

@mergify mergify bot merged commit 44d4b11 into libp2p:master Apr 4, 2023
@tcoratger tcoratger deleted the deprecate_mplex branch April 13, 2023 10:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Deprecate mplex module in libp2p
2 participants