Collapsed fields collision in graphql

src/OrchardCore.Modules/OrchardCore.ContentFields/GraphQL/Fields/ContentFieldsProvider.cs

@@ -86,7 +86,7 @@ public class ContentFieldsProvider : IContentFieldProvider
             }
         };
 
-        public FieldType GetField(ContentPartFieldDefinition field)
+        public FieldType GetField(ContentPartFieldDefinition field, string namedPartTechnicalName, string customFieldName)
         {
             if (!_contentFieldTypeMappings.TryGetValue(field.FieldDefinition.Name, out var value))
             {
@@ -96,13 +96,13 @@ public FieldType GetField(ContentPartFieldDefinition field)
             var fieldDescriptor = value;
             return new FieldType
             {
-                Name = field.Name,
+                Name = customFieldName ?? field.Name,
                 Description = fieldDescriptor.Description,
                 Type = fieldDescriptor.FieldType,
                 Resolver = new FuncFieldResolver<ContentElement, object>(context =>
                 {
                     // Check if part has been collapsed by trying to get the parent part.
-                    var contentPart = context.Source.Get(typeof(ContentPart), field.PartDefinition.Name);
+                    var contentPart = context.Source.Get(typeof(ContentPart), namedPartTechnicalName);
 
                     // Part is not collapsed, access field directly.
                     contentPart ??= context.Source;
@@ -116,6 +116,11 @@ public FieldType GetField(ContentPartFieldDefinition field)
             };
         }
 
+        public bool HasField(ContentPartFieldDefinition field)
+        {
+            return _contentFieldTypeMappings.ContainsKey(field.FieldDefinition.Name);
+        }
+
         private sealed class FieldTypeDescriptor
         {
             public string Description { get; set; }

src/OrchardCore.Modules/OrchardCore.ContentFields/GraphQL/Fields/ObjectGraphTypeFieldProvider.cs

@@ -21,27 +21,23 @@ public ObjectGraphTypeFieldProvider(IHttpContextAccessor httpContextAccessor)
             _httpContextAccessor = httpContextAccessor;
         }
 
-        public FieldType GetField(ContentPartFieldDefinition field)
+        public FieldType GetField(ContentPartFieldDefinition field, string namedPartTechnicalName, string customFieldName)
         {
-            var serviceProvider = _httpContextAccessor.HttpContext.RequestServices;
-            var queryGraphType = _partObjectGraphTypes.GetOrAdd(field.FieldDefinition.Name,
-                                                       partName => serviceProvider.GetService<IEnumerable<IObjectGraphType>>()?
-                                                            .FirstOrDefault(x => x.GetType().BaseType.GetGenericArguments().First().Name == partName)
-                                                   );
+            var queryGraphType = GetObjectGraphType(field);
 
             if (queryGraphType != null)
             {
                 return new FieldType
                 {
-                    Name = field.Name,
+                    Name = customFieldName ?? field.Name,
                     Description = field.FieldDefinition.Name,
                     Type = queryGraphType.GetType(),
                     Resolver = new FuncFieldResolver<ContentElement, ContentElement>(context =>
                     {
                         var typeToResolve = context.FieldDefinition.ResolvedType.GetType().BaseType.GetGenericArguments().First();
 
                         // Check if part has been collapsed by trying to get the parent part.
-                        var contentPart = context.Source.Get(typeof(ContentPart), field.PartDefinition.Name);
+                        var contentPart = context.Source.Get(typeof(ContentPart), namedPartTechnicalName);
 
                         // Part is not collapsed, access field directly.
                         contentPart ??= context.Source;
@@ -54,5 +50,20 @@ public FieldType GetField(ContentPartFieldDefinition field)
 
             return null;
         }
+
+        private IObjectGraphType GetObjectGraphType(ContentPartFieldDefinition field)
+        {
+            var serviceProvider = _httpContextAccessor.HttpContext.RequestServices;
+
+            return _partObjectGraphTypes.GetOrAdd(field.FieldDefinition.Name,
+                partName => serviceProvider.GetService<IEnumerable<IObjectGraphType>>()?
+                    .FirstOrDefault(x => x.GetType().BaseType.GetGenericArguments().First().Name == partName)
+                );
+        }
+
+        public bool HasField(ContentPartFieldDefinition field)
+        {
+            return GetObjectGraphType(field) != null;
+        }
     }
 }

src/OrchardCore.Modules/OrchardCore.ContentTypes/GraphQL/Drivers/GraphQLContentTypePartSettingsDriver.cs

@@ -1,35 +1,44 @@
 using System.Threading.Tasks;
+using Microsoft.Extensions.Localization;
 using Microsoft.Extensions.Options;
 using OrchardCore.ContentManagement.GraphQL.Options;
 using OrchardCore.ContentManagement.GraphQL.Settings;
 using OrchardCore.ContentManagement.Metadata.Models;
 using OrchardCore.ContentTypes.Editors;
 using OrchardCore.ContentTypes.GraphQL.ViewModels;
+using OrchardCore.DisplayManagement.ModelBinding;
 using OrchardCore.DisplayManagement.Views;
 
 namespace OrchardCore.ContentTypes.GraphQL.Drivers
 {
     public class GraphQLContentTypePartSettingsDriver : ContentTypePartDefinitionDisplayDriver
     {
         private readonly GraphQLContentOptions _contentOptions;
+        private readonly IStringLocalizer S;
 
-        public GraphQLContentTypePartSettingsDriver(IOptions<GraphQLContentOptions> optionsAccessor)
+        public GraphQLContentTypePartSettingsDriver(IOptions<GraphQLContentOptions> optionsAccessor, IStringLocalizer<GraphQLContentTypePartSettingsDriver> stringLocalizer)
         {
             _contentOptions = optionsAccessor.Value;
+            S = stringLocalizer;
         }
 
-        public override IDisplayResult Edit(ContentTypePartDefinition contentTypePartDefinition)
+        public override IDisplayResult Edit(ContentTypePartDefinition contentTypePartDefinition, IUpdateModel updater)
         {
             if (contentTypePartDefinition.ContentTypeDefinition.Name == contentTypePartDefinition.PartDefinition.Name)
             {
                 return null;
             }
 
-            return Initialize<GraphQLContentTypePartSettingsViewModel>("GraphQLContentTypePartSettings_Edit", model =>
+            return Initialize<GraphQLContentTypePartSettingsViewModel>("GraphQLContentTypePartSettings_Edit", async model =>
             {
                 model.Definition = contentTypePartDefinition;
                 model.Options = _contentOptions;
                 model.Settings = contentTypePartDefinition.GetSettings<GraphQLContentTypePartSettings>();
+
+                if (!updater.ModelState.IsValid)
+                {
+                    await updater.TryUpdateModelAsync(model, Prefix, x => x.Settings);
+                }
             }).Location("Content");
         }
 
@@ -42,11 +51,11 @@ public override async Task<IDisplayResult> UpdateAsync(ContentTypePartDefinition
 
             var model = new GraphQLContentTypePartSettingsViewModel();
 
-            await context.Updater.TryUpdateModelAsync(model, Prefix);
+            await context.Updater.TryUpdateModelAsync(model, Prefix, m => m.Settings);
 
             context.Builder.WithSettings(model.Settings);
 
-            return Edit(contentTypePartDefinition);
+            return Edit(contentTypePartDefinition, context.Updater);
         }
     }
 }

src/OrchardCore.Modules/OrchardCore.ContentTypes/Views/GraphQLContentTypePartSettings.Edit.cshtml

@@ -11,29 +11,52 @@
     var hidden = hiddenByDefault ? true : settings.Hidden;
 }
 
-<div class="mb-3">
-    <div class="form-check">
-        <input type="checkbox" class="form-check-input" asp-for="Settings.Collapse" checked="@collapsed" asp-is-disabled="@collapsedByDefault" />
-        <label class="form-check-label" asp-for="Settings.Collapse">@T["Collapse"]</label>
-        @if (collapsedByDefault)
-        {
-            <span class="hint">@T["NB. Setting is collapsed by default, and cannot be overwritten."]</span>
-        }
-        else
-        {
-            <span class="hint">@T["Check to collapse fields in the GraphQL schema."]</span>
-        }
-    </div>
-    <div class="form-check">
-        <input type="checkbox" class="form-check-input" asp-for="Settings.Hidden" checked="@hidden" asp-is-disabled="@hiddenByDefault" />
-        <label class="form-check-label" asp-for="Settings.Hidden">@T["Hide"]</label>
-        @if (hiddenByDefault)
-        {
-            <span class="hint">@T["Setting is hidden by default, and cannot be overwritten."]</span>
-        }
-        else
-        {
-            <span class="hint">@T["Check to hide part from the GraphQL schema."]</span>
-        }
-    </div>
+
+<div class="form-check">
+    <input type="checkbox" class="form-check-input" asp-for="Settings.Collapse" checked="@collapsed" asp-is-disabled="@collapsedByDefault" />
+    <label class="form-check-label" asp-for="Settings.Collapse">@T["Collapse"]</label>
+    @if (collapsedByDefault)
+    {
+        <span class="hint">@T["NB. Setting is collapsed by default, and cannot be overwritten."]</span>
+    }
+    else
+    {
+        <span class="hint">@T["Check to collapse fields in the GraphQL schema."]</span>
+    }
+</div>
+
+<div class="form-check mb-3 mt-3">
+    <input type="checkbox" class="form-check-input" asp-for="Settings.PreventFieldNameCollision" checked="@settings.PreventFieldNameCollision" />
+    <label class="form-check-label" asp-for="Settings.PreventFieldNameCollision">@T["Prevent Field Name Collision"]</label>
+    <span class="hint">@T["Check to prevent fields' names collisions in the GraphQL schema when they are collapsed."]</span>
 </div>
+
+<div class="form-check mb-3">
+    <input type="checkbox" class="form-check-input" asp-for="Settings.Hidden" checked="@hidden" asp-is-disabled="@hiddenByDefault" />
+    <label class="form-check-label" asp-for="Settings.Hidden">@T["Hide"]</label>
+    @if (hiddenByDefault)
+    {
+        <span class="hint">@T["Setting is hidden by default, and cannot be overwritten."]</span>
+    }
+    else
+    {
+        <span class="hint">@T["Check to hide part from the GraphQL schema."]</span>
+    }
+</div>
+
+<script at="Foot">
+    (function () {
+        const collapseCheckbox = document.getElementById("@(Html.IdFor(x => x.Settings.Collapse))");
+        const preventFieldNameCollisionCheckbox = document.getElementById("@(Html.IdFor(x => x.Settings.PreventFieldNameCollision))");
+        const setFieldVisibility = (checked) => {
+            preventFieldNameCollisionCheckbox.parentElement.style.display = checked ? 'block' : 'none';
+            if (!checked) {
+                preventFieldNameCollisionCheckbox.checked = false;
+            }            
+        };
+        collapseCheckbox.addEventListener('change', (e) => {
+            setFieldVisibility(e.target.checked);
+        });
+        setFieldVisibility(@(collapsed.ToString().ToLower()));
+    })();
+</script>

src/OrchardCore/OrchardCore.ContentManagement.GraphQL/Options/GraphQLContentOptions.cs

@@ -1,6 +1,7 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
+using GraphQL;
 using GraphQL.Types;
 using OrchardCore.ContentManagement.GraphQL.Settings;
 using OrchardCore.ContentManagement.Metadata.Models;
@@ -221,5 +222,17 @@ public bool IsHiddenByDefault(ContentTypePartDefinition definition)
 
             return false;
         }
+
+        internal string GetFieldName(ContentTypePartDefinition definition, string partName, string fieldName)
+        {
+            var settings = definition.GetSettings<GraphQLContentTypePartSettings>();
+
+            if (settings.PreventFieldNameCollision)
+            {
+                return $"{partName.ToFieldName()}{fieldName.ToPascalCase()}";
+            }
+
+            return fieldName;
+        }
     }
 }

src/OrchardCore/OrchardCore.ContentManagement.GraphQL/Queries/Types/DynamicContentTypeBuilder.cs

@@ -53,7 +53,7 @@ public void Build(FieldType contentQuery, ContentTypeDefinition contentTypeDefin
                     continue;
                 }
 
-                if (!(part.PartDefinition.Fields.Any(field => contentFieldProviders.Any(fieldProvider => fieldProvider.GetField(field) != null))))
+                if (!(part.PartDefinition.Fields.Any(field => contentFieldProviders.Any(fieldProvider => fieldProvider.HasField(field)))))
                 {
                     continue;
                 }
@@ -64,7 +64,9 @@ public void Build(FieldType contentQuery, ContentTypeDefinition contentTypeDefin
                     {
                         foreach (var fieldProvider in contentFieldProviders)
                         {
-                            var fieldType = fieldProvider.GetField(field);
+                            var customFieldName = _contentOptions.GetFieldName(part, part.Name, field.Name);
+
+                            var fieldType = fieldProvider.GetField(field, part.Name, customFieldName);
 
                             if (fieldType != null)
                             {
@@ -90,7 +92,7 @@ public void Build(FieldType contentQuery, ContentTypeDefinition contentTypeDefin
                         {
                             foreach (var fieldProvider in contentFieldProviders)
                             {
-                                var contentFieldType = fieldProvider.GetField(field);
+                                var contentFieldType = fieldProvider.GetField(field, part.Name);
 
                                 if (contentFieldType != null && !contentItemType.HasField(contentFieldType.Name))
                                 {

src/OrchardCore/OrchardCore.ContentManagement.GraphQL/Queries/Types/DynamicPartGraphType.cs

@@ -19,7 +19,7 @@ public DynamicPartGraphType(IHttpContextAccessor httpContextAccessor, ContentTyp
             {
                 foreach (var fieldProvider in contentFieldProviders)
                 {
-                    var fieldType = fieldProvider.GetField(field);
+                    var fieldType = fieldProvider.GetField(field, part.Name);
                     if (fieldType != null)
                     {
                         AddField(fieldType);

src/OrchardCore/OrchardCore.ContentManagement.GraphQL/Queries/Types/IContentFieldProvider.cs

@@ -5,6 +5,8 @@ namespace OrchardCore.ContentManagement.GraphQL.Queries.Types
 {
     public interface IContentFieldProvider
     {
-        FieldType GetField(ContentPartFieldDefinition field);
+        FieldType GetField(ContentPartFieldDefinition field, string namedPartTechnicalName, string customFieldName = null);
+
+        bool HasField(ContentPartFieldDefinition field);
     }
 }

src/OrchardCore/OrchardCore.ContentManagement.GraphQL/Settings/GraphQLContentTypePartSettings.cs

@@ -5,5 +5,7 @@ public class GraphQLContentTypePartSettings
         public bool Collapse { get; set; }
 
         public bool Hidden { get; set; }
+
+        public bool PreventFieldNameCollision { get; set; }
     }
 }