src/main/java/com/google/devtools/build/lib/skyframe/packages/PackageLoader.java

// Copyright 2017 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.skyframe.packages;

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

import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.devtools.build.lib.cmdline.PackageIdentifier;
import com.google.devtools.build.lib.events.Event;
import com.google.devtools.build.lib.packages.NoSuchPackageException;
import com.google.devtools.build.lib.packages.Package;
import javax.annotation.Nullable;

/** A standalone library for performing Bazel package loading. */
public interface PackageLoader extends AutoCloseable {
  /**
   * Loads and returns a single package. This method is a simplified shorthand for {@link
   * #loadPackages} when just a single {@link Package} and nothing else is desired.
   */
  Package loadPackage(PackageIdentifier pkgId) throws NoSuchPackageException, InterruptedException;

  /**
   * Returns the result of loading a collection of packages. Note that the returned {@link Package}s
   * may contain errors - see {@link Package#containsErrors()} for details.
   */
  Result loadPackages(Iterable<PackageIdentifier> pkgIds) throws InterruptedException;

  /**
   * Shut down the internal threadpools used by the {@link PackageLoader}.
   *
   * <p>Call this method when you are completely done with the {@link PackageLoader} instance,
   * otherwise there may be resource leaks.
   */
  @Override
  void close();

  /** Contains the result of package loading. */
  class Result {
    private final ImmutableMap<PackageIdentifier, PackageOrException> loadedPackages;
    private final ImmutableList<Event> events;

    Result(
        ImmutableMap<PackageIdentifier, PackageOrException> loadedPackages,
        ImmutableList<Event> events) {
      this.loadedPackages = loadedPackages;
      this.events = events;
    }

    public ImmutableMap<PackageIdentifier, PackageOrException> getLoadedPackages() {
      return loadedPackages;
    }

    /** Returns all events generated while loading the requested packages. */
    public ImmutableList<Event> getEvents() {
      return events;
    }
  }

  /** Contains a {@link Package} or the exception produced while loading it. */
  class PackageOrException {
    private final Package pkg;
    private final NoSuchPackageException exception;

    PackageOrException(@Nullable Package pkg, @Nullable NoSuchPackageException exception) {
      checkState((pkg == null) != (exception == null));
      this.pkg = pkg;
      this.exception = exception;
    }

    /**
     * @throws NoSuchPackageException if there was a non-recoverable error loading the package, e.g.
     *     an io error reading the BUILD file.
     */
    public Package get() throws NoSuchPackageException {
      if (pkg != null) {
        return pkg;
      }
      throw exception;
    }
  }
}