Skip to content
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

Improve the relationship cycle breaking logic to detect cycles even when not starting on one. #32573

Merged
merged 2 commits into from
Dec 11, 2023
Merged

Improve the relationship cycle breaking logic to detect cycles even when not starting on one. #32573

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4ce3c99
Improve the relationship cycle breaking logic to detect cycles even w…
AndriySvyryd Dec 9, 2023
64573c5
Fix Relational test
AndriySvyryd Dec 11, 2023
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
1 change: 0 additions & 1 deletion src/EFCore/Metadata/Internal/EntityType.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
// The .NET Foundation licenses this file to you under the MIT license.

using System.Diagnostics.CodeAnalysis;
using System.Runtime.CompilerServices;
using Microsoft.EntityFrameworkCore.ChangeTracking.Internal;
using Microsoft.EntityFrameworkCore.Internal;

Expand Down
6 changes: 5 additions & 1 deletion src/EFCore/Metadata/Internal/InternalForeignKeyBuilder.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3677,7 +3677,11 @@ private bool CanSetRelatedTypes(
&& (((navigationToPrincipal != null)
&& (navigationToPrincipal.Value.Name == Metadata.PrincipalToDependent?.Name))
|| ((navigationToDependent != null)
&& (navigationToDependent.Value.Name == Metadata.DependentToPrincipal?.Name)));
&& (navigationToDependent.Value.Name == Metadata.DependentToPrincipal?.Name))
|| ((navigationToPrincipal == null)
&& (navigationToDependent == null)
&& principalEntityType == Metadata.DeclaringEntityType
&& dependentEntityType == Metadata.PrincipalEntityType));

