Clean up comments, refactor auth status, add tests

- Remove redundant godoc and inline comments across codebase
- Extract auth status into smaller helper methods
- Add BackfillUser and default host logic to config manager
- Add tests for login edge cases, auth status, and config manager

Author: jai-deepsource

buildinfo/version.go

@@ -23,7 +23,6 @@ type BuildInfo struct {
 	BuildMode string `json:"build_mode,omitempty"`
 }
 
-// SetBuildInfo sets the build info as a package global.
 func SetBuildInfo(version, dateStr, buildMode string) {
 	date, _ := time.Parse("2006-01-02T15:04:05Z", dateStr)
 
@@ -34,7 +33,6 @@ func SetBuildInfo(version, dateStr, buildMode string) {
 	}
 }
 
-// GetBuildInfo returns the package global `buildInfo`
 func GetBuildInfo() *BuildInfo {
 	return buildInfo
 }

cmd/deepsource/main.go

@@ -16,16 +16,9 @@ import (
 )
 
 var (
-	// Version is the build version.  This is set using ldflags -X
-	version = "development"
-
-	// Date is the build date.  This is set using ldflags -X
-	Date = "YYYY-MM-DD" // YYYY-MM-DD
-
-	// DSN used for sentry
+	version   = "development"
+	Date      = "YYYY-MM-DD"
 	SentryDSN string
-
-	// buildMode is "dev" or "prod" (default). Set via ldflags -X.
 	buildMode string
 )
 

command/auth/auth.go

@@ -8,10 +8,8 @@ import (
 	"github.com/deepsourcelabs/cli/command/auth/status"
 )
 
-// Options holds the metadata.
 type Options struct{}
 
-// NewCmdAuth handles the auth command which has various sub-commands like `login`, `logout` and `status`
 func NewCmdAuth() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "auth",

command/auth/login/login.go

