Skip to content

[release/8.0] Don't generate a discriminator in the snapshot if there's no discriminator property. #33622

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 1, 2024
Merged

[release/8.0] Don't generate a discriminator in the snapshot if there's no discriminator property. #33622

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
97 changes: 50 additions & 47 deletions src/EFCore.Design/Migrations/Design/CSharpSnapshotGenerator.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -886,65 +886,68 @@ protected virtual void GenerateEntityTypeAnnotations(
?? discriminatorValueAnnotation?.Value)
!= null)
{
stringBuilder
.AppendLine()
.Append(entityTypeBuilderName)
.Append('.')
.Append("HasDiscriminator");

var discriminatorProperty = entityType.FindDiscriminatorProperty();
if (discriminatorPropertyAnnotation?.Value != null
&& discriminatorProperty != null)
{
var propertyClrType = FindValueConverter(discriminatorProperty)?.ProviderClrType
.MakeNullable(discriminatorProperty.IsNullable)
?? discriminatorProperty.ClrType;
stringBuilder
.Append('<')
.Append(Code.Reference(propertyClrType))
.Append(">(")
.Append(Code.Literal(discriminatorProperty.Name))
.Append(')');
}
else
if (discriminatorProperty != null)
{
stringBuilder
.Append("()");
}
.AppendLine()
.Append(entityTypeBuilderName)
.Append('.')
.Append("HasDiscriminator");

if (discriminatorMappingCompleteAnnotation?.Value != null)
{
var value = (bool)discriminatorMappingCompleteAnnotation.Value;
if (discriminatorProperty.DeclaringType == entityType
&& discriminatorProperty.Name != "Discriminator")
{
var propertyClrType = FindValueConverter(discriminatorProperty)?.ProviderClrType
.MakeNullable(discriminatorProperty.IsNullable)
?? discriminatorProperty.ClrType;
stringBuilder
.Append('<')
.Append(Code.Reference(propertyClrType))
.Append(">(")
.Append(Code.Literal(discriminatorProperty.Name))
.Append(')');
}
else
{
stringBuilder
.Append("()");
}

stringBuilder
.Append('.')
.Append("IsComplete")
.Append('(')
.Append(Code.Literal(value))
.Append(')');
}
if (discriminatorMappingCompleteAnnotation?.Value != null)
{
var value = (bool)discriminatorMappingCompleteAnnotation.Value;

if (discriminatorValueAnnotation?.Value != null)
{
var value = discriminatorValueAnnotation.Value;
if (discriminatorProperty != null)
stringBuilder
.Append('.')
.Append("IsComplete")
.Append('(')
.Append(Code.Literal(value))
.Append(')');
}

if (discriminatorValueAnnotation?.Value != null)
{
var valueConverter = FindValueConverter(discriminatorProperty);
if (valueConverter != null)
var value = discriminatorValueAnnotation.Value;
if (discriminatorProperty != null)
{
value = valueConverter.ConvertToProvider(value);
var valueConverter = FindValueConverter(discriminatorProperty);
if (valueConverter != null)
{
value = valueConverter.ConvertToProvider(value);
}
}

stringBuilder
.Append('.')
.Append("HasValue")
.Append('(')
.Append(Code.UnknownLiteral(value))
.Append(')');
}

stringBuilder
.Append('.')
.Append("HasValue")
.Append('(')
.Append(Code.UnknownLiteral(value))
.Append(')');
stringBuilder.AppendLine(";");
}

stringBuilder.AppendLine(";");
}

GenerateAnnotations(entityTypeBuilderName, entityType, stringBuilder, annotations, inChainedCall: false);
Expand Down
9 changes: 1 addition & 8 deletions test/EFCore.Design.Tests/Migrations/Design/CSharpMigrationsGeneratorTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,14 +134,7 @@ public void Test_new_annotations_handled_for_entity_types()
},
{
CoreAnnotationNames.DiscriminatorValue, ("MyDiscriminatorValue",
_toTable
+ ";"
+ _nl
+ _nl
+ "entityTypeBuilder.HasDiscriminator"
+ "()."
+ nameof(DiscriminatorBuilder.HasValue)
+ @"(""MyDiscriminatorValue"")")
_toTable)
},
{
RelationalAnnotationNames.Comment, ("My Comment",
Expand Down
113 changes: 106 additions & 7 deletions test/EFCore.Design.Tests/Migrations/ModelSnapshotSqlServerTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -999,6 +999,105 @@ protected override void BuildModel(ModelBuilder modelBuilder)
Assert.Null(humanPetType.GetViewName());
});

