Upgrade to cli/v3 (#140)

Author: gammazero

cmd/ipni/ipni.go

@@ -1,6 +1,7 @@
 package main
 
 import (
+	"context"
 	"encoding/json"
 	"fmt"
 	"io"
@@ -15,15 +16,15 @@ import (
 	"github.com/ipni/ipni-cli/pkg/random"
 	"github.com/ipni/ipni-cli/pkg/spaddr"
 	"github.com/ipni/ipni-cli/pkg/verify"
-	"github.com/urfave/cli/v2"
+	"github.com/urfave/cli/v3"
 	"golang.org/x/mod/semver"
 )
 
 func main() {
 	// Disable logging that happens in packages such as data-transfer.
 	_ = logging.SetLogLevel("*", "fatal")
 
-	app := &cli.App{
+	cmd := &cli.Command{
 		Name:    "ipni",
 		Usage:   "Commands to interact with IPNI indexers and index providers",
 		Version: ipnicli.Version,
@@ -38,7 +39,7 @@ func main() {
 		},
 	}
 
-	if err := app.Run(os.Args); err != nil {
+	if err := cmd.Run(context.Background(), os.Args); err != nil {
 		fmt.Fprintln(os.Stderr, err)
 		os.Exit(1)
 	}
@@ -50,9 +51,9 @@ var versionCmd = &cli.Command{
 	Action: versionAction,
 }
 
-func versionAction(cctx *cli.Context) error {
+func versionAction(ctx context.Context, cmd *cli.Command) error {
 	const githubURL = "https://api.github.com/repos/ipni/ipni-cli/releases/latest"
-	fmt.Println(cctx.App.Version)
+	fmt.Println(cmd.Version)
 	resp, err := http.Get(githubURL)
 	if err != nil {
 		return fmt.Errorf("cannot check for newer version: %s", err)
@@ -72,11 +73,11 @@ func versionAction(cctx *cli.Context) error {
 	}
 	switch semver.Compare(ipnicli.Release, relName) {
 	case 0:
-		fmt.Fprintln(os.Stderr, cctx.App.Name, "is up to date")
+		fmt.Fprintln(os.Stderr, cmd.Name, "is up to date")
 	case -1:
-		fmt.Fprintln(os.Stderr, "a newer version of", cctx.App.Name, "is available:", relName)
+		fmt.Fprintln(os.Stderr, "a newer version of", cmd.Name, "is available:", relName)
 	case 1:
-		fmt.Fprintln(os.Stderr, "this is the newest version of", cctx.App.Name)
+		fmt.Fprintln(os.Stderr, "this is the newest version of", cmd.Name)
 	}
 	return nil
 }

go.mod

@@ -17,7 +17,7 @@ require (
 	github.com/multiformats/go-multicodec v0.9.0
 	github.com/multiformats/go-multihash v0.2.3
 	github.com/stretchr/testify v1.10.0
-	github.com/urfave/cli/v2 v2.27.5
+	github.com/urfave/cli/v3 v3.3.2
 	github.com/ybbus/jsonrpc/v2 v2.1.7
 	golang.org/x/mod v0.23.0
 )
@@ -139,6 +139,7 @@ require (
 	github.com/raulk/go-watchdog v1.3.0 // indirect
 	github.com/russross/blackfriday/v2 v2.1.0 // indirect
 	github.com/spaolacci/murmur3 v1.1.0 // indirect
+	github.com/urfave/cli/v2 v2.27.5 // indirect
 	github.com/whyrusleeping/cbor v0.0.0-20171005072247-63513f603b11 // indirect
 	github.com/whyrusleeping/cbor-gen v0.2.0 // indirect
 	github.com/wlynxg/anet v0.0.5 // indirect

go.sum

@@ -577,6 +577,8 @@ github.com/urfave/cli v1.22.10/go.mod h1:Gos4lmkARVdJ6EkW0WaNv/tZAAMe9V7XWyB60Nt
 github.com/urfave/cli/v2 v2.0.0/go.mod h1:SE9GqnLQmjVa0iPEY0f1w3ygNIYcIJ0OKPMoW2caLfQ=
 github.com/urfave/cli/v2 v2.27.5 h1:WoHEJLdsXr6dDWoJgMq/CboDmyY/8HMMH1fTECbih+w=
 github.com/urfave/cli/v2 v2.27.5/go.mod h1:3Sevf16NykTbInEnD0yKkjDAeZDS0A6bzhBH5hrMvTQ=
+github.com/urfave/cli/v3 v3.3.2 h1:BYFVnhhZ8RqT38DxEYVFPPmGFTEf7tJwySTXsVRrS/o=
+github.com/urfave/cli/v3 v3.3.2/go.mod h1:FJSKtM/9AiiTOJL4fJ6TbMUkxBXn7GO9guZqoZtpYpo=
 github.com/viant/assertly v0.4.8/go.mod h1:aGifi++jvCrUaklKEKT0BU95igDNaqkvz+49uaYMPRU=
 github.com/viant/toolbox v0.24.0/go.mod h1:OxMCG57V0PXuIP2HNQrtJf2CjqdmbrOx5EkMILuUhzM=
 github.com/warpfork/go-testmark v0.12.1 h1:rMgCpJfwy1sJ50x0M0NgyphxYYPMOODIJHhsXyEHU0s=

pkg/ads/ads.go

@@ -1,13 +1,13 @@
 package ads
 
 import (
-	"github.com/urfave/cli/v2"
+	"github.com/urfave/cli/v3"
 )
 
 var AdsCmd = &cli.Command{
 	Name:  "ads",
 	Usage: "Show advertisements on a chain from a specified publisher",
-	Subcommands: []*cli.Command{
+	Commands: []*cli.Command{
 		adsGetSubCmd,
 		adsListSubCmd,
 		adsCrawlSubCmd,

pkg/ads/crawl.go

@@ -13,7 +13,7 @@ import (
 	"github.com/ipni/go-libipni/metadata"
 	"github.com/ipni/ipni-cli/pkg/adpub"
 	"github.com/libp2p/go-libp2p/core/peer"
-	"github.com/urfave/cli/v2"
+	"github.com/urfave/cli/v3"
 )
 
 var adsCrawlSubCmd = &cli.Command{
@@ -65,46 +65,46 @@ var adsCrawlFlags = []cli.Flag{
 	topicFlag,
 }
 
-func adsCrawlAction(cctx *cli.Context) error {
-	addrInfo, err := peer.AddrInfoFromString(cctx.String("addr-info"))
+func adsCrawlAction(ctx context.Context, cmd *cli.Command) error {
+	addrInfo, err := peer.AddrInfoFromString(cmd.String("addr-info"))
 	if err != nil {
 		return fmt.Errorf("bad pub-addr-info: %w", err)
 	}
 
 	provClient, err := adpub.NewClient(*addrInfo,
 		adpub.WithDeleteAfterRead(true),
 		adpub.WithEntriesDepthLimit(0),
-		adpub.WithTopicName(cctx.String("topic")),
-		adpub.WithHttpTimeout(cctx.Duration("timeout")))
+		adpub.WithTopicName(cmd.String("topic")),
+		adpub.WithHttpTimeout(cmd.Duration("timeout")))
 	if err != nil {
 		return err
 	}
 
 	var latestCid cid.Cid
-	if cctx.String("latest") != "" {
-		latestCid, err = cid.Decode(cctx.String("latest"))
+	if cmd.String("latest") != "" {
+		latestCid, err = cid.Decode(cmd.String("latest"))
 		if err != nil {
 			return fmt.Errorf("bad cid: %w", err)
 		}
 	}
 
-	quiet := cctx.Bool("quiet")
-	skipEntries := cctx.Bool("skip-entries")
-	showMetadata := cctx.Bool("show-metadata")
-	showExtProviders := cctx.Bool("show-ext-providers")
-	stopMhs := cctx.Int("stop-mhs")
+	quiet := cmd.Bool("quiet")
+	skipEntries := cmd.Bool("skip-entries")
+	showMetadata := cmd.Bool("show-metadata")
+	showExtProviders := cmd.Bool("show-ext-providers")
+	stopMhs := cmd.Int("stop-mhs")
 
 	if skipEntries && stopMhs != 0 {
 		return errors.New("cannot use flag --skip-entries with --stop-mhs")
 	}
 
-	ctx, cancel := context.WithCancel(cctx.Context)
+	ctx, cancel := context.WithCancel(ctx)
 	defer cancel()
 
 	ads := make(chan *adpub.Advertisement, 1)
 	errCh := make(chan error, 1)
 	go func() {
-		errCh <- provClient.Crawl(ctx, latestCid, cctx.Int("number"), ads)
+		errCh <- provClient.Crawl(ctx, latestCid, cmd.Int("number"), ads)
 		close(ads)
 	}()
 
@@ -187,7 +187,7 @@ func adsCrawlAction(cctx *cli.Context) error {
 			continue
 		}
 
-		err = provClient.SyncEntriesWithRetry(cctx.Context, ad.Entries.Root())
+		err = provClient.SyncEntriesWithRetry(ctx, ad.Entries.Root())
 		if err != nil {
 			fmt.Fprintf(os.Stderr, "Failed to sync entries for advertisement %s: %s\n", ad.ID, err)
 			continue

pkg/ads/dist.go

@@ -1,12 +1,13 @@
 package ads
 
 import (
+	"context"
 	"fmt"
 
 	"github.com/ipfs/go-cid"
 	"github.com/ipni/ipni-cli/pkg/dtrack"
 	"github.com/libp2p/go-libp2p/core/peer"
-	"github.com/urfave/cli/v2"
+	"github.com/urfave/cli/v3"
 )
 
 var adsDistSubCmd = &cli.Command{
@@ -42,28 +43,28 @@ var adsDistFlags = []cli.Flag{
 	topicFlag,
 }
 
-func adsDistAction(cctx *cli.Context) error {
-	addrInfo, err := peer.AddrInfoFromString(cctx.String("addr-info"))
+func adsDistAction(ctx context.Context, cmd *cli.Command) error {
+	addrInfo, err := peer.AddrInfoFromString(cmd.String("addr-info"))
 	if err != nil {
 		return fmt.Errorf("bad pub-addr-info: %w", err)
 	}
 
-	startCid, err := cid.Decode(cctx.String("start"))
+	startCid, err := cid.Decode(cmd.String("start"))
 	if err != nil {
 		return fmt.Errorf("bad start cid: %w", err)
 	}
 
 	adDist, err := dtrack.NewAdDistance(
-		dtrack.WithTopic(cctx.String("topic")),
-		dtrack.WithDepthLimit(cctx.Int64("dist-limit")))
+		dtrack.WithTopic(cmd.String("topic")),
+		dtrack.WithDepthLimit(cmd.Int64("dist-limit")))
 	if err != nil {
 		return err
 	}
 
 	var endStr string
 	var endCid cid.Cid
-	if cctx.String("end") != "" {
-		endCid, err = cid.Decode(cctx.String("end"))
+	if cmd.String("end") != "" {
+		endCid, err = cid.Decode(cmd.String("end"))
 		if err != nil {
 			return fmt.Errorf("bad end cid: %w", err)
 		}
@@ -72,12 +73,12 @@ func adsDistAction(cctx *cli.Context) error {
 		endStr = "head"
 	}
 
-	adCount, _, err := adDist.Get(cctx.Context, *addrInfo, startCid, endCid)
+	adCount, _, err := adDist.Get(ctx, *addrInfo, startCid, endCid)
 	if err != nil {
 		return err
 	}
 
-	if cctx.Bool("quiet") {
+	if cmd.Bool("quiet") {
 		fmt.Println(adCount)
 	} else {
 		fmt.Printf("Distance from %s to %s is %d\n", startCid, endStr, adCount)

pkg/ads/flags.go

@@ -3,7 +3,7 @@ package ads
 import (
 	"time"
 
-	"github.com/urfave/cli/v2"
+	"github.com/urfave/cli/v3"
 )
 
 var addrInfoFlag = &cli.StringFlag{

pkg/ads/get.go

@@ -2,6 +2,7 @@ package ads
 
 import (
 	"bufio"
+	"context"
 	"encoding/base64"
 	"errors"
 	"fmt"
@@ -14,7 +15,7 @@ import (
 	"github.com/ipni/ipni-cli/pkg/adpub"
 	"github.com/libp2p/go-libp2p/core/peer"
 	"github.com/mattn/go-isatty"
-	"github.com/urfave/cli/v2"
+	"github.com/urfave/cli/v3"
 )
 
 var adsGetSubCmd = &cli.Command{
@@ -68,14 +69,14 @@ var adsGetFlags = []cli.Flag{
 	topicFlag,
 }
 
-func adsGetAction(cctx *cli.Context) error {
-	addrInfo, err := peer.AddrInfoFromString(cctx.String("addr-info"))
+func adsGetAction(ctx context.Context, cmd *cli.Command) error {
+	addrInfo, err := peer.AddrInfoFromString(cmd.String("addr-info"))
 	if err != nil {
 		return fmt.Errorf("bad pub-addr-info: %w", err)
 	}
 
 	var adCids []cid.Cid
-	cidArgs := cctx.StringSlice("cid")
+	cidArgs := cmd.StringSlice("cid")
 	if len(cidArgs) != 0 {
 		seen := make(map[string]struct{}, len(cidArgs))
 		adCids = make([]cid.Cid, 0, len(cidArgs))
@@ -91,7 +92,7 @@ func adsGetAction(cctx *cli.Context) error {
 			adCids = append(adCids, cid)
 		}
 	}
-	if cctx.Bool("head") {
+	if cmd.Bool("head") {
 		// Fetch latest advertisement
 		adCids = append(adCids, cid.Undef)
 	}
@@ -125,17 +126,17 @@ func adsGetAction(cctx *cli.Context) error {
 	}
 
 	pubClient, err := adpub.NewClient(*addrInfo,
-		adpub.WithTopicName(cctx.String("topic")),
-		adpub.WithEntriesDepthLimit(cctx.Int64("entries-depth-limit")),
-		adpub.WithHttpTimeout(cctx.Duration("timeout")))
+		adpub.WithTopicName(cmd.String("topic")),
+		adpub.WithEntriesDepthLimit(cmd.Int64("entries-depth-limit")),
+		adpub.WithHttpTimeout(cmd.Duration("timeout")))
 	if err != nil {
 		return err
 	}
 
 	for _, adCid := range adCids {
 		fmt.Println()
 
-		ad, err := pubClient.GetAdvertisement(cctx.Context, adCid)
+		ad, err := pubClient.GetAdvertisement(ctx, adCid)
 		if err != nil {
 			if ad == nil {
 				if errors.Is(err, adpub.ErrContentNotFound) {
@@ -223,12 +224,12 @@ func adsGetAction(cctx *cli.Context) error {
 			continue
 		}
 
-		if cctx.Bool("skip-entries") {
+		if cmd.Bool("skip-entries") {
 			continue
 		}
 
 		// Sync entries if not a removal advertisement and has entries.
-		err = pubClient.SyncEntriesWithRetry(cctx.Context, ad.Entries.Root())
+		err = pubClient.SyncEntriesWithRetry(ctx, ad.Entries.Root())
 		if err != nil {
 			fmt.Fprintf(os.Stderr, "⚠️  Failed to sync entries for advertisement %s: %s\n", ad.ID, err)
 			continue
@@ -244,7 +245,7 @@ func adsGetAction(cctx *cli.Context) error {
 			entriesOutput = "⚠️  Note: More entries were available but not synced due to the configured entries recursion limit or error during traversal."
 		}
 
-		if cctx.Bool("print-entries") {
+		if cmd.Bool("print-entries") {
 			for _, mh := range entries {
 				fmt.Printf("  %s\n", mh.B58String())
 			}

pkg/ads/list.go

@@ -1,13 +1,14 @@
 package ads
 
 import (
+	"context"
 	"fmt"
 	"os"
 
 	"github.com/ipfs/go-cid"
 	"github.com/ipni/ipni-cli/pkg/adpub"
 	"github.com/libp2p/go-libp2p/core/peer"
-	"github.com/urfave/cli/v2"
+	"github.com/urfave/cli/v3"
 )
 
 var adsListSubCmd = &cli.Command{
@@ -38,27 +39,27 @@ var adsListFlags = []cli.Flag{
 	topicFlag,
 }
 
-func adsListAction(cctx *cli.Context) error {
-	addrInfo, err := peer.AddrInfoFromString(cctx.String("addr-info"))
+func adsListAction(ctx context.Context, cmd *cli.Command) error {
+	addrInfo, err := peer.AddrInfoFromString(cmd.String("addr-info"))
 	if err != nil {
 		return fmt.Errorf("bad pub-addr-info: %w", err)
 	}
 
 	provClient, err := adpub.NewClient(*addrInfo,
 		adpub.WithDeleteAfterRead(true),
-		adpub.WithTopicName(cctx.String("topic")),
-		adpub.WithHttpTimeout(cctx.Duration("timeout")))
+		adpub.WithTopicName(cmd.String("topic")),
+		adpub.WithHttpTimeout(cmd.Duration("timeout")))
 	if err != nil {
 		return err
 	}
 
 	var latestCid cid.Cid
-	if cctx.String("latest") != "" {
-		latestCid, err = cid.Decode(cctx.String("latest"))
+	if cmd.String("latest") != "" {
+		latestCid, err = cid.Decode(cmd.String("latest"))
 		if err != nil {
 			return fmt.Errorf("bad cid: %w", err)
 		}
 	}
 
-	return provClient.List(cctx.Context, latestCid, cctx.Int("number"), os.Stdout)
+	return provClient.List(ctx, latestCid, cmd.Int("number"), os.Stdout)
 }