Don't generate Fluent API in model snapshot for certain annotations

Temporary fix for 5.0. Fixes #23456
dotnet · Jan 11, 2021 · 25ab6f9 · 25ab6f9
1 parent 4149be5
commit 25ab6f9
Show file tree

Hide file tree

Showing 2 changed files with 220 additions and 123 deletions.
diff --git a/src/EFCore.Design/Migrations/Design/CSharpSnapshotGenerator.cs b/src/EFCore.Design/Migrations/Design/CSharpSnapshotGenerator.cs
@@ -3,6 +3,7 @@
 
 using System;
 using System.Collections.Generic;
+using System.Collections.Immutable;
 using System.Linq;
 using JetBrains.Annotations;
 using Microsoft.EntityFrameworkCore.Design;
@@ -64,6 +65,16 @@ public virtual void Generate(string builderName, IModel model, IndentedStringBui
 
                 using (stringBuilder.Indent())
                 {
+                    // Temporary patch: specifically exclude some annotations which are known to produce identical Fluent API calls across different
+                    // providers, generating them as raw annotations instead.
+                    var ambiguousAnnotations = RemoveAmbiguousFluentApiAnnotations(
+                        annotations,
+                        name => name.EndsWith(":ValueGenerationStrategy", StringComparison.Ordinal)
+                            || name.EndsWith(":IdentityIncrement", StringComparison.Ordinal)
+                            || name.EndsWith(":IdentitySeed", StringComparison.Ordinal)
+                            || name.EndsWith(":HiLoSequenceName", StringComparison.Ordinal)
+                            || name.EndsWith(":HiLoSequenceSchema", StringComparison.Ordinal));
+
                     foreach (var methodCallCodeFragment in
                         Dependencies.AnnotationCodeGenerator.GenerateFluentApiCalls(model, annotations))
                     {
@@ -79,7 +90,7 @@ public virtual void Generate(string builderName, IModel model, IndentedStringBui
                             new Annotation(CoreAnnotationNames.ProductVersion, productVersion));
                     }
 
-                    GenerateAnnotations(remainingAnnotations, stringBuilder);
+                    GenerateAnnotations(remainingAnnotations.Concat(ambiguousAnnotations), stringBuilder);
                 }
 
                 stringBuilder.AppendLine(";");
@@ -574,6 +585,16 @@ protected virtual void GeneratePropertyAnnotations([NotNull] IProperty property,
             GenerateFluentApiForDefaultValue(property, stringBuilder);
             annotations.Remove(RelationalAnnotationNames.DefaultValue);
 
+            // Temporary patch: specifically exclude some annotations which are known to produce identical Fluent API calls across different
+            // providers, generating them as raw annotations instead.
+            var ambiguousAnnotations = RemoveAmbiguousFluentApiAnnotations(
+                annotations,
+                name => name.EndsWith(":ValueGenerationStrategy", StringComparison.Ordinal)
+                    || name.EndsWith(":IdentityIncrement", StringComparison.Ordinal)
+                    || name.EndsWith(":IdentitySeed", StringComparison.Ordinal)
+                    || name.EndsWith(":HiLoSequenceName", StringComparison.Ordinal)
+                    || name.EndsWith(":HiLoSequenceSchema", StringComparison.Ordinal));
+
             foreach (var methodCallCodeFragment in
                 Dependencies.AnnotationCodeGenerator.GenerateFluentApiCalls(property, annotations))
             {
@@ -582,7 +603,7 @@ protected virtual void GeneratePropertyAnnotations([NotNull] IProperty property,
                     .Append(Code.Fragment(methodCallCodeFragment));
             }
 
-            GenerateAnnotations(annotations.Values, stringBuilder);
+            GenerateAnnotations(annotations.Values.Concat(ambiguousAnnotations), stringBuilder);
         }
 
         private ValueConverter FindValueConverter(IProperty property)
@@ -765,6 +786,12 @@ protected virtual void GenerateIndexAnnotations(
                 .FilterIgnoredAnnotations(index.GetAnnotations())
                 .ToDictionary(a => a.Name, a => a);
 
+            // Temporary patch: specifically exclude some annotations which are known to produce identical Fluent API calls across different
+            // providers, generating them as raw annotations instead.
+            var ambiguousAnnotations = RemoveAmbiguousFluentApiAnnotations(
+                annotations,
+                name => name.EndsWith(":Include", StringComparison.Ordinal));
+
             foreach (var methodCallCodeFragment in
                 Dependencies.AnnotationCodeGenerator.GenerateFluentApiCalls(index, annotations))
             {
@@ -773,7 +800,7 @@ protected virtual void GenerateIndexAnnotations(
                     .Append(Code.Fragment(methodCallCodeFragment));
             }
 
-            GenerateAnnotations(annotations.Values, stringBuilder);
+            GenerateAnnotations(annotations.Values.Concat(ambiguousAnnotations), stringBuilder);
         }
 
         /// <summary>
@@ -1565,5 +1592,24 @@ private void GenerateFluentApiForDefaultValue(
             stringBuilder
                 .Append(")");
         }
+
+        private static IReadOnlyList<IAnnotation> RemoveAmbiguousFluentApiAnnotations(
+            Dictionary<string, IAnnotation> annotations,
+            Func<string, bool> annotationNameMatcher)
+        {
+            List<IAnnotation> ambiguousAnnotations = null;
+
+            foreach (var (name, annotation) in annotations)
+            {
+                if (annotationNameMatcher(name))
+                {
+                    annotations.Remove(name);
+                    ambiguousAnnotations ??= new List<IAnnotation>();
+                    ambiguousAnnotations.Add(annotation);
+                }
+            }
+
+            return (IReadOnlyList<IAnnotation>)ambiguousAnnotations ?? ImmutableList<IAnnotation>.Empty;
+        }
     }
 }