refactor!: remove ResolvedPath and use ImmutablePath instead

coreiface/block.go

@@ -14,7 +14,7 @@ type BlockStat interface {
 	Size() int
 
 	// Path returns path to the block
-	Path() path.ResolvedPath
+	Path() path.ImmutablePath
 }
 
 // BlockAPI specifies the interface to the block layer

coreiface/coreapi.go

@@ -47,7 +47,7 @@ type CoreAPI interface {
 	Routing() RoutingAPI
 
 	// ResolvePath resolves the path using Unixfs resolver
-	ResolvePath(context.Context, path.Path) (path.ResolvedPath, error)
+	ResolvePath(context.Context, path.Path) (path.ImmutablePath, error)
 
 	// ResolveNode resolves the path (if not resolved already) using Unixfs
 	// resolver, gets and returns the resolved Node

coreiface/object.go

@@ -59,11 +59,11 @@ type ObjectChange struct {
 
 	// Before holds the link path before the change. Note that when a link is
 	// added, this will be nil.
-	Before path.ResolvedPath
+	Before path.ImmutablePath
 
 	// After holds the link path after the change. Note that when a link is
 	// removed, this will be nil.
-	After path.ResolvedPath
+	After path.ImmutablePath
 }
 
 // ObjectAPI specifies the interface to MerkleDAG and contains useful utilities
@@ -73,7 +73,7 @@ type ObjectAPI interface {
 	New(context.Context, ...options.ObjectNewOption) (ipld.Node, error)
 
 	// Put imports the data into merkledag
-	Put(context.Context, io.Reader, ...options.ObjectPutOption) (path.ResolvedPath, error)
+	Put(context.Context, io.Reader, ...options.ObjectPutOption) (path.ImmutablePath, error)
 
 	// Get returns the node for the path
 	Get(context.Context, path.Path) (ipld.Node, error)
@@ -90,16 +90,16 @@ type ObjectAPI interface {
 	// AddLink adds a link under the specified path. child path can point to a
 	// subdirectory within the patent which must be present (can be overridden
 	// with WithCreate option).
-	AddLink(ctx context.Context, base path.Path, name string, child path.Path, opts ...options.ObjectAddLinkOption) (path.ResolvedPath, error)
+	AddLink(ctx context.Context, base path.Path, name string, child path.Path, opts ...options.ObjectAddLinkOption) (path.ImmutablePath, error)
 
 	// RmLink removes a link from the node
-	RmLink(ctx context.Context, base path.Path, link string) (path.ResolvedPath, error)
+	RmLink(ctx context.Context, base path.Path, link string) (path.ImmutablePath, error)
 
 	// AppendData appends data to the node
-	AppendData(context.Context, path.Path, io.Reader) (path.ResolvedPath, error)
+	AppendData(context.Context, path.Path, io.Reader) (path.ImmutablePath, error)
 
 	// SetData sets the data contained in the node
-	SetData(context.Context, path.Path, io.Reader) (path.ResolvedPath, error)
+	SetData(context.Context, path.Path, io.Reader) (path.ImmutablePath, error)
 
 	// Diff returns a set of changes needed to transform the first object into the
 	// second.

coreiface/pin.go

@@ -11,7 +11,7 @@ import (
 // Pin holds information about pinned resource
 type Pin interface {
 	// Path to the pinned object
-	Path() path.ResolvedPath
+	Path() path.ImmutablePath
 
 	// Type of the pin
 	Type() string
@@ -35,7 +35,7 @@ type PinStatus interface {
 // BadPinNode is a node that has been marked as bad by Pin.Verify
 type BadPinNode interface {
 	// Path is the path of the node
-	Path() path.ResolvedPath
+	Path() path.ImmutablePath
 
 	// Err is the reason why the node has been marked as bad
 	Err() error

coreiface/tests/unixfs.go

@@ -105,7 +105,7 @@ func (tp *TestSuite) TestAdd(t *testing.T) {
 		t.Fatal(err)
 	}
 
-	p := func(h string) path.ResolvedPath {
+	p := func(h string) path.ImmutablePath {
 		c, err := cid.Parse(h)
 		if err != nil {
 			t.Fatal(err)

coreiface/unixfs.go

@@ -11,9 +11,9 @@ import (
 
 type AddEvent struct {
 	Name  string
-	Path  path.ResolvedPath `json:",omitempty"`
-	Bytes int64             `json:",omitempty"`
-	Size  string            `json:",omitempty"`
+	Path  path.ImmutablePath `json:",omitempty"`
+	Bytes int64              `json:",omitempty"`
+	Size  string             `json:",omitempty"`
 }
 
 // FileType is an enum of possible UnixFS file types.
@@ -65,7 +65,7 @@ type UnixfsAPI interface {
 	// Add imports the data from the reader into merkledag file
 	//
 	// TODO: a long useful comment on how to use this for many different scenarios
-	Add(context.Context, files.Node, ...options.UnixfsAddOption) (path.ResolvedPath, error)
+	Add(context.Context, files.Node, ...options.UnixfsAddOption) (path.ImmutablePath, error)
 
 	// Get returns a read-only handle to a file tree referenced by a path
 	//

gateway/blocks_backend.go

@@ -7,7 +7,6 @@ import (
 	"fmt"
 	"io"
 	"net/http"
-	gopath "path"
 	"strings"
 
 	"github.com/ipfs/boxo/blockservice"
@@ -507,7 +506,7 @@ func (bb *BlocksBackend) getNode(ctx context.Context, path path.ImmutablePath) (
 	return md, nd, err
 }
 
-func (bb *BlocksBackend) getPathRoots(ctx context.Context, contentPath path.ImmutablePath) ([]cid.Cid, path.ResolvedPath, error) {
+func (bb *BlocksBackend) getPathRoots(ctx context.Context, contentPath path.ImmutablePath) ([]cid.Cid, path.ImmutablePath, error) {
 	/*
 		These are logical roots where each CID represent one path segment
 		and resolves to either a directory or the root block of a file.
@@ -531,7 +530,7 @@ func (bb *BlocksBackend) getPathRoots(ctx context.Context, contentPath path.Immu
 	contentPathStr := contentPath.String()
 	pathSegments := strings.Split(contentPathStr[6:], "/")
 	sp.WriteString(contentPathStr[:5]) // /ipfs or /ipns
-	var lastPath path.ResolvedPath
+	var lastPath path.ImmutablePath
 	for _, root := range pathSegments {
 		if root == "" {
 			continue
@@ -564,13 +563,13 @@ func (bb *BlocksBackend) ResolveMutable(ctx context.Context, p path.Path) (path.
 	case path.IPNSNamespace:
 		p, err := resolve.ResolveIPNS(ctx, bb.namesys, p)
 		if err != nil {
-			return path.ImmutablePath{}, err
+			return nil, err
 		}
 		return path.NewImmutablePath(p)
 	case path.IPFSNamespace:
 		return path.NewImmutablePath(p)
 	default:
-		return path.ImmutablePath{}, NewErrorStatusCode(fmt.Errorf("unsupported path namespace: %s", p.Namespace()), http.StatusNotImplemented)
+		return nil, NewErrorStatusCode(fmt.Errorf("unsupported path namespace: %s", p.Namespace()), http.StatusNotImplemented)
 	}
 }
 
@@ -628,11 +627,7 @@ func (bb *BlocksBackend) ResolvePath(ctx context.Context, path path.ImmutablePat
 	return md, nil
 }
 
-func (bb *BlocksBackend) resolvePath(ctx context.Context, p path.Path) (path.ResolvedPath, error) {
-	if _, ok := p.(path.ResolvedPath); ok {
-		return p.(path.ResolvedPath), nil
-	}
-
+func (bb *BlocksBackend) resolvePath(ctx context.Context, p path.Path) (path.ImmutablePath, error) {
 	var err error
 	if p.Namespace() == path.IPNSNamespace {
 		p, err = resolve.ResolveIPNS(ctx, bb.namesys, p)
@@ -650,7 +645,12 @@ func (bb *BlocksBackend) resolvePath(ctx context.Context, p path.Path) (path.Res
 		return nil, err
 	}
 
-	return path.NewResolvedPath(p, node, gopath.Join(rest...)), nil
+	p, err = path.Join(path.NewIPFSPath(node), rest...)
+	if err != nil {
+		return nil, err
+	}
+
+	return path.NewImmutablePath(p)
 }
 
 type nodeGetterToCarExporer struct {

gateway/gateway.go

@@ -205,7 +205,7 @@ func (d DuplicateBlocksPolicy) String() string {
 
 type ContentPathMetadata struct {
 	PathSegmentRoots []cid.Cid
-	LastSegment      path.ResolvedPath
+	LastSegment      path.ImmutablePath
 	ContentType      string // Only used for UnixFS requests
 }
 

gateway/gateway_test.go

@@ -736,7 +736,7 @@ func (mb *errorMockBackend) GetCAR(ctx context.Context, path path.ImmutablePath,
 }
 
 func (mb *errorMockBackend) ResolveMutable(ctx context.Context, p path.Path) (path.ImmutablePath, error) {
-	return path.ImmutablePath{}, mb.err
+	return nil, mb.err
 }
 
 func (mb *errorMockBackend) GetIPNSRecord(ctx context.Context, c cid.Cid) ([]byte, error) {

gateway/handler.go

@@ -773,7 +773,7 @@ func (i *handler) handleWebRequestErrors(w http.ResponseWriter, r *http.Request,
 	if errors.Is(err, ErrServiceUnavailable) {
 		err = fmt.Errorf("failed to resolve %s: %w", debugStr(contentPath.String()), err)
 		i.webError(w, r, err, http.StatusServiceUnavailable)
-		return path.ImmutablePath{}, false
+		return nil, false
 	}
 
 	// If we have origin isolation (subdomain gw, DNSLink website),
@@ -795,12 +795,12 @@ func (i *handler) handleWebRequestErrors(w http.ResponseWriter, r *http.Request,
 	// follow https://docs.ipfs.tech/how-to/websites-on-ipfs/redirects-and-custom-404s/ instead.
 	if i.serveLegacy404IfPresent(w, r, immutableContentPath, logger) {
 		logger.Debugw("served legacy 404")
-		return path.ImmutablePath{}, false
+		return nil, false
 	}
 
 	err = fmt.Errorf("failed to resolve %s: %w", debugStr(contentPath.String()), err)
 	i.webError(w, r, err, http.StatusInternalServerError)
-	return path.ImmutablePath{}, false
+	return nil, false
 }
 
 // Detect 'Cache-Control: only-if-cached' in request and return data if it is already in the local datastore.

gateway/handler_codec.go

@@ -149,7 +149,7 @@ func (i *handler) renderCodec(ctx context.Context, w http.ResponseWriter, r *htt
 	return i.serveCodecConverted(ctx, w, r, blockCid, blockData, rq.contentPath, toCodec, modtime, rq.begin)
 }
 
-func (i *handler) serveCodecHTML(ctx context.Context, w http.ResponseWriter, r *http.Request, blockCid cid.Cid, blockData io.ReadSeekCloser, resolvedPath path.ResolvedPath, contentPath path.Path) bool {
+func (i *handler) serveCodecHTML(ctx context.Context, w http.ResponseWriter, r *http.Request, blockCid cid.Cid, blockData io.ReadSeekCloser, resolvedPath path.ImmutablePath, contentPath path.Path) bool {
 	// WithHostname may have constructed an IPFS (or IPNS) path using the Host header.
 	// In this case, we need the original path for constructing the redirect.
 	requestURI, err := url.ParseRequestURI(r.RequestURI)
@@ -288,7 +288,7 @@ func (i *handler) serveCodecConverted(ctx context.Context, w http.ResponseWriter
 	return false
 }
 
-func setCodecContentDisposition(w http.ResponseWriter, r *http.Request, resolvedPath path.ResolvedPath, contentType string) string {
+func setCodecContentDisposition(w http.ResponseWriter, r *http.Request, resolvedPath path.ImmutablePath, contentType string) string {
 	var dispType, name string
 
 	ext, ok := contentTypeToExtension[contentType]

gateway/handler_unixfs__redirects.go

@@ -45,40 +45,40 @@ func (i *handler) serveRedirectsIfPresent(w http.ResponseWriter, r *http.Request
 	if err != nil {
 		err = fmt.Errorf("trouble processing _redirects path %q: %w", immutableContentPath.String(), err)
 		i.webError(w, r, err, http.StatusInternalServerError)
-		return path.ImmutablePath{}, false, true
+		return nil, false, true
 	}
 
 	redirectsPath, err := path.Join(rootPath, "_redirects")
 	if err != nil {
 		err = fmt.Errorf("trouble processing _redirects path %q: %w", rootPath.String(), err)
 		i.webError(w, r, err, http.StatusInternalServerError)
-		return path.ImmutablePath{}, false, true
+		return nil, false, true
 	}
 
 	imRedirectsPath, err := path.NewImmutablePath(redirectsPath)
 	if err != nil {
 		err = fmt.Errorf("trouble processing _redirects path %q: %w", redirectsPath, err)
 		i.webError(w, r, err, http.StatusInternalServerError)
-		return path.ImmutablePath{}, false, true
+		return nil, false, true
 	}
 
 	foundRedirect, redirectRules, err := i.getRedirectRules(r, imRedirectsPath)
 	if err != nil {
 		err = fmt.Errorf("trouble processing _redirects file at %q: %w", redirectsPath, err)
 		i.webError(w, r, err, http.StatusInternalServerError)
-		return path.ImmutablePath{}, false, true
+		return nil, false, true
 	}
 
 	if foundRedirect {
 		redirected, newPath, err := i.handleRedirectsFileRules(w, r, immutableContentPath, contentPath, redirectRules, logger)
 		if err != nil {
 			err = fmt.Errorf("trouble processing _redirects file at %q: %w", redirectsPath, err)
 			i.webError(w, r, err, http.StatusInternalServerError)
-			return path.ImmutablePath{}, false, true
+			return nil, false, true
 		}
 
 		if redirected {
-			return path.ImmutablePath{}, false, true
+			return nil, false, true
 		}
 
 		// 200 is treated as a rewrite, so update the path and continue
@@ -88,13 +88,13 @@ func (i *handler) serveRedirectsIfPresent(w http.ResponseWriter, r *http.Request
 			if err != nil {
 				err = fmt.Errorf("could not use _redirects file to %q: %w", p, err)
 				i.webError(w, r, err, http.StatusInternalServerError)
-				return path.ImmutablePath{}, false, true
+				return nil, false, true
 			}
 			imPath, err := path.NewImmutablePath(p)
 			if err != nil {
 				err = fmt.Errorf("could not use _redirects file to %q: %w", p, err)
 				i.webError(w, r, err, http.StatusInternalServerError)
-				return path.ImmutablePath{}, false, true
+				return nil, false, true
 			}
 			return imPath, true, true
 		}

gateway/handler_unixfs_dir.go

@@ -22,7 +22,7 @@ import (
 // serveDirectory returns the best representation of UnixFS directory
 //
 // It will return index.html if present, or generate directory listing otherwise.
-func (i *handler) serveDirectory(ctx context.Context, w http.ResponseWriter, r *http.Request, resolvedPath path.ResolvedPath, contentPath path.Path, isHeadRequest bool, directoryMetadata *directoryMetadata, ranges []ByteRange, begin time.Time, logger *zap.SugaredLogger) bool {
+func (i *handler) serveDirectory(ctx context.Context, w http.ResponseWriter, r *http.Request, resolvedPath path.ImmutablePath, contentPath path.Path, isHeadRequest bool, directoryMetadata *directoryMetadata, ranges []ByteRange, begin time.Time, logger *zap.SugaredLogger) bool {
 	ctx, span := spanTrace(ctx, "Handler.ServeDirectory", trace.WithAttributes(attribute.String("path", resolvedPath.String())))
 	defer span.End()
 

gateway/handler_unixfs_file.go

@@ -19,7 +19,7 @@ import (
 
 // serveFile returns data behind a file along with HTTP headers based on
 // the file itself, its CID and the contentPath used for accessing it.
-func (i *handler) serveFile(ctx context.Context, w http.ResponseWriter, r *http.Request, resolvedPath path.ResolvedPath, contentPath path.Path, file files.File, fileContentType string, begin time.Time) bool {
+func (i *handler) serveFile(ctx context.Context, w http.ResponseWriter, r *http.Request, resolvedPath path.ImmutablePath, contentPath path.Path, file files.File, fileContentType string, begin time.Time) bool {
 	_, span := spanTrace(ctx, "Handler.ServeFile", trace.WithAttributes(attribute.String("path", resolvedPath.String())))
 	defer span.End()
 

gateway/utilities_test.go

@@ -180,7 +180,7 @@ func (mb *mockBackend) ResolvePath(ctx context.Context, immutablePath path.Immut
 	return mb.gw.ResolvePath(ctx, immutablePath)
 }
 
-func (mb *mockBackend) resolvePathNoRootsReturned(ctx context.Context, ip path.Path) (path.ResolvedPath, error) {
+func (mb *mockBackend) resolvePathNoRootsReturned(ctx context.Context, ip path.Path) (path.ImmutablePath, error) {
 	var imPath path.ImmutablePath
 	var err error
 	if ip.Namespace().Mutable() {