Update feature gate logging to include default on

cmd/postgres-operator/main.go

@@ -134,7 +134,10 @@ func main() {
 
 	features := feature.NewGate()
 	assertNoError(features.Set(os.Getenv("PGO_FEATURE_GATES")))
-	log.Info("feature gates enabled", "PGO_FEATURE_GATES", features.String())
+
+	ctx = feature.NewContext(ctx, features)
+	// This logs just the feature gates as set by the user
+	log.Info("feature gates enabled during deployment", "PGO_FEATURE_GATES", feature.ShowAssigned(ctx))
 
 	cfg, err := runtime.GetConfig()
 	assertNoError(err)

internal/feature/features.go

@@ -42,6 +42,9 @@ package feature
 
 import (
 	"context"
+	"fmt"
+	"slices"
+	"strings"
 
 	"k8s.io/component-base/featuregate"
 )
@@ -51,7 +54,6 @@ type Feature = featuregate.Feature
 // Gate indicates what features exist and which are enabled.
 type Gate interface {
 	Enabled(Feature) bool
-	String() string
 }
 
 // MutableGate contains features that can be enabled or disabled.
@@ -122,11 +124,36 @@ func NewContext(ctx context.Context, gate Gate) context.Context {
 	return context.WithValue(ctx, contextKey{}, gate)
 }
 
-func ShowGates(ctx context.Context) string {
-	featuresEnabled := ""
-	gate, ok := ctx.Value(contextKey{}).(Gate)
-	if ok {
-		featuresEnabled = gate.String()
+// ShowEnabled returns all the features enabled in the Gate contained in ctx.
+func ShowEnabled(ctx context.Context) string {
+	featuresEnabled := []string{}
+	if gate, ok := ctx.Value(contextKey{}).(interface {
+		Gate
+		GetAll() map[Feature]featuregate.FeatureSpec
+	}); ok {
+		specs := gate.GetAll()
+		for feature := range specs {
+			// `gate.Enabled` first checks if the feature is enabled;
+			// then (if not explicitly set by the user),
+			// it checks if the feature is on/true by default
+			if gate.Enabled(feature) {
+				featuresEnabled = append(featuresEnabled, fmt.Sprintf("%s=true", feature))
+			}
+		}
+	}
+	slices.Sort(featuresEnabled)
+	return strings.Join(featuresEnabled, ",")
+}
+
+// ShowAssigned returns the features enabled or disabled by Set and SetFromMap
+// in the Gate contained in ctx.
+func ShowAssigned(ctx context.Context) string {
+	featuresAssigned := ""
+	if gate, ok := ctx.Value(contextKey{}).(interface {
+		Gate
+		String() string
+	}); ok {
+		featuresAssigned = gate.String()
 	}
-	return featuresEnabled
+	return featuresAssigned
 }

internal/feature/features_test.go

@@ -6,6 +6,7 @@ package feature
 
 import (
 	"context"
+	"strings"
 	"testing"
 
 	"gotest.tools/v3/assert"
@@ -23,8 +24,6 @@ func TestDefaults(t *testing.T) {
 	assert.Assert(t, false == gate.Enabled(PGBouncerSidecars))
 	assert.Assert(t, false == gate.Enabled(TablespaceVolumes))
 	assert.Assert(t, false == gate.Enabled(VolumeSnapshots))
-
-	assert.Equal(t, gate.String(), "")
 }
 
 func TestStringFormat(t *testing.T) {
@@ -33,7 +32,6 @@ func TestStringFormat(t *testing.T) {
 
 	assert.NilError(t, gate.Set(""))
 	assert.NilError(t, gate.Set("TablespaceVolumes=true"))
-	assert.Equal(t, gate.String(), "TablespaceVolumes=true")
 	assert.Assert(t, true == gate.Enabled(TablespaceVolumes))
 
 	err := gate.Set("NotAGate=true")
@@ -53,13 +51,21 @@ func TestContext(t *testing.T) {
 	t.Parallel()
 	gate := NewGate()
 	ctx := NewContext(context.Background(), gate)
-	assert.Equal(t, ShowGates(ctx), "")
+
+	assert.Equal(t, ShowAssigned(ctx), "")
+	assert.Assert(t, ShowEnabled(ctx) != "") // This assumes some feature is enabled by default.
 
 	assert.NilError(t, gate.Set("TablespaceVolumes=true"))
-	assert.Assert(t, true == Enabled(ctx, TablespaceVolumes))
-	assert.Equal(t, ShowGates(ctx), "TablespaceVolumes=true")
+	assert.Assert(t, Enabled(ctx, TablespaceVolumes))
+	assert.Equal(t, ShowAssigned(ctx), "TablespaceVolumes=true")
+	assert.Assert(t,
+		strings.Contains(ShowEnabled(ctx), "TablespaceVolumes=true"),
+		"got: %v", ShowEnabled(ctx))
 
 	assert.NilError(t, gate.SetFromMap(map[string]bool{TablespaceVolumes: false}))
-	assert.Assert(t, false == Enabled(ctx, TablespaceVolumes))
-	assert.Equal(t, ShowGates(ctx), "TablespaceVolumes=false")
+	assert.Assert(t, !Enabled(ctx, TablespaceVolumes))
+	assert.Equal(t, ShowAssigned(ctx), "TablespaceVolumes=false")
+	assert.Assert(t,
+		!strings.Contains(ShowEnabled(ctx), "TablespaceVolumes"),
+		"got: %v", ShowEnabled(ctx))
 }

internal/upgradecheck/header.go

@@ -57,7 +57,7 @@ func generateHeader(ctx context.Context, cfg *rest.Config, crClient crclient.Cli
 		BridgeClustersTotal: getBridgeClusters(ctx, crClient),
 		BuildSource:         os.Getenv("BUILD_SOURCE"),
 		DeploymentID:        ensureDeploymentID(ctx, crClient),
-		FeatureGatesEnabled: feature.ShowGates(ctx),
+		FeatureGatesEnabled: feature.ShowEnabled(ctx),
 		IsOpenShift:         isOpenShift,
 		KubernetesEnv:       getServerVersion(ctx, cfg),
 		PGOClustersTotal:    getManagedClusters(ctx, crClient),

internal/upgradecheck/header_test.go

@@ -136,7 +136,10 @@ func TestGenerateHeader(t *testing.T) {
 		assert.Equal(t, len(pgoList.Items), res.PGOClustersTotal)
 		assert.Equal(t, "1.2.3", res.PGOVersion)
 		assert.Equal(t, server.String(), res.KubernetesEnv)
-		assert.Equal(t, "TablespaceVolumes=true", res.FeatureGatesEnabled)
+		assert.Check(t, strings.Contains(
+			res.FeatureGatesEnabled,
+			"TablespaceVolumes=true",
+		))
 		assert.Equal(t, "test", res.PGOInstaller)
 		assert.Equal(t, "test-origin", res.PGOInstallerOrigin)
 		assert.Equal(t, "developer", res.BuildSource)

internal/upgradecheck/http_test.go

@@ -69,7 +69,7 @@ func TestCheckForUpgrades(t *testing.T) {
 		assert.Equal(t, data.RegistrationToken, "speakFriend")
 		assert.Equal(t, data.BridgeClustersTotal, 2)
 		assert.Equal(t, data.PGOClustersTotal, 2)
-		assert.Equal(t, data.FeatureGatesEnabled, "TablespaceVolumes=true")
+		assert.Equal(t, data.FeatureGatesEnabled, "AutoCreateUserSchema=true,TablespaceVolumes=true")
 	}
 
 	t.Run("success", func(t *testing.T) {