Fixed issue with non-deterministic order of automatic type registrations (#7708)

Author: glen-84

src/HotChocolate/Core/src/Types.Analyzers/Generators/TypeModuleSyntaxGenerator.cs

@@ -63,7 +63,7 @@ private static void WriteConfiguration(
         var hasInterfaceTypes = false;
         var hasConfigurations = false;
 
-        foreach (var syntaxInfo in syntaxInfos)
+        foreach (var syntaxInfo in syntaxInfos.OrderBy(s => s.OrderByKey))
         {
             if(syntaxInfo.Diagnostics.Length > 0)
             {

src/HotChocolate/Core/src/Types.Analyzers/Models/DataLoaderDefaultsInfo.cs

@@ -18,6 +18,8 @@ public sealed class DataLoaderDefaultsInfo(
 
     public bool GenerateInterfaces { get; } = generateInterfaces;
 
+    public override string OrderByKey => string.Empty;
+
     public override bool Equals(object? obj)
         => obj is DataLoaderDefaultsInfo other && Equals(other);
 

src/HotChocolate/Core/src/Types.Analyzers/Models/DataLoaderInfo.cs

@@ -78,6 +78,8 @@ public DataLoaderInfo(
 
     public ImmutableArray<DataLoaderParameterInfo> Parameters { get; }
 
+    public override string OrderByKey => FullName;
+
     public ImmutableArray<CacheLookup> GetLookups(ITypeSymbol keyType, ITypeSymbol valueType)
     {
         if (_lookups.Length > 0)

src/HotChocolate/Core/src/Types.Analyzers/Models/DataLoaderModuleInfo.cs

@@ -4,6 +4,8 @@ public sealed class DataLoaderModuleInfo(string moduleName) : SyntaxInfo
 {
     public string ModuleName { get; } = moduleName;
 
+    public override string OrderByKey => ModuleName;
+
     public override bool Equals(object? obj)
         => obj is DataLoaderModuleInfo other && Equals(other);
 

src/HotChocolate/Core/src/Types.Analyzers/Models/InterfaceTypeExtensionInfo.cs

@@ -23,6 +23,8 @@ public sealed class InterfaceTypeExtensionInfo(
 
     public ImmutableArray<Resolver> Resolvers { get; } = resolvers;
 
+    public override string OrderByKey => Name;
+
     public override bool Equals(object? obj)
         => obj is ObjectTypeExtensionInfo other && Equals(other);
 

src/HotChocolate/Core/src/Types.Analyzers/Models/ModuleInfo.cs

@@ -6,6 +6,8 @@ public sealed class ModuleInfo(string moduleName, ModuleOptions options) : Synta
 
     public ModuleOptions Options { get; } = options;
 
+    public override string OrderByKey => ModuleName;
+
     public override bool Equals(object? obj)
         => obj is ModuleInfo other && Equals(other);
 

src/HotChocolate/Core/src/Types.Analyzers/Models/ObjectTypeExtensionInfo.cs

@@ -26,6 +26,8 @@ public sealed class ObjectTypeExtensionInfo(
 
     public ImmutableArray<Resolver> Resolvers { get; } = resolvers;
 
+    public override string OrderByKey => Name;
+
     public override bool Equals(object? obj)
         => obj is ObjectTypeExtensionInfo other && Equals(other);
 

src/HotChocolate/Core/src/Types.Analyzers/Models/OperationInfo.cs

@@ -8,6 +8,8 @@ public sealed class OperationInfo(OperationType type, string typeName, string me
 
     public string MethodName { get; } = methodName;
 
+    public override string OrderByKey => TypeName;
+
     public override bool Equals(object? obj)
         => obj is OperationInfo other && Equals(other);
 

src/HotChocolate/Core/src/Types.Analyzers/Models/OperationRegistrationInfo.cs

@@ -6,6 +6,8 @@ public sealed class OperationRegistrationInfo(OperationType type, string typeNam
 
     public string TypeName { get; } = typeName;
 
+    public override string OrderByKey => TypeName;
+
     public override bool Equals(object? obj)
         => obj is OperationRegistrationInfo other && Equals(other);
 

src/HotChocolate/Core/src/Types.Analyzers/Models/RegisterDataLoaderInfo.cs

@@ -4,6 +4,8 @@ public sealed class RegisterDataLoaderInfo(string name) : SyntaxInfo
 {
     public string Name { get; } = name;
 
+    public override string OrderByKey => Name;
+
     public override bool Equals(object? obj)
         => obj is RegisterDataLoaderInfo other && Equals(other);
 

src/HotChocolate/Core/src/Types.Analyzers/Models/RequestMiddlewareInfo.cs

@@ -21,6 +21,8 @@ public sealed class RequestMiddlewareInfo(
 
     public List<RequestMiddlewareParameterInfo> InvokeParameters { get; } = invokeParameters;
 
+    public override string OrderByKey => Name;
+
     public override bool Equals(object? obj)
         => obj is RequestMiddlewareInfo other && Equals(other);
 

src/HotChocolate/Core/src/Types.Analyzers/Models/SyntaxInfo.cs

@@ -5,6 +5,8 @@ namespace HotChocolate.Types.Analyzers.Models;
 
 public abstract class SyntaxInfo : IEquatable<SyntaxInfo>
 {
+    public abstract string OrderByKey { get; }
+
     public ImmutableArray<Diagnostic> Diagnostics { get; private set; } = ImmutableArray<Diagnostic>.Empty;
 
     public void AddDiagnostic(Diagnostic diagnostic)

src/HotChocolate/Core/src/Types.Analyzers/Models/TypeExtensionInfo.cs

@@ -8,6 +8,8 @@ public sealed class TypeExtensionInfo(string name, bool isStatic, OperationType
 
     public OperationType Type { get; } = type;
 
+    public override string OrderByKey => Name;
+
     public override bool Equals(object? obj)
         => obj is TypeExtensionInfo other && Equals(other);
 

src/HotChocolate/Core/src/Types.Analyzers/Models/TypeInfo.cs

@@ -4,6 +4,8 @@ public sealed class TypeInfo(string name) : SyntaxInfo
 {
     public string Name { get; } = name;
 
+    public override string OrderByKey => Name;
+
     public override bool Equals(object? obj)
         => obj is TypeInfo other && Equals(other);
 

src/HotChocolate/Core/test/Types.Analyzers.Tests/TestHelper.cs

@@ -21,9 +21,11 @@ internal static partial class TestHelper
 
     public static Snapshot GetGeneratedSourceSnapshot([StringSyntax("csharp")] string sourceText)
     {
-        // Parse the provided string into a C# syntax tree.
-        var syntaxTree = CSharpSyntaxTree.ParseText(sourceText);
+        return GetGeneratedSourceSnapshot([sourceText]);
+    }
 
+    public static Snapshot GetGeneratedSourceSnapshot(string[] sourceTexts)
+    {
         IEnumerable<PortableExecutableReference> references =
         [
 #if NET8_0
@@ -48,7 +50,7 @@ public static Snapshot GetGeneratedSourceSnapshot([StringSyntax("csharp")] strin
         // Create a Roslyn compilation for the syntax tree.
         var compilation = CSharpCompilation.Create(
             assemblyName: "Tests",
-            syntaxTrees: [syntaxTree],
+            syntaxTrees: sourceTexts.Select(s => CSharpSyntaxTree.ParseText(s)),
             references);
 
         // Create an instance of our GraphQLServerGenerator incremental source generator.

src/HotChocolate/Core/test/Types.Analyzers.Tests/TypeModuleSyntaxGeneratorTests.cs

@@ -0,0 +1,160 @@
+namespace HotChocolate.Types;
+
+public class TypeModuleSyntaxGeneratorTests
+{
+    [Fact]
+    public async Task GenerateSource_TypeModuleOrdering_MatchesSnapshot()
+    {
+        await TestHelper.GetGeneratedSourceSnapshot(
+        [
+            """
+            using HotChocolate.Types;
+
+            namespace TestNamespace;
+
+            internal class ATestBType: ObjectType<ATestB>;
+            internal record ATestB(int Id);
+            """,
+            """
+            using HotChocolate.Types;
+
+            namespace TestNamespace;
+
+            internal class ATestAType : ObjectType<ATestA>;
+            internal record ATestA(int Id);
+            """,
+            """
+            using HotChocolate.Types;
+
+            namespace TestNamespace;
+
+            [ObjectType<ATestBAttr>]
+            internal static partial class ATestBAttrType;
+            internal record ATestBAttr(int Id);
+            """,
+            """
+            using HotChocolate.Types;
+
+            namespace TestNamespace;
+
+            [ObjectType<ATestAAttr>]
+            internal static partial class ATestAAttrType;
+            internal record ATestAAttr(int Id);
+            """,
+            """
+            using HotChocolate.Types;
+
+            namespace TestNamespace;
+
+            internal class ATestBExtType : ObjectTypeExtension<ATestBExt>;
+            internal record ATestBExt(int Id);
+            """,
+            """
+            using HotChocolate.Types;
+
+            namespace TestNamespace;
+
+            internal class ATestAExtType : ObjectTypeExtension<ATestAExt>;
+            internal record ATestAExt(int Id);
+            """,
+            """
+            using HotChocolate.Types;
+
+            namespace TestNamespace;
+
+            [ExtendObjectType<ATestBExtAttr>]
+            internal class ATestBExtAttrType;
+            internal record ATestBExtAttr(int Id);
+            """,
+            """
+            using HotChocolate.Types;
+
+            namespace TestNamespace;
+
+            [ExtendObjectType<ATestAExtAttr>]
+            internal class ATestAExtAttrType;
+            internal record ATestAExtAttr(int Id);
+            """,
+            """
+            using System.Collections.Generic;
+            using System.Threading;
+            using System.Threading.Tasks;
+            using GreenDonut;
+
+            namespace TestNamespace;
+
+            internal class TestBDataLoader(
+                IBatchScheduler batchScheduler,
+                DataLoaderOptions options)
+                : BatchDataLoader<int, object>(batchScheduler, options)
+            {
+                protected override async Task<IReadOnlyDictionary<int, object>> LoadBatchAsync(
+                    IReadOnlyList<int> ids,
+                    CancellationToken cancellationToken)
+                {
+                    return await Task.FromResult(new Dictionary<int, object>());
+                }
+            }
+            """,
+            """
+            using System.Collections.Generic;
+            using System.Threading;
+            using System.Threading.Tasks;
+            using GreenDonut;
+
+            namespace TestNamespace;
+
+            internal class TestADataLoader(
+                IBatchScheduler batchScheduler,
+                DataLoaderOptions options)
+                : BatchDataLoader<int, object>(batchScheduler, options)
+            {
+                protected override async Task<IReadOnlyDictionary<int, object>> LoadBatchAsync(
+                    IReadOnlyList<int> ids,
+                    CancellationToken cancellationToken)
+                {
+                    return await Task.FromResult(new Dictionary<int, object>());
+                }
+            }
+            """,
+            """
+            using System.Collections.Generic;
+            using System.Threading;
+            using System.Threading.Tasks;
+            using GreenDonut;
+
+            namespace TestNamespace;
+
+            internal static class TestBDataLoaderAttr
+            {
+                [DataLoader]
+                public static async Task<IReadOnlyDictionary<int, object>> GetObjectByIdBAsync(
+                    IReadOnlyList<int> ids,
+                    CancellationToken cancellationToken)
+                {
+                    return await Task.FromResult(new Dictionary<int, object>());
+                }
+            }
+            """,
+            """
+            using System.Collections.Generic;
+            using System.Threading;
+            using System.Threading.Tasks;
+            using GreenDonut;
+
+            namespace TestNamespace;
+
+            internal static class TestADataLoaderAttr
+            {
+                [DataLoader]
+                public static async Task<IReadOnlyDictionary<int, object>> GetObjectByIdAAsync(
+                    IReadOnlyList<int> ids,
+                    CancellationToken cancellationToken)
+                {
+                    return await Task.FromResult(new Dictionary<int, object>());
+                }
+            }
+            """
+        ]).MatchMarkdownAsync();
+    }
+}