Cherry-pick #21: Format the returned XML because facebook limits the length of one row (#22)

* Format the returned XML because facebook limits the length of one row (#21)

Co-authored-by: Tim Gaunt <[email protected]>

* minor changes to code format and bump version

* switch to synchronous Flush because XmlTextWriter.FlushAsync throws NotImplementedException

---------

Co-authored-by: Tim Gaunt <[email protected]>
Co-authored-by: Tim Gaunt <[email protected]>

Author: 3 people

src/Umbraco.Commerce.ProductFeeds.Web/Apis/Public/ProductFeedController.cs

@@ -23,10 +23,7 @@ public ProductFeedController(
         public async Task<IActionResult> Xml(string path)
         {
             ProductFeedSettingReadModel? feedSettings = await _feedConfigService
-                .FindSettingAsync(new FindSettingParams
-                {
-                    FeedRelativePath = path,
-                })
+                .FindSettingAsync(new FindSettingParams { FeedRelativePath = path })
                 .ConfigureAwait(true);
             if (feedSettings == null)
             {
@@ -36,7 +33,8 @@ public async Task<IActionResult> Xml(string path)
             IProductFeedGeneratorService feedGenerator = _feedGeneratorFactory.GetGenerator(feedSettings.FeedType);
             XmlDocument feed = feedGenerator.GenerateFeed(feedSettings);
 
-            return Content(feed.OuterXml, "text/xml");
+            var result = new XmlActionResult(feed) { Formatting = Formatting.Indented };
+            return result;
         }
     }
 }

src/Umbraco.Commerce.ProductFeeds.Web/Apis/Public/XmlActionResult.cs

@@ -0,0 +1,44 @@
+using System;
+using System.Text;
+using System.Threading.Tasks;
+using System.Xml;
+using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Mvc;
+
+namespace Umbraco.Commerce.ProductFeeds.Apis.Public;
+
+public sealed class XmlActionResult : IActionResult
+{
+    private static readonly Serilog.ILogger _logger = Serilog.Log.Logger.ForContext(System.Reflection.MethodBase.GetCurrentMethod().DeclaringType);
+
+    private readonly XmlDocument _document;
+
+    public Formatting Formatting { get; set; } = Formatting.None;
+    public string MimeType { get; set; } = "text/xml";
+
+    public XmlActionResult(XmlDocument document)
+    {
+        ArgumentNullException.ThrowIfNull(document);
+        _document = document;
+    }
+
+    public async Task ExecuteResultAsync(ActionContext context)
+    {
+        context.HttpContext.Response.Clear();
+        context.HttpContext.Response.ContentType = MimeType;
+
+        try
+        {
+            using (var writer = new XmlTextWriter(context.HttpContext.Response.Body, Encoding.UTF8))
+            {
+                writer.Formatting = Formatting;
+                _document.WriteContentTo(writer);
+                writer.Flush();
+            }
+        }
+        catch (Exception ex)
+        {
+            _logger.Error(ex, "Exception generating the XML response");
+        }
+    }
+}

src/Umbraco.Commerce.ProductFeeds.Web/Umbraco.Commerce.ProductFeeds.Web.csproj

@@ -4,7 +4,7 @@
     <Title>Umbraco Commerce Product Feeds Web</Title>
     <Description>Contains apis</Description>
     <Nullable>enable</Nullable>
-    <NoWarn>IDE0007,CA2007</NoWarn>
+    <NoWarn>IDE0007;CA2007</NoWarn>
     <StaticWebAssetBasePath>App_Plugins/umbracocommerceproductfeeds</StaticWebAssetBasePath>
   </PropertyGroup>
 

version.json

@@ -1,6 +1,6 @@
 {
   "$schema": "https://raw.githubusercontent.com/dotnet/Nerdbank.GitVersioning/master/src/NerdBank.GitVersioning/version.schema.json",
-  "version": "14.1.1",
+  "version": "14.1.2",
   "assemblyVersion": {
     "precision": "build"
   },