Do not follow symlinks by default when building repository index

Author: nikita-tkachenko-datadog

dd-java-agent/agent-ci-visibility/src/main/java/datadog/trace/civisibility/source/index/RepoIndexBuilder.java

@@ -104,6 +104,7 @@ private static final class RepoIndexingFileVisitor implements FileVisitor<Path>
     private final RepoIndexingStats indexingStats;
     private final Path repoRoot;
     private final AtomicInteger sourceRootCounter;
+    private final boolean followSymlinks;
 
     private RepoIndexingFileVisitor(
         Config config,
@@ -120,29 +121,17 @@ private RepoIndexingFileVisitor(
       packageTree = new PackageTree(config);
       indexingStats = new RepoIndexingStats();
       sourceRootCounter = new AtomicInteger();
+      followSymlinks = config.isCiVisibilityRepoIndexFollowSymlinks();
     }
 
     @Override
     public FileVisitResult preVisitDirectory(Path dir, BasicFileAttributes attrs) {
-      if (Files.isSymbolicLink(dir) && readSymbolicLink(dir).startsWith(repoRoot)) {
-        // The path is a symlink that points inside the repo.
-        // We'll visit the folder that it points to anyway,
-        // moreover, we don't want two different results for one file
-        // (one containing the symlink, the other - the actual folder).
+      if (Files.isSymbolicLink(dir) && !followSymlinks) {
         return FileVisitResult.SKIP_SUBTREE;
       }
       return FileVisitResult.CONTINUE;
     }
 
-    private static Path readSymbolicLink(Path path) {
-      try {
-        return Files.readSymbolicLink(path);
-      } catch (Exception e) {
-        log.debug("Could not read symbolic link {}", path, e);
-        return path;
-      }
-    }
-
     @Override
     public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) {
       indexingStats.filesVisited++;

dd-trace-api/src/main/java/datadog/trace/api/config/CiVisibilityConfig.java

@@ -44,6 +44,8 @@ public final class CiVisibilityConfig {
       "civisibility.ciprovider.integration.enabled";
   public static final String CIVISIBILITY_REPO_INDEX_DUPLICATE_KEY_CHECK_ENABLED =
       "civisibility.repo.index.duplicate.key.check.enabled";
+  public static final String CIVISIBILITY_REPO_INDEX_FOLLOW_SYMLINKS =
+      "civisibility.repo.index.follow.symlinks";
   public static final String CIVISIBILITY_EXECUTION_SETTINGS_CACHE_SIZE =
       "civisibility.execution.settings.cache.size";
   public static final String CIVISIBILITY_JVM_INFO_CACHE_SIZE = "civisibility.jvm.info.cache.size";

internal-api/src/main/java/datadog/trace/api/Config.java

@@ -254,6 +254,7 @@
 import static datadog.trace.api.config.CiVisibilityConfig.CIVISIBILITY_REMOTE_ENV_VARS_PROVIDER_KEY;
 import static datadog.trace.api.config.CiVisibilityConfig.CIVISIBILITY_REMOTE_ENV_VARS_PROVIDER_URL;
 import static datadog.trace.api.config.CiVisibilityConfig.CIVISIBILITY_REPO_INDEX_DUPLICATE_KEY_CHECK_ENABLED;
+import static datadog.trace.api.config.CiVisibilityConfig.CIVISIBILITY_REPO_INDEX_FOLLOW_SYMLINKS;
 import static datadog.trace.api.config.CiVisibilityConfig.CIVISIBILITY_RESOURCE_FOLDER_NAMES;
 import static datadog.trace.api.config.CiVisibilityConfig.CIVISIBILITY_RUM_FLUSH_WAIT_MILLIS;
 import static datadog.trace.api.config.CiVisibilityConfig.CIVISIBILITY_SCALATEST_FORK_MONITOR_ENABLED;
@@ -1001,6 +1002,7 @@ public static String getHostName() {
   private final boolean ciVisibilityTestSkippingEnabled;
   private final boolean ciVisibilityCiProviderIntegrationEnabled;
   private final boolean ciVisibilityRepoIndexDuplicateKeyCheckEnabled;
+  private final boolean ciVisibilityRepoIndexFollowSymlinks;
   private final int ciVisibilityExecutionSettingsCacheSize;
   private final int ciVisibilityJvmInfoCacheSize;
   private final int ciVisibilityCoverageRootPackagesLimit;
@@ -2261,6 +2263,8 @@ PROFILING_DATADOG_PROFILER_ENABLED, isDatadogProfilerSafeInCurrentEnvironment())
         configProvider.getBoolean(CIVISIBILITY_CIPROVIDER_INTEGRATION_ENABLED, true);
     ciVisibilityRepoIndexDuplicateKeyCheckEnabled =
         configProvider.getBoolean(CIVISIBILITY_REPO_INDEX_DUPLICATE_KEY_CHECK_ENABLED, true);
+    ciVisibilityRepoIndexFollowSymlinks =
+        configProvider.getBoolean(CIVISIBILITY_REPO_INDEX_FOLLOW_SYMLINKS, false);
     ciVisibilityExecutionSettingsCacheSize =
         configProvider.getInteger(CIVISIBILITY_EXECUTION_SETTINGS_CACHE_SIZE, 16);
     ciVisibilityJvmInfoCacheSize = configProvider.getInteger(CIVISIBILITY_JVM_INFO_CACHE_SIZE, 8);
@@ -3822,6 +3826,10 @@ public boolean isCiVisibilityRepoIndexDuplicateKeyCheckEnabled() {
     return ciVisibilityRepoIndexDuplicateKeyCheckEnabled;
   }
 
+  public boolean isCiVisibilityRepoIndexFollowSymlinks() {
+    return ciVisibilityRepoIndexFollowSymlinks;
+  }
+
   public int getCiVisibilityExecutionSettingsCacheSize() {
     return ciVisibilityExecutionSettingsCacheSize;
   }