fix: existing target unmapped required member should not lead to erro…

…r diagnostic
riok · Oct 31, 2024 · 832cb08 · 832cb08
1 parent f72d1b1
commit 832cb08
Show file tree

Hide file tree

Showing 7 changed files with 40 additions and 13 deletions.
diff --git a/...apperly/Descriptors/MappingBodyBuilders/BuilderContext/MemberMappingDiagnosticReporter.cs b/...apperly/Descriptors/MappingBodyBuilders/BuilderContext/MemberMappingDiagnosticReporter.cs
@@ -5,11 +5,11 @@ namespace Riok.Mapperly.Descriptors.MappingBodyBuilders.BuilderContext;
 
 internal static class MemberMappingDiagnosticReporter
 {
-    public static void ReportDiagnostics(MappingBuilderContext ctx, MembersMappingState state)
+    public static void ReportDiagnostics(MappingBuilderContext ctx, MembersMappingState state, bool requiredMembersNeedToBeMapped)
     {
         AddUnusedTargetMembersDiagnostics(ctx, state);
         AddUnmappedSourceMembersDiagnostics(ctx, state);
-        AddUnmappedTargetMembersDiagnostics(ctx, state);
+        AddUnmappedTargetMembersDiagnostics(ctx, state, requiredMembersNeedToBeMapped);
         AddUnmappedAdditionalSourceMembersDiagnostics(ctx, state);
         AddNoMemberMappedDiagnostic(ctx, state);
     }
@@ -33,11 +33,15 @@ private static void AddUnmappedSourceMembersDiagnostics(MappingBuilderContext ct
         }
     }
 
