[CPS] Create Cross Project IndicesOptions

prwhelan · prwhelan · commit e4fe9c57a5b5 · 2025-09-25T13:55:08.000-04:00
An initial IndicesOptions for CrossProject.

This will be used to identify when the index must be resolved for a
cross-project search. It currently always defaults to false so we can
start reading the value, and a later commit will handle enabling it.
diff --git a/server/src/main/java/org/elasticsearch/action/admin/indices/rollover/TransportRolloverAction.java b/server/src/main/java/org/elasticsearch/action/admin/indices/rollover/TransportRolloverAction.java
@@ -159,7 +159,8 @@ protected ClusterBlockException checkBlock(RolloverRequest request, ClusterState
                 .matchOpen(request.indicesOptions().expandWildcardsOpen())
                 .matchClosed(request.indicesOptions().expandWildcardsClosed())
                 .build(),
-            IndicesOptions.GatekeeperOptions.DEFAULT
+            IndicesOptions.GatekeeperOptions.DEFAULT,
+            IndicesOptions.ResolutionModeOptions.DEFAULT
         );
         ResolvedExpression resolvedRolloverTarget = SelectorResolver.parseExpression(request.getRolloverTarget(), request.indicesOptions());
         final IndexAbstraction indexAbstraction = projectMetadata.getIndicesLookup().get(resolvedRolloverTarget.resource());
