[release/10.0] Fix snapshot generation to capture column type for JSON columns #37284
+332
−1
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
Co-authored-by: AndriySvyryd <[email protected]>
Co-authored-by: AndriySvyryd <[email protected]>
Copilot
AI
changed the title
[WIP] Fix model differ test for migrating JSON columns
Add model differ tests for JSON column migration from nvarchar(max) to json
Dec 2, 2025
Copilot finished work on behalf of
AndriySvyryd
December 2, 2025 22:09
AndriySvyryd
reviewed
Dec 2, 2025
test/EFCore.Design.Tests/Migrations/Design/CSharpMigrationsGeneratorTest.ModelSnapshot.cs
Show resolved
Hide resolved
AndriySvyryd
reviewed
Dec 2, 2025
test/EFCore.SqlServer.Tests/Migrations/SqlServerModelDifferTest.cs
Outdated
Show resolved
Hide resolved
- Modified AnnotationCodeGenerator to generate column type for owned
and complex types mapped to JSON even when not explicitly set
- Updated Owned_types_mapped_to_json_are_stored_in_snapshot to expect
HasColumnType("nvarchar(max)") and verify via GetContainerColumnType()
- Renamed Complex_types_mapped_to_json_are_stored_in_snapshot to
Complex_types_mapped_to_json_with_explicit_column_type_are_stored_in_snapshot
- Added new Complex_types_mapped_to_json_are_stored_in_snapshot test
without explicit column type expecting nvarchar(max) in snapshot
Fixes #37275
Co-authored-by: AndriySvyryd <[email protected]>
Copilot
AI
changed the title
Add model differ tests for JSON column migration from nvarchar(max) to json
Fix snapshot generation to capture column type for JSON columns
Dec 2, 2025
Copilot finished work on behalf of
AndriySvyryd
December 2, 2025 22:42
… type test Addresses PR feedback to not add a custom type for the test. Co-authored-by: AndriySvyryd <[email protected]>
Copilot finished work on behalf of
AndriySvyryd
December 2, 2025 22:52
AndriySvyryd
reviewed
Dec 3, 2025
Moved the logic for adding ContainerColumnType annotation from AnnotationCodeGenerator to CSharpSnapshotGenerator as requested. Now GenerateEntityTypeAnnotations and GenerateComplexPropertyAnnotations check if the entity/complex type is mapped to JSON and add the ContainerColumnType annotation if it's missing. Co-authored-by: AndriySvyryd <[email protected]>
Copilot finished work on behalf of
AndriySvyryd
December 3, 2025 01:26
AndriySvyryd
reviewed
Dec 3, 2025
Per review feedback, updated CSharpSnapshotGenerator to first try GetContainerColumnType() for both entity types and complex types, then fall back to type mapping source if the method returns null. Co-authored-by: AndriySvyryd <[email protected]>
Copilot finished work on behalf of
AndriySvyryd
December 3, 2025 01:48
AndriySvyryd
reviewed
Dec 3, 2025
AndriySvyryd
changed the title
Member
|
@copilot Add |
…older snapshots - Created SqlServerSnapshotModelProcessor that detects snapshots from version 9 or older - Processor sets ContainerColumnType to nvarchar(max) for JSON owned types without the annotation - Registered the processor in SqlServerDesignTimeServices using TryAddProviderSpecificServices - Added EFCore.Design project reference to EFCore.SqlServer for design-time types - Added test to verify the processor correctly handles version 9 snapshots Co-authored-by: AndriySvyryd <[email protected]>
Contributor
Author
Fixed in efc876a. Added |
Copilot finished work on behalf of
AndriySvyryd
December 3, 2025 22:08
Member
|
@copilot Revert the last commit |
Reverted the last commit that added: - SqlServerSnapshotModelProcessor class - EFCore.Design project reference in EFCore.SqlServer - Related test Co-authored-by: AndriySvyryd <[email protected]>
Contributor
Author
Copilot finished work on behalf of
AndriySvyryd
December 4, 2025 00:14
Copilot AI
added a commit
that referenced
this pull request
Dec 4, 2025
… of #37284 without complex types) Co-authored-by: AndriySvyryd <[email protected]>
SamMonoRT
approved these changes
Dec 4, 2025
cincuranet
approved these changes
Dec 5, 2025
Member
|
cc @artl93 |
Member
|
@AndriySvyryd - would it make sense to wait for the full fix? |
Member
|
Never mind - I see we're ready to take both. |
AndriySvyryd
added a commit
that referenced
this pull request
Dec 5, 2025
Port of #37284 Co-authored-by: AndriySvyryd <[email protected]>
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.
Fixes #37275
Description
EF Core 10 added support for
jsonSQL Server type for JSON column and it's used by default if the target SQL Server version supports it, but no migrations to convert the columns to the newjsoncolumn type are created because the model snapshot doesn't capture the default store type for JSON columns.For the complete fix #37294 is required for the user to create a migration in 9 that has the explicit type.
Customer impact
Customers upgrading from EF Core 9 to 10 who use
ToJson()won't get migrations generated to update the column type fromnvarchar(max)tojson. The workaround is to manually specify.HasColumnType("json")on the JSON column.How found
Customer reported on EF 10.0.0
Regression
No, new feature.
Testing
Test added
Risk
Low. Targeted fix to include the default column type in the model snapshot. Only affects design-time.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.