Skip to content

bitswap/httpnet: expose the errors on connect when connection impossible #939

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

Merged
hsanjuan merged 3 commits into from
Jun 13, 2025
Merged

bitswap/httpnet: expose the errors on connect when connection impossible #939

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d9b4633
bitswap/httpnet: expose the errors on connect when connection impossible
hsanjuan Jun 3, 2025
14c9d72
bitswap/http: use multierr for grouping errors
hsanjuan Jun 6, 2025
e2e6ff7
Merge branch 'main' into http-expose-errors
hsanjuan Jun 6, 2025
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
30 changes: 24 additions & 6 deletions bitswap/network/httpnet/httpnet.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ import (
var log = logging.Logger("httpnet")

var ErrNoHTTPAddresses = errors.New("AddrInfo does not contain any valid HTTP addresses")
var ErrNoSuccess = errors.New("none of the peer HTTP endpoints responded successfully to request")
var ErrNoSuccess = errors.New("connection failed to all HTTP endpoints")
var ErrNotConnected = errors.New("no HTTP connection has been setup to this peer")

var _ network.BitSwapNetwork = (*Network)(nil)
Expand Down Expand Up @@ -388,6 +388,19 @@ func (ht *Network) Self() peer.ID {
return ht.host.ID()
}

func connectError(errs map[*network.ParsedURL]error) error {
if len(errs) == 0 {
return ErrNoHTTPAddresses
}

finalErr := ErrNoSuccess
for u, err := range errs {
finalErr = fmt.Errorf("%w\n* [%s: %s]", finalErr, u.Multiaddress.String(), err)
}
Comment thread
gammazero marked this conversation as resolved.
Outdated

return finalErr
}

// Connect attempts setting up an HTTP connection to the given peer. The given
// AddrInfo must include at least one HTTP endpoint for the peer. HTTP URLs in
// AddrInfo will be tried by making an HTTP GET request to
Expand All @@ -411,6 +424,8 @@ func (ht *Network) Connect(ctx context.Context, pi peer.AddrInfo) error {

urls := network.ExtractURLsFromPeer(pi)

errsMap := make(map[*network.ParsedURL]error)

// Filter addresses based on allow and denylists
var filteredURLs []network.ParsedURL
for _, u := range urls {
Expand All @@ -426,11 +441,13 @@ func (ht *Network) Connect(ctx context.Context, pi peer.AddrInfo) error {
_, denied := ht.denylist[host]
if allowed && !denied {
filteredURLs = append(filteredURLs, u)
} else {
errsMap[&u] = errors.New("address not allowed per allow/denylist")
}
}
urls = filteredURLs
if len(urls) == 0 {
return ErrNoHTTPAddresses
return connectError(errsMap)
}
if len(urls) > ht.maxHTTPAddressesPerPeer {
urls = urls[0:ht.maxHTTPAddressesPerPeer]
Expand All @@ -446,9 +463,10 @@ func (ht *Network) Connect(ctx context.Context, pi peer.AddrInfo) error {
// If head works we assume GET works too.
err := ht.connectToURL(ctx, pi.ID, u, "HEAD")
if err != nil {
errsMap[&u] = err
// abort if context cancelled
if ctxErr := ctx.Err(); ctxErr != nil {
return ctxErr
return connectError(errsMap)
}
} else {
workingAddrs = append(workingAddrs, u.Multiaddress)
Expand All @@ -460,9 +478,9 @@ func (ht *Network) Connect(ctx context.Context, pi peer.AddrInfo) error {

err = ht.connectToURL(ctx, pi.ID, u, "GET")
if err != nil {
// abort if context cancelled
errsMap[&u] = err
if errors.Is(err, context.Canceled) || errors.Is(err, context.DeadlineExceeded) {
return err
return connectError(errsMap)
}
continue
}
Expand All @@ -471,7 +489,7 @@ func (ht *Network) Connect(ctx context.Context, pi peer.AddrInfo) error {

// Bail out if no working urls found.
if len(workingAddrs) == 0 {
return fmt.Errorf("connect failure to %s: %w", p, ErrNoSuccess)
return connectError(errsMap)
}

// We have some working urls!
Expand Down
73 changes: 61 additions & 12 deletions bitswap/network/httpnet/httpnet_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,9 @@ func mockNetwork(t *testing.T, recv network.Receiver, opts ...Option) (*Network,
if err != nil {
t.Fatal(err)
}
opts = append(opts, WithInsecureSkipVerify(true))

// allow ovewrite of default options by prepending them
opts = append([]Option{WithInsecureSkipVerify(true)}, opts...)
htnet := New(h, opts...)
htnet.Start(recv)
return htnet.(*Network), mn
Expand Down Expand Up @@ -282,20 +284,25 @@ func srvMultiaddr(t *testing.T, srv *httptest.Server) multiaddr.Multiaddr {
return maddr.Encapsulate(httpma)
}

func connectToPeer(t *testing.T, ctx context.Context, htnet *Network, remote host.Host, srvs ...*httptest.Server) {
func connectToPeer(t *testing.T, ctx context.Context, htnet *Network, remote host.Host, srvs ...*httptest.Server) error {
var addrs []multiaddr.Multiaddr
for _, srv := range srvs {
addrs = append(addrs, srvMultiaddr(t, srv))
}

err := htnet.Connect(
return htnet.Connect(
ctx,
peer.AddrInfo{
ID: remote.ID(),
Addrs: addrs,
},
)
if err != nil {
}

func mustConnectToPeer(t *testing.T, ctx context.Context, htnet *Network, remote host.Host, srvs ...*httptest.Server) {
t.Helper()

if err := connectToPeer(t, ctx, htnet, remote, srvs...); err != nil {
t.Fatal(err)
}
}
Expand All @@ -308,7 +315,7 @@ func TestBestURL(t *testing.T) {
t.Fatal(err)
}
msrv := makeServer(t, 0, 0)
connectToPeer(t, ctx, htnet, peer, msrv)
mustConnectToPeer(t, ctx, htnet, peer, msrv)

nms, err := htnet.NewMessageSender(
ctx,
Expand Down Expand Up @@ -393,6 +400,48 @@ func TestBestURL(t *testing.T) {

}

func TestConnectErrors(t *testing.T) {
ctx := context.Background()
recv := mockReceiver(t)
msrv := makeServer(t, 0, 0)

htnet, mn := mockNetwork(t, recv,
WithInsecureSkipVerify(false),
)
peer, err := mn.GenPeer()
if err != nil {
t.Fatal(err)
}

err = connectToPeer(t, ctx, htnet, peer, msrv)
if err == nil {
t.Error("expected error")
}
t.Log(err)
if !strings.Contains(err.Error(), "failed to verify") {
t.Error("wrong error")
}

htnet2, mn2 := mockNetwork(t, recv,
WithDenylist([]string{"127.0.0.1"}),
)

peer2, err := mn2.GenPeer()
if err != nil {
t.Fatal(err)
}

err = connectToPeer(t, ctx, htnet2, peer2, msrv)
if err == nil {
t.Error("expected error")
}
t.Log(err)
if !strings.Contains(err.Error(), "denylist") {
t.Error("wrong error")
}

}

func TestSendMessage(t *testing.T) {
ctx := context.Background()
recv := mockReceiver(t)
Expand All @@ -402,7 +451,7 @@ func TestSendMessage(t *testing.T) {
t.Fatal(err)
}
msrv := makeServer(t, 0, 10)
connectToPeer(t, ctx, htnet, peer, msrv)
mustConnectToPeer(t, ctx, htnet, peer, msrv)

wl := makeCids(t, 0, 10)
msg := makeWantsMessage(wl)
Expand Down Expand Up @@ -431,7 +480,7 @@ func TestSendMessageWithFailingServer(t *testing.T) {
}
msrv := makeServer(t, 0, 0)
msrv2 := makeServer(t, 0, 10)
connectToPeer(t, ctx, htnet, peer, msrv, msrv2)
mustConnectToPeer(t, ctx, htnet, peer, msrv, msrv2)

wl := makeCids(t, 0, 10)
msg := makeWantsMessage(wl)
Expand Down Expand Up @@ -462,7 +511,7 @@ func TestSendMessageWithPartialResponse(t *testing.T) {
t.Fatal(err)
}
msrv := makeServer(t, 5, 10)
connectToPeer(t, ctx, htnet, peer, msrv)
mustConnectToPeer(t, ctx, htnet, peer, msrv)

wl := makeCids(t, 0, 10)
msg := makeWantsMessage(wl)
Expand Down Expand Up @@ -497,7 +546,7 @@ func TestSendMessageSendHavesAndDontHaves(t *testing.T) {
t.Fatal(err)
}
msrv := makeServer(t, 0, 5)
connectToPeer(t, ctx, htnet, peer, msrv)
mustConnectToPeer(t, ctx, htnet, peer, msrv)

wl := makeCids(t, 0, 10)
msg := makeHavesMessage(wl)
Expand Down Expand Up @@ -545,8 +594,8 @@ func TestBackOff(t *testing.T) {
}

msrv := makeServer(t, 0, 1)
connectToPeer(t, ctx, htnet, peer, msrv)
connectToPeer(t, ctx, htnet, peer2, msrv)
mustConnectToPeer(t, ctx, htnet, peer, msrv)
mustConnectToPeer(t, ctx, htnet, peer2, msrv)

nms, err := htnet.NewMessageSender(ctx, peer.ID(), nil)
if err != nil {
Expand Down Expand Up @@ -598,7 +647,7 @@ func TestErrorTracking(t *testing.T) {
}

msrv := makeServer(t, 0, 0)
connectToPeer(t, ctx, htnet, peer, msrv)
mustConnectToPeer(t, ctx, htnet, peer, msrv)

err = recv.waitConnected(1)
if err != nil {
Expand Down