Add --metal flag for filtering cluster SKUs (#990)

iheanyi · web-flow · commit 72ea24910176 · 2025-03-14T17:26:19.000Z
* Update planetscale-go

* Add metal and standard flags to size.

* Remove ClusterSize typing

* Use network instead of standard

* Only have a metal flag

* Fix conditional
diff --git a/go.mod b/go.mod
@@ -23,7 +23,7 @@ require (
 	github.com/mitchellh/go-homedir v1.1.0
 	github.com/pkg/browser v0.0.0-20240102092130-5ac0b6a4141c
 	github.com/pkg/errors v0.9.1
-	github.com/planetscale/planetscale-go v0.124.0
+	github.com/planetscale/planetscale-go v0.125.0
 	github.com/planetscale/psdb v0.0.0-20240109164348-6848e728f6e7
 	github.com/planetscale/psdbproxy v0.0.0-20250117221522-0c8e2b0e36e6
 	github.com/spf13/cobra v1.9.1
@@ -34,7 +34,7 @@ require (
 	go.uber.org/zap v1.27.0
 	go.uber.org/zap/exp v0.3.0
 	golang.org/x/exp v0.0.0-20240909161429-701f63a606c0
-	golang.org/x/oauth2 v0.27.0
+	golang.org/x/oauth2 v0.28.0
 	golang.org/x/sync v0.11.0
 	golang.org/x/sys v0.30.0
 	golang.org/x/text v0.22.0
diff --git a/go.sum b/go.sum
@@ -114,8 +114,8 @@ github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4=
 github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
 github.com/planetscale/noglog v0.2.1-0.20210421230640-bea75fcd2e8e h1:MZ8D+Z3m2vvqGZLvoQfpaGg/j1fNDr4j03s3PRz4rVY=
 github.com/planetscale/noglog v0.2.1-0.20210421230640-bea75fcd2e8e/go.mod h1:hwAsSPQdvPa3WcfKfzTXxtEq/HlqwLjQasfO6QbGo4Q=
-github.com/planetscale/planetscale-go v0.124.0 h1:WiPPBEJ0fpg9D9+X+lQC0i7Knb6cQ3yO38Xe90O/qwQ=
-github.com/planetscale/planetscale-go v0.124.0/go.mod h1:HXOe9UNFb71w9XIICJj5ncwuY25h2Bng/KrXH80GF0s=
+github.com/planetscale/planetscale-go v0.125.0 h1:+R8ZZ0nW+HZhFJGU9IQQxREXM9r7YX6u+S61mFkUWDs=
+github.com/planetscale/planetscale-go v0.125.0/go.mod h1:/9cIDXvqglfjCRPzPNP6BklL+J7qq50SKtAP97c4ix0=
 github.com/planetscale/psdb v0.0.0-20240109164348-6848e728f6e7 h1:dxdoFKWVDlV1gq8UQC8NWCofLjCEjEHw47gfeojgs28=
 github.com/planetscale/psdb v0.0.0-20240109164348-6848e728f6e7/go.mod h1:WZmi4gw3rOK+ryd1inGxgfKwoFV04O7xBCqzWzv0/0U=
 github.com/planetscale/psdbproxy v0.0.0-20250117221522-0c8e2b0e36e6 h1:/Ox1ZTAdk+soSngzzKoJh5voOzptrpPrux11o30rIaw=
@@ -187,8 +187,8 @@ golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v
 golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c=
 golang.org/x/net v0.29.0 h1:5ORfpBpCs4HzDYoodCDBbwHzdR5UrLBZ3sOnUJmFoHo=
 golang.org/x/net v0.29.0/go.mod h1:gLkgy8jTGERgjzMic6DS9+SP0ajcu6Xu3Orq/SpETg0=
-golang.org/x/oauth2 v0.27.0 h1:da9Vo7/tDv5RH/7nZDz1eMGS/q1Vv1N/7FCrBhI9I3M=
-golang.org/x/oauth2 v0.27.0/go.mod h1:onh5ek6nERTohokkhCD/y2cV4Do3fxFHFuAejCkRWT8=
+golang.org/x/oauth2 v0.28.0 h1:CrgCKl8PPAVtLnU3c+EDw6x11699EWlsDeWNWKdIOkc=
+golang.org/x/oauth2 v0.28.0/go.mod h1:onh5ek6nERTohokkhCD/y2cV4Do3fxFHFuAejCkRWT8=
 golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
 golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
 golang.org/x/sync v0.11.0 h1:GGz8+XQP4FvTTrjZPzNKTMFtSXH80RAzG+5ghFPgK9w=
diff --git a/internal/cmd/database/create.go b/internal/cmd/database/create.go
@@ -27,7 +27,7 @@ func CreateCmd(ch *cmdutil.Helper) *cobra.Command {
 				return err
 			}
 
-			createReq.ClusterSize = ps.ClusterSize(clusterSize)
+			createReq.ClusterSize = clusterSize
 
 			createReq.Organization = ch.Config.Organization
 			createReq.Name = args[0]
diff --git a/internal/cmd/keyspace/create.go b/internal/cmd/keyspace/create.go
@@ -33,7 +33,7 @@ func CreateCmd(ch *cmdutil.Helper) *cobra.Command {
 			createReq.Name = keyspace
 			createReq.Shards = flags.shards
 			createReq.ExtraReplicas = flags.additionalReplicas
-			createReq.ClusterSize = planetscale.ClusterSize(flags.clusterSize)
+			createReq.ClusterSize = flags.clusterSize
 
 			client, err := ch.Client()
 			if err != nil {
diff --git a/internal/cmd/keyspace/create_test.go b/internal/cmd/keyspace/create_test.go
@@ -30,7 +30,7 @@ func TestKeyspace_CreateCmd(t *testing.T) {
 	ks := &ps.Keyspace{
 		ID:          "wantid",
 		Name:        keyspace,
-		ClusterSize: ps.ClusterSize("PS-20"),
+		ClusterSize: "PS-20",
 		Replicas:    3,
 		Shards:      2,
 	}
@@ -41,7 +41,7 @@ func TestKeyspace_CreateCmd(t *testing.T) {
 			c.Assert(req.Organization, qt.Equals, org)
 			c.Assert(req.Branch, qt.Equals, branch)
 			c.Assert(req.Name, qt.Equals, keyspace)
-			c.Assert(req.ClusterSize, qt.Equals, ps.ClusterSize("PS-20"))
+			c.Assert(req.ClusterSize, qt.Equals, "PS-20")
 			c.Assert(req.ExtraReplicas, qt.Equals, 1)
 			c.Assert(req.Shards, qt.Equals, 2)
 
@@ -86,7 +86,7 @@ func TestKeyspace_CreateCmdOnlyClusterSize(t *testing.T) {
 	ks := &ps.Keyspace{
 		ID:            "wantid",
 		Name:          keyspace,
-		ClusterSize:   ps.ClusterSize("PS-10"),
+		ClusterSize:   "PS-10",
 		Replicas:      2,
 		ExtraReplicas: 0,
 		Shards:        1,
@@ -98,7 +98,7 @@ func TestKeyspace_CreateCmdOnlyClusterSize(t *testing.T) {
 			c.Assert(req.Organization, qt.Equals, org)
 			c.Assert(req.Branch, qt.Equals, branch)
 			c.Assert(req.Name, qt.Equals, keyspace)
-			c.Assert(req.ClusterSize, qt.Equals, ps.ClusterSize("PS-10"))
+			c.Assert(req.ClusterSize, qt.Equals, "PS-10")
 			c.Assert(req.ExtraReplicas, qt.Equals, 0)
 			c.Assert(req.Shards, qt.Equals, 1)
 
diff --git a/internal/cmd/keyspace/resize.go b/internal/cmd/keyspace/resize.go
@@ -56,7 +56,7 @@ func ResizeCmd(ch *cmdutil.Helper) *cobra.Command {
 			}
 
 			if cmd.Flags().Changed("cluster-size") {
-				size := ps.ClusterSize(flags.clusterSize)
+				size := flags.clusterSize
 				resizeReq.ClusterSize = &size
 			}
 
diff --git a/internal/cmd/keyspace/resize_test.go b/internal/cmd/keyspace/resize_test.go
@@ -45,7 +45,7 @@ func TestKeyspace_ResizeCmd(t *testing.T) {
 			c.Assert(req.Branch, qt.Equals, branch)
 			c.Assert(req.Keyspace, qt.Equals, keyspace)
 			c.Assert(*req.ExtraReplicas, qt.Equals, uint(3))
-			c.Assert(*req.ClusterSize, qt.Equals, ps.ClusterSize("PS_10"))
+			c.Assert(*req.ClusterSize, qt.Equals, "PS_10")
 
 			return krr, nil
 		},
@@ -102,7 +102,7 @@ func TestKeyspace_ResizeCmdOnlyClusterSize(t *testing.T) {
 			c.Assert(req.Branch, qt.Equals, branch)
 			c.Assert(req.Keyspace, qt.Equals, keyspace)
 			c.Assert(req.ExtraReplicas, qt.IsNil)
-			c.Assert(*req.ClusterSize, qt.Equals, ps.ClusterSize("PS_10"))
+			c.Assert(*req.ClusterSize, qt.Equals, "PS_10")
 
 			return krr, nil
 		},
diff --git a/internal/cmd/size/cluster.go b/internal/cmd/size/cluster.go
@@ -26,6 +26,7 @@ func ClusterCmd(ch *cmdutil.Helper) *cobra.Command {
 func ListCmd(ch *cmdutil.Helper) *cobra.Command {
 	var flags struct {
 		region string
+		metal  bool
 	}
 
 	cmd := &cobra.Command{
@@ -47,11 +48,12 @@ func ListCmd(ch *cmdutil.Helper) *cobra.Command {
 				return err
 			}
 
-			return ch.Printer.PrintResource(toClusterSKUs(clusterSKUs))
+			return ch.Printer.PrintResource(toClusterSKUs(clusterSKUs, flags.metal))
 		},
 	}
 
 	cmd.Flags().StringVar(&flags.region, "region", "", "view cluster sizes and rates for a specific region")
+	cmd.Flags().BoolVar(&flags.metal, "metal", false, "view cluster sizes and rates for clusters with metal storage")
 
 	cmd.RegisterFlagCompletionFunc("region", func(cmd *cobra.Command, args []string, toComplete string) ([]cobra.Completion, cobra.ShellCompDirective) {
 		return cmdutil.RegionsCompletionFunc(ch, cmd, args, toComplete)
@@ -103,12 +105,18 @@ func toClusterSKU(clusterSKU *planetscale.ClusterSKU) *ClusterSKU {
 	return cluster
 }
 
-func toClusterSKUs(clusterSKUs []*planetscale.ClusterSKU) []*ClusterSKU {
+func toClusterSKUs(clusterSKUs []*planetscale.ClusterSKU, onlyMetal bool) []*ClusterSKU {
 	clusters := make([]*ClusterSKU, 0, len(clusterSKUs))
 
 	for _, clusterSKU := range clusterSKUs {
 		if clusterSKU.Enabled && clusterSKU.Rate != nil && clusterSKU.Name != "PS_DEV" {
-			clusters = append(clusters, toClusterSKU(clusterSKU))
+			if onlyMetal {
+				if clusterSKU.Metal {
+					clusters = append(clusters, toClusterSKU(clusterSKU))
+				}
+			} else {
+				clusters = append(clusters, toClusterSKU(clusterSKU))
+			}
 		}
 	}
 
diff --git a/internal/cmdutil/cmdutil.go b/internal/cmdutil/cmdutil.go
@@ -296,8 +296,8 @@ func DeployRequestBranchToNumber(ctx context.Context, client *ps.Client, organiz
 	return deployRequests[0].Number, nil
 }
 
-func ToClusterSizeSlug(c ps.ClusterSize) string {
-	return strings.ReplaceAll(string(c), "_", "-")
+func ToClusterSizeSlug(c string) string {
+	return strings.ReplaceAll(c, "_", "-")
 }
 
 func SnakeToSentenceCase(s string) string {

Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ func CreateCmd(ch cmdutil.Helper) cobra.Command {`
`27`	`27`	`return err`
`28`	`28`	`}`
`29`	`29`
`30`		`- createReq.ClusterSize = ps.ClusterSize(clusterSize)`
	`30`	`+ createReq.ClusterSize = clusterSize`
`31`	`31`
`32`	`32`	`createReq.Organization = ch.Config.Organization`
`33`	`33`	`createReq.Name = args[0]`
Original file line number	Diff line number	Diff line change
`@@ -56,7 +56,7 @@ func ResizeCmd(ch cmdutil.Helper) cobra.Command {`
`56`	`56`	`}`
`57`	`57`
`58`	`58`	`if cmd.Flags().Changed("cluster-size") {`
`59`		`- size := ps.ClusterSize(flags.clusterSize)`
	`59`	`+ size := flags.clusterSize`
`60`	`60`	`resizeReq.ClusterSize = &size`
`61`	`61`	`}`
`62`	`62`
Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,7 @@ func ClusterCmd(ch cmdutil.Helper) cobra.Command {`
`26`	`26`	`func ListCmd(ch cmdutil.Helper) cobra.Command {`
`27`	`27`	`var flags struct {`
`28`	`28`	`region string`
	`29`	`+ metal bool`
`29`	`30`	`}`
`30`	`31`
`31`	`32`	`cmd := &cobra.Command{`
`@@ -47,11 +48,12 @@ func ListCmd(ch cmdutil.Helper) cobra.Command {`
`47`	`48`	`return err`
`48`	`49`	`}`
`49`	`50`
`50`		`- return ch.Printer.PrintResource(toClusterSKUs(clusterSKUs))`
	`51`	`+ return ch.Printer.PrintResource(toClusterSKUs(clusterSKUs, flags.metal))`
`51`	`52`	`},`
`52`	`53`	`}`
`53`	`54`
`54`	`55`	`cmd.Flags().StringVar(&flags.region, "region", "", "view cluster sizes and rates for a specific region")`
	`56`	`+ cmd.Flags().BoolVar(&flags.metal, "metal", false, "view cluster sizes and rates for clusters with metal storage")`
`55`	`57`
`56`	`58`	`cmd.RegisterFlagCompletionFunc("region", func(cmd *cobra.Command, args []string, toComplete string) ([]cobra.Completion, cobra.ShellCompDirective) {`
`57`	`59`	`return cmdutil.RegionsCompletionFunc(ch, cmd, args, toComplete)`
`@@ -103,12 +105,18 @@ func toClusterSKU(clusterSKU planetscale.ClusterSKU) ClusterSKU {`
`103`	`105`	`return cluster`
`104`	`106`	`}`
`105`	`107`
`106`		`-func toClusterSKUs(clusterSKUs []planetscale.ClusterSKU) []ClusterSKU {`
	`108`	`+func toClusterSKUs(clusterSKUs []planetscale.ClusterSKU, onlyMetal bool) []ClusterSKU {`
`107`	`109`	`clusters := make([]*ClusterSKU, 0, len(clusterSKUs))`
`108`	`110`
`109`	`111`	`for _, clusterSKU := range clusterSKUs {`
`110`	`112`	`if clusterSKU.Enabled && clusterSKU.Rate != nil && clusterSKU.Name != "PS_DEV" {`
`111`		`- clusters = append(clusters, toClusterSKU(clusterSKU))`
	`113`	`+ if onlyMetal {`
	`114`	`+ if clusterSKU.Metal {`
	`115`	`+ clusters = append(clusters, toClusterSKU(clusterSKU))`
	`116`	`+ }`
	`117`	`+ } else {`
	`118`	`+ clusters = append(clusters, toClusterSKU(clusterSKU))`
	`119`	`+ }`
`112`	`120`	`}`
`113`	`121`	`}`
`114`	`122`
Original file line number	Diff line number	Diff line change
`@@ -296,8 +296,8 @@ func DeployRequestBranchToNumber(ctx context.Context, client *ps.Client, organiz`
`296`	`296`	`return deployRequests[0].Number, nil`
`297`	`297`	`}`
`298`	`298`
`299`		`-func ToClusterSizeSlug(c ps.ClusterSize) string {`
`300`		`- return strings.ReplaceAll(string(c), "_", "-")`
	`299`	`+func ToClusterSizeSlug(c string) string {`
	`300`	`+ return strings.ReplaceAll(c, "_", "-")`
`301`	`301`	`}`
`302`	`302`
`303`	`303`	`func SnakeToSentenceCase(s string) string {`