CLOUDP-124940: Improve user experience of shell detection (#1298)

fmenezes · melissamahoney-mongodb · web-flow · commit 620a6df28015 · 2022-06-14T10:27:59.000+01:00
* CLOUDP-124940: Improve user experience of shell detection * Fix new line * fix mongosh * make binPath internal * Update internal/cli/atlas/quickstart/quick_start.go Co-authored-by: Melissa Mahoney <melissa.mahoney@mongodb.com> * line break Co-authored-by: Melissa Mahoney <melissa.mahoney@mongodb.com>
diff --git a/docs/atlascli/command/atlas-config-set.txt b/docs/atlascli/command/atlas-config-set.txt
@@ -86,6 +86,4 @@ Examples
    $ atlas config set ops_manager_url http://localhost:30700/ -P myProfile
    Set Organization ID in the default profile:
    $ atlas config set org_id 5dd5aaef7a3e5a6c5bd12de4
-   Set path for the MongoDB Shell in the default profile:
-   $ atlas config set mongosh_path /usr/local/bin/mongosh
 
diff --git a/docs/mongocli/command/mongocli-config-set.txt b/docs/mongocli/command/mongocli-config-set.txt
@@ -86,6 +86,4 @@ Examples
    $ mongocli config set ops_manager_url http://localhost:30700/ -P myProfile
    Set Organization ID in the default profile:
    $ mongocli config set org_id 5dd5aaef7a3e5a6c5bd12de4
-   Set path for the MongoDB Shell in the default profile:
-   $ mongocli config set mongosh_path /usr/local/bin/mongosh
 
diff --git a/internal/cli/atlas/config/init.go b/internal/cli/atlas/config/init.go
@@ -83,7 +83,6 @@ Enter [?] on any option to get help.
 		return err
 	}
 	opts.SetUpOutput()
-	opts.SetUpMongoSHPath()
 
 	if err := config.Save(); err != nil {
 		return err
diff --git a/internal/cli/atlas/quickstart/mongoshell_setup.go b/internal/cli/atlas/quickstart/mongoshell_setup.go
diff --git a/internal/cli/atlas/quickstart/prompt.go b/internal/cli/atlas/quickstart/prompt.go
@@ -18,7 +18,6 @@ import (
 	"fmt"
 
 	"github.com/AlecAivazis/survey/v2"
-	"github.com/mongodb/mongodb-atlas-cli/internal/mongosh"
 	"github.com/mongodb/mongodb-atlas-cli/internal/usage"
 	"github.com/mongodb/mongodb-atlas-cli/internal/validate"
 )
@@ -89,44 +88,6 @@ func newSampleDataQuestion(clusterName string) survey.Prompt {
 	}
 }
 
