Introduce first strategic provider: do nothing

License: MIT
Signed-off-by: Michael Avila <davidmichaelavila@gmail.com>

core/builder.go

@@ -3,11 +3,10 @@ package core
 import (
 	"context"
 
-	"github.com/ipfs/go-metrics-interface"
-	"go.uber.org/fx"
-
 	"github.com/ipfs/go-ipfs/core/bootstrap"
 	"github.com/ipfs/go-ipfs/core/node"
+	"github.com/ipfs/go-metrics-interface"
+	"go.uber.org/fx"
 )
 
 type BuildCfg = node.BuildCfg // Alias for compatibility until we properly refactor the constructor interface

core/commands/bitswap.go

@@ -234,7 +234,7 @@ Trigger reprovider to announce our data to network.
 			return ErrNotOnline
 		}
 
-		err = nd.Reprovider.Trigger(req.Context)
+		err = nd.Provider.Reprovide(req.Context)
 		if err != nil {
 			return err
 		}

core/core.go

@@ -27,7 +27,6 @@ import (
 	"github.com/ipfs/go-ipfs/pin"
 	"github.com/ipfs/go-ipfs/provider"
 	"github.com/ipfs/go-ipfs/repo"
-	rp "github.com/ipfs/go-ipfs/reprovide"
 
 	bserv "github.com/ipfs/go-blockservice"
 	bstore "github.com/ipfs/go-ipfs-blockstore"
@@ -94,8 +93,7 @@ type IpfsNode struct {
 	Routing      routing.IpfsRouting `optional:"true"` // the routing system. recommend ipfs-dht
 	Exchange     exchange.Interface  // the block exchange + strategy (bitswap)
 	Namesys      namesys.NameSystem  // the name system, resolves paths to hashes
-	Provider     provider.Provider   // the value provider system
-	Reprovider   *rp.Reprovider      `optional:"true"` // the value reprovider system
+	Provider     provider.System     // the value provider system
 	IpnsRepub    *ipnsrp.Republisher `optional:"true"`
 
 	AutoNAT  *autonat.AutoNATService    `optional:"true"`

core/coreapi/coreapi.go

@@ -68,7 +68,7 @@ type CoreAPI struct {
 	namesys namesys.NameSystem
 	routing routing.IpfsRouting
 
-	provider provider.Provider
+	provider provider.System
 
 	pubSub *pubsub.PubSub
 

core/node/core.go

@@ -4,6 +4,7 @@ import (
 	"context"
 	"fmt"
 
+	"github.com/ipfs/go-ipfs-config"
 	"github.com/ipfs/go-ipfs/core/node/helpers"
 	"github.com/ipfs/go-ipfs/pin"
 	"github.com/ipfs/go-ipfs/repo"
@@ -59,8 +60,9 @@ func Dag(bs blockservice.BlockService) format.DAGService {
 }
 
 // OnlineExchange creates new LibP2P backed block exchange (BitSwap)
-func OnlineExchange(mctx helpers.MetricsCtx, lc fx.Lifecycle, host host.Host, rt routing.IpfsRouting, bs blockstore.GCBlockstore) exchange.Interface {
+func OnlineExchange(mctx helpers.MetricsCtx, lc fx.Lifecycle, cfg *config.Config, host host.Host, rt routing.IpfsRouting, bs blockstore.GCBlockstore) exchange.Interface {
 	bitswapNetwork := network.NewFromIpfsHost(host, rt)
+	bitswap.ProvideEnabled = !cfg.Experimental.StrategicProviding
 	exch := bitswap.New(helpers.LifecycleCtx(mctx, lc), bitswapNetwork, bs)
 	lc.Append(fx.Hook{
 		OnStop: func(ctx context.Context) error {

core/node/groups.go

@@ -14,12 +14,10 @@ import (
 	pubsub "github.com/libp2p/go-libp2p-pubsub"
 
 	"github.com/ipfs/go-ipfs/core/node/libp2p"
-	"github.com/ipfs/go-ipfs/p2p"
-	"github.com/ipfs/go-ipfs/provider"
-	"github.com/ipfs/go-ipfs/reprovide"
 
 	offline "github.com/ipfs/go-ipfs-exchange-offline"
 	offroute "github.com/ipfs/go-ipfs-routing/offline"
+	"github.com/ipfs/go-ipfs/p2p"
 	"github.com/ipfs/go-path/resolver"
 	uio "github.com/ipfs/go-unixfs/io"
 	"go.uber.org/fx"
@@ -188,42 +186,6 @@ var IPNS = fx.Options(
 	fx.Provide(RecordValidator),
 )
 
-// Providers groups units managing provider routing records
-func Providers(cfg *config.Config) fx.Option {
-	reproviderInterval := kReprovideFrequency
-	if cfg.Reprovider.Interval != "" {
-		dur, err := time.ParseDuration(cfg.Reprovider.Interval)
-		if err != nil {
-			return fx.Error(err)
-		}
-
-		reproviderInterval = dur
-	}
-
-	var keyProvider fx.Option
-	switch cfg.Reprovider.Strategy {
-	case "all":
-		fallthrough
-	case "":
-		keyProvider = fx.Provide(reprovide.NewBlockstoreProvider)
-	case "roots":
-		keyProvider = fx.Provide(reprovide.NewPinnedProvider(true))
-	case "pinned":
-		keyProvider = fx.Provide(reprovide.NewPinnedProvider(false))
-	default:
-		return fx.Error(fmt.Errorf("unknown reprovider strategy '%s'", cfg.Reprovider.Strategy))
-	}
-
-	return fx.Options(
-		fx.Provide(ProviderQueue),
-		fx.Provide(ProviderCtor),
-		fx.Provide(ReproviderCtor(reproviderInterval)),
-		keyProvider,
-
-		fx.Invoke(Reprovider),
-	)
-}
-
 // Online groups online-only units
 func Online(bcfg *BuildCfg, cfg *config.Config) fx.Option {
 
@@ -272,17 +234,19 @@ func Online(bcfg *BuildCfg, cfg *config.Config) fx.Option {
 		fx.Provide(p2p.New),
 
 		LibP2P(bcfg, cfg),
-		Providers(cfg),
+		OnlineProviders(cfg),
 	)
 }
 
 // Offline groups offline alternatives to Online units
-var Offline = fx.Options(
-	fx.Provide(offline.Exchange),
-	fx.Provide(Namesys(0)),
-	fx.Provide(offroute.NewOfflineRouter),
-	fx.Provide(provider.NewOfflineProvider),
-)
+func Offline(cfg *config.Config) fx.Option {
+	return fx.Options(
+		fx.Provide(offline.Exchange),
+		fx.Provide(Namesys(0)),
+		fx.Provide(offroute.NewOfflineRouter),
+		OfflineProviders(cfg),
+	)
+}
 
 // Core groups basic IPFS services
 var Core = fx.Options(
@@ -297,7 +261,7 @@ func Networked(bcfg *BuildCfg, cfg *config.Config) fx.Option {
 	if bcfg.Online {
 		return Online(bcfg, cfg)
 	}
-	return Offline
+	return Offline(cfg)
 }
 
 // IPFS builds a group of fx Options based on the passed BuildCfg

core/node/provider.go

@@ -2,50 +2,129 @@ package node
 
 import (
 	"context"
+	"fmt"
 	"time"
 
-	"github.com/libp2p/go-libp2p-routing"
 	"go.uber.org/fx"
 
+	"github.com/ipfs/go-ipfs-config"
 	"github.com/ipfs/go-ipfs/core/node/helpers"
 	"github.com/ipfs/go-ipfs/provider"
+	q "github.com/ipfs/go-ipfs/provider/queue"
+	"github.com/ipfs/go-ipfs/provider/simple"
 	"github.com/ipfs/go-ipfs/repo"
-	"github.com/ipfs/go-ipfs/reprovide"
+	"github.com/libp2p/go-libp2p-routing"
 )
 
 const kReprovideFrequency = time.Hour * 12
 
+// SIMPLE
+
 // ProviderQueue creates new datastore backed provider queue
-func ProviderQueue(mctx helpers.MetricsCtx, lc fx.Lifecycle, repo repo.Repo) (*provider.Queue, error) {
-	return provider.NewQueue(helpers.LifecycleCtx(mctx, lc), "provider-v1", repo.Datastore())
+func ProviderQueue(mctx helpers.MetricsCtx, lc fx.Lifecycle, repo repo.Repo) (*q.Queue, error) {
+	return q.NewQueue(helpers.LifecycleCtx(mctx, lc), "provider-v1", repo.Datastore())
 }
 
-// ProviderCtor creates new record provider
-func ProviderCtor(mctx helpers.MetricsCtx, lc fx.Lifecycle, queue *provider.Queue, rt routing.IpfsRouting) provider.Provider {
-	p := provider.NewProvider(helpers.LifecycleCtx(mctx, lc), queue, rt)
+// SimpleProviderCtor creates new record provider
+func SimpleProviderCtor(mctx helpers.MetricsCtx, lc fx.Lifecycle, queue *q.Queue, rt routing.IpfsRouting) provider.Provider {
+	return simple.NewProvider(helpers.LifecycleCtx(mctx, lc), queue, rt)
+}
+
+// SimpleReproviderCtor creates new reprovider
+func SimpleReproviderCtor(reproviderInterval time.Duration) func(helpers.MetricsCtx, fx.Lifecycle, routing.IpfsRouting, simple.KeyChanFunc) (provider.Reprovider, error) {
+	return func(mctx helpers.MetricsCtx, lc fx.Lifecycle, rt routing.IpfsRouting, keyProvider simple.KeyChanFunc) (provider.Reprovider, error) {
+		return simple.NewReprovider(helpers.LifecycleCtx(mctx, lc), reproviderInterval, rt, keyProvider), nil
+	}
+}
 
+// SimpleProviderSysCtor creates new provider system
+func SimpleProviderSysCtor(lc fx.Lifecycle, p provider.Provider, r provider.Reprovider) provider.System {
+	sys := provider.NewSystem(p, r)
 	lc.Append(fx.Hook{
 		OnStart: func(ctx context.Context) error {
-			p.Run()
+			sys.Run()
 			return nil
 		},
 		OnStop: func(ctx context.Context) error {
-			return p.Close()
+			return sys.Close()
 		},
 	})
+	return sys
+}
+
+// SimpleOfflineProviderSysCtor creates a new offline provider system
+func SimpleOfflineProviderSysCtor(p provider.Provider, r provider.Reprovider) provider.System {
+	return provider.NewSystem(p, r)
+}
+
+// STRATEGIC
+
+// StrategicProviderSysCtor creates new provider system
+func StrategicProviderSysCtor() provider.System {
+	return provider.NewOfflineProvider()
+}
+
+// StrategicOfflineProviderSysCtor creates a new offline provider system
+func StrategicOfflineProviderSysCtor() provider.System {
+	return provider.NewOfflineProvider()
+}
+
+// ONLINE/OFFLINE
+
+// OnlineProviders groups units managing provider routing records online
+func OnlineProviders(cfg *config.Config) fx.Option {
+	if cfg.Experimental.StrategicProviding {
+		return fx.Provide(StrategicProviderSysCtor)
+	}
 
-	return p
+	return fx.Options(
+		SimpleProviders(cfg),
+		fx.Provide(SimpleProviderSysCtor),
+	)
 }
 
-// ReproviderCtor creates new reprovider
-func ReproviderCtor(reproviderInterval time.Duration) func(helpers.MetricsCtx, fx.Lifecycle, routing.IpfsRouting, reprovide.KeyChanFunc) (*reprovide.Reprovider, error) {
-	return func(mctx helpers.MetricsCtx, lc fx.Lifecycle, rt routing.IpfsRouting, keyProvider reprovide.KeyChanFunc) (*reprovide.Reprovider, error) {
-		return reprovide.NewReprovider(helpers.LifecycleCtx(mctx, lc), reproviderInterval, rt, keyProvider), nil
+// OfflineProviders groups units managing provider routing records offline
+func OfflineProviders(cfg *config.Config) fx.Option {
+	if cfg.Experimental.StrategicProviding {
+		return fx.Provide(StrategicOfflineProviderSysCtor)
 	}
+
+	return fx.Options(
+		SimpleProviders(cfg),
+		fx.Provide(SimpleOfflineProviderSysCtor),
+	)
 }
 
-// Reprovider runs the reprovider service
-func Reprovider(lp lcProcess, reprovider *reprovide.Reprovider) error {
-	lp.Append(reprovider.Run)
-	return nil
+// SimpleProviders creates the simple provider/reprovider dependencies
+func SimpleProviders(cfg *config.Config) fx.Option {
+	reproviderInterval := kReprovideFrequency
+	if cfg.Reprovider.Interval != "" {
+		dur, err := time.ParseDuration(cfg.Reprovider.Interval)
+		if err != nil {
+			return fx.Error(err)
+		}
+
+		reproviderInterval = dur
+	}
+
+	var keyProvider fx.Option
+	switch cfg.Reprovider.Strategy {
+	case "all":
+		fallthrough
+	case "":
+		keyProvider = fx.Provide(simple.NewBlockstoreProvider)
+	case "roots":
+		keyProvider = fx.Provide(simple.NewPinnedProvider(true))
+	case "pinned":
+		keyProvider = fx.Provide(simple.NewPinnedProvider(false))
+	default:
+		return fx.Error(fmt.Errorf("unknown reprovider strategy '%s'", cfg.Reprovider.Strategy))
+	}
+
+	return fx.Options(
+		fx.Provide(ProviderQueue),
+		fx.Provide(SimpleProviderCtor),
+		keyProvider,
+		fx.Provide(SimpleReproviderCtor(reproviderInterval)),
+	)
 }

go.mod

@@ -16,7 +16,7 @@ require (
 	github.com/hashicorp/golang-lru v0.5.1
 	github.com/hsanjuan/go-libp2p-http v0.0.2
 	github.com/ipfs/dir-index-html v1.0.3
-	github.com/ipfs/go-bitswap v0.0.4
+	github.com/ipfs/go-bitswap v0.0.5
 	github.com/ipfs/go-block-format v0.0.2
 	github.com/ipfs/go-blockservice v0.0.3
 	github.com/ipfs/go-cid v0.0.1
@@ -34,7 +34,7 @@ require (
 	github.com/ipfs/go-ipfs-chunker v0.0.1
 	github.com/ipfs/go-ipfs-cmdkit v0.0.1
 	github.com/ipfs/go-ipfs-cmds v0.0.5
-	github.com/ipfs/go-ipfs-config v0.0.3
+	github.com/ipfs/go-ipfs-config v0.0.4-0.20190502164316-b06d585017ae
 	github.com/ipfs/go-ipfs-ds-help v0.0.1
 	github.com/ipfs/go-ipfs-exchange-interface v0.0.1
 	github.com/ipfs/go-ipfs-exchange-offline v0.0.1

go.sum

@@ -138,6 +138,10 @@ github.com/ipfs/go-bitswap v0.0.3 h1:uFcSI9dkjUn67S7IM60vr2wA27aAvn8o9xYjaQCug3o
 github.com/ipfs/go-bitswap v0.0.3/go.mod h1:jadAZYsP/tcRMl47ZhFxhaNuDQoXawT8iHMg+iFoQbg=
 github.com/ipfs/go-bitswap v0.0.4 h1:mrS8jBd+rCgKw7Owx4RM5QBiMi9DBc1Ih9FaEBYM4/M=
 github.com/ipfs/go-bitswap v0.0.4/go.mod h1:jadAZYsP/tcRMl47ZhFxhaNuDQoXawT8iHMg+iFoQbg=
+github.com/ipfs/go-bitswap v0.0.5-0.20190430213314-d1f829bed810 h1:bZlGYwSXQ4wiewl39r2w/3GjSE/CwzKoiXVb4UeQ6hE=
+github.com/ipfs/go-bitswap v0.0.5-0.20190430213314-d1f829bed810/go.mod h1:fcVV/eiSBkhfkqOf+v0WjA+fZVYJV6NKZRgue2B6b34=
+github.com/ipfs/go-bitswap v0.0.5 h1:ccnSWMn5CwWH/8zU7UZugFeJ/ZWH2AzexKmozx+7BG8=
+github.com/ipfs/go-bitswap v0.0.5/go.mod h1:fcVV/eiSBkhfkqOf+v0WjA+fZVYJV6NKZRgue2B6b34=
 github.com/ipfs/go-block-format v0.0.1/go.mod h1:DK/YYcsSUIVAFNwo/KZCdIIbpN0ROH/baNLgayt4pFc=
 github.com/ipfs/go-block-format v0.0.2 h1:qPDvcP19izTjU8rgo6p7gTXZlkMkF5bz5G3fqIsSCPE=
 github.com/ipfs/go-block-format v0.0.2/go.mod h1:AWR46JfpcObNfg3ok2JHDUfdiHRgWhJgCQF+KIgOPJY=
@@ -184,8 +188,12 @@ github.com/ipfs/go-ipfs-cmds v0.0.5 h1:+blTEnA0MzkQO86WnpfGnchdojrY5wJLhsbby3/JX
 github.com/ipfs/go-ipfs-cmds v0.0.5/go.mod h1:1QVgxSgenZvOMGVC/XUTC7tJxRBGPLxYvpgPpCi3DUk=
 github.com/ipfs/go-ipfs-config v0.0.1 h1:6ED08emzI1imdsAjixFi2pEyZxTVD5ECKtCOxLBx+Uc=
 github.com/ipfs/go-ipfs-config v0.0.1/go.mod h1:KDbHjNyg4e6LLQSQpkgQMBz6Jf4LXiWAcmnkcwmH0DU=
+github.com/ipfs/go-ipfs-config v0.0.3-0.20190422204848-4aaf5baeceef h1:KEFD4DNaAuvrsN5+38l1e+yjomoegKufUtOJbKcN40k=
+github.com/ipfs/go-ipfs-config v0.0.3-0.20190422204848-4aaf5baeceef/go.mod h1:KDbHjNyg4e6LLQSQpkgQMBz6Jf4LXiWAcmnkcwmH0DU=
 github.com/ipfs/go-ipfs-config v0.0.3 h1:Ep4tRdP1iVK76BgOprD9B/qtOEdpno+1Xb57BqydgGk=
 github.com/ipfs/go-ipfs-config v0.0.3/go.mod h1:KDbHjNyg4e6LLQSQpkgQMBz6Jf4LXiWAcmnkcwmH0DU=
+github.com/ipfs/go-ipfs-config v0.0.4-0.20190502164316-b06d585017ae h1:2lzUW0VhlY+kUQCFjtBAQoFLNqS1cfWQCUmpbgNGRDI=
+github.com/ipfs/go-ipfs-config v0.0.4-0.20190502164316-b06d585017ae/go.mod h1:KDbHjNyg4e6LLQSQpkgQMBz6Jf4LXiWAcmnkcwmH0DU=
 github.com/ipfs/go-ipfs-delay v0.0.0-20181109222059-70721b86a9a8/go.mod h1:8SP1YXK1M1kXuc4KJZINY3TQQ03J2rwBG9QfXmbRPrw=
 github.com/ipfs/go-ipfs-delay v0.0.1 h1:r/UXYyRcddO6thwOnhiznIAiSvxMECGgtv35Xs1IeRQ=
 github.com/ipfs/go-ipfs-delay v0.0.1/go.mod h1:8SP1YXK1M1kXuc4KJZINY3TQQ03J2rwBG9QfXmbRPrw=

provider/offline.go

@@ -1,20 +1,28 @@
 package provider
 
-import "github.com/ipfs/go-cid"
+import (
+	"context"
+	"github.com/ipfs/go-cid"
+)
 
 type offlineProvider struct{}
 
-// NewOfflineProvider creates a Provider that does nothing
-func NewOfflineProvider() Provider {
+// NewOfflineProvider creates a ProviderSystem that does nothing
+func NewOfflineProvider() System {
 	return &offlineProvider{}
 }
 
-func (op *offlineProvider) Run() {}
+func (op *offlineProvider) Run() {
+}
 
-func (op *offlineProvider) Provide(cid cid.Cid) error {
+func (op *offlineProvider) Close() error {
 	return nil
 }
 
-func (op *offlineProvider) Close() error {
+func (op *offlineProvider) Provide(_ cid.Cid) error {
+	return nil
+}
+
+func (op *offlineProvider) Reprovide(_ context.Context) error {
 	return nil
 }