Automatically ignore vendor dir for finding packages

- Adding `--vendor_dir` to ignored package prefixes as if it's added in the `.bazelignore` file. - This allows users to do `bazel build //...` after vendoring external deps in the source root without manually adding the vendor dir in `.bazelignore`. Fixes bazelbuild#23521 Closes bazelbuild#23771. PiperOrigin-RevId: 680994986 Change-Id: I9c8b76ca20b9060232dfe05460a8fc857c92e93f
meteorcloudy · Oct 9, 2024 · b48dc31 · b48dc31
1 parent e2193ee
commit b48dc31
Show file tree

Hide file tree

Showing 6 changed files with 66 additions and 3 deletions.
diff --git a/src/main/java/com/google/devtools/build/lib/skyframe/BUILD b/src/main/java/com/google/devtools/build/lib/skyframe/BUILD
@@ -798,6 +798,7 @@ java_library(
         "//src/main/java/com/google/devtools/build/lib/io:inconsistent_filesystem_exception",
         "//src/main/java/com/google/devtools/build/lib/pkgcache",
         "//src/main/java/com/google/devtools/build/lib/rules:repository/repository_directory_value",
+        "//src/main/java/com/google/devtools/build/lib/rules:repository/repository_function",
         "//src/main/java/com/google/devtools/build/lib/vfs",
         "//src/main/java/com/google/devtools/build/lib/vfs:pathfragment",
         "//src/main/java/com/google/devtools/build/skyframe",

diff --git a/src/main/java/com/google/devtools/build/lib/skyframe/IgnoredPackagePrefixesFunction.java b/src/main/java/com/google/devtools/build/lib/skyframe/IgnoredPackagePrefixesFunction.java
@@ -13,6 +13,8 @@
 // limitations under the License.
 package com.google.devtools.build.lib.skyframe;
 
+import static com.google.devtools.build.lib.rules.repository.RepositoryDelegatorFunction.VENDOR_DIRECTORY;
+
 import com.google.common.collect.ImmutableSet;
 import com.google.common.io.CharStreams;
 import com.google.common.io.LineProcessor;
@@ -82,7 +84,17 @@ public SkyValue compute(SkyKey key, Environment env)
       }
 
       if (repositoryName.isMain()) {
+        PathFragment vendorDir = null;
+        if (VENDOR_DIRECTORY.get(env).isPresent()) {
+          vendorDir = VENDOR_DIRECTORY.get(env).get().asFragment();
+        }
+
         for (Root packagePathEntry : pkgLocator.getPathEntries()) {
+          PathFragment workspaceRoot = packagePathEntry.asPath().asFragment();
+          if (vendorDir != null && vendorDir.startsWith(workspaceRoot)) {
+            ignoredPackagePrefixesBuilder.add(vendorDir.relativeTo(workspaceRoot));
+          }
+
           RootedPath rootedPatternFile =
               RootedPath.toRootedPath(packagePathEntry, ignoredPackagePrefixesFile);
           FileValue patternFileValue = (FileValue) env.getValue(FileValue.key(rootedPatternFile));

diff --git a/src/test/java/com/google/devtools/build/lib/analysis/util/BuildViewTestCase.java b/src/test/java/com/google/devtools/build/lib/analysis/util/BuildViewTestCase.java
@@ -526,7 +526,9 @@ private void setUpSkyframe() {
     skyframeExecutor.injectExtraPrecomputedValues(
         ImmutableList.of(
             PrecomputedValue.injected(
-                RepositoryDelegatorFunction.RESOLVED_FILE_INSTEAD_OF_WORKSPACE, Optional.empty())));
+                RepositoryDelegatorFunction.RESOLVED_FILE_INSTEAD_OF_WORKSPACE, Optional.empty()),
+            PrecomputedValue.injected(
+                RepositoryDelegatorFunction.VENDOR_DIRECTORY, Optional.empty())));
   }
 
   protected void setPackageOptions(String... options) throws Exception {

diff --git a/src/test/java/com/google/devtools/build/lib/packages/util/PackageLoadingTestCase.java b/src/test/java/com/google/devtools/build/lib/packages/util/PackageLoadingTestCase.java
@@ -149,6 +149,10 @@ private SkyframeExecutor createSkyframeExecutor() {
         ImmutableList.of(
             PrecomputedValue.injected(
                 RepositoryDelegatorFunction.RESOLVED_FILE_INSTEAD_OF_WORKSPACE, Optional.empty())));
+    skyframeExecutor.injectExtraPrecomputedValues(
+        ImmutableList.of(
+            PrecomputedValue.injected(
+                RepositoryDelegatorFunction.VENDOR_DIRECTORY, Optional.empty())));
     SkyframeExecutorTestHelper.process(skyframeExecutor);
     return skyframeExecutor;
   }

diff --git a/src/test/java/com/google/devtools/build/lib/pkgcache/IncrementalLoadingTest.java b/src/test/java/com/google/devtools/build/lib/pkgcache/IncrementalLoadingTest.java
@@ -474,8 +474,9 @@ public DiffAwareness maybeCreate(Root pathEntry, ImmutableSet<Path> ignoredPaths
       skyframeExecutor.injectExtraPrecomputedValues(
           ImmutableList.of(
               PrecomputedValue.injected(
-                  RepositoryDelegatorFunction.RESOLVED_FILE_INSTEAD_OF_WORKSPACE,
-                  Optional.empty())));
+                  RepositoryDelegatorFunction.RESOLVED_FILE_INSTEAD_OF_WORKSPACE, Optional.empty()),
+              PrecomputedValue.injected(
+                  RepositoryDelegatorFunction.VENDOR_DIRECTORY, Optional.empty())));
       skyframeExecutor.preparePackageLoading(
           new PathPackageLocator(
               outputBase,

diff --git a/src/test/py/bazel/bzlmod/bazel_vendor_test.py b/src/test/py/bazel/bzlmod/bazel_vendor_test.py
@@ -671,6 +671,49 @@ def testVendorWithTargetPatternFile(self):
     self.assertIn('bbb~', os.listdir(self._test_cwd + '/vendor'))
     self.assertNotIn('ccc~', os.listdir(self._test_cwd + '/vendor'))
 
+  def testVendorDirIsIgnored(self):
+    self.main_registry.createCcModule('aaa', '1.0')
+    self.ScratchFile(
+        'MODULE.bazel',
+        ['bazel_dep(name = "aaa", version = "1.0")'],
+    )
+    self.ScratchFile(
+        'BUILD',
+        [
+            'cc_binary(',
+            '  name = "main",',
+            '  srcs = ["main.cc"],',
+            '  deps = [',
+            '    "@aaa//:lib_aaa",',
+            '  ],',
+            ')',
+        ],
+    )
+    self.ScratchFile(
+        'main.cc',
+        [
+            '#include "aaa.h"',
+            'int main() {',
+            '    hello_aaa("Hello there!");',
+            '}',
+        ],
+    )
+
+    self.RunBazel([
+        'vendor',
+        '//...',
+        '--vendor_dir=vendor',
+    ])
+    # Assert aaa is vendored
+    self.assertIn('aaa+', os.listdir(self._test_cwd + '/vendor'))
+
+    # bazel build //... should succeed because vendor dir is ignored.
+    self.RunBazel([
+        'build',
+        '//...',
+        '--vendor_dir=vendor',
+    ])
+
   def testBuildVendoredTargetOffline(self):
     self.main_registry.createCcModule('aaa', '1.0').createCcModule(
         'bbb', '1.0', {'aaa': '1.0'}