Fix #1335: add general-purpose Feature flag system

CONFIGURATION.md

@@ -71,10 +71,17 @@ Other Quarkus properties that are specifically relevant for the service:
 
 
 ## Command level logging configuration
-*Configuration for command level logging, defined by [CommandLoggingConfig.java](src/main/java/io/stargate/sgv2/jsonapi/config/CommandLoggingConfig.java).*
+*Configuration for command level logging, defined by [CommandLevelLoggingConfig.java](src/main/java/io/stargate/sgv2/jsonapi/config/CommandLoggingConfig.java).*
 
 | Property                                            | Type      | Default | Description                                                                                                                                                        |
 |-----------------------------------------------------|-----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | `stargate.jsonapi.logging.enabled`                  | `boolean` | `false` | Setting it to `true` enables command level logging.                                                                                                                |
 | `stargate.jsonapi.logging.only-results-with-errors` | `boolean` | `true`  | Setting it to `true` prints the command level info only for the commands where the command result has errors.                                                      |
 | `stargate.jsonapi.logging.enabled-tenants`          | `string`  | `ALL`   | Comma separated list of tenants for which command level logging should be enabled. Default is a special keyword called `ALL` which prints this log for all tenants |
+
+## API Feature enabling configuration
+*Configuration for enabling Features, defined by [FeaturesConfig.java](src/main/java/io/stargate/sgv2/jsonapi/config/CommandLoggingConfig.java).*
+
+| Property                        | Type      | Default | Description                                                                                                         |
+|---------------------------------|-----------|---------|---------------------------------------------------------------------------------------------------------------------|
+| `stargate.feature.flags.tables` | `boolean` | `null`   | Setting it to `true` enables Tables functionality; `false` disables; leaving as `null` allows per-request override.|

pom.xml

@@ -238,7 +238,7 @@
     <dependency>
       <groupId>org.junit-pioneer</groupId>
       <artifactId>junit-pioneer</artifactId>
-      <version>2.0.0</version>
+      <version>2.2.0</version>
       <scope>test</scope>
     </dependency>
     <dependency>

src/main/java/io/stargate/sgv2/jsonapi/api/model/command/CommandContext.java

@@ -2,6 +2,7 @@
 
 import com.google.common.base.Preconditions;
 import io.stargate.sgv2.jsonapi.api.v1.metrics.JsonProcessingMetricsReporter;
+import io.stargate.sgv2.jsonapi.config.feature.ApiFeatures;
 import io.stargate.sgv2.jsonapi.exception.ErrorCodeV1;
 import io.stargate.sgv2.jsonapi.service.cqldriver.executor.*;
 import io.stargate.sgv2.jsonapi.service.embedding.operation.EmbeddingProvider;
