Merge pull request #919 from planetscale/dbussink/use-caching-sha2-password

dbussink · web-flow · commit 502e3aa25af6 · 2024-10-09T17:12:40.000+02:00
Switch shell / connect to use caching_sha2_password by default
diff --git a/Dockerfile b/Dockerfile
@@ -1,4 +1,4 @@
-FROM golang:1.23.1 as build
+FROM golang:1.23.2 as build
 WORKDIR /app
 COPY . .
 
diff --git a/Makefile b/Makefile
@@ -11,7 +11,7 @@ endif
 REPO=planetscale
 NAME=pscale
 BUILD_PKG=github.com/planetscale/cli/cmd/pscale
-GORELEASE_CROSS_VERSION ?= v1.23.1
+GORELEASE_CROSS_VERSION ?= v1.23.2
 SYFT_VERSION ?= 1.9.0
 
 .PHONY: all
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -2,7 +2,7 @@ version: '2'
 
 services:
   app:
-    image: golang:1.23.1
+    image: golang:1.23.2
     volumes:
       - .:/work
     working_dir: /work
diff --git a/docker/Dockerfile.goreleaser b/docker/Dockerfile.goreleaser
@@ -1,4 +1,4 @@
-ARG GORELEASE_CROSS_VERSION=v1.23.1
+ARG GORELEASE_CROSS_VERSION=v1.23.2
 FROM ghcr.io/goreleaser/goreleaser-cross:${GORELEASE_CROSS_VERSION}
 
 RUN apt-get update && apt-get install -y openssh-client
diff --git a/go.mod b/go.mod
@@ -1,6 +1,6 @@
 module github.com/planetscale/cli
 
