Merge branch 'main' into mwbrooks-snyk

Author: mwbrooks

go.mod

@@ -18,7 +18,7 @@ require (
 	github.com/nfnt/resize v0.0.0-20180221191011-83c6a9932646
 	github.com/oliamb/cutter v0.2.2
 	github.com/opentracing/opentracing-go v1.2.0
-	github.com/pelletier/go-toml/v2 v2.3.0
+	github.com/pelletier/go-toml/v2 v2.3.1
 	github.com/pkg/browser v0.0.0-20240102092130-5ac0b6a4141c
 	github.com/pkg/errors v0.9.1
 	github.com/radovskyb/watcher v1.0.7

go.sum

@@ -1019,8 +1019,8 @@ github.com/pborman/getopt v0.0.0-20170112200414-7148bc3a4c30/go.mod h1:85jBQOZwp
 github.com/pborman/getopt v0.0.0-20180811024354-2b5b3bfb099b/go.mod h1:85jBQOZwpVEaDAr341tbn15RS4fCAsIst0qp7i8ex1o=
 github.com/pelletier/go-toml v1.9.5 h1:4yBQzkHv+7BHq2PQUZF3Mx0IYxG7LsP222s7Agd3ve8=
 github.com/pelletier/go-toml v1.9.5/go.mod h1:u1nR/EPcESfeI/szUZKdtJ0xRNbUoANCkoOuaOx1Y+c=
-github.com/pelletier/go-toml/v2 v2.3.0 h1:k59bC/lIZREW0/iVaQR8nDHxVq8OVlIzYCOJf421CaM=
-github.com/pelletier/go-toml/v2 v2.3.0/go.mod h1:2gIqNv+qfxSVS7cM2xJQKtLSTLUE9V8t9Stt+h56mCY=
+github.com/pelletier/go-toml/v2 v2.3.1 h1:MYEvvGnQjeNkRF1qUuGolNtNExTDwct51yp7olPtrEc=
+github.com/pelletier/go-toml/v2 v2.3.1/go.mod h1:2gIqNv+qfxSVS7cM2xJQKtLSTLUE9V8t9Stt+h56mCY=
 github.com/pjbgf/sha1cd v0.5.0 h1:a+UkboSi1znleCDUNT3M5YxjOnN1fz2FhN48FlwCxs0=
 github.com/pjbgf/sha1cd v0.5.0/go.mod h1:lhpGlyHLpQZoxMv8HcgXvZEhcGs0PG/vsZnEJ7H0iCM=
 github.com/pkg/browser v0.0.0-20240102092130-5ac0b6a4141c h1:+mdjkGKdHQG3305AYmdv1U2eRNDiU2ErMBj1gwrq8eQ=

internal/shared/types/app_manifest.go

@@ -239,8 +239,10 @@ type ManifestInteractivity struct {
 
 // ManifestScopes
 type ManifestScopes struct {
-	Bot  []string `json:"bot,omitempty" yaml:"bot,flow,omitempty"`
-	User []string `json:"user,omitempty" yaml:"user,flow,omitempty"`
+	Bot          []string `json:"bot,omitempty" yaml:"bot,flow,omitempty"`
+	BotOptional  []string `json:"bot_optional,omitempty" yaml:"bot_optional,flow,omitempty"`
+	User         []string `json:"user,omitempty" yaml:"user,flow,omitempty"`
+	UserOptional []string `json:"user_optional,omitempty" yaml:"user_optional,flow,omitempty"`
 }
 
 // ManifestShortcutsItem

internal/shared/types/app_manifest_test.go

@@ -336,6 +336,62 @@ func Test_AppManifest_AppSettings_IncomingWebhooks(t *testing.T) {
 	}
 }
 
+func Test_AppManifest_OAuthConfig_Scopes(t *testing.T) {
+	tests := map[string]struct {
+		oauthConfig  *OAuthConfig
+		expectedJSON string
+	}{
+		"undefined scopes are omitted": {
+			oauthConfig:  &OAuthConfig{},
+			expectedJSON: `{}`,
+		},
+		"empty scopes are included": {
+			oauthConfig:  &OAuthConfig{Scopes: &ManifestScopes{}},
+			expectedJSON: `{"scopes":{}}`,
+		},
+		"bot scopes are included": {
+			oauthConfig: &OAuthConfig{Scopes: &ManifestScopes{
+				Bot: []string{"chat:write", "channels:read"},
+			}},
+			expectedJSON: `{"scopes":{"bot":["chat:write","channels:read"]}}`,
+		},
+		"user scopes are included": {
+			oauthConfig: &OAuthConfig{Scopes: &ManifestScopes{
+				User: []string{"users:read"},
+			}},
+			expectedJSON: `{"scopes":{"user":["users:read"]}}`,
+		},
+		"bot optional scopes are included": {
+			oauthConfig: &OAuthConfig{Scopes: &ManifestScopes{
+				BotOptional: []string{"channels:history"},
+			}},
+			expectedJSON: `{"scopes":{"bot_optional":["channels:history"]}}`,
+		},
+		"user optional scopes are included": {
+			oauthConfig: &OAuthConfig{Scopes: &ManifestScopes{
+				UserOptional: []string{"users:read.email"},
+			}},
+			expectedJSON: `{"scopes":{"user_optional":["users:read.email"]}}`,
+		},
+		"all scope types are included": {
+			oauthConfig: &OAuthConfig{Scopes: &ManifestScopes{
+				Bot:          []string{"chat:write"},
+				BotOptional:  []string{"channels:history"},
+				User:         []string{"users:read"},
+				UserOptional: []string{"users:read.email"},
+			}},
+			expectedJSON: `{"scopes":{"bot":["chat:write"],"bot_optional":["channels:history"],"user":["users:read"],"user_optional":["users:read.email"]}}`,
+		},
+	}
+	for name, tc := range tests {
+		t.Run(name, func(t *testing.T) {
+			actualJSON, err := json.Marshal(tc.oauthConfig)
+			require.NoError(t, err)
+			assert.Equal(t, tc.expectedJSON, string(actualJSON))
+		})
+	}
+}
+
 func Test_AppManifest_AppSettings_FunctionRuntime(t *testing.T) {
 	tests := map[string]struct {
 		settings        *AppSettings