src/main/java/com/google/devtools/build/lib/analysis/producers/RuleTransitionApplier.java

// Copyright 2023 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.analysis.producers;

import static com.google.common.base.Preconditions.checkNotNull;
import static com.google.common.base.Preconditions.checkState;

import com.google.devtools.build.lib.analysis.PlatformOptions;
import com.google.devtools.build.lib.analysis.config.BuildOptions;
import com.google.devtools.build.lib.analysis.config.StarlarkTransitionCache;
import com.google.devtools.build.lib.analysis.config.transitions.ComposingTransition;
import com.google.devtools.build.lib.analysis.config.transitions.ConfigurationTransition;
import com.google.devtools.build.lib.analysis.config.transitions.TransitionFactory;
import com.google.devtools.build.lib.analysis.starlark.StarlarkTransition.TransitionException;
import com.google.devtools.build.lib.events.ExtendedEventHandler;
import com.google.devtools.build.lib.packages.Rule;
import com.google.devtools.build.lib.packages.RuleTransitionData;
import com.google.devtools.build.lib.skyframe.BuildConfigurationKey;
import com.google.devtools.build.lib.skyframe.PlatformMappingValue;
import com.google.devtools.build.lib.vfs.PathFragment;
import com.google.devtools.build.skyframe.SkyValue;
import com.google.devtools.build.skyframe.state.StateMachine;
import com.google.devtools.common.options.OptionsParsingException;
import java.util.Map;
import java.util.function.Consumer;
import javax.annotation.Nullable;

/** Applies the rule and trimming transitions to a {@link BuildConfigurationKey}. */
final class RuleTransitionApplier
    implements StateMachine, TransitionApplier.ResultSink, Consumer<SkyValue> {
  interface ResultSink {
    void acceptRuleTransitionResult(BuildConfigurationKey key);

    void acceptRuleTransitionError(TransitionException error);

    void acceptRuleTransitionError(OptionsParsingException error);
  }

  // -------------------- Input --------------------
  private final BuildConfigurationKey configurationKey;
  private final Rule rule;
  @Nullable private final TransitionFactory<RuleTransitionData> trimmingTransitionFactory;
  private final StarlarkTransitionCache transitionCache;

  // -------------------- Output --------------------
  private final ResultSink sink;

  // -------------------- Sequencing --------------------
  private final StateMachine runAfter;

  // -------------------- Internal State --------------------
  private BuildOptions transitionedOptions;
  private PlatformMappingValue platformMappingValue;

  RuleTransitionApplier(
      BuildConfigurationKey configurationKey,
      Rule rule,
      @Nullable TransitionFactory<RuleTransitionData> trimmingTransitionFactory,
      StarlarkTransitionCache transitionCache,
      ResultSink sink,
      StateMachine runAfter) {
    this.configurationKey = configurationKey;
    this.rule = rule;
    this.trimmingTransitionFactory = trimmingTransitionFactory;
    this.transitionCache = transitionCache;
    this.sink = sink;
    this.runAfter = runAfter;
  }

  @Override
  public StateMachine step(Tasks tasks, ExtendedEventHandler listener) {
    ConfigurationTransition transition = computeTransition(rule, trimmingTransitionFactory);
    if (transition == null) {
      sink.acceptRuleTransitionResult(configurationKey);
      return runAfter;
    }

    tasks.enqueue(
        new TransitionApplier(
            configurationKey.getOptions(),
            transition,
            transitionCache,
            (TransitionApplier.ResultSink) this));

    // TODO(b/261521010): consider fetching the platform mappings path eagerly once the rule
    // transitions are removed from dependency resolution. In the current, temporary state, it
    // makes sense to do this lazily because rule transitions are mostly applied twice and
    // rarely need remapping.
    return this::processTransitionedOptions;
  }

  @Override
  public void acceptTransitionedOptions(Map<String, BuildOptions> transitionResult) {
    checkState(transitionResult.size() == 1, "Expected exactly one result: %s", transitionResult);
    this.transitionedOptions =
        checkNotNull(
            transitionResult.get(ConfigurationTransition.PATCH_TRANSITION_KEY),
            "Transition result missing patch transition entry: %s",
            transitionResult);
  }

  @Override
  public void acceptTransitionError(TransitionException e) {
    sink.acceptRuleTransitionError(e);
  }

  private StateMachine processTransitionedOptions(Tasks tasks, ExtendedEventHandler listener) {
    if (transitionedOptions == null) {
      return runAfter; // There was an error.
    }

    // TODO(b/261521010): consider removing this check once rule transitions are removed from
    // dependency resolution.
    if (transitionedOptions.equals(configurationKey.getOptions())) {
      // Returns the original key if the options are unchanged.
      sink.acceptRuleTransitionResult(configurationKey);
      return runAfter;
    }

    tasks.lookUp(
        PlatformMappingValue.Key.create(getPlatformMappingsPath(configurationKey.getOptions())),
        (Consumer<SkyValue>) this);

    return this::composeResult;
  }

  @Override
  public void accept(SkyValue value) {
    this.platformMappingValue = (PlatformMappingValue) value;
  }

  private StateMachine composeResult(Tasks tasks, ExtendedEventHandler listener) {
    BuildConfigurationKey newConfigurationKey;
    try {
      newConfigurationKey =
          BuildConfigurationKey.withPlatformMapping(platformMappingValue, transitionedOptions);
    } catch (OptionsParsingException e) {
      sink.acceptRuleTransitionError(e);
      return runAfter;
    }

    sink.acceptRuleTransitionResult(newConfigurationKey);
    return runAfter;
  }

  @Nullable
  private static ConfigurationTransition computeTransition(
      Rule rule, @Nullable TransitionFactory<RuleTransitionData> trimmingTransitionFactory) {
    var transitionData = RuleTransitionData.create(rule);

    ConfigurationTransition transition = null;

    TransitionFactory<RuleTransitionData> transitionFactory =
        rule.getRuleClassObject().getTransitionFactory();
    if (transitionFactory != null) {
      transition = transitionFactory.create(transitionData);
    }

    if (trimmingTransitionFactory != null) {
      var trimmingTransition = trimmingTransitionFactory.create(transitionData);
      if (transition != null) {
        transition = ComposingTransition.of(transition, trimmingTransition);
      } else {
        transition = trimmingTransition;
      }
    }

    return transition;
  }

  @Nullable
  private static PathFragment getPlatformMappingsPath(BuildOptions fromOptions) {
    return fromOptions.hasNoConfig()
        ? null
        : fromOptions.get(PlatformOptions.class).platformMappings;
  }
}