Improve error message for NoMatchingProjectException (#138141)

Add project routing information to the error message when applicable.

Resolves: ES-12966

Author: ywangd

server/src/main/java/org/elasticsearch/cluster/metadata/IndexAbstractionResolver.java

@@ -74,7 +74,8 @@ public ResolvedIndexExpressions resolveIndexAbstractions(
         final Function<IndexComponentSelector, Set<String>> allAuthorizedAndAvailableBySelector,
         final BiPredicate<String, IndexComponentSelector> isAuthorized,
         final TargetProjects targetProjects,
-        final boolean includeDataStreams
+        final boolean includeDataStreams,
+        @Nullable final String projectRouting
     ) {
         if (targetProjects == TargetProjects.LOCAL_ONLY_FOR_CPS_DISABLED) {
             final String message = "cannot resolve indices cross project if target set is local only";
@@ -88,7 +89,7 @@ public ResolvedIndexExpressions resolveIndexAbstractions(
         boolean wildcardSeen = false;
         for (String originalIndexExpression : indices) {
             final CrossProjectIndexExpressionsRewriter.IndexRewriteResult indexRewriteResult = CrossProjectIndexExpressionsRewriter
-                .rewriteIndexExpression(originalIndexExpression, originProjectAlias, linkedProjectAliases);
+                .rewriteIndexExpression(originalIndexExpression, originProjectAlias, linkedProjectAliases, projectRouting);
 
             final String localIndexExpression = indexRewriteResult.localExpression();
             if (localIndexExpression == null) {

server/src/main/java/org/elasticsearch/search/crossproject/CrossProjectIndexExpressionsRewriter.java

@@ -72,7 +72,10 @@ public static Map<String, IndexRewriteResult> rewriteIndexExpressions(
             if (canonicalExpressionsMap.containsKey(indexExpression)) {
                 continue;
             }
-            canonicalExpressionsMap.put(indexExpression, rewriteIndexExpression(indexExpression, originProjectAlias, allProjectAliases));
+            canonicalExpressionsMap.put(
+                indexExpression,
+                rewriteIndexExpression(indexExpression, originProjectAlias, allProjectAliases, null)
+            );
         }
         return canonicalExpressionsMap;
     }
@@ -85,27 +88,30 @@ public static Map<String, IndexRewriteResult> rewriteIndexExpressions(
      *                           it can match on its actual alias and on the special alias "_origin". Any expression matched by the origin
      *                           project also cannot be qualified with its actual alias in the final rewritten expression.
      * @param allProjectAliases the list of all project aliases (linked and origin) consider for a request
+     * @param projectRouting the project routing that was applied to determine the origin and linked projects.
+     *                       {@code null} if no project routing was applied.
      * @throws IllegalArgumentException if exclusions, date math or selectors are present in the index expressions
      * @throws NoMatchingProjectException if a qualified resource cannot be resolved because a project is missing
      */
     public static IndexRewriteResult rewriteIndexExpression(
         String indexExpression,
         @Nullable String originProjectAlias,
-        Set<String> allProjectAliases
+        Set<String> allProjectAliases,
+        @Nullable String projectRouting
     ) {
         maybeThrowOnUnsupportedResource(indexExpression);
 
         // Always 404 when no project is available for index resolution. This is matching error handling behaviour for resolving
         // projects with qualified index patterns such as "missing-*:index".
         if (originProjectAlias == null && allProjectAliases.isEmpty()) {
-            // TODO: add project_routing string to the exception message
-            throw new NoMatchingProjectException("no matching project after applying project routing");
+            assert projectRouting != null;
+            throw new NoMatchingProjectException("no matching project after applying project routing [" + projectRouting + "]");
         }
 
         final boolean isQualified = RemoteClusterAware.isRemoteIndexName(indexExpression);
         final IndexRewriteResult rewrittenExpression;
         if (isQualified) {
-            rewrittenExpression = rewriteQualifiedExpression(indexExpression, originProjectAlias, allProjectAliases);
+            rewrittenExpression = rewriteQualifiedExpression(indexExpression, originProjectAlias, allProjectAliases, projectRouting);
             logger.debug("Rewrote qualified expression [{}] to [{}]", indexExpression, rewrittenExpression);
         } else {
             rewrittenExpression = rewriteUnqualifiedExpression(indexExpression, originProjectAlias, allProjectAliases);
@@ -146,7 +152,8 @@ private static IndexRewriteResult rewriteUnqualifiedExpression(
     private static IndexRewriteResult rewriteQualifiedExpression(
         String resource,
         @Nullable String originProjectAlias,
-        Set<String> allProjectAliases
+        Set<String> allProjectAliases,
+        @Nullable String projectRouting
     ) {
         String[] splitResource = RemoteClusterAware.splitIndexName(resource);
         assert splitResource.length == 2
@@ -167,7 +174,7 @@ private static IndexRewriteResult rewriteQualifiedExpression(
 
         if (originProjectAlias == null && ProjectRoutingResolver.ORIGIN.equals(requestedProjectAlias)) {
             // handling case where we have a qualified expression like: _origin:indexName but no _origin project is set
-            throw new NoMatchingProjectException(requestedProjectAlias);
+            throw new NoMatchingProjectException(requestedProjectAlias, projectRouting);
         }
 
         try {
@@ -177,7 +184,7 @@ private static IndexRewriteResult rewriteQualifiedExpression(
             );
 
             if (allProjectsMatchingAlias.isEmpty()) {
-                throw new NoMatchingProjectException(requestedProjectAlias);
+                throw new NoMatchingProjectException(requestedProjectAlias, projectRouting);
             }
 
             String localExpression = null;
@@ -193,7 +200,7 @@ private static IndexRewriteResult rewriteQualifiedExpression(
             return new IndexRewriteResult(localExpression, resourcesMatchingLinkedProjectAliases);
         } catch (NoSuchRemoteClusterException ex) {
             logger.debug(ex.getMessage(), ex);
-            throw new NoMatchingProjectException(requestedProjectAlias);
+            throw new NoMatchingProjectException(requestedProjectAlias, projectRouting);
         }
     }
 

server/src/main/java/org/elasticsearch/search/crossproject/NoMatchingProjectException.java

@@ -11,6 +11,7 @@
 
 import org.elasticsearch.ResourceNotFoundException;
 import org.elasticsearch.common.io.stream.StreamInput;
+import org.elasticsearch.core.Nullable;
 
 import java.io.IOException;
 
@@ -19,8 +20,12 @@
  */
 public final class NoMatchingProjectException extends ResourceNotFoundException {
 
-    public NoMatchingProjectException(String projectName) {
-        super("No such project: [" + projectName + "]");
+    public NoMatchingProjectException(String message) {
+        super(message);
+    }
+
+    public NoMatchingProjectException(String projectAlias, @Nullable String projectRouting) {
+        super("No such project: [" + projectAlias + "]" + (projectRouting != null ? " with project routing [" + projectRouting + "]" : ""));
     }
 
     public NoMatchingProjectException(StreamInput in) throws IOException {

server/src/test/java/org/elasticsearch/search/crossproject/CrossProjectIndexExpressionsRewriterTests.java

@@ -17,8 +17,11 @@
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Map;
+import java.util.Set;
+import java.util.stream.Collectors;
 
 import static org.hamcrest.Matchers.containsInAnyOrder;
+import static org.hamcrest.Matchers.equalTo;
 
 public class CrossProjectIndexExpressionsRewriterTests extends ESTestCase {
 
@@ -354,19 +357,43 @@ public void test_ALLExpressionShouldMatchAll() {
     }
 
     public void testRewritingShouldThrowIfNotProjectMatchExpression() {
-        ProjectRoutingInfo origin = createRandomProjectWithAlias("P0");
-        List<ProjectRoutingInfo> linked = List.of(
-            createRandomProjectWithAlias("P1"),
-            createRandomProjectWithAlias("P2"),
-            createRandomProjectWithAlias("Q1"),
-            createRandomProjectWithAlias("Q2")
-        );
-        String[] requestedResources = new String[] { "X*:metrics" };
+        {
+            final var projectRouting = "_alias:" + randomAlphaOfLengthBetween(1, 10);
+
+            final var e = expectThrows(
+                NoMatchingProjectException.class,
+                () -> CrossProjectIndexExpressionsRewriter.rewriteIndexExpression(randomIdentifier(), null, Set.of(), projectRouting)
+            );
+            assertThat(e.getMessage(), equalTo("no matching project after applying project routing [" + projectRouting + "]"));
+        }
 
-        expectThrows(
-            NoMatchingProjectException.class,
-            () -> CrossProjectIndexExpressionsRewriter.rewriteIndexExpressions(origin, linked, requestedResources)
-        );
+        {
+            ProjectRoutingInfo origin = createRandomProjectWithAlias("P0");
+            List<ProjectRoutingInfo> linked = List.of(
+                createRandomProjectWithAlias("P1"),
+                createRandomProjectWithAlias("P2"),
+                createRandomProjectWithAlias("Q1"),
+                createRandomProjectWithAlias("Q2")
+            );
+            String indexExpression = "X*:metrics";
+            final var projectRouting = randomBoolean() ? "_alias:" + randomAlphaOfLengthBetween(1, 10) : null;
+
+            final var e = expectThrows(
+                NoMatchingProjectException.class,
+                () -> CrossProjectIndexExpressionsRewriter.rewriteIndexExpression(
+                    indexExpression,
+                    origin.projectAlias(),
+                    linked.stream().map(ProjectRoutingInfo::projectAlias).collect(Collectors.toUnmodifiableSet()),
+                    projectRouting
+                )
+            );
+
+            if (projectRouting != null) {
+                assertThat(e.getMessage(), equalTo("No such project: [X*] with project routing [" + projectRouting + "]"));
+            } else {
+                assertThat(e.getMessage(), equalTo("No such project: [X*]"));
+            }
+        }
     }
 
     private ProjectRoutingInfo createRandomProjectWithAlias(String alias) {

x-pack/plugin/security/src/main/java/org/elasticsearch/xpack/security/authz/IndicesAndAliasesResolver.java

@@ -399,7 +399,8 @@ ResolvedIndices resolveIndicesAndAliases(
                         final var rewritten = CrossProjectIndexExpressionsRewriter.rewriteIndexExpression(
                             indexExpression,
                             resolvedProjects.originProjectAlias(),
-                            resolvedProjects.allProjectAliases()
+                            resolvedProjects.allProjectAliases(),
+                            replaceable.getProjectRouting()
                         );
                         remoteIndices = rewritten.remoteExpressions();
                         if (resolvedProjects.originProject() == null || rewritten.localExpression() == null) {
@@ -448,7 +449,8 @@ ResolvedIndices resolveIndicesAndAliases(
                         authorizedIndices::all,
                         authorizedIndices::check,
                         resolvedProjects,
-                        indicesRequest.includeDataStreams()
+                        indicesRequest.includeDataStreams(),
+                        replaceable.getProjectRouting()
                     );
                     setResolvedIndexExpressionsIfUnset(replaceable, resolved);
                     resolvedIndicesBuilder.addLocal(resolved.getLocalIndicesList());