Stamp several default values into DefaultDbConfig for visibility in include_runtime - add test to catch future missed fields

Author: bbrks

rest/config_database.go

@@ -11,6 +11,7 @@ package rest
 import (
 	"context"
 
+	"github.com/couchbase/sync_gateway/auth"
 	"github.com/couchbase/sync_gateway/base"
 	"github.com/couchbase/sync_gateway/channels"
 	"github.com/couchbase/sync_gateway/db"
@@ -160,7 +161,7 @@ func DefaultDbConfig(sc *StartupConfig, useXattrs bool) *DbConfig {
 		LocalDocExpirySecs:    base.Ptr(base.DefaultLocalDocExpirySecs),
 		EnableXattrs:          base.Ptr(base.DefaultUseXattrs),
 		SecureCookieOverride:  base.Ptr(sc.API.HTTPS.TLSCertPath != ""),
-		SessionCookieName:     "",
+		SessionCookieName:     auth.DefaultCookieName,
 		SessionCookieHTTPOnly: base.Ptr(false),
 		AllowConflicts:        base.Ptr(base.DefaultAllowConflicts),
 		Index: &IndexConfig{
@@ -169,7 +170,7 @@ func DefaultDbConfig(sc *StartupConfig, useXattrs bool) *DbConfig {
 		UseViews:                    base.Ptr(false),
 		SendWWWAuthenticateHeader:   base.Ptr(true),
 		DisablePasswordAuth:         base.Ptr(false),
-		BucketOpTimeoutMs:           nil,
+		BucketOpTimeoutMs:           base.Ptr(uint32(base.DefaultGocbV2OperationTimeout.Milliseconds())),
 		SlowQueryWarningThresholdMs: base.Ptr(kDefaultSlowQueryWarningThreshold),
 		DeltaSync: &DeltaSyncConfig{
 			Enabled:          base.Ptr(db.DefaultDeltaSyncEnabled),
@@ -184,6 +185,7 @@ func DefaultDbConfig(sc *StartupConfig, useXattrs bool) *DbConfig {
 		QueryPaginationLimit:             base.Ptr(db.DefaultQueryPaginationLimit),
 		UserXattrKey:                     nil,
 		ClientPartitionWindowSecs:        base.Ptr(int(base.DefaultClientPartitionWindow.Seconds())),
+		Guest:                            &auth.PrincipalConfig{Disabled: base.Ptr(true)},
 		JavascriptTimeoutSecs:            base.Ptr(base.DefaultJavascriptTimeoutSecs),
 		Suspendable:                      base.Ptr(sc.IsServerless()),
 		ChangesRequestPlus:               base.Ptr(false),
@@ -195,6 +197,8 @@ func DefaultDbConfig(sc *StartupConfig, useXattrs bool) *DbConfig {
 		dbConfig.AutoImport = base.Ptr(base.DefaultAutoImport)
 		if base.IsEnterpriseEdition() {
 			dbConfig.ImportPartitions = base.Ptr(base.GetDefaultImportPartitions(sc.IsServerless()))
+		} else {
+			dbConfig.ImportPartitions = base.Ptr(uint16(0))
 		}
 		dbConfig.Index.NumPartitions = base.Ptr(db.DefaultNumIndexPartitions)
 	} else {

rest/config_database_test.go

@@ -12,6 +12,7 @@ import (
 	"encoding/json"
 	"fmt"
 	"net/http"
+	"reflect"
 	"testing"
 	"time"
 
@@ -29,6 +30,70 @@ func TestDefaultDbConfig(t *testing.T) {
 	require.Equal(t, db.DefaultCompactInterval, time.Duration(compactIntervalDays)*time.Hour*24)
 }
 
+// TestDefaultDbConfigFieldCoverage ensures that all fields in DbConfig are either:
+// 1. Set to a non-zero value in DefaultDbConfig(), or
+// 2. Explicitly listed in the allowlist as intentionally unset
+//
+// This prevents new fields from being added to DbConfig without considering whether
+// they should have a default value exposed in include_runtime=true config output.
+func TestDefaultDbConfigFieldCoverage(t *testing.T) {
+	sc := DefaultStartupConfig("/default/log/file/path")
+	defaultConfig := DefaultDbConfig(&sc, true)
+
+	// Fields that are intentionally left unset in DefaultDbConfig.
+	// When adding a field here, add a comment explaining why it doesn't need a default.
+	intentionallyUnsetFields := map[string]string{
+		// Embedded struct - fields checked separately
+		"BucketConfig":           "embedded struct, fields checked separately",
+		"Scopes":                 "opt-in with no default",
+		"Replications":           "opt-in with no default",
+		"UserFunctions":          "opt-in with no default",
+		"OIDCConfig":             "opt-in with no default",
+		"LocalJWTConfig":         "opt-in with no default",
+		"CORS":                   "opt-in with no default",
+		"EventHandlers":          "opt-in with no default",
+		"ImportFilter":           "opt-in with no default",
+		"UserXattrKey":           "opt-in with no default",
+		"Name":                   "stamped at runtime",
+		"UpdatedAt":              "persisted timestamp",
+		"CreatedAt":              "persisted timestamp",
+		"Unsupported":            "unsupported",
+		"DeprecatedRevCacheSize": "deprecated",
+		"NumIndexReplicas":       "deprecated",
+		"FeedType":               "deprecated",
+		"Users":                  "legacy config",
+		"Roles":                  "legacy config",
+	}
+
+	configType := reflect.TypeFor[DbConfig]()
+	configValue := reflect.ValueOf(*defaultConfig)
+
+	for i := 0; i < configType.NumField(); i++ {
+		field := configType.Field(i)
+		fieldName := field.Name
+		fieldValue := configValue.Field(i)
+
+		// Skip unexported fields
+		if !field.IsExported() {
+			t.Logf("%q: Skipping unexported field", fieldName)
+			continue
+		}
+
+		// Check if field is in the allowlist
+		if reason, ok := intentionallyUnsetFields[fieldName]; ok {
+			if testing.Verbose() {
+				t.Logf("%q: intentionally unset: %s", fieldName, reason)
+			}
+			continue
+		}
+
+		// Check if the field has a non-zero value
+		if fieldValue.IsZero() {
+			assert.Failf(t, "Field not present in DefaultDbConfig", "%q: missing - either add a default value in DefaultDbConfig() or add it to the allowlist with a reason", fieldName)
+		}
+	}
+}
+
 func TestDbConfigUpdatedAtField(t *testing.T) {
 	b := base.GetTestBucket(t)
 	rt := NewRestTester(t, &RestTesterConfig{