@@ -16,7 +17,8 @@ public record CommandContext<T extends SchemaObject>(
     T schemaObject,
     EmbeddingProvider embeddingProvider,
     String commandName,
-    JsonProcessingMetricsReporter jsonProcessingMetricsReporter) {
+    JsonProcessingMetricsReporter jsonProcessingMetricsReporter,
+    ApiFeatures apiFeatures) {
 
   // TODO: this is what the original EMPTY had, no idea why the name of the command is missing
   // this is used by the GeneralResource
@@ -40,26 +42,31 @@ public static <T extends SchemaObject> CommandContext<T> forSchemaObject(
       T schemaObject,
       EmbeddingProvider embeddingProvider,
       String commandName,
-      JsonProcessingMetricsReporter jsonProcessingMetricsReporter) {
+      JsonProcessingMetricsReporter jsonProcessingMetricsReporter,
+      ApiFeatures apiFeatures) {
 
     // TODO: upgrade to use the modern switch statements
     // TODO: how to remove the unchecked cast ? Had to use unchecked cast to get back to the
     // CommandContext<T>
     if (schemaObject instanceof CollectionSchemaObject cso) {
       return (CommandContext<T>)
-          forSchemaObject(cso, embeddingProvider, commandName, jsonProcessingMetricsReporter);
+          forSchemaObject(
+              cso, embeddingProvider, commandName, jsonProcessingMetricsReporter, apiFeatures);
     }
     if (schemaObject instanceof TableSchemaObject tso) {
       return (CommandContext<T>)
-          forSchemaObject(tso, embeddingProvider, commandName, jsonProcessingMetricsReporter);
+          forSchemaObject(
+              tso, embeddingProvider, commandName, jsonProcessingMetricsReporter, apiFeatures);
     }
     if (schemaObject instanceof KeyspaceSchemaObject kso) {
       return (CommandContext<T>)
-          forSchemaObject(kso, embeddingProvider, commandName, jsonProcessingMetricsReporter);
+          forSchemaObject(
+              kso, embeddingProvider, commandName, jsonProcessingMetricsReporter, apiFeatures);
     }
     if (schemaObject instanceof DatabaseSchemaObject dso) {
       return (CommandContext<T>)
-          forSchemaObject(dso, embeddingProvider, commandName, jsonProcessingMetricsReporter);
+          forSchemaObject(
+              dso, embeddingProvider, commandName, jsonProcessingMetricsReporter, apiFeatures);
     }
     throw ErrorCodeV1.SERVER_INTERNAL_ERROR.toApiException(
         "Unknown schema object type: %s", schemaObject.getClass().getName());
@@ -79,9 +86,10 @@ public static CommandContext<CollectionSchemaObject> forSchemaObject(
       CollectionSchemaObject schemaObject,
       EmbeddingProvider embeddingProvider,
       String commandName,
-      JsonProcessingMetricsReporter jsonProcessingMetricsReporter) {
+      JsonProcessingMetricsReporter jsonProcessingMetricsReporter,
+      ApiFeatures apiFeatures) {
     return new CommandContext<>(
-        schemaObject, embeddingProvider, commandName, jsonProcessingMetricsReporter);
+        schemaObject, embeddingProvider, commandName, jsonProcessingMetricsReporter, apiFeatures);
   }
 
   /**
@@ -98,9 +106,10 @@ public static CommandContext<TableSchemaObject> forSchemaObject(
       TableSchemaObject schemaObject,
       EmbeddingProvider embeddingProvider,
       String commandName,
-      JsonProcessingMetricsReporter jsonProcessingMetricsReporter) {
+      JsonProcessingMetricsReporter jsonProcessingMetricsReporter,
+      ApiFeatures apiFeatures) {
     return new CommandContext<>(
-        schemaObject, embeddingProvider, commandName, jsonProcessingMetricsReporter);
+        schemaObject, embeddingProvider, commandName, jsonProcessingMetricsReporter, apiFeatures);
   }
 
   /**
@@ -117,9 +126,10 @@ public static CommandContext<KeyspaceSchemaObject> forSchemaObject(
       KeyspaceSchemaObject schemaObject,
       EmbeddingProvider embeddingProvider,
       String commandName,
-      JsonProcessingMetricsReporter jsonProcessingMetricsReporter) {
+      JsonProcessingMetricsReporter jsonProcessingMetricsReporter,
+      ApiFeatures apiFeatures) {
     return new CommandContext<>(
-        schemaObject, embeddingProvider, commandName, jsonProcessingMetricsReporter);
+        schemaObject, embeddingProvider, commandName, jsonProcessingMetricsReporter, apiFeatures);
   }
 
   /**
@@ -136,9 +146,10 @@ public static CommandContext<DatabaseSchemaObject> forSchemaObject(
       DatabaseSchemaObject schemaObject,
       EmbeddingProvider embeddingProvider,
       String commandName,
-      JsonProcessingMetricsReporter jsonProcessingMetricsReporter) {
+      JsonProcessingMetricsReporter jsonProcessingMetricsReporter,
+      ApiFeatures apiFeatures) {
     return new CommandContext<>(
-        schemaObject, embeddingProvider, commandName, jsonProcessingMetricsReporter);
+        schemaObject, embeddingProvider, commandName, jsonProcessingMetricsReporter, apiFeatures);
   }
 
   @SuppressWarnings("unchecked")

src/main/java/io/stargate/sgv2/jsonapi/api/request/DataApiRequestInfo.java

@@ -18,6 +18,7 @@ public class DataApiRequestInfo {
   private final Optional<String> tenantId;
   private final Optional<String> cassandraToken;
   private final EmbeddingCredentials embeddingCredentials;
+  private final HttpHeaderAccess httpHeaders;
 
   /**
    * Constructor that will be useful in the offline library mode, where only the tenant will be set
@@ -29,6 +30,7 @@ public DataApiRequestInfo(Optional<String> tenantId) {
     this.tenantId = tenantId;
     this.cassandraToken = Optional.empty();
     this.embeddingCredentials = null;
+    httpHeaders = null;
   }
 
   @Inject
@@ -41,6 +43,7 @@ public DataApiRequestInfo(
     this.embeddingCredentials = apiKeysResolver.get().resolveEmbeddingCredentials(routingContext);
     this.tenantId = (tenantResolver.get()).resolve(routingContext, securityContext);
     this.cassandraToken = (tokenResolver.get()).resolve(routingContext, securityContext);
+    httpHeaders = new HttpHeaderAccess(routingContext.request().headers());
   }
 
   public Optional<String> getTenantId() {
@@ -54,4 +57,40 @@ public Optional<String> getCassandraToken() {
   public EmbeddingCredentials getEmbeddingCredentials() {
     return this.embeddingCredentials;
   }
+
+  public HttpHeaderAccess getHttpHeaders() {
+    return this.httpHeaders;
+  }
+
+  /**
+   * Simple wrapper around internal HTTP header container, providing safe(r) access to typed header
+   * values. Minimal API, currently mainly used for feature flags.
+   */
+  public static class HttpHeaderAccess {
+    private final io.vertx.core.MultiMap headers;
+
+    public HttpHeaderAccess(io.vertx.core.MultiMap headers) {
+      this.headers = headers;
+    }
+
+    /**
+     * Accessor for getting value of given header, as {@code Boolean} if (and only if!) value is one
+     * of "true" or "false". Access by name is (and has to be) case-insensitive as per HTTP
+     * standard.
+     *
+     * @param headerName Name of header to check
+     * @return Boolean.TRUE if header value is "true", Boolean.FALSE if "false", or null if not
+     */
+    public Boolean getHeaderAsBoolean(String headerName) {
+      String str = headers.get(headerName);
+      // Only consider strict "true" and "false"; ignore other values
+      if ("true".equals(str)) {
+        return Boolean.TRUE;
+      }
+      if ("false".equals(str)) {
+        return Boolean.FALSE;
+      }
+      return null;
+    }
+  }
 }

