Re-use previously computed deps for TransitiveBaseTraversalFunction#compute if we have them instead of re-computing them each time on a skyframe restart.

PiperOrigin-RevId: 186017079

2 files changed, 162 insertions, 0 deletions

diff --git a/src/test/java/com/google/devtools/build/lib/skyframe/TransitiveBaseTraversalFunctionTest.java b/src/test/java/com/google/devtools/build/lib/skyframe/TransitiveBaseTraversalFunctionTest.java
new file mode 100644
index 0000000000..665e706e7f
--- /dev/null
+++ b/src/test/java/com/google/devtools/build/lib/skyframe/TransitiveBaseTraversalFunctionTest.java
@@ -0,0 +1,134 @@
+// Copyright 2018 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;
+
+import static com.google.common.truth.Truth.assertThat;
+import static org.mockito.Mockito.when;
+
+import com.google.common.collect.ImmutableMap;
+import com.google.devtools.build.lib.analysis.util.BuildViewTestCase;
+import com.google.devtools.build.lib.cmdline.Label;
+import com.google.devtools.build.lib.cmdline.PackageIdentifier;
+import com.google.devtools.build.lib.packages.NoSuchPackageException;
+import com.google.devtools.build.lib.packages.NoSuchTargetException;
+import com.google.devtools.build.lib.packages.Package;
+import com.google.devtools.build.lib.skyframe.TransitiveBaseTraversalFunction.TargetAndErrorIfAnyImpl;
+import com.google.devtools.build.lib.testutil.TestRuleClassProvider;
+import com.google.devtools.build.lib.util.GroupedList;
+import com.google.devtools.build.lib.util.GroupedList.GroupedListHelper;
+import com.google.devtools.build.lib.vfs.Path;
+import com.google.devtools.build.skyframe.SkyFunction;
+import com.google.devtools.build.skyframe.SkyKey;
+import java.util.concurrent.atomic.AtomicBoolean;
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.junit.runners.JUnit4;
+import org.mockito.Mockito;
+
+/** Test for {@link TransitiveBaseTraversalFunction}. */
+@RunWith(JUnit4.class)
+public class TransitiveBaseTraversalFunctionTest extends BuildViewTestCase {
+  Label label;
+  TargetAndErrorIfAnyImpl targetAndErrorIfAny;
+
+  @Before
+  public void setUp() throws Exception {
+    // Create a basic package with a target //foo:foo.
+    label = Label.parseAbsolute("//foo:foo");
+    Package pkg =
+        scratchPackage(
+            "workspace",
+            label.getPackageIdentifier(),
+            "sh_library(name = '" + label.getName() + "')");
+    targetAndErrorIfAny =
+        new TargetAndErrorIfAnyImpl(
+            /*packageLoadedSuccessfully=*/ true,
+            /*errorLoadingTarget=*/ null,
+            pkg.getTarget(label.getName()));
+  }
+
+  @Test
+  public void assertNoLabelVisitationForTransitiveTraversalFunction() throws Exception {
+    assertNoLabelVisitationForFunction(
+        new TransitiveTraversalFunction() {
+          @Override
+          protected LoadTargetResults loadTarget(Environment env, Label label)
+              throws NoSuchTargetException, NoSuchPackageException, InterruptedException {
+            return targetAndErrorIfAny;
+          }
+        });
+  }
+
+  @Test
+  public void assertNoLabelVisitationForTransitiveTargetFunction() throws Exception {
+    assertNoLabelVisitationForFunction(
+        new TransitiveTargetFunction(TestRuleClassProvider.getRuleClassProvider()) {
+          @Override
+          protected LoadTargetResults loadTarget(Environment env, Label label)
+              throws NoSuchTargetException, NoSuchPackageException, InterruptedException {
+            return targetAndErrorIfAny;
+          }
+        });
+  }
+
+  private void assertNoLabelVisitationForFunction(TransitiveBaseTraversalFunction<?> function)
+      throws Exception {
+    // Create the GroupedList saying we had already requested two targets the last time we called
+    // #compute.
+    GroupedListHelper<SkyKey> helper = new GroupedListHelper<>();
+    SkyKey fakeDep1 = function.getKey(Label.parseAbsolute("//foo:bar"));
+    SkyKey fakeDep2 = function.getKey(Label.parseAbsolute("//foo:baz"));
+    helper.add(TargetMarkerValue.key(label));
+    helper.add(PackageValue.key(label.getPackageIdentifier()));
+    helper.startGroup();
+    // Note that these targets don't actually exist in the package we created initially. It doesn't
+    // matter for the purpose of this test, the original package was just to create some objects
+    // that we needed.
+    helper.add(fakeDep1);
+    helper.add(fakeDep2);
+    helper.endGroup();
+    GroupedList<SkyKey> groupedList = new GroupedList<>();
+    groupedList.append(helper);
+    AtomicBoolean wasOptimizationUsed = new AtomicBoolean(false);
+    SkyFunction.Environment mockEnv = Mockito.mock(SkyFunction.Environment.class);
+    when(mockEnv.getTemporaryDirectDeps()).thenReturn(groupedList);
+    when(mockEnv.getValuesOrThrow(
+            groupedList.get(2), NoSuchPackageException.class, NoSuchTargetException.class))
+        .thenAnswer(
+            (invocationOnMock) -> {
+              wasOptimizationUsed.set(true);
+              // It doesn't matter what this map is, we'll return false in the valuesMissing() call.
+              return ImmutableMap.of();
+            });
+    when(mockEnv.valuesMissing()).thenReturn(true);
+
+    // Run the compute function and check that we returned null.
+    assertThat(function.compute(function.getKey(label), mockEnv)).isNull();
+
+    // Verify that the mock was called with the arguments we expected.
+    assertThat(wasOptimizationUsed.get()).isTrue();
+  }
+
+  private Package scratchPackage(String workspaceName, PackageIdentifier packageId, String... lines)
+      throws Exception {
+    Path buildFile = scratch.file("" + packageId.getSourceRoot() + "/BUILD", lines);
+    Package.Builder externalPkg =
+        Package.newExternalPackageBuilder(
+            Package.Builder.DefaultHelper.INSTANCE, buildFile.getRelative("WORKSPACE"), "TESTING");
+    externalPkg.setWorkspaceName(workspaceName);
+    return pkgFactory.createPackageForTesting(
+        packageId, externalPkg.build(), buildFile, packageIdentifier -> buildFile, reporter);
+  }
+}
diff --git a/src/test/java/com/google/devtools/build/skyframe/MemoizingEvaluatorTest.java b/src/test/java/com/google/devtools/build/skyframe/MemoizingEvaluatorTest.java
index 0b1ed3561e..b1518fc3b9 100644
--- a/src/test/java/com/google/devtools/build/skyframe/MemoizingEvaluatorTest.java
+++ b/src/test/java/com/google/devtools/build/skyframe/MemoizingEvaluatorTest.java
@@ -53,6 +53,7 @@ import com.google.devtools.build.skyframe.SkyFunction.Environment;
 import com.google.devtools.build.skyframe.SkyFunctionException.Transience;
 import java.lang.ref.WeakReference;
 import java.util.ArrayList;
