chore!: deprecate ErrNotFound and alias to github.com/ipld/go-ipld-prime/storage.ErrNotFound

Author: rvagg

batch_test.go

@@ -26,7 +26,7 @@ func (d *testDag) Get(ctx context.Context, cid cid.Cid) (Node, error) {
 	if n, ok := d.nodes[cid.KeyString()]; ok {
 		return n, nil
 	}
-	return nil, ErrNotFound{cid}
+	return nil, ErrNotFound{Key: cid.KeyString()}
 }
 
 func (d *testDag) GetMany(ctx context.Context, cids []cid.Cid) <-chan *NodeOption {
@@ -37,7 +37,7 @@ func (d *testDag) GetMany(ctx context.Context, cids []cid.Cid) <-chan *NodeOptio
 		if n, ok := d.nodes[c.KeyString()]; ok {
 			out <- &NodeOption{Node: n}
 		} else {
-			out <- &NodeOption{Err: ErrNotFound{c}}
+			out <- &NodeOption{Err: ErrNotFound{Key: c.KeyString()}}
 		}
 	}
 	close(out)

coding_test.go

@@ -21,7 +21,7 @@ func TestDecode(t *testing.T) {
 	id, err := cid.Prefix{
 		Version:  1,
 		Codec:    cid.Raw,
-		MhType:   mh.ID,
+		MhType:   mh.IDENTITY,
 		MhLength: 0,
 	}.Sum(nil)
 

format_test.go

@@ -32,7 +32,7 @@ func (n *EmptyNode) Cid() cid.Cid {
 	id, err := cid.Prefix{
 		Version:  1,
 		Codec:    cid.Raw,
-		MhType:   mh.ID,
+		MhType:   mh.IDENTITY,
 		MhLength: 0,
 	}.Sum(nil)
 

go.mod

@@ -15,8 +15,8 @@ require (
 	github.com/mr-tron/base58 v1.1.0 // indirect
 	github.com/multiformats/go-base32 v0.0.3 // indirect
 	github.com/multiformats/go-multibase v0.0.1 // indirect
-	golang.org/x/crypto v0.1.0 // indirect
-	golang.org/x/sys v0.1.0 // indirect
+	golang.org/x/crypto v0.0.0-20190211182817-74369b46fc67 // indirect
+	golang.org/x/sys v0.0.0-20190219092855-153ac476189d // indirect
 )
 
 go 1.19

go.sum

@@ -21,9 +21,7 @@ github.com/multiformats/go-multibase v0.0.1 h1:PN9/v21eLywrFWdFNsFKaU04kLJzuYzmr
 github.com/multiformats/go-multibase v0.0.1/go.mod h1:bja2MqRZ3ggyXtZSEDKpl0uO/gviWFaSteVbWT51qgs=
 github.com/multiformats/go-multihash v0.0.1 h1:HHwN1K12I+XllBCrqKnhX949Orn4oawPkegHMu2vDqQ=
 github.com/multiformats/go-multihash v0.0.1/go.mod h1:w/5tugSrLEbWqlcgJabL3oHFKTwfvkofsjW2Qa1ct4U=
+golang.org/x/crypto v0.0.0-20190211182817-74369b46fc67 h1:ng3VDlRp5/DHpSWl02R4rM9I+8M2rhmsuLwAMmkLQWE=
 golang.org/x/crypto v0.0.0-20190211182817-74369b46fc67/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4=
-golang.org/x/crypto v0.1.0 h1:MDRAIl0xIo9Io2xV565hzXHw3zVseKrJKodhohM5CjU=
-golang.org/x/crypto v0.1.0/go.mod h1:RecgLatLF4+eUMCP1PoPZQb+cVrJcOPbHkTkbkB9sbw=
+golang.org/x/sys v0.0.0-20190219092855-153ac476189d h1:Z0Ahzd7HltpJtjAHHxX8QFP3j1yYgiuvjbjRzDj/KH0=
 golang.org/x/sys v0.0.0-20190219092855-153ac476189d/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
-golang.org/x/sys v0.1.0 h1:kunALQeHf1/185U1i0GOB/fy1IPRDDpuoOOqRReG57U=
-golang.org/x/sys v0.1.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=

merkledag.go

@@ -4,53 +4,31 @@ import (
 	"context"
 
 	cid "github.com/ipfs/go-cid"
+	"github.com/ipld/go-ipld-prime/storage"
 )
 
 // ErrNotFound is used to signal when a Node could not be found. The specific
 // meaning will depend on the DAGService implementation, which may be trying
 // to read nodes locally but also, trying to find them remotely.
 //
-// The Cid field can be filled in to provide additional context.
-type ErrNotFound struct {
-	Cid cid.Cid
-}
-
-// Error implements the error interface and returns a human-readable
-// message for this error.
-func (e ErrNotFound) Error() string {
-	if e.Cid == cid.Undef {
-		return "ipld: could not find node"
-	}
-
-	return "ipld: could not find " + e.Cid.String()
-}
-
-// Is allows to check whether any error is of this ErrNotFound type.
-// Do not use this directly, but rather errors.Is(yourError, ErrNotFound).
-// For maximum compatibility you should prefer IsNotFound() instead as it will
-// also match other compatible NotFound error types.
-func (e ErrNotFound) Is(err error) bool {
-	switch err.(type) {
-	case ErrNotFound:
-		return true
-	default:
-		return false
-	}
-}
-
-// NotFound returns true.
-func (e ErrNotFound) NotFound() bool {
-	return true
-}
+// Deprecated: use github.com/ipld/go-ipld-prime/storage#ErrNotFound instead.
+type ErrNotFound = storage.ErrNotFound
 
 // IsNotFound returns true if the error is a ErrNotFound. As it uses a
 // feature-test, it is also compatible with other NotFound error types,
 // including github.com/ipld/go-ipld-prime/storage#ErrNotFound.
+//
+// errors.Is() should be preferred as the standard Go way to test for errors;
+// however due to the move of the legacy ErrNotFound to
+// github.com/ipld/go-ipld-prime/storage, it may not report correctly where
+// older block storage packages emit the legacy ErrNotFound. The IsNotFound()
+// function provides a maximally compatible matching function that should be
+// able to determine whether an ErrNotFound, either new or legacy, exists within
+// a wrapped error chain.
+//
+// Deprecated: use github.com/ipld/go-ipld-prime/storage#IsNotFound instead.
 func IsNotFound(err error) bool {
-	if nf, ok := err.(interface{ NotFound() bool }); ok {
-		return nf.NotFound()
-	}
-	return false
+	return storage.IsNotFound(err)
 }
 
 // Either a node or an error.