Make sorting more readable (#1128)

Author: nfx

clusters/data_node_type.go

@@ -2,7 +2,6 @@ package clusters
 
 import (
 	"context"
-	"sort"
 	"strings"
 
 	"github.com/databrickslabs/terraform-provider-databricks/common"
@@ -32,33 +31,21 @@ type NodeTypeList struct {
 
 // Sort NodeTypes within this struct
 func (l *NodeTypeList) Sort() {
-	sort.Slice(l.NodeTypes, func(i, j int) bool {
-		if l.NodeTypes[i].IsDeprecated != l.NodeTypes[j].IsDeprecated {
-			return !l.NodeTypes[i].IsDeprecated
+	sortByChain(l.NodeTypes, func(i int) sortCmp {
+		var localDisks, localDiskSizeGB int32
+		if l.NodeTypes[i].NodeInstanceType != nil {
+			localDisks = l.NodeTypes[i].NodeInstanceType.LocalDisks
+			localDiskSizeGB = l.NodeTypes[i].NodeInstanceType.LocalDiskSizeGB
+		}
+		return sortChain{
+			boolAsc(l.NodeTypes[i].IsDeprecated),
+			intAsc(localDisks),
+			intAsc(localDiskSizeGB),
+			intAsc(l.NodeTypes[i].MemoryMB),
+			intAsc(l.NodeTypes[i].NumCores),
+			intAsc(l.NodeTypes[i].NumGPUs),
+			strAsc(l.NodeTypes[i].InstanceTypeID),
 		}
-		if l.NodeTypes[i].NodeInstanceType != nil &&
-			l.NodeTypes[j].NodeInstanceType != nil {
-			if l.NodeTypes[i].NodeInstanceType.LocalDisks !=
-				l.NodeTypes[j].NodeInstanceType.LocalDisks {
-				return l.NodeTypes[i].NodeInstanceType.LocalDisks <
-					l.NodeTypes[j].NodeInstanceType.LocalDisks
-			}
-			if l.NodeTypes[i].NodeInstanceType.LocalDiskSizeGB !=
-				l.NodeTypes[j].NodeInstanceType.LocalDiskSizeGB {
-				return l.NodeTypes[i].NodeInstanceType.LocalDiskSizeGB <
-					l.NodeTypes[j].NodeInstanceType.LocalDiskSizeGB
-			}
-		}
-		if l.NodeTypes[i].MemoryMB != l.NodeTypes[j].MemoryMB {
-			return l.NodeTypes[i].MemoryMB < l.NodeTypes[j].MemoryMB
-		}
-		if l.NodeTypes[i].NumCores != l.NodeTypes[j].NumCores {
-			return l.NodeTypes[i].NumCores < l.NodeTypes[j].NumCores
-		}
-		if l.NodeTypes[i].NumGPUs != l.NodeTypes[j].NumGPUs {
-			return l.NodeTypes[i].NumGPUs < l.NodeTypes[j].NumGPUs
-		}
-		return l.NodeTypes[i].InstanceTypeID < l.NodeTypes[j].InstanceTypeID
 	})
 }
 

clusters/sort.go

@@ -0,0 +1,49 @@
+package clusters
+
+import (
+	"sort"
+)
+
+// readable chained sorting helper
+func sortByChain(s interface{}, fn func(int) sortCmp) {
+	sort.Slice(s, func(i, j int) bool {
+		return fn(i).Less(fn(j))
+	})
+}
+
+type sortCmp interface {
+	Less(o sortCmp) bool
+}
+
+type boolAsc bool
+
+func (b boolAsc) Less(o sortCmp) bool {
+	return bool(b) != bool(o.(boolAsc)) && !bool(b)
+}
+
+type intAsc int
+
+func (ia intAsc) Less(o sortCmp) bool {
+	return int(ia) < int(o.(intAsc))
+}
+
+type strAsc string
+
+func (s strAsc) Less(o sortCmp) bool {
+	return string(s) < string(o.(strAsc))
+}
+
+type sortChain []sortCmp
+
+func (c sortChain) Less(other sortCmp) bool {
+	o := other.(sortChain)
+	for i := range c {
+		if c[i].Less(o[i]) {
+			return true
+		}
+		if o[i].Less(c[i]) {
+			break
+		}
+	}
+	return false
+}