Include optional Ipni-Cid-Schema-Type HTTP header #221
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
|
github actions seems to be pretty unhappy about the references here - are you missing a file / definition? |
This optional header, when present, serves as an indication to advertisement publishers what type of data is being requested and is identified by the CID. This may help some publishers more quickly lookup the data. The publisher, who receives the Ipni-Cid-Schema-Type HTTP header, does not validate the value, because newer values may need to be received by consumer that is using an older version of library. Implements fix for ipni/storetheindex#2662
gammazero
force-pushed
the
request-type-hint
branch
from
860c89b to
fe0831e
Compare
willscott
approved these changes
Sep 3, 2024
masih
requested changes
Sep 3, 2024
There was a problem hiding this comment.
Blockers:
- exposed context key for schema type
- check that returned node matches the expected type from link system.
- match IPLD schema types exactly for header values.
Otherwise, LGTM. Left some suggestions.
Thank you for getting this done @gammazero 🍻
| // Value already checked in Sync. | ||
| reqType, ok := ctx.Value(CidSchemaCtxKey).(string) | ||
| if ok { | ||
| req.Header.Set(CidSchemaHeader, reqType) |
There was a problem hiding this comment.
OK to set this for both request and response. We just want to make sure this is documented in the specs somewhere.
There was a problem hiding this comment.
I don't think we want it in the response, do we, since the indexer knows what was requested?
gammazero
force-pushed
the
request-type-hint
branch
from
6a23460 to
bbbeb76
Compare
masih
approved these changes
Sep 4, 2024
There was a problem hiding this comment.
There is a minor lint issue that's failing CI, otherwise no blockers. Thanks @gammazero 🚀
gammazero
added a commit
that referenced
this pull request
Sep 5, 2024
Same as #221 applied to Release-0.5.x branch. - update go-libp2p to latest
gammazero
added a commit
that referenced
this pull request
Sep 5, 2024
Same as #221 applied to Release-0.5.x branch. - update go-libp2p to latest
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.
This optional header, when present, serves as an indication to advertisement publishers what type of data is being requested and is identified by the CID. This may help some publishers more quickly lookup the data.
The publisher, who receives the Ipni-Cid-Schema-Type HTTP header, does not validate the value, because newer values may need to be received by consumer that is using an older version of library.
Implements fix for ipni/storetheindex#2662