chore: add comment that explains require_telemetry behavior (#6211)

ammario · web-flow · commit 5e4931efaf10 · 2023-02-15T01:40:08.000Z
diff --git a/enterprise/coderd/coderd.go b/enterprise/coderd/coderd.go
@@ -242,22 +242,27 @@ func (api *API) updateEntitlements(ctx context.Context) error {
 	api.entitlementsMu.Lock()
 	defer api.entitlementsMu.Unlock()
 
-	entitlements, err := license.Entitlements(ctx, api.Database, api.Logger, len(api.replicaManager.All()), len(api.GitAuthConfigs), api.Keys, map[codersdk.FeatureName]bool{
-		codersdk.FeatureAuditLog:                   api.AuditLogging,
-		codersdk.FeatureBrowserOnly:                api.BrowserOnly,
-		codersdk.FeatureSCIM:                       len(api.SCIMAPIKey) != 0,
-		codersdk.FeatureHighAvailability:           api.DERPServerRelayAddress != "",
-		codersdk.FeatureMultipleGitAuth:            len(api.GitAuthConfigs) > 1,
-		codersdk.FeatureTemplateRBAC:               api.RBAC,
-		codersdk.FeatureExternalProvisionerDaemons: true,
-	})
+	entitlements, err := license.Entitlements(
+		ctx, api.Database,
+		api.Logger, len(api.replicaManager.All()), len(api.GitAuthConfigs), api.Keys, map[codersdk.FeatureName]bool{
+			codersdk.FeatureAuditLog:                   api.AuditLogging,
+			codersdk.FeatureBrowserOnly:                api.BrowserOnly,
+			codersdk.FeatureSCIM:                       len(api.SCIMAPIKey) != 0,
+			codersdk.FeatureHighAvailability:           api.DERPServerRelayAddress != "",
+			codersdk.FeatureMultipleGitAuth:            len(api.GitAuthConfigs) > 1,
+			codersdk.FeatureTemplateRBAC:               api.RBAC,
+			codersdk.FeatureExternalProvisionerDaemons: true,
+		})
 	if err != nil {
 		return err
 	}
 
 	if entitlements.RequireTelemetry && !api.DeploymentConfig.Telemetry.Enable.Value {
 		// We can't fail because then the user couldn't remove the offending
 		// license w/o a restart.
+		//
+		// We don't simply append to entitlement.Errors since we don't want any
+		// enterprise features enabled.
 		api.entitlements.Errors = []string{
 			"License requires telemetry but telemetry is disabled",
 		}
