🧹

coder · aslilac · Feb 21, 2024 · Feb 9, 2024 · Feb 9, 2024 · Feb 9, 2024
commit eaddb5b5d47ac4250ea1f33dfdd8efe292bd0551
diff --git a/cli/create_test.go b/cli/create_test.go
@@ -757,7 +757,7 @@ func TestCreateWithGitAuth(t *testing.T) {
 			{
 				Type: &proto.Response_Plan{
 					Plan: &proto.PlanComplete{
-						ExternalAuthProviders: []string{"github"},
+						ExternalAuthProviders: []*proto.ExternalAuthProviderResource{{Id: "github"}},
 					},
 				},
 			},

diff --git a/coderd/database/dbauthz/dbauthz_test.go b/coderd/database/dbauthz/dbauthz_test.go
@@ -925,8 +925,7 @@ func (s *MethodTestSuite) TestTemplate() {
 			JobID:      jobID,
 		})
 		check.Args(database.UpdateTemplateVersionExternalAuthProvidersByJobIDParams{
-			JobID:                 jobID,
-			ExternalAuthProviders: []string{},
+			JobID: jobID,
 		}).Asserts(t1, rbac.ActionUpdate).Returns()
 	}))
 	s.Run("GetTemplateInsights", s.Subtest(func(db database.Store, check *expects) {

diff --git a/coderd/provisionerdserver/provisionerdserver_test.go b/coderd/provisionerdserver/provisionerdserver_test.go
@@ -172,11 +172,14 @@ func TestAcquireJob(t *testing.T) {
 			// create an API key with an expiration within the bounds of the
 			// deployment config.
 			dv := &codersdk.DeploymentValues{MaxTokenLifetime: clibase.Duration(time.Hour)}
-			gitAuthProvider := "github"
+			gitAuthProvider := &sdkproto.ExternalAuthProviderResource{
+				Id: "github",
+			}
+
 			srv, db, ps, _ := setup(t, false, &overrides{
 				deploymentValues: dv,
 				externalAuthConfigs: []*externalauth.Config{{
-					ID:                       gitAuthProvider,
+					ID:                       gitAuthProvider.Id,
 					InstrumentedOAuth2Config: &testutil.OAuth2Config{},
 				}},
 			})
@@ -191,7 +194,7 @@ func TestAcquireJob(t *testing.T) {
 				OAuthAccessToken: "access-token",
 			})
 			dbgen.ExternalAuthLink(t, db, database.ExternalAuthLink{
-				ProviderID: gitAuthProvider,
+				ProviderID: gitAuthProvider.Id,
 				UserID:     user.ID,
 			})
 			template := dbgen.Template(t, db, database.Template{
@@ -207,9 +210,11 @@ func TestAcquireJob(t *testing.T) {
 				},
 				JobID: uuid.New(),
 			})
-			err := db.UpdateTemplateVersionExternalAuthProvidersByJobID(ctx, database.UpdateTemplateVersionExternalAuthProvidersByJobIDParams{
+			externalAuthProviders, err := json.Marshal([]*sdkproto.ExternalAuthProviderResource{gitAuthProvider})
+			require.NoError(t, err)
+			err = db.UpdateTemplateVersionExternalAuthProvidersByJobID(ctx, database.UpdateTemplateVersionExternalAuthProvidersByJobIDParams{
 				JobID:                 version.JobID,
-				ExternalAuthProviders: []string{gitAuthProvider},
+				ExternalAuthProviders: json.RawMessage(externalAuthProviders),
 				UpdatedAt:             dbtime.Now(),
 			})
 			require.NoError(t, err)
@@ -321,7 +326,7 @@ func TestAcquireJob(t *testing.T) {
 						},
 					},
 					ExternalAuthProviders: []*sdkproto.ExternalAuthProvider{{
-						Id:          gitAuthProvider,
+						Id:          gitAuthProvider.Id,
 						AccessToken: "access_token",
 					}},
 					Metadata: &sdkproto.Metadata{
@@ -949,8 +954,10 @@ func TestCompleteJob(t *testing.T) {
 							Name: "hello",
 							Type: "aws_instance",
 						}},
-						StopResources:         []*sdkproto.Resource{},
-						ExternalAuthProviders: []string{"github"},
+						StopResources: []*sdkproto.Resource{},
+						ExternalAuthProviders: []*sdkproto.ExternalAuthProviderResource{{
+							Id: "github",
+						}},
 					},
 				},
 			})
