Fix area name comma-split bug in changelog label mapping (#2935)

Author: lcawl

config/changelog.example.yml

@@ -104,14 +104,22 @@ pivot:
   #   - ">release-highlight"
 
   # Area definitions with labels
-  # Keys are area display names, values are label strings or lists
+  # Keys are area display names (can contain commas), values are label strings or lists
+  # Each label maps to exactly one area.
   # String form: "label1, label2" | List form: [label1, label2]
+  # To map one label to multiple areas, repeat the label under each area name.
   areas:
     # Example mappings - customize based on your label naming conventions
     # Autoscaling: ":Distributed Coordination/Autoscaling"
     # Search: ":Search/Search"
     # Security: ":Security/Security"
     # Watcher: ":Data Management/Watcher"
+    # To map a label to multiple areas (e.g., "Team:Search" to both "Search" and "Observability"):
+    # Search:
+    #   - ":Search/Search"
+    #   - "Team:Search"
+    # Observability:
+    #   - "Team:Search"
     # List form example:
     # Search:
     #   - ":Search/Search"

src/Elastic.Documentation.Configuration/Changelog/ChangelogConfiguration.cs

@@ -85,9 +85,9 @@ public record ChangelogConfiguration
 
 	/// <summary>
 	/// Mapping from GitHub label names to changelog area values (computed from Pivot.Areas)
-	/// Multiple labels can map to the same area, and a single label can map to multiple areas (comma-separated)
+	/// Multiple labels can map to the same area. To map one label to multiple areas, repeat the label under each area in pivot.areas.
 	/// </summary>
-	public IReadOnlyDictionary<string, string>? LabelToAreas { get; init; }
+	public IReadOnlyDictionary<string, IReadOnlyList<string>>? LabelToAreas { get; init; }
 
 	/// <summary>
 	/// Mapping from GitHub label names to product spec strings (computed from Pivot.Products).

src/services/Elastic.Changelog/Configuration/ChangelogConfigurationLoader.cs

@@ -115,7 +115,7 @@ internal static ChangelogConfigurationYaml DeserializeConfiguration(string yaml)
 		IReadOnlyList<string> availableSubtypes;
 		IReadOnlyList<string>? availableAreas;
 		Dictionary<string, string>? labelToType;
-		Dictionary<string, string>? labelToAreas;
+		Dictionary<string, List<string>>? labelToAreas;
 		Dictionary<string, string>? labelToProducts;
 		PivotConfiguration? pivot = null;
 
@@ -309,6 +309,11 @@ internal static ChangelogConfigurationYaml DeserializeConfiguration(string yaml)
 			filenameStrategy = parsed;
 		}
 
