-
Notifications
You must be signed in to change notification settings - Fork 3.4k
Align JSON and M.D.Sqlite representations #36951
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.
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
Open
krisbiradar
wants to merge
8
commits into
dotnet:main
Choose a base branch
from
krisbiradar:fix-timeonly-byte-array-handling-in-sqlite-json-deserialization
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
1f1077f
fix:Align JSON and M.D.Sqlite representations , #36749
krisbiradar 0c597a0
Fixes failing tests
krisbiradar 983b50d
Fixed One Last Failing Test
krisbiradar fada149
Update test/EFCore.Sqlite.FunctionalTests/Types/SqliteMiscellaneousTy…
krisbiradar 98c4657
Update src/EFCore.Sqlite.Core/Storage/Json/Internal/SqliteJsonTimeOnl…
krisbiradar d2d938e
Update src/Microsoft.Data.Sqlite.Core/SqliteValueBinder.cs
krisbiradar f3a9a81
Update src/Microsoft.Data.Sqlite.Core/SqliteValueBinder.cs
krisbiradar bb850f0
Update src/EFCore.Sqlite.Core/Storage/Internal/SqliteTypeMappingSourc…
krisbiradar File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -35,26 +35,50 @@ public SqliteByteArrayTypeMapping(string storeType, DbType? dbType = System.Data | |
| typeof(byte[]), | ||
| jsonValueReaderWriter: SqliteJsonByteArrayReaderWriter.Instance), | ||
| storeType, | ||
| dbType: dbType)) | ||
| dbType: dbType), | ||
| false) | ||
| { | ||
| } | ||
|
|
||
| private SqliteByteArrayTypeMapping( | ||
| RelationalTypeMappingParameters parameters, | ||
| bool isJsonColumn) | ||
| : base(parameters) | ||
| { | ||
| _isJsonColumn = isJsonColumn; | ||
| } | ||
|
|
||
| private readonly bool _isJsonColumn; | ||
|
|
||
| /// <summary> | ||
| /// This is an internal API that supports the Entity Framework Core infrastructure and not subject to | ||
| /// the same compatibility standards as public APIs. It may be changed or removed without notice in | ||
| /// any release. You should only use it directly in your code with extreme caution and knowing that | ||
| /// doing so can result in application failures when updating to a new Entity Framework Core release. | ||
| /// </summary> | ||
| protected SqliteByteArrayTypeMapping(RelationalTypeMappingParameters parameters) | ||
| : base(parameters) | ||
| { | ||
| } | ||
|
|
||
|
|
||
| /// <summary> | ||
| /// Creates a copy of this mapping. | ||
| /// </summary> | ||
| /// <param name="parameters">The parameters for this mapping.</param> | ||
| /// <returns>The newly created mapping.</returns> | ||
| protected override RelationalTypeMapping Clone(RelationalTypeMappingParameters parameters) | ||
| => new SqliteByteArrayTypeMapping(parameters); | ||
| => new SqliteByteArrayTypeMapping(parameters, _isJsonColumn); | ||
|
|
||
| internal SqliteByteArrayTypeMapping WithJsonColumn() | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Add a |
||
| => new(Parameters, true); | ||
|
|
||
| /// <summary> | ||
| /// Configures the parameter, setting the <see cref="Microsoft.Data.Sqlite.SqliteParameter.SqliteType" /> to | ||
| /// <see cref="Microsoft.Data.Sqlite.SqliteType.Text" /> when the mapping is for a JSON column. | ||
| /// </summary> | ||
| /// <param name="parameter">The parameter to be configured.</param> | ||
| protected override void ConfigureParameter(DbParameter parameter) | ||
| { | ||
| if (_isJsonColumn && parameter is Data.Sqlite.SqliteParameter sqliteParameter) | ||
| { | ||
| sqliteParameter.SqliteType = Data.Sqlite.SqliteType.Text; | ||
| } | ||
| } | ||
| } | ||
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
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
59 changes: 59 additions & 0 deletions
59
src/EFCore.Sqlite.Core/Storage/Json/Internal/SqliteJsonTimeOnlyReaderWriter.cs
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| // Licensed to the .NET Foundation under one or more agreements. | ||
| // The .NET Foundation licenses this file to you under the MIT license. | ||
|
|
||
| using System.Globalization; | ||
| using System.Text.Json; | ||
| using Microsoft.EntityFrameworkCore.Storage.Json; | ||
|
|
||
| namespace Microsoft.EntityFrameworkCore.Sqlite.Storage.Json.Internal; | ||
|
|
||
| /// <summary> | ||
| /// The Sqlite-specific <see cref="JsonValueReaderWriter{TValue}" /> for <see cref="TimeOnly" />. Writes and reads the JSON string | ||
| /// representation of <see cref="TimeOnly" />, using <c>HH:mm:ss</c> when there are no fractional seconds and the round-trip | ||
| /// (<c>"o"</c>) format otherwise, to match the SQLite non-JSON representation. | ||
| /// </summary> | ||
| /// <remarks> | ||
| /// This is an internal API that supports the Entity Framework Core infrastructure and not subject to | ||
| /// the same compatibility standards as public APIs. It may be changed or removed without notice in | ||
| /// any release. You should only use it directly in your code with extreme caution and knowing that | ||
| /// doing so can result in application failures when updating to a new Entity Framework Core release. | ||
| /// </remarks> | ||
| public sealed class SqliteJsonTimeOnlyReaderWriter : JsonValueReaderWriter<TimeOnly> | ||
| { | ||
| private static readonly PropertyInfo InstanceProperty = typeof(SqliteJsonTimeOnlyReaderWriter).GetProperty(nameof(Instance))!; | ||
|
|
||
| /// <summary> | ||
| /// This is an internal API that supports the Entity Framework Core infrastructure and not subject to | ||
| /// the same compatibility standards as public APIs. It may be changed or removed without notice in | ||
| /// any release. You should only use it directly in your code with extreme caution and knowing that | ||
| /// doing so can result in application failures when updating to a new Entity Framework Core release. | ||
| /// </summary> | ||
| public static SqliteJsonTimeOnlyReaderWriter Instance { get; } = new(); | ||
|
|
||
| private SqliteJsonTimeOnlyReaderWriter() | ||
| { | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// This is an internal API that supports the Entity Framework Core infrastructure and not subject to | ||
| /// the same compatibility standards as public APIs. It may be changed or removed without notice in | ||
| /// any release. You should only use it directly in your code with extreme caution and knowing that | ||
| /// doing so can result in application failures when updating to a new Entity Framework Core release. | ||
| /// </summary> | ||
| public override TimeOnly FromJsonTyped(ref Utf8JsonReaderManager manager, object? existingObject = null) | ||
| => TimeOnly.Parse(manager.CurrentReader.GetString()!); | ||
|
|
||
| /// <summary> | ||
| /// This is an internal API that supports the Entity Framework Core infrastructure and not subject to | ||
| /// the same compatibility standards as public APIs. It may be changed or removed without notice in | ||
| /// any release. You should only use it directly in your code with extreme caution and knowing that | ||
| /// doing so can result in application failures when updating to a new Entity Framework Core release. | ||
| /// </summary> | ||
| public override void ToJsonTyped(Utf8JsonWriter writer, TimeOnly value) | ||
| => writer.WriteStringValue(value.Ticks % TimeSpan.TicksPerSecond == 0 ? string.Format(CultureInfo.InvariantCulture, @"{0:HH\:mm\:ss}", value) | ||
| : value.ToString("o")); | ||
|
|
||
| /// <inheritdoc /> | ||
| public override Expression ConstructorExpression | ||
| => Expression.Property(null, InstanceProperty); | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -61,8 +61,17 @@ public virtual void Bind() | |
| } | ||
| else if (type == typeof(byte[])) | ||
| { | ||
| // In SQLite JSON columns, parameter binding for byte[] results in a blob being bound, whereas the column is a text column. This conversion is needed to align representations. | ||
| var value1 = (byte[])value; | ||
| BindBlob(value1); | ||
| if (sqliteType == SqliteType.Text) | ||
| { | ||
| var value = ToHexString(value1); | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Are there tests for this? |
||
| BindText(value); | ||
| } | ||
| else | ||
| { | ||
| BindBlob(value1); | ||
| } | ||
| } | ||
| else if (type == typeof(char)) | ||
| { | ||
|
|
@@ -313,4 +322,23 @@ private static double GetTotalDays(int hour, int minute, int second, int millise | |
|
|
||
| return iJD / 86400000.0; | ||
| } | ||
|
|
||
| private static string ToHexString(byte[] bytes) | ||
| { | ||
| char[] hexChars = new char[bytes.Length * 2]; | ||
|
|
||
| for (int i = 0; i < bytes.Length; i++) | ||
| { | ||
| byte b = bytes[i]; | ||
|
|
||
| int highNibble = (b >> 4); | ||
| int lowNibble = (b & 0x0F); | ||
|
|
||
| hexChars[i * 2] = (char)(highNibble < 10 ? highNibble + '0' : highNibble + 'A' - 10); | ||
| hexChars[i * 2 + 1] = (char)(lowNibble < 10 ? lowNibble + '0' : lowNibble + 'A' - 10); | ||
| } | ||
|
|
||
| return new string(hexChars); | ||
| } | ||
|
|
||
| } | ||
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
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
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
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
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Extra blank lines should be removed. There should only be one blank line between the XML documentation comment and the next member declaration.