src/main/java/io/stargate/sgv2/jsonapi/api/v1/CollectionResource.java

@@ -20,9 +20,14 @@
 import io.stargate.sgv2.jsonapi.api.request.DataApiRequestInfo;
 import io.stargate.sgv2.jsonapi.api.v1.metrics.JsonProcessingMetricsReporter;
 import io.stargate.sgv2.jsonapi.config.constants.OpenApiConstants;
+import io.stargate.sgv2.jsonapi.config.feature.ApiFeature;
+import io.stargate.sgv2.jsonapi.config.feature.ApiFeatures;
+import io.stargate.sgv2.jsonapi.config.feature.FeaturesConfig;
+import io.stargate.sgv2.jsonapi.exception.ErrorCodeV1;
 import io.stargate.sgv2.jsonapi.exception.JsonApiException;
 import io.stargate.sgv2.jsonapi.exception.mappers.ThrowableCommandResultSupplier;
 import io.stargate.sgv2.jsonapi.service.cqldriver.executor.SchemaCache;
+import io.stargate.sgv2.jsonapi.service.cqldriver.executor.SchemaObject;
 import io.stargate.sgv2.jsonapi.service.cqldriver.executor.VectorConfig;
 import io.stargate.sgv2.jsonapi.service.embedding.operation.EmbeddingProvider;
 import io.stargate.sgv2.jsonapi.service.embedding.operation.EmbeddingProviderFactory;
@@ -68,6 +73,8 @@ public class CollectionResource {
 
   @Inject private DataApiRequestInfo dataApiRequestInfo;
 
+  @Inject FeaturesConfig apiFeatureConfig;
+
   @Inject private JsonProcessingMetricsReporter jsonProcessingMetricsReporter;
 
   @Inject
@@ -181,6 +188,14 @@ public Uni<RestResponse<CommandResult>> postCommand(
                 return Uni.createFrom().item(new ThrowableCommandResultSupplier(error));
               } else {
                 // TODO No need for the else clause here, simplify
+                final ApiFeatures apiFeatures =
+                    ApiFeatures.fromConfigAndRequest(
+                        apiFeatureConfig, dataApiRequestInfo.getHttpHeaders());
+                if ((schemaObject.type == SchemaObject.SchemaObjectType.TABLE)
+                    && !apiFeatures.isFeatureEnabled(ApiFeature.TABLES)) {
+                  return Uni.createFrom()
+                      .failure(ErrorCodeV1.TABLE_FEATURE_NOT_ENABLED.toApiException());
+                }
                 // TODO: refactor this code to be cleaner so it assigns on one line
                 EmbeddingProvider embeddingProvider = null;
                 final VectorConfig.VectorizeConfig vectorizeConfig =
@@ -203,7 +218,8 @@ public Uni<RestResponse<CommandResult>> postCommand(
                         schemaObject,
                         embeddingProvider,
                         command.getClass().getSimpleName(),
-                        jsonProcessingMetricsReporter);
+                        jsonProcessingMetricsReporter,
+                        apiFeatures);
 
                 return meteredCommandProcessor.processCommand(
                     dataApiRequestInfo, commandContext, command);

src/main/java/io/stargate/sgv2/jsonapi/api/v1/GeneralResource.java

@@ -7,6 +7,8 @@
 import io.stargate.sgv2.jsonapi.api.model.command.impl.CreateNamespaceCommand;
 import io.stargate.sgv2.jsonapi.api.request.DataApiRequestInfo;
 import io.stargate.sgv2.jsonapi.config.constants.OpenApiConstants;
+import io.stargate.sgv2.jsonapi.config.feature.ApiFeatures;
+import io.stargate.sgv2.jsonapi.config.feature.FeaturesConfig;
 import io.stargate.sgv2.jsonapi.service.cqldriver.executor.DatabaseSchemaObject;
 import io.stargate.sgv2.jsonapi.service.processor.MeteredCommandProcessor;
 import jakarta.inject.Inject;
@@ -37,6 +39,8 @@ public class GeneralResource {
 
   @Inject private DataApiRequestInfo dataApiRequestInfo;
 
+  @Inject FeaturesConfig apiFeatureConfig;
+
   public static final String BASE_PATH = "/v1";
 
   private final MeteredCommandProcessor meteredCommandProcessor;
@@ -75,10 +79,16 @@ public GeneralResource(MeteredCommandProcessor meteredCommandProcessor) {
                   })))
   @POST
   public Uni<RestResponse<CommandResult>> postCommand(@NotNull @Valid GeneralCommand command) {
+    final ApiFeatures apiFeatures =
+        ApiFeatures.fromConfigAndRequest(apiFeatureConfig, dataApiRequestInfo.getHttpHeaders());
 
     var commandContext =
         CommandContext.forSchemaObject(
-            new DatabaseSchemaObject(), null, command.getClass().getSimpleName(), null);
+            new DatabaseSchemaObject(),
+            null,
+            command.getClass().getSimpleName(),
+            null,
+            apiFeatures);
 
     return meteredCommandProcessor
         .processCommand(dataApiRequestInfo, commandContext, command)

