Refactor loading Product and LegacyUrlMapping data

Author: cotti

src/Elastic.Documentation.Configuration/BuildContext.cs

@@ -6,6 +6,8 @@
 using System.Reflection;
 using Elastic.Documentation.Configuration.Assembler;
 using Elastic.Documentation.Configuration.Builder;
+using Elastic.Documentation.Configuration.LegacyUrlMappings;
+using Elastic.Documentation.Configuration.Products;
 using Elastic.Documentation.Configuration.Versions;
 using Elastic.Documentation.Diagnostics;
 
@@ -30,6 +32,9 @@ public record BuildContext : IDocumentationSetContext, IDocumentationConfigurati
 	public ConfigurationFileProvider ConfigurationFileProvider { get; }
 	public DocumentationEndpoints Endpoints { get; }
 
+	public ProductsConfiguration ProductsConfiguration { get; }
+	public LegacyUrlMappingConfiguration LegacyUrlMappings { get; }
+
 	public IFileInfo ConfigurationPath { get; }
 
 	public GitCheckoutInformation Git { get; }
@@ -82,6 +87,8 @@ public BuildContext(
 		AvailableExporters = availableExporters;
 		VersionsConfiguration = configurationContext.VersionsConfiguration;
 		ConfigurationFileProvider = configurationContext.ConfigurationFileProvider;
+		ProductsConfiguration = configurationContext.ProductsConfiguration;
+		LegacyUrlMappings = configurationContext.LegacyUrlMappings;
 		Endpoints = configurationContext.Endpoints;
 
 		var rootFolder = !string.IsNullOrWhiteSpace(source)
@@ -100,7 +107,7 @@ public BuildContext(
 			DocumentationSourceDirectory = ConfigurationPath.Directory!;
 
 		Git = gitCheckoutInformation ?? GitCheckoutInformation.Create(DocumentationCheckoutDirectory, ReadFileSystem);
-		Configuration = new ConfigurationFile(this, VersionsConfiguration);
+		Configuration = new ConfigurationFile(this, VersionsConfiguration, ProductsConfiguration);
 		GoogleTagManager = new GoogleTagManagerConfiguration
 		{
 			Enabled = false

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

@@ -63,7 +63,7 @@ public record ConfigurationFile : ITableOfContentsScope
 		Project is not null
 		&& Project.Equals("Elastic documentation", StringComparison.OrdinalIgnoreCase);
 
-	public ConfigurationFile(IDocumentationSetContext context, VersionsConfiguration versionsConfig)
+	public ConfigurationFile(IDocumentationSetContext context, VersionsConfiguration versionsConfig, ProductsConfiguration productsConfig)
 	{
 		_context = context;
 		ScopeDirectory = context.ConfigurationPath.Directory!;
@@ -149,10 +149,10 @@ public ConfigurationFile(IDocumentationSetContext context, VersionsConfiguration
 								break;
 							}
 
-							if (!Product.AllById(versionsConfig).ContainsKey(productId.Value))
-								reader.EmitError($"Product \"{productId.Value}\" not found in the product list. {new Suggestion(Product.All(versionsConfig).Select(p => p.Id).ToHashSet(), productId.Value).GetSuggestionQuestion()}", node);
+							if (!productsConfig.Products.TryGetValue(productId.Value, out var productToAdd))
+								reader.EmitError($"Product \"{productId.Value}\" not found in the product list. {new Suggestion(productsConfig.Products.Select(p => p.Value.Id).ToHashSet(), productId.Value).GetSuggestionQuestion()}", node);
 							else
-								_ = Products.Add(versionsConfig.Products[productId.Value]);
+								_ = Products.Add(productToAdd);
 						}
 						break;
 					case "features":
@@ -177,10 +177,10 @@ public ConfigurationFile(IDocumentationSetContext context, VersionsConfiguration
 				_substitutions[key] = system.Base;
 			}
 
-			foreach (var (id, product) in versionsConfig.Products)
+			foreach (var product in productsConfig.Products.Values)
 			{
-				_substitutions[$"product.{id}"] = product.DisplayName;
-				_substitutions[$".{id}"] = product.DisplayName;
+				_substitutions[$"product.{product.Id}"] = product.DisplayName;
+				_substitutions[$".{product.Id}"] = product.DisplayName;
 			}
 
 			var toc = new TableOfContentsConfiguration(this, sourceFile, ScopeDirectory, _context, 0, "");

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

@@ -5,8 +5,11 @@
 using System.IO.Abstractions;
 using System.Text.RegularExpressions;
 using Elastic.Documentation.Configuration.Assembler;
+using Elastic.Documentation.Configuration.Serialization;
 using Microsoft.Extensions.DependencyInjection;
 using NetEscapades.EnumGenerators;
+using YamlDotNet.Serialization;
+using YamlDotNet.Serialization.NamingConventions;
 
 namespace Elastic.Documentation.Configuration;
 
@@ -23,6 +26,10 @@ public partial class ConfigurationFileProvider
 	private readonly IFileSystem _fileSystem;
 	private readonly string _assemblyName;
 
+	internal IDeserializer Deserializer { get; } = new StaticDeserializerBuilder(new YamlStaticContext())
+		.WithNamingConvention(UnderscoredNamingConvention.Instance)
+		.Build();
+
 	public ConfigurationSource ConfigurationSource { get; private set; } = ConfigurationSource.Embedded;
 	public string? GitReference { get; }
 

src/Elastic.Documentation.Configuration/ConfigurationFileProvider.cs

@@ -2,7 +2,9 @@
 // Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
 // See the LICENSE file in the project root for more information
 
+using Elastic.Documentation.Configuration.Products;
 using Elastic.Documentation.Configuration.Versions;
+using Elastic.Documentation.Configuration.LegacyUrlMappings;
 
 namespace Elastic.Documentation.Configuration;
 
@@ -11,6 +13,8 @@ public interface IConfigurationContext
 	VersionsConfiguration VersionsConfiguration { get; }
 	ConfigurationFileProvider ConfigurationFileProvider { get; }
 	DocumentationEndpoints Endpoints { get; }
+	ProductsConfiguration ProductsConfiguration { get; }
+	LegacyUrlMappingConfiguration LegacyUrlMappings { get; }
 }
 
 /// Used only to seed <see cref="IConfigurationContext"/> in DI, you primarily want to depend on <see cref="IDocumentationConfigurationContext"/>
@@ -24,6 +28,13 @@ public class ConfigurationContext : IConfigurationContext
 
 	/// <inheritdoc />
 	public required DocumentationEndpoints Endpoints { get; init; }
+
+	/// <inheritdoc />
+	public required ProductsConfiguration ProductsConfiguration { get; init; }
+
+	/// <inheritdoc />
+	public required LegacyUrlMappingConfiguration LegacyUrlMappings { get; init; }
+
 }
 
 public interface IDocumentationConfigurationContext : IDocumentationContext, IConfigurationContext;

src/Elastic.Documentation.Configuration/IDocumentationConfigurationContext.cs

@@ -0,0 +1,33 @@
+// Licensed to Elasticsearch B.V under one or more agreements.
+// Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
+// See the LICENSE file in the project root for more information
+
+using Elastic.Documentation.Configuration.Products;
+
+namespace Elastic.Documentation.Configuration.LegacyUrlMappings;
+
+public record LegacyUrlMappingConfiguration
+{
+	public required IReadOnlyCollection<LegacyUrlMapping> Mappings { get; init; }
+}
+public record LegacyUrlMapping
+{
+	public required string BaseUrl { get; init; }
+	public required Product Product { get; init; }
+	public required IReadOnlyCollection<string> LegacyVersions { get; init; }
+}
+
+public record LegacyPageMapping(Product Product, string RawUrl, string Version, bool Exists)
+{
+	public override string ToString() => RawUrl.Replace("/current/", $"/{Version}/");
+}
+
+public interface ILegacyUrlMapper
+{
+	IReadOnlyCollection<LegacyPageMapping>? MapLegacyUrl(IReadOnlyCollection<string>? mappedPages);
+}
+
+public record NoopLegacyUrlMapper : ILegacyUrlMapper
+{
+	public IReadOnlyCollection<LegacyPageMapping> MapLegacyUrl(IReadOnlyCollection<string>? mappedPages) => [];
+}

src/Elastic.Documentation.Configuration/LegacyUrlMappings/LegacyUrlMapping.cs

@@ -0,0 +1,42 @@
+// Licensed to Elasticsearch B.V under one or more agreements.
+// Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
+// See the LICENSE file in the project root for more information
+
+using System.Collections.Immutable;
+using Elastic.Documentation.Configuration.Products;
+
+namespace Elastic.Documentation.Configuration.LegacyUrlMappings;
+
+public static class LegacyUrlMappingExtensions
+{
+	public static LegacyUrlMappingConfiguration CreateLegacyUrlMappings(this ConfigurationFileProvider provider, ProductsConfiguration products)
+	{
+		var legacyUrlMappingsFilePath = provider.LegacyUrlMappingsFile;
+
+		var legacyUrlMappingsDto = provider.Deserializer.Deserialize<LegacyUrlMappingConfigDto>(legacyUrlMappingsFilePath.OpenText());
+
+		var legacyUrlMappings = legacyUrlMappingsDto.Mappings.Select(kvp =>
+			new LegacyUrlMapping
+			{
+				BaseUrl = kvp.Key,
+				Product = products.Products[kvp.Value.Product],
+				LegacyVersions = kvp.Value.LegacyVersions.ToImmutableList()
+			});
+
+		return new LegacyUrlMappingConfiguration { Mappings = legacyUrlMappings.ToImmutableList() };
+	}
+}
+
+// Private DTOs for deserialization. These match the YAML structure directly.
+
+internal sealed record LegacyUrlMappingConfigDto
+{
+	public IEnumerable<string> Stack { get; set; } = [];
+	public Dictionary<string, LegacyUrlMappingDto> Mappings { get; set; } = [];
+}
+
+internal sealed record LegacyUrlMappingDto
+{
+	public string Product { get; set; } = string.Empty;
+	public IEnumerable<string> LegacyVersions { get; set; } = [];
+}

src/Elastic.Documentation.Configuration/LegacyUrlMappings/LegacyUrlMappingExtensions.cs

@@ -2,20 +2,23 @@
 // Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
 // See the LICENSE file in the project root for more information
 
+using System.Collections.Frozen;
 using Elastic.Documentation.Configuration.Versions;
 using YamlDotNet.Serialization;
 
 namespace Elastic.Documentation.Configuration.Products;
 
+public record ProductsConfiguration
+{
+	public required FrozenDictionary<string, Product> Products { get; init; }
+}
+
 [YamlSerializable]
 public record Product
 {
 	public required string Id { get; init; }
 	public required string DisplayName { get; init; }
-	public VersioningSystemId? VersionSystem { get; init; }
-
-	public static IReadOnlyCollection<Product> All(VersionsConfiguration versions) => [.. versions.Products.Values];
-	public static IReadOnlyDictionary<string, Product> AllById(VersionsConfiguration versions) => versions.Products;
+	public VersioningSystem? VersioningSystem { get; init; }
 }
 
 public sealed class ProductEqualityComparer : IEqualityComparer<Product>, IComparer<Product>
@@ -35,6 +38,6 @@ public int Compare(Product? x, Product? y)
 		if (idComparison != 0)
 			return idComparison;
 		var displayNameComparison = string.Compare(x.DisplayName, y.DisplayName, StringComparison.OrdinalIgnoreCase);
-		return displayNameComparison != 0 ? displayNameComparison : Nullable.Compare(x.VersionSystem, y.VersionSystem);
+		return displayNameComparison != 0 ? displayNameComparison : x.VersioningSystem?.Current.CompareTo(y.VersioningSystem?.Current) ?? 0;
 	}
 }

