go.chromium.org/luci@v0.0.0-20240309015107-7cdc2e660f33/led/job/experiments/common.go (about)

     1  // Copyright 2020 The LUCI Authors.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //      http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package experiments
    16  
    17  import (
    18  	"context"
    19  
    20  	"go.chromium.org/luci/common/errors"
    21  
    22  	bbpb "go.chromium.org/luci/buildbucket/proto"
    23  	swarmingpb "go.chromium.org/luci/swarming/proto/api_v2"
    24  )
    25  
    26  var knownExperiments = map[string]Experiment{}
    27  
    28  // Experiment mutates `task` based on `b`.
    29  type Experiment func(ctx context.Context, b *bbpb.Build, task *swarmingpb.NewTaskRequest) error
    30  
    31  // Register registers a known experiment given its key and implementation.
    32  func Register(key string, exp Experiment) {
    33  	knownExperiments[key] = exp
    34  }
    35  
    36  // Apply mutates `task` based on known experiments in b.Input.Experiments.
    37  func Apply(ctx context.Context, b *bbpb.Build, task *swarmingpb.NewTaskRequest) error {
    38  	for _, name := range b.GetInput().GetExperiments() {
    39  		if exp, ok := knownExperiments[name]; ok {
    40  			if err := exp(ctx, b, task); err != nil {
    41  				return errors.Annotate(err, "experiment %q", name).Err()
    42  			}
    43  		}
    44  	}
    45  	return nil
    46  }