-    private static void AddUnmappedTargetMembersDiagnostics(MappingBuilderContext ctx, MembersMappingState state)
+    private static void AddUnmappedTargetMembersDiagnostics(
+        MappingBuilderContext ctx,
+        MembersMappingState state,
+        bool requiredMembersNeedToBeMapped
+    )
     {
         foreach (var targetMember in state.EnumerateUnmappedTargetMembers())
         {
-            if (targetMember.IsRequired)
+            if (targetMember.IsRequired && requiredMembersNeedToBeMapped)
             {
                 ctx.ReportDiagnostic(DiagnosticDescriptors.RequiredMemberNotMapped, targetMember.Name, ctx.Target, ctx.Source);
                 continue;

diff --git a/...k.Mapperly/Descriptors/MappingBodyBuilders/BuilderContext/MembersMappingBuilderContext.cs b/...k.Mapperly/Descriptors/MappingBodyBuilders/BuilderContext/MembersMappingBuilderContext.cs
@@ -24,9 +24,9 @@ public abstract class MembersMappingBuilderContext<T>(MappingBuilderContext buil
 
     public T Mapping { get; } = mapping;
 
-    public void AddDiagnostics()
+    public void AddDiagnostics(bool requiredMembersNeedToBeMapped)
     {
-        MemberMappingDiagnosticReporter.ReportDiagnostics(BuilderContext, _state);
+        MemberMappingDiagnosticReporter.ReportDiagnostics(BuilderContext, _state, requiredMembersNeedToBeMapped);
         _nestedMappingsContext.ReportDiagnostics();
     }
 

diff --git a/src/Riok.Mapperly/Descriptors/MappingBodyBuilders/EnumerableMappingBodyBuilder.cs b/src/Riok.Mapperly/Descriptors/MappingBodyBuilders/EnumerableMappingBodyBuilder.cs
@@ -25,7 +25,7 @@ public static void BuildMappingBody(MappingBuilderContext ctx, INewInstanceEnume
         BuildConstructorMapping(mappingCtx);
         NewInstanceObjectMemberMappingBodyBuilder.BuildInitMemberMappings(mappingCtx);
         ObjectMemberMappingBodyBuilder.BuildMappingBody(mappingCtx);
-        mappingCtx.AddDiagnostics();
+        mappingCtx.AddDiagnostics(true);
     }
 
     public static void BuildMappingBody(MappingBuilderContext ctx, IEnumerableMapping mapping)
@@ -45,7 +45,7 @@ public static void BuildMappingBody(MappingBuilderContext ctx, IEnumerableMappin
         }
 
         ObjectMemberMappingBodyBuilder.BuildMappingBody(mappingCtx);
-        mappingCtx.AddDiagnostics();
+        mappingCtx.AddDiagnostics(false);
     }
 
     private static void InitContext<T>(MembersMappingBuilderContext<T> ctx)

diff --git a/...iok.Mapperly/Descriptors/MappingBodyBuilders/NewInstanceObjectMemberMappingBodyBuilder.cs b/...iok.Mapperly/Descriptors/MappingBodyBuilders/NewInstanceObjectMemberMappingBodyBuilder.cs
@@ -20,7 +20,7 @@ public static void BuildMappingBody(MappingBuilderContext ctx, NewInstanceObject
         var mappingCtx = new NewInstanceBuilderContext<NewInstanceObjectMemberMapping>(ctx, mapping);
         BuildConstructorMapping(mappingCtx);
         BuildInitMemberMappings(mappingCtx, true);
-        mappingCtx.AddDiagnostics();
+        mappingCtx.AddDiagnostics(true);
     }
 
     public static void BuildMappingBody(MappingBuilderContext ctx, NewInstanceObjectMemberMethodMapping mapping)
@@ -29,7 +29,7 @@ public static void BuildMappingBody(MappingBuilderContext ctx, NewInstanceObject
         BuildConstructorMapping(mappingCtx);
         BuildInitMemberMappings(mappingCtx);
         ObjectMemberMappingBodyBuilder.BuildMappingBody(mappingCtx);
-        mappingCtx.AddDiagnostics();
+        mappingCtx.AddDiagnostics(true);
     }
 
     public static IReadOnlyList<ConstructorParameterMapping> BuildConstructorMapping(

diff --git a/src/Riok.Mapperly/Descriptors/MappingBodyBuilders/NewValueTupleMappingBodyBuilder.cs b/src/Riok.Mapperly/Descriptors/MappingBodyBuilders/NewValueTupleMappingBodyBuilder.cs
@@ -14,15 +14,15 @@ public static void BuildMappingBody(MappingBuilderContext ctx, NewValueTupleCons
     {
         var mappingCtx = new NewValueTupleConstructorBuilderContext<NewValueTupleConstructorMapping>(ctx, expressionMapping);
         BuildTupleConstructorMapping(mappingCtx);
-        mappingCtx.AddDiagnostics();
+        mappingCtx.AddDiagnostics(true);
     }
 
     public static void BuildMappingBody(MappingBuilderContext ctx, NewValueTupleExpressionMapping expressionMapping)
     {
         var mappingCtx = new NewValueTupleExpressionBuilderContext<NewValueTupleExpressionMapping>(ctx, expressionMapping);
         BuildTupleConstructorMapping(mappingCtx);
         ObjectMemberMappingBodyBuilder.BuildMappingBody(mappingCtx);
-        mappingCtx.AddDiagnostics();
+        mappingCtx.AddDiagnostics(true);
     }
 
     private static void BuildTupleConstructorMapping(INewValueTupleBuilderContext<INewValueTupleMapping> ctx)

diff --git a/src/Riok.Mapperly/Descriptors/MappingBodyBuilders/ObjectMemberMappingBodyBuilder.cs b/src/Riok.Mapperly/Descriptors/MappingBodyBuilders/ObjectMemberMappingBodyBuilder.cs
@@ -26,7 +26,7 @@ public static void BuildMappingBody(MappingBuilderContext ctx, IMemberAssignment
         // do not report "no member mapping" for existing target mappings
         mappingCtx.MappingAdded();
 
-        mappingCtx.AddDiagnostics();
+        mappingCtx.AddDiagnostics(false);
     }
 
     public static void BuildMappingBody(IMembersContainerBuilderContext<IMemberAssignmentTypeMapping> ctx)

diff --git a/test/Riok.Mapperly.Tests/Mapping/ObjectPropertyExistingInstanceTest.cs b/test/Riok.Mapperly.Tests/Mapping/ObjectPropertyExistingInstanceTest.cs
@@ -168,4 +168,27 @@ public class B
                 """
             );
     }
+
+    [Fact]
+    public Task UnmappedRequiredPropertyShouldDiagnostic()
+    {
+        var source = TestSourceBuilder.MapperWithBodyAndTypes(
+            "public partial void Update(A source, B target);",
+            """
+            public class A
+            {
+                public required string Value { get; set; }
+                public required string OtherValue { get; set; }
+            }
+            """,
+            """
+            public class B
+            {
+                public required string Value2 { get; set; }
+                public required string OtherValue { get; set; }
+            }
+            """
+        );
+        return TestHelper.VerifyGenerator(source);
+    }
 }