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.

Sign up for GitHub

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

Jump to bottom

feat(routing/http/client): DefaultProtocolFilter for IPIP-484 #689

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+63 −21
Open

feat(routing/http/client): DefaultProtocolFilter for IPIP-484 #689

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ The following emojis are used to highlight certain changes:

### Changed

- `routing/http/client`: creating delegated routing client with `New` now defaults to querying delegated routing server with `DefaultProtocolFilter` ([IPIP-484](https://github.com/ipfs/specs/pull/484)) [#689](https://github.com/ipfs/boxo/pull/689)

### Removed

### Fixed
Expand Down
4 changes: 2 additions & 2 deletions examples/routing/delegated-routing-client/main_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,15 @@ func TestFindProviders(t *testing.T) {
if r.URL.Path == "/routing/v1/providers/"+cidStr {
w.Header().Set("Content-Type", "application/x-ndjson")
w.Write([]byte(`{"Schema":"peer","ID":"12D3KooWM8sovaEGU1bmiWGWAzvs47DEcXKZZTuJnpQyVTkRs2Vn","Addrs":["/ip4/111.222.222.111/tcp/5734"],"Protocols":["transport-bitswap"]}` + "\n"))
w.Write([]byte(`{"Schema":"peer","ID":"12D3KooWB6RAWgcmHAP7TGEGK7utV2ZuqSzX1DNjRa97TtJ7139n","Addrs":["/ip4/127.0.0.1/tcp/5734"],"Protocols":["transport-horse"]}` + "\n"))
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps keep "transport-horse" and add an additional unknown one so that it's clear it's getting filtered

w.Write([]byte(`{"Schema":"peer","ID":"12D3KooWB6RAWgcmHAP7TGEGK7utV2ZuqSzX1DNjRa97TtJ7139n","Addrs":["/ip4/127.0.0.1/tcp/5734"],"Protocols":[]}` + "\n"))
}
}))
t.Cleanup(ts.Close)

out := &bytes.Buffer{}
err := run(out, ts.URL, cidStr, "", "", 1)
assert.Contains(t, out.String(), "12D3KooWM8sovaEGU1bmiWGWAzvs47DEcXKZZTuJnpQyVTkRs2Vn\n\tProtocols: [transport-bitswap]\n\tAddresses: [/ip4/111.222.222.111/tcp/5734]\n")
assert.Contains(t, out.String(), "12D3KooWB6RAWgcmHAP7TGEGK7utV2ZuqSzX1DNjRa97TtJ7139n\n\tProtocols: [transport-horse]\n\tAddresses: [/ip4/127.0.0.1/tcp/5734]\n")
assert.Contains(t, out.String(), "12D3KooWB6RAWgcmHAP7TGEGK7utV2ZuqSzX1DNjRa97TtJ7139n\n\tProtocols: []\n\tAddresses: [/ip4/127.0.0.1/tcp/5734]\n")
assert.NoError(t, err)
}

