Refactor InternalEntityEntry in preparation for complex collection support #36165
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR refactors the internal change-tracking infrastructure to prepare for complex collection support by extracting InternalEntryBase, removing IInternalEntry.Object, and moving common change-tracking code to TypeBase.
- Updates method signatures and parameter types to use IInternalEntry for better abstraction.
- Introduces new state management via InternalEntryBase.StateData and adjusts snapshot and relationship handling.
- Adjusts EF Core scaffolding and collection entry code to support complex types and collections.
Reviewed Changes
Copilot reviewed 208 out of 208 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/EFCore/ChangeTracking/Internal/ShadowValuesFactoryFactory.cs | Adjusts GetPropertyCount signature and uses new indexer syntax for shadow values. |
| src/EFCore/ChangeTracking/Internal/RelationshipSnapshotFactoryFactory.cs | Changes GetPropertyCount signature and safely casts structuralType where necessary. |
| src/EFCore/ChangeTracking/Internal/OriginalValuesFactoryFactory.cs | Updates GetPropertyCount to use structuralType.Counts.OriginalValueCount. |
| src/EFCore/ChangeTracking/Internal/InternalEntryBase.StateData.cs | New file adding bit-level state management and property flag handling. |
| src/EFCore/ChangeTracking/Internal/InternalEntryBase.SidecarValues.cs | Updates signature by renaming to InternalEntryBase. |
| src/EFCore/ChangeTracking/Internal/InternalEntryBase.OriginalValues.cs | Updates parameter types to use InternalEntryBase and revised OriginalValues factory. |
| src/EFCore/ChangeTracking/Internal/InternalEntityEntryNotifier.cs | Changes method signatures to use IInternalEntry. |
| src/EFCore/ChangeTracking/Internal/IInternalEntry.cs | Removes IInternalEntry.Object and adds properties/methods to support the new design. |
| src/EFCore/ChangeTracking/Internal/IChangeDetector.cs | Updates change notification methods to use IInternalEntry. |
| src/EFCore/ChangeTracking/Internal/EmptyShadowValuesFactoryFactory.cs | Signature updates for GetPropertyCount consistent with new types. |
| src/EFCore/ChangeTracking/Internal/ChangeDetector.cs | Updates change detection logic and method signatures to use IInternalEntry with necessary casts. |
| src/EFCore/ChangeTracking/Internal/ArrayPropertyValues.cs | Uses new collection expression syntax for initializing properties. |
| src/EFCore/ChangeTracking/ComplexPropertyEntry`.cs | Updates constructor parameter from InternalEntityEntry to IInternalEntry and property access. |
| src/EFCore/ChangeTracking/ComplexPropertyEntry.cs | Similar constructor and IsModified changes for complex properties. |
| src/EFCore/ChangeTracking/CollectionEntry`.cs | Adjusts property access and collection query logic to use InternalEntityEntry consistently. |
| src/EFCore/ChangeTracking/CollectionEntry.cs | Updates collection entry code to work with the refactored change-tracking types. |
| src/EFCore.Design/Scaffolding/Internal/CSharpRuntimeModelCodeGenerator.cs | Introduces support for complex collections and updates generated counts accordingly. |
Comments suppressed due to low confidence (3)
src/EFCore/ChangeTracking/ComplexPropertyEntry`.cs:34
- The file name contains an unexpected backtick (`). Consider renaming the file to remove the backtick for consistency.
public ComplexPropertyEntry(IInternalEntry internalEntry, IComplexProperty complexProperty)
src/EFCore/ChangeTracking/CollectionEntry`.cs:62
- The file name includes an extraneous backtick (`); consider renaming the file to remove it for consistency with project naming conventions.
=> new(InternalEntityEntry);
src/EFCore/ChangeTracking/Internal/ArrayPropertyValues.cs:111
- The use of the collection expression syntax initializes _properties as an array rather than a List as before. Verify that downstream code expecting a List is updated or that the array behavior is acceptable.
=> _properties ??= [.. EntityType.GetFlattenedProperties()];
24e1985 to
61659f2
Compare
0d8b2df to
b7234f9
Compare
roji
approved these changes
Jun 13, 2025
| @@ -1219,7 +1324,7 @@ public virtual ChangeTrackingStrategy GetChangeTrackingStrategy() | |||
| /// doing so can result in application failures when updating to a new Entity Framework Core release. | |||
| /// </summary> | |||
| public static string? CheckChangeTrackingStrategy( | |||
| IReadOnlyTypeBase typeBase, | |||
| IReadOnlyTypeBase structuralType, | |||
There was a problem hiding this comment.
We discussed this in the past, but should we consider renaming ITypeBase IStructuralType? While technically a breaking change, it's very unlikely anyone actually uses this... We could still keep ITypeBase as an obsolete super-interface of IStructuralType to get people some time etc.
There was a problem hiding this comment.
I don't think it's worth it yet. Will reconsider when we have another thing that implements it
e826135 to
579bb61
Compare
579bb61 to
24e3747
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Extract
InternalEntryBaseRemove
IInternalEntry.ObjectMove common change-tracking code to
TypeBaseFix some minor model building issues related to complex types
Part of #31237