implement total time

Author: Yannic

src/main/java/com/google/devtools/build/lib/buildeventstream/proto/build_event_stream.proto

@@ -22,7 +22,6 @@ import "src/main/protobuf/command_line.proto";
 import "src/main/protobuf/critical_path.proto";
 import "src/main/protobuf/failure_details.proto";
 import "src/main/protobuf/invocation_policy.proto";
-import "src/main/protobuf/spawn.proto";
 
 option java_package = "com.google.devtools.build.lib.buildeventstream";
 option java_outer_classname = "BuildEventStreamProtos";
@@ -224,7 +223,7 @@ message BuildEventId {
   // Identifier of an event providing convenience symlinks information.
   message ConvenienceSymlinksIdentifiedId {}
 
-  // Next id: 30.
+  // Next id: 28.
   oneof id {
     UnknownBuildEventId unknown = 1;
     ProgressId progress = 2;
@@ -253,8 +252,6 @@ message BuildEventId {
     BuildMetadataId build_metadata = 24;
     ConvenienceSymlinksIdentifiedId convenience_symlinks_identified = 25;
     build.bazel.bep.CriticalPath.BepId critical_path = 27;
-    tools.protos.SpawnMetrics.BepId spawn_metrics = 28;
-    build.bazel.bep.CriticalPathComponent.BepId critical_path_component = 29;
   }
 }
 
@@ -1158,7 +1155,7 @@ message ConvenienceSymlink {
 // that is observed, is provided in the payload. More options for the payload
 // might be added in the future.
 //
-// Next id: 32.
+// Next id: 30.
 message BuildEvent {
   reserved 11, 19;
   BuildEventId id = 1;
@@ -1189,7 +1186,5 @@ message BuildEvent {
     BuildMetadata build_metadata = 26;
     ConvenienceSymlinksIdentified convenience_symlinks_identified = 27;
     build.bazel.bep.CriticalPath critical_path = 29;
-    tools.protos.SpawnMetrics spawn_metrics = 30;
-    build.bazel.bep.CriticalPath critical_path_component = 31;
   }
 }

src/main/java/com/google/devtools/build/lib/buildtool/BuildTool.java

@@ -45,6 +45,7 @@
 import com.google.devtools.build.lib.events.OutputFilter;
 import com.google.devtools.build.lib.events.Reporter;
 import com.google.devtools.build.lib.exec.ExecutionOptions;
+import com.google.devtools.build.lib.metrics.criticalpath.CriticalPathEvent;
 import com.google.devtools.build.lib.pkgcache.LoadingFailedException;
 import com.google.devtools.build.lib.profiler.ProfilePhase;
 import com.google.devtools.build.lib.profiler.Profiler;
@@ -694,7 +695,9 @@ public void stopRequest(
               new BuildCompleteEvent(
                   result,
                   ImmutableList.of(
-                      BuildEventIdUtil.buildToolLogs(), BuildEventIdUtil.buildMetrics())));
+                      BuildEventIdUtil.buildToolLogs(),
+                      BuildEventIdUtil.buildMetrics(),
+                      CriticalPathEvent.BEP_ID)));
     }
     // Post the build tool logs event; the corresponding local files may be contributed from
     // modules, and this has to happen after posting the BuildCompleteEvent because that's when

src/main/java/com/google/devtools/build/lib/buildtool/buildevent/BuildCompleteEvent.java

@@ -16,6 +16,7 @@
 
 import static com.google.common.base.Preconditions.checkNotNull;
 
+import com.google.common.annotations.VisibleForTesting;
 import com.google.common.collect.ImmutableList;
 import com.google.devtools.build.lib.buildeventstream.BuildCompletingEvent;
 import com.google.devtools.build.lib.buildeventstream.BuildEventStreamProtos.BuildEventId;
@@ -36,6 +37,7 @@ public BuildCompleteEvent(BuildResult result, Collection<BuildEventId> children)
     this.result = checkNotNull(result);
   }
 
+  @VisibleForTesting
   public BuildCompleteEvent(BuildResult result) {
     this(result, ImmutableList.of());
   }

src/main/java/com/google/devtools/build/lib/metrics/criticalpath/AggregatedCriticalPath.java

@@ -15,7 +15,9 @@
 package com.google.devtools.build.lib.metrics.criticalpath;
 
 import com.google.common.base.Joiner;
+import com.google.common.base.Preconditions;
 import com.google.common.collect.ImmutableList;
+import com.google.common.eventbus.EventBus;
 import com.google.devtools.build.lib.actions.AggregatedSpawnMetrics;
 import com.google.devtools.build.lib.actions.SpawnMetrics;
 import java.time.Duration;
@@ -103,4 +105,11 @@ public String toStringSummary() {
   public String toStringSummaryNoRemote() {
     return toString(true, false);
   }
+
+  /**Posts the {@code BEP} event for the critical path on the provided {@link EventBus}. */
+  public void postEvent(EventBus eventBus) {
+    Preconditions.checkNotNull(eventBus);
+
+    eventBus.post(new CriticalPathEvent(Duration.ofMillis(totalTimeInMs)));
+  }
 }

