fix: open the list of apps if no known apps are found for "app settings" command (#314)

Author: zimeg

cmd/app/settings.go

@@ -45,7 +45,7 @@ func NewSettingsCommand(clients *shared.ClientFactory) *cobra.Command {
 		}, "\n"),
 		Example: style.ExampleCommandsf([]style.ExampleCommand{
 			{
-				Meaning: "Open app settings for a prompted app",
+				Meaning: "Open app settings dashboard",
 				Command: "app settings",
 			},
 			{
@@ -65,11 +65,12 @@ func NewSettingsCommand(clients *shared.ClientFactory) *cobra.Command {
 }
 
 // appSettingsCommandPreRunE determines if the command can be run in a project
+// or if the command is run outside of a project
 func appSettingsCommandPreRunE(clients *shared.ClientFactory, cmd *cobra.Command, args []string) error {
 	ctx := cmd.Context()
 	err := cmdutil.IsValidProjectDirectory(clients)
 	if err != nil {
-		return err
+		return nil
 	}
 	// Allow the force flag to ignore hosted apps and try to open app settings
 	if clients.Config.ForceFlag {
@@ -98,6 +99,28 @@ func appSettingsCommandRunE(clients *shared.ClientFactory, cmd *cobra.Command, a
 
 	app, err := settingsAppSelectPromptFunc(ctx, clients, prompts.ShowAllEnvironments, prompts.ShowInstalledAndUninstalledApps)
 	if err != nil {
+		// If no apps exist, open the list of all apps known to the developer
+		if slackerror.Is(err, slackerror.ErrInstallationRequired) {
+			host := clients.API().Host()
+			parsed, err := url.Parse(host)
+			if err != nil {
+				return err
+			}
+			parsed.Host = "api." + parsed.Host
+			settingsURL := fmt.Sprintf("%s/apps", parsed.String())
+
+			clients.IO.PrintInfo(ctx, false, "\n%s", style.Sectionf(style.TextSection{
+				Emoji: "house",
+				Text:  "App Settings",
+				Secondary: []string{
+					settingsURL,
+				},
+			}))
+			clients.Browser().OpenURL(settingsURL)
+
+			clients.IO.PrintTrace(ctx, slacktrace.AppSettingsSuccess, settingsURL)
+			return nil
+		}
 		return err
 	}
 	host := clients.API().Host()

cmd/app/settings_test.go

@@ -32,8 +32,28 @@ import (
 
 func Test_App_SettingsCommand(t *testing.T) {
 	testutil.TableTestCommand(t, testutil.CommandTests{
-		"requires a valid project directory": {
-			ExpectedError: slackerror.New(slackerror.ErrInvalidAppDirectory),
+		"opens app listing page when not in a project directory": {
+			Setup: func(t *testing.T, ctx context.Context, cm *shared.ClientsMock, cf *shared.ClientFactory) {
+				appSelectMock := prompts.NewAppSelectMock()
+				appSelectMock.On(
+					"AppSelectPrompt",
+					mock.Anything,
+					mock.Anything,
+					prompts.ShowAllEnvironments,
+					prompts.ShowInstalledAndUninstalledApps,
+				).Return(
+					prompts.SelectedApp{},
+					slackerror.New(slackerror.ErrInstallationRequired),
+				)
+				settingsAppSelectPromptFunc = appSelectMock.AppSelectPrompt
+				cm.API.On("Host").Return("https://slack.com")
+			},
+			ExpectedAsserts: func(t *testing.T, ctx context.Context, cm *shared.ClientsMock) {
+				expectedURL := "https://api.slack.com/apps"
+				cm.Browser.AssertCalled(t, "OpenURL", expectedURL)
+				cm.IO.AssertCalled(t, "PrintTrace", mock.Anything, slacktrace.AppSettingsStart, mock.Anything)
+				cm.IO.AssertCalled(t, "PrintTrace", mock.Anything, slacktrace.AppSettingsSuccess, []string{expectedURL})
+			},
 		},
 		"errors for rosi applications": {
 			Setup: func(t *testing.T, ctx context.Context, cm *shared.ClientsMock, cf *shared.ClientFactory) {
@@ -113,7 +133,40 @@ func Test_App_SettingsCommand(t *testing.T) {
 				cm.IO.AssertCalled(t, "PrintTrace", mock.Anything, slacktrace.AppSettingsSuccess, []string{expectedURL})
 			},
 		},
-		"requires an existing application": {
+		"opens app listing page when no apps exist": {
+			Setup: func(t *testing.T, ctx context.Context, cm *shared.ClientsMock, cf *shared.ClientFactory) {
+				cf.SDKConfig.WorkingDirectory = "."
+				projectConfigMock := config.NewProjectConfigMock()
+				projectConfigMock.On(
+					"GetManifestSource",
+					mock.Anything,
+				).Return(
+					config.ManifestSourceRemote,
+					nil,
+				)
+				cm.Config.ProjectConfig = projectConfigMock
+				appSelectMock := prompts.NewAppSelectMock()
+				appSelectMock.On(
+					"AppSelectPrompt",
+					mock.Anything,
+					mock.Anything,
+					prompts.ShowAllEnvironments,
+					prompts.ShowInstalledAndUninstalledApps,
+				).Return(
+					prompts.SelectedApp{},
+					slackerror.New(slackerror.ErrInstallationRequired),
+				)
+				settingsAppSelectPromptFunc = appSelectMock.AppSelectPrompt
+				cm.API.On("Host").Return("https://slack.com")
+			},
+			ExpectedAsserts: func(t *testing.T, ctx context.Context, cm *shared.ClientsMock) {
+				expectedURL := "https://api.slack.com/apps"
+				cm.Browser.AssertCalled(t, "OpenURL", expectedURL)
+				cm.IO.AssertCalled(t, "PrintTrace", mock.Anything, slacktrace.AppSettingsStart, mock.Anything)
+				cm.IO.AssertCalled(t, "PrintTrace", mock.Anything, slacktrace.AppSettingsSuccess, []string{expectedURL})
+			},
+		},
+		"opens app listing page for development environment when no apps exist": {
 			Setup: func(t *testing.T, ctx context.Context, cm *shared.ClientsMock, cf *shared.ClientFactory) {
 				cf.SDKConfig.WorkingDirectory = "."
 				projectConfigMock := config.NewProjectConfigMock()
@@ -137,8 +190,14 @@ func Test_App_SettingsCommand(t *testing.T) {
 					slackerror.New(slackerror.ErrInstallationRequired),
 				)
 				settingsAppSelectPromptFunc = appSelectMock.AppSelectPrompt
+				cm.API.On("Host").Return("https://dev1234.slack.com")
+			},
+			ExpectedAsserts: func(t *testing.T, ctx context.Context, cm *shared.ClientsMock) {
+				expectedURL := "https://api.dev1234.slack.com/apps"
+				cm.Browser.AssertCalled(t, "OpenURL", expectedURL)
+				cm.IO.AssertCalled(t, "PrintTrace", mock.Anything, slacktrace.AppSettingsStart, mock.Anything)
+				cm.IO.AssertCalled(t, "PrintTrace", mock.Anything, slacktrace.AppSettingsSuccess, []string{expectedURL})
 			},
-			ExpectedError: slackerror.New(slackerror.ErrInstallationRequired),
 		},
 		"opens the url to app settings of an app in production": {
 			Setup: func(t *testing.T, ctx context.Context, cm *shared.ClientsMock, cf *shared.ClientFactory) {