Expand Down
11 changes: 7 additions & 4 deletions routing/http/client/client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ import (
var (
_ contentrouter.Client = &Client{}
logger = logging.Logger("routing/http/client")

DefaultProtocolFilter = []string{"unknown", "transport-bitswap"} // IPIP-484
)

const (
Expand Down Expand Up @@ -175,10 +177,11 @@ func WithStreamResultsRequired() Option {
// The Provider and identity parameters are option. If they are nil, the [client.ProvideBitswap] method will not function.
func New(baseURL string, opts ...Option) (*Client, error) {
client := &Client{
baseURL: baseURL,
httpClient: newDefaultHTTPClient(defaultUserAgent),
clock: clock.New(),
accepts: strings.Join([]string{mediaTypeNDJSON, mediaTypeJSON}, ","),
baseURL: baseURL,
httpClient: newDefaultHTTPClient(defaultUserAgent),
clock: clock.New(),
accepts: strings.Join([]string{mediaTypeNDJSON, mediaTypeJSON}, ","),
protocolFilter: DefaultProtocolFilter, // can be customized via WithProtocolFilter
}

for _, opt := range opts {
Expand Down
67 changes: 52 additions & 15 deletions routing/http/client/client_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,11 +223,22 @@ func (e *osErrContains) errContains(t *testing.T, err error) {
}

func TestClient_FindProviders(t *testing.T) {
unknownPeerRecord := makePeerRecord([]string{})
bitswapPeerRecord := makePeerRecord([]string{"transport-bitswap"})
httpPeerRecord := makePeerRecord([]string{"transport-ipfs-gateway-http"})
fooPeerRecord := makePeerRecord([]string{"transport-foo"})

peerProviders := []iter.Result[types.Record]{
{Val: &unknownPeerRecord},
{Val: &bitswapPeerRecord},
{Val: &httpPeerRecord},
{Val: &fooPeerRecord},
}

// DefaultProtocolFilter
defaultFilterPeerProviders := []iter.Result[types.Record]{
{Val: &unknownPeerRecord},
{Val: &bitswapPeerRecord},
}

bitswapRecord := makeBitswapRecord()
Expand All @@ -249,16 +260,23 @@ func TestClient_FindProviders(t *testing.T) {
expJSONResponse bool
}{
{
name: "happy case",
name: "happy case with DefaultProtocolFilter",
routerResult: peerProviders,
expResult: defaultFilterPeerProviders,
expStreamingResponse: true,
},
{
name: "pass through with protocol filter disabled",
filterProtocols: []string{},
routerResult: peerProviders,
expResult: peerProviders,
expStreamingResponse: true,
},
{
name: "happy case with protocol filter",
filterProtocols: []string{"transport-bitswap"},
name: "happy case with custom protocol filter",
filterProtocols: []string{"transport-foo"},
routerResult: peerProviders,
expResult: []iter.Result[types.Record]{{Val: &bitswapPeerRecord}},
expResult: []iter.Result[types.Record]{{Val: &fooPeerRecord}},
expStreamingResponse: true,
},
{
Expand All @@ -270,7 +288,7 @@ func TestClient_FindProviders(t *testing.T) {
{
name: "server doesn't support streaming",
routerResult: peerProviders,
expResult: peerProviders,
expResult: defaultFilterPeerProviders,
serverStreamingDisabled: true,
expJSONResponse: true,
},
Expand Down Expand Up @@ -497,13 +515,25 @@ func TestClient_Provide(t *testing.T) {
}

func TestClient_FindPeers(t *testing.T) {
peerRecord1 := makePeerRecord([]string{"transport-bitswap"})
peerRecord2 := makePeerRecord([]string{"transport-ipfs-gateway-http"})
unknownPeerRecord := makePeerRecord([]string{})
bitswapPeerRecord := makePeerRecord([]string{"transport-bitswap"})
httpPeerRecord := makePeerRecord([]string{"transport-ipfs-gateway-http"})
fooPeerRecord := makePeerRecord([]string{"transport-foo"})

peerRecords := []iter.Result[*types.PeerRecord]{
{Val: &peerRecord1},
{Val: &peerRecord2},
{Val: &unknownPeerRecord},
{Val: &bitswapPeerRecord},
{Val: &httpPeerRecord},
{Val: &fooPeerRecord},
}

// DefaultProtocolFilter
defaultFilterPeerRecords := []iter.Result[*types.PeerRecord]{
{Val: &unknownPeerRecord},
{Val: &bitswapPeerRecord},
}
pid := *peerRecord1.ID

pid := *bitswapPeerRecord.ID

cases := []struct {
name string
Expand All @@ -521,22 +551,29 @@ func TestClient_FindPeers(t *testing.T) {
expJSONResponse bool
}{
{
name: "happy case",
name: "happy case with DefaultProtocolFilter",
routerResult: peerRecords,
expResult: defaultFilterPeerRecords,
expStreamingResponse: true,
},
{
name: "pass through with protocol filter disabled",
filterProtocols: []string{},
routerResult: peerRecords,
expResult: peerRecords,
expStreamingResponse: true,
},
{
name: "happy case with protocol filter",
filterProtocols: []string{"transport-bitswap"},
name: "happy case with custom protocol filter",
filterProtocols: []string{"transport-foo"},
routerResult: peerRecords,
expResult: []iter.Result[*types.PeerRecord]{{Val: &peerRecord1}},
expResult: []iter.Result[*types.PeerRecord]{{Val: &fooPeerRecord}},
expStreamingResponse: true,
},
{
name: "server doesn't support streaming",
routerResult: peerRecords,
expResult: peerRecords,
expResult: defaultFilterPeerRecords,
serverStreamingDisabled: true,
expJSONResponse: true,
},
Expand Down