cmd: improved error handling to catch malformed responses

This PR uses the newly added `*planetscale.Error` and its various new error codes (see: planetscale/planetscale-go#38). The following improvement was made: * We introduced a new helper function, called `cmdutil.ErrCode()` that returns the `planetscale.ErrorCode` if the error type is `*planetscale.Error`. This is handy function that let us type switch on the `planetscale.ErrorCode` type. * We introduced a new `cmdutil.MalformedError` function that returns a human readable error message if the API returns any response that is not JSON. This is usually and indication the API is down and we receive 5xx HTML content from the LB or other intermediate proxies. * I went over all Client calls made to the API and we now fully cover every single call. We make sure to handle for `ErrNotFound` errors also to handle `ErrResponseMalformed` responses. depends on: #145 closes: planetscale/surfaces#148
planetscale · Apr 6, 2021 · dae6c80 · dae6c80
1 parent 717bf7e
commit dae6c80
Show file tree

Hide file tree

Showing 37 changed files with 334 additions and 61 deletions.
diff --git a/internal/cmd/backup/create.go b/internal/cmd/backup/create.go
@@ -7,6 +7,7 @@ import (
 	"github.com/planetscale/cli/internal/cmdutil"
 	"github.com/planetscale/cli/internal/config"
 	"github.com/planetscale/cli/internal/printer"
+	"github.com/planetscale/planetscale-go/planetscale"
 	ps "github.com/planetscale/planetscale-go/planetscale"
 
 	"github.com/spf13/cobra"
@@ -37,10 +38,14 @@ func CreateCmd(cfg *config.Config) *cobra.Command {
 			defer end()
 			backup, err := client.Backups.Create(ctx, createReq)
 			if err != nil {
-				if cmdutil.IsNotFoundError(err) {
+				switch cmdutil.ErrCode(err) {
+				case planetscale.ErrNotFound:
 					return fmt.Errorf("%s does not exist in %s", cmdutil.BoldBlue(branch), cmdutil.BoldBlue(database))
+				case planetscale.ErrResponseMalformed:
+					return cmdutil.MalformedError(err)
+				default:
+					return err
 				}
-				return err
 			}
 
 			end()

diff --git a/internal/cmd/backup/delete.go b/internal/cmd/backup/delete.go
@@ -72,10 +72,14 @@ func DeleteCmd(cfg *config.Config) *cobra.Command {
 				Backup:       backup,
 			})
 			if err != nil {
-				if cmdutil.IsNotFoundError(err) {
+				switch cmdutil.ErrCode(err) {
+				case planetscale.ErrNotFound:
 					return fmt.Errorf("%s does not exist in branch %s of %s\n", cmdutil.BoldBlue(backup), cmdutil.BoldBlue(branch), cmdutil.BoldBlue(database))
+				case planetscale.ErrResponseMalformed:
+					return cmdutil.MalformedError(err)
+				default:
+					return err
 				}
-				return err
 			}
 
 			end()

diff --git a/internal/cmd/backup/get.go b/internal/cmd/backup/get.go
@@ -59,10 +59,14 @@ func GetCmd(cfg *config.Config) *cobra.Command {
 			end()
 			err = printer.PrintOutput(cfg.OutputJSON, printer.NewBackupPrinter(b))
 			if err != nil {
-				if cmdutil.IsNotFoundError(err) {
+				switch cmdutil.ErrCode(err) {
+				case planetscale.ErrNotFound:
 					return fmt.Errorf("%s does not exist in branch %s of %s\n", cmdutil.BoldBlue(backup), cmdutil.BoldBlue(branch), cmdutil.BoldBlue(database))
+				case planetscale.ErrResponseMalformed:
+					return cmdutil.MalformedError(err)
+				default:
+					return err
 				}
-				return err
 			}
 
 			return nil

diff --git a/internal/cmd/backup/list.go b/internal/cmd/backup/list.go
@@ -53,10 +53,14 @@ func ListCmd(cfg *config.Config) *cobra.Command {
 				Branch:       branch,
 			})
 			if err != nil {
-				if cmdutil.IsNotFoundError(err) {
+				switch cmdutil.ErrCode(err) {
+				case planetscale.ErrNotFound:
 					return fmt.Errorf("%s does not exist in %s\n", cmdutil.BoldBlue(branch), cmdutil.BoldBlue(database))
+				case planetscale.ErrResponseMalformed:
+					return cmdutil.MalformedError(err)
+				default:
+					return errors.Wrap(err, "error listing backups")
 				}
-				return errors.Wrap(err, "error listing backups")
 			}
 			end()
 

diff --git a/internal/cmd/branch/create.go b/internal/cmd/branch/create.go
@@ -9,6 +9,7 @@ import (
 	"github.com/planetscale/cli/internal/cmdutil"
 	"github.com/planetscale/cli/internal/config"
 	"github.com/planetscale/cli/internal/printer"
+	"github.com/planetscale/planetscale-go/planetscale"
 	ps "github.com/planetscale/planetscale-go/planetscale"
 	"github.com/spf13/cobra"
 )
@@ -63,10 +64,14 @@ func CreateCmd(cfg *config.Config) *cobra.Command {
 			defer end()
 			dbBranch, err := client.DatabaseBranches.Create(ctx, createReq)
 			if err != nil {
-				if cmdutil.IsNotFoundError(err) {
+				switch cmdutil.ErrCode(err) {
+				case planetscale.ErrNotFound:
 					return fmt.Errorf("%s does not exist in %s\n", cmdutil.BoldBlue(source), cmdutil.BoldBlue(cfg.Organization))
+				case planetscale.ErrResponseMalformed:
+					return cmdutil.MalformedError(err)
+				default:
+					return err
 				}
-				return err
 			}
 
 			end()

diff --git a/internal/cmd/branch/delete.go b/internal/cmd/branch/delete.go
@@ -70,10 +70,14 @@ func DeleteCmd(cfg *config.Config) *cobra.Command {
 				Branch:       branch,
 			})
 			if err != nil {
-				if cmdutil.IsNotFoundError(err) {
-					return fmt.Errorf("%s does not exist in %s", cmdutil.BoldBlue(branch), cmdutil.BoldBlue(source))
+				switch cmdutil.ErrCode(err) {
+				case planetscale.ErrNotFound:
+					return fmt.Errorf("%s does not exist in %s\n", cmdutil.BoldBlue(source), cmdutil.BoldBlue(cfg.Organization))
+				case planetscale.ErrResponseMalformed:
+					return cmdutil.MalformedError(err)
+				default:
+					return err
 				}
-				return err
 			}
 
 			end()

diff --git a/internal/cmd/branch/get.go b/internal/cmd/branch/get.go
@@ -51,10 +51,14 @@ func GetCmd(cfg *config.Config) *cobra.Command {
 				Branch:       branch,
 			})
 			if err != nil {
-				if cmdutil.IsNotFoundError(err) {
+				switch cmdutil.ErrCode(err) {
+				case planetscale.ErrNotFound:
 					return fmt.Errorf("%s does not exist in %s", cmdutil.BoldBlue(branch), cmdutil.BoldBlue(source))
+				case planetscale.ErrResponseMalformed:
+					return cmdutil.MalformedError(err)
+				default:
+					return err
 				}
-				return err
 			}
 
 			end()

diff --git a/internal/cmd/branch/list.go b/internal/cmd/branch/list.go
@@ -51,10 +51,14 @@ func ListCmd(cfg *config.Config) *cobra.Command {
 				Database:     database,
 			})
 			if err != nil {
-				if cmdutil.IsNotFoundError(err) {
+				switch cmdutil.ErrCode(err) {
+				case planetscale.ErrNotFound:
 					return fmt.Errorf("%s does not exist in %s\n", cmdutil.BoldBlue(database), cmdutil.BoldBlue(cfg.Organization))
+				case planetscale.ErrResponseMalformed:
+					return cmdutil.MalformedError(err)
+				default:
+					return errors.Wrap(err, "error listing branches")
 				}
-				return errors.Wrap(err, "error listing branches")
 			}
 			end()
 

diff --git a/internal/cmd/branch/status.go b/internal/cmd/branch/status.go
@@ -37,10 +37,15 @@ func StatusCmd(cfg *config.Config) *cobra.Command {
 				Branch:       branch,
 			})
 			if err != nil {
-				if cmdutil.IsNotFoundError(err) {
+				switch cmdutil.ErrCode(err) {
+				case planetscale.ErrNotFound:
 					return fmt.Errorf("%s does not exist in %s", cmdutil.BoldBlue(branch), cmdutil.BoldBlue(source))
+				case planetscale.ErrResponseMalformed:
+					return cmdutil.MalformedError(err)
+				default:
+					return err
 				}
-				return err
+
 			}
 
 			end()

diff --git a/internal/cmd/database/create.go b/internal/cmd/database/create.go
@@ -9,6 +9,7 @@ import (
 	"github.com/planetscale/cli/internal/config"
 	"github.com/planetscale/cli/internal/printer"
 
+	"github.com/planetscale/planetscale-go/planetscale"
 	ps "github.com/planetscale/planetscale-go/planetscale"
 
 	"github.com/pkg/browser"
@@ -51,7 +52,14 @@ func CreateCmd(cfg *config.Config) *cobra.Command {
 			defer end()
 			database, err := client.Databases.Create(ctx, createReq)
 			if err != nil {
-				return err
+				switch cmdutil.ErrCode(err) {
+				case planetscale.ErrNotFound:
+					return fmt.Errorf("%s does not exist in\n", cmdutil.BoldBlue(cfg.Organization))
+				case planetscale.ErrResponseMalformed:
+					return cmdutil.MalformedError(err)
+				default:
+					return err
+				}
 			}
 
 			end()

diff --git a/internal/cmd/database/delete.go b/internal/cmd/database/delete.go
@@ -68,10 +68,14 @@ func DeleteCmd(cfg *config.Config) *cobra.Command {
 				Database:     name,
 			})
 			if err != nil {
-				if cmdutil.IsNotFoundError(err) {
+				switch cmdutil.ErrCode(err) {
+				case planetscale.ErrNotFound:
 					return fmt.Errorf("%s does not exist in %s\n", cmdutil.BoldBlue(name), cmdutil.BoldBlue(cfg.Organization))
+				case planetscale.ErrResponseMalformed:
+					return cmdutil.MalformedError(err)
+				default:
+					return err
 				}
-				return err
 			}
 
 			end()

diff --git a/internal/cmd/database/get.go b/internal/cmd/database/get.go
@@ -49,10 +49,14 @@ func GetCmd(cfg *config.Config) *cobra.Command {
 				Database:     name,
 			})
 			if err != nil {
-				if cmdutil.IsNotFoundError(err) {
+				switch cmdutil.ErrCode(err) {
+				case planetscale.ErrNotFound:
 					return fmt.Errorf("%s does not exist in %s\n", cmdutil.BoldBlue(name), cmdutil.BoldBlue(cfg.Organization))
+				case planetscale.ErrResponseMalformed:
+					return cmdutil.MalformedError(err)
+				default:
+					return err
 				}
-				return err
 			}
 
 			end()

diff --git a/internal/cmd/database/list.go b/internal/cmd/database/list.go
@@ -48,7 +48,14 @@ func ListCmd(cfg *config.Config) *cobra.Command {
 				Organization: cfg.Organization,
 			})
 			if err != nil {
-				return errors.Wrap(err, "error listing databases")
+				switch cmdutil.ErrCode(err) {
+				case planetscale.ErrNotFound:
+					return fmt.Errorf("%s does not exist\n", cmdutil.BoldBlue(cfg.Organization))
+				case planetscale.ErrResponseMalformed:
+					return cmdutil.MalformedError(err)
+				default:
+					return errors.Wrap(err, "error listing databases")
+				}
 			}
 
 			end()

diff --git a/internal/cmd/deployrequest/close.go b/internal/cmd/deployrequest/close.go
@@ -39,7 +39,15 @@ func CloseCmd(cfg *config.Config) *cobra.Command {
 				Number:       n,
 			})
 			if err != nil {
-				return err
+				switch cmdutil.ErrCode(err) {
+				case planetscale.ErrNotFound:
+					return fmt.Errorf("%s/%s does not exist in %s\n",
+						cmdutil.BoldBlue(database), cmdutil.BoldBlue(number), cmdutil.BoldBlue(cfg.Organization))
+				case planetscale.ErrResponseMalformed:
+					return cmdutil.MalformedError(err)
+				default:
+					return err
+				}
 			}
 
 			fmt.Printf("Deploy request %s/%s was successfully closed!\n",

diff --git a/internal/cmd/deployrequest/create.go b/internal/cmd/deployrequest/create.go
@@ -42,7 +42,15 @@ func CreateCmd(cfg *config.Config) *cobra.Command {
 				IntoBranch:   flags.deployTo,
 			})
 			if err != nil {
-				return err
+				switch cmdutil.ErrCode(err) {
+				case planetscale.ErrNotFound:
+					return fmt.Errorf("%s does not exist in %s\n",
+						cmdutil.BoldBlue(database), cmdutil.BoldBlue(cfg.Organization))
+				case planetscale.ErrResponseMalformed:
+					return cmdutil.MalformedError(err)
+				default:
+					return err
+				}
 			}
 			end()
 

diff --git a/internal/cmd/deployrequest/deploy.go b/internal/cmd/deployrequest/deploy.go
@@ -40,7 +40,15 @@ func DeployCmd(cfg *config.Config) *cobra.Command {
 				Number:       n,
 			})
 			if err != nil {
-				return err
+				switch cmdutil.ErrCode(err) {
+				case planetscale.ErrNotFound:
+					return fmt.Errorf("%s/%s does not exist in %s\n",
+						cmdutil.BoldBlue(database), cmdutil.BoldBlue(number), cmdutil.BoldBlue(cfg.Organization))
+				case planetscale.ErrResponseMalformed:
+					return cmdutil.MalformedError(err)
+				default:
+					return err
+				}
 			}
 
 			if cfg.OutputJSON {

diff --git a/internal/cmd/deployrequest/diff.go b/internal/cmd/deployrequest/diff.go
@@ -53,7 +53,15 @@ func DiffCmd(cfg *config.Config) *cobra.Command {
 				Number:       n,
 			})
 			if err != nil {
-				return err
+				switch cmdutil.ErrCode(err) {
+				case planetscale.ErrNotFound:
+					return fmt.Errorf("%s/%s does not exist in %s\n",
+						cmdutil.BoldBlue(database), cmdutil.BoldBlue(number), cmdutil.BoldBlue(cfg.Organization))
+				case planetscale.ErrResponseMalformed:
+					return cmdutil.MalformedError(err)
+				default:
+					return err
+				}
 			}
 
 			for _, df := range diffs {
@@ -62,9 +70,9 @@ func DiffCmd(cfg *config.Config) *cobra.Command {
 				for scanner.Scan() {
 					txt := scanner.Text()
 					if strings.HasPrefix(txt, "+") {
-						color.New(color.FgGreen).Add(color.Bold).Println(txt)
+						color.New(color.FgGreen).Add(color.Bold).Println(txt) //nolint: errcheck
 					} else if strings.HasPrefix(txt, "-") {
-						color.New(color.FgRed).Add(color.Bold).Println(txt)
+						color.New(color.FgRed).Add(color.Bold).Println(txt) //nolint: errcheck
 					} else {
 						fmt.Println(txt)
 					}

diff --git a/internal/cmd/deployrequest/list.go b/internal/cmd/deployrequest/list.go
@@ -52,7 +52,15 @@ func ListCmd(cfg *config.Config) *cobra.Command {
 				Database:     database,
 			})
 			if err != nil {
-				return errors.Wrap(err, "error listing deploy requests")
+				switch cmdutil.ErrCode(err) {
+				case planetscale.ErrNotFound:
+					return fmt.Errorf("%s does not exist in %s\n",
+						cmdutil.BoldBlue(database), cmdutil.BoldBlue(cfg.Organization))
+				case planetscale.ErrResponseMalformed:
+					return cmdutil.MalformedError(err)
+				default:
+					return errors.Wrap(err, "error listing deploy requests")
+				}
 			}
 			end()
 

diff --git a/internal/cmd/deployrequest/review.go b/internal/cmd/deployrequest/review.go
@@ -57,7 +57,15 @@ func ReviewCmd(cfg *config.Config) *cobra.Command {
 				CommentText:  flags.comment,
 			})
 			if err != nil {
-				return err
+				switch cmdutil.ErrCode(err) {
+				case planetscale.ErrNotFound:
+					return fmt.Errorf("%s/%s does not exist in %s\n",
+						cmdutil.BoldBlue(database), cmdutil.BoldBlue(number), cmdutil.BoldBlue(cfg.Organization))
+				case planetscale.ErrResponseMalformed:
+					return cmdutil.MalformedError(err)
+				default:
+					return err
+				}
 			}
 
 			switch action {

diff --git a/internal/cmd/deployrequest/show.go b/internal/cmd/deployrequest/show.go
@@ -50,7 +50,15 @@ func ShowCmd(cfg *config.Config) *cobra.Command {
 				Number:       n,
 			})
 			if err != nil {
-				return err
+				switch cmdutil.ErrCode(err) {
+				case planetscale.ErrNotFound:
+					return fmt.Errorf("%s/%s does not exist in %s\n",
+						cmdutil.BoldBlue(database), cmdutil.BoldBlue(number), cmdutil.BoldBlue(cfg.Organization))
+				case planetscale.ErrResponseMalformed:
+					return cmdutil.MalformedError(err)
+				default:
+					return err
+				}
 			}
 
 			err = printer.PrintOutput(cfg.OutputJSON, printer.NewDeployRequestPrinter(dr))