Add new commands, auto token refresh, and structured error handling

- Add top-level issues, metrics, and vulnerabilities commands with SDK queries
- Add transparent token refresh in GraphQL client (removes need for auth refresh)
- Remove version, auth refresh, and auth whoami commands
- Add UserError type to skip user-correctable errors from Sentry
- Improve Sentry setup with panic recovery, release tagging
- Add YAML output format and source filter for run issues
- Auto-open browser on login instead of waiting for user input
- Update GraphQL schema to use issues instead of occurrences
- Use --version flag instead of version subcommand
- Clean up error messages and stale code

Author: jai-deepsource

ARCHITECTURE_REFACTORING_PLAN.md

@@ -74,13 +74,10 @@ Usage:
 
 Available commands are:
     auth        Authentication commands (login, logout, refresh, status)
-    config      Generate and Validate DeepSource config
     issues      Show the list of issues in a file in a repository
     repo        Operations related to the project repository (status, view)
     report      Report artifacts to DeepSource
     runs        View analysis runs and run issues
-    version     Get the version of the DeepSource CLI
-    whoami      Show the currently authenticated user
 
 Help:
     Use 'deepsource <command> --help/-h' for more information about the command.

README.md

@@ -1,12 +1,16 @@
 package main
 
 import (
+	"errors"
+	"fmt"
 	"log"
 	"os"
+	"strings"
 	"time"
 
-	"github.com/deepsourcelabs/cli/command"
 	v "github.com/deepsourcelabs/cli/buildinfo"
+	"github.com/deepsourcelabs/cli/command"
+	clierrors "github.com/deepsourcelabs/cli/internal/errors"
 	"github.com/getsentry/sentry-go"
 	"github.com/pterm/pterm"
 )
@@ -22,22 +26,50 @@ var (
 	SentryDSN string
 )
 
+func sentryEnvironment(ver string) string {
+	if strings.HasPrefix(ver, "v") || strings.Contains(ver, ".") {
+		return "production"
+	}
+	return "development"
+}
+
 func main() {
 	log.SetFlags(log.LstdFlags | log.Lshortfile)
 
 	// Init sentry
 	err := sentry.Init(sentry.ClientOptions{
-		Dsn: SentryDSN,
+		Dsn:         SentryDSN,
+		Release:     "deepsource-cli@" + version,
+		Environment: sentryEnvironment(version),
 	})
 	if err != nil {
 		log.Println("Could not load sentry.")
 	}
+
+	defer func() {
+		if r := recover(); r != nil {
+			sentry.CurrentHub().Recover(r)
+			sentry.Flush(2 * time.Second)
+			fmt.Fprintf(os.Stderr, "fatal: unexpected panic: %v\n", r)
+			os.Exit(2)
+		}
+	}()
+
 	v.SetBuildInfo(version, Date, "", "")
 
 	if err := command.Execute(); err != nil {
-		// TODO: Handle exit codes here
-		pterm.Error.Println(err)
-		sentry.CaptureException(err)
+		var cliErr *clierrors.CLIError
+		if errors.As(err, &cliErr) {
+			pterm.Error.Println(cliErr.Message)
+			if os.Getenv("DEEPSOURCE_CLI_DEBUG") != "" && cliErr.Cause != nil {
+				pterm.DefaultBasicText.Printf("  cause: %v\n", cliErr.Cause)
+			}
+		} else {
+			pterm.Error.Println(err)
+		}
+		if !clierrors.IsUserError(err) {
+			sentry.CaptureException(err)
+		}
 		sentry.Flush(2 * time.Second)
 		os.Exit(1)
 	}

cmd/deepsource/main.go

@@ -5,24 +5,20 @@ import (
 
 	"github.com/deepsourcelabs/cli/command/auth/login"
 	"github.com/deepsourcelabs/cli/command/auth/logout"
-	"github.com/deepsourcelabs/cli/command/auth/refresh"
 	"github.com/deepsourcelabs/cli/command/auth/status"
-	"github.com/deepsourcelabs/cli/command/auth/whoami"
 )
 
 // Options holds the metadata.
 type Options struct{}
 
-// NewCmdAuth handles the auth command which has various sub-commands like `login`, `logout`, `refresh` and `status`
+// NewCmdAuth handles the auth command which has various sub-commands like `login`, `logout` and `status`
 func NewCmdAuth() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "auth",
 		Short: "Authenticate with DeepSource",
 	}
 	cmd.AddCommand(login.NewCmdLogin())
 	cmd.AddCommand(logout.NewCmdLogout())
-	cmd.AddCommand(refresh.NewCmdRefresh())
 	cmd.AddCommand(status.NewCmdStatus())
-	cmd.AddCommand(whoami.NewCmdWhoAmI())
 	return cmd
 }

command/auth/auth.go

@@ -10,6 +10,7 @@ import (
 	"github.com/cli/browser"
 	"github.com/deepsourcelabs/cli/config"
 	"github.com/deepsourcelabs/cli/deepsource/auth"
+	clierrors "github.com/deepsourcelabs/cli/internal/errors"
 	authsvc "github.com/deepsourcelabs/cli/internal/services/auth"
 	"github.com/fatih/color"
 )
