src/main/java/com/google/devtools/build/lib/bazel/bzlmod/SingleExtensionFunction.java

// Copyright 2021 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.bazel.bzlmod;

import com.google.devtools.build.lib.server.FailureDetails.ExternalDeps.Code;
import com.google.devtools.build.skyframe.SkyFunction;
import com.google.devtools.build.skyframe.SkyFunctionException;
import com.google.devtools.build.skyframe.SkyFunctionException.Transience;
import com.google.devtools.build.skyframe.SkyKey;
import com.google.devtools.build.skyframe.SkyValue;
import java.util.Map.Entry;
import javax.annotation.Nullable;
import net.starlark.java.spelling.SpellChecker;

/**
 * Validates the result of {@link SingleExtensionEvalFunction}. This is done in a separate
 * SkyFunction so that the unvalidated value can be cached, avoiding a re-evaluation of the
 * extension, even if the `use_repo` imports provided by the user are incorrect.
 */
public class SingleExtensionFunction implements SkyFunction {

  @Nullable
  @Override
  public SkyValue compute(SkyKey skyKey, Environment env)
      throws InterruptedException, SingleExtensionFunctionException {
    ModuleExtensionId extensionId = (ModuleExtensionId) skyKey.argument();
    SingleExtensionUsagesValue usagesValue =
        (SingleExtensionUsagesValue) env.getValue(SingleExtensionUsagesValue.key(extensionId));
    if (usagesValue == null) {
      return null;
    }
    SingleExtensionValue evalOnlyValue =
        (SingleExtensionValue) env.getValue(SingleExtensionValue.evalKey(extensionId));
    if (evalOnlyValue == null) {
      return null;
    }

    // Check that all imported repos have actually been generated.
    for (ModuleExtensionUsage usage : usagesValue.getExtensionUsages().values()) {
      for (Entry<String, String> repoImport : usage.getImports().entrySet()) {
        if (!evalOnlyValue.getGeneratedRepoSpecs().containsKey(repoImport.getValue())) {
          throw new SingleExtensionFunctionException(
              ExternalDepsException.withMessage(
                  Code.INVALID_EXTENSION_IMPORT,
                  "module extension \"%s\" from \"%s\" does not generate repository \"%s\", yet it"
                      + " is imported as \"%s\" in the usage at %s%s",
                  extensionId.getExtensionName(),
                  extensionId.getBzlFileLabel(),
                  repoImport.getValue(),
                  repoImport.getKey(),
                  usage.getLocation(),
                  SpellChecker.didYouMean(
                      repoImport.getValue(), evalOnlyValue.getGeneratedRepoSpecs().keySet())),
              Transience.PERSISTENT);
        }
      }
    }

    return evalOnlyValue;
  }

  static final class SingleExtensionFunctionException extends SkyFunctionException {

    SingleExtensionFunctionException(ExternalDepsException cause, Transience transience) {
      super(cause, transience);
    }
  }
}