refactor: namesys cleanup, gateway /ipns/ ttl

ipfs · Sep 5, 2023 · 183ee5b · 183ee5b
1 parent d9bca2c
commit 183ee5b
Show file tree

Hide file tree

Showing 16 changed files with 79 additions and 58 deletions.
diff --git a/client/rpc/name.go b/client/rpc/name.go
@@ -8,8 +8,8 @@ import (
 
  iface "github.com/ipfs/boxo/coreiface"
  caopts "github.com/ipfs/boxo/coreiface/options"
- nsopts "github.com/ipfs/boxo/coreiface/options/namesys"
  "github.com/ipfs/boxo/ipns"
+ "github.com/ipfs/boxo/namesys"
  "github.com/ipfs/boxo/path"
 )
 
@@ -49,9 +49,9 @@ func (api *NameAPI) Search(ctx context.Context, name string, opts ...caopts.Name
  return nil, err
  }
 
- ropts := nsopts.ProcessOpts(options.ResolveOpts)
- if ropts.Depth != nsopts.DefaultDepthLimit && ropts.Depth != 1 {
- return nil, fmt.Errorf("Name.Resolve: depth other than 1 or %d not supported", nsopts.DefaultDepthLimit)
+ ropts := namesys.ProcessResolveOptions(options.ResolveOpts)
+ if ropts.Depth != namesys.DefaultDepthLimit && ropts.Depth != 1 {
+ return nil, fmt.Errorf("Name.Resolve: depth other than 1 or %d not supported", namesys.DefaultDepthLimit)
  }
 
  req := api.core().Request("name/resolve", name).
@@ -110,9 +110,9 @@ func (api *NameAPI) Resolve(ctx context.Context, name string, opts ...caopts.Nam
  return nil, err
  }
 
- ropts := nsopts.ProcessOpts(options.ResolveOpts)
- if ropts.Depth != nsopts.DefaultDepthLimit && ropts.Depth != 1 {
- return nil, fmt.Errorf("Name.Resolve: depth other than 1 or %d not supported", nsopts.DefaultDepthLimit)
+ ropts := namesys.ProcessResolveOptions(options.ResolveOpts)
+ if ropts.Depth != namesys.DefaultDepthLimit && ropts.Depth != 1 {
+ return nil, fmt.Errorf("Name.Resolve: depth other than 1 or %d not supported", namesys.DefaultDepthLimit)
  }
 
  req := api.core().Request("name/resolve", name).

diff --git a/core/commands/dht_test.go b/core/commands/dht_test.go
@@ -11,7 +11,7 @@ import (
 
 func TestKeyTranslation(t *testing.T) {
  pid := test.RandPeerIDFatal(t)
- pkname := namesys.PkKeyForID(pid)
+ pkname := namesys.PkRoutingKey(pid)
  ipnsname := ipns.NameFromPeer(pid).RoutingKey()
 
  pkk, err := escapeDhtKey("/pk/" + pid.Pretty())

diff --git a/core/commands/dns.go b/core/commands/dns.go
@@ -4,7 +4,6 @@ import (
  "fmt"
  "io"
 
- nsopts "github.com/ipfs/boxo/coreiface/options/namesys"
  namesys "github.com/ipfs/boxo/namesys"
  cmdenv "github.com/ipfs/kubo/core/commands/cmdenv"
  ncmd "github.com/ipfs/kubo/core/commands/name"
@@ -47,12 +46,12 @@ It will work across multiple DNSLinks and IPNS keys.
  name := req.Arguments[0]
  resolver := namesys.NewDNSResolver(node.DNSResolver.LookupTXT)
 
- var routing []nsopts.ResolveOpt
+ var routing []namesys.ResolveOption
  if !recursive {
- routing = append(routing, nsopts.Depth(1))
+ routing = append(routing, namesys.ResolveWithDepth(1))
  }
 
- output, err := resolver.Resolve(req.Context, name, routing...)
+ output, _, err := resolver.Resolve(req.Context, name, routing...)
  if err != nil && (recursive || err != namesys.ErrResolveRecursion) {
  return err
  }

diff --git a/core/commands/name/ipns.go b/core/commands/name/ipns.go
@@ -7,14 +7,12 @@ import (
  "strings"
  "time"
 
- namesys "github.com/ipfs/boxo/namesys"
- cmdenv "github.com/ipfs/kubo/core/commands/cmdenv"
-
  options "github.com/ipfs/boxo/coreiface/options"
- nsopts "github.com/ipfs/boxo/coreiface/options/namesys"
+ "github.com/ipfs/boxo/namesys"
  "github.com/ipfs/boxo/path"
  cmds "github.com/ipfs/go-ipfs-cmds"
  logging "github.com/ipfs/go-log"
+ cmdenv "github.com/ipfs/kubo/core/commands/cmdenv"
 )
 
 var log = logging.Logger("core/commands/ipns")
@@ -108,10 +106,10 @@ Resolve the value of a dnslink:
  }
 
  if !recursive {
- opts = append(opts, options.Name.ResolveOption(nsopts.Depth(1)))
+ opts = append(opts, options.Name.ResolveOption(namesys.ResolveWithDepth(1)))
  }
  if rcok {
- opts = append(opts, options.Name.ResolveOption(nsopts.DhtRecordCount(rc)))
+ opts = append(opts, options.Name.ResolveOption(namesys.ResolveWithDhtRecordCount(rc)))
  }
  if dhttok {
  d, err := time.ParseDuration(dhtt)
@@ -121,7 +119,7 @@ Resolve the value of a dnslink:
  if d < 0 {
  return errors.New("DHT timeout value must be >= 0")
  }
- opts = append(opts, options.Name.ResolveOption(nsopts.DhtTimeout(d)))
+ opts = append(opts, options.Name.ResolveOption(namesys.ResolveWithDhtTimeout(d)))
  }
 
  if !strings.HasPrefix(name, "/ipns/") {

diff --git a/core/commands/resolve.go b/core/commands/resolve.go
@@ -8,14 +8,13 @@ import (
  "time"
 
  ns "github.com/ipfs/boxo/namesys"
- "github.com/ipfs/boxo/path"
  cidenc "github.com/ipfs/go-cidutil/cidenc"
  cmdenv "github.com/ipfs/kubo/core/commands/cmdenv"
  "github.com/ipfs/kubo/core/commands/cmdutils"
  ncmd "github.com/ipfs/kubo/core/commands/name"
 
  options "github.com/ipfs/boxo/coreiface/options"
- nsopts "github.com/ipfs/boxo/coreiface/options/namesys"
+ "github.com/ipfs/boxo/path"
  cmds "github.com/ipfs/go-ipfs-cmds"
 )
 
@@ -87,11 +86,11 @@ Resolve the value of an IPFS DAG path:
  rc, rcok := req.Options[resolveDhtRecordCountOptionName].(uint)
  dhtt, dhttok := req.Options[resolveDhtTimeoutOptionName].(string)
  ropts := []options.NameResolveOption{
- options.Name.ResolveOption(nsopts.Depth(1)),
+ options.Name.ResolveOption(ns.ResolveWithDepth(1)),
  }
 
  if rcok {
- ropts = append(ropts, options.Name.ResolveOption(nsopts.DhtRecordCount(rc)))
+ ropts = append(ropts, options.Name.ResolveOption(ns.ResolveWithDhtRecordCount(rc)))
  }
  if dhttok {
  d, err := time.ParseDuration(dhtt)
@@ -101,7 +100,7 @@ Resolve the value of an IPFS DAG path:
  if d < 0 {
  return errors.New("DHT timeout value must be >= 0")
  }
- ropts = append(ropts, options.Name.ResolveOption(nsopts.DhtTimeout(d)))
+ ropts = append(ropts, options.Name.ResolveOption(ns.ResolveWithDhtTimeout(d)))
  }
  p, err := api.Name().Resolve(req.Context, name, ropts...)
  // ErrResolveRecursion is fine

diff --git a/core/coreapi/name.go b/core/coreapi/name.go
@@ -15,7 +15,6 @@ import (
 
  coreiface "github.com/ipfs/boxo/coreiface"
  caopts "github.com/ipfs/boxo/coreiface/options"
- nsopts "github.com/ipfs/boxo/coreiface/options/namesys"
  "github.com/ipfs/boxo/path"
  ci "github.com/libp2p/go-libp2p/core/crypto"
  peer "github.com/libp2p/go-libp2p/core/peer"
@@ -57,13 +56,13 @@ func (api *NameAPI) Publish(ctx context.Context, p path.Path, opts ...caopts.Nam
 
  eol := time.Now().Add(options.ValidTime)
 
- publishOptions := []nsopts.PublishOption{
- nsopts.PublishWithEOL(eol),
- nsopts.PublishCompatibleWithV1(options.CompatibleWithV1),
+ publishOptions := []namesys.PublishOption{
+ namesys.PublishWithEOL(eol),
+ namesys.PublishCompatibleWithV1(options.CompatibleWithV1),
  }
 
  if options.TTL != nil {
- publishOptions = append(publishOptions, nsopts.PublishWithTTL(*options.TTL))
+ publishOptions = append(publishOptions, namesys.PublishWithTTL(*options.TTL))
  }
 
  err = api.namesys.Publish(ctx, k, p, publishOptions...)

diff --git a/core/coreapi/path.go b/core/coreapi/path.go
@@ -2,9 +2,10 @@ package coreapi
 
 import (
  "context"
+ "errors"
  "fmt"
 
- "github.com/ipfs/boxo/namesys/resolve"
+ "github.com/ipfs/boxo/namesys"
  "github.com/ipfs/kubo/tracing"
 
  "go.opentelemetry.io/otel/attribute"
@@ -47,8 +48,8 @@ func (api *CoreAPI) ResolvePath(ctx context.Context, p path.Path) (path.Immutabl
  // return nil, err
  // }
 
- p, err := resolve.ResolveIPNS(ctx, api.namesys, p)
- if err == resolve.ErrNoNamesys {
+ p, _, err := namesys.ResolveIPNS(ctx, api.namesys, p)
+ if errors.Is(err, namesys.ErrNoNamesys) {
  return nil, coreiface.ErrOffline
  } else if err != nil {
  return nil, err

diff --git a/core/corehttp/gateway.go b/core/corehttp/gateway.go
@@ -7,6 +7,7 @@ import (
  "io"
  "net"
  "net/http"
+ "time"
 
  "github.com/ipfs/boxo/blockservice"
  iface "github.com/ipfs/boxo/coreiface"
@@ -170,10 +171,10 @@ func (o *offlineGatewayErrWrapper) GetIPNSRecord(ctx context.Context, c cid.Cid)
  return rec, err
 }
 
-func (o *offlineGatewayErrWrapper) ResolveMutable(ctx context.Context, path path.Path) (path.ImmutablePath, error) {
- imPath, err := o.gwimpl.ResolveMutable(ctx, path)
+func (o *offlineGatewayErrWrapper) ResolveMutable(ctx context.Context, path path.Path) (path.ImmutablePath, time.Duration, error) {
+ imPath, ttl, err := o.gwimpl.ResolveMutable(ctx, path)
  err = offlineErrWrap(err)
- return imPath, err
+ return imPath, ttl, err
 }
 
 func (o *offlineGatewayErrWrapper) GetDNSLinkRecord(ctx context.Context, s string) (path.Path, error) {

diff --git a/core/corehttp/gateway_test.go b/core/corehttp/gateway_test.go
@@ -8,6 +8,7 @@ import (
  "net/http/httptest"
  "strings"
  "testing"
+ "time"
 
  "github.com/ipfs/boxo/namesys"
  version "github.com/ipfs/kubo"
@@ -17,7 +18,6 @@ import (
  "github.com/stretchr/testify/assert"
 
  iface "github.com/ipfs/boxo/coreiface"
- nsopts "github.com/ipfs/boxo/coreiface/options/namesys"
  "github.com/ipfs/boxo/path"
  "github.com/ipfs/go-datastore"
  syncds "github.com/ipfs/go-datastore/sync"
@@ -27,41 +27,41 @@ import (
 
 type mockNamesys map[string]path.Path
 
-func (m mockNamesys) Resolve(ctx context.Context, name string, opts ...nsopts.ResolveOpt) (value path.Path, err error) {
- cfg := nsopts.DefaultResolveOpts()
+func (m mockNamesys) Resolve(ctx context.Context, name string, opts ...namesys.ResolveOption) (value path.Path, ttl time.Duration, err error) {
+ cfg := namesys.DefaultResolveOptions()
  for _, o := range opts {
  o(&cfg)
  }
  depth := cfg.Depth
- if depth == nsopts.UnlimitedDepth {
+ if depth == namesys.UnlimitedDepth {
  // max uint
  depth = ^uint(0)
  }
  for strings.HasPrefix(name, "/ipns/") {
  if depth == 0 {
- return value, namesys.ErrResolveRecursion
+ return value, 0, namesys.ErrResolveRecursion
  }
  depth--
 
  var ok bool
  value, ok = m[name]
  if !ok {
- return nil, namesys.ErrResolveFailed
+ return nil, 0, namesys.ErrResolveFailed
  }
  name = value.String()
  }
- return value, nil
+ return value, 0, nil
 }
 
-func (m mockNamesys) ResolveAsync(ctx context.Context, name string, opts ...nsopts.ResolveOpt) <-chan namesys.Result {
- out := make(chan namesys.Result, 1)
- v, err := m.Resolve(ctx, name, opts...)
- out <- namesys.Result{Path: v, Err: err}
+func (m mockNamesys) ResolveAsync(ctx context.Context, name string, opts ...namesys.ResolveOption) <-chan namesys.ResolveResult {
+ out := make(chan namesys.ResolveResult, 1)
+ v, ttl, err := m.Resolve(ctx, name, opts...)
+ out <- namesys.ResolveResult{Path: v, TTL: ttl, Err: err}
  close(out)
  return out
 }
 
-func (m mockNamesys) Publish(ctx context.Context, name ci.PrivKey, value path.Path, opts ...nsopts.PublishOption) error {
+func (m mockNamesys) Publish(ctx context.Context, name ci.PrivKey, value path.Path, opts ...namesys.PublishOption) error {
  return errors.New("not implemented for mockNamesys")
 }
 

diff --git a/docs/examples/kubo-as-a-library/go.mod b/docs/examples/kubo-as-a-library/go.mod
@@ -7,7 +7,7 @@ go 1.20
 replace github.com/ipfs/kubo => ./../../..
 
 require (
- github.com/ipfs/boxo v0.12.1-0.20230905111226-1bf3f677e997
+ github.com/ipfs/boxo v0.12.1-0.20230905120600-fb409c23c69e
  github.com/ipfs/kubo v0.0.0-00010101000000-000000000000
  github.com/libp2p/go-libp2p v0.30.0
  github.com/multiformats/go-multiaddr v0.11.0

diff --git a/docs/examples/kubo-as-a-library/go.sum b/docs/examples/kubo-as-a-library/go.sum
@@ -300,8 +300,8 @@ github.com/ianlancetaylor/demangle v0.0.0-20181102032728-5e5cf60278f6/go.mod h1:
 github.com/inconshreveable/mousetrap v1.0.0/go.mod h1:PxqpIevigyE2G7u3NXJIT2ANytuPF1OarO4DADm73n8=
 github.com/ipfs/bbloom v0.0.4 h1:Gi+8EGJ2y5qiD5FbsbpX/TMNcJw8gSqr7eyjHa4Fhvs=
 github.com/ipfs/bbloom v0.0.4/go.mod h1:cS9YprKXpoZ9lT0n/Mw/a6/aFV6DTjTLYHeA+gyqMG0=
-github.com/ipfs/boxo v0.12.1-0.20230905111226-1bf3f677e997 h1:kFBPvjuL9ZTeo0/7oUP4zUJHg/GRmzmPZGk4BQs77hg=
-github.com/ipfs/boxo v0.12.1-0.20230905111226-1bf3f677e997/go.mod h1:btrtHy0lmO1ODMECbbEY1pxNtrLilvKSYLoGQt1yYCk=
+github.com/ipfs/boxo v0.12.1-0.20230905120600-fb409c23c69e h1:KhXZxwHeqrs2VZUXMu1lptXZODHQ9HT37zrDZri3ees=
+github.com/ipfs/boxo v0.12.1-0.20230905120600-fb409c23c69e/go.mod h1:btrtHy0lmO1ODMECbbEY1pxNtrLilvKSYLoGQt1yYCk=
 github.com/ipfs/go-bitfield v1.1.0 h1:fh7FIo8bSwaJEh6DdTWbCeZ1eqOaOkKFI74SCnsWbGA=
 github.com/ipfs/go-bitfield v1.1.0/go.mod h1:paqf1wjq/D2BBmzfTVFlJQ9IlFOZpg422HL0HqsGWHU=
 github.com/ipfs/go-block-format v0.0.2/go.mod h1:AWR46JfpcObNfg3ok2JHDUfdiHRgWhJgCQF+KIgOPJY=

diff --git a/fuse/ipns/common.go b/fuse/ipns/common.go
@@ -4,7 +4,7 @@ import (
  "context"
 
  ft "github.com/ipfs/boxo/ipld/unixfs"
- nsys "github.com/ipfs/boxo/namesys"
+ "github.com/ipfs/boxo/namesys"
  "github.com/ipfs/boxo/path"
  "github.com/ipfs/kubo/core"
  ci "github.com/libp2p/go-libp2p/core/crypto"
@@ -28,7 +28,7 @@ func InitializeKeyspace(n *core.IpfsNode, key ci.PrivKey) error {
  return err
  }
 
- pub := nsys.NewIpnsPublisher(n.Routing, n.Repo.Datastore())
+ pub := namesys.NewIPNSPublisher(n.Routing, n.Repo.Datastore())
 
  return pub.Publish(ctx, key, path.NewIPFSPath(emptyDir.Cid()))
 }
diff --git a/go.mod b/go.mod
@@ -15,7 +15,7 @@ require (
  github.com/fsnotify/fsnotify v1.6.0
  github.com/google/uuid v1.3.0
  github.com/hashicorp/go-multierror v1.1.1
- github.com/ipfs/boxo v0.12.1-0.20230905111226-1bf3f677e997
+ github.com/ipfs/boxo v0.12.1-0.20230905120600-fb409c23c69e
  github.com/ipfs/go-block-format v0.1.2
  github.com/ipfs/go-cid v0.4.1
  github.com/ipfs/go-cidutil v0.1.0

diff --git a/go.sum b/go.sum
@@ -335,8 +335,8 @@ github.com/ianlancetaylor/demangle v0.0.0-20181102032728-5e5cf60278f6/go.mod h1:
 github.com/inconshreveable/mousetrap v1.0.0/go.mod h1:PxqpIevigyE2G7u3NXJIT2ANytuPF1OarO4DADm73n8=
 github.com/ipfs/bbloom v0.0.4 h1:Gi+8EGJ2y5qiD5FbsbpX/TMNcJw8gSqr7eyjHa4Fhvs=
 github.com/ipfs/bbloom v0.0.4/go.mod h1:cS9YprKXpoZ9lT0n/Mw/a6/aFV6DTjTLYHeA+gyqMG0=
-github.com/ipfs/boxo v0.12.1-0.20230905111226-1bf3f677e997 h1:kFBPvjuL9ZTeo0/7oUP4zUJHg/GRmzmPZGk4BQs77hg=
-github.com/ipfs/boxo v0.12.1-0.20230905111226-1bf3f677e997/go.mod h1:btrtHy0lmO1ODMECbbEY1pxNtrLilvKSYLoGQt1yYCk=
+github.com/ipfs/boxo v0.12.1-0.20230905120600-fb409c23c69e h1:KhXZxwHeqrs2VZUXMu1lptXZODHQ9HT37zrDZri3ees=
+github.com/ipfs/boxo v0.12.1-0.20230905120600-fb409c23c69e/go.mod h1:btrtHy0lmO1ODMECbbEY1pxNtrLilvKSYLoGQt1yYCk=
 github.com/ipfs/go-bitfield v1.1.0 h1:fh7FIo8bSwaJEh6DdTWbCeZ1eqOaOkKFI74SCnsWbGA=
 github.com/ipfs/go-bitfield v1.1.0/go.mod h1:paqf1wjq/D2BBmzfTVFlJQ9IlFOZpg422HL0HqsGWHU=
 github.com/ipfs/go-bitswap v0.11.0 h1:j1WVvhDX1yhG32NTC9xfxnqycqYIlhzEzLXG/cU1HyQ=

diff --git a/test/dependencies/go.mod b/test/dependencies/go.mod
@@ -7,7 +7,7 @@ replace github.com/ipfs/kubo => ../../
 require (
  github.com/Kubuxu/gocovmerge v0.0.0-20161216165753-7ecaa51963cd
  github.com/golangci/golangci-lint v1.54.1
- github.com/ipfs/boxo v0.12.1-0.20230905111226-1bf3f677e997
+ github.com/ipfs/boxo v0.12.1-0.20230905120600-fb409c23c69e
  github.com/ipfs/go-cid v0.4.1
  github.com/ipfs/go-cidutil v0.1.0
  github.com/ipfs/go-datastore v0.6.0
@@ -165,6 +165,9 @@ require (
  github.com/libp2p/go-cidranger v1.1.0 // indirect
  github.com/libp2p/go-flow-metrics v0.1.0 // indirect
  github.com/libp2p/go-libp2p-asn-util v0.3.0 // indirect
+ github.com/libp2p/go-libp2p-kad-dht v0.24.2 // indirect
+ github.com/libp2p/go-libp2p-kbucket v0.6.3 // indirect
+ github.com/libp2p/go-libp2p-record v0.2.0 // indirect
  github.com/libp2p/go-msgio v0.3.0 // indirect
  github.com/libp2p/go-nat v0.2.0 // indirect
  github.com/libp2p/go-netroute v0.2.1 // indirect
@@ -264,11 +267,14 @@ require (
  github.com/ultraware/whitespace v0.0.5 // indirect
  github.com/urfave/cli v1.22.10 // indirect
  github.com/uudashr/gocognit v1.0.7 // indirect
+ github.com/whyrusleeping/base32 v0.0.0-20170828182744-c30ac30633cc // indirect
+ github.com/whyrusleeping/go-keyspace v0.0.0-20160322163242-5b898ac5add1 // indirect
  github.com/xen0n/gosmopolitan v1.2.1 // indirect
  github.com/yagipy/maintidx v1.0.0 // indirect
  github.com/yeya24/promlinter v0.2.0 // indirect
  github.com/ykadowak/zerologlint v0.1.3 // indirect
  gitlab.com/bosi/decorder v0.4.0 // indirect
+ go.opencensus.io v0.24.0 // indirect
  go.opentelemetry.io/otel v1.16.0 // indirect
  go.opentelemetry.io/otel/metric v1.16.0 // indirect
  go.opentelemetry.io/otel/trace v1.16.0 // indirect
@@ -288,6 +294,7 @@ require (
  golang.org/x/term v0.11.0 // indirect
  golang.org/x/text v0.12.0 // indirect
  golang.org/x/tools v0.12.1-0.20230815132531-74c255bcf846 // indirect
+ gonum.org/v1/gonum v0.13.0 // indirect
  google.golang.org/protobuf v1.31.0 // indirect
  gopkg.in/ini.v1 v1.67.0 // indirect
  gopkg.in/yaml.v2 v2.4.0 // indirect