feat: implement delegated PUTs

Author: hacdias

client.go

@@ -47,15 +47,6 @@ func findProviders(ctx context.Context, key cid.Cid, endpoint string, prettyOutp
 				fmt.Fprintln(os.Stdout, record.ID)
 				fmt.Fprintln(os.Stdout, "\tProtocols:", record.Protocols)
 				fmt.Fprintln(os.Stdout, "\tAddresses:", record.Addrs)
-
-				//lint:ignore SA1019 // ignore staticcheck
-			case types.SchemaBitswap:
-				//lint:ignore SA1019 // ignore staticcheck
-				record := res.Val.(*types.BitswapRecord)
-				fmt.Fprintln(os.Stdout, record.ID)
-				fmt.Fprintln(os.Stdout, "\tProtocol:", record.Protocol)
-				fmt.Fprintln(os.Stdout, "\tAddresses:", record.Addrs)
-
 			default:
 				// This is an unknown schema. Let's just print it raw.
 				err := json.NewEncoder(os.Stdout).Encode(res.Val)

go.mod

@@ -5,7 +5,7 @@ go 1.21
 require (
 	github.com/CAFxX/httpcompression v0.0.9
 	github.com/felixge/httpsnoop v1.0.4
-	github.com/ipfs/boxo v0.17.0
+	github.com/ipfs/boxo v0.17.1-0.20240215103716-813b59fc38e9
 	github.com/ipfs/go-cid v0.4.1
 	github.com/ipfs/go-log/v2 v2.5.1
 	github.com/libp2p/go-libp2p v0.32.2

go.sum

@@ -186,8 +186,8 @@ github.com/hpcloud/tail v1.0.0/go.mod h1:ab1qPbhIpdTxEkNHXyeSf5vhxWSCs/tWer42PpO
 github.com/huin/goupnp v1.3.0 h1:UvLUlWDNpoUdYzb2TCn+MuTWtcjXKSza2n6CBdQ0xXc=
 github.com/huin/goupnp v1.3.0/go.mod h1:gnGPsThkYa7bFi/KWmEysQRf48l2dvR5bxr2OFckNX8=
 github.com/inconshreveable/mousetrap v1.0.0/go.mod h1:PxqpIevigyE2G7u3NXJIT2ANytuPF1OarO4DADm73n8=
-github.com/ipfs/boxo v0.17.0 h1:fVXAb12dNbraCX1Cdid5BB6Kl62gVLNVA+e0EYMqAU0=
-github.com/ipfs/boxo v0.17.0/go.mod h1:pIZgTWdm3k3pLF9Uq6MB8JEcW07UDwNJjlXW1HELW80=
+github.com/ipfs/boxo v0.17.1-0.20240215103716-813b59fc38e9 h1:UCaiJRJTjpYtDXG9H3M3AdeotBw+KxcU6zj3D8PdnVU=
+github.com/ipfs/boxo v0.17.1-0.20240215103716-813b59fc38e9/go.mod h1:pIZgTWdm3k3pLF9Uq6MB8JEcW07UDwNJjlXW1HELW80=
 github.com/ipfs/go-cid v0.0.3/go.mod h1:GHWU/WuQdMPmIosc4Yn1bcCT7dSeX4lBafM7iqUPQvM=
 github.com/ipfs/go-cid v0.4.1 h1:A/T3qGvxi4kpKWWcPC/PgbvDA2bjVLO7n4UeVwnbs/s=
 github.com/ipfs/go-cid v0.4.1/go.mod h1:uQHwDeX4c6CtyrFwdqyhpNcxVewur1M7l7fNU7LKwZk=

server_routers.go

@@ -3,6 +3,7 @@ package main
 import (
 	"context"
 	"errors"
+	"math"
 	"sync"
 	"time"
 
@@ -24,10 +25,12 @@ type router interface {
 
 type providersRouter interface {
 	FindProviders(ctx context.Context, cid cid.Cid, limit int) (iter.ResultIter[types.Record], error)
+	Provide(ctx context.Context, req *types.AnnouncementRecord) (time.Duration, error)
 }
 
 type peersRouter interface {
 	FindPeers(ctx context.Context, pid peer.ID, limit int) (iter.ResultIter[*types.PeerRecord], error)
+	ProvidePeer(ctx context.Context, req *types.AnnouncementRecord) (time.Duration, error)
 }
 
 type ipnsRouter interface {
@@ -50,13 +53,27 @@ func (r composableRouter) FindProviders(ctx context.Context, key cid.Cid, limit
 	return r.providers.FindProviders(ctx, key, limit)
 }
 
+func (r composableRouter) Provide(ctx context.Context, req *types.AnnouncementRecord) (time.Duration, error) {
+	if r.providers == nil {
+		return 0, nil
+	}
+	return r.providers.Provide(ctx, req)
+}
+
 func (r composableRouter) FindPeers(ctx context.Context, pid peer.ID, limit int) (iter.ResultIter[*types.PeerRecord], error) {
 	if r.peers == nil {
 		return iter.ToResultIter(iter.FromSlice([]*types.PeerRecord{})), nil
 	}
 	return r.peers.FindPeers(ctx, pid, limit)
 }
 
+func (r composableRouter) ProvidePeer(ctx context.Context, req *types.AnnouncementRecord) (time.Duration, error) {
+	if r.peers == nil {
+		return 0, nil
+	}
+	return r.peers.ProvidePeer(ctx, req)
+}
+
 func (r composableRouter) GetIPNS(ctx context.Context, name ipns.Name) (*ipns.Record, error) {
 	if r.ipns == nil {
 		return nil, routing.ErrNotFound
@@ -71,11 +88,6 @@ func (r composableRouter) PutIPNS(ctx context.Context, name ipns.Name, record *i
 	return r.ipns.PutIPNS(ctx, name, record)
 }
 
-//lint:ignore SA1019 // ignore staticcheck
-func (r composableRouter) ProvideBitswap(ctx context.Context, req *server.BitswapWriteProvideRequest) (time.Duration, error) {
-	return 0, routing.ErrNotSupported
-}
-
 var _ server.ContentRouter = parallelRouter{}
 
 type parallelRouter struct {
@@ -206,6 +218,57 @@ func (mi *manyIter[T]) Close() error {
 	return err
 }
 
+func (r parallelRouter) Provide(ctx context.Context, req *types.AnnouncementRecord) (time.Duration, error) {
+	return provide(ctx, r.routers, func(ctx context.Context, r router) (time.Duration, error) {
+		return r.Provide(ctx, req)
+	})
+}
+
+func (r parallelRouter) ProvidePeer(ctx context.Context, req *types.AnnouncementRecord) (time.Duration, error) {
+	return provide(ctx, r.routers, func(ctx context.Context, r router) (time.Duration, error) {
+		return r.ProvidePeer(ctx, req)
+	})
+}
+
+func provide(ctx context.Context, routers []router, call func(context.Context, router) (time.Duration, error)) (time.Duration, error) {
+	switch len(routers) {
+	case 0:
+		return 0, nil
+	case 1:
+		return call(ctx, routers[0])
+	}
+
+	ctx, cancel := context.WithCancel(ctx)
+	defer cancel()
+
+	var wg sync.WaitGroup
+	resultsTTL := make([]time.Duration, len(routers))
+	resultsErr := make([]error, len(routers))
+	wg.Add(len(routers))
+	for i, ri := range routers {
+		go func(ri router, i int) {
+			resultsTTL[i], resultsErr[i] = call(ctx, ri)
+			wg.Done()
+		}(ri, i)
+	}
+	wg.Wait()
+
+	var err error
+	for _, e := range resultsErr {
+		err = errors.Join(err, e)
+	}
+
+	// Choose lowest TTL to return.
+	var ttl time.Duration = math.MaxInt64
+	for _, t := range resultsTTL {
+		if t < ttl {
+			ttl = t
+		}
+	}
+
+	return ttl, err
+}
+
 func (r parallelRouter) GetIPNS(ctx context.Context, name ipns.Name) (*ipns.Record, error) {
 	switch len(r.routers) {
 	case 0:
@@ -296,11 +359,6 @@ func (r parallelRouter) PutIPNS(ctx context.Context, name ipns.Name, record *ipn
 	return errs
 }
 
-//lint:ignore SA1019 // ignore staticcheck
-func (r parallelRouter) ProvideBitswap(ctx context.Context, req *server.BitswapWriteProvideRequest) (time.Duration, error) {
-	return 0, routing.ErrNotSupported
-}
-
 var _ router = libp2pRouter{}
 
 type libp2pRouter struct {
@@ -316,6 +374,12 @@ func (d libp2pRouter) FindProviders(ctx context.Context, key cid.Cid, limit int)
 	}), nil
 }
 
+func (d libp2pRouter) Provide(ctx context.Context, req *types.AnnouncementRecord) (time.Duration, error) {
+	// NOTE: this router cannot provide further to the DHT, since we can only
+	// announce CIDs that our own node has, which is not the case.
+	return 0, routing.ErrNotSupported
+}
+
 func (d libp2pRouter) FindPeers(ctx context.Context, pid peer.ID, limit int) (iter.ResultIter[*types.PeerRecord], error) {
 	ctx, cancel := context.WithCancel(ctx)
 	defer cancel()
@@ -337,6 +401,10 @@ func (d libp2pRouter) FindPeers(ctx context.Context, pid peer.ID, limit int) (it
 	return iter.ToResultIter[*types.PeerRecord](iter.FromSlice[*types.PeerRecord]([]*types.PeerRecord{rec})), nil
 }
 
+func (r libp2pRouter) ProvidePeer(ctx context.Context, req *types.AnnouncementRecord) (time.Duration, error) {
+	return 0, routing.ErrNotSupported
+}
+
 func (d libp2pRouter) GetIPNS(ctx context.Context, name ipns.Name) (*ipns.Record, error) {
 	ctx, cancel := context.WithCancel(ctx)
 	defer cancel()
@@ -409,6 +477,36 @@ func (d clientRouter) FindProviders(ctx context.Context, cid cid.Cid, limit int)
 	return d.Client.FindProviders(ctx, cid)
 }
 
+func (d clientRouter) Provide(ctx context.Context, req *types.AnnouncementRecord) (time.Duration, error) {
+	return d.provide(func() (iter.ResultIter[*types.AnnouncementRecord], error) {
+		return d.Client.ProvideRecords(ctx, req)
+	})
+}
+
 func (d clientRouter) FindPeers(ctx context.Context, pid peer.ID, limit int) (iter.ResultIter[*types.PeerRecord], error) {
 	return d.Client.FindPeers(ctx, pid)
 }
+
+func (d clientRouter) ProvidePeer(ctx context.Context, req *types.AnnouncementRecord) (time.Duration, error) {
+	return d.provide(func() (iter.ResultIter[*types.AnnouncementRecord], error) {
+		return d.Client.ProvidePeerRecords(ctx, req)
+	})
+}
+
+func (d clientRouter) provide(do func() (iter.ResultIter[*types.AnnouncementRecord], error)) (time.Duration, error) {
+	resIter, err := do()
+	if err != nil {
+		return 0, err
+	}
+
+	records, err := iter.ReadAllResults(resIter)
+	if err != nil {
+		return 0, err
+	}
+
+	if len(records) != 1 {
+		return 0, errors.New("invalid number of records returned")
+	}
+
+	return records[0].Payload.TTL, nil
+}

server_routers_test.go

@@ -32,6 +32,11 @@ func (m *mockRouter) FindProviders(ctx context.Context, key cid.Cid, limit int)
 	return args.Get(0).(iter.ResultIter[types.Record]), args.Error(1)
 }
 
+func (m *mockRouter) Provide(ctx context.Context, req *types.AnnouncementRecord) (time.Duration, error) {
+	args := m.Called(ctx, req)
+	return args.Get(0).(time.Duration), args.Error(1)
+}
+
 func (m *mockRouter) FindPeers(ctx context.Context, pid peer.ID, limit int) (iter.ResultIter[*types.PeerRecord], error) {
 	args := m.Called(ctx, pid, limit)
 	if arg0 := args.Get(0); arg0 == nil {
@@ -40,6 +45,11 @@ func (m *mockRouter) FindPeers(ctx context.Context, pid peer.ID, limit int) (ite
 	return args.Get(0).(iter.ResultIter[*types.PeerRecord]), args.Error(1)
 }
 
+func (m *mockRouter) ProvidePeer(ctx context.Context, req *types.AnnouncementRecord) (time.Duration, error) {
+	args := m.Called(ctx, req)
+	return args.Get(0).(time.Duration), args.Error(1)
+}
+
 func (m *mockRouter) GetIPNS(ctx context.Context, name ipns.Name) (*ipns.Record, error) {
 	args := m.Called(ctx, name)
 	if arg0 := args.Get(0); arg0 == nil {