Skip to content

Commit 9adf153

Browse files
lidellidel
committed
fix(gw): useful IPIP-402 CARs on not found errors
This aims to test ipfs/boxo#440 against ipfs/gateway-conformance#131
1 parent ced3483 commit 9adf153

File tree

9 files changed

+23
-12
lines changed

9 files changed

+23
-12
lines changed

‎.github/workflows/gateway-conformance.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ jobs:
2424
steps:
2525
# 1. Download the gateway-conformance fixtures
2626
- name: Download gateway-conformance fixtures
27-
uses: ipfs/gateway-conformance/.github/actions/extract-fixtures@v0.3
27+
uses: ipfs/gateway-conformance/.github/actions/extract-fixtures@261cc49391dcd2bddd7704ad28b236dc4a63c424
2828
with:
2929
output: fixtures
3030

@@ -90,7 +90,7 @@ jobs:
9090

9191
# 6. Run the gateway-conformance tests
9292
- name: Run gateway-conformance tests
93-
uses: ipfs/gateway-conformance/.github/actions/test@v0.3
93+
uses: ipfs/gateway-conformance/.github/actions/test@261cc49391dcd2bddd7704ad28b236dc4a63c424
9494
with:
9595
gateway-url: http://127.0.0.1:8080
9696
json: output.json

‎docs/changelogs/v0.23.md

