Refactored PlaceHolder processing to use Stack approach instead of recursion

Author: robearlam

src/Sitecore.AspNetCore.SDK.Pages/Request/Handlers/GraphQL/GraphQLEditingServiceHandler.cs

@@ -22,7 +22,7 @@ namespace Sitecore.AspNetCore.SDK.Pages.Request.Handlers.GraphQL;
 /// <param name="logger">The <see cref="ILogger"/> to use for logging.</param>
 /// <param name="clientFactory">The GraphQlClientFactory used to generate instances of the GraphQl client.</param>
 /// <param name="serializer">The serializer to handle response data.</param>
-public class GraphQLEditingServiceHandler(IGraphQLClientFactory clientFactory,
+public partial class GraphQLEditingServiceHandler(IGraphQLClientFactory clientFactory,
     ISitecoreLayoutSerializer serializer,
     ILogger<GraphQLEditingServiceHandler> logger)
     : ILayoutRequestHandler
@@ -93,43 +93,77 @@ private static void GenerateMetaDataChromes(SitecoreLayoutResponseContent? conte
 
     private static Placeholder ProcessPlaceholder(string name, string id, Placeholder placeholderFeatures)
     {
-        Placeholder updatedPlaceholders = [];
+        Placeholder result = new();
 
-        AddPlaceholderOpeningChrome(name, id, updatedPlaceholders);
+        // Create a separate class outside of this method for the work item
+        // to avoid nested class compilation issues
+        var workStack = new Stack<PlaceholderWorkItem>();
+        workStack.Push(new PlaceholderWorkItem(name, id, placeholderFeatures, result));
 
-        foreach (var feature in placeholderFeatures)
+        while (workStack.Count > 0)
         {
-            if (feature is Component component)
-            {
-                AddRenderingOpeningChrome(updatedPlaceholders, component);
+            var current = workStack.Pop();
+            var output = current.Output;
+
+            // Add opening chrome for placeholder
+            AddPlaceholderOpeningChrome(current.Name, current.Id, output);
 
-                var updatedFields = new Dictionary<string, IFieldReader>();
-                foreach (var field in component.Fields)
+            // Process all features in this placeholder
+            foreach (var feature in current.Features)
+            {
+                if (feature is Component component)
                 {
-                    ProcessField(updatedFields, field);
-                }
+                    // Add opening chrome
+                    AddRenderingOpeningChrome(output, component);
 
-                component.Fields = updatedFields;
+                    // Process fields
+                    Dictionary<string, IFieldReader> updatedFields = new();
+                    foreach (var field in component.Fields)
+                    {
+                        ProcessField(updatedFields, field);
+                    }
+                    component.Fields = updatedFields;
 
-                updatedPlaceholders.Add(component);
+                    // Add the component to the output
+                    output.Add(component);
 
-                foreach (var componentPlaceholder in component.Placeholders)
-                {
+                    // Process component placeholders before adding closing chrome
+                    if (component.Placeholders.Count > 0)
                     {
-                        string componentPlaceholderName = componentPlaceholder.Key;
-                        Placeholder componentPlaceholderFeatures = componentPlaceholder.Value;
-
-                        component.Placeholders[componentPlaceholderName] = ProcessPlaceholder("container-{*}", component.Id, componentPlaceholderFeatures);
+                        // For each placeholder in the component, add it to the work stack
+                        foreach (var placeholder in component.Placeholders.ToList())
+                        {
+                            string placeholderKey = placeholder.Key;
+                            Placeholder placeholderValue = placeholder.Value;
+
+                            // Create a new placeholder to hold the processed content
+                            Placeholder processedPlaceholder = new();
+
+                            // Add a work item to process this placeholder
+                            workStack.Push(new PlaceholderWorkItem(
+                                "container-{*}",
+                                component.Id,
+                                placeholderValue,
+                                processedPlaceholder,
+                                component,
+                                placeholderKey
+                            ));
+
+                            // Store the processed placeholder for later assignment
+                            component.Placeholders[placeholderKey] = processedPlaceholder;
+                        }
                     }
-                }
 
-                AddRenderingClosingChrome(updatedPlaceholders);
+                    // Add closing chrome for the component
+                    AddRenderingClosingChrome(output);
+                }
             }
-        }
 
-        AddPlaceholderClosingChrome(updatedPlaceholders);
+            // Add closing chrome for placeholder
+            AddPlaceholderClosingChrome(output);
+        }
 
-        return updatedPlaceholders;
+        return result;
     }
 
     private static void AddRenderingClosingChrome(Placeholder updatedPlaceholders)

src/Sitecore.AspNetCore.SDK.Pages/Request/Handlers/GraphQL/PlaceholderWorkItem.cs

@@ -0,0 +1,33 @@
+using Sitecore.AspNetCore.SDK.LayoutService.Client.Response.Model;
+
+namespace Sitecore.AspNetCore.SDK.Pages.Request.Handlers.GraphQL;
+
+public partial class GraphQLEditingServiceHandler
+{
+    // Define the work item class outside of the method to avoid nested class issues
+    private class PlaceholderWorkItem
+    {
+        public string Name { get; }
+        public string Id { get; }
+        public Placeholder Features { get; }
+        public Placeholder Output { get; }
+        public Component ParentComponent { get; }
+        public string PlaceholderKey { get; }
+
+        public PlaceholderWorkItem(
+            string name,
+            string id,
+            Placeholder features,
+            Placeholder output,
+            Component parentComponent = null,
+            string placeholderKey = null)
+        {
+            Name = name;
+            Id = id;
+            Features = features;
+            Output = output;
+            ParentComponent = parentComponent;
+            PlaceholderKey = placeholderKey;
+        }
+    }
+}