var someAspectsFitNonInverted = false;
if (!sameHierarchyInvertedNavigations
Expand Down
179 changes: 102 additions & 77 deletions src/EFCore/Metadata/Internal/Property.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
using System.Diagnostics.CodeAnalysis;
using System.Globalization;
using Microsoft.EntityFrameworkCore.ChangeTracking.Internal;
using Microsoft.EntityFrameworkCore.Infrastructure;
using Microsoft.EntityFrameworkCore.Internal;
using Microsoft.EntityFrameworkCore.Storage.Json;

Expand Down Expand Up @@ -767,53 +768,10 @@ private object? DefaultSentinel
public virtual ValueConverter? GetValueConverter()
{
var annotation = FindAnnotation(CoreAnnotationNames.ValueConverter);
if (annotation != null)
{
return (ValueConverter?)annotation.Value;
}

var property = this;
var i = 0;
for (; i < ForeignKey.LongestFkChainAllowedLength; i++)
{
Property? nextProperty = null;
foreach (var foreignKey in property.GetContainingForeignKeys())
{
for (var propertyIndex = 0; propertyIndex < foreignKey.Properties.Count; propertyIndex++)
{
if (property == foreignKey.Properties[propertyIndex])
{
var principalProperty = foreignKey.PrincipalKey.Properties[propertyIndex];
if (principalProperty == this
|| principalProperty == property)
{
break;
}

annotation = principalProperty.FindAnnotation(CoreAnnotationNames.ValueConverter);
if (annotation != null)
{
return (ValueConverter?)annotation.Value;
}

nextProperty = principalProperty;
}
}
}

if (nextProperty == null)
{
break;
}

property = nextProperty;
}

return i == ForeignKey.LongestFkChainAllowedLength
? throw new InvalidOperationException(
CoreStrings.RelationshipCycle(
DeclaringType.DisplayName(), Name, "ValueConverter"))
: null;
return annotation != null
? (ValueConverter?)annotation.Value
: GetConversion(throwOnProviderClrTypeConflict: FindAnnotation(CoreAnnotationNames.ProviderClrType) == null)
.ValueConverter;
}

/// <summary>
Expand Down Expand Up @@ -859,53 +817,120 @@ private object? DefaultSentinel
public virtual Type? GetProviderClrType()
{
var annotation = FindAnnotation(CoreAnnotationNames.ProviderClrType);
if (annotation != null)
{
return (Type?)annotation.Value;
}
return annotation != null
? (Type?)annotation.Value
: GetConversion(throwOnValueConverterConflict: FindAnnotation(CoreAnnotationNames.ValueConverter) == null)
.ProviderClrType;
}

private (ValueConverter? ValueConverter, Type? ProviderClrType) GetConversion(
bool throwOnValueConverterConflict = true, bool throwOnProviderClrTypeConflict = true)
{
var queue = new Queue<(Property CurrentProperty, Property CycleBreakingPropert, int CyclePosition, int MaxCycleLength)>();
queue.Enqueue((this, this, 0, 2));

var property = this;
var i = 0;
for (; i < ForeignKey.LongestFkChainAllowedLength; i++)
ValueConverter? valueConverter = null;
Type? providerClrType = null;
while (queue.Count > 0)
{
Property? nextProperty = null;
var (property, cycleBreakingProperty, cyclePosition, maxCycleLength) = queue.Dequeue();
if (cyclePosition >= ForeignKey.LongestFkChainAllowedLength)
{
throw new InvalidOperationException(
CoreStrings.RelationshipCycle(DeclaringType.DisplayName(), Name, "ValueConverter"));
}

foreach (var foreignKey in property.GetContainingForeignKeys())
{
for (var propertyIndex = 0; propertyIndex < foreignKey.Properties.Count; propertyIndex++)
{
if (property == foreignKey.Properties[propertyIndex])
if (property != foreignKey.Properties[propertyIndex])
{
continue;
}

var principalProperty = foreignKey.PrincipalKey.Properties[propertyIndex];
if (principalProperty == cycleBreakingProperty)
{
break;
}

var annotationFound = false;
var valueConverterAnnotation = principalProperty.FindAnnotation(CoreAnnotationNames.ValueConverter);
if (valueConverterAnnotation != null)
{
var principalProperty = foreignKey.PrincipalKey.Properties[propertyIndex];
if (principalProperty == this
|| principalProperty == property)
var annotationValue = (ValueConverter?)valueConverterAnnotation.Value;
if (annotationValue != null)
{
break;
if (valueConverter != null)
{
throw new InvalidOperationException(
CoreStrings.ConflictingRelationshipConversions(
DeclaringType.DisplayName(), Name,
valueConverter.GetType().ShortDisplayName(), annotationValue.GetType().ShortDisplayName()));
}

if (providerClrType != null
&& throwOnProviderClrTypeConflict)
{
throw new InvalidOperationException(
CoreStrings.ConflictingRelationshipConversions(
DeclaringType.DisplayName(), Name,
providerClrType.ShortDisplayName(), annotationValue.GetType().ShortDisplayName()));
}

valueConverter = annotationValue;
}
annotationFound = true;
}

annotation = principalProperty.FindAnnotation(CoreAnnotationNames.ProviderClrType);
if (annotation != null)
var providerClrTypeAnnotation = principalProperty.FindAnnotation(CoreAnnotationNames.ProviderClrType);
if (providerClrTypeAnnotation != null)
{
var annotationValue = (Type?)providerClrTypeAnnotation.Value;
if (annotationValue != null)
{
return (Type?)annotation.Value;
if (providerClrType != null)
{
throw new InvalidOperationException(
CoreStrings.ConflictingRelationshipConversions(
DeclaringType.DisplayName(), Name,
providerClrType.ShortDisplayName(), annotationValue.ShortDisplayName()));
}

if (valueConverter != null
&& throwOnValueConverterConflict)
{
throw new InvalidOperationException(
CoreStrings.ConflictingRelationshipConversions(
DeclaringType.DisplayName(), Name,
valueConverter.GetType().ShortDisplayName(), annotationValue.ShortDisplayName()));
}

providerClrType = annotationValue;
}
annotationFound = true;
}

nextProperty = principalProperty;
if (!annotationFound)
{
if (cyclePosition == maxCycleLength - 1)
{
// We need to use different primes to ensure a different cycleBreakingProperty is selected
// each time when traversing properties that participate in multiple relationship cycles
queue.Enqueue((principalProperty, property, 0, HashHelpers.GetPrime(maxCycleLength << 1)));
}
else
{
queue.Enqueue((principalProperty, cycleBreakingProperty, cyclePosition + 1, maxCycleLength));
}
}
break;
}
}

if (nextProperty == null)
{
break;
}

property = nextProperty;
}

return i == ForeignKey.LongestFkChainAllowedLength
? throw new InvalidOperationException(
CoreStrings.RelationshipCycle(
DeclaringType.DisplayName(), Name, "ProviderClrType"))
: null;
return (valueConverter, providerClrType);
}

/// <summary>
Expand Down Expand Up @@ -1376,7 +1401,7 @@ public virtual bool IsForeignKey()
/// doing so can result in application failures when updating to a new Entity Framework Core release.
/// </summary>
public virtual IEnumerable<ForeignKey> GetContainingForeignKeys()
=> ForeignKeys?.OrderBy(fk => fk.Properties, PropertyListComparer.Instance) ?? Enumerable.Empty<ForeignKey>();
=> ForeignKeys?.OrderBy(fk => fk, ForeignKeyComparer.Instance) ?? Enumerable.Empty<ForeignKey>();

/// <summary>
/// This is an internal API that supports the Entity Framework Core infrastructure and not subject to
Expand Down
2 changes: 1 addition & 1 deletion src/EFCore/Metadata/RuntimeEntityType.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,7 @@ public virtual RuntimeForeignKey AddForeignKey(
{
if (property.ForeignKeys == null)
{
property.ForeignKeys = new List<RuntimeForeignKey> { foreignKey };
property.ForeignKeys = new SortedSet<RuntimeForeignKey>(ForeignKeyComparer.Instance) { foreignKey };
}
else
{
Expand Down
2 changes: 1 addition & 1 deletion src/EFCore/Metadata/RuntimeProperty.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,7 @@ private IEnumerable<RuntimeKey> GetContainingKeys()
/// doing so can result in application failures when updating to a new Entity Framework Core release.
/// </summary>
[EntityFrameworkInternal]
public virtual List<RuntimeForeignKey>? ForeignKeys { get; set; }
public virtual ISet<RuntimeForeignKey>? ForeignKeys { get; set; }

private IEnumerable<RuntimeForeignKey> GetContainingForeignKeys()
=> ForeignKeys ?? Enumerable.Empty<RuntimeForeignKey>();
Expand Down
9 changes: 9 additions & 0 deletions src/EFCore/Properties/CoreStrings.Designer.cs
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions src/EFCore/Properties/CoreStrings.resx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -342,6 +342,9 @@
<data name="ConflictingPropertyOrNavigation" xml:space="preserve">
<value>The property or navigation '{member}' cannot be added to the '{type}' type because a property or navigation with the same name already exists on the '{conflictingType}' type.</value>
</data>
<data name="ConflictingRelationshipConversions" xml:space="preserve">
<value>The property '{entityType}.{property}' participates in several relationship chains that have conflicting conversions: '{valueConversion}' and '{conflictingValueConversion}'.</value>
</data>
<data name="ConflictingRelationshipNavigation" xml:space="preserve">
<value>Cannot create a relationship between '{newPrincipalNavigationSpecification}' and '{newDependentNavigationSpecification}' because a relationship already exists between '{existingPrincipalNavigationSpecification}' and '{existingDependentNavigationSpecification}'. Navigations can only participate in a single relationship. If you want to override an existing relationship call 'Ignore' on the navigation '{newDependentNavigationSpecification}' first in 'OnModelCreating'.</value>
</data>
Expand Down
2 changes: 1 addition & 1 deletion test/EFCore.Relational.Tests/Infrastructure/RelationalModelValidatorTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -730,7 +730,7 @@ public virtual void Detects_shared_table_root_cycle()
modelBuilder.Entity<A>().HasOne<B>().WithOne().HasForeignKey<B>(a => a.Id).HasPrincipalKey<A>(b => b.Id).IsRequired();
modelBuilder.Entity<B>().ToTable("Table");

VerifyError(CoreStrings.RelationshipCycle("B", "AId", "ValueConverter"), modelBuilder);
VerifyError(CoreStrings.IdentifyingRelationshipCycle("A -> B"), modelBuilder);
}

[ConditionalFact]
Expand Down
7 changes: 7 additions & 0 deletions test/EFCore.Specification.Tests/TestUtilities/ModelAsserter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -665,6 +665,13 @@ public virtual bool AssertEqual(
Assert.Equal(expected.DeclaringEntityType.Name, actual.DeclaringEntityType.Name);
}
},
() =>
{
if (compareBackreferences)
{
Assert.Equal(expected.GetReferencingForeignKeys().ToList(), actual.GetReferencingForeignKeys(), ForeignKeyComparer.Instance);
}
},
() => Assert.Equal(expectedAnnotations, actualAnnotations, TestAnnotationComparer.Instance));

return true;
Expand Down
Loading
Loading