Merge pull request #3301 from ipfs/feat/node-interface

Turn merkledag.Node into an interface

blocks/blocks.go

@@ -14,7 +14,6 @@ import (
 var ErrWrongHash = errors.New("data did not match given hash!")
 
 type Block interface {
-	Multihash() mh.Multihash
 	RawData() []byte
 	Cid() *cid.Cid
 	String() string

blockservice/test/blocks_test.go

@@ -18,18 +18,8 @@ import (
 	dssync "gx/ipfs/QmbzuUusHqaLLoNTDEVLcSF6vZDHZDLPC7p4bztRvvkXxU/go-datastore/sync"
 )
 
-func newObject(data []byte) *testObject {
-	return &testObject{
-		Block: blocks.NewBlock(data),
-	}
-}
-
-type testObject struct {
-	blocks.Block
-}
-
-func (o *testObject) Cid() *cid.Cid {
-	return cid.NewCidV0(o.Block.Multihash())
+func newObject(data []byte) blocks.Block {
+	return blocks.NewBlock(data)
 }
 
 func TestBlocks(t *testing.T) {
@@ -38,12 +28,8 @@ func TestBlocks(t *testing.T) {
 	defer bs.Close()
 
 	o := newObject([]byte("beep boop"))
-	h := u.Hash([]byte("beep boop"))
-	if !bytes.Equal(o.Multihash(), h) {
-		t.Error("Block Multihash and data multihash not equal")
-	}
-
-	if !o.Cid().Equals(cid.NewCidV0(h)) {
+	h := cid.NewCidV0(u.Hash([]byte("beep boop")))
+	if !o.Cid().Equals(h) {
 		t.Error("Block key and data multihash key not equal")
 	}
 
@@ -74,8 +60,8 @@ func TestBlocks(t *testing.T) {
 	}
 }
 
-func makeObjects(n int) []*testObject {
-	var out []*testObject
+func makeObjects(n int) []blocks.Block {
+	var out []blocks.Block
 	for i := 0; i < n; i++ {
 		out = append(out, newObject([]byte(fmt.Sprintf("object %d", i))))
 	}

core/commands/files/files.go

@@ -182,7 +182,7 @@ func statNode(ds dag.DAGService, fsn mfs.FSNode) (*Object, error) {
 
 	return &Object{
 		Hash:           c.String(),
-		Blocks:         len(nd.Links),
+		Blocks:         len(nd.Links()),
 		Size:           d.GetFilesize(),
 		CumulativeSize: cumulsize,
 		Type:           ndtype,
@@ -245,15 +245,25 @@ var FilesCpCmd = &cmds.Command{
 	},
 }
 
-func getNodeFromPath(ctx context.Context, node *core.IpfsNode, p string) (*dag.Node, error) {
+func getNodeFromPath(ctx context.Context, node *core.IpfsNode, p string) (*dag.ProtoNode, error) {
 	switch {
 	case strings.HasPrefix(p, "/ipfs/"):
 		np, err := path.ParsePath(p)
 		if err != nil {
 			return nil, err
 		}
 
-		return core.Resolve(ctx, node, np)
+		nd, err := core.Resolve(ctx, node, np)
+		if err != nil {
+			return nil, err
+		}
+
+		pbnd, ok := nd.(*dag.ProtoNode)
+		if !ok {
+			return nil, dag.ErrNotProtobuf
+		}
+
+		return pbnd, nil
 	default:
 		fsn, err := mfs.Lookup(node.FilesRoot, p)
 		if err != nil {

core/commands/get.go

@@ -13,6 +13,7 @@ import (
 
 	cmds "github.com/ipfs/go-ipfs/commands"
 	core "github.com/ipfs/go-ipfs/core"
+	dag "github.com/ipfs/go-ipfs/merkledag"
 	path "github.com/ipfs/go-ipfs/path"
 	tar "github.com/ipfs/go-ipfs/thirdparty/tar"
 	uarchive "github.com/ipfs/go-ipfs/unixfs/archive"
@@ -69,6 +70,12 @@ may also specify the level of compression by specifying '-l=<1-9>'.
 			return
 		}
 
+		pbnd, ok := dn.(*dag.ProtoNode)
+		if !ok {
+			res.SetError(err, cmds.ErrNormal)
+			return
+		}
+
 		size, err := dn.Size()
 		if err != nil {
 			res.SetError(err, cmds.ErrNormal)
@@ -78,7 +85,7 @@ may also specify the level of compression by specifying '-l=<1-9>'.
 		res.SetLength(size)
 
 		archive, _, _ := req.Option("archive").Bool()
-		reader, err := uarchive.DagArchive(ctx, dn, p.String(), node.DAG, archive, cmplvl)
+		reader, err := uarchive.DagArchive(ctx, pbnd, p.String(), node.DAG, archive, cmplvl)
 		if err != nil {
 			res.SetError(err, cmds.ErrNormal)
 			return

core/commands/ls.go

@@ -13,7 +13,7 @@ import (
 	unixfs "github.com/ipfs/go-ipfs/unixfs"
 	unixfspb "github.com/ipfs/go-ipfs/unixfs/pb"
 
-	cid "gx/ipfs/QmXUuRadqDq5BuFWzVU6VuKaSjTcNm1gNCtLvvP1TJCW4z/go-cid"
+	node "gx/ipfs/QmZx42H5khbVQhV5odp66TApShV4XCujYazcvYduZ4TroB/go-ipld-node"
 )
 
 type LsLink struct {
@@ -52,7 +52,7 @@ The JSON output contains type information.
 		cmds.BoolOption("resolve-type", "Resolve linked objects to find out their types.").Default(true),
 	},
 	Run: func(req cmds.Request, res cmds.Response) {
-		node, err := req.InvocContext().GetNode()
+		nd, err := req.InvocContext().GetNode()
 		if err != nil {
 			res.SetError(err, cmds.ErrNormal)
 			return
@@ -72,9 +72,9 @@ The JSON output contains type information.
 
 		paths := req.Arguments()
 
-		var dagnodes []*merkledag.Node
+		var dagnodes []node.Node
 		for _, fpath := range paths {
-			dagnode, err := core.Resolve(req.Context(), node, path.Path(fpath))
+			dagnode, err := core.Resolve(req.Context(), nd, path.Path(fpath))
 			if err != nil {
 				res.SetError(err, cmds.ErrNormal)
 				return
@@ -86,14 +86,14 @@ The JSON output contains type information.
 		for i, dagnode := range dagnodes {
 			output[i] = LsObject{
 				Hash:  paths[i],
-				Links: make([]LsLink, len(dagnode.Links)),
+				Links: make([]LsLink, len(dagnode.Links())),
 			}
-			for j, link := range dagnode.Links {
-				var linkNode *merkledag.Node
+			for j, link := range dagnode.Links() {
+				var linkNode *merkledag.ProtoNode
 				t := unixfspb.Data_DataType(-1)
-				linkKey := cid.NewCidV0(link.Hash)
-				if ok, err := node.Blockstore.Has(linkKey); ok && err == nil {
-					b, err := node.Blockstore.Get(linkKey)
+				linkKey := link.Cid
+				if ok, err := nd.Blockstore.Has(linkKey); ok && err == nil {
+					b, err := nd.Blockstore.Get(linkKey)
 					if err != nil {
 						res.SetError(err, cmds.ErrNormal)
 						return
@@ -106,11 +106,19 @@ The JSON output contains type information.
 				}
 
 				if linkNode == nil && resolve {
-					linkNode, err = link.GetNode(req.Context(), node.DAG)
+					nd, err := link.GetNode(req.Context(), nd.DAG)
 					if err != nil {
 						res.SetError(err, cmds.ErrNormal)
 						return
 					}
+
+					pbnd, ok := nd.(*merkledag.ProtoNode)
+					if !ok {
+						res.SetError(merkledag.ErrNotProtobuf, cmds.ErrNormal)
+						return
+					}
+
+					linkNode = pbnd
 				}
 				if linkNode != nil {
 					d, err := unixfs.FromBytes(linkNode.Data())
@@ -123,7 +131,7 @@ The JSON output contains type information.
 				}
 				output[i].Links[j] = LsLink{
 					Name: link.Name,
-					Hash: link.Hash.B58String(),
+					Hash: link.Cid.String(),
 					Size: link.Size,
 					Type: t,
 				}

core/commands/object/diff.go

@@ -7,6 +7,7 @@ import (
 
 	cmds "github.com/ipfs/go-ipfs/commands"
 	core "github.com/ipfs/go-ipfs/core"
+	dag "github.com/ipfs/go-ipfs/merkledag"
 	dagutils "github.com/ipfs/go-ipfs/merkledag/utils"
 	path "github.com/ipfs/go-ipfs/path"
 )
@@ -85,7 +86,19 @@ Example:
 			return
 		}
 
-		changes, err := dagutils.Diff(ctx, node.DAG, obj_a, obj_b)
+		pbobj_a, ok := obj_a.(*dag.ProtoNode)
+		if !ok {
+			res.SetError(dag.ErrNotProtobuf, cmds.ErrNormal)
+			return
+		}
+
+		pbobj_b, ok := obj_b.(*dag.ProtoNode)
+		if !ok {
+			res.SetError(dag.ErrNotProtobuf, cmds.ErrNormal)
+			return
+		}
+
+		changes, err := dagutils.Diff(ctx, node.DAG, pbobj_a, pbobj_b)
 		if err != nil {
 			res.SetError(err, cmds.ErrNormal)
 			return

core/commands/object/object.go

@@ -12,13 +12,14 @@ import (
 	"strings"
 	"text/tabwriter"
 
-	mh "gx/ipfs/QmYDds3421prZgqKbLpEK7T9Aa2eVdQ7o3YarX1LVLdP2J/go-multihash"
-
 	cmds "github.com/ipfs/go-ipfs/commands"
 	core "github.com/ipfs/go-ipfs/core"
 	dag "github.com/ipfs/go-ipfs/merkledag"
 	path "github.com/ipfs/go-ipfs/path"
 	ft "github.com/ipfs/go-ipfs/unixfs"
+
+	cid "gx/ipfs/QmXUuRadqDq5BuFWzVU6VuKaSjTcNm1gNCtLvvP1TJCW4z/go-cid"
+	node "gx/ipfs/QmZx42H5khbVQhV5odp66TApShV4XCujYazcvYduZ4TroB/go-ipld-node"
 )
 
 // ErrObjectTooLarge is returned when too much data was read from stdin. current limit 2m
@@ -98,7 +99,14 @@ is the raw data of the object.
 			res.SetError(err, cmds.ErrNormal)
 			return
 		}
-		res.SetOutput(bytes.NewReader(node.Data()))
+
+		pbnode, ok := node.(*dag.ProtoNode)
+		if !ok {
+			res.SetError(dag.ErrNotProtobuf, cmds.ErrNormal)
+			return
+		}
+
+		res.SetOutput(bytes.NewReader(pbnode.Data()))
 	},
 }
 
@@ -137,6 +145,7 @@ multihash.
 			res.SetError(err, cmds.ErrNormal)
 			return
 		}
+
 		output, err := getOutput(node)
 		if err != nil {
 			res.SetError(err, cmds.ErrNormal)
@@ -201,14 +210,20 @@ This command outputs data in the following encodings:
 			return
 		}
 
+		pbo, ok := object.(*dag.ProtoNode)
+		if !ok {
+			res.SetError(dag.ErrNotProtobuf, cmds.ErrNormal)
+			return
+		}
+
 		node := &Node{
-			Links: make([]Link, len(object.Links)),
-			Data:  string(object.Data()),
+			Links: make([]Link, len(object.Links())),
+			Data:  string(pbo.Data()),
 		}
 
-		for i, link := range object.Links {
+		for i, link := range object.Links() {
 			node.Links[i] = Link{
-				Hash: link.Hash.B58String(),
+				Hash: link.Cid.String(),
 				Name: link.Name,
 				Size: link.Size,
 			}
@@ -276,10 +291,10 @@ var ObjectStatCmd = &cmds.Command{
 
 		res.SetOutput(ns)
 	},
-	Type: dag.NodeStat{},
+	Type: node.NodeStat{},
 	Marshalers: cmds.MarshalerMap{
 		cmds.Text: func(res cmds.Response) (io.Reader, error) {
-			ns := res.Output().(*dag.NodeStat)
+			ns := res.Output().(*node.NodeStat)
 
 			buf := new(bytes.Buffer)
 			w := func(s string, n int) {
@@ -413,7 +428,7 @@ Available templates:
 			return
 		}
 
-		node := new(dag.Node)
+		node := new(dag.ProtoNode)
 		if len(req.Arguments()) == 1 {
 			template := req.Arguments()[0]
 			var err error
@@ -440,7 +455,7 @@ Available templates:
 	Type: Object{},
 }
 
-func nodeFromTemplate(template string) (*dag.Node, error) {
+func nodeFromTemplate(template string) (*dag.ProtoNode, error) {
 	switch template {
 	case "unixfs-dir":
 		return ft.EmptyDirNode(), nil
@@ -464,7 +479,7 @@ func objectPut(n *core.IpfsNode, input io.Reader, encoding string, dataFieldEnco
 		return nil, ErrObjectTooLarge
 	}
 
-	var dagnode *dag.Node
+	var dagnode *dag.ProtoNode
 	switch getObjectEnc(encoding) {
 	case objectEncodingJSON:
 		node := new(Node)
@@ -542,47 +557,47 @@ func getObjectEnc(o interface{}) objectEncoding {
 	return objectEncoding(v)
 }
 
-func getOutput(dagnode *dag.Node) (*Object, error) {
+func getOutput(dagnode node.Node) (*Object, error) {
 	c := dagnode.Cid()
 	output := &Object{
 		Hash:  c.String(),
-		Links: make([]Link, len(dagnode.Links)),
+		Links: make([]Link, len(dagnode.Links())),
 	}
 
-	for i, link := range dagnode.Links {
+	for i, link := range dagnode.Links() {
 		output.Links[i] = Link{
 			Name: link.Name,
-			Hash: link.Hash.B58String(),
+			Hash: link.Cid.String(),
 			Size: link.Size,
 		}
 	}
 
 	return output, nil
 }
 
-// converts the Node object into a real dag.Node
-func deserializeNode(node *Node, dataFieldEncoding string) (*dag.Node, error) {
-	dagnode := new(dag.Node)
+// converts the Node object into a real dag.ProtoNode
+func deserializeNode(nd *Node, dataFieldEncoding string) (*dag.ProtoNode, error) {
+	dagnode := new(dag.ProtoNode)
 	switch dataFieldEncoding {
 	case "text":
-		dagnode.SetData([]byte(node.Data))
+		dagnode.SetData([]byte(nd.Data))
 	case "base64":
-		data, _ := base64.StdEncoding.DecodeString(node.Data)
+		data, _ := base64.StdEncoding.DecodeString(nd.Data)
 		dagnode.SetData(data)
 	default:
 		return nil, fmt.Errorf("Unkown data field encoding")
 	}
 
-	dagnode.Links = make([]*dag.Link, len(node.Links))
-	for i, link := range node.Links {
-		hash, err := mh.FromB58String(link.Hash)
+	dagnode.SetLinks(make([]*node.Link, len(nd.Links)))
+	for i, link := range nd.Links {
+		c, err := cid.Decode(link.Hash)
 		if err != nil {
 			return nil, err
 		}
-		dagnode.Links[i] = &dag.Link{
+		dagnode.Links()[i] = &node.Link{
 			Name: link.Name,
 			Size: link.Size,
-			Hash: hash,
+			Cid:  c,
 		}
 	}