[Fusion] Added post-merge validation rule "EmptyMergedEnumTypeRule" (#7977)

Author: danielreynolds1

src/HotChocolate/Fusion-vnext/src/Fusion.Composition/Events/SchemaEvents.cs

@@ -10,6 +10,10 @@ internal record DirectiveArgumentEvent(
     DirectiveDefinition Directive,
     SchemaDefinition Schema) : IEvent;
 
+internal record EnumTypeEvent(
+    EnumTypeDefinition EnumType,
+    SchemaDefinition Schema) : IEvent;
+
 internal record FieldArgumentEvent(
     InputFieldDefinition Argument,
     OutputFieldDefinition Field,

src/HotChocolate/Fusion-vnext/src/Fusion.Composition/Logging/LogEntryCodes.cs

@@ -3,6 +3,7 @@ namespace HotChocolate.Fusion.Logging;
 public static class LogEntryCodes
 {
     public const string DisallowedInaccessible = "DISALLOWED_INACCESSIBLE";
+    public const string EmptyMergedEnumType = "EMPTY_MERGED_ENUM_TYPE";
     public const string EmptyMergedObjectType = "EMPTY_MERGED_OBJECT_TYPE";
     public const string EnumValuesMismatch = "ENUM_VALUES_MISMATCH";
     public const string ExternalArgumentDefaultMismatch = "EXTERNAL_ARGUMENT_DEFAULT_MISMATCH";

src/HotChocolate/Fusion-vnext/src/Fusion.Composition/Logging/LogEntryHelper.cs

@@ -100,6 +100,19 @@ public static LogEntry DisallowedInaccessibleDirectiveArgument(
             schema);
     }
 
+    public static LogEntry EmptyMergedEnumType(
+        EnumTypeDefinition enumType,
+        SchemaDefinition schema)
+    {
+        return new LogEntry(
+            string.Format(LogEntryHelper_EmptyMergedEnumType, enumType.Name),
+            LogEntryCodes.EmptyMergedEnumType,
+            LogSeverity.Error,
+            new SchemaCoordinate(enumType.Name),
+            enumType,
+            schema);
+    }
+
     public static LogEntry EmptyMergedObjectType(
         ObjectTypeDefinition objectType,
         SchemaDefinition schema)

src/HotChocolate/Fusion-vnext/src/Fusion.Composition/PostMergeValidationRules/EmptyMergedEnumTypeRule.cs

@@ -0,0 +1,32 @@
+using HotChocolate.Fusion.Events;
+using HotChocolate.Fusion.Events.Contracts;
+using HotChocolate.Fusion.Extensions;
+using static HotChocolate.Fusion.Logging.LogEntryHelper;
+
+namespace HotChocolate.Fusion.PostMergeValidationRules;
+
+/// <summary>
+/// TODO: Summary
+/// </summary>
+/// <seealso href="https://graphql.github.io/composite-schemas-spec/draft/#sec-Empty-Merged-Enum-Type">
+/// Specification
+/// </seealso>
+internal sealed class EmptyMergedEnumTypeRule : IEventHandler<EnumTypeEvent>
+{
+    public void Handle(EnumTypeEvent @event, CompositionContext context)
+    {
+        var (enumType, schema) = @event;
+
+        if (enumType.HasInaccessibleDirective())
+        {
+            return;
+        }
+
+        var accessibleValues = enumType.Values.Where(v => !v.HasInaccessibleDirective());
+
+        if (!accessibleValues.Any())
+        {
+            context.Log.Write(EmptyMergedEnumType(enumType, schema));
+        }
+    }
+}

src/HotChocolate/Fusion-vnext/src/Fusion.Composition/PostMergeValidator.cs

@@ -33,6 +33,10 @@ private void PublishEvents()
         {
             switch (type)
             {
+                case EnumTypeDefinition enumType:
+                    PublishEvent(new EnumTypeEvent(enumType, mergedSchema), context);
+                    break;
+
                 case InputObjectTypeDefinition inputType:
                     PublishEvent(new InputTypeEvent(inputType, mergedSchema), context);
 

src/HotChocolate/Fusion-vnext/src/Fusion.Composition/Properties/CompositionResources.Designer.cs

@@ -45,6 +45,9 @@
   <data name="LogEntryHelper_DisallowedInaccessibleDirectiveArgument" xml:space="preserve">
     <value>The built-in directive argument '{0}' in schema '{1}' is not accessible.</value>
   </data>
+  <data name="LogEntryHelper_EmptyMergedEnumType" xml:space="preserve">
+    <value>The merged enum type '{0}' is empty.</value>
+  </data>
   <data name="LogEntryHelper_EmptyMergedObjectType" xml:space="preserve">
     <value>The merged object type '{0}' is empty.</value>
   </data>

src/HotChocolate/Fusion-vnext/src/Fusion.Composition/Properties/CompositionResources.resx

@@ -120,6 +120,7 @@ public CompositionResult<SchemaDefinition> Compose()
 
     private static readonly ImmutableArray<object> s_postMergeRules =
     [
+        new EmptyMergedEnumTypeRule(),
         new EmptyMergedObjectTypeRule()
     ];
 }

src/HotChocolate/Fusion-vnext/src/Fusion.Composition/SchemaComposer.cs

@@ -0,0 +1,126 @@
+using System.Collections.Immutable;
+using HotChocolate.Fusion.Logging;
+
+namespace HotChocolate.Fusion.PostMergeValidationRules;
+
+public sealed class EmptyMergedEnumTypeRuleTests : CompositionTestBase
+{
+    private static readonly object s_rule = new EmptyMergedEnumTypeRule();
+    private static readonly ImmutableArray<object> s_rules = [s_rule];
+    private readonly CompositionLog _log = new();
+
+    [Theory]
+    [MemberData(nameof(ValidExamplesData))]
+    public void Examples_Valid(string[] sdl)
+    {
+        // arrange
+        var schemas = CreateSchemaDefinitions(sdl);
+        var merger = new SourceSchemaMerger(schemas);
+        var mergeResult = merger.Merge();
+        var validator = new PostMergeValidator(mergeResult.Value, s_rules, schemas, _log);
+
+        // act
+        var result = validator.Validate();
+
+        // assert
+        Assert.True(result.IsSuccess);
+        Assert.True(_log.IsEmpty);
+    }
+
+    [Theory]
+    [MemberData(nameof(InvalidExamplesData))]
+    public void Examples_Invalid(string[] sdl, string[] errorMessages)
+    {
+        // arrange
+        var schemas = CreateSchemaDefinitions(sdl);
+        var merger = new SourceSchemaMerger(schemas);
+        var mergeResult = merger.Merge();
+        var validator = new PostMergeValidator(mergeResult.Value, s_rules, schemas, _log);
+
+        // act
+        var result = validator.Validate();
+
+        // assert
+        Assert.True(result.IsFailure);
+        Assert.Equal(errorMessages, _log.Select(e => e.Message).ToArray());
+        Assert.True(_log.All(e => e.Code == "EMPTY_MERGED_ENUM_TYPE"));
+        Assert.True(_log.All(e => e.Severity == LogSeverity.Error));
+    }
+
+    public static TheoryData<string[]> ValidExamplesData()
+    {
+        return new TheoryData<string[]>
+        {
+            // TODO: Use examples from spec
+            {
+                [
+                    """
+                    # Schema A
+                    enum Genre {
+                        FANTASY
+                        SCIENCE_FICTION @inaccessible
+                    }
+                    """,
+                    """
+                    # Schema B
+                    enum Genre {
+                        FANTASY
+                    }
+                    """
+                ]
+            },
+            // TODO: Check spec text
+            // If the @inaccessible directive is applied to an enum type itself, the entire merged
+            // enum type is excluded from the composite schema, and it is not required to contain
+            // any values.
+            {
+                [
+                    """
+                    # Schema A
+                    enum Genre @inaccessible {
+                        FANTASY
+                        SCIENCE_FICTION
+                    }
+                    """,
+                    """
+                    # Schema B
+                    enum Genre {
+                        FANTASY
+                    }
+                    """
+                ]
+            }
+        };
+    }
+
+    public static TheoryData<string[], string[]> InvalidExamplesData()
+    {
+        return new TheoryData<string[], string[]>
+        {
+            // This example demonstrates an invalid merged enum type. In this case, "Genre" is
+            // defined in two source schemas, but all values are marked as @inaccessible in at least
+            // one of the source schemas, resulting in an empty merged enum type.
+            {
+                [
+                    """
+                    # Schema A
+                    enum Genre {
+                        FANTASY
+                        SCIENCE_FICTION @inaccessible
+                    }
+                    """,
+                    """
+                    # Schema B
+                    enum Genre {
+                        FANTASY @inaccessible
+                        SCIENCE_FICTION
+                    }
+                    """
+                ],
+                [
+                    "The merged enum type 'Genre' is empty."
+                ]
+            }
+        };
+    }
+}