From 8fa3bc71374eba92c79346c1d0e92d9445b87a71 Mon Sep 17 00:00:00 2001
From: Evgeny Zemtsov <eze@resoptima.com>
Date: Thu, 1 Sep 2022 10:10:48 +0200
Subject: feat(buildkite/mkPipeline): allow fast failure for build steps

This is supposed to help with resource wasting in situations when
multiple dynamic steps depend on a failing derivation. Cost of
failure currently is `C = T * D` where:
 - T -> time to compile the failing derivation
 - D -> amount of CI targets depending on a failing derivation

Switching to `Fail Fast` limits it to just T (time of a single
failure). Which helps a lot, especially while upgrading nixpkgs.

Fast fail at this moment is in preview, so to enable it:
 - Enable `Fail Fast` feature at pipeline or organization level
 - Set `cancelOnBuildFailing` parameter to true for `mkPipeline`

Change-Id: I4373a46633522d21e94cfa8bac35243b4eeb0b9c
Reviewed-on: https://cl.tvl.fyi/c/depot/+/6243
Tested-by: BuildkiteCI
Reviewed-by: tazjin <tazjin@tvl.su>
---
 nix/buildkite/default.nix | 13 ++++++++++---
 1 file changed, 10 insertions(+), 3 deletions(-)

(limited to 'nix/buildkite')

diff --git a/nix/buildkite/default.nix b/nix/buildkite/default.nix
index 5c46dcb333..898c4f5cb8 100644
--- a/nix/buildkite/default.nix
+++ b/nix/buildkite/default.nix
@@ -66,7 +66,7 @@ rec {
   ];
 
   # Create a pipeline step from a single target.
-  mkStep = headBranch: parentTargetMap: target:
+  mkStep = headBranch: parentTargetMap: target: cancelOnBuildFailing:
     let
       label = mkLabel target;
       drvPath = unsafeDiscardStringContext target.drvPath;
@@ -78,6 +78,7 @@ rec {
       skip = shouldSkip' label drvPath;
       command = mkBuildCommand target drvPath;
       env.READTREE_TARGET = label;
+      cancel_on_build_failing = cancelOnBuildFailing;
 
       # Add a dependency on the initial static pipeline step which
       # always runs. This allows build steps uploaded in batches to
@@ -151,6 +152,12 @@ rec {
       #
       # TODO(tazjin): Fail/warn if unknown phase is requested.
       activePhases ? [ "build" "release" ]
+      # Setting this attribute to true cancels dynamic pipeline steps
+      # as soon as the build is marked as failing.
+      #
+      # To enable this feature one should enable "Fail Fast" setting
+      # at Buildkite pipeline or on organization level.
+    , cancelOnBuildFailing ? false
     }:
     let
       # Currently the only known phases are 'build' (Nix builds and
@@ -172,14 +179,14 @@ rec {
       # phase (as phases end up in different chunks).
       targetToSteps = target:
         let
-          step = mkStep headBranch parentTargetMap target;
+          step = mkStep headBranch parentTargetMap target cancelOnBuildFailing;
 
           # Same step, but with an override function applied. This is
           # used in mkExtraStep if the extra step needs to modify the
           # parent derivation somehow.
           #
           # Note that this will never affect the label.
-          overridable = f: mkStep headBranch parentTargetMap (f target);
+          overridable = f: mkStep headBranch parentTargetMap (f target) cancelOnBuildFailing;
 
           # Split extra steps by phase.
           splitExtraSteps = lib.groupBy ({ phase, ... }: phase)
-- 
cgit 1.4.1