refactor(paths-filter): use regex in paths filter, remove filtering mode, defer filtering of commits

Author: roeil

src/GitVersion.Core.Tests/VersionCalculation/PathFilterTests.cs

@@ -1,5 +1,4 @@
 using GitVersion.Core.Tests.Helpers;
-using GitVersion.Git;
 using GitVersion.VersionCalculation;
 
 namespace GitVersion.Core.Tests;
@@ -9,12 +8,4 @@ public class PathFilterTests : TestBase
 {
     [Test]
     public void VerifyNullGuard() => Should.Throw<ArgumentNullException>(() => new PathFilter(null!, null!, null!));
-
-    [Test]
-    public void VerifyNullGuard2()
-    {
-        var sut = new PathFilter(null!, null!, [""]);
-
-        Should.Throw<ArgumentNullException>(() => sut.Exclude((ICommit?)null, out _));
-    }
 }

src/GitVersion.Core/VersionCalculation/IncrementStrategyFinder.cs

@@ -58,14 +58,11 @@ public VersionField DetermineIncrementedField(
         var pathFilters = configuration.Ignore.ToFilters(repository, versionContext.Value).OfType<PathFilter>();
 
         var increments = commits
-            .Where(c => !pathFilters.Any(f => f.Exclude(c, out _)))
-            .Select(c => GetIncrementFromCommit(c, majorRegex, minorRegex, patchRegex, noBumpRegex))
-            .Where(v => v != null)
-            .ToList();
-
-        return increments.Count != 0
-            ? increments.Max()
-            : null;
+            .Select(c => (commit: c, increment: GetIncrementFromCommit(c, majorRegex, minorRegex, patchRegex, noBumpRegex)))
+            .Where(pair => pair.increment != null)
+            .OrderByDescending(pair => pair.increment);
+
+        return increments.FirstOrDefault(pair => !pathFilters.Any(f => f.Exclude(pair.commit, out _)), (null!, null)).increment;
     }
 
     private VersionField? FindCommitMessageIncrement(

src/GitVersion.Core/VersionCalculation/Mainline/MainlineContext.cs

@@ -4,11 +4,13 @@
 
 namespace GitVersion.VersionCalculation.Mainline;
 
-internal record MainlineContext(IIncrementStrategyFinder IncrementStrategyFinder, IGitVersionConfiguration Configuration)
+internal record MainlineContext(IIncrementStrategyFinder IncrementStrategyFinder, IGitVersionConfiguration Configuration, IGitRepository Repository, GitVersionContext GitverContext)
 {
     public IIncrementStrategyFinder IncrementStrategyFinder { get; } = IncrementStrategyFinder.NotNull();
 
     public IGitVersionConfiguration Configuration { get; } = Configuration.NotNull();
+    public IGitRepository Repository { get; } = Repository.NotNull();
+    public GitVersionContext GitverContext { get; } = GitverContext.NotNull();
 
     public string? TargetLabel { get; init; }
 

src/GitVersion.Core/VersionCalculation/Mainline/NonTrunk/MergeCommitOnNonTrunkBase.cs

@@ -18,7 +18,9 @@ public virtual IEnumerable<IBaseVersionIncrement> GetIncrements(
            iteration: commit.ChildIteration,
            targetLabel: context.TargetLabel,
            incrementStrategyFinder: context.IncrementStrategyFinder,
-           configuration: context.Configuration
+           configuration: context.Configuration,
+           repository: context.Repository,
+           gitverContext: context.GitverContext
        );
 
         context.Label ??= baseVersion.Operator?.Label;

src/GitVersion.Core/VersionCalculation/Mainline/Trunk/MergeCommitOnTrunkBase.cs

@@ -16,7 +16,9 @@ public virtual IEnumerable<IBaseVersionIncrement> GetIncrements(
            iteration: commit.ChildIteration!,
            targetLabel: context.TargetLabel,
            incrementStrategyFinder: context.IncrementStrategyFinder,
-           configuration: context.Configuration
+           configuration: context.Configuration,
+           repository: context.Repository,
+           gitverContext: context.GitverContext
        );
 
         context.Label ??= baseVersion.Operator?.Label;

src/GitVersion.Core/VersionCalculation/PathFilter.cs

@@ -1,14 +1,14 @@
+using System.Text.RegularExpressions;
 using GitVersion.Extensions;
 using GitVersion.Git;
 
 namespace GitVersion.VersionCalculation;
 
-internal class PathFilter(IGitRepository repository, GitVersionContext context, IEnumerable<string> paths, PathFilter.PathFilterMode mode = PathFilter.PathFilterMode.Inclusive) : IVersionFilter
+internal class PathFilter(IGitRepository repository, GitVersionContext context, IEnumerable<string> paths) : IVersionFilter
 {
     public enum PathFilterMode { Inclusive = 0, Exclusive = 1 }
 
     private readonly IEnumerable<string> paths = paths.NotNull();
-    private readonly PathFilterMode mode = mode;
     private readonly GitVersionContext context = context;
 
     public bool Exclude(IBaseVersion baseVersion, out string? reason)
@@ -31,22 +31,10 @@ public bool Exclude(ICommit? commit, out string? reason)
 
             if (patchPaths != null)
             {
-                switch (this.mode)
+                if (this.paths.Any(path => patchPaths.All(p => Regex.IsMatch(p, path, RegexOptions.IgnoreCase))))
                 {
-                    case PathFilterMode.Inclusive:
-                        if (!this.paths.Any(path => patchPaths.Any(p => p.StartsWith(path, StringComparison.OrdinalIgnoreCase))))
-                        {
-                            reason = "Source was ignored due to commit path is not present";
-                            return true;
-                        }
-                        break;
-                    case PathFilterMode.Exclusive:
-                        if (this.paths.Any(path => patchPaths.All(p => p.StartsWith(path, StringComparison.OrdinalIgnoreCase))))
-                        {
-                            reason = "Source was ignored due to commit path excluded";
-                            return true;
-                        }
-                        break;
+                    reason = "Source was ignored due to commit path matching ignore regex";
+                    return true;
                 }
             }
         }

src/GitVersion.Core/VersionCalculation/VersionCalculators/NextVersionCalculator.cs

@@ -156,10 +156,10 @@ private SemanticVersion CalculateSemanticVersion(
 
     private NextVersion CalculateNextVersion(IBranch branch, IGitVersionConfiguration configuration)
     {
-        var nextVersions = GetNextVersions(branch, configuration);
+        var nextVersions = GetNextVersions(branch, configuration).OrderByDescending(v => v.IncrementedVersion);
         log.Separator();
 
-        var maxVersion = nextVersions.Max()
+        var maxVersion = nextVersions.FirstOrDefault(v => ShouldIncludeVersion(configuration, v))
             ?? throw new GitVersionException("No base versions determined on the current branch.");
 
         ICommit? latestBaseVersionSource;
@@ -168,6 +168,7 @@ private NextVersion CalculateNextVersion(IBranch branch, IGitVersionConfiguratio
             .Where(
                 element => element.BaseVersion.BaseVersionSource != null
                     && element.IncrementedVersion == maxVersion.IncrementedVersion
+                    && ShouldIncludeVersion(configuration, element)
             ).ToArray();
         if (matchingVersionsOnceIncremented.Length > 1)
         {
@@ -193,11 +194,11 @@ private NextVersion CalculateNextVersion(IBranch branch, IGitVersionConfiguratio
                 .Where(v => v.BaseVersion.BaseVersionSource != null)
                 .OrderByDescending(v => v.IncrementedVersion)
                 .ThenByDescending(v => v.BaseVersion.BaseVersionSource?.When)
-                .FirstOrDefault();
+                .FirstOrDefault(v => ShouldIncludeVersion(configuration, v));
 
             version ??= versions.Where(v => v.BaseVersion.BaseVersionSource == null)
                 .OrderByDescending(v => v.IncrementedVersion)
-                .First();
+                .First(v => ShouldIncludeVersion(configuration, v));
             latestBaseVersionSource = version.BaseVersion.BaseVersionSource;
         }
 
@@ -217,6 +218,9 @@ private NextVersion CalculateNextVersion(IBranch branch, IGitVersionConfiguratio
         return new(maxVersion.IncrementedVersion, calculatedBase, maxVersion.BranchConfiguration);
     }
 
+    private bool ShouldIncludeVersion(IGitVersionConfiguration configuration, NextVersion version) =>
+        configuration.Ignore.ToFilters(repository, this.Context).All(filter => !filter.Exclude(version.BaseVersion, out _));
+
     private static NextVersion CompareVersions(NextVersion version1, NextVersion version2)
     {
         if (version1.BaseVersion.BaseVersionSource == null)
@@ -265,7 +269,8 @@ IEnumerable<NextVersion> GetNextVersionsInternal()
                             foreach (var baseVersion in versionStrategy.GetBaseVersions(effectiveBranchConfiguration))
                             {
                                 log.Info(baseVersion.ToString());
-                                if (IncludeVersion(baseVersion, configuration.Ignore))
+                                if (versionStrategy is not FallbackVersionStrategy || IncludeVersion(baseVersion, configuration.Ignore))
+                                //Defer the version inclusion check to the caller, for strategies other than FallbackVersionStrategy
                                 {
                                     atLeastOneBaseVersionReturned = true;
 

src/GitVersion.Core/VersionCalculation/VersionSearchStrategies/MainlineVersionStrategy.cs

@@ -11,6 +11,7 @@ namespace GitVersion.VersionCalculation;
 
 internal sealed class MainlineVersionStrategy(
     Lazy<GitVersionContext> contextLazy,
+    IGitRepository repository,
     IRepositoryStore repositoryStore,
     ITaggedSemanticVersionService taggedSemanticVersionService,
     IIncrementStrategyFinder incrementStrategyFinder)
@@ -19,6 +20,7 @@ internal sealed class MainlineVersionStrategy(
     private volatile int iterationCounter;
     private readonly Lazy<GitVersionContext> contextLazy = contextLazy.NotNull();
     private readonly ITaggedSemanticVersionService taggedSemanticVersionService = taggedSemanticVersionService.NotNull();
+    private readonly IGitRepository repository = repository.NotNull();
     private readonly IRepositoryStore repositoryStore = repositoryStore.NotNull();
     private readonly IIncrementStrategyFinder incrementStrategyFinder = incrementStrategyFinder.NotNull();
 
@@ -323,16 +325,16 @@ private bool IterateOverCommitsRecursive(
         return result;
     }
 
-    private static BaseVersion DetermineBaseVersion(MainlineIteration iteration, string? targetLabel,
+    private BaseVersion DetermineBaseVersion(MainlineIteration iteration, string? targetLabel,
             IIncrementStrategyFinder incrementStrategyFinder, IGitVersionConfiguration configuration)
-        => DetermineBaseVersionRecursive(iteration, targetLabel, incrementStrategyFinder, configuration);
+        => DetermineBaseVersionRecursive(iteration, targetLabel, incrementStrategyFinder, configuration, this.repository, this.Context);
 
     internal static BaseVersion DetermineBaseVersionRecursive(MainlineIteration iteration, string? targetLabel,
-        IIncrementStrategyFinder incrementStrategyFinder, IGitVersionConfiguration configuration)
+        IIncrementStrategyFinder incrementStrategyFinder, IGitVersionConfiguration configuration, IGitRepository repository, GitVersionContext gitverContext)
     {
         iteration.NotNull();
 
-        var incrementSteps = GetIncrements(iteration, targetLabel, incrementStrategyFinder, configuration).ToArray();
+        var incrementSteps = GetIncrements(iteration, targetLabel, incrementStrategyFinder, configuration, repository, gitverContext).ToArray();
 
         BaseVersion? result = null;
         foreach (var baseVersionIncrement in incrementSteps)
@@ -355,15 +357,20 @@ internal static BaseVersion DetermineBaseVersionRecursive(MainlineIteration iter
     }
 
     private static IEnumerable<IBaseVersionIncrement> GetIncrements(MainlineIteration iteration, string? targetLabel,
-        IIncrementStrategyFinder incrementStrategyFinder, IGitVersionConfiguration configuration)
+        IIncrementStrategyFinder incrementStrategyFinder, IGitVersionConfiguration configuration, IGitRepository repository, GitVersionContext gitverContext)
     {
-        MainlineContext context = new(incrementStrategyFinder, configuration)
+        MainlineContext context = new(incrementStrategyFinder, configuration, repository, gitverContext)
         {
             TargetLabel = targetLabel
         };
 
         foreach (var commit in iteration.Commits)
         {
+            if (configuration.Ignore.ToFilters(repository, gitverContext).OfType<PathFilter>().Any(f => f.Exclude(commit.Value, out _)))
+            {
+                continue;
+            }
+
             foreach (var item in TrunkContextPreEnricherCollection)
             {
                 item.Enrich(iteration, commit, context);