+		var labelToAreasReadOnly = labelToAreas?.ToDictionary(
+			kvp => kvp.Key,
+			kvp => (IReadOnlyList<string>)kvp.Value,
+			StringComparer.OrdinalIgnoreCase);
+
 		return new ChangelogConfiguration
 		{
 			Pivot = pivot,
@@ -318,7 +323,7 @@ internal static ChangelogConfigurationYaml DeserializeConfiguration(string yaml)
 			Areas = availableAreas,
 			Products = products,
 			LabelToType = labelToType,
-			LabelToAreas = labelToAreas,
+			LabelToAreas = labelToAreasReadOnly,
 			LabelToProducts = labelToProducts,
 			Rules = rules,
 			HighlightLabels = highlightLabels,
@@ -1010,22 +1015,31 @@ private static BundleConfiguration ParseBundleConfiguration(BundleConfigurationY
 
 	/// <summary>
 	/// Builds LabelToAreas mapping by inverting pivot.areas entries.
-	/// Each label in an area entry maps to that area name.
+	/// Each label in an area entry maps to that area name. The same label may appear under multiple areas; all area names are collected.
 	/// </summary>
-	private static Dictionary<string, string>? BuildLabelToAreasMapping(Dictionary<string, YamlLenientList?>? areas)
+	private static Dictionary<string, List<string>>? BuildLabelToAreasMapping(Dictionary<string, YamlLenientList?>? areas)
 	{
 		if (areas == null || areas.Count == 0)
 			return null;
 
-		var labelToAreas = new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase);
+		var labelToAreas = new Dictionary<string, List<string>>(StringComparer.OrdinalIgnoreCase);
 
 		foreach (var (areaName, labelList) in areas)
 		{
 			if (labelList?.Values == null)
 				continue;
 
 			foreach (var label in labelList.Values)
-				labelToAreas[label] = areaName;
+			{
+				if (!labelToAreas.TryGetValue(label, out var areaNames))
+				{
+					areaNames = [];
+					labelToAreas[label] = areaNames;
+				}
+
+				if (!areaNames.Exists(a => a.Equals(areaName, StringComparison.OrdinalIgnoreCase)))
+					areaNames.Add(areaName);
+			}
 		}
 
 		return labelToAreas.Count > 0 ? labelToAreas : null;

src/services/Elastic.Changelog/Creation/PrInfoProcessor.cs

@@ -386,15 +386,17 @@ internal static bool IsBlockedByRules(string[] prLabels, CreateRules rules)
 		.Select(label => labelToTypeMapping.TryGetValue(label, out var mappedType) ? mappedType : null)
 		.FirstOrDefault(mappedType => mappedType != null);
 
-	internal static List<string> MapLabelsToAreas(string[] labels, IReadOnlyDictionary<string, string> labelToAreasMapping)
+	internal static List<string> MapLabelsToAreas(string[] labels, IReadOnlyDictionary<string, IReadOnlyList<string>> labelToAreasMapping)
 	{
 		var areas = new HashSet<string>();
-		var areaList = labels
-			.Where(label => labelToAreasMapping.ContainsKey(label))
-			.SelectMany(label => labelToAreasMapping[label]
-				.Split(',', StringSplitOptions.RemoveEmptyEntries | StringSplitOptions.TrimEntries));
-		foreach (var area in areaList)
-			_ = areas.Add(area);
+		foreach (var label in labels)
+		{
+			if (!labelToAreasMapping.TryGetValue(label, out var mappedAreas))
+				continue;
+
+			foreach (var area in mappedAreas)
+				_ = areas.Add(area);
+		}
 		return areas.ToList();
 	}
 

src/services/Elastic.Changelog/GithubRelease/GitHubReleaseChangelogService.cs

@@ -346,15 +346,17 @@ private static string GenerateYaml(ChangelogEntry data) =>
 			.Select(label => labelToTypeMapping.TryGetValue(label, out var mappedType) ? mappedType : null)
 			.FirstOrDefault(mappedType => mappedType != null);
 
-	private static List<string> MapLabelsToAreas(string[] labels, IReadOnlyDictionary<string, string> labelToAreasMapping)
+	private static List<string> MapLabelsToAreas(string[] labels, IReadOnlyDictionary<string, IReadOnlyList<string>> labelToAreasMapping)
 	{
 		var areas = new HashSet<string>();
-		var areaList = labels
-			.Where(label => labelToAreasMapping.ContainsKey(label))
-			.SelectMany(label => labelToAreasMapping[label]
-				.Split(',', StringSplitOptions.RemoveEmptyEntries | StringSplitOptions.TrimEntries));
-		foreach (var area in areaList)
-			_ = areas.Add(area);
+		foreach (var label in labels)
+		{
+			if (!labelToAreasMapping.TryGetValue(label, out var mappedAreas))
+				continue;
+
+			foreach (var area in mappedAreas)
+				_ = areas.Add(area);
+		}
 		return areas.ToList();
 	}
 

tests/Elastic.Changelog.Tests/Changelogs/ChangelogConfigurationTests.cs

@@ -191,9 +191,9 @@ public async Task LoadChangelogConfiguration_WithPivotAreas_ComputesLabelToAreas
 			// Should have inverted label mappings
 			config.LabelToAreas.Should().NotBeNull();
 			config.LabelToAreas.Should().ContainKey(":Search/Search");
-			config.LabelToAreas[":Search/Search"].Should().Be("Search");
+			config.LabelToAreas[":Search/Search"].Should().ContainSingle().Which.Should().Be("Search");
 			config.LabelToAreas.Should().ContainKey(":Security/Security");
-			config.LabelToAreas[":Security/Security"].Should().Be("Security");
+			config.LabelToAreas[":Security/Security"].Should().ContainSingle().Which.Should().Be("Security");
 		}
 		finally
 		{
@@ -695,12 +695,12 @@ public async Task LoadChangelogConfiguration_PivotAreas_AsListValues_ComputesMap
 		// Both labels from the list should map to "Search"
 		config.LabelToAreas.Should().NotBeNull();
 		config.LabelToAreas.Should().ContainKey(":Search/Search");
-		config.LabelToAreas[":Search/Search"].Should().Be("Search");
+		config.LabelToAreas[":Search/Search"].Should().ContainSingle().Which.Should().Be("Search");
 		config.LabelToAreas.Should().ContainKey(":Search/Ranking");
-		config.LabelToAreas[":Search/Ranking"].Should().Be("Search");
+		config.LabelToAreas[":Search/Ranking"].Should().ContainSingle().Which.Should().Be("Search");
 		// String form should still work
 		config.LabelToAreas.Should().ContainKey(":Security/Security");
-		config.LabelToAreas[":Security/Security"].Should().Be("Security");
+		config.LabelToAreas[":Security/Security"].Should().ContainSingle().Which.Should().Be("Security");
 	}
 
 	[Fact]
@@ -860,11 +860,11 @@ public async Task LoadChangelogConfiguration_MixedStringAndListForms_ParsesCorre
 
 		// Areas: string for Search, list for Security
 		config.LabelToAreas.Should().ContainKey(":Search/Search");
-		config.LabelToAreas[":Search/Search"].Should().Be("Search");
+		config.LabelToAreas[":Search/Search"].Should().ContainSingle().Which.Should().Be("Search");
 		config.LabelToAreas.Should().ContainKey(":Security/Security");
-		config.LabelToAreas[":Security/Security"].Should().Be("Security");
+		config.LabelToAreas[":Security/Security"].Should().ContainSingle().Which.Should().Be("Security");
 		config.LabelToAreas.Should().ContainKey(":Security/Auth");
-		config.LabelToAreas[":Security/Auth"].Should().Be("Security");
+		config.LabelToAreas[":Security/Auth"].Should().ContainSingle().Which.Should().Be("Security");
 	}
 
 	/// <summary>

