Merge pull request #1194 from progressonderwijs/fons/json_rvs

Give the possibility to serialize rowversion columns to number properties in the JSON reader.

Author: fdij

src/ProgressOnderwijsUtils/Data/ParameterizedSqlObjectMapper.cs

@@ -70,8 +70,8 @@ public static void ExecuteNonQuery(this ParameterizedSql sql, SqlConnection sqlC
         where T : IWrittenImplicitly
         => q.OfPocos<T>().Execute(sqlConn);
 
-    public static void ReadJson(this ParameterizedSql q, SqlConnection sqlConn, IBufferWriter<byte> buffer, JsonWriterOptions options, JsonIgnoreCondition defaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull)
-        => q.OfJson().Execute(sqlConn, buffer, options, defaultIgnoreCondition);
+    public static void ReadJson(this ParameterizedSql q, SqlConnection sqlConn, IBufferWriter<byte> buffer, JsonWriterOptions options, JsonIgnoreCondition defaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull, bool rowVersionAsNumber = false)
+        => q.OfJson().Execute(sqlConn, buffer, options, defaultIgnoreCondition, rowVersionAsNumber);
 
     /// <summary>
     /// Reads all records of the given query from the database, unpacking into a C# array of tuples in field order

src/ProgressOnderwijsUtils/Data/SqlBatch.cs

@@ -1,4 +1,5 @@
 using System.Buffers;
+using System.Buffers.Binary;
 using System.Data.Common;
 using System.Text.Json;
 using System.Text.Json.Serialization;
@@ -212,7 +213,7 @@ public readonly record struct JsonSqlCommand(ParameterizedSql Sql, CommandTimeou
     public JsonSqlCommand WithTimeout(CommandTimeout timeout)
         => this with { CommandTimeout = timeout, };
 
-    public void Execute(SqlConnection conn, IBufferWriter<byte> buffer, JsonWriterOptions options, JsonIgnoreCondition defaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull)
+    public void Execute(SqlConnection conn, IBufferWriter<byte> buffer, JsonWriterOptions options, JsonIgnoreCondition defaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull, bool rowVersionAsNumber = false)
     {
         if (defaultIgnoreCondition is JsonIgnoreCondition.Always) {
             throw new ArgumentException("The value cannot be 'Always'", nameof(defaultIgnoreCondition));
@@ -265,7 +266,12 @@ public void Execute(SqlConnection conn, IBufferWriter<byte> buffer, JsonWriterOp
                     } else if (type == typeof(string)) {
                         writer.WriteString(name, reader.GetString(i));
                     } else if (type == typeof(byte[])) {
-                        writer.WriteBase64String(name, reader.GetFieldValue<byte[]>(i));
+                        var bytes = reader.GetFieldValue<byte[]>(i);
+                        if (sqlType is "rowversion" or "timestamp" && rowVersionAsNumber) {
+                            writer.WriteNumber(name, BinaryPrimitives.ReadUInt64BigEndian(bytes));
+                        } else {
+                            writer.WriteBase64String(name, bytes);
+                        }
                     } else if (type == typeof(Guid)) {
                         writer.WriteString(name, reader.GetGuid(i));
                     } else {

src/ProgressOnderwijsUtils/ProgressOnderwijsUtils.csproj

@@ -1,8 +1,8 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <Import Project="..\NugetPackagesCommon.props" />
   <PropertyGroup Label="Configuration">
-    <Version>110.1.0</Version>
-    <PackageReleaseNotes>Added standaard configuration parm for configuring the serialization of null-properties when reading JSON from SQL query.</PackageReleaseNotes>
+    <Version>110.2.0</Version>
+    <PackageReleaseNotes>Give the possibility to serialize rowversion columns to number properties in the JSON reader.</PackageReleaseNotes>
     <Title>ProgressOnderwijsUtils</Title>
     <Description>Collection of utilities developed by ProgressOnderwijs</Description>
     <PackageTags>ProgressOnderwijs</PackageTags>

test/ProgressOnderwijsUtils.Tests/Data/ReadJsonTest.ReadJson_can_read_all_known_used_column_types_from_the_db.approved.txt

@@ -16,6 +16,19 @@
     "UniqueIdentifierColumn": "82dbee37-3af8-46f2-a403-ae0a1950bc6e"
   },
   {
-    "ReadJsonTestId": 2
+    "ReadJsonTestId": 2,
+    "BitColumn": null,
+    "IntColumn": null,
+    "BigIntColumn": null,
+    "DecimalColumn": null,
+    "FloatColumn": null,
+    "DateColumn": null,
+    "DateTimeOffsetColumn": null,
+    "CharColumn": null,
+    "VarCharColumn": null,
+    "NCharColumn": null,
+    "NVarCharColumn": null,
+    "BinaryColumn": null,
+    "UniqueIdentifierColumn": null
   }
 ]

test/ProgressOnderwijsUtils.Tests/Data/ReadJsonTest.cs

@@ -100,7 +100,7 @@ ReadJsonTestId int not null
         ).ExecuteNonQuery(Connection);
 
         var pipe = new Pipe();
-        SQL($"select t.* from #ReadJsonTest t order by t.ReadJsonTestId").ReadJson(Connection, pipe.Writer, new() { Indented = true, });
+        SQL($"select t.* from #ReadJsonTest t order by t.ReadJsonTestId").ReadJson(Connection, pipe.Writer, new() { Indented = true, }, JsonIgnoreCondition.Never);
         pipe.Writer.Complete();
 
         ApprovalTest.CreateHere().AssertUnchangedAndSave(Encoding.UTF8.GetString(pipe.Reader.ReadAsync().GetAwaiter().GetResult().Buffer));
@@ -156,6 +156,7 @@ sealed record ReadJsonPocoTest : IWrittenImplicitly
         public string? StringColumn { get; init; }
         public DateTime? DateTimeColumn { get; init; }
         public byte[]? BinaryColumn { get; init; }
+        public ulong RijRevisie { get; init; }
     }
 
     [Fact]
@@ -173,6 +174,7 @@ ReadJsonPocoTestId int not null
                 , StringColumn nvarchar(32)
                 , DateTimeColumn datetime2
                 , BinaryColumn varbinary(32)
+                , RijRevisie rowversion
             );
             """
         ).ExecuteNonQuery(Connection);
@@ -199,7 +201,7 @@ ReadJsonPocoTestId int not null
         var pocos = query.ReadPocos<ReadJsonPocoTest>(Connection);
 
         var pipe = new Pipe();
-        query.ReadJson(Connection, pipe.Writer, new() { Indented = true, });
+        query.ReadJson(Connection, pipe.Writer, new() { Indented = true, }, JsonIgnoreCondition.WhenWritingNull, true);
         pipe.Writer.Complete();
         var json = Encoding.UTF8.GetString(pipe.Reader.ReadAsync().GetAwaiter().GetResult().Buffer);
         var jsonPocos = JsonSerializer.Deserialize<ReadJsonPocoTest[]>(json).AssertNotNull();