@@ -23,41 +24,42 @@ func (opts *LoginOptions) startLoginFlow(svc *authsvc.Service, cfg *config.CLICo
 		return err
 	}
 
-	// Print the user code and the permission to open browser at verificationURI
-	c := color.New(color.FgCyan, color.Bold)
-	c.Printf("Please copy your one-time code: %s\n", deviceRegistrationResponse.UserCode)
-	c.Printf("Press enter to open deepsource.io in your browser...")
-	fmt.Scanln()
-
-	// Having received the user code, open the browser at verificationURIComplete
+	// Open the browser for authentication
 	err = browser.OpenURL(deviceRegistrationResponse.VerificationURIComplete)
 	if err != nil {
-		return err
+		// If the browser fails to open, show the URL for manual access
+		c := color.New(color.FgCyan, color.Bold)
+		c.Printf("Open this URL in your browser to authenticate:\n")
+		fmt.Println(deviceRegistrationResponse.VerificationURIComplete)
+	} else {
+		fmt.Println("Opened the authentication page in your browser")
 	}
 
-	// Fetch the PAT using the device registration resonse
+	fmt.Println("Waiting for authentication")
+
+	// Fetch the PAT by polling the server
 	var tokenData *auth.PAT
 	tokenData, opts.AuthTimedOut, err = fetchPAT(ctx, deviceRegistrationResponse, svc, cfg)
 	if err != nil {
 		return err
 	}
 
-	// Check if it was a success poll or the Auth timed out
 	if opts.AuthTimedOut {
-		return fmt.Errorf("Authentication timed out")
+		return clierrors.NewCLIError(clierrors.ErrAuthRequired, "Authentication timed out. Please try again", nil)
 	}
 
-	// Storing the useful data for future reference and usage
-	// in a global config object (Cfg)
+	// Store auth data in config
 	cfg.User = tokenData.User.Email
 	cfg.Token = tokenData.Token
 	cfg.SetTokenExpiry(tokenData.Expiry)
 
-	// Having stored the data in the global Cfg object, write it into the config file present in the local filesystem
 	err = svc.SaveConfig(cfg)
 	if err != nil {
-		return fmt.Errorf("Error in writing authentication data to a file. Exiting...")
+		return clierrors.NewCLIError(clierrors.ErrInvalidConfig, "Failed to save authentication data", err)
 	}
+
+	c := color.New(color.FgGreen, color.Bold)
+	c.Printf("Logged in as %s\n", tokenData.User.Email)
 	return nil
 }
 

command/auth/login/login_flow.go

@@ -2,11 +2,11 @@ package logout
 
 import (
 	"errors"
-	"fmt"
 
 	"github.com/deepsourcelabs/cli/config"
 	"github.com/deepsourcelabs/cli/internal/cli/args"
 	"github.com/deepsourcelabs/cli/internal/cli/prompt"
+	clierrors "github.com/deepsourcelabs/cli/internal/errors"
 	authsvc "github.com/deepsourcelabs/cli/internal/services/auth"
 	"github.com/pterm/pterm"
 	"github.com/spf13/cobra"
@@ -33,7 +33,7 @@ func (opts *LogoutOptions) Run() error {
 	// Fetch config
 	cfg, err := svc.LoadConfig()
 	if err != nil {
-		return fmt.Errorf("Error while reading DeepSource CLI config : %v", err)
+		return clierrors.NewCLIError(clierrors.ErrInvalidConfig, "Error reading DeepSource CLI config", err)
 	}
 	// Checking if the user has authenticated / logged in or not
 	if cfg.Token == "" {

command/auth/logout/logout.go

@@ -2,12 +2,12 @@ package status
 
 import (
 	"errors"
-	"fmt"
 
 	"github.com/MakeNowJust/heredoc"
 	"github.com/deepsourcelabs/cli/config"
 	"github.com/deepsourcelabs/cli/internal/cli/args"
 	"github.com/deepsourcelabs/cli/internal/cli/style"
+	clierrors "github.com/deepsourcelabs/cli/internal/errors"
 	authsvc "github.com/deepsourcelabs/cli/internal/services/auth"
 	"github.com/pterm/pterm"
 	"github.com/spf13/cobra"
@@ -41,7 +41,7 @@ func (opts *AuthStatusOptions) Run() error {
 	// Fetch config
 	cfg, err := svc.LoadConfig()
 	if err != nil {
-		return fmt.Errorf("Error while reading DeepSource CLI config : %v", err)
+		return clierrors.NewCLIError(clierrors.ErrInvalidConfig, "Error reading DeepSource CLI config", err)
 	}
 	// Checking if the user has authenticated / logged in or not
 	if cfg.Token == "" {
@@ -52,7 +52,7 @@ func (opts *AuthStatusOptions) Run() error {
 	if !cfg.IsExpired() {
 		pterm.Printf("Logged in to DeepSource as %s.\n", cfg.User)
 	} else {
-		pterm.Println("The authentication has expired. Run \"deepsource auth refresh\" to refresh the credentials.")
+		pterm.Println("The authentication has expired. Run \"deepsource auth login\" to re-authenticate.")
 	}
 	return nil
 }