CLOUDP-105503: Telemetry Improvements (#1270)

Author: fmenezes

cmd/atlas/atlas.go

@@ -23,44 +23,30 @@ import (
 
 	"github.com/mongodb/mongodb-atlas-cli/internal/cli/root/atlas"
 	"github.com/mongodb/mongodb-atlas-cli/internal/config"
-	"github.com/mongodb/mongodb-atlas-cli/internal/flag"
 	"github.com/mongodb/mongodb-atlas-cli/internal/telemetry"
 	"github.com/spf13/cobra"
 )
 
-var (
-	profile string
-)
-
 // Execute adds all child commands to the root command and sets flags appropriately.
 // This is called by main.main(). It only needs to happen once to the rootCmd.
 func Execute() {
 	ctx := telemetry.NewContext()
-	rootCmd := atlas.Builder(&profile)
-	if cmd, err := rootCmd.ExecuteContextC(ctx); err != nil {
-		telemetry.TrackCommand(telemetry.TrackOptions{
-			Cmd: cmd,
+	rootCmd := atlas.Builder()
+	if err := rootCmd.ExecuteContext(ctx); err != nil {
+		telemetry.FinishTrackingCommand(telemetry.TrackOptions{
 			Err: err,
 		})
 		os.Exit(1)
 	}
 }
 
 // loadConfig reads in config file and ENV variables if set.
-func loadConfig() {
+func loadConfig() error {
 	if err := config.LoadAtlasCLIConfig(); err != nil {
-		log.Fatalf("Error loading config: %v", err)
+		return fmt.Errorf("error loading config: %w", err)
 	}
-}
 
-func initProfile() {
-	if profile != "" {
-		config.SetName(profile)
-	} else if profile = config.GetString(flag.Profile); profile != "" {
-		config.SetName(profile)
-	} else if availableProfiles := config.List(); len(availableProfiles) == 1 {
-		config.SetName(availableProfiles[0])
-	}
+	return nil
 }
 
 // createConfigFromMongoCLIConfig creates the atlasCLI config file from the mongocli config file.
@@ -134,13 +120,24 @@ func mongoCLIConfigFilePath() (configPath string, err error) {
 	return configPath, nil
 }
 
+func trackInitError(e error) {
+	if e == nil {
+		return
+	}
+	if cmd, args, err := atlas.Builder().Find(os.Args[1:]); err == nil {
+		telemetry.StartTrackingCommand(cmd, args)
+		telemetry.FinishTrackingCommand(telemetry.TrackOptions{
+			Err: e,
+		})
+	}
+	log.Fatal(e)
+}
+
 func main() {
 	cobra.EnableCommandSorting = false
 
 	createConfigFromMongoCLIConfig()
-	loadConfig()
-
-	cobra.OnInitialize(initProfile)
+	trackInitError(loadConfig())
 
 	Execute()
 }

e2e/atlas/logs_test.go

@@ -16,7 +16,6 @@
 package atlas_test
 
 import (
-	"log"
 	"os"
 	"strings"
 	"testing"
@@ -58,7 +57,7 @@ func downloadLogTmpPath(t *testing.T, cliPath, hostname, logFile, projectID stri
 	t.Helper()
 	dir, err := os.Getwd()
 	if err != nil {
-		log.Fatal(err)
+		t.Fatal(err)
 	}
 	filepath := dir + logFile
 

go.mod

@@ -31,9 +31,9 @@ require (
 	github.com/stretchr/testify v1.7.2
 	github.com/tangzero/inflector v1.0.0
 	github.com/withfig/autocomplete-tools/packages/cobra v1.2.0
-	go.mongodb.org/atlas v0.15.1-0.20220506113516-0a876936c455
+	go.mongodb.org/atlas v0.16.1-0.20220531163122-551edbfb2f27
 	go.mongodb.org/mongo-driver v1.9.1
-	go.mongodb.org/ops-manager v0.38.0
+	go.mongodb.org/ops-manager v0.38.1-0.20220531172257-e2e9ea43cc71
 	golang.org/x/crypto v0.0.0-20220511200225-c6db032c6c88
 	golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a
 	google.golang.org/api v0.82.0

go.sum

@@ -358,13 +358,12 @@ github.com/yuin/goldmark v1.1.27/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9de
 github.com/yuin/goldmark v1.1.32/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74=
 github.com/yuin/goldmark v1.2.1/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74=
 github.com/yuin/goldmark v1.3.5/go.mod h1:mwnBkeHKe2W/ZEtQ+71ViKU8L12m81fl3OWwC1Zlc8k=
-go.mongodb.org/atlas v0.15.0/go.mod h1:lQhRHIxc6jQHEK3/q9WLu/SdBkPj2fQYhjLGUF6Z3U8=
-go.mongodb.org/atlas v0.15.1-0.20220506113516-0a876936c455 h1:ai/IUkgQHGpsphE1+Tk1rSt8SrlNfBRIqVwobkLTQaY=
-go.mongodb.org/atlas v0.15.1-0.20220506113516-0a876936c455/go.mod h1:lQhRHIxc6jQHEK3/q9WLu/SdBkPj2fQYhjLGUF6Z3U8=
+go.mongodb.org/atlas v0.16.1-0.20220531163122-551edbfb2f27 h1:rGTb8CaE9ZKNjmdUJ58jFcHopLg6o6Kzfm9AIayq1Hw=
+go.mongodb.org/atlas v0.16.1-0.20220531163122-551edbfb2f27/go.mod h1:lQhRHIxc6jQHEK3/q9WLu/SdBkPj2fQYhjLGUF6Z3U8=
 go.mongodb.org/mongo-driver v1.9.1 h1:m078y9v7sBItkt1aaoe2YlvWEXcD263e1a4E1fBrJ1c=
 go.mongodb.org/mongo-driver v1.9.1/go.mod h1:0sQWfOeY63QTntERDJJ/0SuKK0T1uVSgKCuAROlKEPY=
-go.mongodb.org/ops-manager v0.38.0 h1:2LQYrrTdIUsMvdYOGCejaxWjn8JF9RYNe3nExcIyJfA=
-go.mongodb.org/ops-manager v0.38.0/go.mod h1:rit/vJzJTlZ3TppvZSb6hbGk6BzG14daGEuDF1XAd5k=
+go.mongodb.org/ops-manager v0.38.1-0.20220531172257-e2e9ea43cc71 h1:hbpH9FXHn4RXYSI2Exd1nUgLyj9Ht8y1OddxYtDH0Mc=
+go.mongodb.org/ops-manager v0.38.1-0.20220531172257-e2e9ea43cc71/go.mod h1:NVwauDvGZ28yuddHSQKaLLQKVzKejU8YxOXKxTSZyZY=
 go.opencensus.io v0.21.0/go.mod h1:mSImk1erAIZhrmZN+AvHh14ztQfjbGwt4TtuofqLduU=
 go.opencensus.io v0.22.0/go.mod h1:+kGneAE2xo2IficOXnaByMWTGM9T73dGwxeWcUqIpI8=
 go.opencensus.io v0.22.2/go.mod h1:yxeiOL68Rb0Xd1ddK5vPZ/oVn4vY4Ynel7k9FzqtOIw=

internal/cli/atlas/atlas.go

@@ -16,7 +16,6 @@ package atlas
 
 import (
 	"fmt"
-	"os"
 
 	"github.com/mongodb/mongodb-atlas-cli/internal/cli"
 	"github.com/mongodb/mongodb-atlas-cli/internal/cli/alerts"
@@ -43,6 +42,7 @@ import (
 	"github.com/mongodb/mongodb-atlas-cli/internal/cli/events"
 	"github.com/mongodb/mongodb-atlas-cli/internal/cli/performanceadvisor"
 	"github.com/mongodb/mongodb-atlas-cli/internal/config"
+	"github.com/mongodb/mongodb-atlas-cli/internal/log"
 	"github.com/mongodb/mongodb-atlas-cli/internal/validate"
 	"github.com/spf13/cobra"
 )
@@ -58,7 +58,9 @@ func Builder() *cobra.Command {
 		Short: "MongoDB Atlas operations.",
 		Long:  deprecatedMessage,
 		PersistentPreRunE: func(cmd *cobra.Command, args []string) error {
-			_, _ = fmt.Fprint(os.Stderr, deprecatedMessage)
+			log.SetOutput(cmd.ErrOrStderr())
+
+			_, _ = log.Warning(deprecatedMessage)
 			if err := opts.InitFlow(); err != nil {
 				return err
 			}

internal/cli/atlas/dbusers/certs/list.go

@@ -43,7 +43,7 @@ func (opts *ListOpts) initStore(ctx context.Context) func() error {
 }
 
 func (opts *ListOpts) Run() error {
-	r, err := opts.store.DBUserCertificates(opts.ConfigProjectID(), opts.username)
+	r, err := opts.store.DBUserCertificates(opts.ConfigProjectID(), opts.username, nil)
 	if err != nil {
 		return err
 	}

internal/cli/atlas/dbusers/certs/list_test.go

@@ -42,7 +42,7 @@ func TestListBuilder(t *testing.T) {
 
 	mockStore.
 		EXPECT().
-		DBUserCertificates(listOpts.ProjectID, username).
+		DBUserCertificates(listOpts.ProjectID, username, nil).
 		Return(expected, nil).
 		Times(1)
 

internal/cli/atlas/quickstart/cluster_setup.go

@@ -27,6 +27,8 @@ import (
 	atlas "go.mongodb.org/atlas/mongodbatlas"
 )
 
+var ErrNoRegions = errors.New("no regions found for cloud provider")
+
 func (opts *Opts) createCluster() error {
 	if _, err := opts.store.CreateCluster(opts.newCluster()); err != nil {
 		return err
@@ -69,6 +71,11 @@ func (opts *Opts) askClusterRegion() error {
 	if err != nil {
 		return err
 	}
+
+	if len(regions) == 0 {
+		return fmt.Errorf("%w: %v", ErrNoRegions, opts.Provider)
+	}
+
 	regionQ := newRegionQuestions(regions)
 	return telemetry.TrackAskOne(regionQ, &opts.Region, survey.WithValidator(survey.Required))
 }

internal/cli/atlas/quickstart/mongoshell_setup.go

@@ -16,9 +16,9 @@ package quickstart
 
 import (
 	"fmt"
-	"os"
 
 	"github.com/mongodb/mongodb-atlas-cli/internal/config"
+	"github.com/mongodb/mongodb-atlas-cli/internal/log"
 	"github.com/mongodb/mongodb-atlas-cli/internal/telemetry"
 	"github.com/pkg/browser"
 )
@@ -40,7 +40,7 @@ func (opts *Opts) askMongoShellQuestion() error {
 	if config.MongoShellPath() != "" {
 		return nil
 	}
-	_, _ = fmt.Fprint(os.Stderr, "No MongoDB shell version configured.\n")
+	_, _ = log.Warningln("No MongoDB shell version configured.")
 	if err := telemetry.TrackAskOne(newIsMongoShellInstalledQuestion(), &opts.mongoShellInstalled); err != nil {
 		return err
 	}

internal/cli/atlas/quickstart/quick_start.go

@@ -20,7 +20,6 @@ import (
 	"fmt"
 	"io"
 	"os"
-	"os/signal"
 	"strconv"
 	"strings"
 	"syscall"
@@ -30,7 +29,9 @@ import (
 	"github.com/mongodb/mongodb-atlas-cli/internal/cli"
 	"github.com/mongodb/mongodb-atlas-cli/internal/config"
 	"github.com/mongodb/mongodb-atlas-cli/internal/flag"
+	"github.com/mongodb/mongodb-atlas-cli/internal/log"
 	"github.com/mongodb/mongodb-atlas-cli/internal/mongosh"
+	"github.com/mongodb/mongodb-atlas-cli/internal/sighandle"
 	"github.com/mongodb/mongodb-atlas-cli/internal/store"
 	"github.com/mongodb/mongodb-atlas-cli/internal/telemetry"
 	"github.com/mongodb/mongodb-atlas-cli/internal/usage"
@@ -158,7 +159,7 @@ func (opts *Opts) Run() error {
 		if publicIP := store.IPAddress(); publicIP != "" {
 			opts.IPAddresses = []string{publicIP}
 		} else {
-			_, _ = fmt.Fprintf(os.Stderr, quickstartTemplateIPNotFound, cli.ExampleAtlasEntryPoint())
+			_, _ = log.Warningf(quickstartTemplateIPNotFound, cli.ExampleAtlasEntryPoint())
 		}
 	}
 
@@ -312,13 +313,13 @@ func askMongoShellAndSetConfig() error {
 // program if it receives an interrupt from the OS. We then handle this by printing
 // the dbUsername and dbPassword.
 func (opts *Opts) setupCloseHandler() {
-	c := make(chan os.Signal, 1)
-	signal.Notify(c, os.Interrupt, syscall.SIGTERM)
-	go func() {
-		<-c
+	sighandle.Notify(func(sig os.Signal) {
 		fmt.Printf(quickstartTemplateCloseHandler, opts.ClusterName)
+		telemetry.FinishTrackingCommand(telemetry.TrackOptions{
+			Signal: sig.String(),
+		})
 		os.Exit(0)
-	}()
+	}, os.Interrupt, syscall.SIGTERM)
 }
 
 func (opts *Opts) providerAndRegionToConstant() {
@@ -374,7 +375,7 @@ func (opts *Opts) newDefaultValues() (*quickstart, error) {
 		if publicIP := store.IPAddress(); publicIP != "" {
 			values.IPAddresses = []string{publicIP}
 		} else {
-			_, _ = fmt.Fprintf(os.Stderr, quickstartTemplateIPNotFound, cli.ExampleAtlasEntryPoint())
+			_, _ = log.Warningf(quickstartTemplateIPNotFound, cli.ExampleAtlasEntryPoint())
 		}
 	}