Skip to content

Fix XML flatten serialization: namespace loss, primitive formatting, document-root validity, and converter ordering #153

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gimlichael merged 13 commits into from
Feb 27, 2026
Merged

Fix XML flatten serialization: namespace loss, primitive formatting, document-root validity, and converter ordering #153

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
96d5d31
🐛 fixed xml writing by conditionally encapsulating child nodes
gimlichael Feb 26, 2026
c013dbc
✨ add minimal xml options extension method for service collection
gimlichael Feb 26, 2026
3de9f86
✨ add flattenItems option for enumerable XML serialization
gimlichael Feb 26, 2026
bc5e7bc
✅ add xml serialization tests
gimlichael Feb 26, 2026
09ad4a9
⬆️ bump dependencies for benchmarkdotnet and xunit packages
gimlichael Feb 26, 2026
5d863a3
🗑️ remove service update workflow file
gimlichael Feb 26, 2026
9cb7018
📦️ updated NuGet package definition
gimlichael Feb 26, 2026
53c6a54
🤖 add prompt for populating PackageReleaseNotes.txt files
gimlichael Feb 27, 2026
587651e
📦️ updated NuGet package definition
gimlichael Feb 27, 2026
124ee90
💬 updated community health pages
gimlichael Feb 27, 2026
3a125d6
Initial plan
Copilot Feb 27, 2026
22f0d1c
♻️ address review feedback on XML flatten serialization
Copilot Feb 27, 2026
5ddc879
Merge branch 'main' into copilot/sub-pr-152
gimlichael Feb 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 13 additions & 6 deletions src/Cuemon.Xml/Extensions/Serialization/Converters/XmlConverterDecoratorExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ public static IDecorator<IList<XmlConverter>> AddEnumerableConverter(this IDecor
{
if (isDictionaryLike)
{
w.WriteStartElement(q.LocalName);
w.WriteStartElement(q.Prefix, q.LocalName, q.Namespace);
foreach (var element in o)
{
var elementType = element.GetType();
Expand All @@ -125,31 +125,38 @@ public static IDecorator<IList<XmlConverter>> AddEnumerableConverter(this IDecor
var keyName = Decorator.Enclose(keyValue.ToString()).SanitizeXmlElementName();
if (Decorator.Enclose(valuePropertyType).IsComplex())
{
Decorator.Enclose(w).WriteObject(valueValue, valuePropertyType, opts => opts.Settings.RootName = new XmlQualifiedEntity(keyName));
Decorator.Enclose(w).WriteObject(valueValue, valuePropertyType, opts => opts.Settings.RootName = new XmlQualifiedEntity(keyName, q.Namespace));
}
else
{
w.WriteElementString(keyName, Convert.ToString(valueValue, CultureInfo.InvariantCulture));
w.WriteStartElement(keyName, q.Namespace);
w.WriteValue(valueValue);
w.WriteEndElement();
}
}
w.WriteEndElement();
}
else
{
var isDocumentRoot = w.WriteState == WriteState.Start;
if (isDocumentRoot) { w.WriteStartElement(q.Prefix, q.LocalName, q.Namespace); }
var qe = new XmlQualifiedEntity(q.Prefix, q.LocalName, q.Namespace);
foreach (var item in o)
{
if (item == null) { continue; }
var itemType = item.GetType();
if (Decorator.Enclose(itemType).IsComplex())
{
var localName = q.LocalName;
Decorator.Enclose(w).WriteObject(item, itemType, opts => opts.Settings.RootName = new XmlQualifiedEntity(localName));
Decorator.Enclose(w).WriteObject(item, itemType, opts => opts.Settings.RootName = qe);
}
else
{
w.WriteElementString(q.LocalName, Convert.ToString(item, CultureInfo.InvariantCulture));
w.WriteStartElement(q.Prefix, q.LocalName, q.Namespace);
w.WriteValue(item);
w.WriteEndElement();
}
}
if (isDocumentRoot) { w.WriteEndElement(); }
Comment on lines +141 to +159

Copilot AI Feb 27, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The updated flatten-items writer logic (namespace/prefix propagation, WriteValue formatting, and document-root wrapping) is not currently covered by unit tests. Please add tests that exercise: (1) FlattenCollectionItems=true with a root IEnumerable where Settings.RootName is set (ensuring the output is well-formed XML with a single document element), (2) primitive formatting (e.g., bool emits "true/false"), and (3) namespace/prefix preservation on the emitted elements.

Copilot uses AI. Check for mistakes.
}
}
else
Expand Down
11 changes: 8 additions & 3 deletions src/Cuemon.Xml/Serialization/Formatters/XmlFormatterOptions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,9 +129,14 @@ internal XmlSerializerOptions RefreshWithConverterDependencies()
_refreshed = true;
if (Settings.FlattenCollectionItems)
{
var existing = Decorator.Enclose(Settings.Converters).FirstOrDefaultWriterConverter(typeof(IEnumerable));
if (existing != null) { Settings.Converters.Remove(existing); }
Decorator.Enclose(Settings.Converters).AddEnumerableConverter(flattenItems: true);
var converters = Decorator.Enclose(Settings.Converters);
while (true)
{
var existing = converters.FirstOrDefaultWriterConverter(typeof(IEnumerable));
if (existing == null) { break; }
Settings.Converters.Remove(existing);
}
converters.AddEnumerableConverter(flattenItems: true);
Comment on lines +132 to +139

Copilot AI Feb 27, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

RefreshWithConverterDependencies now removes all writer converters that can convert IEnumerable before inserting the flattened enumerable converter. Please add a unit test that registers multiple IEnumerable-capable converters ahead of the default one and verifies that when FlattenCollectionItems=true, serialization actually uses the flattened converter (and that all prior IEnumerable writer converters are removed as intended).

Copilot uses AI. Check for mistakes.
}
Decorator.Enclose(Settings.Converters)
.AddExceptionConverter(SensitivityDetails.HasFlag(FaultSensitivityDetails.StackTrace), SensitivityDetails.HasFlag(FaultSensitivityDetails.Data))
Expand Down
Loading