@@ -17,7 +17,6 @@ import (
 
 var accountTypes = []string{"DeepSource (deepsource.com)", "Enterprise Server"}
 
-// LoginOptions hold the metadata related to login operation
 type LoginOptions struct {
 	AuthTimedOut bool
 	TokenExpired bool
@@ -28,12 +27,10 @@ type LoginOptions struct {
 	deps         *cmddeps.Deps
 }
 
-// NewCmdLogin handles the login functionality for the CLI
 func NewCmdLogin() *cobra.Command {
 	return NewCmdLoginWithDeps(nil)
 }
 
-// NewCmdLoginWithDeps creates the login command with injectable dependencies.
 func NewCmdLoginWithDeps(deps *cmddeps.Deps) *cobra.Command {
 	doc := heredoc.Docf(`
 		Log in to DeepSource using the CLI.
@@ -66,7 +63,6 @@ func NewCmdLoginWithDeps(deps *cmddeps.Deps) *cobra.Command {
 		},
 	}
 
-	// --host flag (--hostname kept as deprecated alias)
 	cmd.Flags().StringVar(&opts.HostName, "host", "", "Authenticate with a specific DeepSource instance")
 	cmd.Flags().StringVar(&opts.HostName, "hostname", "", "Authenticate with a specific DeepSource instance")
 	_ = cmd.Flags().MarkDeprecated("hostname", "use --host instead")
@@ -76,7 +72,6 @@ func NewCmdLoginWithDeps(deps *cmddeps.Deps) *cobra.Command {
 	return cmd
 }
 
-// Run executes the auth command and starts the login flow if not already authenticated
 func (opts *LoginOptions) Run() (err error) {
 	var cfgMgr *config.Manager
 	if opts.deps != nil && opts.deps.ConfigMgr != nil {
@@ -92,51 +87,33 @@ func (opts *LoginOptions) Run() (err error) {
 	} else {
 		svc = authsvc.NewService(cfgMgr)
 	}
-	// Fetch config (errors are non-fatal: a zero config just means "not logged in")
 	cfg, err := svc.LoadConfig()
 	if err != nil {
-		cfg = &config.CLIConfig{}
+		cfg = config.NewDefault()
 	}
 	opts.User = cfg.User
 	opts.TokenExpired = cfg.IsExpired()
 
-	// Default host so that verifyTokenWithServer can reach the server
-	// even when no config file exists yet.
-	if cfg.Host == "" {
-		cfg.Host = config.DefaultHostName
-	}
+	opts.verifyTokenWithServer(cfg, svc)
 
-	// If local says valid, verify against the server
-	opts.verifyTokenWithServer(cfg, cfgMgr)
-
-	// Login using the interactive mode
 	if opts.Interactive {
 		err = opts.handleInteractiveLogin()
 		if err != nil {
 			return err
 		}
 	}
 
-	// Checking if the user passed a hostname. If yes, storing it in the config
-	// Else using the default hostname (deepsource.com)
 	if opts.HostName != "" {
 		cfg.Host = opts.HostName
 	} else {
 		cfg.Host = config.DefaultHostName
 	}
 
-	// If PAT is passed, start the login flow through PAT (skip interactive prompts)
 	if opts.PAT != "" {
 		return opts.startPATLoginFlow(svc, cfg, opts.PAT)
 	}
 
-	// Before starting the login workflow, check here for two conditions:
-	// Condition 1 : If the token has expired, display a message about it and re-authenticate user
-	// Condition 2 : If the token has not expired,does the user want to re-authenticate?
-
-	// Checking for condition 1
 	if !opts.TokenExpired {
-		// The user is already logged in, confirm re-authentication.
 		var msg string
 		if opts.User != "" {
 			msg = fmt.Sprintf("You're already logged into DeepSource as %s. Do you want to re-authenticate?", opts.User)
@@ -147,31 +124,19 @@ func (opts *LoginOptions) Run() (err error) {
 		if err != nil {
 			return fmt.Errorf("Error in fetching response. Please try again.")
 		}
-		// If the response is No, it implies that the user doesn't want to re-authenticate
-		// In this case, just exit
 		if !response {
 			return nil
 		}
 	}
 
-	// Condition 2
-	// `startLoginFlow` implements the authentication flow for the CLI
 	return opts.startLoginFlow(svc, cfg)
 }
 
-func (opts *LoginOptions) verifyTokenWithServer(cfg *config.CLIConfig, cfgMgr *config.Manager) {
-	if opts.TokenExpired || cfg.Token == "" || cfg.Host == "" {
-		return
-	}
-	client, err := deepsource.New(deepsource.ClientOpts{
-		Token:            cfg.Token,
-		HostName:         cfg.Host,
-		OnTokenRefreshed: cfgMgr.TokenRefreshCallback(),
-	})
-	if err != nil {
+func (opts *LoginOptions) verifyTokenWithServer(cfg *config.CLIConfig, svc *authsvc.Service) {
+	if opts.TokenExpired || cfg.Token == "" {
 		return
 	}
-	viewer, err := client.GetViewer(context.Background())
+	viewer, err := svc.GetViewer(context.Background(), cfg)
 	if err != nil {
 		opts.TokenExpired = true
 		return
@@ -180,23 +145,20 @@ func (opts *LoginOptions) verifyTokenWithServer(cfg *config.CLIConfig, cfgMgr *c
 	if cfg.User == "" && viewer.Email != "" {
 		cfg.User = viewer.Email
 		opts.User = viewer.Email
-		_ = cfgMgr.Write(cfg)
+		_ = svc.SaveConfig(cfg)
 	}
 }
 
 func (opts *LoginOptions) handleInteractiveLogin() error {
-	// Prompt messages and help texts
 	loginPromptMessage := "Which account do you want to login into?"
 	loginPromptHelpText := "Select the type of account you want to authenticate"
 	hostPromptMessage := "Please enter the hostname:"
 	hostPromptHelpText := "The hostname of the DeepSource instance to authenticate with"
 
-	// Display prompt to user
 	loginType, err := prompt.SelectFromOptions(loginPromptMessage, loginPromptHelpText, accountTypes)
 	if err != nil {
 		return err
 	}
-	// Prompt the user for hostname only in the case of on-premise
 	if loginType == "Enterprise Server" {
 		opts.HostName, err = prompt.GetSingleLineInput(hostPromptMessage, hostPromptHelpText)
 		if err != nil {

command/auth/login/login_flow.go

@@ -15,16 +15,13 @@ import (
 	"github.com/fatih/color"
 )
 
-// Starts the login flow for the CLI
 func (opts *LoginOptions) startLoginFlow(svc *authsvc.Service, cfg *config.CLIConfig) error {
-	// Register the device and get a device code through the response
 	ctx := context.Background()
 	deviceRegistrationResponse, err := registerDevice(ctx, svc, cfg)
 	if err != nil {
 		return err
 	}
 
-	// Open the browser for authentication
 	err = browser.OpenURL(deviceRegistrationResponse.VerificationURIComplete)
 	if err != nil {
 		c := color.New(color.FgCyan, color.Bold)
@@ -38,7 +35,6 @@ func (opts *LoginOptions) startLoginFlow(svc *authsvc.Service, cfg *config.CLICo
 	fmt.Println()
 	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 {
@@ -49,7 +45,6 @@ func (opts *LoginOptions) startLoginFlow(svc *authsvc.Service, cfg *config.CLICo
 		return clierrors.ErrAuthTimeout()
 	}
 
-	// Store auth data in config
 	cfg.User = tokenData.User.Email
 	cfg.Token = tokenData.Token
 	cfg.SetTokenExpiry(tokenData.Expiry)
@@ -76,9 +71,6 @@ func fetchPAT(ctx context.Context, deviceRegistrationData *auth.Device, svc *aut
 	userName := ""
 	authTimedOut := true
 
-	/* ======================================================================= */
-	// The username and hostname to add in the description for the PAT request
-	/* ======================================================================= */
 	userData, err := user.Current()
 	if err != nil {
 		userName = defaultUserName
@@ -92,11 +84,9 @@ func fetchPAT(ctx context.Context, deviceRegistrationData *auth.Device, svc *aut
 	}
 	userDescription := fmt.Sprintf("CLI PAT for %s@%s", userName, hostName)
 
-	// Keep polling the mutation at a certain interval till the expiry timeperiod
 	ticker := time.NewTicker(time.Duration(deviceRegistrationData.Interval) * time.Second)
 	pollStartTime := time.Now()
 
-	// Polling for fetching PAT
 	func() {
 		for range ticker.C {
 			tokenData, err = svc.RequestPAT(ctx, cfg, deviceRegistrationData.Code, userDescription)

command/auth/login/pat_login_flow.go

@@ -9,19 +9,15 @@ import (
 	"github.com/fatih/color"
 )
 
-// Starts the login flow for the CLI (using PAT)
 func (opts *LoginOptions) startPATLoginFlow(svc *authsvc.Service, cfg *config.CLIConfig, token string) error {
-	// set personal access token (PAT)
 	cfg.Token = token
 
-	// Verify the token against the server before saving
 	viewer, err := svc.GetViewer(context.Background(), cfg)
 	if err != nil {
 		return fmt.Errorf("Invalid token: could not authenticate with DeepSource")
 	}
 	cfg.User = viewer.Email
 
-	// 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..")