Skip to content

Commit

Permalink
Add support for optional complex types to model building
Browse files Browse the repository at this point in the history 
Part of #31376
  • Loading branch information
@AndriySvyryd
AndriySvyryd committed Feb 11, 2025
1 parent 028980e commit 64afeec
Show file tree
Hide file tree
Showing 27 changed files with 534 additions and 361 deletions.
6 changes: 3 additions & 3 deletions src/EFCore.Relational/Design/Internal/RelationalCSharpRuntimeAnnotationCodeGenerator.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1498,7 +1498,7 @@ public virtual void Generate(IStoredProcedureMapping sprocMapping, CSharpRuntime
private void GenerateAddMapping(
ITableMappingBase tableMapping,
string tableVariable,
string entityTypeVariable,
string structuralTypeVariable,
string tableMappingsVariable,
string tableMappingVariable,
string mappingType,
Expand All @@ -1510,7 +1510,7 @@ private void GenerateAddMapping(
var typeBase = tableMapping.TypeBase;

mainBuilder
.Append($"var {tableMappingVariable} = new {mappingType}({entityTypeVariable}, ")
.Append($"var {tableMappingVariable} = new {mappingType}({structuralTypeVariable}, ")
.Append($"{tableVariable}, {additionalParameter ?? ""}{code.Literal(tableMapping.IncludesDerivedTypes)}");

if (tableMapping.IsSharedTablePrincipal.HasValue
Expand Down Expand Up @@ -1549,7 +1549,7 @@ private void GenerateAddMapping(
foreach (var internalForeignKey in table.GetRowInternalForeignKeys(entityType))
{
mainBuilder
.Append(tableVariable).Append($".AddRowInternalForeignKey({entityTypeVariable}, ")
.Append(tableVariable).Append($".AddRowInternalForeignKey({structuralTypeVariable}, ")
.AppendLine("RelationalModel.GetForeignKey(this,").IncrementIndent()
.AppendLine($"{code.Literal(internalForeignKey.DeclaringEntityType.Name)},")
.AppendLine($"{code.Literal(internalForeignKey.Properties.Select(p => p.Name).ToArray())},")
Expand Down
82 changes: 56 additions & 26 deletions src/EFCore.Relational/Extensions/RelationalPropertyExtensions.cs
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

using System.Diagnostics.CodeAnalysis;
using System.Globalization;
using System.Runtime.CompilerServices;
using System.Text;
Expand Down Expand Up @@ -230,21 +231,54 @@ public static string GetDefaultColumnName(this IReadOnlyProperty property)
StringBuilder? builder = null;
var currentStoreObject = storeObject;
if (property.DeclaringType is IReadOnlyEntityType entityType)
{
builder = CreateOwnershipPrefix(entityType, storeObject, builder);
}
else if (StoreObjectIdentifier.Create(property.DeclaringType, currentStoreObject.StoreObjectType) == currentStoreObject
|| property.DeclaringType.GetMappingFragments(storeObject.StoreObjectType)
.Any(f => f.StoreObject == currentStoreObject))
{
builder = CreateComplexPrefix((IReadOnlyComplexType)property.DeclaringType, storeObject, builder);
}

var baseName = storeObject.StoreObjectType == StoreObjectType.Table ? property.GetDefaultColumnName() : property.Name;
if (builder == null)
{
return baseName;
}

builder.Append(baseName);
baseName = builder.ToString();

return Uniquifier.Truncate(baseName, property.DeclaringType.Model.GetMaxIdentifierLength());

[return: NotNullIfNotNull("builder")]
static StringBuilder? CreateOwnershipPrefix(IReadOnlyEntityType entityType, in StoreObjectIdentifier storeObject, StringBuilder? builder)
{
while (true)
{
var ownership = entityType.GetForeignKeys().SingleOrDefault(fk => fk.IsOwnership);
if (ownership == null)
{
break;
return builder;
}

var ownerType = ownership.PrincipalEntityType;
if (StoreObjectIdentifier.Create(ownerType, currentStoreObject.StoreObjectType) != currentStoreObject
&& ownerType.GetMappingFragments(storeObject.StoreObjectType)
.All(f => f.StoreObject != currentStoreObject))
if (StoreObjectIdentifier.Create(ownerType, storeObject.StoreObjectType) != storeObject)
{
break;
var foundMappedFragment = false;
foreach (var fragment in ownerType.GetMappingFragments(storeObject.StoreObjectType))
{
if (fragment.StoreObject == storeObject)
{
foundMappedFragment = true;
}
}

if (!foundMappedFragment)
{
return builder;
}
}

builder ??= new StringBuilder();
Expand All @@ -254,31 +288,27 @@ public static string GetDefaultColumnName(this IReadOnlyProperty property)
entityType = ownerType;
}
}
else if (StoreObjectIdentifier.Create(property.DeclaringType, currentStoreObject.StoreObjectType) == currentStoreObject
|| property.DeclaringType.GetMappingFragments(storeObject.StoreObjectType)
.Any(f => f.StoreObject == currentStoreObject))

static StringBuilder CreateComplexPrefix(IReadOnlyComplexType complexType, in StoreObjectIdentifier storeObject, StringBuilder? builder)
{
var complexType = (IReadOnlyComplexType)property.DeclaringType;
builder ??= new StringBuilder();
while (complexType != null)
while (true)
{
builder.Insert(0, "_");
builder.Insert(0, complexType.ComplexProperty.Name);

complexType = complexType.ComplexProperty.DeclaringType as IReadOnlyComplexType;
switch (complexType.ComplexProperty.DeclaringType)
{
case IReadOnlyComplexType declaringComplexType:
complexType = declaringComplexType;
break;
case IReadOnlyEntityType declaringEntityType:
return CreateOwnershipPrefix(declaringEntityType, storeObject, builder);
default:
return builder;
}
}
}

var baseName = storeObject.StoreObjectType == StoreObjectType.Table ? property.GetDefaultColumnName() : property.Name;
if (builder == null)
{
return baseName;
}

builder.Append(baseName);
baseName = builder.ToString();

return Uniquifier.Truncate(baseName, property.DeclaringType.Model.GetMaxIdentifierLength());
}

/// <summary>
Expand Down Expand Up @@ -1501,13 +1531,13 @@ public static RelationalTypeMapping GetRelationalTypeMapping(this IReadOnlyPrope
}

IReadOnlyProperty? linkedProperty = null;
foreach (var p in entityType
foreach (var principalProperty in entityType
.FindRowInternalForeignKeys(storeObject)
.SelectMany(fk => fk.PrincipalEntityType.GetProperties()))
.SelectMany(static fk => fk.PrincipalEntityType.GetProperties()))
{
if (p.GetColumnName(storeObject) == column)
if (principalProperty.GetColumnName(storeObject) == column)
{
linkedProperty = p;
linkedProperty = principalProperty;
break;
}
}
Expand Down
108 changes: 65 additions & 43 deletions src/EFCore.Relational/Infrastructure/RelationalModelValidator.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,22 @@ static void ValidateType(ITypeBase typeBase)
}
}

/// <inheritdoc/>
protected override void ValidatePropertyMapping(IConventionComplexProperty complexProperty)
{
base.ValidatePropertyMapping(complexProperty);

var typeBase = complexProperty.DeclaringType;

if (!typeBase.IsMappedToJson()
&& complexProperty.IsNullable
&& complexProperty.ComplexType.GetProperties().All(m => m.IsNullable))
{
throw new InvalidOperationException(
RelationalStrings.ComplexPropertyOptionalTableSharing(typeBase.DisplayName(), complexProperty.Name));
}
}

/// <summary>
/// Validates the mapping/configuration of SQL queries in the model.
/// </summary>
Expand Down Expand Up @@ -1239,16 +1255,56 @@ protected virtual void ValidateSharedColumnsCompatibility(
if (missingConcurrencyTokens != null)
{
missingConcurrencyTokens.Clear();
foreach (var (key, readOnlyProperties) in concurrencyColumns!)
foreach (var (concurrencyColumn, concurrencyProperties) in concurrencyColumns!)
{
if (TableSharingConcurrencyTokenConvention.IsConcurrencyTokenMissing(readOnlyProperties, entityType, mappedTypes))
if (TableSharingConcurrencyTokenConvention.IsConcurrencyTokenMissing(concurrencyProperties, entityType, mappedTypes))
{
missingConcurrencyTokens.Add(key);
missingConcurrencyTokens.Add(concurrencyColumn);
}
}
}

foreach (var property in entityType.GetDeclaredProperties())
ValidateCompatible(entityType, storeObject, propertyMappings, missingConcurrencyTokens, logger);

if (missingConcurrencyTokens != null)
{
foreach (var concurrencyColumn in missingConcurrencyTokens)
{
throw new InvalidOperationException(
RelationalStrings.MissingConcurrencyColumn(
entityType.DisplayName(), concurrencyColumn, storeObject.DisplayName()));
}
}
}

var columnOrders = new Dictionary<int, List<string>>();
foreach (var property in propertyMappings.Values)
{
var columnOrder = property.GetColumnOrder(storeObject);
if (!columnOrder.HasValue)
{
continue;
}

var columns = columnOrders.GetOrAddNew(columnOrder.Value);
columns.Add(property.GetColumnName(storeObject)!);
}

if (columnOrders.Any(g => g.Value.Count > 1))
{
logger.DuplicateColumnOrders(
storeObject,
columnOrders.Where(g => g.Value.Count > 1).SelectMany(g => g.Value).ToList());
}

void ValidateCompatible(
ITypeBase structuralType,
in StoreObjectIdentifier storeObject,
Dictionary<string, IProperty> propertyMappings,
HashSet<string>? missingConcurrencyTokens,
IDiagnosticsLogger<DbLoggerCategory.Model.Validation> logger)
{
foreach (var property in structuralType.GetDeclaredProperties())
{
var columnName = property.GetColumnName(storeObject);
if (columnName == null)
Expand Down Expand Up @@ -1276,39 +1332,14 @@ protected virtual void ValidateSharedColumnsCompatibility(
storeObject.DisplayName()));
}

ValidateCompatible(property, duplicateProperty, columnName, storeObject, logger);
this.ValidateCompatible(property, duplicateProperty, columnName, storeObject, logger);
}

if (missingConcurrencyTokens != null)
foreach (var complexProperty in structuralType.GetDeclaredComplexProperties())
{
foreach (var missingColumn in missingConcurrencyTokens)
{
throw new InvalidOperationException(
RelationalStrings.MissingConcurrencyColumn(
entityType.DisplayName(), missingColumn, storeObject.DisplayName()));
}
ValidateCompatible(complexProperty.ComplexType, storeObject, propertyMappings, missingConcurrencyTokens, logger);
}
}

var columnOrders = new Dictionary<int, List<string>>();
foreach (var property in propertyMappings.Values)
{
var columnOrder = property.GetColumnOrder(storeObject);
if (!columnOrder.HasValue)
{
continue;
}

var columns = columnOrders.GetOrAddNew(columnOrder.Value);
columns.Add(property.GetColumnName(storeObject)!);
}

if (columnOrders.Any(g => g.Value.Count > 1))
{
logger.DuplicateColumnOrders(
storeObject,
columnOrders.Where(g => g.Value.Count > 1).SelectMany(g => g.Value).ToList());
}
}