@@ -1002,7 +1009,7 @@ func TestCompleteJob(t *testing.T) {
 							Type: "aws_instance",
 						}},
 						StopResources:         []*sdkproto.Resource{},
-						ExternalAuthProviders: []string{"github"},
+						ExternalAuthProviders: []*sdkproto.ExternalAuthProviderResource{{Id: "github"}},
 					},
 				},
 			})

diff --git a/coderd/templateversions_test.go b/coderd/templateversions_test.go
@@ -347,7 +347,7 @@ func TestTemplateVersionsExternalAuth(t *testing.T) {
 			ProvisionPlan: []*proto.Response{{
 				Type: &proto.Response_Plan{
 					Plan: &proto.PlanComplete{
-						ExternalAuthProviders: []string{"github"},
+						ExternalAuthProviders: []*proto.ExternalAuthProviderResource{{Id: "github"}},
 					},
 				},
 			}},

diff --git a/codersdk/templateversions.go b/codersdk/templateversions.go
@@ -41,7 +41,7 @@ type TemplateVersionExternalAuth struct {
 	DisplayIcon     string `json:"display_icon"`
 	AuthenticateURL string `json:"authenticate_url"`
 	Authenticated   bool   `json:"authenticated"`
-	Optional        bool   `json:"optional"`
+	Optional        bool   `json:"optional,omitempty"`
 }
 
 type ValidationMonotonicOrder string

diff --git a/enterprise/coderd/provisionerdaemons.go b/enterprise/coderd/provisionerdaemons.go
@@ -241,7 +241,7 @@ func (api *API) provisionerDaemonServe(rw http.ResponseWriter, r *http.Request)
 
 	if err := proto.CurrentVersion.Validate(apiVersion); err != nil {
 		httpapi.Write(ctx, rw, http.StatusBadRequest, codersdk.Response{
-			Message: "Incompatible or unparseable version",
+			Message: "Incompatible or unparsable version",
 			Validations: []codersdk.ValidationError{
 				{Field: "version", Detail: err.Error()},
 			},

diff --git a/provisioner/terraform/resources.go b/provisioner/terraform/resources.go
@@ -718,8 +718,8 @@ func ConvertState(modules []*tfjson.StateModule, rawGraph string) (*State, error
 		}
 	}
 	externalAuthProviders := make([]*proto.ExternalAuthProviderResource, 0, len(externalAuthProvidersMap))
-	for _, provider := range externalAuthProvidersMap {
-		externalAuthProviders = append(externalAuthProviders, provider)
+	for _, it := range externalAuthProvidersMap {
+		externalAuthProviders = append(externalAuthProviders, it)
 	}
 
 	return &State{

diff --git a/provisioner/terraform/resources_test.go b/provisioner/terraform/resources_test.go
@@ -7,6 +7,7 @@ import (
 	"path/filepath"
 	"runtime"
 	"sort"
+	"strings"
 	"testing"
 
 	tfjson "github.com/hashicorp/terraform-json"
@@ -23,9 +24,9 @@ func TestConvertResources(t *testing.T) {
 	// nolint:dogsled
 	_, filename, _, _ := runtime.Caller(0)
 	type testCase struct {
-		resources        []*proto.Resource
-		parameters       []*proto.RichParameter
-		gitAuthProviders []string
+		resources             []*proto.Resource
+		parameters            []*proto.RichParameter
+		externalAuthProviders []*proto.ExternalAuthProviderResource
 	}
 
 	// If a user doesn't specify 'display_apps' then they default
@@ -486,7 +487,7 @@ func TestConvertResources(t *testing.T) {
 					DisplayApps:              &displayApps,
 				}},
 			}},
-			gitAuthProviders: []string{"github", "gitlab"},
+			externalAuthProviders: []*proto.ExternalAuthProviderResource{{Id: "github"}, {Id: "gitlab"}},
 		},
 		"display-apps": {
 			resources: []*proto.Resource{{
@@ -547,7 +548,7 @@ func TestConvertResources(t *testing.T) {
 				state, err := terraform.ConvertState(modules, string(tfPlanGraph))
 				require.NoError(t, err)
 				sortResources(state.Resources)
-				sort.Strings(state.ExternalAuthProviders)
+				sortExternalAuthProviders(state.ExternalAuthProviders)
 
 				expectedNoMetadata := make([]*proto.Resource, 0)
 				for _, resource := range expected.resources {
@@ -585,7 +586,7 @@ func TestConvertResources(t *testing.T) {
 				require.Equal(t, string(parametersWant), string(parametersGot))
 				require.Equal(t, expectedNoMetadataMap, resourcesMap)
 
-				require.ElementsMatch(t, expected.gitAuthProviders, state.ExternalAuthProviders)
+				require.ElementsMatch(t, expected.externalAuthProviders, state.ExternalAuthProviders)
 			})
 
 			t.Run("Provision", func(t *testing.T) {
@@ -601,7 +602,7 @@ func TestConvertResources(t *testing.T) {
 				state, err := terraform.ConvertState([]*tfjson.StateModule{tfState.Values.RootModule}, string(tfStateGraph))
 				require.NoError(t, err)
 				sortResources(state.Resources)
-				sort.Strings(state.ExternalAuthProviders)
+				sortExternalAuthProviders(state.ExternalAuthProviders)
 				for _, resource := range state.Resources {
 					for _, agent := range resource.Agents {
 						agent.Id = ""
@@ -628,7 +629,7 @@ func TestConvertResources(t *testing.T) {
 				require.NoError(t, err)
 
 				require.Equal(t, expectedMap, resourcesMap)
-				require.ElementsMatch(t, expected.gitAuthProviders, state.ExternalAuthProviders)
+				require.ElementsMatch(t, expected.externalAuthProviders, state.ExternalAuthProviders)
 			})
 		})
 	}
@@ -901,3 +902,9 @@ func sortResources(resources []*proto.Resource) {
 		})
 	}
 }
+
+func sortExternalAuthProviders(providers []*proto.ExternalAuthProviderResource) {
+	sort.Slice(providers, func(i, j int) bool {
+		return strings.Compare(providers[i].Id, providers[j].Id) == -1
+	})
+}
diff --git a/site/src/api/typesGenerated.ts b/site/src/api/typesGenerated.ts
diff --git a/site/src/pages/CreateWorkspacePage/CreateWorkspacePageView.stories.tsx b/site/src/pages/CreateWorkspacePage/CreateWorkspacePageView.stories.tsx
@@ -141,7 +141,6 @@ export const OptionalExternalAuth: Story = {
         authenticate_url: "",
         display_icon: "/icon/github.svg",
         display_name: "GitHub",
-        // @ts-expect-error
         optional: true,
       },
       {
@@ -151,7 +150,6 @@ export const OptionalExternalAuth: Story = {
         authenticate_url: "",
         display_icon: "/icon/gitlab.svg",
         display_name: "GitLab",
-        // @ts-expect-error
         optional: true,
       },
     ],

diff --git a/site/src/pages/CreateWorkspacePage/ExternalAuthWall/ExternalAuthItem.tsx b/site/src/pages/CreateWorkspacePage/ExternalAuthWall/ExternalAuthItem.tsx
@@ -37,7 +37,7 @@ export const ExternalAuthItem: FC<ExternalAuthItemProps> = ({
       <span css={styles.providerHeader}>
         <ExternalImage src={provider.display_icon} css={styles.providerIcon} />
         <strong css={styles.providerName}>{provider.display_name}</strong>
-        {!provider.authenticated && (provider as any).optional && (
+        {!provider.authenticated && provider.optional && (
           <Pill type="notice">Optional</Pill>
         )}
       </span>