Compile time check to forbid return IEnumerator from relations.

Author: Bobris

BTDB.SourceGenerator.Test/RelationTests.VerifyThatIEnumerableIsOk#IUserNoticeTable.g.verified.cs

@@ -0,0 +1,20 @@
+//HintName: IUserNoticeTable.g.cs
+// <auto-generated/>
+#pragma warning disable 612,618
+#nullable enable
+using System;
+using System.Runtime.CompilerServices;
+// Name: IUserNoticeTable
+// Field: UserId ulong
+//           PrimaryIndex: 1
+// Field: NoticeId ulong
+//           PrimaryIndex: 2
+//           SecondaryIndex NoticeId: 0
+[CompilerGenerated]
+static file class IUserNoticeTableRegistration
+{
+    [ModuleInitializer]
+    internal static unsafe void Register4BTDB()
+    {
+    }
+}

BTDB.SourceGenerator.Test/RelationTests.VerifyThatIEnumerableIsOk#UserNotice.g.verified.cs

@@ -0,0 +1,51 @@
+//HintName: UserNotice.g.cs
+// <auto-generated/>
+#pragma warning disable 612,618
+using System;
+using System.Runtime.CompilerServices;
+
+[CompilerGenerated]
+static file class UserNoticeRegistration
+{
+    [UnsafeAccessor(UnsafeAccessorKind.Constructor)]
+    extern static global::UserNotice Creator();
+    [UnsafeAccessor(UnsafeAccessorKind.Field, Name = "<UserId>k__BackingField")]
+    extern static ref ulong Field1(global::UserNotice @this);
+    [UnsafeAccessor(UnsafeAccessorKind.Field, Name = "<NoticeId>k__BackingField")]
+    extern static ref ulong Field2(global::UserNotice @this);
+    [ModuleInitializer]
+    internal static unsafe void Register4BTDB()
+    {
+        global::BTDB.IOC.IContainer.RegisterFactory(typeof(global::UserNotice), (container, ctx) =>
+        {
+            return (container2, ctx2) =>
+            {
+                var res = new global::UserNotice();
+                return res;
+            };
+        });
+        var metadata = new global::BTDB.Serialization.ClassMetadata();
+        metadata.Name = "UserNotice";
+        metadata.Type = typeof(global::UserNotice);
+        metadata.Namespace = "";
+        metadata.Implements = [];
+        metadata.Creator = &Creator;
+        var dummy = Unsafe.As<global::UserNotice>(metadata);
+        metadata.Fields = new global::BTDB.Serialization.FieldMetadata[]
+        {
+            new global::BTDB.Serialization.FieldMetadata
+            {
+                Name = "UserId",
+                Type = typeof(ulong),
+                ByteOffset = global::BTDB.Serialization.RawData.CalcOffset(dummy, ref Field1(dummy)),
+            },
+            new global::BTDB.Serialization.FieldMetadata
+            {
+                Name = "NoticeId",
+                Type = typeof(ulong),
+                ByteOffset = global::BTDB.Serialization.RawData.CalcOffset(dummy, ref Field2(dummy)),
+            },
+        };
+        global::BTDB.Serialization.ReflectionMetadata.Register(metadata);
+    }
+}

BTDB.SourceGenerator.Test/RelationTests.VerifyThatIEnumeratorIsError.verified.txt

@@ -0,0 +1,23 @@
+{
+  Diagnostics: [
+    {
+      Location: /*
+    void Insert(UserNotice un);
+    IEnumerator<UserNotice> ListByNoticeId(AdvancedEnumeratorParam<ulong> noticeId);
+                            ^^^^^^^^^^^^^^
+}
+*/
+ : (16,28)-(16,42),
+      Message: Cannot use IEnumerator<> as return type in ListByNoticeId,
+      Severity: Error,
+      Descriptor: {
+        Id: BTDB0009,
+        Title: Cannot use IEnumerator<> as return type in ListByNoticeId,
+        MessageFormat: Cannot use IEnumerator<> as return type in ListByNoticeId,
+        Category: BTDB,
+        DefaultSeverity: Error,
+        IsEnabledByDefault: true
+      }
+    }
+  ]
+}

BTDB.SourceGenerator.Test/RelationTests.VerifyThatTwoSecondaryKeysCannotHaveSameOrder.verified.txt

