Merge pull request #15 from berty/glouvigny/ipfs_services_as_interface

chore: now using an interface for ipfs services
berty · Jun 14, 2019 · d8de9b8 · d8de9b8
2 parents 93ce6f2 + c6d0f8a
commit d8de9b8
Show file tree

Hide file tree

Showing 19 changed files with 136 additions and 121 deletions.
diff --git a/entry/entry.go b/entry/entry.go
@@ -127,7 +127,7 @@ func init() {
 	cbornode.RegisterCborType(AtlasEntry)
 }
 
-func CreateEntry(ipfsInstance *io.IpfsServices, identity *identityprovider.Identity, data *Entry, clock *lamportclock.LamportClock) (*Entry, error) {
+func CreateEntry(ipfsInstance io.IpfsServices, identity *identityprovider.Identity, data *Entry, clock *lamportclock.LamportClock) (*Entry, error) {
 	if ipfsInstance == nil {
 		return nil, errors.New("ipfs instance not defined")
 	}
@@ -178,7 +178,7 @@ func CreateEntry(ipfsInstance *io.IpfsServices, identity *identityprovider.Ident
 	}
 
 	ctx, _ := context.WithTimeout(context.Background(), time.Second*5)
-	err = ipfsInstance.DAG.Add(ctx, nd)
+	err = ipfsInstance.Dag().Add(ctx, nd)
 	if err != nil {
 		return nil, err
 	}
@@ -298,7 +298,7 @@ func Verify(identity identityprovider.Interface, entry *Entry) error {
 	return nil
 }
 
-func ToMultihash(ipfsInstance *io.IpfsServices, entry *Entry) (cid.Cid, error) {
+func ToMultihash(ipfsInstance io.IpfsServices, entry *Entry) (cid.Cid, error) {
 	if entry == nil {
 		return cid.Cid{}, errors.New("entry is not defined")
 	}
@@ -333,7 +333,7 @@ func ToMultihash(ipfsInstance *io.IpfsServices, entry *Entry) (cid.Cid, error) {
 	return entryCID, err
 }
 
-func FromMultihash(ipfs *io.IpfsServices, hash cid.Cid, provider identityprovider.Interface) (*Entry, error) {
+func FromMultihash(ipfs io.IpfsServices, hash cid.Cid, provider identityprovider.Interface) (*Entry, error) {
 	if ipfs == nil {
 		return nil, errors.New("ipfs instance not defined")
 	}

diff --git a/entry/entry_io.go b/entry/entry_io.go
@@ -18,7 +18,7 @@ type FetchOptions struct {
 	Provider     identityprovider.Interface
 }
 
-func FetchParallel(ipfs *io.IpfsServices, hashes []cid.Cid, options *FetchOptions) []*Entry {
+func FetchParallel(ipfs io.IpfsServices, hashes []cid.Cid, options *FetchOptions) []*Entry {
 	var entries []*Entry
 
 	for _, h := range hashes {
@@ -31,7 +31,7 @@ func FetchParallel(ipfs *io.IpfsServices, hashes []cid.Cid, options *FetchOption
 	return NewOrderedMapFromEntries(entries).Slice()
 }
 
-func FetchAll(ipfs *io.IpfsServices, hashes []cid.Cid, options *FetchOptions) []*Entry {
+func FetchAll(ipfs io.IpfsServices, hashes []cid.Cid, options *FetchOptions) []*Entry {
 	result := []*Entry{}
 	cache := NewOrderedMap()
 	loadingQueue := append(hashes[:0:0], hashes...)

diff --git a/example/example_log_append_test.go b/example/example_log_append_test.go
@@ -6,16 +6,16 @@ import (
 	"io/ioutil"
 
 	idp "berty.tech/go-ipfs-log/identityprovider"
-	log_io "berty.tech/go-ipfs-log/io"
-	keystore "berty.tech/go-ipfs-log/keystore"
+	"berty.tech/go-ipfs-log/keystore"
 	"berty.tech/go-ipfs-log/log"
-	datastore "github.com/ipfs/go-datastore"
+	"github.com/ipfs/go-datastore"
 	dssync "github.com/ipfs/go-datastore/sync"
 	config "github.com/ipfs/go-ipfs-config"
 	ipfs_core "github.com/ipfs/go-ipfs/core"
+	"github.com/ipfs/go-ipfs/core/coreapi"
 	ipfs_libp2p "github.com/ipfs/go-ipfs/core/node/libp2p"
 	ipfs_repo "github.com/ipfs/go-ipfs/repo"
-	libp2p "github.com/libp2p/go-libp2p"
+	"github.com/libp2p/go-libp2p"
 	host "github.com/libp2p/go-libp2p-host"
 	peer "github.com/libp2p/go-libp2p-peer"
 	pstore "github.com/libp2p/go-libp2p-peerstore"
@@ -86,11 +86,15 @@ func Example_logAppend() {
 		panic(fmt.Errorf("connect error: %s", err))
 	}
 
-	mdsA := datastore.NewMapDatastore()
-	serviceA := log_io.FromIpfsNode(nodeA, mdsA)
+	serviceA, err := coreapi.NewCoreAPI(nodeA)
+	if err != nil {
+		panic(fmt.Errorf("coreapi error: %s", err))
+	}
 
-	mdsB := datastore.NewMapDatastore()
-	serviceB := log_io.FromIpfsNode(nodeB, mdsB)
+	serviceB, err := coreapi.NewCoreAPI(nodeB)
+	if err != nil {
+		panic(fmt.Errorf("coreapi error: %s", err))
+	}
 
 	// Fill up datastore with identities
 	ds := dssync.MutexWrap(datastore.NewMapDatastore())

diff --git a/io/io.go b/io/io.go
@@ -16,7 +16,7 @@ func SetDebug(val bool) {
 	debug = val
 }
 
-func WriteCBOR(ipfs *IpfsServices, obj interface{}) (cid.Cid, error) {
+func WriteCBOR(ipfs IpfsServices, obj interface{}) (cid.Cid, error) {
 	cborNode, err := cbornode.WrapObject(obj, math.MaxUint64, -1)
 	if err != nil {
 		return cid.Cid{}, err
@@ -26,14 +26,14 @@ func WriteCBOR(ipfs *IpfsServices, obj interface{}) (cid.Cid, error) {
 		fmt.Printf("\nStr of cbor: %x\n", cborNode.RawData())
 	}
 
-	err = ipfs.DAG.Add(context.Background(), cborNode)
+	err = ipfs.Dag().Add(context.Background(), cborNode)
 	if err != nil {
 		return cid.Cid{}, err
 	}
 
 	return cborNode.Cid(), nil
 }
 
-func ReadCBOR(ipfs *IpfsServices, contentIdentifier cid.Cid) (format.Node, error) {
-	return ipfs.DAG.Get(context.Background(), contentIdentifier)
+func ReadCBOR(ipfs IpfsServices, contentIdentifier cid.Cid) (format.Node, error) {
+	return ipfs.Dag().Get(context.Background(), contentIdentifier)
 }
diff --git a/io/io_test.go b/io/io_test.go
diff --git a/io/service.go b/io/service.go
@@ -1,50 +1,9 @@
 package io // import "berty.tech/go-ipfs-log/io"
 
 import (
-	bserv "github.com/ipfs/go-blockservice"
-	datastore "github.com/ipfs/go-datastore"
-	dssync "github.com/ipfs/go-datastore/sync"
-	bstore "github.com/ipfs/go-ipfs-blockstore"
-	offline "github.com/ipfs/go-ipfs-exchange-offline"
-	ipfs_core "github.com/ipfs/go-ipfs/core"
-	"github.com/ipfs/go-ipfs/pin"
-	ipld "github.com/ipfs/go-ipld-format"
-	merkledag "github.com/ipfs/go-merkledag"
+	core_iface "github.com/ipfs/interface-go-ipfs-core"
 )
 
-type IpfsServices struct {
-	DAG        ipld.DAGService
-	BlockStore bstore.Blockstore
-	DB         datastore.Datastore
-	Blockserv  bserv.BlockService
-	Pinner     pin.Pinner
-}
-
-func NewMemoryServices() *IpfsServices {
-	dataStore := datastore.NewMapDatastore()
-	db := dssync.MutexWrap(dataStore)
-	bs := bstore.NewBlockstore(db)
-	blockserv := bserv.New(bs, offline.Exchange(bs))
-	dag := merkledag.NewDAGService(blockserv)
-	pinner := pin.NewPinner(db, dag, dag)
-
-	// var pinning pin.Pinner = pin.NewPinner()
-	// var blockstore bstore.GCBlockstore = bstore.NewBlockstore()
-	return &IpfsServices{
-		DAG:        dag,
-		BlockStore: bs,
-		DB:         db,
-		Blockserv:  blockserv,
-		Pinner:     pinner,
-	}
-}
-
-func FromIpfsNode(node *ipfs_core.IpfsNode, ds datastore.Datastore) *IpfsServices {
-	return &IpfsServices{
-		DAG:        node.DAG,
-		BlockStore: node.Blockstore,
-		DB:         ds,
-		Blockserv:  node.Blocks,
-		Pinner:     node.Pinning,
-	}
+type IpfsServices interface {
+	Dag() core_iface.APIDagService
 }
diff --git a/log/log.go b/log/log.go
@@ -27,7 +27,7 @@ type JSONLog struct {
 }
 
 type Log struct {
-	Storage          *io.IpfsServices
+	Storage          io.IpfsServices
 	ID               string
 	AccessController accesscontroller.Interface
 	SortFn           func(a *entry.Entry, b *entry.Entry) (int, error)
@@ -71,7 +71,7 @@ func maxClockTimeForEntries(entries []*entry.Entry, defValue int) int {
 	return max
 }
 
-func NewLog(services *io.IpfsServices, identity *identityprovider.Identity, options *NewLogOptions) (*Log, error) {
+func NewLog(services io.IpfsServices, identity *identityprovider.Identity, options *NewLogOptions) (*Log, error) {
 	if services == nil {
 		return nil, errmsg.IPFSNotDefined
 	}
@@ -474,7 +474,7 @@ func (l *Log) ToMultihash() (cid.Cid, error) {
 	return ToMultihash(l.Storage, l)
 }
 
-func NewFromMultihash(services *io.IpfsServices, identity *identityprovider.Identity, hash cid.Cid, logOptions *NewLogOptions, fetchOptions *FetchOptions) (*Log, error) {
+func NewFromMultihash(services io.IpfsServices, identity *identityprovider.Identity, hash cid.Cid, logOptions *NewLogOptions, fetchOptions *FetchOptions) (*Log, error) {
 	if services == nil {
 		return nil, errmsg.IPFSNotDefined
 	}
@@ -521,7 +521,7 @@ func NewFromMultihash(services *io.IpfsServices, identity *identityprovider.Iden
 	})
 }
 
-func NewFromEntryHash(services *io.IpfsServices, identity *identityprovider.Identity, hash cid.Cid, logOptions *NewLogOptions, fetchOptions *FetchOptions) (*Log, error) {
+func NewFromEntryHash(services io.IpfsServices, identity *identityprovider.Identity, hash cid.Cid, logOptions *NewLogOptions, fetchOptions *FetchOptions) (*Log, error) {
 	if logOptions == nil {
 		return nil, errmsg.LogOptionsNotDefined
 	}
@@ -548,7 +548,7 @@ func NewFromEntryHash(services *io.IpfsServices, identity *identityprovider.Iden
 	})
 }
 
-func NewFromJSON(services *io.IpfsServices, identity *identityprovider.Identity, jsonLog *JSONLog, logOptions *NewLogOptions, fetchOptions *entry.FetchOptions) (*Log, error) {
+func NewFromJSON(services io.IpfsServices, identity *identityprovider.Identity, jsonLog *JSONLog, logOptions *NewLogOptions, fetchOptions *entry.FetchOptions) (*Log, error) {
 	if logOptions == nil {
 		return nil, errmsg.LogOptionsNotDefined
 	}
@@ -576,7 +576,7 @@ func NewFromJSON(services *io.IpfsServices, identity *identityprovider.Identity,
 	})
 }
 
-func NewFromEntry(services *io.IpfsServices, identity *identityprovider.Identity, sourceEntries []*entry.Entry, logOptions *NewLogOptions, fetchOptions *entry.FetchOptions) (*Log, error) {
+func NewFromEntry(services io.IpfsServices, identity *identityprovider.Identity, sourceEntries []*entry.Entry, logOptions *NewLogOptions, fetchOptions *entry.FetchOptions) (*Log, error) {
 	if logOptions == nil {
 		return nil, errmsg.LogOptionsNotDefined
 	}

diff --git a/log/log_io.go b/log/log_io.go
@@ -19,15 +19,15 @@ type FetchOptions struct {
 	Timeout      time.Duration
 }
 
-func ToMultihash(services *io.IpfsServices, log *Log) (cid.Cid, error) {
+func ToMultihash(services io.IpfsServices, log *Log) (cid.Cid, error) {
 	if log.Values().Len() < 1 {
 		return cid.Cid{}, errors.New(`can't serialize an empty log`)
 	}
 
 	return io.WriteCBOR(services, log.ToJSON())
 }
 
-func FromMultihash(services *io.IpfsServices, hash cid.Cid, options *FetchOptions) (*Snapshot, error) {
+func FromMultihash(services io.IpfsServices, hash cid.Cid, options *FetchOptions) (*Snapshot, error) {
 	result, err := io.ReadCBOR(services, hash)
 	if err != nil {
 		return nil, err
@@ -77,7 +77,7 @@ func FromMultihash(services *io.IpfsServices, hash cid.Cid, options *FetchOption
 	}, nil
 }
 
-func FromEntryHash(services *io.IpfsServices, hashes []cid.Cid, options *FetchOptions) ([]*entry.Entry, error) {
+func FromEntryHash(services io.IpfsServices, hashes []cid.Cid, options *FetchOptions) ([]*entry.Entry, error) {
 	if services == nil {
 		return nil, errmsg.IPFSNotDefined
 	}
@@ -106,7 +106,7 @@ func FromEntryHash(services *io.IpfsServices, hashes []cid.Cid, options *FetchOp
 	return sliced, nil
 }
 
-func FromJSON(services *io.IpfsServices, jsonLog *JSONLog, options *entry.FetchOptions) (*Snapshot, error) {
+func FromJSON(services io.IpfsServices, jsonLog *JSONLog, options *entry.FetchOptions) (*Snapshot, error) {
 	if services == nil {
 		return nil, errmsg.IPFSNotDefined
 	}
@@ -132,7 +132,7 @@ func FromJSON(services *io.IpfsServices, jsonLog *JSONLog, options *entry.FetchO
 	}, nil
 }
 
-func FromEntry(services *io.IpfsServices, sourceEntries []*entry.Entry, options *entry.FetchOptions) (*Snapshot, error) {
+func FromEntry(services io.IpfsServices, sourceEntries []*entry.Entry, options *entry.FetchOptions) (*Snapshot, error) {
 	if services == nil {
 		return nil, errmsg.IPFSNotDefined
 	}

diff --git a/test/entry_io_test.go b/test/entry_io_test.go
@@ -9,7 +9,6 @@ import (
 
 	"berty.tech/go-ipfs-log/entry"
 	idp "berty.tech/go-ipfs-log/identityprovider"
-	"berty.tech/go-ipfs-log/io"
 	ks "berty.tech/go-ipfs-log/keystore"
 	"berty.tech/go-ipfs-log/log"
 	cid "github.com/ipfs/go-cid"
@@ -22,7 +21,7 @@ func TestEntryPersistence(t *testing.T) {
 	_, cancel := context.WithTimeout(context.Background(), time.Second*10)
 	defer cancel()
 
-	ipfs := io.NewMemoryServices()
+	ipfs := NewMemoryServices()
 
 	datastore := dssync.MutexWrap(NewIdentityDataStore())
 	keystore, err := ks.NewKeystore(datastore)

diff --git a/test/entry_test.go b/test/entry_test.go
@@ -8,7 +8,6 @@ import (
 
 	"berty.tech/go-ipfs-log/entry"
 	idp "berty.tech/go-ipfs-log/identityprovider"
-	"berty.tech/go-ipfs-log/io"
 	ks "berty.tech/go-ipfs-log/keystore"
 	cid "github.com/ipfs/go-cid"
 	dssync "github.com/ipfs/go-datastore/sync"
@@ -20,7 +19,7 @@ func TestEntry(t *testing.T) {
 	_, cancel := context.WithTimeout(context.Background(), time.Second*10)
 	defer cancel()
 
-	ipfs := io.NewMemoryServices()
+	ipfs := NewMemoryServices()
 
 	datastore := dssync.MutexWrap(NewIdentityDataStore())
 	keystore, err := ks.NewKeystore(datastore)

diff --git a/test/log_append_test.go b/test/log_append_test.go
@@ -7,8 +7,7 @@ import (
 	"time"
 
 	idp "berty.tech/go-ipfs-log/identityprovider"
-	log_io "berty.tech/go-ipfs-log/io"
-	keystore "berty.tech/go-ipfs-log/keystore"
+	"berty.tech/go-ipfs-log/keystore"
 	"berty.tech/go-ipfs-log/log"
 	dssync "github.com/ipfs/go-datastore/sync"
 
@@ -19,7 +18,7 @@ func TestLogAppend(t *testing.T) {
 	_, cancel := context.WithTimeout(context.Background(), time.Second*10)
 	defer cancel()
 
-	ipfs := log_io.NewMemoryServices()
+	ipfs := NewMemoryServices()
 
 	datastore := dssync.MutexWrap(NewIdentityDataStore())
 	keystore, err := keystore.NewKeystore(datastore)

diff --git a/test/log_heads_tails_test.go b/test/log_heads_tails_test.go
@@ -7,7 +7,6 @@ import (
 	"time"
 
 	idp "berty.tech/go-ipfs-log/identityprovider"
-	"berty.tech/go-ipfs-log/io"
 	ks "berty.tech/go-ipfs-log/keystore"
 	"berty.tech/go-ipfs-log/log"
 	ds "github.com/ipfs/go-datastore"
@@ -20,7 +19,7 @@ func TestLogHeadsTails(t *testing.T) {
 	_, cancel := context.WithTimeout(context.Background(), time.Second*10)
 	defer cancel()
 
-	ipfs := io.NewMemoryServices()
+	ipfs := NewMemoryServices()
 
 	datastore := dssync.MutexWrap(ds.NewMapDatastore())
 	keystore, err := ks.NewKeystore(datastore)

diff --git a/test/log_join_test.go b/test/log_join_test.go
@@ -10,7 +10,6 @@ import (
 	"berty.tech/go-ipfs-log/entry"
 	"berty.tech/go-ipfs-log/errmsg"
 	idp "berty.tech/go-ipfs-log/identityprovider"
-	"berty.tech/go-ipfs-log/io"
 	ks "berty.tech/go-ipfs-log/keystore"
 	"berty.tech/go-ipfs-log/log"
 	"berty.tech/go-ipfs-log/utils/lamportclock"
@@ -24,7 +23,7 @@ func TestLogJoin(t *testing.T) {
 	_, cancel := context.WithTimeout(context.Background(), time.Second*10)
 	defer cancel()
 
-	ipfs := io.NewMemoryServices()
+	ipfs := NewMemoryServices()
 
 	datastore := dssync.MutexWrap(NewIdentityDataStore())
 	keystore, err := ks.NewKeystore(datastore)