Add support for default exclusion of $vector and $vectorize

src/main/java/io/stargate/sgv2/jsonapi/config/constants/DocumentConstants.java

@@ -31,7 +31,7 @@ interface Fields {
     String VECTOR_INDEX_FUNCTION_NAME = "similarity_function";
 
     /** Field name used in projection clause to get similarity score in response. */
-    String VECTOR_FUNCTION_PROJECTION_FIELD = "$similarity";
+    String VECTOR_FUNCTION_SIMILARITY_FIELD = "$similarity";
 
     // Current definition of valid JSON API names: note that this only validates
     // characters, not length limits (nor empty nor "too long" allowed but validated

src/main/java/io/stargate/sgv2/jsonapi/service/operation/model/impl/ReadAndUpdateOperation.java

@@ -188,7 +188,9 @@ private Uni<UpdatedDocument> processUpdate(
                               returnUpdatedDocument ? updatedDocument : originalDocument;
                           // Some operations (findOneAndUpdate) define projection to apply to
                           // result:
-                          resultProjection.applyProjection(documentToReturn);
+                          if (documentToReturn != null) { // null for some Operation tests
+                            resultProjection.applyProjection(documentToReturn);
+                          }
                         }
                         return new UpdatedDocument(
                             writableShreddedDocument.id(), upsert, documentToReturn, null);

src/main/java/io/stargate/sgv2/jsonapi/service/projection/DocumentProjector.java

@@ -1,6 +1,7 @@
 package io.stargate.sgv2.jsonapi.service.projection;
 
 import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.node.JsonNodeFactory;
 import com.fasterxml.jackson.databind.node.ObjectNode;
 import io.stargate.sgv2.jsonapi.config.constants.DocumentConstants;
 import io.stargate.sgv2.jsonapi.exception.ErrorCode;
@@ -23,12 +24,6 @@ public class DocumentProjector {
    * No-op projector that does not modify documents. Considered "exclusion" projector since "no
    * exclusions" is conceptually what happens ("no inclusions" would drop all content)
    */
-  private static final DocumentProjector DEFAULT_PROJECTOR =
-      new DocumentProjector(null, false, false);
-
-  private static final DocumentProjector DEFAULT_PROJECTOR_WITH_SIMILARITY =
-      new DocumentProjector(null, false, true);
-
   private static final DocumentProjector INCLUDE_ALL_PROJECTOR =
       new DocumentProjector(null, false, false);
 
@@ -57,7 +52,18 @@ private DocumentProjector(
   }
 
   public static DocumentProjector defaultProjector() {
-    return DEFAULT_PROJECTOR;
+    return DefaultProjectorWrapper.defaultProjector();
+  }
+
+  public static DocumentProjector includeAllProjector() {
+    return INCLUDE_ALL_PROJECTOR;
+  }
+
+  DocumentProjector withIncludeSimilarity(boolean includeSimilarityScore) {
+    if (this.includeSimilarityScore == includeSimilarityScore) {
+      return this;
+    }
+    return new DocumentProjector(rootLayer, inclusion, includeSimilarityScore);
   }
 
   public static DocumentProjector createFromDefinition(JsonNode projectionDefinition) {
@@ -69,9 +75,9 @@ public static DocumentProjector createFromDefinition(
     // First special case: "simple" default projection
     if (projectionDefinition == null || projectionDefinition.isEmpty()) {
       if (includeSimilarity) {
-        return DEFAULT_PROJECTOR_WITH_SIMILARITY;
+        return DefaultProjectorWrapper.defaultProjectorWithSimilarity();
       }
-      return DEFAULT_PROJECTOR;
+      return DefaultProjectorWrapper.defaultProjector();
     }
     if (!projectionDefinition.isObject()) {
       throw new JsonApiException(
@@ -125,6 +131,7 @@ public void applyProjection(JsonNode document) {
   }
 
   public void applyProjection(JsonNode document, Float similarityScore) {
+    Objects.requireNonNull(document, "Document to call 'applyProjection()' on must not be null");
     // null -> either include-add or exclude-all; but logic may seem counter-intuitive
     if (rootLayer == null) {
       if (inclusion) { // exclude-all
@@ -133,7 +140,7 @@ public void applyProjection(JsonNode document, Float similarityScore) {
       // In either case, we may need to add similarity score if present
       if (includeSimilarityScore && similarityScore != null) {
         ((ObjectNode) document)
-            .put(DocumentConstants.Fields.VECTOR_FUNCTION_PROJECTION_FIELD, similarityScore);
+            .put(DocumentConstants.Fields.VECTOR_FUNCTION_SIMILARITY_FIELD, similarityScore);
       }
       return;
     }
@@ -144,7 +151,7 @@ public void applyProjection(JsonNode document, Float similarityScore) {
     }
     if (includeSimilarityScore && similarityScore != null) {
       ((ObjectNode) document)
-          .put(DocumentConstants.Fields.VECTOR_FUNCTION_PROJECTION_FIELD, similarityScore);
+          .put(DocumentConstants.Fields.VECTOR_FUNCTION_SIMILARITY_FIELD, similarityScore);
     }
   }
 
@@ -165,6 +172,34 @@ public int hashCode() {
     return rootLayer.hashCode();
   }
 
+  /**
+   * Due to the way projection is handled, we need to handle construction of default instance via
+   * separate class (to avoid cyclic dependency)
+   */
+  static class DefaultProjectorWrapper {
+    /**
+     * Default projector that drops $vector and $vectorize fields but otherwise leaves document
+     * as-is. Constructed from empty definition (no inclusions/exclusions).
+     */
+    private static final DocumentProjector DEFAULT_PROJECTOR;
+
+    static {
+      ObjectNode emptyDef = new ObjectNode(JsonNodeFactory.instance);
+      DEFAULT_PROJECTOR = PathCollector.collectPaths(emptyDef, false).buildProjector();
+    }
+
+    private static final DocumentProjector DEFAULT_PROJECTOR_WITH_SIMILARITY =
+        DEFAULT_PROJECTOR.withIncludeSimilarity(true);
+
+    public static DocumentProjector defaultProjector() {
+      return DEFAULT_PROJECTOR;
+    }
+
+    public static DocumentProjector defaultProjectorWithSimilarity() {
+      return DEFAULT_PROJECTOR_WITH_SIMILARITY;
+    }
+  }
+
   /**
    * Helper object used to traverse and collection inclusion/exclusion path definitions and verify
    * that there are only one or the other (except for doc id). Does not build data structures for
@@ -177,7 +212,11 @@ private static class PathCollector {
 
     private int exclusions, inclusions;
 
-    private Boolean idInclusion = null;
+    private Boolean idInclusion;
+
+    private Boolean $vectorInclusion;
+
+    private Boolean $vectorizeInclusion;
 
     /** Whether similarity score is needed. */
     private final boolean includeSimilarityScore;
@@ -191,36 +230,36 @@ static PathCollector collectPaths(JsonNode def, boolean includeSimilarity) {
     }
 
     public DocumentProjector buildProjector() {
-      if (isDefaultProjection()) {
-        return defaultProjector();
-      }
-
       // One more thing: do we need to add document id?
       if (inclusions > 0) { // inclusion-based projection
-        // doc-id included unless explicitly excluded
         return new DocumentProjector(
-            ProjectionLayer.buildLayersNoOverlap(paths, slices, !Boolean.FALSE.equals(idInclusion)),
+            ProjectionLayer.buildLayersForProjection(
+                paths,
+                slices,
+                // doc-id included unless explicitly excluded
+                !Boolean.FALSE.equals(idInclusion),
+                // $vector only included if explicitly included
+                Boolean.TRUE.equals($vectorInclusion),
+                // $vectorize only included if explicitly included
+                Boolean.TRUE.equals($vectorizeInclusion)),
             true,
             includeSimilarityScore);
       } else { // exclusion-based
-        // doc-id excluded only if explicitly excluded
         return new DocumentProjector(
-            ProjectionLayer.buildLayersNoOverlap(paths, slices, Boolean.FALSE.equals(idInclusion)),
+            ProjectionLayer.buildLayersForProjection(
+                paths,
+                slices,
+                // doc-id excluded only if explicitly excluded
+                Boolean.FALSE.equals(idInclusion),
+                // $vector excluded unless explicitly included
+                !Boolean.TRUE.equals($vectorInclusion),
+                // $vectorize excluded unless explicitly included
+                !Boolean.TRUE.equals($vectorizeInclusion)),
             false,
             includeSimilarityScore);
       }
     }
 
-    /**
-     * Accessor to use for checking if collected paths indicate "empty" (no-operation) projection:
-     * if so, caller can avoid actual construction or evaluation.
-     */
-    boolean isDefaultProjection() {
-      // Only the case if we have no non-doc-id inclusions/exclusions AND
-      // doc-id is included (by default or explicitly)
-      return paths.isEmpty() && slices.isEmpty() && !Boolean.FALSE.equals(idInclusion);
-    }
-
     PathCollector collectFromObject(JsonNode ob, String parentPath) {
       var it = ob.fields();
       while (it.hasNext()) {
@@ -338,6 +377,10 @@ private void addSlice(String path, JsonNode sliceDef) {
     private void addExclusion(String path) {
       if (DocumentConstants.Fields.DOC_ID.equals(path)) {
         idInclusion = false;
+      } else if (DocumentConstants.Fields.VECTOR_EMBEDDING_FIELD.equals(path)) {
+        $vectorInclusion = false;
+      } else if (DocumentConstants.Fields.VECTOR_EMBEDDING_TEXT_FIELD.equals(path)) {
+        $vectorizeInclusion = false;
       } else {
         // Must not mix exclusions and inclusions
         if (inclusions > 0) {
@@ -356,6 +399,10 @@ private void addExclusion(String path) {
     private void addInclusion(String path) {
       if (DocumentConstants.Fields.DOC_ID.equals(path)) {
         idInclusion = true;
+      } else if (DocumentConstants.Fields.VECTOR_EMBEDDING_FIELD.equals(path)) {
+        $vectorInclusion = true;
+      } else if (DocumentConstants.Fields.VECTOR_EMBEDDING_TEXT_FIELD.equals(path)) {
+        $vectorizeInclusion = true;
       } else {
         // Must not mix exclusions and inclusions
         if (exclusions > 0) {

src/main/java/io/stargate/sgv2/jsonapi/service/projection/IndexingProjector.java

@@ -60,7 +60,7 @@ public static IndexingProjector createForIndexing(Set<String> allowed, Set<Strin
       if (!allowed.contains(DocumentConstants.Fields.VECTOR_EMBEDDING_TEXT_FIELD)) {
         allowed.add(DocumentConstants.Fields.VECTOR_EMBEDDING_TEXT_FIELD);
       }
-      return new IndexingProjector(ProjectionLayer.buildLayersOverlapOk(allowed), true, false);
+      return new IndexingProjector(ProjectionLayer.buildLayersForIndexing(allowed), true, false);
     }
     if (denied != null && !denied.isEmpty()) {
       // (special) Case 4:
@@ -71,10 +71,10 @@ public static IndexingProjector createForIndexing(Set<String> allowed, Set<Strin
         overrideFields.add(DocumentConstants.Fields.VECTOR_EMBEDDING_FIELD);
         overrideFields.add(DocumentConstants.Fields.VECTOR_EMBEDDING_TEXT_FIELD);
         return new IndexingProjector(
-            ProjectionLayer.buildLayersOverlapOk(overrideFields), true, true);
+            ProjectionLayer.buildLayersForIndexing(overrideFields), true, true);
       }
       // Case 2: exclusion-based projection
-      return new IndexingProjector(ProjectionLayer.buildLayersOverlapOk(denied), false, false);
+      return new IndexingProjector(ProjectionLayer.buildLayersForIndexing(denied), false, false);
     }
     // Case 3: include-all (identity) projection
     return identityProjector();

src/main/java/io/stargate/sgv2/jsonapi/service/projection/ProjectionLayer.java

@@ -50,17 +50,26 @@ class ProjectionLayer {
     nextLayers = null;
   }
 
-  public static ProjectionLayer buildLayersNoOverlap(
-      Collection<String> dotPaths, List<SliceDef> slices, boolean addDocId) {
-    return buildLayers(dotPaths, slices, addDocId, true);
+  public static ProjectionLayer buildLayersForProjection(
+      Collection<String> dotPaths,
+      List<SliceDef> slices,
+      boolean addDocId,
+      boolean add$vector,
+      boolean add$vectorize) {
+    return buildLayers(dotPaths, slices, true, addDocId, add$vector, add$vectorize);
   }
 
-  public static ProjectionLayer buildLayersOverlapOk(Collection<String> dotPaths) {
-    return buildLayers(dotPaths, Collections.emptyList(), false, false);
+  public static ProjectionLayer buildLayersForIndexing(Collection<String> dotPaths) {
+    return buildLayers(dotPaths, Collections.emptyList(), false, false, false, false);
   }
 
   private static ProjectionLayer buildLayers(
-      Collection<String> dotPaths, List<SliceDef> slices, boolean addDocId, boolean failOnOverlap) {
+      Collection<String> dotPaths,
+      List<SliceDef> slices,
+      boolean failOnOverlap,
+      boolean addDocId,
+      boolean add$vector,
+      boolean add$vectorize) {
     // Root is always branch (not terminal):
     ProjectionLayer root = new ProjectionLayer("", false);
     for (String fullPath : dotPaths) {
@@ -83,6 +92,20 @@ private static ProjectionLayer buildLayers(
           root,
           new String[] {DocumentConstants.Fields.DOC_ID});
     }
+    if (add$vector) {
+      buildPath(
+          failOnOverlap,
+          DocumentConstants.Fields.VECTOR_EMBEDDING_FIELD,
+          root,
+          new String[] {DocumentConstants.Fields.VECTOR_EMBEDDING_FIELD});
+    }
+    if (add$vectorize) {
+      buildPath(
+          failOnOverlap,
+          DocumentConstants.Fields.VECTOR_EMBEDDING_TEXT_FIELD,
+          root,
+          new String[] {DocumentConstants.Fields.VECTOR_EMBEDDING_TEXT_FIELD});
+    }
     return root;
   }
 

src/main/java/io/stargate/sgv2/jsonapi/service/resolver/model/impl/DeleteManyCommandResolver.java

@@ -59,7 +59,7 @@ private FindOperation getFindOperation(CommandContext commandContext, DeleteMany
     return FindOperation.unsorted(
         commandContext,
         logicalExpression,
-        DocumentProjector.defaultProjector(),
+        DocumentProjector.includeAllProjector(),
         null,
         operationsConfig.maxDocumentDeleteCount() + 1,
         operationsConfig.defaultPageSize(),

src/main/java/io/stargate/sgv2/jsonapi/service/resolver/model/impl/DeleteOneCommandResolver.java

@@ -62,7 +62,7 @@ private FindOperation getFindOperation(CommandContext commandContext, DeleteOneC
       return FindOperation.vsearchSingle(
           commandContext,
           logicalExpression,
-          DocumentProjector.defaultProjector(),
+          DocumentProjector.includeAllProjector(),
           ReadType.KEY,
           objectMapper,
           vector);
@@ -74,7 +74,7 @@ private FindOperation getFindOperation(CommandContext commandContext, DeleteOneC
       return FindOperation.sortedSingle(
           commandContext,
           logicalExpression,
-          DocumentProjector.defaultProjector(),
+          DocumentProjector.includeAllProjector(),
           // For in memory sorting we read more data than needed, so defaultSortPageSize like 100
           operationsConfig.defaultSortPageSize(),
           ReadType.SORTED_DOCUMENT,
@@ -88,7 +88,7 @@ private FindOperation getFindOperation(CommandContext commandContext, DeleteOneC
       return FindOperation.unsortedSingle(
           commandContext,
           logicalExpression,
-          DocumentProjector.defaultProjector(),
+          DocumentProjector.includeAllProjector(),
           ReadType.KEY,
           objectMapper);
     }

src/main/java/io/stargate/sgv2/jsonapi/service/resolver/model/impl/FindOneAndDeleteCommandResolver.java

@@ -66,7 +66,7 @@ private FindOperation getFindOperation(
       return FindOperation.vsearchSingle(
           commandContext,
           logicalExpression,
-          DocumentProjector.defaultProjector(),
+          DocumentProjector.includeAllProjector(),
           ReadType.DOCUMENT,
           objectMapper,
           vector);
@@ -78,7 +78,7 @@ private FindOperation getFindOperation(
       return FindOperation.sortedSingle(
           commandContext,
           logicalExpression,
-          DocumentProjector.defaultProjector(),
+          DocumentProjector.includeAllProjector(),
           // For in memory sorting we read more data than needed, so defaultSortPageSize like 100
           operationsConfig.defaultSortPageSize(),
           ReadType.SORTED_DOCUMENT,
@@ -92,7 +92,7 @@ private FindOperation getFindOperation(
       return FindOperation.unsortedSingle(
           commandContext,
           logicalExpression,
-          DocumentProjector.defaultProjector(),
+          DocumentProjector.includeAllProjector(),
           ReadType.DOCUMENT,
           objectMapper);
     }

src/main/java/io/stargate/sgv2/jsonapi/service/resolver/model/impl/FindOneAndReplaceCommandResolver.java

@@ -84,7 +84,7 @@ private FindOperation getFindOperation(
       return FindOperation.vsearchSingle(
           commandContext,
           logicalExpression,
-          DocumentProjector.defaultProjector(),
+          DocumentProjector.includeAllProjector(),
           ReadType.DOCUMENT,
           objectMapper,
           vector);
@@ -96,7 +96,7 @@ private FindOperation getFindOperation(
       return FindOperation.sortedSingle(
           commandContext,
           logicalExpression,
-          DocumentProjector.defaultProjector(),
+          DocumentProjector.includeAllProjector(),
           // For in memory sorting we read more data than needed, so defaultSortPageSize like 100
           operationsConfig.defaultSortPageSize(),
           ReadType.SORTED_DOCUMENT,
@@ -110,7 +110,7 @@ private FindOperation getFindOperation(
       return FindOperation.unsortedSingle(
           commandContext,
           logicalExpression,
-          DocumentProjector.defaultProjector(),
+          DocumentProjector.includeAllProjector(),
           ReadType.DOCUMENT,
           objectMapper);
     }