@@ -11,7 +11,7 @@ public interface IPersonTable : IRelation<Person>
       Message: Cannot have multiple SecondaryKey with same order in S1Also as in S1,
       Severity: Error,
       Descriptor: {
-        Id: BTDB0007,
+        Id: BTDB0008,
         Title: Cannot have multiple SecondaryKey with same order in S1Also as in S1,
         MessageFormat: Cannot have multiple SecondaryKey with same order in S1Also as in S1,
         Category: BTDB,

BTDB.SourceGenerator.Test/RelationTests.cs

@@ -190,4 +190,58 @@ public interface IPersonTable : IRelation<Person>
 
             """);
     }
+
+    [Fact]
+    public Task VerifyThatIEnumerableIsOk()
+    {
+        // language=cs
+        return VerifySourceGenerator("""
+            using System.Collections.Generic;
+            using BTDB.ODBLayer;
+
+            public class UserNotice
+            {
+                [PrimaryKey(1)] public ulong UserId { get; set; }
+
+                [PrimaryKey(2)]
+                [SecondaryKey("NoticeId")]
+                public ulong NoticeId { get; set; }
+            }
+
+            [PersistedName("UserNotice")]
+            public interface IUserNoticeTable : IRelation<UserNotice>
+            {
+                void Insert(UserNotice un);
+                IEnumerable<UserNotice> ListByNoticeId(AdvancedEnumeratorParam<ulong> noticeId);
+            }
+
+            """);
+    }
+
+    [Fact]
+    public Task VerifyThatIEnumeratorIsError()
+    {
+        // language=cs
+        return VerifySourceGenerator("""
+            using System.Collections.Generic;
+            using BTDB.ODBLayer;
+
+            public class UserNotice
+            {
+                [PrimaryKey(1)] public ulong UserId { get; set; }
+
+                [PrimaryKey(2)]
+                [SecondaryKey("NoticeId")]
+                public ulong NoticeId { get; set; }
+            }
+
+            [PersistedName("UserNotice")]
+            public interface IUserNoticeTable : IRelation<UserNotice>
+            {
+                void Insert(UserNotice un);
+                IEnumerator<UserNotice> ListByNoticeId(AdvancedEnumeratorParam<ulong> noticeId);
+            }
+
+            """);
+    }
 }

BTDB.SourceGenerator/Main.cs

@@ -149,6 +149,27 @@ public void Initialize(IncrementalGeneratorInitializationContext context)
                             if (generationInfo is not { GenType: GenerationType.Class }) return null;
                             var detectedError = DetectErrors(generationInfo.Fields.AsSpan(),
                                 ((InterfaceDeclarationSyntax)syntaxContext.Node).Identifier.GetLocation());
+                            // Get all methods
+                            var methods = symbol.GetMembers().OfType<IMethodSymbol>().ToArray();
+                            foreach (var method in methods)
+                            {
+                                if (method.ReturnType.TypeKind == TypeKind.Interface)
+                                {
+                                    // Check is return type is IEnumerator<>
+                                    if (method.ReturnType.OriginalDefinition.SpecialType ==
+                                        SpecialType.System_Collections_Generic_IEnumerator_T)
+                                    {
+                                        return GenerationError("BTDB0009",
+                                            "Cannot use IEnumerator<> as return type in " + method.Name,
+                                            method.Locations[0]);
+                                    }
+                                }
+                            }
+
+                            // Get method return types and skip void
+                            var methodReturnTypes = methods.Select(m => m.ReturnType)
+                                .Where(t => t.SpecialType != SpecialType.System_Void).ToArray();
+
                             if (detectedError != null)
                                 return detectedError;
                             return new(GenerationType.RelationIface, namespaceName, interfaceName,
@@ -364,7 +385,7 @@ public void Initialize(IncrementalGeneratorInitializationContext context)
 
                 if (order2Index.ContainsKey(index.Order))
                 {
-                    return GenerationError("BTDB0007",
+                    return GenerationError("BTDB0008",
                         "Cannot have multiple SecondaryKey with same order in " + f.Name + " as in " +
                         fields[order2Index[index.Order]].Name, location);
                 }

BTDBTest/ObjectDbTableTest.cs

@@ -1533,7 +1533,7 @@ public interface IProductionInvalidTable : IRelation<ProductionTrackingDaily>
         {
             void Insert(ProductionTrackingDaily productionTrackingDaily);
 
-            IEnumerator<ProductionTrackingDaily> FindByProductionDateWithCompanyId(ulong companyId,
+            IEnumerable<ProductionTrackingDaily> FindByProductionDateWithCompanyId(ulong companyId,
                 AdvancedEnumeratorParam<DateTime> productionDate);
         }
 
@@ -1950,7 +1950,7 @@ public override int GetHashCode()
         public interface IPersonTableSuperfluousParameter : IRelation<Person>
         {
             void Insert(Person person);
-            IEnumerator<Person> ListByName(ulong tenantId, string name, AdvancedEnumeratorParam<int> param);
+            IEnumerable<Person> ListByName(ulong tenantId, string name, AdvancedEnumeratorParam<int> param);
         }
 
         [Fact]
@@ -1965,7 +1965,7 @@ public void ReportErrorForSuperfluousMethodParameter()
         public interface IPersonTableWrongTypeParameter : IRelation<Person>
         {
             void Insert(Person person);
-            IEnumerator<Person> ListByName(ulong tenantId, AdvancedEnumeratorParam<int> param);
+            IEnumerable<Person> ListByName(ulong tenantId, AdvancedEnumeratorParam<int> param);
         }
 
         [Fact]