+11
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
- [Overview](#overview)
88
- [🔦 Highlights](#-highlights)
99
- [Mplex deprecation](#mplex-deprecation)
10+
- [Gateway: meaningful CAR responses on Not Found errors](#gateway-meaningful-car-responses-on-not-found-errors)
1011
- [📝 Changelog](#-changelog)
1112
- [👨‍👩‍👧‍👦 Contributors](#-contributors)
1213

@@ -32,6 +33,16 @@ $ ipfs config --json Swarm.Transports.Multiplexers.Mplex 200
3233
We will completely remove Mplex in v0.24 as it makes protocols very bad to implement,
3334
if you are in this situation you need to add yamux support to your other implementation.
3435

36+
#### Gateway: meaningful CAR responses on Not Found errors
37+
38+
When requesting a CAR from the gateway, the root of the CAR might no longer be
39+
meaningful. By default, the CAR root will be the last resolvable segment of the
40+
path. However, in situations where the path cannot be resolved, such as when
41+
the path does not exist, a CAR will be sent with a root of `bafkqaaa` (empty CID).
42+
43+
This CAR will contain all blocks necessary to validate that the path does not
44+
exist without having to trust the gateway.
45+
3546
### 📝 Changelog
3647

3748
### 👨‍👩‍👧‍👦 Contributors

‎docs/examples/kubo-as-a-library/go.mod

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ go 1.18
77
replace github.com/ipfs/kubo => ./../../..
88

99
require (
10-
github.com/ipfs/boxo v0.11.1-0.20230817061817-1d2f5e511e9f
10+
github.com/ipfs/boxo v0.11.1-0.20230817163255-eb36550a9547
1111
github.com/ipfs/kubo v0.0.0-00010101000000-000000000000
1212
github.com/libp2p/go-libp2p v0.29.2
1313
github.com/multiformats/go-multiaddr v0.10.1

‎docs/examples/kubo-as-a-library/go.sum

+2-2
Original file line numberDiff line numberDiff line change
@@ -301,8 +301,8 @@ github.com/ianlancetaylor/demangle v0.0.0-20181102032728-5e5cf60278f6/go.mod h1:
301301
github.com/inconshreveable/mousetrap v1.0.0/go.mod h1:PxqpIevigyE2G7u3NXJIT2ANytuPF1OarO4DADm73n8=
302302
github.com/ipfs/bbloom v0.0.4 h1:Gi+8EGJ2y5qiD5FbsbpX/TMNcJw8gSqr7eyjHa4Fhvs=
303303
github.com/ipfs/bbloom v0.0.4/go.mod h1:cS9YprKXpoZ9lT0n/Mw/a6/aFV6DTjTLYHeA+gyqMG0=
304-
github.com/ipfs/boxo v0.11.1-0.20230817061817-1d2f5e511e9f h1:sXqGLIATCsBdHse7S9n6e328NhORvVM64+4IRuFlpmI=
305-
github.com/ipfs/boxo v0.11.1-0.20230817061817-1d2f5e511e9f/go.mod h1:8IfDmp+FzFGcF4zjAgHMVPpwYw4AjN9ePEzDfkaYJ1w=
304+
github.com/ipfs/boxo v0.11.1-0.20230817163255-eb36550a9547 h1:AE6pzqLUq22jKFf3648vmcCcQ6lbRhbGEQvj6TL65KA=
305+
github.com/ipfs/boxo v0.11.1-0.20230817163255-eb36550a9547/go.mod h1:8IfDmp+FzFGcF4zjAgHMVPpwYw4AjN9ePEzDfkaYJ1w=
306306
github.com/ipfs/go-bitfield v1.1.0 h1:fh7FIo8bSwaJEh6DdTWbCeZ1eqOaOkKFI74SCnsWbGA=
307307
github.com/ipfs/go-bitfield v1.1.0/go.mod h1:paqf1wjq/D2BBmzfTVFlJQ9IlFOZpg422HL0HqsGWHU=
308308
github.com/ipfs/go-block-format v0.0.2/go.mod h1:AWR46JfpcObNfg3ok2JHDUfdiHRgWhJgCQF+KIgOPJY=

‎go.mod

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ require (
1515
github.com/fsnotify/fsnotify v1.6.0
1616
github.com/google/uuid v1.3.0
1717
github.com/hashicorp/go-multierror v1.1.1
18-
github.com/ipfs/boxo v0.11.1-0.20230817061817-1d2f5e511e9f
18+
github.com/ipfs/boxo v0.11.1-0.20230817163255-eb36550a9547
1919
github.com/ipfs/go-block-format v0.1.2
2020
github.com/ipfs/go-cid v0.4.1
2121
github.com/ipfs/go-cidutil v0.1.0

‎go.sum

+2-2
Original file line numberDiff line numberDiff line change
@@ -337,8 +337,8 @@ github.com/ianlancetaylor/demangle v0.0.0-20181102032728-5e5cf60278f6/go.mod h1:
337337
github.com/inconshreveable/mousetrap v1.0.0/go.mod h1:PxqpIevigyE2G7u3NXJIT2ANytuPF1OarO4DADm73n8=
338338
github.com/ipfs/bbloom v0.0.4 h1:Gi+8EGJ2y5qiD5FbsbpX/TMNcJw8gSqr7eyjHa4Fhvs=
339339
github.com/ipfs/bbloom v0.0.4/go.mod h1:cS9YprKXpoZ9lT0n/Mw/a6/aFV6DTjTLYHeA+gyqMG0=
340-
github.com/ipfs/boxo v0.11.1-0.20230817061817-1d2f5e511e9f h1:sXqGLIATCsBdHse7S9n6e328NhORvVM64+4IRuFlpmI=
341-
github.com/ipfs/boxo v0.11.1-0.20230817061817-1d2f5e511e9f/go.mod h1:8IfDmp+FzFGcF4zjAgHMVPpwYw4AjN9ePEzDfkaYJ1w=
340+
github.com/ipfs/boxo v0.11.1-0.20230817163255-eb36550a9547 h1:AE6pzqLUq22jKFf3648vmcCcQ6lbRhbGEQvj6TL65KA=
341+
github.com/ipfs/boxo v0.11.1-0.20230817163255-eb36550a9547/go.mod h1:8IfDmp+FzFGcF4zjAgHMVPpwYw4AjN9ePEzDfkaYJ1w=
342342
github.com/ipfs/go-bitfield v1.1.0 h1:fh7FIo8bSwaJEh6DdTWbCeZ1eqOaOkKFI74SCnsWbGA=
343343
github.com/ipfs/go-bitfield v1.1.0/go.mod h1:paqf1wjq/D2BBmzfTVFlJQ9IlFOZpg422HL0HqsGWHU=
344344
github.com/ipfs/go-bitswap v0.11.0 h1:j1WVvhDX1yhG32NTC9xfxnqycqYIlhzEzLXG/cU1HyQ=

‎test/cli/gateway_test.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -487,7 +487,7 @@ func TestGateway(t *testing.T) {
487487

488488
t.Run("not present key from node 1", func(t *testing.T) {
489489
t.Parallel()
490-
assert.Equal(t, 404, node1.GatewayClient().Get("/ipfs/"+cidFoo).StatusCode)
490+
assert.Equal(t, 500, node1.GatewayClient().Get("/ipfs/"+cidFoo).StatusCode)
491491
})
492492

493493
t.Run("not present IPNS key from node 1", func(t *testing.T) {

‎test/dependencies/go.mod

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ replace github.com/ipfs/kubo => ../../
77
require (
88
github.com/Kubuxu/gocovmerge v0.0.0-20161216165753-7ecaa51963cd
99
github.com/golangci/golangci-lint v1.49.0
10-
github.com/ipfs/boxo v0.11.1-0.20230817061817-1d2f5e511e9f
10+
github.com/ipfs/boxo v0.11.1-0.20230817163255-eb36550a9547
1111
github.com/ipfs/go-cid v0.4.1
1212
github.com/ipfs/go-cidutil v0.1.0
1313
github.com/ipfs/go-datastore v0.6.0

‎test/dependencies/go.sum

+2-2
Original file line numberDiff line numberDiff line change
@@ -395,8 +395,8 @@ github.com/inconshreveable/mousetrap v1.0.0 h1:Z8tu5sraLXCXIcARxBp/8cbvlwVa7Z1NH
395395
github.com/inconshreveable/mousetrap v1.0.0/go.mod h1:PxqpIevigyE2G7u3NXJIT2ANytuPF1OarO4DADm73n8=
396396
github.com/ipfs/bbloom v0.0.4 h1:Gi+8EGJ2y5qiD5FbsbpX/TMNcJw8gSqr7eyjHa4Fhvs=
397397
github.com/ipfs/bbloom v0.0.4/go.mod h1:cS9YprKXpoZ9lT0n/Mw/a6/aFV6DTjTLYHeA+gyqMG0=
398-
github.com/ipfs/boxo v0.11.1-0.20230817061817-1d2f5e511e9f h1:sXqGLIATCsBdHse7S9n6e328NhORvVM64+4IRuFlpmI=
399-
github.com/ipfs/boxo v0.11.1-0.20230817061817-1d2f5e511e9f/go.mod h1:8IfDmp+FzFGcF4zjAgHMVPpwYw4AjN9ePEzDfkaYJ1w=
398+
github.com/ipfs/boxo v0.11.1-0.20230817163255-eb36550a9547 h1:AE6pzqLUq22jKFf3648vmcCcQ6lbRhbGEQvj6TL65KA=
399+
github.com/ipfs/boxo v0.11.1-0.20230817163255-eb36550a9547/go.mod h1:8IfDmp+FzFGcF4zjAgHMVPpwYw4AjN9ePEzDfkaYJ1w=
400400
github.com/ipfs/go-bitfield v1.1.0 h1:fh7FIo8bSwaJEh6DdTWbCeZ1eqOaOkKFI74SCnsWbGA=
401401
github.com/ipfs/go-bitfield v1.1.0/go.mod h1:paqf1wjq/D2BBmzfTVFlJQ9IlFOZpg422HL0HqsGWHU=
402402
github.com/ipfs/go-block-format v0.1.2 h1:GAjkfhVx1f4YTODS6Esrj1wt2HhrtwTnhEr+DyPUaJo=

0 commit comments

Comments
 (0)