-func newMongoShellQuestionAccessDeployment(clusterName string) survey.Prompt {
-	return &survey.Confirm{
-		Message: fmt.Sprintf("Do you want to connect to %s with MongoDB Shell?", clusterName),
-		Help:    "MongoDB CLI will use your installed version of MongoDB Shell to access your deployments.",
-		Default: true,
-	}
-}
-
-func newMongoShellPathQuestion() survey.Prompt {
-	return &survey.Confirm{
-		Message: "Do you want to provide the path to your MongoDB Shell binary?",
-		Help:    "MongoDB CLI will store the path in your profile, type ‘mongocli config’ to change it.",
-		Default: true,
-	}
-}
-
-func newIsMongoShellInstalledQuestion() survey.Prompt {
-	return &survey.Confirm{
-		Message: "Do you have a MongoDB Shell version installed on your machine?",
-		Default: true,
-	}
-}
-
-func newMongoShellPathInput() survey.Prompt {
-	return &survey.Input{
-		Message: "Default MongoDB Shell Path",
-		Help:    "MongoDB CLI will use your installed version of MongoDB Shell to access your deployments.",
-		Default: mongosh.Path(),
-	}
-}
-
-func newMongoShellQuestionOpenBrowser() survey.Prompt {
-	return &survey.Confirm{
-		Message: "Do you want to download MongoDB Shell [This will open www.mongodb.com on your browser]?",
-		Default: true,
-	}
-}
-
 func newClusterCreateConfirm() survey.Prompt {
 	return &survey.Confirm{
 		Message: "Are you ready to create your Atlas cluster with the above settings?",
diff --git a/internal/cli/atlas/quickstart/quick_start.go b/internal/cli/atlas/quickstart/quick_start.go
@@ -25,7 +25,6 @@ import (
 	"syscall"
 	"time"
 
-	"github.com/AlecAivazis/survey/v2"
 	"github.com/mongodb/mongodb-atlas-cli/internal/cli"
 	"github.com/mongodb/mongodb-atlas-cli/internal/cli/auth"
 	"github.com/mongodb/mongodb-atlas-cli/internal/config"
@@ -44,10 +43,20 @@ import (
 
 //go:generate mockgen -destination=../../../mocks/mock_quick_start.go -package=mocks github.com/mongodb/mongodb-atlas-cli/internal/cli/atlas/quickstart Flow
 
-const quickstartTemplate = `
-Now you can connect to your Atlas cluster with: mongosh -u %s -p %s %s
+const quickstartTemplateMongoshDetected = `
+MongoDB Shell detected. Connecting to your Atlas cluster:
+$ mongosh -u %s -p %s %s
+`
+
+const quickstartTemplateMongoshNotDetected = `
+MongoDB Shell not detected. To install, open www.mongodb.com/try/download/shell.
+
+MongoDB Shell (mongosh) is an interactive command line interface to query, update, and manage data in your MongoDB database.
 
+Once you install the MongoDB Shell, connect to your database with:
+$ mongosh -u %s -p %s %s
 `
+
 const quickstartTemplateCloseHandler = `
 Enter 'atlas cluster watch %s' to learn when your cluster is available.
 `
@@ -79,7 +88,6 @@ const (
 	DefaultAtlasTier    = "M0"
 	defaultAtlasGovTier = "M30"
 	atlasAdmin          = "atlasAdmin"
-	mongoshURL          = "https://www.mongodb.com/try/download/shell"
 	defaultProvider     = "AWS"
 	defaultRegion       = "US_EAST_1"
 	defaultRegionGCP    = "US_EAST_4"
@@ -104,8 +112,6 @@ type Opts struct {
 	SampleDataJobID     string
 	SkipSampleData      bool
 	SkipMongosh         bool
-	runMongoShell       bool
-	mongoShellInstalled bool
 	defaultValue        bool
 	Confirm             bool
 	CurrentIP           bool
@@ -264,33 +270,32 @@ func (opts *Opts) Run() error {
 		return er
 	}
 
-	fmt.Print("Cluster created.")
+	fmt.Println("Cluster created.")
 
-	if err := opts.loadSampleData(); err != nil {
+	// Get cluster's connection string
+	cluster, err := opts.store.AtlasCluster(opts.ConfigProjectID(), opts.ClusterName)
+	if err != nil {
 		return err
 	}
 
-	if err := opts.askMongoShellQuestion(); err != nil {
+	fmt.Printf("Your connection string: %v\n", cluster.ConnectionStrings.StandardSrv)
+
+	if err := opts.loadSampleData(); err != nil {
 		return err
 	}
 
-	// If user does not want to open MongoShell, skip everything below
-	if !opts.runMongoShell {
+	if opts.SkipMongosh {
 		return nil
 	}
-	// Get cluster's connection string
-	cluster, err := opts.store.AtlasCluster(opts.ConfigProjectID(), opts.ClusterName)
-	if err != nil {
-		return err
-	}
 
-	fmt.Printf(quickstartTemplate, opts.DBUsername, opts.DBUserPassword, cluster.ConnectionStrings.StandardSrv)
+	if !mongosh.Detect() {
+		fmt.Printf(quickstartTemplateMongoshNotDetected, opts.DBUsername, opts.DBUserPassword, cluster.ConnectionStrings.StandardSrv)
 
-	if opts.runMongoShell && config.MongoShellPath() != "" {
-		return mongosh.Run(config.MongoShellPath(), opts.DBUsername, opts.DBUserPassword, cluster.ConnectionStrings.StandardSrv)
+		return nil
 	}
 
-	return nil
+	fmt.Printf(quickstartTemplateMongoshDetected, opts.DBUsername, opts.DBUserPassword, cluster.ConnectionStrings.StandardSrv)
+	return mongosh.Run(opts.DBUsername, opts.DBUserPassword, cluster.ConnectionStrings.StandardSrv)
 }
 
 func (opts *Opts) createResources() error {
@@ -365,17 +370,6 @@ func (opts *Opts) askSampleDataQuestion() error {
 	return nil
 }
 
-func askMongoShellAndSetConfig() error {
-	var mongoShellPath string
-	q := newMongoShellPathInput()
-	if err := telemetry.TrackAskOne(q, &mongoShellPath, survey.WithValidator(validate.Path)); err != nil {
-		return err
-	}
-
-	config.SetMongoShellPath(mongoShellPath)
-	return config.Save()
-}
-
 // setupCloseHandler creates a 'listener' on a new goroutine which will notify the
 // program if it receives an interrupt from the OS. We then handle this by printing
 // the dbUsername and dbPassword.
diff --git a/internal/cli/atlas/quickstart/quick_start_test.go b/internal/cli/atlas/quickstart/quick_start_test.go
@@ -75,8 +75,6 @@ func TestQuickstartOpts_Run(t *testing.T) {
 		Confirm:        true,
 	}
 
-	opts.runMongoShell = true
-
 	projectIPAccessList := opts.newProjectIPAccessList()
 
 	mockStore.
@@ -124,7 +122,6 @@ func TestQuickstartOpts_Run_NotLoggedIn(t *testing.T) {
 		Confirm:        true,
 	}
 
-	opts.runMongoShell = true
 	require.Error(t, validate.ErrMissingCredentials, opts.quickstartPreRun(ctx, buf))
 }
 
@@ -164,7 +161,6 @@ func TestQuickstartOpts_Run_NeedLogin_ForceAfterLogin(t *testing.T) {
 		loginOpts:      auth.NewLoginOpts(),
 	}
 
-	opts.runMongoShell = true
 	setConfig()
 	projectIPAccessList := opts.newProjectIPAccessList()
 
@@ -240,8 +236,6 @@ func TestQuickstartOpts_Run_CheckFlagsSet(t *testing.T) {
 		Confirm:        true,
 	}
 
-	opts.runMongoShell = true
-
 	projectIPAccessList := opts.newProjectIPAccessList()
 
 	mockStore.
diff --git a/internal/cli/auth/login.go b/internal/cli/auth/login.go
@@ -206,7 +206,6 @@ func (opts *LoginOpts) setUpProfile(ctx context.Context) error {
 		_, _ = fmt.Fprintf(opts.OutWriter, "You can use [%s config set] to change these settings at a later time.\n", config.BinName())
 	}
 
-	opts.SetUpMongoSHPath()
 	return opts.config.Save()
 }
 
diff --git a/internal/cli/config/config.go b/internal/cli/config/config.go
@@ -71,7 +71,6 @@ Enter [?] on any option to get help.
 		return err
 	}
 	opts.SetUpOutput()
-	opts.SetUpMongoSHPath()
 
 	if err := config.Save(); err != nil {
 		return err
diff --git a/internal/cli/config/set.go b/internal/cli/config/set.go
@@ -80,9 +80,7 @@ Available properties include: %v.`, config.Properties()),
   Set Ops Manager Base URL in the profile myProfile:
   $ %[1]s config set ops_manager_url http://localhost:30700/ -P myProfile
   Set Organization ID in the default profile:
-  $ %[1]s config set org_id 5dd5aaef7a3e5a6c5bd12de4
-  Set path for the MongoDB Shell in the default profile:
-  $ %[1]s config set mongosh_path /usr/local/bin/mongosh`, config.BinName()),
+  $ %[1]s config set org_id 5dd5aaef7a3e5a6c5bd12de4`, config.BinName()),
 		Annotations: map[string]string{
 			"args":             "propertyName,value",
 			"requiredArgs":     "propertyName,value",
diff --git a/internal/cli/default_setter_opts.go b/internal/cli/default_setter_opts.go
@@ -22,7 +22,6 @@ import (
 
 	"github.com/AlecAivazis/survey/v2"
 	"github.com/mongodb/mongodb-atlas-cli/internal/config"
-	"github.com/mongodb/mongodb-atlas-cli/internal/mongosh"
 	"github.com/mongodb/mongodb-atlas-cli/internal/prompt"
 	"github.com/mongodb/mongodb-atlas-cli/internal/store"
 	"github.com/mongodb/mongodb-atlas-cli/internal/telemetry"
@@ -46,7 +45,6 @@ type DefaultSetterOpts struct {
 	OpsManagerURL            string
 	ProjectID                string
 	OrgID                    string
-	MongoShellPath           string
 	TelemetryEnabled         bool
 	Output                   string
 	Store                    ProjectOrgsLister
@@ -270,19 +268,6 @@ func (opts *DefaultSetterOpts) SetUpOrg() {
 	}
 }
 
-func (opts *DefaultSetterOpts) SetUpMongoSHPath() {
-	if !opts.IsCloud() {
-		return
-	}
-
-	defaultPath := config.MongoShellPath()
-	if defaultPath == "" {
-		defaultPath = mongosh.Path()
-	}
-
-	config.SetMongoShellPath(defaultPath)
-}
-
 func (opts *DefaultSetterOpts) SetUpOutput() {
 	if opts.Output != plaintextFormat {
 		config.SetOutput(opts.Output)
diff --git a/internal/config/profile.go b/internal/config/profile.go
@@ -404,18 +404,6 @@ func (p *Profile) SetOrgID(v string) {
 	p.Set(orgID, v)
 }
 
-// MongoShellPath get the configured MongoDB Shell path.
-func MongoShellPath() string { return Default().MongoShellPath() }
-func (p *Profile) MongoShellPath() string {
-	return p.GetString(mongoShellPath)
-}
-
-// SetMongoShellPath sets the global MongoDB Shell path.
-func SetMongoShellPath(v string) { Default().SetMongoShellPath(v) }
-func (*Profile) SetMongoShellPath(v string) {
-	SetGlobal(mongoShellPath, v)
-}
-
 // SkipUpdateCheck get the global skip update check.
 func SkipUpdateCheck() bool { return Default().SkipUpdateCheck() }
 func (p *Profile) SkipUpdateCheck() bool {
@@ -496,9 +484,6 @@ func Map() map[string]string { return Default().Map() }
 func (p *Profile) Map() map[string]string {
 	settings := viper.GetStringMapString(p.Name())
 	profileSettings := make(map[string]string, len(settings)+1)
-	if p.MongoShellPath() != "" {
-		profileSettings[mongoShellPath] = p.MongoShellPath()
-	}
 	for k, v := range settings {
 		if k == privateAPIKey || k == publicAPIKey || k == AccessTokenField || k == RefreshTokenField {
 			profileSettings[k] = "redacted"
diff --git a/internal/mongosh/mongosh.go b/internal/mongosh/mongosh.go
diff --git a/internal/mongosh/mongosh_test.go b/internal/mongosh/mongosh_test.go

Original file line number	Diff line number	Diff line change
`@@ -83,7 +83,6 @@ Enter [?] on any option to get help.`
`83`	`83`	`return err`
`84`	`84`	`}`
`85`	`85`	`opts.SetUpOutput()`
`86`		`- opts.SetUpMongoSHPath()`
`87`	`86`
`88`	`87`	`if err := config.Save(); err != nil {`
`89`	`88`	`return err`
Original file line number	Diff line number	Diff line change
`@@ -75,8 +75,6 @@ func TestQuickstartOpts_Run(t *testing.T) {`
`75`	`75`	`Confirm: true,`
`76`	`76`	`}`
`77`	`77`
`78`		`- opts.runMongoShell = true`
`79`		`-`
`80`	`78`	`projectIPAccessList := opts.newProjectIPAccessList()`
`81`	`79`
`82`	`80`	`mockStore.`
`@@ -124,7 +122,6 @@ func TestQuickstartOpts_Run_NotLoggedIn(t *testing.T) {`
`124`	`122`	`Confirm: true,`
`125`	`123`	`}`
`126`	`124`
`127`		`- opts.runMongoShell = true`
`128`	`125`	`require.Error(t, validate.ErrMissingCredentials, opts.quickstartPreRun(ctx, buf))`
`129`	`126`	`}`
`130`	`127`
`@@ -164,7 +161,6 @@ func TestQuickstartOpts_Run_NeedLogin_ForceAfterLogin(t *testing.T) {`
`164`	`161`	`loginOpts: auth.NewLoginOpts(),`
`165`	`162`	`}`
`166`	`163`
`167`		`- opts.runMongoShell = true`
`168`	`164`	`setConfig()`
`169`	`165`	`projectIPAccessList := opts.newProjectIPAccessList()`
`170`	`166`
`@@ -240,8 +236,6 @@ func TestQuickstartOpts_Run_CheckFlagsSet(t *testing.T) {`
`240`	`236`	`Confirm: true,`
`241`	`237`	`}`
`242`	`238`
`243`		`- opts.runMongoShell = true`
`244`		`-`
`245`	`239`	`projectIPAccessList := opts.newProjectIPAccessList()`
`246`	`240`
`247`	`241`	`mockStore.`
Original file line number	Diff line number	Diff line change
`@@ -206,7 +206,6 @@ func (opts *LoginOpts) setUpProfile(ctx context.Context) error {`
`206`	`206`	`_, _ = fmt.Fprintf(opts.OutWriter, "You can use [%s config set] to change these settings at a later time.\n", config.BinName())`
`207`	`207`	`}`
`208`	`208`
`209`		`- opts.SetUpMongoSHPath()`
`210`	`209`	`return opts.config.Save()`
`211`	`210`	`}`
`212`	`211`
Original file line number	Diff line number	Diff line change
`@@ -71,7 +71,6 @@ Enter [?] on any option to get help.`
`71`	`71`	`return err`
`72`	`72`	`}`
`73`	`73`	`opts.SetUpOutput()`
`74`		`- opts.SetUpMongoSHPath()`
`75`	`74`
`76`	`75`	`if err := config.Save(); err != nil {`
`77`	`76`	`return err`