tests/Elastic.Changelog.Tests/Changelogs/Create/LabelMappingTests.cs

@@ -432,4 +432,154 @@ public async Task CreateChangelog_WithPrOptionAndAreaMapping_MapsLabelsToAreas()
 		yamlContent.Should().Contain("- security");
 		yamlContent.Should().Contain("- search");
 	}
+
+	[Fact]
+	public void MapLabelsToAreas_WithAreaNameContainingCommas_PresservesFullName()
+	{
+		// Arrange
+		var labelToAreas = new Dictionary<string, IReadOnlyList<string>>(StringComparer.OrdinalIgnoreCase)
+		{
+			["Team:Alerting Services"] = ["Alerting, connectors, and reporting"],
+			["Team:Search"] = ["Search"]
+		};
+
+		// Act
+		var result = PrInfoProcessor.MapLabelsToAreas(
+			["Team:Alerting Services", "Team:Search"],
+			labelToAreas
+		);
+
+		// Assert
+		result.Should().HaveCount(2);
+		result.Should().Contain("Alerting, connectors, and reporting");  // Not split
+		result.Should().Contain("Search");
+	}
+
+	[Fact]
+	public async Task CreateChangelog_WithAreaNameContainingCommas_PreservesAreaName()
+	{
+		// Arrange: Area name contains commas
+		var prInfo = new GitHubPrInfo
+		{
+			Title = "Fix alerting issues",
+			Labels = ["type:bug", "Team:Alerting Services"]
+		};
+
+		A.CallTo(() => MockGitHubService.FetchPrInfoAsync(
+				A<string>._,
+				A<string?>._,
+				A<string?>._,
+				A<CancellationToken>._))
+			.Returns(prInfo);
+
+		// language=yaml
+		var configContent =
+			"""
+			pivot:
+			  types:
+			    bug-fix: "type:bug"
+			    feature:
+			    breaking-change:
+			  areas:
+			    "Alerting, connectors, and reporting":
+			      - "Team:Alerting Services"
+			lifecycles:
+			  - preview
+			  - beta
+			  - ga
+			""";
+		var configPath = await CreateConfigDirectory(configContent);
+
+		var service = CreateService();
+
+		var input = new CreateChangelogArguments
+		{
+			Prs = ["https://github.com/elastic/elasticsearch/pull/12345"],
+			Products = [new ProductArgument { Product = "elasticsearch", Target = "9.2.0" }],
+			Config = configPath,
+			Output = CreateOutputDirectory()
+		};
+
+		// Act
+		var result = await service.CreateChangelog(Collector, input, TestContext.Current.CancellationToken);
+
+		// Assert
+		if (!result)
+		{
+			foreach (var diagnostic in Collector.Diagnostics)
+				Output.WriteLine($"{diagnostic.Severity}: {diagnostic.Message}");
+		}
+
+		result.Should().BeTrue();
+		Collector.Errors.Should().Be(0);
+
+		var outputDir = input.Output ?? FileSystem.Directory.GetCurrentDirectory();
+		if (!FileSystem.Directory.Exists(outputDir))
+			FileSystem.Directory.CreateDirectory(outputDir);
+		var files = FileSystem.Directory.GetFiles(outputDir, "*.yaml");
+		var yamlContent = await FileSystem.File.ReadAllTextAsync(files[0], TestContext.Current.CancellationToken);
+		yamlContent.Should().Contain("- Alerting, connectors, and reporting");  // Full name, not split
+	}
+
+	[Fact]
+	public async Task CreateChangelog_WithOneLabelMappedToMultipleAreas_AddsAllAreas()
+	{
+		// Arrange: Same label under multiple areas
+		var prInfo = new GitHubPrInfo
+		{
+			Title = "Cross-area change",
+			Labels = ["type:enhancement", "Team:Search"]
+		};
+
+		A.CallTo(() => MockGitHubService.FetchPrInfoAsync(
+				A<string>._,
+				A<string?>._,
+				A<string?>._,
+				A<CancellationToken>._))
+			.Returns(prInfo);
+
+		// language=yaml
+		var configContent =
+			"""
+			pivot:
+			  types:
+			    enhancement: "type:enhancement"
+			    feature:
+			    bug-fix:
+			    breaking-change:
+			  areas:
+			    "Search":
+			      - "Team:Search"
+			    "Observability":
+			      - "Team:Search"
+			lifecycles:
+			  - ga
+			""";
+		var configPath = await CreateConfigDirectory(configContent);
+
+		var service = CreateService();
+
+		var input = new CreateChangelogArguments
+		{
+			Prs = ["https://github.com/elastic/elasticsearch/pull/12345"],
+			Products = [new ProductArgument { Product = "elasticsearch" }],
+			Config = configPath,
+			Output = CreateOutputDirectory()
+		};
+
+		// Act
+		var result = await service.CreateChangelog(Collector, input, TestContext.Current.CancellationToken);
+
+		// Assert
+		result.Should().BeTrue();
+		Collector.Errors.Should().Be(0);
+
+		var outputDir = input.Output;
+		if (!FileSystem.Directory.Exists(outputDir))
+			FileSystem.Directory.CreateDirectory(outputDir);
+		var files = FileSystem.Directory.GetFiles(outputDir, "*.yaml");
+		var yamlContent = await FileSystem.File.ReadAllTextAsync(files[0], TestContext.Current.CancellationToken);
+		yamlContent.Should().Contain("- Search");
+		yamlContent.Should().Contain("- Observability");
+	}
 }