/// <summary>
Expand All @@ -1326,18 +1357,9 @@ protected virtual void ValidateCompatible(
in StoreObjectIdentifier storeObject,
IDiagnosticsLogger<DbLoggerCategory.Model.Validation> logger)
{
if (property.IsColumnNullable(storeObject) != duplicateProperty.IsColumnNullable(storeObject))
{
throw new InvalidOperationException(
RelationalStrings.DuplicateColumnNameNullabilityMismatch(
duplicateProperty.DeclaringType.DisplayName(),
duplicateProperty.Name,
property.DeclaringType.DisplayName(),
property.Name,
columnName,
storeObject.DisplayName()));
}
// NB: Properties can have different nullability, the resulting column will be non-nullable if any of the properties is non-nullable

// TODO: allow conflicts if one of them is null
var currentMaxLength = property.GetMaxLength(storeObject);
var previousMaxLength = duplicateProperty.GetMaxLength(storeObject);
if (currentMaxLength != previousMaxLength)
Expand Down
17 changes: 13 additions & 4 deletions src/EFCore.Relational/Metadata/Conventions/SharedTableConvention.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -235,9 +235,18 @@ private static void UniquifyColumnNames(
continue;
}

var identifyingMemberInfo = property.PropertyInfo ?? (MemberInfo?)property.FieldInfo;
if ((identifyingMemberInfo != null
&& identifyingMemberInfo.IsSameAs(otherProperty.PropertyInfo ?? (MemberInfo?)otherProperty.FieldInfo))
var declaringEntityType = property.DeclaringType as IConventionEntityType;
#pragma warning disable EF1001 // Internal EF Core API usage.
var identifyingMemberInfo = property.GetIdentifyingMemberInfo();
var isInheritedSharedMember = identifyingMemberInfo != null
&& ((declaringEntityType != null && identifyingMemberInfo.DeclaringType != type.ClrType)
|| (declaringEntityType == null
&& otherProperty.DeclaringType is IConventionComplexType otherDeclaringComplexType
&& ((IConventionComplexType)property.DeclaringType).ComplexProperty.GetIdentifyingMemberInfo()
.IsSameAs(otherDeclaringComplexType.ComplexProperty.GetIdentifyingMemberInfo())))
&& identifyingMemberInfo.IsSameAs(otherProperty.GetIdentifyingMemberInfo());
#pragma warning restore EF1001 // Internal EF Core API usage.
if (isInheritedSharedMember
|| (property.IsPrimaryKey() && otherProperty.IsPrimaryKey())
|| (property.IsConcurrencyToken && otherProperty.IsConcurrencyToken)
|| (!property.Builder.CanSetColumnName(null) && !otherProperty.Builder.CanSetColumnName(null)))
Expand All @@ -262,7 +271,7 @@ private static void UniquifyColumnNames(
if (!usePrefix
|| (!property.DeclaringType.IsStrictlyDerivedFrom(otherProperty.DeclaringType)
&& !otherProperty.DeclaringType.IsStrictlyDerivedFrom(property.DeclaringType))
|| (property.DeclaringType as IConventionEntityType)?.FindRowInternalForeignKeys(storeObject).Any() == true)
|| declaringEntityType?.FindRowInternalForeignKeys(storeObject).Any() == true)
{
var newColumnName = TryUniquify(property, columnName, columns, storeObject, usePrefix, maxLength);
if (newColumnName != null)
Expand Down
Loading

0 comments on commit 64afeec

Please sign in to comment.