Merge branch 'main' into vsezima/cors-exposed-headers

OrchardCMS · Jun 7, 2024 · 0c953a4 · 0c953a4
2 parents 6f35da7 + 07a655b
commit 0c953a4
Show file tree

Hide file tree

Showing 6 changed files with 102 additions and 57 deletions.
diff --git a/.github/workflows/comment_issue_on_triage.yml b/.github/workflows/comment_issue_on_triage.yml
@@ -12,7 +12,8 @@ jobs:
     runs-on: ubuntu-latest
     permissions:
       issues: write
-    if: github.event.issue.state == 'open'
+    # Despite the trigger being called "issues", this would still run for setting the milestone of PRs too.
+    if: github.event.issue.pull_request == null && github.event.issue.state == 'open'
     steps:
       - name: Add Comment
         run: gh issue comment "$NUMBER" --body "$BODY"

diff --git a/src/OrchardCore/OrchardCore.ContentManagement.GraphQL/Extensions/FieldTypeExtensions.cs b/src/OrchardCore/OrchardCore.ContentManagement.GraphQL/Extensions/FieldTypeExtensions.cs
diff --git a/src/OrchardCore/OrchardCore.ContentManagement.GraphQL/Extensions/GraphQLTypeExtensions.cs b/src/OrchardCore/OrchardCore.ContentManagement.GraphQL/Extensions/GraphQLTypeExtensions.cs
@@ -0,0 +1,40 @@
+using System;
+using System.Linq;
+using GraphQL.Types;
+
+namespace OrchardCore.ContentManagement.GraphQL;
+
+public static class GraphQLTypeExtensions
+{
+    public static FieldType WithPartCollapsedMetaData(this FieldType fieldType, bool collapsed = true)
+        => fieldType.WithMetaData("PartCollapsed", collapsed);
+
+    public static FieldType WithPartNameMetaData(this FieldType fieldType, string partName)
+        => fieldType.WithMetaData("PartName", partName);
+
+    /// <summary>
+    /// Checks if the field exists in the GraphQL type in a case-insensitive way.
+    /// </summary>
+    /// <remarks>
+    /// <para>
+    /// This is the same as calling <see cref="IComplexGraphType.HasField(string)"/> but in a case-insensitive way. OC
+    /// fields may be added with different casings, and we want to avoid collisions even then.
+    /// </para>
+    /// <para>
+    /// See <see href="https://github.com/OrchardCMS/OrchardCore/pull/16151"/> and its corresponding issues for context.
+    /// </para>
+    /// </remarks>
+    public static bool HasFieldIgnoreCase(this IComplexGraphType graphType, string fieldName)
+        => graphType.Fields.Any(field => field.Name.Equals(fieldName, StringComparison.OrdinalIgnoreCase));
+
+    private static FieldType WithMetaData(this FieldType fieldType, string name, object value)
+    {
+        // TODO: Understand if locking is the best solution to https://github.com/OrchardCMS/OrchardCore/issues/15308
+        lock (fieldType.Metadata)
+        {
+            fieldType.Metadata.TryAdd(name, value);
+        }
+
+        return fieldType;
+    }
+}
diff --git a/...hardCore/OrchardCore.ContentManagement.GraphQL/Queries/Types/DynamicContentTypeBuilder.cs b/...hardCore/OrchardCore.ContentManagement.GraphQL/Queries/Types/DynamicContentTypeBuilder.cs
@@ -1,3 +1,4 @@
+using System;
 using System.Collections.Generic;
 using System.Linq;
 using GraphQL.Types;
