Add backwards compatibility option to libp2phttp for the well-known resource #2798
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
gammazero
approved these changes
May 17, 2024
MarcoPolo
force-pushed
the
marco/backwards-compat-libp2p-http-well-known
branch
from
eddd9f7
to
b105c1a
Compare
sukunrt
approved these changes
May 17, 2024
Comment on lines
+38
to
+42
|
|
||
| // LegacyWellKnownProtocols refer to a the well-known resource used in an early | ||
| // draft of the libp2p+http spec. Some users have deployed this, and need backwards compatibility. | ||
| // Hopefully we can phase this out in the future. Context: https://github.com/libp2p/go-libp2p/pull/2797 | ||
| const LegacyWellKnownProtocols = "/.well-known/libp2p" |
There was a problem hiding this comment.
I think so. For similar reasons as we export the other one. Also when we remove compatibility support we’ll remove this, which could help folks realize this is gone.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We've bike shedded on the well-known resource so long that we have a number of users that are relying on the old well-known path being at
.well-known/libp2p. This patch gives them a migration path. Enabling this option allows clients to request both the new and old path in parallel (so it doesn't cost one whole round trip). On the server side, it serves both well-known resources so that legacy clients don't break.This change is meant to give our early adopters of libp2phttp a migration path. The goal is to get rid of this code after some time (2 releases? 3?) to allow users to upgrade.