-go 1.23.1
+go 1.23.2
 
 require (
 	github.com/99designs/keyring v1.2.2
@@ -23,9 +23,9 @@ 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.108.0
+	github.com/planetscale/planetscale-go v0.110.0
 	github.com/planetscale/psdb v0.0.0-20240109164348-6848e728f6e7
-	github.com/planetscale/psdbproxy v0.0.0-20240927190836-61feaf3c8bdb
+	github.com/planetscale/psdbproxy v0.0.0-20241009145102-7fdfa92ae3ca
 	github.com/spf13/cobra v1.8.1
 	github.com/spf13/pflag v1.0.5
 	github.com/spf13/viper v1.19.0
@@ -39,6 +39,7 @@ require (
 	golang.org/x/sys v0.26.0
 	golang.org/x/text v0.19.0
 	gopkg.in/yaml.v2 v2.4.0
+	vitess.io/vitess v0.10.3-0.20240927074858-3e5371377b43
 )
 
 require (
@@ -91,7 +92,6 @@ require (
 	gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c // indirect
 	gopkg.in/ini.v1 v1.67.0 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
-	vitess.io/vitess v0.10.3-0.20240927074858-3e5371377b43 // indirect
 )
 
 replace github.com/golang/glog => github.com/planetscale/noglog v0.2.1-0.20210421230640-bea75fcd2e8e
diff --git a/go.sum b/go.sum
@@ -114,12 +114,12 @@ 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.108.0 h1:KwLhKsntOO2yokjYxfBtUwHN9/n+c6PnYPbsibZ8jmE=
-github.com/planetscale/planetscale-go v0.108.0/go.mod h1:2s0/iqbBEBEL5k+3t0+eNztAU3bYxUynLQs4yLrKNDI=
+github.com/planetscale/planetscale-go v0.110.0 h1:iaS/4pbP/efBmLtzr+cH8gjhLy1OjAovOgSqL+Gbobk=
+github.com/planetscale/planetscale-go v0.110.0/go.mod h1:ldGffCLckkR8fjGDjDFs4WcjlDr8uqg2qRUZhRYBEMI=
 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-20240927190836-61feaf3c8bdb h1:eJqW2GfcbKOkUCNHBmHOIWrX4sIaYUJ9xljnlNYtVPQ=
-github.com/planetscale/psdbproxy v0.0.0-20240927190836-61feaf3c8bdb/go.mod h1:qxC4twwQwRjHb9lt2DB/Ny0CuhJs1rrxskPbBLDljgo=
+github.com/planetscale/psdbproxy v0.0.0-20241009145102-7fdfa92ae3ca h1:E5E1yyZ03FzA/6styZr5C2L3DdqhnkZsKSJy5q4JnuU=
+github.com/planetscale/psdbproxy v0.0.0-20241009145102-7fdfa92ae3ca/go.mod h1:qxC4twwQwRjHb9lt2DB/Ny0CuhJs1rrxskPbBLDljgo=
 github.com/planetscale/vitess-types v0.0.0-20231211191709-770e14433716 h1:FD6vnHCirVPeyn+E6Z0HyXoAqXzjfTcRpgss/63im6w=
 github.com/planetscale/vitess-types v0.0.0-20231211191709-770e14433716/go.mod h1:8KWsIjuUBs+xlbfn9wBCxicFZqV8BCPIFoqlOSs+60I=
 github.com/planetscale/vtprotobuf v0.6.1-0.20240319094008-0393e58bdf10 h1:GFCKgmp0tecUJ0sJuv4pzYCqS9+RGSn52M3FUwPs+uo=
diff --git a/internal/cmd/connect/connect.go b/internal/cmd/connect/connect.go
@@ -21,6 +21,8 @@ import (
 
 	"github.com/mattn/go-shellwords"
 	"github.com/spf13/cobra"
+
+	"vitess.io/vitess/go/mysql"
 )
 
 func ConnectCmd(ch *cmdutil.Helper) *cobra.Command {
@@ -34,6 +36,7 @@ func ConnectCmd(ch *cmdutil.Helper) *cobra.Command {
 		role                string
 		noRandom            bool
 		replica             bool
+		authMethod          string
 	}
 
 	cmd := &cobra.Command{
@@ -95,6 +98,18 @@ argument:
 				role = cmdutil.ReaderRole
 			}
 
+			authMethod := mysql.CachingSha2Password
+			if flags.authMethod != "" {
+				switch flags.authMethod {
+				case "caching_sha2_password":
+					authMethod = mysql.CachingSha2Password
+				case "mysql_native_password":
+					authMethod = mysql.MysqlNativePassword
+				default:
+					return fmt.Errorf("unsupported auth method: %s", flags.authMethod)
+				}
+			}
+
 			// check whether database and branch exist
 			dbBranch, err := client.DatabaseBranches.Get(ctx, &planetscale.GetDatabaseBranchRequest{
 				Organization: ch.Config.Organization,
@@ -156,7 +171,7 @@ argument:
 
 			errCh := make(chan error, 1)
 			go func() {
-				errCh <- proxy.Serve(l)
+				errCh <- proxy.Serve(l, authMethod)
 			}()
 
 			go func() {
@@ -215,6 +230,8 @@ argument:
 	cmd.PersistentFlags().StringVar(&flags.role, "role",
 		"", "Role defines the access level, allowed values are: reader, writer, readwriter, admin. Defaults to 'reader' for replica passwords, otherwise defaults to 'admin'.")
 	cmd.Flags().BoolVar(&flags.replica, "replica", false, "When enabled, the password will route all reads to the branch's primary replicas and all read-only regions.")
+	cmd.PersistentFlags().StringVar(&flags.authMethod, "mysql-auth-method",
+		"", "MySQL auth method defines the authentication method returned for the MySQL protocol. Allowed values are: caching_sha2_password, mysql_native_password. Defaults to 'caching_sha2_password'.")
 
 	return cmd
 }
diff --git a/internal/cmd/database/dump.go b/internal/cmd/database/dump.go
@@ -21,6 +21,8 @@ import (
 	_ "github.com/go-sql-driver/mysql"
 
 	"github.com/spf13/cobra"
+
+	"vitess.io/vitess/go/mysql"
 )
 
 type dumpFlags struct {
@@ -173,7 +175,10 @@ func dump(ch *cmdutil.Helper, cmd *cobra.Command, flags *dumpFlags, args []strin
 	defer l.Close()
 
 	go func() {
-		if err := proxy.Serve(l); err != nil {
+		// We have to use mysql.MysqlNativePassword here because we still end
+		// up using https://github.com/xelabs/go-mysqlstack which is unmaintained
+		// and doesn't support caching_sha2_password.
+		if err := proxy.Serve(l, mysql.MysqlNativePassword); err != nil {
 			ch.Printer.Println("proxy error: ", err)
 		}
 	}()
diff --git a/internal/cmd/database/restore.go b/internal/cmd/database/restore.go
@@ -15,6 +15,8 @@ import (
 	ps "github.com/planetscale/planetscale-go/planetscale"
 
 	"github.com/spf13/cobra"
+
+	"vitess.io/vitess/go/mysql"
 )
 
 type restoreFlags struct {
@@ -127,7 +129,7 @@ func restore(ch *cmdutil.Helper, cmd *cobra.Command, flags *restoreFlags, args [
 	defer l.Close()
 
 	go func() {
-		if err := proxy.Serve(l); err != nil {
+		if err := proxy.Serve(l, mysql.MysqlNativePassword); err != nil {
 			ch.Printer.Println("proxy error: ", err)
 		}
 	}()
diff --git a/internal/cmd/shell/shell.go b/internal/cmd/shell/shell.go
@@ -63,7 +63,7 @@ second argument:
 				runForeground = false
 			}
 
-			mysqlPath, err := cmdutil.MySQLClientPath()
+			mysqlPath, authMethod, err := cmdutil.MySQLClientPath()
 			if err != nil {
 				return err
 			}
@@ -210,7 +210,7 @@ second argument:
 
 			errCh := make(chan error, 1)
 			go func() {
-				errCh <- proxy.Serve(l)
+				errCh <- proxy.Serve(l, authMethod)
 			}()
 
 			go func() {
diff --git a/internal/cmdutil/cmdutil.go b/internal/cmdutil/cmdutil.go
@@ -5,7 +5,9 @@ import (
 	"fmt"
 	"os"
 	"path/filepath"
+	"regexp"
 	"runtime"
+	"strconv"
 	"strings"
 	"time"
 
@@ -18,6 +20,8 @@ import (
 	"go.uber.org/zap"
 	"go.uber.org/zap/zapcore"
 	exec "golang.org/x/sys/execabs"
+
+	"vitess.io/vitess/go/mysql"
 )
 
 const WarnAuthMessage = "not authenticated yet. Please run 'pscale auth login'"
@@ -166,10 +170,12 @@ func HasHomebrew() bool {
 	return err == nil
 }
 
+var versionRegex = regexp.MustCompile(`Ver ([0-9]+)\.([0-9]+)\.([0-9]+)`)
+
 // MySQLClientPath checks whether the 'mysql' client exists and returns the
 // path to the binary. The returned error contains instructions to install the
 // client.
-func MySQLClientPath() (string, error) {
+func MySQLClientPath() (string, mysql.AuthMethodDescription, error) {
 	// 'brew install mysql-client' installs the client into an unusual path
 	// https://docs.brew.sh/FAQ#why-should-i-install-homebrew-in-the-default-location
 	var homebrewPrefix string
@@ -183,30 +189,55 @@ func MySQLClientPath() (string, error) {
 		homebrewPrefix = "/home/linuxbrew/.linuxbrew"
 	}
 
+	authMethod := mysql.CachingSha2Password
 	oldpath := os.Getenv("PATH")
-	newpath := homebrewPrefix + "/opt/mysql-client/bin/" + string(os.PathListSeparator) + oldpath
+	newpath := homebrewPrefix + "/opt/mysql-client/bin/" +
+		homebrewPrefix + "/opt/mysql/bin/" +
+		string(os.PathListSeparator) + oldpath
 	defer func() {
 		if err := os.Setenv("PATH", oldpath); err != nil {
 			fmt.Println("failed to restore PATH", err)
 		}
 	}()
 
 	if err := os.Setenv("PATH", newpath); err != nil {
-		return "", err
+		return "", authMethod, err
 	}
 
 	path, err := exec.LookPath("mysql")
-	if err == nil {
-		return path, nil
+	if err != nil {
+		return installInstructions("couldn't find the 'mysql' command-line tool required to run this command.")
+	}
+
+	cmd := exec.Command("mysql", "--version")
+	out, err := cmd.Output()
+	if err != nil {
+		return "", authMethod, fmt.Errorf("failed to run 'mysql --version': %w", err)
+	}
+
+	v := versionRegex.FindStringSubmatch(string(out))
+	if len(v) != 4 {
+		return "", authMethod, fmt.Errorf("could not parse server version from: %s", string(out))
+	}
+	major, err := strconv.Atoi(v[1])
+	if err != nil {
+		return "", authMethod, fmt.Errorf("could not parse server version from: %s", string(out))
 	}
 
-	msg := "couldn't find the 'mysql' command-line tool required to run this command."
+	if major < 8 {
+		authMethod = mysql.MysqlNativePassword
+	}
+
+	return path, authMethod, nil
+}
+
+func installInstructions(msg string) (string, mysql.AuthMethodDescription, error) {
 	installURL := "https://planetscale.com/docs/reference/planetscale-environment-setup"
 
 	switch runtime.GOOS {
 	case "darwin":
 		if HasHomebrew() {
-			return "", fmt.Errorf("%s\nTo install, run: brew install mysql-client", msg)
+			return "", mysql.CachingSha2Password, fmt.Errorf("%s\nTo install, run: brew install mysql-client@8.4", msg)
 		}
 
 		installURL = "https://planetscale.com/docs/reference/planetscale-environment-setup#macos-instructions"
@@ -216,7 +247,7 @@ func MySQLClientPath() (string, error) {
 		installURL = "https://planetscale.com/docs/reference/planetscale-environment-setup#windows-instructions"
 	}
 
-	return "", fmt.Errorf("%s\nTo install, follow the instructions: %s", msg, installURL)
+	return "", mysql.CachingSha2Password, fmt.Errorf("%s\nTo install, follow the instructions: %s", msg, installURL)
 }
 
 func ParseSSLMode(sslMode string) ps.ExternalDataSourceSSLVerificationMode {
diff --git a/internal/mock/keyspace.go b/internal/mock/keyspace.go
@@ -21,6 +21,15 @@ type BranchKeyspacesService struct {
 
 	CreateFn        func(context.Context, *ps.CreateBranchKeyspaceRequest) (*ps.Keyspace, error)
 	CreateFnInvoked bool
+
+	ResizeFn      func(context.Context, *ps.ResizeKeyspaceRequest) (*ps.KeyspaceResizeRequest, error)
+	ResizeInvoked bool
+
+	CancelResizeFn      func(context.Context, *ps.CancelKeyspaceResizeRequest) error
+	CancelResizeInvoked bool
+
+	ResizeStatusFn      func(context.Context, *ps.KeyspaceResizeStatusRequest) (*ps.KeyspaceResizeRequest, error)
+	ResizeStatusInvoked bool
 }
 
 func (s *BranchKeyspacesService) List(ctx context.Context, req *ps.ListBranchKeyspacesRequest) ([]*ps.Keyspace, error) {
@@ -48,3 +57,18 @@ func (s *BranchKeyspacesService) Create(ctx context.Context, req *ps.CreateBranc
 	s.CreateFnInvoked = true
 	return s.CreateFn(ctx, req)
 }
+
+func (s *BranchKeyspacesService) Resize(ctx context.Context, req *ps.ResizeKeyspaceRequest) (*ps.KeyspaceResizeRequest, error) {
+	s.ResizeInvoked = true
+	return s.ResizeFn(ctx, req)
+}
+
+func (s *BranchKeyspacesService) CancelResize(ctx context.Context, req *ps.CancelKeyspaceResizeRequest) error {
+	s.CancelResizeInvoked = true
+	return s.CancelResizeFn(ctx, req)
+}
+
+func (s *BranchKeyspacesService) ResizeStatus(ctx context.Context, req *ps.KeyspaceResizeStatusRequest) (*ps.KeyspaceResizeRequest, error) {
+	s.ResizeStatusInvoked = true
+	return s.ResizeStatusFn(ctx, req)
+}

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-FROM golang:1.23.1 as build`
	`1`	`+FROM golang:1.23.2 as build`
`2`	`2`	`WORKDIR /app`
`3`	`3`	`COPY . .`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-ARG GORELEASE_CROSS_VERSION=v1.23.1`
	`1`	`+ARG GORELEASE_CROSS_VERSION=v1.23.2`
`2`	`2`	`FROM ghcr.io/goreleaser/goreleaser-cross:${GORELEASE_CROSS_VERSION}`
`3`	`3`
`4`	`4`	`RUN apt-get update && apt-get install -y openssh-client`
Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,8 @@ import (`
`15`	`15`	`ps "github.com/planetscale/planetscale-go/planetscale"`
`16`	`16`
`17`	`17`	`"github.com/spf13/cobra"`
	`18`	`+`
	`19`	`+ "vitess.io/vitess/go/mysql"`
`18`	`20`	`)`
`19`	`21`
`20`	`22`	`type restoreFlags struct {`
`@@ -127,7 +129,7 @@ func restore(ch cmdutil.Helper, cmd cobra.Command, flags *restoreFlags, args [`
`127`	`129`	`defer l.Close()`
`128`	`130`
`129`	`131`	`go func() {`
`130`		`- if err := proxy.Serve(l); err != nil {`
	`132`	`+ if err := proxy.Serve(l, mysql.MysqlNativePassword); err != nil {`
`131`	`133`	`ch.Printer.Println("proxy error: ", err)`
`132`	`134`	`}`
`133`	`135`	`}()`
Original file line number	Diff line number	Diff line change
`@@ -63,7 +63,7 @@ second argument:`
`63`	`63`	`runForeground = false`
`64`	`64`	`}`
`65`	`65`
`66`		`- mysqlPath, err := cmdutil.MySQLClientPath()`
	`66`	`+ mysqlPath, authMethod, err := cmdutil.MySQLClientPath()`
`67`	`67`	`if err != nil {`
`68`	`68`	`return err`
`69`	`69`	`}`
`@@ -210,7 +210,7 @@ second argument:`
`210`	`210`
`211`	`211`	`errCh := make(chan error, 1)`
`212`	`212`	`go func() {`
`213`		`- errCh <- proxy.Serve(l)`
	`213`	`+ errCh <- proxy.Serve(l, authMethod)`
`214`	`214`	`}()`
`215`	`215`
`216`	`216`	`go func() {`