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

Deprecate @libp2p/mplex tracking issue #2555

Closed
4 of 5 tasks
maschad opened this issue May 26, 2024 · 3 comments
Closed
4 of 5 tasks

Deprecate @libp2p/mplex tracking issue #2555

maschad opened this issue May 26, 2024 · 3 comments
Assignees
Labels
dependencies Pull requests that update a dependency file kind/maintenance Work required to avoid breaking changes or harm to project's status quo version-2.0 PRs that will be released in libp2p v2

Comments

@maschad
Copy link
Member

maschad commented May 26, 2024

As a part of the wider initiative to deprecate mplex we need to:

  • Add a deprecation notice the @libp2p/mplex README.
  • Add a deprecation notice to the Multiplexing section of the GETTING_STARTED.
  • Deprecate the@libp2p/mplex module on npm
  • Remove all tests using mplex
  • Remove all references in the docs to mplex
@maschad maschad added the need/triage Needs initial labeling and prioritization label May 26, 2024
@maschad maschad self-assigned this May 26, 2024
@maschad maschad added kind/maintenance Work required to avoid breaking changes or harm to project's status quo dependencies Pull requests that update a dependency file and removed need/triage Needs initial labeling and prioritization labels May 26, 2024
@maschad maschad moved this to 🛠️ Todo in js-libp2p May 26, 2024
@achingbrain
Copy link
Member

Remove all tests using mplex

The missing piece here is to replace mplex with yamux where a muxer is required by the test.

The thing about mplex is that it's in this repo which means when we next release a major of @libp2p/interfaces we don't need to solve the chicken and egg problem of the tests here not passing (and as such the release not happening) until yamux upgrades, which can't happen until the tests here pass (and the release happening).

I think mplex will still need to be used in tests here for the foreseeable future.

@achingbrain achingbrain changed the title fix: deprecate @libp2p/mplex Deprecate @libp2p/mplex tracking issue May 28, 2024
@maschad
Copy link
Member Author

maschad commented May 31, 2024

The missing piece here is to replace mplex with yamux where a muxer is required by the test.

I should have articulated it this way, but post-#1578 this should be the case, so our tests are currently testing against yamux to my understanding. Therefore, it should be safe to remove mplex from those tests.

@maschad maschad added the version-2.0 PRs that will be released in libp2p v2 label Aug 27, 2024
@achingbrain
Copy link
Member

Mplex is marked deprecated so there's not much else to do here.

It's still in the repo and being tested/updated as it's very low-maintenance to do so. If it becomes high-maintenance it'll be removed but that's not happened yet.

@github-project-automation github-project-automation bot moved this from 🛠️ Todo to 🎉Done in js-libp2p Sep 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file kind/maintenance Work required to avoid breaking changes or harm to project's status quo version-2.0 PRs that will be released in libp2p v2
Projects
Archived in project
Development

No branches or pull requests

2 participants