migrate providers package (#1094)

Author: guillaumemichel

dht.go

@@ -23,7 +23,7 @@ import (
 	"github.com/libp2p/go-libp2p-kad-dht/internal/metrics"
 	"github.com/libp2p/go-libp2p-kad-dht/netsize"
 	pb "github.com/libp2p/go-libp2p-kad-dht/pb"
-	"github.com/libp2p/go-libp2p-kad-dht/providers"
+	"github.com/libp2p/go-libp2p-kad-dht/records"
 	"github.com/libp2p/go-libp2p-kad-dht/rtrefresh"
 	kb "github.com/libp2p/go-libp2p-kbucket"
 	"github.com/libp2p/go-libp2p-kbucket/peerdiversity"
@@ -86,7 +86,7 @@ type IpfsDHT struct {
 
 	routingTable *kb.RoutingTable // Array of routing tables for differently distanced nodes
 	// providerStore stores & manages the provider records for this Dht peer.
-	providerStore providers.ProviderStore
+	providerStore records.ProviderStore
 
 	// manages Routing Table refresh
 	rtRefreshManager *rtrefresh.RtRefreshManager
@@ -365,7 +365,7 @@ func makeDHT(ctx context.Context, h host.Host, cfg dhtcfg.Config) (*IpfsDHT, err
 	if cfg.ProviderStore != nil {
 		dht.providerStore = cfg.ProviderStore
 	} else {
-		dht.providerStore, err = providers.NewProviderManager(dht.ctx, h.ID(), dht.peerstore, cfg.Datastore)
+		dht.providerStore, err = records.NewProviderManager(dht.ctx, h.ID(), dht.peerstore, cfg.Datastore)
 		if err != nil {
 			return nil, fmt.Errorf("initializing default provider manager (%v)", err)
 		}
@@ -456,7 +456,7 @@ func makeRoutingTable(dht *IpfsDHT, cfg dhtcfg.Config, maxLastSuccessfulOutbound
 }
 
 // ProviderStore returns the provider storage object for storing and retrieving provider records.
-func (dht *IpfsDHT) ProviderStore() providers.ProviderStore {
+func (dht *IpfsDHT) ProviderStore() records.ProviderStore {
 	return dht.providerStore
 }
 

dht_options.go

@@ -9,7 +9,7 @@ import (
 	"github.com/libp2p/go-libp2p-kad-dht/amino"
 	dhtcfg "github.com/libp2p/go-libp2p-kad-dht/internal/config"
 	pb "github.com/libp2p/go-libp2p-kad-dht/pb"
-	"github.com/libp2p/go-libp2p-kad-dht/providers"
+	"github.com/libp2p/go-libp2p-kad-dht/records"
 	"github.com/libp2p/go-libp2p-kbucket/peerdiversity"
 	record "github.com/libp2p/go-libp2p-record"
 	"github.com/libp2p/go-libp2p/core/host"
@@ -42,7 +42,7 @@ const DefaultPrefix protocol.ID = amino.ProtocolPrefix
 type Option = dhtcfg.Option
 
 // ProviderStore sets the provider storage manager.
-func ProviderStore(ps providers.ProviderStore) Option {
+func ProviderStore(ps records.ProviderStore) Option {
 	return func(c *dhtcfg.Config) error {
 		c.ProviderStore = ps
 		return nil

dht_test.go

@@ -16,7 +16,7 @@ import (
 
 	"github.com/libp2p/go-libp2p-kad-dht/internal"
 	"github.com/libp2p/go-libp2p-kad-dht/internal/net"
-	"github.com/libp2p/go-libp2p-kad-dht/providers"
+	"github.com/libp2p/go-libp2p-kad-dht/records"
 	"github.com/libp2p/go-libp2p/core/crypto"
 	"github.com/libp2p/go-libp2p/core/event"
 	"github.com/libp2p/go-libp2p/core/network"
@@ -635,7 +635,7 @@ type testProviderManager struct {
 	close        func() error
 }
 
-var _ providers.ProviderStore = (*testProviderManager)(nil)
+var _ records.ProviderStore = (*testProviderManager)(nil)
 
 func (t *testProviderManager) AddProvider(ctx context.Context, key []byte, prov peer.AddrInfo) error {
 	return t.addProvider(ctx, key, prov)

fullrt/dht.go

@@ -41,7 +41,7 @@ import (
 	internalConfig "github.com/libp2p/go-libp2p-kad-dht/internal/config"
 	"github.com/libp2p/go-libp2p-kad-dht/internal/net"
 	dht_pb "github.com/libp2p/go-libp2p-kad-dht/pb"
-	"github.com/libp2p/go-libp2p-kad-dht/providers"
+	"github.com/libp2p/go-libp2p-kad-dht/records"
 	kb "github.com/libp2p/go-libp2p-kbucket"
 
 	record "github.com/libp2p/go-libp2p-record"
@@ -82,7 +82,7 @@ type FullRT struct {
 
 	enableValues, enableProviders bool
 	Validator                     record.Validator
-	ProviderManager               *providers.ProviderManager
+	ProviderManager               *records.ProviderManager
 	datastore                     ds.Datastore
 	h                             host.Host
 
@@ -184,7 +184,7 @@ func NewFullRT(h host.Host, protocolPrefix protocol.ID, options ...Option) (*Ful
 	ctx, cancel := context.WithCancel(context.Background())
 
 	self := h.ID()
-	pm, err := providers.NewProviderManager(ctx, self, h.Peerstore(), dhtcfg.Datastore, fullrtcfg.pmOpts...)
+	pm, err := records.NewProviderManager(ctx, self, h.Peerstore(), dhtcfg.Datastore, fullrtcfg.pmOpts...)
 	if err != nil {
 		cancel()
 		return nil, err

fullrt/options.go

@@ -6,7 +6,7 @@ import (
 
 	kaddht "github.com/libp2p/go-libp2p-kad-dht"
 	"github.com/libp2p/go-libp2p-kad-dht/crawler"
-	"github.com/libp2p/go-libp2p-kad-dht/providers"
+	"github.com/libp2p/go-libp2p-kad-dht/records"
 )
 
 type config struct {
@@ -17,7 +17,7 @@ type config struct {
 	bulkSendParallelism    int
 	timeoutPerOp           time.Duration
 	crawler                crawler.Crawler
-	pmOpts                 []providers.Option
+	pmOpts                 []records.Option
 	ipDiversityFilterLimit int
 }
 
@@ -94,8 +94,8 @@ func WithTimeoutPerOperation(t time.Duration) Option {
 }
 
 // WithProviderManagerOptions sets the options to use when instantiating
-// providers.ProviderManager.
-func WithProviderManagerOptions(pmOpts ...providers.Option) Option {
+// records.ProviderManager.
+func WithProviderManagerOptions(pmOpts ...records.Option) Option {
 	return func(opt *config) error {
 		opt.pmOpts = pmOpts
 		return nil

internal/config/config.go

@@ -12,7 +12,7 @@ import (
 	"github.com/libp2p/go-libp2p-kad-dht/amino"
 	"github.com/libp2p/go-libp2p-kad-dht/internal/net"
 	pb "github.com/libp2p/go-libp2p-kad-dht/pb"
-	"github.com/libp2p/go-libp2p-kad-dht/providers"
+	"github.com/libp2p/go-libp2p-kad-dht/records"
 	"github.com/libp2p/go-libp2p-kbucket/peerdiversity"
 	record "github.com/libp2p/go-libp2p-record"
 	"github.com/libp2p/go-libp2p/core/host"
@@ -49,7 +49,7 @@ type Config struct {
 	MaxRecordAge           time.Duration
 	EnableProviders        bool
 	EnableValues           bool
-	ProviderStore          providers.ProviderStore
+	ProviderStore          records.ProviderStore
 	QueryPeerFilter        QueryFilterFunc
 	LookupCheckConcurrency int
 	MsgSenderBuilder       func(h host.Host, protos []protocol.ID) pb.MessageSenderWithDisconnect
@@ -128,7 +128,7 @@ var Defaults = func(o *Config) error {
 	o.RoutingTable.AutoRefresh = true
 	o.RoutingTable.PeerFilter = EmptyRTFilter
 
-	o.MaxRecordAge = providers.ProvideValidity
+	o.MaxRecordAge = records.ProvideValidity
 
 	o.BucketSize = amino.DefaultBucketSize
 	o.Concurrency = amino.DefaultConcurrency

providers/providers_manager.go

@@ -26,18 +26,23 @@ import (
 const (
 	// ProvidersKeyPrefix is the prefix/namespace for ALL provider record
 	// keys stored in the data store.
+	//
+	// Deprecated: use records.ProvidersKeyPrefix
 	ProvidersKeyPrefix = "/providers/"
 
 	// ProviderAddrTTL is the TTL to keep the multi addresses of provider
 	// peers around. Those addresses are returned alongside provider. After
 	// it expires, the returned records will require an extra lookup, to
 	// find the multiaddress associated with the returned peer id.
+	//
+	// Deprecated: use records.ProviderAddrTTL
 	ProviderAddrTTL = amino.DefaultProviderAddrTTL
 )
 
 // ProvideValidity is the default time that a Provider Record should last on DHT
 // This value is also known as Provider Record Expiration Interval.
 var (
+	// Deprecated: use records.ProvideValidity
 	ProvideValidity        = amino.DefaultProvideValidity
 	defaultCleanupInterval = time.Hour
 	lruCacheSize           = 256
@@ -46,6 +51,8 @@ var (
 )
 
 // ProviderStore represents a store that associates peers and their addresses to keys.
+//
+// Deprecated: use records.ProviderStore
 type ProviderStore interface {
 	AddProvider(ctx context.Context, key []byte, prov peer.AddrInfo) error
 	GetProviders(ctx context.Context, key []byte) ([]peer.AddrInfo, error)
@@ -54,6 +61,8 @@ type ProviderStore interface {
 
 // ProviderManager adds and pulls providers out of the datastore,
 // caching them in between
+//
+// Deprecated: use records.ProviderManager
 type ProviderManager struct {
 	self peer.ID
 	// all non channel fields are meant to be accessed only within
@@ -75,6 +84,8 @@ type ProviderManager struct {
 var _ ProviderStore = (*ProviderManager)(nil)
 
 // Option is a function that sets a provider manager option.
+//
+// Deprecated: use records.Option
 type Option func(*ProviderManager) error
 
 func (pm *ProviderManager) applyOptions(opts ...Option) error {
@@ -88,6 +99,8 @@ func (pm *ProviderManager) applyOptions(opts ...Option) error {
 
 // CleanupInterval sets the time between GC runs.
 // Defaults to 1h.
+//
+// Deprecated: use records package instead
 func CleanupInterval(d time.Duration) Option {
 	return func(pm *ProviderManager) error {
 		pm.cleanupInterval = d
@@ -97,6 +110,8 @@ func CleanupInterval(d time.Duration) Option {
 
 // Cache sets the LRU cache implementation.
 // Defaults to a simple LRU cache.
+//
+// Deprecated: use records package instead
 func Cache(c lru.LRUCache) Option {
 	return func(pm *ProviderManager) error {
 		pm.cache = c
@@ -117,6 +132,8 @@ type getProv struct {
 }
 
 // NewProviderManager constructor
+//
+// Deprecated: use records.NewProviderManager
 func NewProviderManager(ctx context.Context, local peer.ID, ps peerstore.Peerstore, dstore ds.Batching, opts ...Option) (*ProviderManager, error) {
 	pm := new(ProviderManager)
 	pm.self = local

records/provider_set.go

@@ -0,0 +1,34 @@
+package records
+
+import (
+	"time"
+
+	"github.com/libp2p/go-libp2p/core/peer"
+)
+
+// A providerSet has the list of providers and the time that they were added
+// It is used as an intermediary data struct between what is stored in the datastore
+// and the list of providers that get passed to the consumer of a .GetProviders call
+type providerSet struct {
+	providers []peer.ID
+	set       map[peer.ID]time.Time
+}
+
+func newProviderSet() *providerSet {
+	return &providerSet{
+		set: make(map[peer.ID]time.Time),
+	}
+}
+
+func (ps *providerSet) Add(p peer.ID) {
+	ps.setVal(p, time.Now())
+}
+
+func (ps *providerSet) setVal(p peer.ID, t time.Time) {
+	_, found := ps.set[p]
+	if !found {
+		ps.providers = append(ps.providers, p)
+	}
+
+	ps.set[p] = t
+}