Target System.Text.Json 5.0.0 final (#66)

bartelink · web-flow · commit b88959f579c6 · 2021-09-09T15:57:31.000+01:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,6 +10,9 @@ The `Unreleased` section name is replaced by the expected version of next releas
 
 ### Added
 ### Changed
+
+- `FsCodec.SystemTextJson` - updated to target released `System.Text.Json` v `5.0.0` binaries [#66](https://github.com/jet/FsCodec/pull/66)
+
 ### Removed
 ### Fixed
 
diff --git a/Directory.Build.props b/Directory.Build.props
@@ -10,8 +10,7 @@
 
     <TestTargetFrameworks>netcoreapp3.1;net461</TestTargetFrameworks>
     <!-- avoid fighting with CI images about getting mono to run on MacOSX-->
-    <TestTargetFrameworks Condition=" '$([System.Runtime.InteropServices.RuntimeInformation]::IsOSPlatform($([System.Runtime.InteropServices.OSPlatform]::OSX)))' ">netcoreapp3.1</TestTargetFrameworks>
-
+    <TestTargetFrameworks Condition=" '$([System.Runtime.InteropServices.RuntimeInformation]::IsOSPlatform($([System.Runtime.InteropServices.OSPlatform]::OSX)))' ">net5.0</TestTargetFrameworks>
     <ThisDirAbsolute>$([System.IO.Path]::GetFullPath("$(MSBuildThisFileDirectory)"))</ThisDirAbsolute>
 
     <!-- SourceLink related properties https://github.com/dotnet/SourceLink#using-sourcelink -->
@@ -32,4 +31,4 @@
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </Content>
   </ItemGroup>
-</Project>
+</Project>
diff --git a/README.md b/README.md
@@ -7,7 +7,7 @@ Typically used in [applications](https://github.com/jet/dotnet-templates) levera
 
 ## Components
 
-The components within this repository are delivered as multi-targeted Nuget packages supporting `net461` (F# 3.1+) and `netstandard2.0` (F# 4.5+) profiles.
+The components within this repository are delivered as multi-targeted Nuget packages supporting `net461` (F# 3.1+) and `netstandard2.0`/`1` (F# 4.5+) profiles.
 
 - [![Codec NuGet](https://img.shields.io/nuget/v/FsCodec.svg)](https://www.nuget.org/packages/FsCodec/) `FsCodec` Defines interfaces with trivial implementation helpers.
   - No dependencies.
diff --git a/global.json b/global.json
@@ -1,6 +1,6 @@
 {
   "sdk": {
-    "version": "3.1.101",
+    "version": "5.0.200",
     "rollForward": "latestFeature"
   }
 }
diff --git a/src/FsCodec.NewtonsoftJson/FsCodec.NewtonsoftJson.fsproj b/src/FsCodec.NewtonsoftJson/FsCodec.NewtonsoftJson.fsproj
@@ -36,4 +36,4 @@
     <ProjectReference Include="../FsCodec/FsCodec.fsproj" />
   </ItemGroup>
 
-</Project>
+</Project>
diff --git a/src/FsCodec.NewtonsoftJson/Settings.fs b/src/FsCodec.NewtonsoftJson/Settings.fs
@@ -38,7 +38,7 @@ type Settings private () =
             MissingMemberHandling = (if errorOnMissing then MissingMemberHandling.Error else MissingMemberHandling.Ignore),
             NullValueHandling = (if ignoreNulls then NullValueHandling.Ignore else NullValueHandling.Include))
 
-    /// Optionated helper that creates serializer settings that provide good defaults for F#
+    /// Opinionated helper that creates serializer settings that provide good defaults for F#
     /// - no camel case conversion - assumption is you'll use records with camelCased names
     /// - Always prepends an OptionConverter() to any converters supplied
     /// - everything else is as per CreateDefault:- i.e. emit nulls instead of omitting fields etc
diff --git a/src/FsCodec.SystemTextJson/FsCodec.SystemTextJson.fsproj b/src/FsCodec.SystemTextJson/FsCodec.SystemTextJson.fsproj
@@ -26,12 +26,12 @@
 
     <PackageReference Include="FSharp.Core" Version="4.3.4" />
 
-    <PackageReference Include="System.Text.Json" Version="5.0.0-preview.3.20214.6" />
+    <PackageReference Include="System.Text.Json" Version="5.0.1" />
     <PackageReference Include="TypeShape" Version="8.0.0" />
   </ItemGroup>
 
   <ItemGroup>
     <ProjectReference Include="../FsCodec/FsCodec.fsproj" />
   </ItemGroup>
 
-</Project>
+</Project>
diff --git a/tests/FsCodec.NewtonsoftJson.Tests/Examples.fsx b/tests/FsCodec.NewtonsoftJson.Tests/Examples.fsx
@@ -1,17 +1,8 @@
 // Compile the fsproj by either a) right-clicking or b) typing
 // dotnet build tests/FsCodec.NewtonsoftJson.Tests before attempting to send this to FSI with Alt-Enter
 
-#if VISUALSTUDIO
-#r "netstandard"
-#endif
-#I "bin/Debug/netcoreapp3.1"
-#r "Newtonsoft.Json.dll"
-#r "Serilog.dll"
-#r "Serilog.Sinks.Console.dll"
-#r "TypeShape.dll"
-#r "FsCodec.dll"
-#r "FsCodec.NewtonsoftJson.dll"
-#r "FSharp.UMX.dll"
+#r "nuget: FsCodec.NewtonsoftJson"
+#r "nuget: Serilog.Sinks.Console"
 
 open FsCodec.NewtonsoftJson
 open Newtonsoft.Json
@@ -230,15 +221,13 @@ Unhandled Event: Category Misc, Id x, Index 0, Event: "Dummy"
    Where relevant, a decoding process may want to extract such context alongside mapping the base information.
 *)
 
-module EventsWithMeta =
+module Reactions =
 
-    type EventWithMeta = int64 * DateTimeOffset * Events.Event
+    type Event = int64 * DateTimeOffset * Events.Event
 
     let codec =
-        let up (raw : FsCodec.ITimelineEvent<byte[]>, contract : Events.Event) : EventWithMeta =
-            raw.Index, raw.Timestamp, contract
-        let down ((_index, timestamp, event) : EventWithMeta) =
-            event, None, Some timestamp
+        let up (raw : FsCodec.ITimelineEvent<byte[]>, contract : Events.Event) : Event = raw.Index, raw.Timestamp, contract
+        let down ((_index, timestamp, event) : Event) = event, None, Some timestamp
         FsCodec.NewtonsoftJson.Codec.Create(up, down)
 
     (* Helpers for parsing individual events *)
@@ -260,7 +249,7 @@ module EventsWithMeta =
 let runWithContext () =
     for stream, event in events do
         match stream, event with
-        | EventsWithMeta.Match (clientId, (index, ts, e)) ->
+        | Reactions.Match (clientId, (index, ts, e)) ->
             printfn "Client %s index %d time %O event %A" (ClientId.toString clientId) index (ts.ToString "u") e
         | FsCodec.StreamName.CategoryAndId (cat, id), e ->
             printfn "Unhandled Event: Category %s, Id %s, Index %d, Event: %A " cat id e.Index e.EventType
diff --git a/tests/FsCodec.NewtonsoftJson.Tests/FsCodec.NewtonsoftJson.Tests.fsproj b/tests/FsCodec.NewtonsoftJson.Tests/FsCodec.NewtonsoftJson.Tests.fsproj
@@ -20,7 +20,7 @@
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.7.1" />
     <PackageReference Include="Serilog" Version="2.9.0" />
     <PackageReference Include="Serilog.Sinks.Console" Version="3.0.0" />
-    <PackageReference Include="Unquote" Version="5.0.0" />
+    <PackageReference Include="Unquote" Version="6.1.0" />
     <PackageReference Include="xunit" Version="2.4.1" />
     <PackageReference Include="xunit.runner.visualstudio" Version="2.4.3" />
   </ItemGroup>
diff --git a/tests/FsCodec.NewtonsoftJson.Tests/UnionConverterTests.fs b/tests/FsCodec.NewtonsoftJson.Tests/UnionConverterTests.fs
@@ -113,8 +113,7 @@ let ``deserializes properly`` () =
 
     test <@ CaseE ("hi", 0) = deserialize """{"case":"CaseE","Item1":"hi","Item2":0}""" @>
     // NB this only passes by virtue of MissingMemberHandling=Ignore and NullValueHandling=Ignore in default settings
-    test <@ CaseE (null, 0) = deserialize """{"case":"CaseE","Item3":"hi","Item4":0}""" @>
-
+    test <@ CaseE (null, 0) = deserialize """{"case":"CaseE","Item1":null,"Item2":0,"Item3":"hi","Item4":"0"}""" @>
     test <@ CaseF ("hi", 0) = deserialize """{"case":"CaseF","a":"hi","b":0}""" @>
 
     test <@ CaseG {Item = "hi"} = deserialize """{"case":"CaseG","Item":"hi"}""" @>
diff --git a/tests/FsCodec.SystemTextJson.Tests/Examples.fsx b/tests/FsCodec.SystemTextJson.Tests/Examples.fsx
@@ -1,17 +1,18 @@
 // Compile the fsproj by either a) right-clicking or b) typing
 // dotnet build tests/FsCodec.SystemTextJson.Tests before attempting to send this to FSI with Alt-Enter
 
-#if VISUALSTUDIO
-#r "netstandard"
-#endif
-#I "bin/Debug/netcoreapp3.1"
-//#r "System.Text.Json.dll"
-#r "Serilog.dll"
-#r "Serilog.Sinks.Console.dll"
-#r "TypeShape.dll"
+(* Rider's FSI is not happy without the explicit references :shrug: *)
+
+#I "bin/Debug/net5.0"
 #r "FsCodec.dll"
 #r "FsCodec.SystemTextJson.dll"
+#r "TypeShape.dll"
 #r "FSharp.UMX.dll"
+#r "Serilog.dll"
+#r "Serilog.Sinks.Console.dll"
+
+#r "nuget: FsCodec.SystemTextJson"
+#r "nuget: Serilog.Sinks.Console"
 
 open FsCodec.SystemTextJson
 open System.Text.Json
@@ -137,12 +138,12 @@ module ClientId =
 module Events =
 
     // By convention, each contract defines a 'category' used as the first part of the stream name (e.g. `"Favorites-ClientA"`)
-    let [<Literal>] CategoryId = "Favorites"
+    let [<Literal>] Category = "Favorites"
 
     /// Pattern to determine whether a given {category}-{aggregateId} StreamName represents the stream associated with this Aggregate
     /// Yields a strongly typed id from the aggregateId if the Category does match
-    let (|MatchesCategory|_|) = function
-        | FsCodec.StreamName.CategoryAndId (CategoryId, ClientId.Parse clientId) -> Some clientId
+    let (|StreamName|_|) = function
+        | FsCodec.StreamName.CategoryAndId (Category, ClientId.Parse clientId) -> Some clientId
         | _ -> None
 
     type Added = { item : string }
@@ -153,12 +154,12 @@ module Events =
         interface TypeShape.UnionContract.IUnionContract
 
     let codec = FsCodec.SystemTextJson.Codec.Create<Event>()
-    let (|Decode|_|) stream = EventCodec.tryDecode codec Serilog.Log.Logger stream
+    let (|TryDecode|_|) stream = EventCodec.tryDecode codec Serilog.Log.Logger stream
 
     /// Yields decoded event and relevant strongly typed ids if the category of the Stream Name is correct
     let (|Match|_|) (streamName, span) =
         match streamName, span with
-        | MatchesCategory clientId, (Decode streamName event) -> Some (clientId, event)
+        | StreamName clientId, TryDecode streamName event -> Some (clientId, event)
         | _ -> None
 
 open FsCodec
@@ -178,7 +179,7 @@ let events = [
 let runCodec () =
     for stream, event in events do
         match stream, event with
-        | StreamName.CategoryAndId (Events.CategoryId, ClientId.Parse id), (Events.Decode stream e) ->
+        | StreamName.CategoryAndId (Events.Category, ClientId.Parse id), Events.TryDecode stream e ->
             printfn "Client %s, event %A" (ClientId.toString id) e
         | StreamName.CategoryAndId (cat, id), e ->
             printfn "Unhandled Event: Category %s, Id %s, Index %d, Event: %A " cat id e.Index e.EventType
@@ -223,28 +224,26 @@ Unhandled Event: Category Misc, Id x, Index 0, Event: "Dummy"
    Where relevant, a decoding process may want to extract such context alongside mapping the base information.
 *)
 
-module EventsWithMeta =
+module Reactions =
 
-    type EventWithMeta = int64 * DateTimeOffset * Events.Event
+    type Event = int64 * DateTimeOffset * Events.Event
 
     let codec =
-        let up (raw : FsCodec.ITimelineEvent<JsonElement>, contract : Events.Event) : EventWithMeta =
-            raw.Index, raw.Timestamp, contract
-        let down ((_index, timestamp, event) : EventWithMeta) =
-            event, None, Some timestamp
+        let up (raw : FsCodec.ITimelineEvent<JsonElement>, contract : Events.Event) : Event = raw.Index, raw.Timestamp, contract
+        let down ((_index, timestamp, event) : Event) = event, None, Some timestamp
         FsCodec.SystemTextJson.Codec.Create(up, down)
 
-    let (|Decode|_|) stream event : EventWithMeta option = EventCodec.tryDecode codec Serilog.Log.Logger stream event
-
+    let (|TryDecode|_|) stream event : Event option = EventCodec.tryDecode codec Serilog.Log.Logger stream event
     let (|Match|_|) (streamName, span) =
         match streamName, span with
-        | Events.MatchesCategory clientId, (Decode streamName event) -> Some (clientId, event)
+        | Events.StreamName clientId, TryDecode streamName event -> Some (clientId, event)
+
         | _ -> None
 
 let runWithContext () =
     for stream, event in events do
         match stream, event with
-        | EventsWithMeta.Match (clientId, (index, ts, e)) ->
+        | Reactions.Match (clientId, (index, ts, e)) ->
             printfn "Client %s index %d time %O event %A" (ClientId.toString clientId) index (ts.ToString "u") e
         | FsCodec.StreamName.CategoryAndId (cat, id), e ->
             printfn "Unhandled Event: Category %s, Id %s, Index %d, Event: %A " cat id e.Index e.EventType
diff --git a/tests/FsCodec.SystemTextJson.Tests/FsCodec.SystemTextJson.Tests.fsproj b/tests/FsCodec.SystemTextJson.Tests/FsCodec.SystemTextJson.Tests.fsproj
@@ -1,7 +1,7 @@
 ﻿<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFramework>netcoreapp3.1</TargetFramework>
+    <TargetFramework>net5.0</TargetFramework>
     <WarningLevel>5</WarningLevel>
     <IsPackable>false</IsPackable>
   </PropertyGroup>
@@ -10,7 +10,7 @@
     <PackageReference Include="FsCheck.Xunit" Version="2.14.3" />
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.7.1" />
     <PackageReference Include="Serilog.Sinks.Console" Version="3.0.0" />
-    <PackageReference Include="Unquote" Version="5.0.0" />
+    <PackageReference Include="Unquote" Version="6.1.0" />
     <PackageReference Include="xunit" Version="2.4.1" />
     <PackageReference Include="xunit.runner.visualstudio" Version="2.4.3" />
   </ItemGroup>
@@ -31,4 +31,4 @@
     <Compile Include="InteropTests.fs" />
   </ItemGroup>
 
-</Project>
+</Project>
diff --git a/tests/FsCodec.SystemTextJson.Tests/SerdesTests.fs b/tests/FsCodec.SystemTextJson.Tests/SerdesTests.fs
@@ -39,7 +39,7 @@ module StjCharacterization =
 
         let correctSer = """["A,"B"]"""
         raisesWith <@ Serdes.Deserialize<string list>(correctSer, ootbOptions) @>
-            <| fun e -> <@ e.Message.Contains "Deserialization of reference types without a parameterless constructor, a singular parameterized constructor, or a parameterized constructor annotated with 'JsonConstructorAttribute' is not supported. Type 'Microsoft.FSharp.Collections.FSharpList`1[System.String]" @>
+            <| fun e -> <@ e.Message.Contains "The collection type 'Microsoft.FSharp.Collections.FSharpList`1[System.String]' is abstract, an interface, or is read only, and could not be instantiated and populated" @>
 
     // System.Text.Json's JsonSerializerOptions by default escapes HTML-sensitive characters when generating JSON strings
     // while this arguably makes sense as a default

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"sdk": {`
`3`		`- "version": "3.1.101",`
	`3`	`+ "version": "5.0.200",`
`4`	`4`	`"rollForward": "latestFeature"`
`5`	`5`	`}`
`6`	`6`	`}`