src/main/java/com/google/devtools/build/lib/metrics/criticalpath/BUILD

@@ -17,12 +17,17 @@ java_library(
     deps = [
         "//src/main/java/com/google/devtools/build/lib/actions",
         "//src/main/java/com/google/devtools/build/lib/actions:artifacts",
+        "//src/main/java/com/google/devtools/build/lib/buildeventstream",
+        "//src/main/java/com/google/devtools/build/lib/buildeventstream/proto:build_event_stream_java_proto",
         "//src/main/java/com/google/devtools/build/lib/clock",
         "//src/main/java/com/google/devtools/build/lib/cmdline",
         "//src/main/java/com/google/devtools/build/lib/concurrent",
+        "//src/main/java/com/google/devtools/build/lib/events",
         "//src/main/java/com/google/devtools/build/lib/skyframe/rewinding:action_rewound_event",
+        "//src/main/protobuf:critical_path_java_proto",
         "//third_party:flogger",
         "//third_party:guava",
         "//third_party:jsr305",
+        "@com_google_protobuf//:protobuf_java",
     ],
 )

src/main/java/com/google/devtools/build/lib/metrics/criticalpath/CriticalPathEvent.java

@@ -0,0 +1,47 @@
+package com.google.devtools.build.lib.metrics.criticalpath;
+
+import build.bazel.bep.CriticalPath;
+import com.google.common.base.Preconditions;
+import com.google.common.collect.ImmutableList;
+import com.google.devtools.build.lib.buildeventstream.BuildEventContext;
+import com.google.devtools.build.lib.buildeventstream.BuildEventIdUtil;
+import com.google.devtools.build.lib.buildeventstream.BuildEventStreamProtos;
+import com.google.devtools.build.lib.buildeventstream.BuildEventStreamProtos.BuildEventId;
+import com.google.devtools.build.lib.buildeventstream.BuildEventWithOrderConstraint;
+import com.google.devtools.build.lib.buildeventstream.GenericBuildEvent;
+import java.time.Duration;
+import java.util.Collection;
+
+/** {@code Build event protocol} event for the {@code critical path} of a build. */
+public final class CriticalPathEvent extends GenericBuildEvent
+    implements BuildEventWithOrderConstraint {
+  public static final BuildEventId BEP_ID =
+      BuildEventId.newBuilder().setCriticalPath(CriticalPath.BepId.getDefaultInstance()).build();
+
+  private final Duration totalTime;
+
+  CriticalPathEvent(Duration totalTime) {
+    super(BEP_ID, ImmutableList.of());
+
+    this.totalTime = Preconditions.checkNotNull(totalTime);
+  }
+
+  @Override
+  public Collection<BuildEventId> postedAfter() {
+    return ImmutableList.of(BuildEventIdUtil.buildFinished());
+  }
+
+  @Override
+  public BuildEventStreamProtos.BuildEvent asStreamProto(BuildEventContext converters) {
+    return GenericBuildEvent.protoChaining(this)
+        .setCriticalPath(
+            CriticalPath.newBuilder()
+                .setTotalTime(
+                    com.google.protobuf.Duration.newBuilder()
+                        .setSeconds(totalTime.getSeconds())
+                        .setNanos(totalTime.getNano())
+                        .build())
+                .build())
+        .build();
+  }
+}

src/main/java/com/google/devtools/build/lib/runtime/BuildSummaryStatsModule.java

@@ -225,6 +225,8 @@ public void buildComplete(BuildCompleteEvent event) {
           .getResult()
           .getBuildToolLogCollection()
           .addDirectValue("process stats", spawnSummaryString.getBytes(StandardCharsets.UTF_8));
+
+      criticalPath.postEvent(eventBus);
     } finally {
       if (criticalPathComputer != null) {
         eventBus.unregister(criticalPathComputer);

src/main/protobuf/critical_path.proto

@@ -21,12 +21,12 @@ import "google/protobuf/duration.proto";
 option java_package = "build.bazel.bep";
 option java_outer_classname = "CriticalPathProtos";
 // option java_api_version = 2;
+option java_multiple_files = true;
 
 // Represents the critical path of a build.
 //
 // This is an event in the Build Event Stream (BES) with the following
 // children:
-//   - `tools.protos.SpawnMetrics`
 //   - `build.bazel.bep.CriticalPathComponent`
 message CriticalPath {
   // Identifier of a BES event of this type.
@@ -35,11 +35,3 @@ message CriticalPath {
   // The total time of the critical path.
   google.protobuf.Duration total_time = 1;
 }
-
-// Represents a single component in the critical path.
-message CriticalPathComponent {
-  // Identifier of a BES event of this type.
-  message BepId {
-    string action_key = 1;
-  }
-}

src/main/protobuf/spawn.proto

@@ -63,11 +63,6 @@ message Platform {
 //
 // Next id: 21
 message SpawnMetrics {
-  // Identifier of a BES event of this type.
-  message BepId {
-    SpawnExecKind exec_kind = 1;
-  }
-
   enum SpawnExecKind {
     OTHER = 0;
     REMOTE = 1;