CBG-3607: disable the ability to set shared_bucket_access to false. I… (#6590)

* CBG-3607: disable the ability to set shared_bucket_access to false. In future we will probably look to fully remove the config param but for now this will protect against panics

* remove comment slashes + add test comments

* updates off review + failing test in integration test run

* missed test update

* lint error fix

* add skip for lint?

Author: gregns1

base/util_testing.go

@@ -209,6 +209,9 @@ func TestUseXattrs() bool {
 	if err != nil {
 		panic(fmt.Sprintf("unable to parse %q value %q: %v", TestEnvSyncGatewayUseXattrs, useXattrs, err))
 	}
+	if !val {
+		panic("sync gateway requires xattrs to be enabled")
+	}
 
 	return val
 }

db/revision_cache_interface.go

@@ -327,10 +327,11 @@ func revCacheLoaderForDocument(ctx context.Context, backingStore RevisionCacheBa
 }
 
 // revCacheLoaderForDocumentCV used either during cache miss (from revCacheLoaderForCv), or used directly when getting current active CV from cache
+// nolint:staticcheck
 func revCacheLoaderForDocumentCV(ctx context.Context, backingStore RevisionCacheBackingStore, doc *Document, cv SourceAndVersion) (bodyBytes []byte, body Body, history Revisions, channels base.Set, removed bool, attachments AttachmentsMeta, deleted bool, expiry *time.Time, revid string, err error) {
 	if bodyBytes, body, attachments, err = backingStore.getCurrentVersion(ctx, doc); err != nil {
+		// TODO: pending CBG-3213 support of channel removal for CV
 		// we need implementation of IsChannelRemoval for CV here.
-		// pending CBG-3213 support of channel removal for CV
 	}
 
 	if err = doc.HasCurrentVersion(cv); err != nil {

rest/adminapitest/admin_api_test.go

@@ -2471,7 +2471,7 @@ func TestHandlePutDbConfigWithBackticksCollections(t *testing.T) {
 	reqBodyWithBackticks := `{
         "server": "walrus:",
         "bucket": "backticks",
-		"enable_shared_bucket_access":false,
+		"enable_shared_bucket_access":true,
 		"scopes": {
 			"scope1": {
 			  "collections" : {

rest/api_test.go

@@ -2746,6 +2746,79 @@ func TestNullDocHandlingForMutable1xBody(t *testing.T) {
 	assert.Contains(t, err.Error(), "null doc body for doc")
 }
 
+// TestDatabaseXattrConfigHandlingForDBConfigUpdate:
+//   - Create database with xattrs enabled
+//   - Test updating the config to disable the use of xattrs in this database through replacing + upserting the config
+//   - Assert error code is returned and response contains error string
+func TestDatabaseXattrConfigHandlingForDBConfigUpdate(t *testing.T) {
+	base.LongRunningTest(t)
+	const (
+		dbName  = "db1"
+		errResp = "sync gateway requires enable_shared_bucket_access=true"
+	)
+
+	testCases := []struct {
+		name         string
+		upsertConfig bool
+	}{
+		{
+			name:         "POST update",
+			upsertConfig: true,
+		},
+		{
+			name:         "PUT update",
+			upsertConfig: false,
+		},
+	}
+	for _, testCase := range testCases {
+		t.Run(testCase.name, func(t *testing.T) {
+			rt := NewRestTester(t, &RestTesterConfig{
+				PersistentConfig: true,
+			})
+			defer rt.Close()
+
+			dbConfig := rt.NewDbConfig()
+
+			resp := rt.CreateDatabase(dbName, dbConfig)
+			RequireStatus(t, resp, http.StatusCreated)
+			assert.NoError(t, rt.WaitForDBOnline())
+
+			dbConfig.EnableXattrs = base.BoolPtr(false)
+
+			if testCase.upsertConfig {
+				resp = rt.UpsertDbConfig(dbName, dbConfig)
+				RequireStatus(t, resp, http.StatusInternalServerError)
+				assert.Contains(t, resp.Body.String(), errResp)
+			} else {
+				resp = rt.ReplaceDbConfig(dbName, dbConfig)
+				RequireStatus(t, resp, http.StatusInternalServerError)
+				assert.Contains(t, resp.Body.String(), errResp)
+			}
+		})
+	}
+}
+
+// TestCreateDBWithXattrsDisbaled:
+//   - Test that you cannot create a database with xattrs disabled
+//   - Assert error code is returned and response contains error string
+func TestCreateDBWithXattrsDisbaled(t *testing.T) {
+	rt := NewRestTester(t, &RestTesterConfig{
+		PersistentConfig: true,
+	})
+	defer rt.Close()
+	const (
+		dbName  = "db1"
+		errResp = "sync gateway requires enable_shared_bucket_access=true"
+	)
+
+	dbConfig := rt.NewDbConfig()
+	dbConfig.EnableXattrs = base.BoolPtr(false)
+
+	resp := rt.CreateDatabase(dbName, dbConfig)
+	RequireStatus(t, resp, http.StatusInternalServerError)
+	assert.Contains(t, resp.Body.String(), errResp)
+}
+
 // TestPutDocUpdateVersionVector:
 //   - Put a doc and assert that the versions and the source for the hlv is correctly updated
 //   - Update that doc and assert HLV has also been updated

rest/server_context.go

@@ -1085,6 +1085,11 @@ func dbcOptionsFromConfig(ctx context.Context, sc *ServerContext, config *DbConf
 		}
 	}
 
+	// In sync gateway version 4.0+ we do not support the disabling of use of xattrs
+	if !config.UseXattrs() {
+		return db.DatabaseContextOptions{}, fmt.Errorf("sync gateway requires enable_shared_bucket_access=true")
+	}
+
 	// Create a callback function that will be invoked if the database goes offline and comes
 	// back online again
 	dbOnlineCallback := func(dbContext *db.DatabaseContext) {

rest/serverless_test.go

@@ -319,6 +319,7 @@ func TestServerlessSuspendDatabase(t *testing.T) {
 	assert.NotNil(t, sc.dbConfigs["db"])
 
 	// Update config in bucket to see if unsuspending check for updates
+	sc.dbConfigs["db"].EnableXattrs = base.BoolPtr(true) // xattrs must be enabled
 	cas, err := sc.BootstrapContext.UpdateConfig(base.TestCtx(t), tb.GetName(), sc.Config.Bootstrap.ConfigGroupID, "db", func(bucketDbConfig *DatabaseConfig) (updatedConfig *DatabaseConfig, err error) {
 		config := sc.dbConfigs["db"].ToDatabaseConfig()
 		config.cfgCas = bucketDbConfig.cfgCas