PR comments

coder · Emyrk · Aug 30, 2024 · Aug 28, 2024 · Aug 26, 2024 · Aug 26, 2024
commit e18bc8f43f20512159fa336d1260fa3a23d4d920
diff --git a/coderd/coderd.go b/coderd/coderd.go
@@ -275,8 +275,6 @@ func New(options *Options) *API {
 		options.Entitlements = entitlements.New()
 	}
 	if options.IDPSync == nil {
-		// If this is set in the options, it is probably the enterprise
-		// version of the code.
 		options.IDPSync = idpsync.NewAGPLSync(options.Logger, idpsync.SyncSettings{
 			OrganizationField:         options.DeploymentValues.OIDC.OrganizationField.Value(),
 			OrganizationMapping:       options.DeploymentValues.OIDC.OrganizationMapping.Value,

diff --git a/coderd/idpsync/idpsync.go b/coderd/idpsync/idpsync.go
@@ -52,6 +52,18 @@ type SyncSettings struct {
 	OrganizationAssignDefault bool
 }
 
+type OrganizationParams struct {
+	// SyncEnabled if false will skip syncing the user's organizations.
+	SyncEnabled bool
+	// IncludeDefault is primarily for single org deployments. It will ensure
+	// a user is always inserted into the default org.
+	IncludeDefault bool
+	// Organizations is the list of organizations the user should be a member of
+	// assuming syncing is turned on.
+	Organizations []uuid.UUID
+}
+
+
 func NewAGPLSync(logger slog.Logger, settings SyncSettings) *AGPLIDPSync {
 	return &AGPLIDPSync{
 		Logger:       logger.Named("idp-sync"),

diff --git a/coderd/idpsync/organization.go b/coderd/idpsync/organization.go
@@ -30,17 +30,6 @@ func (s AGPLIDPSync) ParseOrganizationClaims(_ context.Context, _ jwt.MapClaims)
 	}, nil
 }
 
-type OrganizationParams struct {
-	// SyncEnabled if false will skip syncing the user's organizations.
-	SyncEnabled bool
-	// IncludeDefault is primarily for single org deployments. It will ensure
-	// a user is always inserted into the default org.
-	IncludeDefault bool
-	// Organizations is the list of organizations the user should be a member of
-	// assuming syncing is turned on.
-	Organizations []uuid.UUID
-}
-
 // SyncOrganizations if enabled will ensure the user is a member of the provided
 // organizations. It will add and remove their membership to match the expected set.
 func (s AGPLIDPSync) SyncOrganizations(ctx context.Context, tx database.Store, user database.User, params OrganizationParams) error {

diff --git a/enterprise/coderd/enidpsync/enidpsync.go b/enterprise/coderd/enidpsync/enidpsync.go
@@ -7,6 +7,11 @@ import (
 	"github.com/coder/coder/v2/coderd/idpsync"
 )
 
+// EnterpriseIDPSync enabled syncing user information from an external IDP.
+// The sync is an enterprise feature, so this struct wraps the AGPL implementation
+// and extends it with enterprise capabilities. These capabilities can entirely
+// be changed in the Parsing, and leaving the "syncing" part (which holds the
+// more complex logic) to the shared AGPL implementation.
 type EnterpriseIDPSync struct {
 	entitlements *entitlements.Set
 	*idpsync.AGPLIDPSync