Refactor RedirectFile initialization and enhance IRepositoryTracker for improved redirect handling

- Simplified `RedirectFile` creation logic and constructor overloading.
- Changed `IRepositoryTracker` to return a `IReadOnlyCollection` for consistency.
- Enhanced path normalization across repository trackers.
- Adjusted dependent tests and updated related YAML documentation.

Author: Mpdreamz

docs/contribute/redirects.md

@@ -86,7 +86,7 @@ This example strips all anchors from the source page.
 Any remaining links resolving to anchors on `7th-page.md` will fail link validation.
 
 ```yaml
-redirects
+redirects:
   'testing/redirects/7th-page.md':
     to: 'testing/redirects/5th-page.md'
     anchors: '!'

src/Elastic.Documentation.Configuration/Builder/ConfigurationFile.cs

@@ -73,12 +73,10 @@ public ConfigurationFile(IDocumentationSetContext context, VersionsConfiguration
 			return;
 		}
 
-		var sourceFile = context.ConfigurationPath;
-		var redirectFileName = sourceFile.Name.StartsWith('_') ? "_redirects.yml" : "redirects.yml";
-		var redirectFileInfo = sourceFile.FileSystem.FileInfo.New(Path.Combine(sourceFile.Directory!.FullName, redirectFileName));
-		var redirectFile = new RedirectFile(redirectFileInfo, _context);
+		var redirectFile = new RedirectFile(_context);
 		Redirects = redirectFile.Redirects;
 
+		var sourceFile = context.ConfigurationPath;
 		var reader = new YamlStreamReader(sourceFile, _context.Collector);
 		try
 		{

src/Elastic.Documentation.Configuration/Builder/RedirectFile.cs

@@ -10,16 +10,19 @@ namespace Elastic.Documentation.Configuration.Builder;
 
 public record RedirectFile
 {
-	public Dictionary<string, LinkRedirect>? Redirects { get; set; }
-	private IFileInfo Source { get; init; }
-	private IDocumentationSetContext Context { get; init; }
+	public Dictionary<string, LinkRedirect>? Redirects { get; }
+	public IFileInfo Source { get; }
+	private IDocumentationSetContext Context { get; }
 
-	public RedirectFile(IFileInfo source, IDocumentationSetContext context)
+	public RedirectFile(IDocumentationSetContext context, IFileInfo? source = null)
 	{
-		Source = source;
+		var docsetConfigurationPath = context.ConfigurationPath;
+		var redirectFileName = docsetConfigurationPath.Name.StartsWith('_') ? "_redirects.yml" : "redirects.yml";
+		var redirectFileInfo = docsetConfigurationPath.FileSystem.FileInfo.New(Path.Combine(docsetConfigurationPath.Directory!.FullName, redirectFileName));
+		Source = source ?? redirectFileInfo;
 		Context = context;
 
-		if (!source.Exists)
+		if (!Source.Exists)
 			return;
 
 		var reader = new YamlStreamReader(Source, Context.Collector);

src/tooling/docs-builder/Cli/DiffCommands.cs

@@ -40,51 +40,55 @@ public async Task<int> ValidateRedirects(string? path = null, Cancel ctx = defau
 		var fs = new FileSystem();
 
 		var buildContext = new BuildContext(collector, fs, fs, configurationContext, ExportOptions.MetadataOnly, path, null);
-		var sourceFile = buildContext.ConfigurationPath;
-		var redirectFileName = sourceFile.Name.StartsWith('_') ? "_redirects.yml" : "redirects.yml";
-		var redirectFileInfo = sourceFile.FileSystem.FileInfo.New(Path.Combine(sourceFile.Directory!.FullName, redirectFileName));
-		if (!redirectFileInfo.Exists)
+		var redirectFile = new RedirectFile(buildContext);
+		if (!redirectFile.Source.Exists)
 		{
 			await collector.StopAsync(ctx);
 			return 0;
 		}
 
-		var redirectFileParser = new RedirectFile(redirectFileInfo, buildContext);
-		var redirects = redirectFileParser.Redirects;
+		var redirects = redirectFile.Redirects;
 
 		if (redirects is null)
 		{
-			collector.EmitError(redirectFileInfo, "It was not possible to parse the redirects file.");
+			collector.EmitError(redirectFile.Source, "It was not possible to parse the redirects file.");
 			await collector.StopAsync(ctx);
 			return collector.Errors;
 		}
 
 		var root = Paths.DetermineSourceDirectoryRoot(buildContext.DocumentationSourceDirectory);
 		if (root is null)
 		{
-			collector.EmitError(redirectFileInfo, $"Unable to determine the root of the source directory {buildContext.DocumentationSourceDirectory}.");
+			collector.EmitError(redirectFile.Source, $"Unable to determine the root of the source directory {buildContext.DocumentationSourceDirectory}.");
 			await collector.StopAsync(ctx);
 			return collector.Errors;
 		}
 		var relativePath = Path.GetRelativePath(root.FullName, buildContext.DocumentationSourceDirectory.FullName);
 		_log.LogInformation("Using relative path {RelativePath} for validating changes", relativePath);
 		IRepositoryTracker tracker = runningOnCi ? new IntegrationGitRepositoryTracker(relativePath) : new LocalGitRepositoryTracker(collector, root, relativePath);
-		var changed = tracker.GetChangedFiles().ToArray();
+		var changed = tracker.GetChangedFiles();
 
-		if (changed.Length != 0)
-			_log.LogInformation("Found {Count} changes to files related to documentation in the current branch.", changed.Length);
+		if (changed.Count != 0)
+			_log.LogInformation("Found {Count} changes to files related to documentation in the current branch.", changed.Count);
 
-		foreach (var notFound in changed.DistinctBy(c => c.FilePath).Where(c => c.ChangeType is GitChangeType.Deleted or GitChangeType.Renamed
-																	&& !redirects.ContainsKey(c is RenamedGitChange renamed ? renamed.OldFilePath : c.FilePath)))
+		var missingRedirects = changed
+			.DistinctBy(c => c.FilePath)
+			.Where(c =>
+				c.ChangeType is GitChangeType.Deleted or GitChangeType.Renamed
+				&& !redirects.ContainsKey(c is RenamedGitChange renamed ? renamed.OldFilePath : c.FilePath)
+			)
+			.ToArray();
+
+		foreach (var notFound in missingRedirects)
 		{
 			if (notFound is RenamedGitChange renamed)
 			{
-				collector.EmitError(redirectFileInfo.Name,
+				collector.EmitError(redirectFile.Source,
 					$"File '{renamed.OldFilePath}' was renamed to '{renamed.NewFilePath}' but it has no redirect configuration set.");
 			}
 			else if (notFound.ChangeType is GitChangeType.Deleted)
 			{
-				collector.EmitError(redirectFileInfo.Name,
+				collector.EmitError(redirectFile.Source,
 					$"File '{notFound.FilePath}' was deleted but it has no redirect targets. This will lead to broken links.");
 			}
 		}

src/tooling/docs-builder/Tracking/IRepositoryTracker.cs

@@ -19,5 +19,5 @@ public record RenamedGitChange(string OldFilePath, string NewFilePath, GitChange
 
 public interface IRepositoryTracker
 {
-	IEnumerable<GitChange> GetChangedFiles();
+	IReadOnlyCollection<GitChange> GetChangedFiles();
 }

src/tooling/docs-builder/Tracking/IntegrationGitRepositoryTracker.cs

@@ -7,38 +7,44 @@ namespace Documentation.Builder.Tracking;
 public class IntegrationGitRepositoryTracker(string lookupPath) : IRepositoryTracker
 {
 	private string LookupPath { get; } = $"{lookupPath.Trim(['/', '\\'])}/";
-	public IEnumerable<GitChange> GetChangedFiles()
+	public IReadOnlyCollection<GitChange> GetChangedFiles()
 	{
-		var deletedFiles = Environment.GetEnvironmentVariable("DELETED_FILES") ?? string.Empty;
-		if (!string.IsNullOrEmpty(deletedFiles))
-		{
-			foreach (var file in deletedFiles.Split(' ', StringSplitOptions.RemoveEmptyEntries).Where(f => f.StartsWith(LookupPath)))
-				yield return new GitChange(file, GitChangeType.Deleted);
-		}
+		return GetChanges().ToArray();
 
-		var addedFiles = Environment.GetEnvironmentVariable("ADDED_FILES");
-		if (!string.IsNullOrEmpty(addedFiles))
+		IEnumerable<GitChange> GetChanges()
 		{
-			foreach (var file in addedFiles.Split(' ', StringSplitOptions.RemoveEmptyEntries).Where(f => f.StartsWith(LookupPath)))
-				yield return new GitChange(file, GitChangeType.Added);
-		}
+			var deletedFiles = Environment.GetEnvironmentVariable("DELETED_FILES") ?? string.Empty;
+			if (!string.IsNullOrEmpty(deletedFiles))
+			{
+				foreach (var file in deletedFiles.Split(' ', StringSplitOptions.RemoveEmptyEntries).Where(f => f.StartsWith(LookupPath)))
+					yield return new GitChange(file, GitChangeType.Deleted);
+			}
 
-		var modifiedFiles = Environment.GetEnvironmentVariable("MODIFIED_FILES");
-		if (!string.IsNullOrEmpty(modifiedFiles))
-		{
-			foreach (var file in modifiedFiles.Split(' ', StringSplitOptions.RemoveEmptyEntries).Where(f => f.StartsWith(LookupPath)))
-				yield return new GitChange(file, GitChangeType.Modified);
-		}
+			var addedFiles = Environment.GetEnvironmentVariable("ADDED_FILES");
+			if (!string.IsNullOrEmpty(addedFiles))
+			{
+				foreach (var file in addedFiles.Split(' ', StringSplitOptions.RemoveEmptyEntries).Where(f => f.StartsWith(LookupPath)))
+					yield return new GitChange(file, GitChangeType.Added);
+			}
 
-		var renamedFiles = Environment.GetEnvironmentVariable("RENAMED_FILES");
-		if (!string.IsNullOrEmpty(renamedFiles))
-		{
-			foreach (var pair in renamedFiles.Split(' ', StringSplitOptions.RemoveEmptyEntries).Where(f => f.StartsWith(LookupPath)))
+			var modifiedFiles = Environment.GetEnvironmentVariable("MODIFIED_FILES");
+			if (!string.IsNullOrEmpty(modifiedFiles))
 			{
-				var parts = pair.Split(':');
-				if (parts.Length == 2)
-					yield return new RenamedGitChange(parts[0], parts[1], GitChangeType.Renamed);
+				foreach (var file in modifiedFiles.Split(' ', StringSplitOptions.RemoveEmptyEntries).Where(f => f.StartsWith(LookupPath)))
+					yield return new GitChange(file, GitChangeType.Modified);
 			}
+
+			var renamedFiles = Environment.GetEnvironmentVariable("RENAMED_FILES");
+			if (!string.IsNullOrEmpty(renamedFiles))
+			{
+				foreach (var pair in renamedFiles.Split(' ', StringSplitOptions.RemoveEmptyEntries).Where(f => f.StartsWith(LookupPath)))
+				{
+					var parts = pair.Split(':');
+					if (parts.Length == 2)
+						yield return new RenamedGitChange(parts[0], parts[1], GitChangeType.Renamed);
+				}
+			}
+
 		}
 	}
 }

src/tooling/docs-builder/Tracking/LocalGitRepositoryTracker.cs

@@ -10,16 +10,16 @@ namespace Documentation.Builder.Tracking;
 
 public class LocalGitRepositoryTracker(DiagnosticsCollector collector, IDirectoryInfo workingDirectory, string lookupPath) : ExternalCommandExecutor(collector, workingDirectory), IRepositoryTracker
 {
-	private string LookupPath { get; } = lookupPath;
+	private string LookupPath { get; } = lookupPath.Trim('\\', '/');
 
-	public IEnumerable<GitChange> GetChangedFiles()
+	public IReadOnlyCollection<GitChange> GetChangedFiles()
 	{
 		var defaultBranch = GetDefaultBranch();
 		var commitChanges = CaptureMultiple("git", "diff", "--name-status", $"{defaultBranch}...HEAD", "--", $"./{LookupPath}");
 		var localChanges = CaptureMultiple("git", "status", "--porcelain");
-		var captured = Capture("git", "stash", "push", "--", $"./{LookupPath}");
+		var gitStashDocsFolder = Capture("git", "stash", "push", "--", $"./{LookupPath}");
 		var localUnstagedChanges = Array.Empty<string>();
-		if (captured != "No local changes to save")
+		if (gitStashDocsFolder != "No local changes to save")
 		{
 			localUnstagedChanges = CaptureMultiple("git", "stash", "show", "--name-status", "-u");
 			ExecInSilent([], "git", "stash", "pop");

tests/authoring/Framework/CrossLinkResolverAssertions.fs

@@ -35,7 +35,7 @@ module CrossLinkResolverAssertions =
                 member _.ConfigurationPath = mockFileSystem.FileInfo.New("mock_docset.yml")
                 member _.OutputDirectory = mockFileSystem.DirectoryInfo.New(".artifacts")
             }
-        let redirectFileParser = RedirectFile(mockRedirectsFile, docContext)
+        let redirectFileParser = RedirectFile(docContext, mockRedirectsFile)
         redirectFileParser.Redirects
 
     let private createFetchedCrossLinks (redirectsYamlSnippet: string) (linksData: IDictionary<string, LinkMetadata>) repoName =