src/Elastic.Documentation.Configuration/Products/Product.cs

@@ -0,0 +1,44 @@
+// Licensed to Elasticsearch B.V under one or more agreements.
+// Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
+// See the LICENSE file in the project root for more information
+
+using System.Collections.Frozen;
+using Elastic.Documentation.Configuration.Versions;
+
+namespace Elastic.Documentation.Configuration.Products;
+
+public static class ProductExtensions
+{
+	public static ProductsConfiguration CreateProducts(this ConfigurationFileProvider provider, VersionsConfiguration versionsConfiguration)
+	{
+		var productsFilePath = provider.ProductsFile;
+
+		var productsDto = provider.Deserializer.Deserialize<ProductConfigDto>(productsFilePath.OpenText());
+
+		var products = productsDto.Products.ToDictionary(
+			kvp => kvp.Key,
+			kvp => new Product
+			{
+				Id = kvp.Key,
+				DisplayName = kvp.Value.Display,
+				VersioningSystem = versionsConfiguration.GetVersioningSystem(VersionsConfigurationExtensions.ToVersioningSystemId(kvp.Value.Versioning))
+			});
+
+		return new ProductsConfiguration
+		{
+			Products = products.ToFrozenDictionary()
+		};
+	}
+}
+
+// Private DTOs for deserialization. These match the YAML structure directly.
+
+internal sealed record ProductConfigDto
+{
+	public Dictionary<string, ProductDto> Products { get; set; } = [];
+}
+internal sealed record ProductDto
+{
+	public string Display { get; set; } = string.Empty;
+	public string Versioning { get; set; } = string.Empty;
+}

src/Elastic.Documentation.Configuration/Products/ProductExtensions.cs

@@ -3,6 +3,8 @@
 // See the LICENSE file in the project root for more information
 
 using Elastic.Documentation.Configuration.Assembler;
+using Elastic.Documentation.Configuration.LegacyUrlMappings;
+using Elastic.Documentation.Configuration.Products;
 using Elastic.Documentation.Configuration.Versions;
 using YamlDotNet.Serialization;
 
@@ -19,4 +21,6 @@ namespace Elastic.Documentation.Configuration.Serialization;
 [YamlSerializable(typeof(ProductConfigDto))]
 [YamlSerializable(typeof(VersioningSystemDto))]
 [YamlSerializable(typeof(ProductDto))]
+[YamlSerializable(typeof(LegacyUrlMappingDto))]
+[YamlSerializable(typeof(LegacyUrlMappingConfigDto))]
 public partial class YamlStaticContext;