+import java.util.Collections;
 import java.util.List;
 import java.util.Map;
 import java.util.Set;
@@ -214,6 +215,33 @@ public class MemoizingEvaluatorTest {
   }
 
   @Test
+  public void testEnvProvidesTemporaryDirectDeps() throws Exception {
+    AtomicInteger counter = new AtomicInteger();
+    List<SkyKey> deps = Collections.synchronizedList(new ArrayList<>());
+    SkyKey topKey = toSkyKey("top");
+    SkyKey bottomKey = toSkyKey("bottom");
+    SkyValue bottomValue = new StringValue("bottom");
+    tester
+        .getOrCreate(topKey)
+        .setBuilder(
+            new NoExtractorFunction() {
+              @Override
+              public SkyValue compute(SkyKey skyKey, Environment env) throws InterruptedException {
+                if (counter.getAndIncrement() > 0) {
+                  deps.addAll(env.getTemporaryDirectDeps().get(0));
+                } else {
+                  assertThat(env.getTemporaryDirectDeps().listSize()).isEqualTo(0);
+                }
+                return env.getValue(bottomKey);
+              }
+            });
+    tester.getOrCreate(bottomKey).setConstantValue(bottomValue);
+    EvaluationResult<StringValue> result = tester.eval(/*keepGoing=*/ true, "top");
+    assertThat(result.get(topKey)).isEqualTo(bottomValue);
+    assertThat(deps).containsExactly(bottomKey);
+  }
+
+  @Test
   public void cachedErrorShutsDownThreadpool() throws Exception {
     // When a node throws an error on the first build,
     SkyKey cachedErrorKey = GraphTester.skyKey("error");