BEP: Report pattern expansion failures

If expanding a pattern fails, report this on the build event protocol;
also include details of what happened.

--
Change-Id: I2bc9caf7c085911b80551d7892cc34f5e9961c7b
Reviewed-on: https://cr.bazel.build/8795
PiperOrigin-RevId: 148894326
MOS_MIGRATED_REVID=148894326

4 files changed, 106 insertions, 5 deletions

diff --git a/src/main/java/com/google/devtools/build/lib/buildeventstream/BuildEventId.java b/src/main/java/com/google/devtools/build/lib/buildeventstream/BuildEventId.java
index 467d6f2b20..3a89fa5aeb 100644
--- a/src/main/java/com/google/devtools/build/lib/buildeventstream/BuildEventId.java
+++ b/src/main/java/com/google/devtools/build/lib/buildeventstream/BuildEventId.java
@@ -84,15 +84,30 @@ public final class BuildEventId implements Serializable {
         BuildEventStreamProtos.BuildEventId.newBuilder().setStarted(startedId).build());
   }
 
-  public static BuildEventId targetPatternExpanded(List<String> targetPattern) {
+  private static BuildEventId targetPatternExpanded(List<String> targetPattern, boolean skipped) {
     BuildEventStreamProtos.BuildEventId.PatternExpandedId patternId =
         BuildEventStreamProtos.BuildEventId.PatternExpandedId.newBuilder()
             .addAllPattern(targetPattern)
             .build();
-    return new BuildEventId(
-        BuildEventStreamProtos.BuildEventId.newBuilder().setPattern(patternId).build());
+    BuildEventStreamProtos.BuildEventId.Builder builder =
+        BuildEventStreamProtos.BuildEventId.newBuilder();
+    if (skipped) {
+      builder.setPatternSkipped(patternId);
+    } else {
+      builder.setPattern(patternId);
+    }
+    return new BuildEventId(builder.build());
   }
 
+  public static BuildEventId targetPatternExpanded(List<String> targetPattern) {
+    return targetPatternExpanded(targetPattern, false);
+  }
+
+  public static BuildEventId targetPatternSkipped(List<String> targetPattern) {
+    return targetPatternExpanded(targetPattern, true);
+  }
+
+
   public static BuildEventId targetCompleted(Label target) {
     BuildEventStreamProtos.BuildEventId.TargetCompletedId targetId =
         BuildEventStreamProtos.BuildEventId.TargetCompletedId.newBuilder()
diff --git a/src/main/java/com/google/devtools/build/lib/buildeventstream/proto/build_event_stream.proto b/src/main/java/com/google/devtools/build/lib/buildeventstream/proto/build_event_stream.proto
index 1ff9d6a021..9d6af941f8 100644
--- a/src/main/java/com/google/devtools/build/lib/buildeventstream/proto/build_event_stream.proto
+++ b/src/main/java/com/google/devtools/build/lib/buildeventstream/proto/build_event_stream.proto
@@ -51,6 +51,10 @@ message BuildEventId {
 
   // Identifier of an event indicating that a target pattern has been expanded
   // further.
+  // Messages of this shape are also used to describe parts of a pattern that
+  // have been skipped for some reason, if the actual expasion was still carried
+  // out (e.g., if keep_going is set). In this case, the pattern_skipped choice
+  // in the id field is to be made.
   message PatternExpandedId {
     repeated string pattern = 1;
   }
@@ -94,6 +98,7 @@ message BuildEventId {
     ProgressId progress = 2;
     BuildStartedId started = 3;
     PatternExpandedId pattern = 4;
+    PatternExpandedId pattern_skipped = 10;
     TargetCompletedId target_completed = 5;
     ActionCompletedId action_completed = 6;
     TestResultId test_result = 8;
@@ -135,6 +140,12 @@ message Aborted {
   string description = 2;
 }
 
+// Payload of an event indicating that an expected event will not come, as
+// something went wrong when attempting to load the corresponding package.
+message LoadingFailure {
+  string details = 1;
+}
+
 // Payload of an event indicating the beginning of a new build. Usually, events
 // of those type start a new build-event stream. The target pattern requested
 // to be build is contained in one of the announced child events; it is an
@@ -273,6 +284,7 @@ message BuildEvent {
   oneof payload {
     Progress progress = 3;
     Aborted aborted = 4;
+    LoadingFailure loading_failed = 11;
     BuildStarted started = 5;
     PatternExpanded expanded = 6;
     ActionExecuted action = 7;
diff --git a/src/main/java/com/google/devtools/build/lib/skyframe/PatternExpandingError.java b/src/main/java/com/google/devtools/build/lib/skyframe/PatternExpandingError.java
new file mode 100644
index 0000000000..fd273e7fee
--- /dev/null
+++ b/src/main/java/com/google/devtools/build/lib/skyframe/PatternExpandingError.java
@@ -0,0 +1,66 @@
+// Copyright 2016 The Bazel Authors. All rights reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//    http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+package com.google.devtools.build.lib.skyframe;
+
+import com.google.common.collect.ImmutableList;
+import com.google.devtools.build.lib.buildeventstream.BuildEvent;
+import com.google.devtools.build.lib.buildeventstream.BuildEventId;
+import com.google.devtools.build.lib.buildeventstream.BuildEventStreamProtos;
+import com.google.devtools.build.lib.buildeventstream.GenericBuildEvent;
+import com.google.devtools.build.lib.buildeventstream.PathConverter;
+import java.util.Collection;
+import java.util.List;
+
+/** Event reporting about failure to expand a target pattern properly. */
+public final class PatternExpandingError implements BuildEvent {
+
+  private final List<String> pattern;
+  private final String message;
+  private final boolean skipped;
+
+  private PatternExpandingError(List<String> pattern, String message, boolean skipped) {
+    this.pattern = pattern;
+    this.message = message;
+    this.skipped = skipped;
+  }
+
+  public static PatternExpandingError failed(List<String> pattern, String message) {
+    return new PatternExpandingError(pattern, message, false);
+  }
+
+  public static PatternExpandingError skipped(String term, String message) {
+    return new PatternExpandingError(ImmutableList.of(term), message, true);
+  }
+
+  @Override
+  public BuildEventId getEventId() {
+    if (skipped) {
+      return BuildEventId.targetPatternSkipped(pattern);
+    } else {
+      return BuildEventId.targetPatternExpanded(pattern);
+    }
+  }
+
+  @Override
+  public Collection<BuildEventId> getChildrenEvents() {
+    return ImmutableList.<BuildEventId>of();
+  }
+
+  @Override
+  public BuildEventStreamProtos.BuildEvent asStreamProto(PathConverter pathConverter) {
+    BuildEventStreamProtos.LoadingFailure failure =
+        BuildEventStreamProtos.LoadingFailure.newBuilder().setDetails(message).build();
+    return GenericBuildEvent.protoChaining(this).setLoadingFailed(failure).build();
+  }
+}
diff --git a/src/main/java/com/google/devtools/build/lib/skyframe/SkyframeTargetPatternEvaluator.java b/src/main/java/com/google/devtools/build/lib/skyframe/SkyframeTargetPatternEvaluator.java
index 6fc79ef7e0..af3450e765 100644
--- a/src/main/java/com/google/devtools/build/lib/skyframe/SkyframeTargetPatternEvaluator.java
+++ b/src/main/java/com/google/devtools/build/lib/skyframe/SkyframeTargetPatternEvaluator.java
@@ -121,8 +121,13 @@ final class SkyframeTargetPatternEvaluator implements TargetPatternEvaluator {
       }
     }
     ImmutableList<SkyKey> skyKeys = builder.build();
-    return parseTargetPatternKeys(skyKeys, SkyframeExecutor.DEFAULT_THREAD_COUNT, keepGoing,
-        eventHandler, createTargetPatternEvaluatorUtil(policy, eventHandler, keepGoing));
+    return parseTargetPatternKeys(
+        targetPatterns,
+        skyKeys,
+        SkyframeExecutor.DEFAULT_THREAD_COUNT,
+        keepGoing,
+        eventHandler,
+        createTargetPatternEvaluatorUtil(policy, eventHandler, keepGoing));
   }
 
   private TargetPatternsResultBuilder createTargetPatternEvaluatorUtil(
@@ -134,6 +139,7 @@ final class SkyframeTargetPatternEvaluator implements TargetPatternEvaluator {
   }
 
   ResolvedTargets<Target> parseTargetPatternKeys(
+      List<String> targetPattern,
       Iterable<SkyKey> patternSkyKeys,
       int numThreads,
       boolean keepGoing,
@@ -178,6 +184,7 @@ final class SkyframeTargetPatternEvaluator implements TargetPatternEvaluator {
         }
         if (keepGoing) {
           eventHandler.handle(Event.error("Skipping '" + rawPattern + "': " + errorMessage));
+          eventHandler.post(PatternExpandingError.skipped(rawPattern, errorMessage));
         }
         finalTargetSetEvaluator.setError();
 
@@ -192,6 +199,7 @@ final class SkyframeTargetPatternEvaluator implements TargetPatternEvaluator {
       Preconditions.checkState(errorMessage != null, "unexpected errors: %s", result.errorMap());
       finalTargetSetEvaluator.setError();
       if (!keepGoing) {
+        eventHandler.post(PatternExpandingError.failed(targetPattern, errorMessage));
         throw new TargetParsingException(errorMessage);
       }
     }