@@ -70,7 +71,8 @@ public void Build(ISchema schema, FieldType contentQuery, ContentTypeDefinition
 
                             if (fieldType != null)
                             {
-                                if (_contentOptions.ShouldSkip(fieldType.Type, fieldType.Name))
+                                if (_contentOptions.ShouldSkip(fieldType.Type, fieldType.Name) ||
+                                    contentItemType.HasFieldIgnoreCase(fieldType.Name))
                                 {
                                     continue;
                                 }
@@ -84,45 +86,63 @@ public void Build(ISchema schema, FieldType contentQuery, ContentTypeDefinition
                 else
                 {
                     // Check if another builder has already added a field for this part.
-                    var existingField = contentItemType.GetField(partName.ToFieldName());
-                    if (existingField != null)
+                    var partFieldName = partName.ToFieldName();
+                    var partFieldType = contentItemType.GetField(partFieldName);
+
+                    if (partFieldType != null)
                     {
-                        // Add content field types.
-                        foreach (var field in part.PartDefinition.Fields)
+                        // Add dynamic content field types to the static part type.
+                        var partContentItemType = schema.AdditionalTypeInstances
+                            .OfType<IObjectGraphType>()
+                            .Where(type => type.GetType() == partFieldType.Type)
+                            .FirstOrDefault();
+
+                        if (partContentItemType != null)
                         {
-                            foreach (var fieldProvider in contentFieldProviders)
+                            foreach (var field in part.PartDefinition.Fields)
                             {
-                                var contentFieldType = fieldProvider.GetField(schema, field, part.Name);
-
-                                if (contentFieldType != null && !contentItemType.HasField(contentFieldType.Name))
+                                foreach (var fieldProvider in contentFieldProviders)
                                 {
-                                    contentItemType.AddField(contentFieldType);
-                                    break;
+                                    var contentFieldType = fieldProvider.GetField(schema, field, part.Name);
+
+                                    if (contentFieldType != null)
+                                    {
+                                        if (_contentOptions.ShouldSkip(contentFieldType.Type, contentFieldType.Name) ||
+                                            partContentItemType.HasFieldIgnoreCase(contentFieldType.Name))
+                                        {
+                                            continue;
+                                        }
+
+
+                                        partContentItemType.AddField(contentFieldType);
+                                        break;
+                                    }
                                 }
                             }
                         }
-                        continue;
-                    }
-
-                    if (_dynamicPartFields.TryGetValue(partName, out var fieldType))
-                    {
-                        contentItemType.AddField(fieldType);
                     }
                     else
                     {
-                        var field = contentItemType
-                            .Field<DynamicPartGraphType>(partName.ToFieldName())
-                            .Description(S["Represents a {0}.", part.PartDefinition.Name])
-                            .Resolve(context =>
-                            {
-                                var nameToResolve = partName;
-                                var typeToResolve = context.FieldDefinition.ResolvedType.GetType().BaseType.GetGenericArguments().First();
+                        if (_dynamicPartFields.TryGetValue(partName, out var fieldType))
+                        {
+                            contentItemType.AddField(fieldType);
+                        }
+                        else
+                        {
+                            var field = contentItemType
+                                .Field<DynamicPartGraphType>(partFieldName)
+                                .Description(S["Represents a {0}.", part.PartDefinition.Name])
+                                .Resolve(context =>
+                                {
+                                    var nameToResolve = partName;
+                                    var typeToResolve = context.FieldDefinition.ResolvedType.GetType().BaseType.GetGenericArguments().First();
 
-                                return context.Source.Get(typeToResolve, nameToResolve);
-                            });
+                                    return context.Source.Get(typeToResolve, nameToResolve);
+                                });
 
-                        field.Type(new DynamicPartGraphType(part));
-                        _dynamicPartFields[partName] = field.FieldType;
+                            field.Type(new DynamicPartGraphType(part));
+                            _dynamicPartFields[partName] = field.FieldType;
+                        }
                     }
                 }
             }

diff --git a/...rchardCore/OrchardCore.ContentManagement.GraphQL/Queries/Types/TypedContentTypeBuilder.cs b/...rchardCore/OrchardCore.ContentManagement.GraphQL/Queries/Types/TypedContentTypeBuilder.cs
@@ -1,3 +1,4 @@
+using System;
 using System.Linq;
 using GraphQL;
 using GraphQL.Resolvers;
@@ -40,9 +41,10 @@ public void Build(ISchema schema, FieldType contentQuery, ContentTypeDefinition
                 }
 
                 var partName = part.Name;
+                var partFieldName = partName.ToFieldName();
 
                 // Check if another builder has already added a field for this part.
-                if (contentItemType.HasField(partName))
+                if (contentItemType.HasField(partFieldName))
                 {
                     continue;
                 }
@@ -58,7 +60,8 @@ public void Build(ISchema schema, FieldType contentQuery, ContentTypeDefinition
                     {
                         foreach (var field in queryGraphType.Fields)
                         {
-                            if (_contentOptions.ShouldSkip(queryGraphType.GetType(), field.Name))
+                            if (_contentOptions.ShouldSkip(queryGraphType.GetType(), field.Name) ||
+                                contentItemType.HasFieldIgnoreCase(field.Name))
                             {
                                 continue;
                             }
@@ -94,11 +97,11 @@ public void Build(ISchema schema, FieldType contentQuery, ContentTypeDefinition
                     {
                         var field = new FieldType
                         {
-                            Name = partName.ToFieldName(),
+                            Name = partFieldName,
                             Type = queryGraphType.GetType(),
                             Description = queryGraphType.Description,
                         };
-                        contentItemType.Field(partName.ToFieldName(), queryGraphType.GetType())
+                        contentItemType.Field(partFieldName, queryGraphType.GetType())
                                        .Description(queryGraphType.Description)
                                        .Resolve(context =>
                                        {
@@ -135,7 +138,7 @@ public void Build(ISchema schema, FieldType contentQuery, ContentTypeDefinition
                         whereInput.AddField(new FieldType
                         {
                             Type = inputGraphTypeResolved.GetType(),
-                            Name = partName.ToFieldName(),
+                            Name = partFieldName,
                             Description = inputGraphTypeResolved.Description
                         }.WithPartNameMetaData(partName));
                     }

diff --git a/src/docs/releases/2.0.0.md b/src/docs/releases/2.0.0.md
@@ -246,6 +246,10 @@ Here are the updated signatures:
 
 These adjustments ensure compatibility and adherence to the latest conventions within the `SectionDisplayDriver` class.
 
+The GraphQL schema may change because fields are now always added to the correct part. Previously, additional fields may have been added to the parent content item type directly. 
+
+You may have to adjust your GraphQL queries in that case.
+
 ## Change Logs
 
 ### Azure AI Search Module