Skip to content

Commit

Permalink
refactor: return remainder from ResolvePath
Browse files Browse the repository at this point in the history
  • Loading branch information
hacdias committed Sep 27, 2023
1 parent de5ff6b commit f78a7ee
Show file tree
Hide file tree
Showing 17 changed files with 75 additions and 55 deletions.
2 changes: 1 addition & 1 deletion client/rpc/apifile.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ const forwardSeekLimit = 1 << 14 // 16k
func (api *UnixfsAPI) Get(ctx context.Context, p path.Path) (files.Node, error) {
if p.Namespace().Mutable() { // use resolved path in case we are dealing with IPNS / MFS
var err error
p, err = api.core().ResolvePath(ctx, p)
p, _, err = api.core().ResolvePath(ctx, p)
if err != nil {
return nil, err
}
Expand Down
4 changes: 2 additions & 2 deletions client/rpc/dht.go
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ func (api *DhtAPI) FindProviders(ctx context.Context, p path.Path, opts ...caopt
return nil, err
}

rp, err := api.core().ResolvePath(ctx, p)
rp, _, err := api.core().ResolvePath(ctx, p)
if err != nil {
return nil, err
}
Expand Down Expand Up @@ -98,7 +98,7 @@ func (api *DhtAPI) Provide(ctx context.Context, p path.Path, opts ...caopts.DhtP
return err
}

rp, err := api.core().ResolvePath(ctx, p)
rp, _, err := api.core().ResolvePath(ctx, p)
if err != nil {
return err
}
Expand Down
19 changes: 11 additions & 8 deletions client/rpc/path.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,35 +8,38 @@ import (
ipld "github.com/ipfs/go-ipld-format"
)

func (api *HttpApi) ResolvePath(ctx context.Context, p path.Path) (path.ImmutablePath, error) {
func (api *HttpApi) ResolvePath(ctx context.Context, p path.Path) (path.ImmutablePath, []string, error) {
var out struct {
Cid cid.Cid
RemPath string
}

// TODO: this is hacky, fixing https://github.com/ipfs/go-ipfs/issues/5703 would help

var err error
if p.Namespace() == path.IPNSNamespace {
if p, err = api.Name().Resolve(ctx, p.String()); err != nil {
return nil, err
return nil, nil, err
}
}

if err := api.Request("dag/resolve", p.String()).Exec(ctx, &out); err != nil {
return nil, err
return nil, nil, err
}

p, err = path.NewPathFromSegments(p.Namespace().String(), out.Cid.String(), out.RemPath)
if err != nil {
return nil, err
return nil, nil, err
}

imPath, err := path.NewImmutablePath(p)
if err != nil {
return nil, nil, err
}

return path.NewImmutablePath(p)
return imPath, path.StringToSegments(out.RemPath), nil
}

func (api *HttpApi) ResolveNode(ctx context.Context, p path.Path) (ipld.Node, error) {
rp, err := api.ResolvePath(ctx, p)
rp, _, err := api.ResolvePath(ctx, p)
if err != nil {
return nil, err
}
Expand Down
2 changes: 1 addition & 1 deletion core/commands/block.go
Original file line number Diff line number Diff line change
Expand Up @@ -270,7 +270,7 @@ It takes a list of CIDs to remove from the local datastore..
return err
}

rp, err := api.ResolvePath(req.Context, p)
rp, _, err := api.ResolvePath(req.Context, p)
if err != nil {
return err
}
Expand Down
7 changes: 4 additions & 3 deletions core/commands/dag/get.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import (
"fmt"
"io"

"github.com/ipfs/boxo/path"
ipldlegacy "github.com/ipfs/go-ipld-legacy"
"github.com/ipfs/kubo/core/commands/cmdenv"
"github.com/ipfs/kubo/core/commands/cmdutils"
Expand Down Expand Up @@ -33,7 +34,7 @@ func dagGet(req *cmds.Request, res cmds.ResponseEmitter, env cmds.Environment) e
return err
}

rp, err := api.ResolvePath(req.Context, p)
rp, remainder, err := api.ResolvePath(req.Context, p)
if err != nil {
return err
}
Expand All @@ -50,8 +51,8 @@ func dagGet(req *cmds.Request, res cmds.ResponseEmitter, env cmds.Environment) e

finalNode := universal.(ipld.Node)

if len(rp.Remainder()) > 0 {
remainderPath := ipld.ParsePath(rp.Remainder())
if len(remainder) > 0 {
remainderPath := ipld.ParsePath(path.SegmentsToString(remainder...))

finalNode, err = traversal.Get(finalNode, remainderPath)
if err != nil {
Expand Down
5 changes: 3 additions & 2 deletions core/commands/dag/resolve.go
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package dagcmd

import (
"github.com/ipfs/boxo/path"
"github.com/ipfs/kubo/core/commands/cmdenv"
"github.com/ipfs/kubo/core/commands/cmdutils"

Expand All @@ -18,13 +19,13 @@ func dagResolve(req *cmds.Request, res cmds.ResponseEmitter, env cmds.Environmen
return err
}

rp, err := api.ResolvePath(req.Context, p)
rp, remainder, err := api.ResolvePath(req.Context, p)
if err != nil {
return err
}

return cmds.EmitOnce(res, &ResolveOutput{
Cid: rp.Cid(),
RemPath: rp.Remainder(),
RemPath: path.SegmentsToString(remainder...),
})
}
4 changes: 2 additions & 2 deletions core/commands/dag/stat.go
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,11 @@ func dagStat(req *cmds.Request, res cmds.ResponseEmitter, env cmds.Environment)
if err != nil {
return err
}
rp, err := api.ResolvePath(req.Context, p)
rp, remainder, err := api.ResolvePath(req.Context, p)
if err != nil {
return err
}
if len(rp.Remainder()) > 0 {
if len(remainder) > 0 {
return fmt.Errorf("cannot return size for anything other than a DAG with a root CID")
}

Expand Down
2 changes: 1 addition & 1 deletion core/commands/object/object.go
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ multihash. Provided for legacy reasons. Use 'ipfs dag get' instead.
return err
}

rp, err := api.ResolvePath(req.Context, path)
rp, _, err := api.ResolvePath(req.Context, path)
if err != nil {
return err
}
Expand Down
10 changes: 5 additions & 5 deletions core/commands/pin/pin.go
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@ func pinAddMany(ctx context.Context, api coreiface.CoreAPI, enc cidenc.Encoder,
return nil, err
}

rp, err := api.ResolvePath(ctx, p)
rp, _, err := api.ResolvePath(ctx, p)
if err != nil {
return nil, err
}
Expand Down Expand Up @@ -252,7 +252,7 @@ ipfs pin ls -t indirect <cid>
return err
}

rp, err := api.ResolvePath(req.Context, p)
rp, _, err := api.ResolvePath(req.Context, p)
if err != nil {
return err
}
Expand Down Expand Up @@ -468,7 +468,7 @@ func pinLsKeys(req *cmds.Request, typeStr string, api coreiface.CoreAPI, emit fu
return err
}

rp, err := api.ResolvePath(req.Context, p)
rp, _, err := api.ResolvePath(req.Context, p)
if err != nil {
return err
}
Expand Down Expand Up @@ -594,11 +594,11 @@ pin.
}

// Resolve the paths ahead of time so we can return the actual CIDs
from, err := api.ResolvePath(req.Context, fromPath)
from, _, err := api.ResolvePath(req.Context, fromPath)
if err != nil {
return err
}
to, err := api.ResolvePath(req.Context, toPath)
to, _, err := api.ResolvePath(req.Context, toPath)
if err != nil {
return err
}
Expand Down
2 changes: 1 addition & 1 deletion core/commands/pin/remotepin.go
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ NOTE: a comma-separated notation is supported in CLI for convenience:
return err
}

rp, err := api.ResolvePath(ctx, p)
rp, _, err := api.ResolvePath(ctx, p)
if err != nil {
return err
}
Expand Down
2 changes: 1 addition & 1 deletion core/commands/refs.go
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ func objectsForPaths(ctx context.Context, n iface.CoreAPI, paths []string) ([]ci
if err != nil {
return nil, err
}
o, err := n.ResolvePath(ctx, p)
o, _, err := n.ResolvePath(ctx, p)
if err != nil {
return nil, err
}
Expand Down
6 changes: 3 additions & 3 deletions core/commands/resolve.go
Original file line number Diff line number Diff line change
Expand Up @@ -134,15 +134,15 @@ Resolve the value of an IPFS DAG path:
}

// else, ipfs path or ipns with recursive flag
rp, err := api.ResolvePath(req.Context, p)
rp, remainder, err := api.ResolvePath(req.Context, p)
if err != nil {
return err
}

// Trick to encode path with correct encoding.
encodedPath := "/" + rp.Namespace().String() + "/" + enc.Encode(rp.Cid())
if remainder := rp.Remainder(); remainder != "" {
encodedPath += "/" + remainder
if len(remainder) != 0 {
encodedPath += path.SegmentsToString(remainder...)
}

// Ensure valid and sanitized.
Expand Down
6 changes: 3 additions & 3 deletions core/coreapi/block.go
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ func (api *BlockAPI) Put(ctx context.Context, src io.Reader, opts ...caopts.Bloc
func (api *BlockAPI) Get(ctx context.Context, p path.Path) (io.Reader, error) {
ctx, span := tracing.Span(ctx, "CoreAPI.BlockAPI", "Get", trace.WithAttributes(attribute.String("path", p.String())))
defer span.End()
rp, err := api.core().ResolvePath(ctx, p)
rp, _, err := api.core().ResolvePath(ctx, p)
if err != nil {
return nil, err
}
Expand All @@ -91,7 +91,7 @@ func (api *BlockAPI) Rm(ctx context.Context, p path.Path, opts ...caopts.BlockRm
ctx, span := tracing.Span(ctx, "CoreAPI.BlockAPI", "Rm", trace.WithAttributes(attribute.String("path", p.String())))
defer span.End()

rp, err := api.core().ResolvePath(ctx, p)
rp, _, err := api.core().ResolvePath(ctx, p)
if err != nil {
return err
}
Expand Down Expand Up @@ -132,7 +132,7 @@ func (api *BlockAPI) Stat(ctx context.Context, p path.Path) (coreiface.BlockStat
ctx, span := tracing.Span(ctx, "CoreAPI.BlockAPI", "Stat", trace.WithAttributes(attribute.String("path", p.String())))
defer span.End()

rp, err := api.core().ResolvePath(ctx, p)
rp, _, err := api.core().ResolvePath(ctx, p)
if err != nil {
return nil, err
}
Expand Down
4 changes: 2 additions & 2 deletions core/coreapi/dht.go
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ func (api *DhtAPI) FindProviders(ctx context.Context, p path.Path, opts ...caopt
return nil, err
}

rp, err := api.core().ResolvePath(ctx, p)
rp, _, err := api.core().ResolvePath(ctx, p)
if err != nil {
return nil, err
}
Expand Down Expand Up @@ -82,7 +82,7 @@ func (api *DhtAPI) Provide(ctx context.Context, path path.Path, opts ...caopts.D
return err
}

rp, err := api.core().ResolvePath(ctx, path)
rp, _, err := api.core().ResolvePath(ctx, path)
if err != nil {
return err
}
Expand Down
39 changes: 24 additions & 15 deletions core/coreapi/path.go
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ func (api *CoreAPI) ResolveNode(ctx context.Context, p path.Path) (ipld.Node, er
ctx, span := tracing.Span(ctx, "CoreAPI", "ResolveNode", trace.WithAttributes(attribute.String("path", p.String())))
defer span.End()

rp, err := api.ResolvePath(ctx, p)
rp, _, err := api.ResolvePath(ctx, p)
if err != nil {
return nil, err
}
Expand All @@ -36,40 +36,49 @@ func (api *CoreAPI) ResolveNode(ctx context.Context, p path.Path) (ipld.Node, er

// ResolvePath resolves the path `p` using Unixfs resolver, returns the
// resolved path.
func (api *CoreAPI) ResolvePath(ctx context.Context, p path.Path) (path.ImmutablePath, error) {
func (api *CoreAPI) ResolvePath(ctx context.Context, p path.Path) (path.ImmutablePath, []string, error) {
ctx, span := tracing.Span(ctx, "CoreAPI", "ResolvePath", trace.WithAttributes(attribute.String("path", p.String())))
defer span.End()

p, err := resolve.ResolveIPNS(ctx, api.namesys, p)
if err == resolve.ErrNoNamesys {
return nil, coreiface.ErrOffline
return nil, nil, coreiface.ErrOffline
} else if err != nil {
return nil, err
}

if p.Namespace() != path.IPFSNamespace && p.Namespace() != path.IPLDNamespace {
return nil, fmt.Errorf("unsupported path namespace: %s", p.Namespace().String())
return nil, nil, err
}

var resolver ipfspathresolver.Resolver
if p.Namespace() == path.IPLDNamespace {
switch p.Namespace() {
case path.IPLDNamespace:
resolver = api.ipldPathResolver
} else {
case path.IPFSNamespace:
resolver = api.unixFSPathResolver
default:
return nil, nil, fmt.Errorf("unsupported path namespace: %s", p.Namespace().String())
}

node, rest, err := resolver.ResolveToLastNode(ctx, p)
imPath, err := path.NewImmutablePath(p)
if err != nil {
return nil, err
return nil, nil, err
}

node, remainder, err := resolver.ResolveToLastNode(ctx, imPath)
if err != nil {
return nil, nil, err
}

segments := []string{p.Namespace().String(), node.String()}
segments = append(segments, rest...)
segments = append(segments, remainder...)

p, err = path.NewPathFromSegments(segments...)
if err != nil {
return nil, err
return nil, nil, err
}

imPath, err = path.NewImmutablePath(p)
if err != nil {
return nil, nil, err
}

return path.NewImmutablePath(p)
return imPath, remainder, nil
}
8 changes: 4 additions & 4 deletions core/coreapi/pin.go
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ func (api *PinAPI) IsPinned(ctx context.Context, p path.Path, opts ...caopts.Pin
ctx, span := tracing.Span(ctx, "CoreAPI.PinAPI", "IsPinned", trace.WithAttributes(attribute.String("path", p.String())))
defer span.End()

resolved, err := api.core().ResolvePath(ctx, p)
resolved, _, err := api.core().ResolvePath(ctx, p)
if err != nil {
return "", false, fmt.Errorf("error resolving path: %s", err)
}
Expand All @@ -99,7 +99,7 @@ func (api *PinAPI) Rm(ctx context.Context, p path.Path, opts ...caopts.PinRmOpti
ctx, span := tracing.Span(ctx, "CoreAPI.PinAPI", "Rm", trace.WithAttributes(attribute.String("path", p.String())))
defer span.End()

rp, err := api.core().ResolvePath(ctx, p)
rp, _, err := api.core().ResolvePath(ctx, p)
if err != nil {
return err
}
Expand Down Expand Up @@ -136,12 +136,12 @@ func (api *PinAPI) Update(ctx context.Context, from path.Path, to path.Path, opt

span.SetAttributes(attribute.Bool("unpin", settings.Unpin))

fp, err := api.core().ResolvePath(ctx, from)
fp, _, err := api.core().ResolvePath(ctx, from)
if err != nil {
return err
}

tp, err := api.core().ResolvePath(ctx, to)
tp, _, err := api.core().ResolvePath(ctx, to)
if err != nil {
return err
}
Expand Down
Loading

0 comments on commit f78a7ee

Please sign in to comment.