refactor: use slices.Sort where appropriate (#10858)

gammazero · lidel · commit ca2b8f69a67f · 2025-07-08T18:43:23.000+02:00
(cherry picked from commit b95845e)
diff --git a/core/commands/active.go b/core/commands/active.go
@@ -3,7 +3,7 @@ package commands
 import (
 	"fmt"
 	"io"
-	"sort"
+	"slices"
 	"text/tabwriter"
 	"time"
 
@@ -60,7 +60,7 @@ Lists running and recently run commands.
 					for k := range req.Options {
 						keys = append(keys, k)
 					}
-					sort.Strings(keys)
+					slices.Sort(keys)
 
 					for _, k := range keys {
 						fmt.Fprintf(tw, "%s=%v,", k, req.Options[k])
diff --git a/core/commands/bootstrap.go b/core/commands/bootstrap.go
@@ -4,14 +4,14 @@ import (
 	"errors"
 	"fmt"
 	"io"
-	"sort"
+	"slices"
+	"strings"
 
+	cmds "github.com/ipfs/go-ipfs-cmds"
+	config "github.com/ipfs/kubo/config"
 	cmdenv "github.com/ipfs/kubo/core/commands/cmdenv"
 	repo "github.com/ipfs/kubo/repo"
 	fsrepo "github.com/ipfs/kubo/repo/fsrepo"
-
-	cmds "github.com/ipfs/go-ipfs-cmds"
-	config "github.com/ipfs/kubo/config"
 	peer "github.com/libp2p/go-libp2p/core/peer"
 	ma "github.com/multiformats/go-multiaddr"
 )
@@ -284,7 +284,9 @@ var bootstrapListCmd = &cmds.Command{
 }
 
 func bootstrapWritePeers(w io.Writer, prefix string, peers []string) error {
-	sort.Stable(sort.StringSlice(peers))
+	slices.SortStableFunc(peers, func(a, b string) int {
+		return strings.Compare(a, b)
+	})
 	for _, peer := range peers {
 		_, err := w.Write([]byte(prefix + peer + "\n"))
 		if err != nil {
diff --git a/core/commands/cid.go b/core/commands/cid.go
@@ -1,10 +1,11 @@
 package commands
 
 import (
+	"cmp"
 	"errors"
 	"fmt"
 	"io"
-	"sort"
+	"slices"
 	"strings"
 	"unicode"
 
@@ -287,7 +288,7 @@ var basesCmd = &cmds.Command{
 		cmds.Text: cmds.MakeTypedEncoder(func(req *cmds.Request, w io.Writer, val []CodeAndName) error {
 			prefixes, _ := req.Options[prefixOptionName].(bool)
 			numeric, _ := req.Options[numericOptionName].(bool)
-			sort.Sort(multibaseSorter{val})
+			multibaseSorter{val}.Sort()
 			for _, v := range val {
 				code := v.Code
 				if code < 32 || code >= 127 {
@@ -357,7 +358,7 @@ var codecsCmd = &cmds.Command{
 	Encoders: cmds.EncoderMap{
 		cmds.Text: cmds.MakeTypedEncoder(func(req *cmds.Request, w io.Writer, val []CodeAndName) error {
 			numeric, _ := req.Options[codecsNumericOptionName].(bool)
-			sort.Sort(codeAndNameSorter{val})
+			codeAndNameSorter{val}.Sort()
 			for _, v := range val {
 				if numeric {
 					fmt.Fprintf(w, "%5d  %s\n", v.Code, v.Name)
@@ -398,23 +399,22 @@ type multibaseSorter struct {
 	data []CodeAndName
 }
 
-func (s multibaseSorter) Len() int      { return len(s.data) }
-func (s multibaseSorter) Swap(i, j int) { s.data[i], s.data[j] = s.data[j], s.data[i] }
-
-func (s multibaseSorter) Less(i, j int) bool {
-	a := unicode.ToLower(rune(s.data[i].Code))
-	b := unicode.ToLower(rune(s.data[j].Code))
-	if a != b {
-		return a < b
-	}
-	// lowecase letters should come before uppercase
-	return s.data[i].Code > s.data[j].Code
+func (s multibaseSorter) Sort() {
+	slices.SortFunc(s.data, func(a, b CodeAndName) int {
+		if n := cmp.Compare(unicode.ToLower(rune(a.Code)), unicode.ToLower(rune(b.Code))); n != 0 {
+			return n
+		}
+		// lowecase letters should come before uppercase
+		return cmp.Compare(b.Code, a.Code)
+	})
 }
 
 type codeAndNameSorter struct {
 	data []CodeAndName
 }
 
-func (s codeAndNameSorter) Len() int           { return len(s.data) }
-func (s codeAndNameSorter) Swap(i, j int)      { s.data[i], s.data[j] = s.data[j], s.data[i] }
-func (s codeAndNameSorter) Less(i, j int) bool { return s.data[i].Code < s.data[j].Code }
+func (s codeAndNameSorter) Sort() {
+	slices.SortFunc(s.data, func(a, b CodeAndName) int {
+		return cmp.Compare(a.Code, b.Code)
+	})
+}
diff --git a/core/commands/commands.go b/core/commands/commands.go
@@ -10,7 +10,7 @@ import (
 	"fmt"
 	"io"
 	"os"
-	"sort"
+	"slices"
 	"strings"
 
 	cmds "github.com/ipfs/go-ipfs-cmds"
@@ -131,7 +131,7 @@ func cmdPathStrings(cmd *Command, showOptions bool) []string {
 	}
 
 	recurse("", cmd)
-	sort.Strings(cmds)
+	slices.Sort(cmds)
 	return cmds
 }
 
diff --git a/core/commands/completion.go b/core/commands/completion.go
@@ -2,7 +2,8 @@ package commands
 
 import (
 	"io"
-	"sort"
+	"slices"
+	"strings"
 	"text/template"
 
 	cmds "github.com/ipfs/go-ipfs-cmds"
@@ -39,8 +40,8 @@ func commandToCompletions(name string, fullName string, cmd *cmds.Command) *comp
 		parsed.Subcommands = append(parsed.Subcommands,
 			commandToCompletions(name, fullName+" "+name, subCmd))
 	}
-	sort.Slice(parsed.Subcommands, func(i, j int) bool {
-		return parsed.Subcommands[i].Name < parsed.Subcommands[j].Name
+	slices.SortFunc(parsed.Subcommands, func(a, b *completionCommand) int {
+		return strings.Compare(a.Name, b.Name)
 	})
 
 	for _, opt := range cmd.Options {
@@ -68,18 +69,10 @@ func commandToCompletions(name string, fullName string, cmd *cmds.Command) *comp
 			parsed.Options = append(parsed.Options, flag)
 		}
 	}
-	sort.Slice(parsed.LongFlags, func(i, j int) bool {
-		return parsed.LongFlags[i] < parsed.LongFlags[j]
-	})
-	sort.Slice(parsed.ShortFlags, func(i, j int) bool {
-		return parsed.ShortFlags[i] < parsed.ShortFlags[j]
-	})
-	sort.Slice(parsed.LongOptions, func(i, j int) bool {
-		return parsed.LongOptions[i] < parsed.LongOptions[j]
-	})
-	sort.Slice(parsed.ShortOptions, func(i, j int) bool {
-		return parsed.ShortOptions[i] < parsed.ShortOptions[j]
-	})
+	slices.Sort(parsed.LongFlags)
+	slices.Sort(parsed.ShortFlags)
+	slices.Sort(parsed.LongOptions)
+	slices.Sort(parsed.ShortOptions)
 	return parsed
 }
 
diff --git a/core/commands/files.go b/core/commands/files.go
@@ -8,7 +8,7 @@ import (
 	"io"
 	"os"
 	gopath "path"
-	"sort"
+	"slices"
 	"strconv"
 	"strings"
 	"time"
@@ -698,8 +698,8 @@ Examples:
 		cmds.Text: cmds.MakeTypedEncoder(func(req *cmds.Request, w io.Writer, out *filesLsOutput) error {
 			noSort, _ := req.Options[dontSortOptionName].(bool)
 			if !noSort {
-				sort.Slice(out.Entries, func(i, j int) bool {
-					return strings.Compare(out.Entries[i].Name, out.Entries[j].Name) < 0
+				slices.SortFunc(out.Entries, func(a, b mfs.NodeListing) int {
+					return strings.Compare(a.Name, b.Name)
 				})
 			}
 
diff --git a/core/commands/id.go b/core/commands/id.go
@@ -6,7 +6,7 @@ import (
 	"errors"
 	"fmt"
 	"io"
-	"sort"
+	"slices"
 	"strings"
 
 	version "github.com/ipfs/kubo"
@@ -170,11 +170,11 @@ func printPeer(keyEnc ke.KeyEncoder, ps pstore.Peerstore, p peer.ID) (interface{
 	for _, a := range addrs {
 		info.Addresses = append(info.Addresses, a.String())
 	}
-	sort.Strings(info.Addresses)
+	slices.Sort(info.Addresses)
 
 	protocols, _ := ps.GetProtocols(p) // don't care about errors here.
 	info.Protocols = append(info.Protocols, protocols...)
-	sort.Slice(info.Protocols, func(i, j int) bool { return info.Protocols[i] < info.Protocols[j] })
+	slices.Sort(info.Protocols)
 
 	if v, err := ps.Get(p, "AgentVersion"); err == nil {
 		if vs, ok := v.(string); ok {
@@ -205,9 +205,9 @@ func printSelf(keyEnc ke.KeyEncoder, node *core.IpfsNode) (interface{}, error) {
 		for _, a := range addrs {
 			info.Addresses = append(info.Addresses, a.String())
 		}
-		sort.Strings(info.Addresses)
+		slices.Sort(info.Addresses)
 		info.Protocols = node.PeerHost.Mux().Protocols()
-		sort.Slice(info.Protocols, func(i, j int) bool { return info.Protocols[i] < info.Protocols[j] })
+		slices.Sort(info.Protocols)
 	}
 	info.AgentVersion = version.GetUserAgentVersion()
 	return info, nil
diff --git a/core/commands/ls.go b/core/commands/ls.go
@@ -5,7 +5,8 @@ import (
 	"fmt"
 	"io"
 	"os"
-	"sort"
+	"slices"
+	"strings"
 	"text/tabwriter"
 	"time"
 
@@ -118,8 +119,8 @@ The JSON output contains type information.
 						return nil
 					}, func(i int) {
 						// after each dir
-						sort.Slice(outputLinks, func(i, j int) bool {
-							return outputLinks[i].Name < outputLinks[j].Name
+						slices.SortFunc(outputLinks, func(a, b LsLink) int {
+							return strings.Compare(a.Name, b.Name)
 						})
 
 						output[i] = LsObject{
diff --git a/core/commands/pubsub.go b/core/commands/pubsub.go
@@ -6,7 +6,7 @@ import (
 	"fmt"
 	"io"
 	"net/http"
-	"sort"
+	"slices"
 
 	cmdenv "github.com/ipfs/kubo/core/commands/cmdenv"
 	mbase "github.com/multiformats/go-multibase"
@@ -325,7 +325,7 @@ TOPIC AND DATA ENCODING
 		for _, peer := range peers {
 			list.Strings = append(list.Strings, peer.String())
 		}
-		sort.Strings(list.Strings)
+		slices.Sort(list.Strings)
 		return cmds.EmitOnce(res, list)
 	},
 	Type: stringList{},
diff --git a/core/commands/swarm.go b/core/commands/swarm.go
@@ -8,8 +8,9 @@ import (
 	"fmt"
 	"io"
 	"path"
-	"sort"
+	"slices"
 	"strconv"
+	"strings"
 	"sync"
 	"text/tabwriter"
 	"time"
@@ -301,11 +302,11 @@ var swarmPeersCmd = &cmds.Command{
 				identifyResult, _ := ci.identifyPeer(n.Peerstore, c.ID())
 				ci.Identify = identifyResult
 			}
-			sort.Sort(&ci)
+			ci.Sort()
 			out.Peers = append(out.Peers, ci)
 		}
 
-		sort.Sort(&out)
+		out.Sort()
 		return cmds.EmitOnce(res, &out)
 	},
 	Encoders: cmds.EncoderMap{
@@ -435,32 +436,20 @@ type connInfo struct {
 	Identify  IdOutput       `json:",omitempty"`
 }
 
-func (ci *connInfo) Less(i, j int) bool {
-	return ci.Streams[i].Protocol < ci.Streams[j].Protocol
-}
-
-func (ci *connInfo) Len() int {
-	return len(ci.Streams)
-}
-
-func (ci *connInfo) Swap(i, j int) {
-	ci.Streams[i], ci.Streams[j] = ci.Streams[j], ci.Streams[i]
+func (ci *connInfo) Sort() {
+	slices.SortFunc(ci.Streams, func(a, b streamInfo) int {
+		return strings.Compare(a.Protocol, b.Protocol)
+	})
 }
 
 type connInfos struct {
 	Peers []connInfo
 }
 
-func (ci connInfos) Less(i, j int) bool {
-	return ci.Peers[i].Addr < ci.Peers[j].Addr
-}
-
-func (ci connInfos) Len() int {
-	return len(ci.Peers)
-}
-
-func (ci connInfos) Swap(i, j int) {
-	ci.Peers[i], ci.Peers[j] = ci.Peers[j], ci.Peers[i]
+func (ci *connInfos) Sort() {
+	slices.SortFunc(ci.Peers, func(a, b connInfo) int {
+		return strings.Compare(a.Addr, b.Addr)
+	})
 }
 
 func (ci *connInfo) identifyPeer(ps pstore.Peerstore, p peer.ID) (IdOutput, error) {
@@ -484,11 +473,11 @@ func (ci *connInfo) identifyPeer(ps pstore.Peerstore, p peer.ID) (IdOutput, erro
 	for _, a := range addrs {
 		info.Addresses = append(info.Addresses, a.String())
 	}
-	sort.Strings(info.Addresses)
+	slices.Sort(info.Addresses)
 
 	if protocols, err := ps.GetProtocols(p); err == nil {
 		info.Protocols = append(info.Protocols, protocols...)
-		sort.Slice(info.Protocols, func(i, j int) bool { return info.Protocols[i] < info.Protocols[j] })
+		slices.Sort(info.Protocols)
 	}
 
 	if v, err := ps.Get(p, "AgentVersion"); err == nil {
@@ -551,7 +540,7 @@ var swarmAddrsCmd = &cmds.Command{
 			for p := range am.Addrs {
 				ids = append(ids, p)
 			}
-			sort.Strings(ids)
+			slices.Sort(ids)
 
 			for _, p := range ids {
 				paddrs := am.Addrs[p]
@@ -603,7 +592,7 @@ var swarmAddrsLocalCmd = &cmds.Command{
 			}
 			addrs = append(addrs, saddr)
 		}
-		sort.Strings(addrs)
+		slices.Sort(addrs)
 		return cmds.EmitOnce(res, &stringList{addrs})
 	},
 	Type: stringList{},
@@ -634,7 +623,7 @@ var swarmAddrsListenCmd = &cmds.Command{
 		for _, addr := range maddrs {
 			addrs = append(addrs, addr.String())
 		}
-		sort.Strings(addrs)
+		slices.Sort(addrs)
 
 		return cmds.EmitOnce(res, &stringList{addrs})
 	},

Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ import (`
`10`	`10`	`"fmt"`
`11`	`11`	`"io"`
`12`	`12`	`"os"`
`13`		`- "sort"`
	`13`	`+ "slices"`
`14`	`14`	`"strings"`
`15`	`15`
`16`	`16`	`cmds "github.com/ipfs/go-ipfs-cmds"`
`@@ -131,7 +131,7 @@ func cmdPathStrings(cmd *Command, showOptions bool) []string {`
`131`	`131`	`}`
`132`	`132`
`133`	`133`	`recurse("", cmd)`
`134`		`- sort.Strings(cmds)`
	`134`	`+ slices.Sort(cmds)`
`135`	`135`	`return cmds`
`136`	`136`	`}`
`137`	`137`