Follow up for PR #1251: Remove Optional and centralize validation

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

@@ -1,5 +1,8 @@
 package io.stargate.sgv2.jsonapi.api.request;
 
+import static io.stargate.sgv2.jsonapi.config.constants.HttpConstants.EMBEDDING_AUTHENTICATION_TOKEN_HEADER_NAME;
+import static io.stargate.sgv2.jsonapi.exception.ErrorCode.EMBEDDING_PROVIDER_API_KEY_MISSING;
+
 import io.stargate.sgv2.jsonapi.api.request.tenant.DataApiTenantResolver;
 import io.stargate.sgv2.jsonapi.api.request.token.DataApiTokenResolver;
 import io.vertx.ext.web.RoutingContext;
@@ -54,4 +57,14 @@ public Optional<String> getCassandraToken() {
   public Optional<String> getEmbeddingApiKey() {
     return this.embeddingApiKey;
   }
+
+  public String getAndValidateEmbeddingApiKey() {
+    Optional<String> apiKey = getEmbeddingApiKey();
+    if (apiKey.isEmpty()) {
+      throw EMBEDDING_PROVIDER_API_KEY_MISSING.toApiException(
+          "header value `%s` is missing in the request.",
+          EMBEDDING_AUTHENTICATION_TOKEN_HEADER_NAME);
+    }
+    return apiKey.get();
+  }
 }

src/main/java/io/stargate/sgv2/jsonapi/service/embedding/DataVectorizer.java