src/main/java/io/stargate/sgv2/jsonapi/api/v1/NamespaceResource.java

@@ -9,8 +9,10 @@
 import io.stargate.sgv2.jsonapi.api.model.command.impl.DeleteCollectionCommand;
 import io.stargate.sgv2.jsonapi.api.model.command.impl.FindCollectionsCommand;
 import io.stargate.sgv2.jsonapi.api.request.DataApiRequestInfo;
-import io.stargate.sgv2.jsonapi.config.ApiTablesConfig;
 import io.stargate.sgv2.jsonapi.config.constants.OpenApiConstants;
+import io.stargate.sgv2.jsonapi.config.feature.ApiFeature;
+import io.stargate.sgv2.jsonapi.config.feature.ApiFeatures;
+import io.stargate.sgv2.jsonapi.config.feature.FeaturesConfig;
 import io.stargate.sgv2.jsonapi.exception.ErrorCodeV1;
 import io.stargate.sgv2.jsonapi.exception.mappers.ThrowableCommandResultSupplier;
 import io.stargate.sgv2.jsonapi.service.cqldriver.executor.KeyspaceSchemaObject;
@@ -51,7 +53,7 @@ public class NamespaceResource {
 
   @Inject private DataApiRequestInfo dataApiRequestInfo;
 
-  @Inject ApiTablesConfig apiTablesConfig;
+  @Inject FeaturesConfig apiFeatureConfig;
 
   @Inject
   public NamespaceResource(MeteredCommandProcessor meteredCommandProcessor) {
@@ -106,22 +108,26 @@ public Uni<RestResponse<CommandResult>> postCommand(
           @Size(min = 1, max = 48)
           String namespace) {
 
-    if (command instanceof TableOnlyCommand && !apiTablesConfig.enabled()) {
-      return Uni.createFrom()
-          .item(
-              new ThrowableCommandResultSupplier(
-                  ErrorCodeV1.TABLE_FEATURE_NOT_ENABLED.toApiException()))
-          .map(commandResult -> commandResult.toRestResponse());
-    }
+    final ApiFeatures apiFeatures =
+        ApiFeatures.fromConfigAndRequest(apiFeatureConfig, dataApiRequestInfo.getHttpHeaders());
 
     // create context
     // TODO: Aaron , left here to see what CTOR was used, there was a lot of different ones.
     //    CommandContext commandContext = new CommandContext(namespace, null);
     // HACK TODO: The above did not set a command name on the command context, how did that work ?
     CommandContext<KeyspaceSchemaObject> commandContext =
-        new CommandContext<>(new KeyspaceSchemaObject(namespace), null, "", null);
+        new CommandContext<>(new KeyspaceSchemaObject(namespace), null, "", null, apiFeatures);
+
+    // Need context first to check if feature is enabled
+    if (command instanceof TableOnlyCommand && !apiFeatures.isFeatureEnabled(ApiFeature.TABLES)) {
+      return Uni.createFrom()
+          .item(
+              new ThrowableCommandResultSupplier(
+                  ErrorCodeV1.TABLE_FEATURE_NOT_ENABLED.toApiException()))
+          .map(commandResult -> commandResult.toRestResponse());
+    }
 
-    //     call processor
+    // call processor
     return meteredCommandProcessor
         .processCommand(dataApiRequestInfo, commandContext, command)
         // map to 2xx unless overridden by error