@@ -255,7 +256,8 @@ protected void masterOperation(
         final var statsIndicesOptions = new IndicesOptions(
             IndicesOptions.ConcreteTargetOptions.ALLOW_UNAVAILABLE_TARGETS,
             IndicesOptions.WildcardOptions.builder().matchClosed(true).allowEmptyExpressions(false).build(),
-            IndicesOptions.GatekeeperOptions.DEFAULT
+            IndicesOptions.GatekeeperOptions.DEFAULT,
+            IndicesOptions.ResolutionModeOptions.DEFAULT
         );
         // Make sure to recombine any selectors on the stats request
         IndicesStatsRequest statsRequest = new IndicesStatsRequest().indices(resolvedRolloverTarget.combined())
diff --git a/server/src/main/java/org/elasticsearch/action/support/IndicesOptions.java b/server/src/main/java/org/elasticsearch/action/support/IndicesOptions.java
@@ -9,9 +9,11 @@
 package org.elasticsearch.action.support;
 
 import org.elasticsearch.ElasticsearchParseException;
+import org.elasticsearch.TransportVersion;
 import org.elasticsearch.TransportVersions;
 import org.elasticsearch.common.io.stream.StreamInput;
 import org.elasticsearch.common.io.stream.StreamOutput;
+import org.elasticsearch.common.io.stream.Writeable;
 import org.elasticsearch.common.logging.DeprecationCategory;
 import org.elasticsearch.common.logging.DeprecationLogger;
 import org.elasticsearch.core.Nullable;
@@ -49,7 +51,8 @@
 public record IndicesOptions(
     ConcreteTargetOptions concreteTargetOptions,
     WildcardOptions wildcardOptions,
-    GatekeeperOptions gatekeeperOptions
+    GatekeeperOptions gatekeeperOptions,
+    ResolutionModeOptions resolutionModeOptions
 ) implements ToXContentFragment {
 
     public static IndicesOptions.Builder builder() {
@@ -413,6 +416,37 @@ public static Builder builder(GatekeeperOptions gatekeeperOptions) {
         }
     }
 
+    public record ResolutionModeOptions(boolean crossProject) implements ToXContentFragment, Writeable {
+
+        public static final ResolutionModeOptions DEFAULT = new ResolutionModeOptions(false);
+
+        private static final TransportVersion INDICES_OPTIONS_RESOLUTION_MODE = TransportVersion.fromName(
+            "indices_options_resolution_mode"
+        );
+
+        private static final String CROSS_PROJECT_NAME = "resolve_cross_project";
+
+        @Override
+        public XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException {
+            return builder.field(CROSS_PROJECT_NAME, crossProject);
+        }
+
+        @Override
+        public void writeTo(StreamOutput out) throws IOException {
+            if (out.getTransportVersion().supports(INDICES_OPTIONS_RESOLUTION_MODE)) {
+                out.writeBoolean(crossProject);
+            }
+        }
+
+        public static ResolutionModeOptions readFrom(StreamInput in) throws IOException {
+            if (in.getTransportVersion().supports(INDICES_OPTIONS_RESOLUTION_MODE)) {
+                return new ResolutionModeOptions(in.readBoolean());
+            } else {
+                return ResolutionModeOptions.DEFAULT;
+            }
+        }
+    }
+
     /**
      * This class is maintained for backwards compatibility and performance purposes. We use it for serialisation along with {@link Option}.
      */
@@ -463,7 +497,8 @@ private enum Option {
     public static final IndicesOptions DEFAULT = new IndicesOptions(
         ConcreteTargetOptions.ERROR_WHEN_UNAVAILABLE_TARGETS,
         WildcardOptions.DEFAULT,
-        GatekeeperOptions.DEFAULT
+        GatekeeperOptions.DEFAULT,
+        ResolutionModeOptions.DEFAULT
     );
 
     public static final IndicesOptions STRICT_EXPAND_OPEN = IndicesOptions.builder()
@@ -857,6 +892,13 @@ public boolean ignoreThrottled() {
         return gatekeeperOptions().ignoreThrottled();
     }
 
+    /**
+     * @return whether indices will resolve to the cross-project "flat world" expression
+     */
+    public boolean resolveCrossProject() {
+        return resolutionModeOptions().crossProject();
+    }
+
     public void writeIndicesOptions(StreamOutput out) throws IOException {
         EnumSet<Option> backwardsCompatibleOptions = EnumSet.noneOf(Option.class);
         if (allowNoIndices()) {
@@ -917,6 +959,7 @@ public void writeIndicesOptions(StreamOutput out) throws IOException {
                 out.writeByte((byte) 0); // ordinal 0 (::data selector)
             }
         }
+        out.writeWriteable(resolutionModeOptions);
     }
 
     public static IndicesOptions readIndicesOptions(StreamInput in) throws IOException {
@@ -968,14 +1011,16 @@ public static IndicesOptions readIndicesOptions(StreamInput in) throws IOExcepti
                 ? ConcreteTargetOptions.ALLOW_UNAVAILABLE_TARGETS
                 : ConcreteTargetOptions.ERROR_WHEN_UNAVAILABLE_TARGETS,
             wildcardOptions,
-            gatekeeperOptions
+            gatekeeperOptions,
+            ResolutionModeOptions.readFrom(in)
         );
     }
 
     public static class Builder {
         private ConcreteTargetOptions concreteTargetOptions;
         private WildcardOptions wildcardOptions;
         private GatekeeperOptions gatekeeperOptions;
+        private ResolutionModeOptions resolutionModeOptions;
 
         Builder() {
             this(DEFAULT);
@@ -985,6 +1030,7 @@ public static class Builder {
             concreteTargetOptions = indicesOptions.concreteTargetOptions;
             wildcardOptions = indicesOptions.wildcardOptions;
             gatekeeperOptions = indicesOptions.gatekeeperOptions;
+            resolutionModeOptions = indicesOptions.resolutionModeOptions;
         }
 
         public Builder concreteTargetOptions(ConcreteTargetOptions concreteTargetOptions) {
@@ -1012,8 +1058,13 @@ public Builder gatekeeperOptions(GatekeeperOptions.Builder generalOptions) {
             return this;
         }
 
+        public Builder resolutionModeOptions(ResolutionModeOptions resolutionModeOptions) {
+            this.resolutionModeOptions = resolutionModeOptions;
+            return this;
+        }
+
         public IndicesOptions build() {
-            return new IndicesOptions(concreteTargetOptions, wildcardOptions, gatekeeperOptions);
+            return new IndicesOptions(concreteTargetOptions, wildcardOptions, gatekeeperOptions, resolutionModeOptions);
         }
     }
 
@@ -1115,7 +1166,8 @@ public static IndicesOptions fromOptions(
         return new IndicesOptions(
             ignoreUnavailable ? ConcreteTargetOptions.ALLOW_UNAVAILABLE_TARGETS : ConcreteTargetOptions.ERROR_WHEN_UNAVAILABLE_TARGETS,
             wildcards,
-            gatekeeperOptions
+            gatekeeperOptions,
+            ResolutionModeOptions.DEFAULT
         );
     }
 
@@ -1202,13 +1254,15 @@ public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params par
         concreteTargetOptions.toXContent(builder, params);
         wildcardOptions.toXContent(builder, params);
         gatekeeperOptions.toXContent(builder, params);
+        resolutionModeOptions.toXContent(builder, params);
         return builder;
     }
 
     private static final ParseField EXPAND_WILDCARDS_FIELD = new ParseField(WildcardOptions.EXPAND_WILDCARDS);
     private static final ParseField IGNORE_UNAVAILABLE_FIELD = new ParseField(ConcreteTargetOptions.IGNORE_UNAVAILABLE);
     private static final ParseField IGNORE_THROTTLED_FIELD = new ParseField(GatekeeperOptions.IGNORE_THROTTLED).withAllDeprecated();
     private static final ParseField ALLOW_NO_INDICES_FIELD = new ParseField(WildcardOptions.ALLOW_NO_INDICES);
+    private static final ParseField RESOLVE_CROSS_PROJECT = new ParseField(ResolutionModeOptions.CROSS_PROJECT_NAME);
 
     public static IndicesOptions fromXContent(XContentParser parser) throws IOException {
         return fromXContent(parser, null);
@@ -1221,6 +1275,7 @@ public static IndicesOptions fromXContent(XContentParser parser, @Nullable Indic
             .ignoreThrottled(defaults != null && defaults.gatekeeperOptions().ignoreThrottled());
         Boolean allowNoIndices = defaults == null ? null : defaults.allowNoIndices();
         Boolean ignoreUnavailable = defaults == null ? null : defaults.ignoreUnavailable();
+        boolean resolveCrossProject = defaults == null ? ResolutionModeOptions.DEFAULT.crossProject() : defaults.resolveCrossProject();
         Token token = parser.currentToken() == Token.START_OBJECT ? parser.currentToken() : parser.nextToken();
         String currentFieldName = null;
         if (token != Token.START_OBJECT) {
@@ -1268,6 +1323,8 @@ public static IndicesOptions fromXContent(XContentParser parser, @Nullable Indic
                     allowNoIndices = parser.booleanValue();
                 } else if (IGNORE_THROTTLED_FIELD.match(currentFieldName, parser.getDeprecationHandler())) {
                     generalOptions.ignoreThrottled(parser.booleanValue());
+                } else if (RESOLVE_CROSS_PROJECT.match(currentFieldName, parser.getDeprecationHandler())) {
+                    resolveCrossProject = parser.booleanValue();
                 } else {
                     throw new ElasticsearchParseException(
                         "could not read indices options. Unexpected index option [" + currentFieldName + "]"
@@ -1298,6 +1355,7 @@ public static IndicesOptions fromXContent(XContentParser parser, @Nullable Indic
             .concreteTargetOptions(new ConcreteTargetOptions(ignoreUnavailable))
             .wildcardOptions(wildcards)
             .gatekeeperOptions(generalOptions)
+            .resolutionModeOptions(new ResolutionModeOptions(resolveCrossProject))
             .build();
     }
 
@@ -1459,6 +1517,8 @@ public String toString() {
             + allowSelectors()
             + ", include_failure_indices="
             + includeFailureIndices()
+            + ", resolve_cross_project="
+            + resolveCrossProject()
             + ']';
     }
 }
diff --git a/server/src/main/resources/transport/definitions/referable/indices_options_resolution_mode.csv b/server/src/main/resources/transport/definitions/referable/indices_options_resolution_mode.csv
@@ -0,0 +1 @@
+9173000
diff --git a/server/src/main/resources/transport/upper_bounds/9.2.csv b/server/src/main/resources/transport/upper_bounds/9.2.csv
@@ -1 +1 @@
-index_reshard_shardcount_summary,9172000
+indices_options_resolution_mode,9173000
diff --git a/server/src/test/java/org/elasticsearch/action/support/IndicesOptionsTests.java b/server/src/test/java/org/elasticsearch/action/support/IndicesOptionsTests.java
@@ -11,6 +11,7 @@
 
 import org.elasticsearch.action.support.IndicesOptions.ConcreteTargetOptions;
 import org.elasticsearch.action.support.IndicesOptions.GatekeeperOptions;
+import org.elasticsearch.action.support.IndicesOptions.ResolutionModeOptions;
 import org.elasticsearch.action.support.IndicesOptions.WildcardOptions;
 import org.elasticsearch.common.bytes.BytesReference;
 import org.elasticsearch.common.io.stream.BytesStreamOutput;
@@ -57,6 +58,7 @@ public void testSerialization() throws Exception {
                         .allowClosedIndices(randomBoolean())
                         .allowSelectors(randomBoolean())
                 )
+                .resolutionModeOptions(new ResolutionModeOptions(randomBoolean()))
                 .build();
 
             BytesStreamOutput output = new BytesStreamOutput();
@@ -102,6 +104,7 @@ public void testFromOptions() {
         assertThat(indicesOptions.forbidClosedIndices(), equalTo(forbidClosedIndices));
         assertEquals(ignoreAliases, indicesOptions.ignoreAliases());
         assertEquals(ignoreThrottled, indicesOptions.ignoreThrottled());
+        assertEquals(indicesOptions.resolveCrossProject(), ResolutionModeOptions.DEFAULT.crossProject());
     }
 
     public void testFromOptionsWithDefaultOptions() {
@@ -138,6 +141,7 @@ public void testFromOptionsWithDefaultOptions() {
         assertEquals(defaultOptions.allowAliasesToMultipleIndices(), indicesOptions.allowAliasesToMultipleIndices());
         assertEquals(defaultOptions.forbidClosedIndices(), indicesOptions.forbidClosedIndices());
         assertEquals(defaultOptions.ignoreAliases(), indicesOptions.ignoreAliases());
+        assertEquals(defaultOptions.resolveCrossProject(), indicesOptions.resolveCrossProject());
     }
 
     public void testFromParameters() {
@@ -201,6 +205,7 @@ public void testFromParameters() {
         assertEquals(defaultOptions.allowAliasesToMultipleIndices(), updatedOptions.allowAliasesToMultipleIndices());
         assertEquals(defaultOptions.forbidClosedIndices(), updatedOptions.forbidClosedIndices());
         assertEquals(defaultOptions.ignoreAliases(), updatedOptions.ignoreAliases());
+        assertEquals(defaultOptions.resolveCrossProject(), updatedOptions.resolveCrossProject());
     }
 
     public void testEqualityAndHashCode() {
@@ -330,6 +335,7 @@ public void testFromMap() {
         assertEquals(ignoreUnavailable == null ? defaults.ignoreUnavailable() : ignoreUnavailable, fromMap.ignoreUnavailable());
         assertEquals(allowNoIndices == null ? defaults.allowNoIndices() : allowNoIndices, fromMap.allowNoIndices());
         assertEquals(ignoreThrottled == null ? defaults.ignoreThrottled() : ignoreThrottled, fromMap.ignoreThrottled());
+        assertEquals(fromMap.resolveCrossProject(), ResolutionModeOptions.DEFAULT.crossProject());
     }
 
     public void testToXContent() throws IOException {
@@ -348,8 +354,14 @@ public void testToXContent() throws IOException {
             randomBoolean(),
             randomBoolean()
         );
+        ResolutionModeOptions resolutionModeOptions = new ResolutionModeOptions(randomBoolean());
 
-        IndicesOptions indicesOptions = new IndicesOptions(concreteTargetOptions, wildcardOptions, gatekeeperOptions);
+        IndicesOptions indicesOptions = new IndicesOptions(
+            concreteTargetOptions,
+            wildcardOptions,
+            gatekeeperOptions,
+            resolutionModeOptions
+        );
 
         XContentType type = randomFrom(XContentType.values());
         BytesReference xContentBytes = toXContentBytes(indicesOptions, type);
@@ -364,6 +376,7 @@ public void testToXContent() throws IOException {
         assertThat(map.get("ignore_unavailable"), equalTo(concreteTargetOptions.allowUnavailableTargets()));
         assertThat(map.get("allow_no_indices"), equalTo(wildcardOptions.allowEmptyExpressions()));
         assertThat(map.get("ignore_throttled"), equalTo(gatekeeperOptions.ignoreThrottled()));
+        assertThat(map.get("resolve_cross_project"), equalTo(resolutionModeOptions.crossProject()));
     }
 
     public void testFromXContent() throws IOException {
@@ -375,10 +388,12 @@ public void testFromXContent() throws IOException {
             randomBoolean()
         );
         ConcreteTargetOptions concreteTargetOptions = new ConcreteTargetOptions(randomBoolean());
+        ResolutionModeOptions resolutionModeOptions = new ResolutionModeOptions(randomBoolean());
 
         IndicesOptions indicesOptions = IndicesOptions.builder()
             .concreteTargetOptions(concreteTargetOptions)
             .wildcardOptions(wildcardOptions)
+            .resolutionModeOptions(resolutionModeOptions)
             .build();
 
         XContentType type = randomFrom(XContentType.values());
@@ -397,6 +412,7 @@ public void testFromXContent() throws IOException {
         assertEquals(indicesOptions.ignoreUnavailable(), fromXContentOptions.ignoreUnavailable());
         assertEquals(indicesOptions.allowNoIndices(), fromXContentOptions.allowNoIndices());
         assertEquals(indicesOptions.ignoreThrottled(), fromXContentOptions.ignoreThrottled());
+        assertEquals(indicesOptions.resolveCrossProject(), fromXContentOptions.resolveCrossProject());
     }
 
     public void testFromXContentWithWildcardSpecialValues() throws IOException {
@@ -423,6 +439,7 @@ public void testFromXContentWithWildcardSpecialValues() throws IOException {
         assertTrue(fromXContentOptions.expandWildcardsClosed());
         assertTrue(fromXContentOptions.expandWildcardsHidden());
         assertTrue(fromXContentOptions.expandWildcardsOpen());
+        assertFalse(fromXContentOptions.resolveCrossProject());
 
         try (XContentBuilder builder = XContentFactory.contentBuilder(type)) {
             builder.startObject();
@@ -441,6 +458,7 @@ public void testFromXContentWithWildcardSpecialValues() throws IOException {
         assertFalse(fromXContentOptions.expandWildcardsClosed());
         assertFalse(fromXContentOptions.expandWildcardsHidden());
         assertFalse(fromXContentOptions.expandWildcardsOpen());
+        assertFalse(fromXContentOptions.resolveCrossProject());
     }
 
     public void testFromXContentWithDefaults() throws Exception {
@@ -494,6 +512,7 @@ public void testFromXContentWithDefaults() throws Exception {
         }
         assertEquals(ignoreUnavailable, fromXContentOptions.ignoreUnavailable());
         assertEquals(expectedWildcardStates, fromXContentOptions.wildcardOptions());
+        assertFalse(fromXContentOptions.resolveCrossProject());
     }
 
     private BytesReference toXContentBytes(IndicesOptions indicesOptions, XContentType type) throws IOException {
diff --git a/server/src/test/java/org/elasticsearch/cluster/metadata/IndexNameExpressionResolverTests.java b/server/src/test/java/org/elasticsearch/cluster/metadata/IndexNameExpressionResolverTests.java
@@ -2371,7 +2371,8 @@ public void testIgnoreThrottled() {
                 new IndicesOptions(
                     IndicesOptions.ConcreteTargetOptions.ERROR_WHEN_UNAVAILABLE_TARGETS,
                     IndicesOptions.WildcardOptions.DEFAULT,
-                    IndicesOptions.GatekeeperOptions.builder().ignoreThrottled(true).build()
+                    IndicesOptions.GatekeeperOptions.builder().ignoreThrottled(true).build(),
+                    IndicesOptions.ResolutionModeOptions.DEFAULT
                 ),
                 "ind*",
                 "test-index"

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-index_reshard_shardcount_summary,9172000`
	`1`	`+indices_options_resolution_mode,9173000`