change "bitbucket" to "bitbucket-cloud"

Emyrk · Emyrk · commit 57da5cc68fb3 · 2023-11-06T10:16:55.000-06:00
diff --git a/coderd/externalauth/externalauth.go b/coderd/externalauth/externalauth.go
@@ -495,8 +495,18 @@ func ConvertConfig(entries []codersdk.ExternalAuthConfig, accessURL *url.URL) ([
 
 // applyDefaultsToConfig applies defaults to the config entry.
 func applyDefaultsToConfig(config *codersdk.ExternalAuthConfig) {
+	configType := codersdk.EnhancedExternalAuthProvider(config.Type)
+	if configType == "bitbucket" {
+		// For backwards compatibility, we need to support the "bitbucket" string.
+		configType = codersdk.EnhancedExternalAuthProviderBitBucketCloud
+		defer func() {
+			// The config type determines the config ID (if unset). So change the legacy
+			// type to the correct new type after the defaults have been configured.
+			config.Type = string(codersdk.EnhancedExternalAuthProviderBitBucketCloud)
+		}()
+	}
 	// If static defaults exist, apply them.
-	if defaults, ok := staticDefaults[codersdk.EnhancedExternalAuthProvider(config.Type)]; ok {
+	if defaults, ok := staticDefaults[configType]; ok {
 		copyDefaultSettings(config, defaults)
 		return
 	}
@@ -607,7 +617,7 @@ var staticDefaults = map[codersdk.EnhancedExternalAuthProvider]codersdk.External
 		Regex:       `^(https?://)?dev\.azure\.com(/.*)?$`,
 		Scopes:      []string{"vso.code_write"},
 	},
-	codersdk.EnhancedExternalAuthProviderBitBucket: {
+	codersdk.EnhancedExternalAuthProviderBitBucketCloud: {
 		AuthURL:     "https://bitbucket.org/site/oauth2/authorize",
 		TokenURL:    "https://bitbucket.org/site/oauth2/access_token",
 		ValidateURL: "https://api.bitbucket.org/2.0/user",
diff --git a/coderd/externalauth/externalauth_internal_test.go b/coderd/externalauth/externalauth_internal_test.go
@@ -19,7 +19,7 @@ func Test_bitbucketServerConfigDefaults(t *testing.T) {
 	}{
 		{
 			// Very few fields are statically defined for Bitbucket Server.
-			name: "EmpyBitbucketServer",
+			name: "EmptyBitbucketServer",
 			config: &codersdk.ExternalAuthConfig{
 				Type: bbType,
 			},
@@ -50,6 +50,25 @@ func Test_bitbucketServerConfigDefaults(t *testing.T) {
 				DisplayIcon: "/icon/bitbucket.svg",
 			},
 		},
+		{
+			// Ensure backwards compatibility. The type should update to "bitbucket-cloud",
+			// but the ID and other fields should remain the same.
+			name: "BitbucketLegacy",
+			config: &codersdk.ExternalAuthConfig{
+				Type: "bitbucket",
+			},
+			expected: codersdk.ExternalAuthConfig{
+				Type:        string(codersdk.EnhancedExternalAuthProviderBitBucketCloud),
+				ID:          "bitbucket", // Legacy ID remains unchanged
+				AuthURL:     "https://bitbucket.org/site/oauth2/authorize",
+				TokenURL:    "https://bitbucket.org/site/oauth2/access_token",
+				ValidateURL: "https://api.bitbucket.org/2.0/user",
+				DisplayName: "BitBucket",
+				DisplayIcon: "/icon/bitbucket.svg",
+				Regex:       `^(https?://)?bitbucket\.org(/.*)?$`,
+				Scopes:      []string{"account", "repository:write"},
+			},
+		},
 	}
 	for _, tt := range tests {
 		tt := tt
diff --git a/coderd/workspaceagents.go b/coderd/workspaceagents.go
@@ -2452,7 +2452,8 @@ func createExternalAuthResponse(typ, token string, extra pqtype.NullRawMessage)
 			Username: "oauth2",
 			Password: token,
 		}
-	case string(codersdk.EnhancedExternalAuthProviderBitBucket), string(codersdk.EnhancedExternalAuthProviderBitBucketServer):
+	case string(codersdk.EnhancedExternalAuthProviderBitBucketCloud), string(codersdk.EnhancedExternalAuthProviderBitBucketServer):
+		// The string "bitbucket" was a legacy parameter that needs to still be supported.
 		// https://support.atlassian.com/bitbucket-cloud/docs/use-oauth-on-bitbucket-cloud/#Cloning-a-repository-with-an-access-token
 		resp = agentsdk.ExternalAuthResponse{
 			Username: "x-token-auth",
diff --git a/codersdk/externalauth.go b/codersdk/externalauth.go
@@ -21,7 +21,7 @@ func (e EnhancedExternalAuthProvider) Git() bool {
 	switch e {
 	case EnhancedExternalAuthProviderGitHub,
 		EnhancedExternalAuthProviderGitLab,
-		EnhancedExternalAuthProviderBitBucket,
+		EnhancedExternalAuthProviderBitBucketCloud,
 		EnhancedExternalAuthProviderBitBucketServer,
 		EnhancedExternalAuthProviderAzureDevops:
 		return true
@@ -34,9 +34,9 @@ const (
 	EnhancedExternalAuthProviderAzureDevops EnhancedExternalAuthProvider = "azure-devops"
 	EnhancedExternalAuthProviderGitHub      EnhancedExternalAuthProvider = "github"
 	EnhancedExternalAuthProviderGitLab      EnhancedExternalAuthProvider = "gitlab"
-	// EnhancedExternalAuthProviderBitBucket is the Bitbucket Cloud provider.
+	// EnhancedExternalAuthProviderBitBucketCloud is the Bitbucket Cloud provider.
 	// Not to be confused with the self-hosted 'EnhancedExternalAuthProviderBitBucketServer'
-	EnhancedExternalAuthProviderBitBucket       EnhancedExternalAuthProvider = "bitbucket"
+	EnhancedExternalAuthProviderBitBucketCloud  EnhancedExternalAuthProvider = "bitbucket-cloud"
 	EnhancedExternalAuthProviderBitBucketServer EnhancedExternalAuthProvider = "bitbucket-server"
 	EnhancedExternalAuthProviderSlack           EnhancedExternalAuthProvider = "slack"
 	EnhancedExternalAuthProviderJFrog           EnhancedExternalAuthProvider = "jfrog"
