feat(gateway): IPIP-0524 + AllowCodecConversion config option#1077
Open
feat(gateway): IPIP-0524 + AllowCodecConversion config option#1077
Conversation
lidel
force-pushed
the
feat/ipip-0524-optional-codec-conversion
branch
3 times, most recently
from
5d808bf to
4206b34
Compare
lidel
changed the title
Codecov Report✅ All modified and coverable lines are covered by tests. @@ Coverage Diff @@
## main #1077 +/- ##
==========================================
+ Coverage 61.63% 61.68% +0.04%
==========================================
Files 265 265
Lines 26521 26528 +7
==========================================
+ Hits 16347 16363 +16
+ Misses 8487 8479 -8
+ Partials 1687 1686 -1
... and 10 files with indirect coverage changes 🚀 New features to boost your workflow:
|
Add AllowCodecConversion to gateway.Config to control codec conversion behavior per IPIP-0524. When false (default), the gateway returns 406 Not Acceptable if the requested format doesn't match the block's codec. When true, conversions between codecs are performed for backward compatibility. Codec conversion tests moved here from gateway-conformance since conversions are now an optional implementation feature, not a spec requirement. Gateway-conformance now tests for 406 responses. Ref: ipfs/specs#524 Ref: ipfs/gateway-conformance#254
lidel
force-pushed
the
feat/ipip-0524-optional-codec-conversion
branch
from
4206b34 to
c92cc34
Compare
lidel
commented
Dec 3, 2025
gateway/handler_codec.go
Outdated
Comment on lines
152
to
154
| if !i.config.AllowCodecConversion && toCodec != cidCodec { | ||
| // Conversion not allowed and codecs don't match - return 406 | ||
| err := fmt.Errorf("format %q requested but block has codec %q: codec conversion is not supported", rq.responseFormat, cidCodec.String()) |
Member
Author
There was a problem hiding this comment.
dag-json as a generic ?format=json or dag-cbor as generic ?format=cbor
If we trully don't allow conversions, these requests will now error on gateways.
I do not know if anyone is using these conversions, so in boxo an kubo I'm going to keep configuration option to opt-in back to old behavior if someone self-hosts.
cc @achingbrain for visibility
Member
Author
There was a problem hiding this comment.
I'm assuming this is a niche feature that can go away as long we have meaningful error message in boxo/gateway.
Relaxed spec a bit to allow implementation to handle Accept: application/json in more interoperable way, but that is MAY, not mandatory from spec perspective.
lidel
added a commit
to ipfs/kubo
that referenced
this pull request
Dec 3, 2025
Wire up boxo's AllowCodecConversion config to control codec conversion behavior per IPIP-0524. When false (default), the gateway returns 406 Not Acceptable if the requested format doesn't match the block's codec. Clients should fetch raw blocks (`?format=raw`) and convert client-side. Ref: ipfs/specs#524 Ref: ipfs/boxo#1077 Ref: ipfs/gateway-conformance#254
2 tasks
lidel
added a commit
to ipfs/kubo
that referenced
this pull request
Dec 3, 2025
Wire up boxo's AllowCodecConversion config to control codec conversion behavior per IPIP-0524. When false (default), the gateway returns 406 Not Acceptable if the requested format doesn't match the block's codec. Clients should fetch raw blocks (`?format=raw`) and convert client-side. Ref: ipfs/specs#524 Ref: ipfs/boxo#1077 Ref: ipfs/gateway-conformance#254
…al-codec-conversion
lidel
added a commit
to ipfs/kubo
that referenced
this pull request
Dec 3, 2025
Wire up boxo's AllowCodecConversion config to control codec conversion behavior per IPIP-0524. When false (default), the gateway returns 406 Not Acceptable if the requested format doesn't match the block's codec. Clients should fetch raw blocks (`?format=raw`) and convert client-side. Ref: ipfs/specs#524 Ref: ipfs/boxo#1077 Ref: ipfs/gateway-conformance#254
…al-codec-conversion # Conflicts: # .github/workflows/gateway-conformance.yml # CHANGELOG.md # examples/go.mod
when codec conversion is disabled (IPIP-0524) and you request ?format=dag-json for a dag-pb block, the 406 response now suggests fetching the raw block with ?format=raw and converting client-side. covers dag-pb directories, dag-pb files, and raw blocks requested with ?format=dag-json or ?format=dag-cbor. plain ?format=json and Accept: application/json continue to serve the default response, so existing HTTP clients are not affected.
only show the matching format download link (dag-json or dag-cbor) in the HTML preview page when AllowCodecConversion is disabled, preventing users from clicking links that would return 406. when AllowCodecConversion is enabled, both links are shown as before.
Member
Author
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Add
AllowCodecConversiontogateway.Configto control codec conversion behavior per IPIP-0524. When false (default), the gateway returns 406 Not Acceptable if the requested format doesn't match the block's codec. When true, conversions between codecs are performed for backward compatibility.Codec conversion tests moved here from gateway-conformance since conversions are now an optional implementation feature, not a spec requirement. Gateway-conformance now tests for 406 responses.