[ConditionalFact] // Issue #33605
public virtual void Abstract_base_class_with_TPT()
=> Test(
builder =>
{
builder.Entity<Cat>().ToTable("Cats");
builder.Entity<Dog>().ToTable("Dogs");
builder.Entity<Animal>();
builder.Ignore<Human>();
builder.Ignore<Pet>();
builder.Ignore<Animal>();
},
"""
// <auto-generated />
using Microsoft.EntityFrameworkCore;
using Microsoft.EntityFrameworkCore.Infrastructure;
using Microsoft.EntityFrameworkCore.Metadata;
using Microsoft.EntityFrameworkCore.Storage.ValueConversion;

#nullable disable

namespace RootNamespace
{
[DbContext(typeof(DbContext))]
partial class Snapshot : ModelSnapshot
{
protected override void BuildModel(ModelBuilder modelBuilder)
{
#pragma warning disable 612, 618
modelBuilder
.HasDefaultSchema("DefaultSchema")
.HasAnnotation("Relational:MaxIdentifierLength", 128);

SqlServerModelBuilderExtensions.UseIdentityColumns(modelBuilder);

modelBuilder.Entity("Microsoft.EntityFrameworkCore.Migrations.ModelSnapshotSqlServerTest+Cat", b =>
{
b.Property<int>("Id")
.ValueGeneratedOnAdd()
.HasColumnType("int");

SqlServerPropertyBuilderExtensions.UseIdentityColumn(b.Property<int>("Id"));

b.Property<string>("EducationLevel")
.HasColumnType("nvarchar(max)");

b.Property<string>("Name")
.HasColumnType("nvarchar(max)");

b.Property<string>("Vet")
.HasColumnType("nvarchar(max)");

b.HasKey("Id");

b.ToTable("Cats", "DefaultSchema");
});

modelBuilder.Entity("Microsoft.EntityFrameworkCore.Migrations.ModelSnapshotSqlServerTest+Dog", b =>
{
b.Property<int>("Id")
.ValueGeneratedOnAdd()
.HasColumnType("int");

SqlServerPropertyBuilderExtensions.UseIdentityColumn(b.Property<int>("Id"));

b.Property<string>("FavoriteToy")
.HasColumnType("nvarchar(max)");

b.Property<string>("Name")
.HasColumnType("nvarchar(max)");

b.Property<string>("Vet")
.HasColumnType("nvarchar(max)");

b.HasKey("Id");

b.ToTable("Dogs", "DefaultSchema");
});
#pragma warning restore 612, 618
}
}
}

""",
model =>
{
Assert.Equal(5, model.GetAnnotations().Count());
Assert.Equal(2, model.GetEntityTypes().Count());

var catType = model.FindEntityType("Microsoft.EntityFrameworkCore.Migrations.ModelSnapshotSqlServerTest+Cat");
Assert.Equal("Cats", catType.GetTableName());
Assert.Null(catType.GetViewName());
Assert.Null(catType.FindProperty("Discriminator"));

var dogType = model.FindEntityType("Microsoft.EntityFrameworkCore.Migrations.ModelSnapshotSqlServerTest+Dog");
Assert.Equal("Dogs", dogType.GetTableName());
Assert.Null(dogType.GetViewName());
});

[ConditionalFact]
public virtual void Entity_splitting_is_stored_in_snapshot_with_tables()
=> Test(
Expand Down Expand Up @@ -1678,7 +1777,7 @@ public virtual void CheckConstraint_is_only_stored_in_snapshot_once_for_TPH()

b.ToTable("BaseEntity", "DefaultSchema");

b.HasDiscriminator<string>("Discriminator").HasValue("BaseEntity");
b.HasDiscriminator().HasValue("BaseEntity");

b.UseTphMappingStrategy();
});
Expand Down Expand Up @@ -2011,7 +2110,7 @@ public virtual void BaseType_is_stored_in_snapshot()

b.ToTable("BaseEntity", "DefaultSchema");

b.HasDiscriminator<string>("Discriminator").HasValue("BaseEntity");
b.HasDiscriminator().HasValue("BaseEntity");

b.UseTphMappingStrategy();
});
Expand Down Expand Up @@ -2082,7 +2181,7 @@ public virtual void Discriminator_annotations_are_stored_in_snapshot()

b.ToTable("BaseEntity", "DefaultSchema");

b.HasDiscriminator<string>("Discriminator").IsComplete(true).HasValue("BaseEntity");
b.HasDiscriminator().IsComplete(true).HasValue("BaseEntity");

b.UseTphMappingStrategy();
});
Expand Down Expand Up @@ -2158,7 +2257,7 @@ public virtual void Converted_discriminator_annotations_are_stored_in_snapshot()

b.ToTable("BaseEntityWithStructDiscriminator", "DefaultSchema");

b.HasDiscriminator<string>("Discriminator").IsComplete(true).HasValue("Base");
b.HasDiscriminator().IsComplete(true).HasValue("Base");

b.UseTphMappingStrategy();
});
Expand Down Expand Up @@ -4614,7 +4713,7 @@ public virtual void Property_column_name_is_stored_in_snapshot_when_DefaultColum

b.ToTable("BarBase", "DefaultSchema");

b.HasDiscriminator<string>("Discriminator").HasValue("BarBase");
b.HasDiscriminator().HasValue("BarBase");

b.UseTphMappingStrategy();
});
Expand Down Expand Up @@ -4830,7 +4929,7 @@ public virtual void Property_column_name_on_specific_table_is_stored_in_snapshot

b.ToTable("BaseEntity", "DefaultSchema");

b.HasDiscriminator<string>("Discriminator").HasValue("BaseEntity");
b.HasDiscriminator().HasValue("BaseEntity");

b.UseTphMappingStrategy();
});
Expand Down Expand Up @@ -7090,7 +7189,7 @@ public virtual void Do_not_generate_entity_type_builder_again_if_no_foreign_key_

b.ToTable("BaseType", "DefaultSchema");

b.HasDiscriminator<string>("Discriminator").HasValue("BaseType");
b.HasDiscriminator().HasValue("BaseType");

b.UseTphMappingStrategy();
});
Expand Down