add database.ExternalAuthProviders type

coder · aslilac · Feb 21, 2024 · Feb 9, 2024 · Feb 9, 2024 · Feb 9, 2024
commit c5e63eb5648c83ec671ded3868bf2a65864c6516
diff --git a/coderd/database/types.go b/coderd/database/types.go
@@ -64,6 +64,11 @@ func (t TemplateACL) Value() (driver.Value, error) {
 	return json.Marshal(t)
 }
 
+type ExternalAuthProvider struct {
+	ID       string `json:"id"`
+	Optional bool   `json:"optional,omitempty"`
+}
+
 type StringMap map[string]string
 
 func (m *StringMap) Scan(src interface{}) error {

diff --git a/coderd/provisionerdserver/provisionerdserver.go b/coderd/provisionerdserver/provisionerdserver.go
@@ -501,16 +501,16 @@ func (s *server) acquireProtoJob(ctx context.Context, job database.ProvisionerJo
 			return nil, failJob(fmt.Sprintf("get workspace build parameters: %s", err))
 		}
 
-		externalAuthProviderResources := []*sdkproto.ExternalAuthProviderResource{}
-		err = json.Unmarshal(templateVersion.ExternalAuthProviders, &externalAuthProviderResources)
+		dbExternalAuthProviders := []database.ExternalAuthProvider{}
+		err = json.Unmarshal(templateVersion.ExternalAuthProviders, &dbExternalAuthProviders)
 		if err != nil {
 			return nil, xerrors.Errorf("failed to deserialize external_auth_providers value: %w", err)
 		}
 
-		externalAuthProviders := []*sdkproto.ExternalAuthProvider{}
-		for _, p := range externalAuthProviderResources {
+		externalAuthProviders := make([]*sdkproto.ExternalAuthProvider, 0, len(dbExternalAuthProviders))
+		for _, p := range dbExternalAuthProviders {
 			link, err := s.Database.GetExternalAuthLink(ctx, database.GetExternalAuthLinkParams{
-				ProviderID: p.Id,
+				ProviderID: p.ID,
 				UserID:     owner.ID,
 			})
 			if errors.Is(err, sql.ErrNoRows) {
@@ -521,7 +521,7 @@ func (s *server) acquireProtoJob(ctx context.Context, job database.ProvisionerJo
 			}
 			var config *externalauth.Config
 			for _, c := range s.ExternalAuthConfigs {
-				if c.ID != p.Id {
+				if c.ID != p.ID {
 					continue
 				}
 				config = c
@@ -530,21 +530,21 @@ func (s *server) acquireProtoJob(ctx context.Context, job database.ProvisionerJo
 			// We weren't able to find a matching config for the ID!
 			if config == nil {
 				s.Logger.Warn(ctx, "workspace build job is missing external auth provider",
-					slog.F("provider_id", p.Id),
+					slog.F("provider_id", p.ID),
 					slog.F("template_version_id", templateVersion.ID),
 					slog.F("workspace_id", workspaceBuild.WorkspaceID))
 				continue
 			}
 
 			link, valid, err := config.RefreshToken(ctx, s.Database, link)
 			if err != nil {
-				return nil, failJob(fmt.Sprintf("refresh external auth link %q: %s", p.Id, err))
+				return nil, failJob(fmt.Sprintf("refresh external auth link %q: %s", p.ID, err))
 			}
 			if !valid {
 				continue
 			}
 			externalAuthProviders = append(externalAuthProviders, &sdkproto.ExternalAuthProvider{
-				Id:          p.Id,
+				Id:          p.ID,
 				AccessToken: link.OAuthAccessToken,
 			})
 		}
@@ -1153,16 +1153,23 @@ func (s *server) CompleteJob(ctx context.Context, completed *proto.CompletedJob)
 			}
 		}
 
-		externalAuthProviders := jobType.TemplateImport.ExternalAuthProviders
 		// Fallback to `ExternalAuthProvidersNames` if it was specified and `ExternalAuthProviders`
 		// was not. Gives us backwards compatibility with custom provisioners that haven't been
 		// updated to use the new field yet.
-		namesLen := len(jobType.TemplateImport.ExternalAuthProvidersNames)
-		if len(externalAuthProviders) == 0 && namesLen > 0 {
-			externalAuthProviders = make([]*sdkproto.ExternalAuthProviderResource, 0, namesLen)
+		var externalAuthProviders []database.ExternalAuthProvider
+		if providersLen := len(jobType.TemplateImport.ExternalAuthProviders); providersLen > 0 {
+			externalAuthProviders = make([]database.ExternalAuthProvider, 0, providersLen)
+			for _, provider := range jobType.TemplateImport.ExternalAuthProviders {
+				externalAuthProviders = append(externalAuthProviders, database.ExternalAuthProvider{
+					ID:       provider.Id,
+					Optional: provider.Optional,
+				})
+			}
+		} else if namesLen := len(jobType.TemplateImport.ExternalAuthProvidersNames); namesLen > 0 {
+			externalAuthProviders = make([]database.ExternalAuthProvider, 0, namesLen)
 			for _, providerID := range jobType.TemplateImport.ExternalAuthProvidersNames {
-				externalAuthProviders = append(externalAuthProviders, &sdkproto.ExternalAuthProviderResource{
-					Id: providerID,
+				externalAuthProviders = append(externalAuthProviders, database.ExternalAuthProvider{
+					ID: providerID,
 				})
 			}
 		}

diff --git a/coderd/provisionerdserver/provisionerdserver_test.go b/coderd/provisionerdserver/provisionerdserver_test.go
@@ -210,7 +210,10 @@ func TestAcquireJob(t *testing.T) {
 				},
 				JobID: uuid.New(),
 			})
-			externalAuthProviders, err := json.Marshal([]*sdkproto.ExternalAuthProviderResource{gitAuthProvider})
+			externalAuthProviders, err := json.Marshal([]database.ExternalAuthProvider{{
+				ID:       gitAuthProvider.Id,
+				Optional: gitAuthProvider.Optional,
+			}})
 			require.NoError(t, err)
 			err = db.UpdateTemplateVersionExternalAuthProvidersByJobID(ctx, database.UpdateTemplateVersionExternalAuthProvidersByJobIDParams{
 				JobID:                 version.JobID,

diff --git a/coderd/templateversions.go b/coderd/templateversions.go
@@ -289,7 +289,7 @@ func (api *API) templateVersionExternalAuth(rw http.ResponseWriter, r *http.Requ
 		templateVersion = httpmw.TemplateVersionParam(r)
 	)
 
-	var rawProviders []*sdkproto.ExternalAuthProviderResource
+	var rawProviders []database.ExternalAuthProvider
 	err := json.Unmarshal(templateVersion.ExternalAuthProviders, &rawProviders)
 	if err != nil {
 		httpapi.Write(ctx, rw, http.StatusInternalServerError, codersdk.Response{
@@ -303,14 +303,14 @@ func (api *API) templateVersionExternalAuth(rw http.ResponseWriter, r *http.Requ
 	for _, rawProvider := range rawProviders {
 		var config *externalauth.Config
 		for _, provider := range api.ExternalAuthConfigs {
-			if provider.ID == rawProvider.Id {
+			if provider.ID == rawProvider.ID {
 				config = provider
 				break
 			}
 		}
 		if config == nil {
 			httpapi.Write(ctx, rw, http.StatusNotFound, codersdk.Response{
-				Message: fmt.Sprintf("The template version references a Git auth provider %q that no longer exists.", rawProvider),
+				Message: fmt.Sprintf("The template version references a Git auth provider %q that no longer exists.", rawProvider.ID),
 				Detail:  "You'll need to update the template version to use a different provider.",
 			})
 			return

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: []*proto.ExternalAuthProviderResource{{Id: "github"}},
+						ExternalAuthProviders: []*proto.ExternalAuthProviderResource{{Id: "github", Optional: true}},
 					},
 				},
 			}},
@@ -373,6 +373,7 @@ func TestTemplateVersionsExternalAuth(t *testing.T) {
 		require.NoError(t, err)
 		require.Len(t, providers, 1)
 		require.True(t, providers[0].Authenticated)
+		require.True(t, providers[0].Optional)
 	})
 }
 

diff --git a/provisionerd/runner/runner.go b/provisionerd/runner/runner.go
@@ -564,14 +564,21 @@ func (r *Runner) runTemplateImport(ctx context.Context) (*proto.CompletedJob, *p
 		return nil, r.failedJobf("template import provision for stop: %s", err)
 	}
 
+	// For backwards compatibility with older versions of coderd
+	externalAuthProviderNames := make([]string, 0, len(startProvision.ExternalAuthProviders))
+	for _, it := range startProvision.ExternalAuthProviders {
+		externalAuthProviderNames = append(externalAuthProviderNames, it.Id)
+	}
+
 	return &proto.CompletedJob{
 		JobId: r.job.JobId,
 		Type: &proto.CompletedJob_TemplateImport_{
 			TemplateImport: &proto.CompletedJob_TemplateImport{
-				StartResources:        startProvision.Resources,
-				StopResources:         stopProvision.Resources,
-				RichParameters:        startProvision.Parameters,
-				ExternalAuthProviders: startProvision.ExternalAuthProviders,
+				StartResources:             startProvision.Resources,
+				StopResources:              stopProvision.Resources,
+				RichParameters:             startProvision.Parameters,
+				ExternalAuthProvidersNames: externalAuthProviderNames,
+				ExternalAuthProviders:      startProvision.ExternalAuthProviders,
 			},
 		},
 	}, nil