@@ -20,7 +20,6 @@
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
-import java.util.Optional;
 
 /**
  * Utility class to execute embedding serive to get vector embeddings for the text fields in the
@@ -30,7 +29,7 @@
 public class DataVectorizer {
   private final EmbeddingProvider embeddingProvider;
   private final JsonNodeFactory nodeFactory;
-  private final Optional<String> embeddingApiKey;
+  private final String embeddingApiKey;
   private final CollectionSettings collectionSettings;
 
   /**
@@ -45,7 +44,7 @@ public class DataVectorizer {
   public DataVectorizer(
       EmbeddingProvider embeddingProvider,
       JsonNodeFactory nodeFactory,
-      Optional<String> embeddingApiKey,
+      String embeddingApiKey,
       CollectionSettings collectionSettings) {
     this.embeddingProvider = embeddingProvider;
     this.nodeFactory = nodeFactory;

src/main/java/io/stargate/sgv2/jsonapi/service/embedding/DataVectorizerService.java

@@ -62,7 +62,7 @@ public Uni<Command> vectorize(
         new DataVectorizer(
             embeddingProvider,
             objectMapper.getNodeFactory(),
-            dataApiRequestInfo.getEmbeddingApiKey(),
+            dataApiRequestInfo.getAndValidateEmbeddingApiKey(),
             commandContext.collectionSettings());
     return vectorizeSortClause(dataVectorizer, commandContext, command)
         .onItem()

src/main/java/io/stargate/sgv2/jsonapi/service/embedding/gateway/EmbeddingGatewayClient.java

@@ -83,10 +83,7 @@ public EmbeddingGatewayClient(
    */
   @Override
   public Uni<Response> vectorize(
-      int batchId,
-      List<String> texts,
-      Optional<String> apiKey,
-      EmbeddingRequestType embeddingRequestType) {
+      int batchId, List<String> texts, String apiKey, EmbeddingRequestType embeddingRequestType) {
     Map<String, EmbeddingGateway.ProviderEmbedRequest.EmbeddingRequest.ParameterValue>
         grpcVectorizeServiceParameter = new HashMap<>();
     if (vectorizeServiceParameter != null) {
@@ -136,8 +133,8 @@ else if (value instanceof Boolean)
             .setProviderName(provider)
             .setTenantId(tenant.orElse(DEFAULT_TENANT_ID));
     builder.putAuthTokens(DATA_API_KEY, authToken.orElse(""));
-    if (apiKey.isPresent()) {
-      builder.putAuthTokens(API_KEY, apiKey.get());
+    if (null != apiKey) {
+      builder.putAuthTokens(API_KEY, apiKey);
     }
     if (authentication != null) {
       builder.putAllAuthTokens(authentication);

src/main/java/io/stargate/sgv2/jsonapi/service/embedding/operation/AzureOpenAIEmbeddingProvider.java

@@ -16,7 +16,6 @@
 import java.util.Collections;
 import java.util.List;
 import java.util.Map;
-import java.util.Optional;
 import java.util.concurrent.TimeUnit;
 import org.eclipse.microprofile.rest.client.annotation.ClientHeaderParam;
 import org.eclipse.microprofile.rest.client.annotation.RegisterProvider;
@@ -111,17 +110,13 @@ private record Usage(int prompt_tokens, int total_tokens) {}
 
   @Override
   public Uni<Response> vectorize(
-      int batchId,
-      List<String> texts,
-      Optional<String> apiKey,
-      EmbeddingRequestType embeddingRequestType) {
-    checkEmbeddingApiKeyHeader(providerId, apiKey);
+      int batchId, List<String> texts, String apiKey, EmbeddingRequestType embeddingRequestType) {
     String[] textArray = new String[texts.size()];
     EmbeddingRequest request = new EmbeddingRequest(texts.toArray(textArray), modelName, dimension);
 
     // NOTE: NO "Bearer " prefix with API key for Azure OpenAI
     Uni<EmbeddingResponse> response =
-        applyRetry(openAIEmbeddingProviderClient.embed(apiKey.get(), request));
+        applyRetry(openAIEmbeddingProviderClient.embed(apiKey, request));
 
     return response
         .onItem()

src/main/java/io/stargate/sgv2/jsonapi/service/embedding/operation/CohereEmbeddingProvider.java

@@ -16,7 +16,6 @@
 import java.util.Collections;
 import java.util.List;
 import java.util.Map;
-import java.util.Optional;
 import java.util.concurrent.TimeUnit;
 import org.eclipse.microprofile.rest.client.annotation.ClientHeaderParam;
 import org.eclipse.microprofile.rest.client.annotation.RegisterProvider;
@@ -123,20 +122,15 @@ public void setEmbeddings(List<float[]> embeddings) {
 
   @Override
   public Uni<Response> vectorize(
-      int batchId,
-      List<String> texts,
-      Optional<String> apiKey,
-      EmbeddingRequestType embeddingRequestType) {
-    checkEmbeddingApiKeyHeader(providerId, apiKey);
-
+      int batchId, List<String> texts, String apiKey, EmbeddingRequestType embeddingRequestType) {
     String[] textArray = new String[texts.size()];
     String input_type =
         embeddingRequestType == EmbeddingRequestType.INDEX ? SEARCH_DOCUMENT : SEARCH_QUERY;
     EmbeddingRequest request =
         new EmbeddingRequest(texts.toArray(textArray), modelName, input_type);
 
     Uni<EmbeddingResponse> response =
-        applyRetry(cohereEmbeddingProviderClient.embed("Bearer " + apiKey.get(), request));
+        applyRetry(cohereEmbeddingProviderClient.embed("Bearer " + apiKey, request));
 
     return response
         .onItem()

src/main/java/io/stargate/sgv2/jsonapi/service/embedding/operation/EmbeddingProvider.java

@@ -1,16 +1,12 @@
 package io.stargate.sgv2.jsonapi.service.embedding.operation;
 
-import static io.stargate.sgv2.jsonapi.config.constants.HttpConstants.EMBEDDING_AUTHENTICATION_TOKEN_HEADER_NAME;
-import static io.stargate.sgv2.jsonapi.exception.ErrorCode.EMBEDDING_PROVIDER_API_KEY_MISSING;
-
 import io.smallrye.mutiny.Uni;
 import io.stargate.sgv2.jsonapi.exception.ErrorCode;
 import io.stargate.sgv2.jsonapi.exception.JsonApiException;
 import io.stargate.sgv2.jsonapi.service.embedding.configuration.EmbeddingProviderConfigStore;
 import java.time.Duration;
 import java.util.List;
 import java.util.Map;
-import java.util.Optional;
 import java.util.concurrent.TimeoutException;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -79,10 +75,7 @@ protected <T> Uni<T> applyRetry(Uni<T> uni) {
    * @return VectorResponse
    */
   public abstract Uni<Response> vectorize(
-      int batchId,
-      List<String> texts,
-      Optional<String> apiKey,
-      EmbeddingRequestType embeddingRequestType);
+      int batchId, List<String> texts, String apiKey, EmbeddingRequestType embeddingRequestType);
 
   /**
    * returns the maximum batch size supported by the provider
@@ -137,15 +130,6 @@ protected String replaceParameters(String template, Map<String, Object> paramete
     return baseUrl.toString();
   }
 
-  /** Helper method to check if the API key is present in the header */
-  protected void checkEmbeddingApiKeyHeader(String providerId, Optional<String> apiKey) {
-    if (apiKey.isEmpty()) {
-      throw EMBEDDING_PROVIDER_API_KEY_MISSING.toApiException(
-          "header value `%s` is missing for embedding provider: %s",
-          EMBEDDING_AUTHENTICATION_TOKEN_HEADER_NAME, providerId);
-    }
-  }
-
   /**
    * Record to hold the batchId and embedding vectors
    *

src/main/java/io/stargate/sgv2/jsonapi/service/embedding/operation/HuggingFaceDedicatedEmbeddingProvider.java

@@ -97,18 +97,12 @@ private record Usage(int prompt_tokens, int total_tokens) {}
 
   @Override
   public Uni<Response> vectorize(
-      int batchId,
-      List<String> texts,
-      Optional<String> apiKey,
-      EmbeddingRequestType embeddingRequestType) {
-    checkEmbeddingApiKeyHeader(providerId, apiKey);
-
+      int batchId, List<String> texts, String apiKey, EmbeddingRequestType embeddingRequestType) {
     String[] textArray = new String[texts.size()];
     EmbeddingRequest request = new EmbeddingRequest(texts.toArray(textArray));
 
     Uni<EmbeddingResponse> response =
-        applyRetry(
-            huggingFaceDedicatedEmbeddingProviderClient.embed("Bearer " + apiKey.get(), request));
+        applyRetry(huggingFaceDedicatedEmbeddingProviderClient.embed("Bearer " + apiKey, request));
 
     return response
         .onItem()

src/main/java/io/stargate/sgv2/jsonapi/service/embedding/operation/HuggingFaceEmbeddingProvider.java

@@ -16,7 +16,6 @@
 import java.util.Collections;
 import java.util.List;
 import java.util.Map;
-import java.util.Optional;
 import java.util.concurrent.TimeUnit;
 import org.eclipse.microprofile.rest.client.annotation.ClientHeaderParam;
 import org.eclipse.microprofile.rest.client.annotation.RegisterProvider;
@@ -91,14 +90,11 @@ public record Options(boolean waitForModel) {}
 
   @Override
   public Uni<Response> vectorize(
-      int batchId,
-      List<String> texts,
-      Optional<String> apiKey,
-      EmbeddingRequestType embeddingRequestType) {
+      int batchId, List<String> texts, String apiKey, EmbeddingRequestType embeddingRequestType) {
     EmbeddingRequest request = new EmbeddingRequest(texts, new EmbeddingRequest.Options(true));
 
     return applyRetry(
-            huggingFaceEmbeddingProviderClient.embed("Bearer " + apiKey.get(), modelName, request))
+            huggingFaceEmbeddingProviderClient.embed("Bearer " + apiKey, modelName, request))
         .onItem()
         .transform(
             resp -> {

src/main/java/io/stargate/sgv2/jsonapi/service/embedding/operation/JinaAIEmbeddingProvider.java

@@ -95,16 +95,11 @@ private record Usage(int prompt_tokens, int total_tokens) {}
 
   @Override
   public Uni<Response> vectorize(
-      int batchId,
-      List<String> texts,
-      Optional<String> apiKey,
-      EmbeddingRequestType embeddingRequestType) {
-    checkEmbeddingApiKeyHeader(providerId, apiKey);
-
+      int batchId, List<String> texts, String apiKey, EmbeddingRequestType embeddingRequestType) {
     EmbeddingRequest request = new EmbeddingRequest(texts, modelName);
 
     Uni<EmbeddingResponse> response =
-        applyRetry(jinaAIEmbeddingProviderClient.embed("Bearer " + apiKey.get(), request));
+        applyRetry(jinaAIEmbeddingProviderClient.embed("Bearer " + apiKey, request));
 
     return response
         .onItem()

src/main/java/io/stargate/sgv2/jsonapi/service/embedding/operation/MeteredEmbeddingProvider.java

@@ -9,7 +9,6 @@
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
-import java.util.Optional;
 import org.apache.commons.lang3.tuple.Pair;
 
 /**
@@ -50,10 +49,7 @@ public MeteredEmbeddingProvider(
    */
   @Override
   public Uni<Response> vectorize(
-      int batchId,
-      List<String> texts,
-      Optional<String> apiKey,
-      EmbeddingRequestType embeddingRequestType) {
+      int batchId, List<String> texts, String apiKey, EmbeddingRequestType embeddingRequestType) {
     // String bytes metrics for vectorize
     DistributionSummary ds =
         DistributionSummary.builder(jsonApiMetricsConfig.vectorizeInputBytesMetrics())

src/main/java/io/stargate/sgv2/jsonapi/service/embedding/operation/MistralEmbeddingProvider.java

@@ -102,16 +102,11 @@ private record Usage(int prompt_tokens, int total_tokens, int completion_tokens)
 
   @Override
   public Uni<Response> vectorize(
-      int batchId,
-      List<String> texts,
-      Optional<String> apiKey,
-      EmbeddingRequestType embeddingRequestType) {
-    checkEmbeddingApiKeyHeader(providerId, apiKey);
-
+      int batchId, List<String> texts, String apiKey, EmbeddingRequestType embeddingRequestType) {
     EmbeddingRequest request = new EmbeddingRequest(texts, modelName, "float");
 
     Uni<EmbeddingResponse> response =
-        applyRetry(mistralEmbeddingProviderClient.embed("Bearer " + apiKey.get(), request));
+        applyRetry(mistralEmbeddingProviderClient.embed("Bearer " + apiKey, request));
 
     return response
         .onItem()

src/main/java/io/stargate/sgv2/jsonapi/service/embedding/operation/NvidiaEmbeddingProvider.java

@@ -16,7 +16,6 @@
 import java.util.Collections;
 import java.util.List;
 import java.util.Map;
-import java.util.Optional;
 import java.util.concurrent.TimeUnit;
 import org.eclipse.microprofile.rest.client.annotation.ClientHeaderParam;
 import org.eclipse.microprofile.rest.client.annotation.RegisterProvider;
@@ -103,20 +102,15 @@ private record Usage(int prompt_tokens, int total_tokens) {}
 
   @Override
   public Uni<Response> vectorize(
-      int batchId,
-      List<String> texts,
-      Optional<String> apiKey,
-      EmbeddingRequestType embeddingRequestType) {
-    checkEmbeddingApiKeyHeader(providerId, apiKey);
-
+      int batchId, List<String> texts, String apiKey, EmbeddingRequestType embeddingRequestType) {
     String[] textArray = new String[texts.size()];
     String input_type = embeddingRequestType == EmbeddingRequestType.INDEX ? PASSAGE : QUERY;
 
     EmbeddingRequest request =
         new EmbeddingRequest(texts.toArray(textArray), modelName, input_type);
 
     Uni<EmbeddingResponse> response =
-        applyRetry(nvidiaEmbeddingProviderClient.embed("Bearer " + apiKey.get(), request));
+        applyRetry(nvidiaEmbeddingProviderClient.embed("Bearer " + apiKey, request));
 
     return response
         .onItem()

src/main/java/io/stargate/sgv2/jsonapi/service/embedding/operation/OpenAIEmbeddingProvider.java

@@ -17,7 +17,6 @@
 import java.util.Collections;
 import java.util.List;
 import java.util.Map;
-import java.util.Optional;
 import java.util.concurrent.TimeUnit;
 import org.eclipse.microprofile.rest.client.annotation.ClientHeaderParam;
 import org.eclipse.microprofile.rest.client.annotation.RegisterProvider;
@@ -112,11 +111,7 @@ private record Usage(int prompt_tokens, int total_tokens) {}
 
   @Override
   public Uni<Response> vectorize(
-      int batchId,
-      List<String> texts,
-      Optional<String> apiKey,
-      EmbeddingRequestType embeddingRequestType) {
-    checkEmbeddingApiKeyHeader(providerId, apiKey);
+      int batchId, List<String> texts, String apiKey, EmbeddingRequestType embeddingRequestType) {
     String[] textArray = new String[texts.size()];
     EmbeddingRequest request = new EmbeddingRequest(texts.toArray(textArray), modelName, dimension);
     String organizationId = (String) vectorizeServiceParameters.get("organizationId");
@@ -125,7 +120,7 @@ public Uni<Response> vectorize(
     Uni<EmbeddingResponse> response =
         applyRetry(
             openAIEmbeddingProviderClient.embed(
-                "Bearer " + apiKey.get(), organizationId, projectId, request));
+                "Bearer " + apiKey, organizationId, projectId, request));
 
     return response
         .onItem()

src/main/java/io/stargate/sgv2/jsonapi/service/embedding/operation/UpstageAIEmbeddingProvider.java

@@ -17,7 +17,6 @@
 import java.util.Collections;
 import java.util.List;
 import java.util.Map;
-import java.util.Optional;
 import java.util.concurrent.TimeUnit;
 import org.eclipse.microprofile.rest.client.annotation.ClientHeaderParam;
 import org.eclipse.microprofile.rest.client.annotation.RegisterProvider;
@@ -118,11 +117,7 @@ record Usage(int prompt_tokens, int total_tokens) {}
 
   @Override
   public Uni<Response> vectorize(
-      int batchId,
-      List<String> texts,
-      Optional<String> apiKey,
-      EmbeddingRequestType embeddingRequestType) {
-    checkEmbeddingApiKeyHeader(providerId, apiKey);
+      int batchId, List<String> texts, String apiKey, EmbeddingRequestType embeddingRequestType) {
     // Oddity: Implementation does not support batching, so we only accept "batches"
     // of 1 String, fail for others
     if (texts.size() != 1) {
@@ -140,7 +135,7 @@ public Uni<Response> vectorize(
     EmbeddingRequest request = new EmbeddingRequest(texts.get(0), modelName);
 
     Uni<EmbeddingResponse> response =
-        applyRetry(upstageAIEmbeddingProviderClient.embed("Bearer " + apiKey.get(), request));
+        applyRetry(upstageAIEmbeddingProviderClient.embed("Bearer " + apiKey, request));
 
     return response
         .onItem()