FSharp.Data.JsonProvider.Serializer 1.0.2

dotnet add package FSharp.Data.JsonProvider.Serializer --version 1.0.2                
NuGet\Install-Package FSharp.Data.JsonProvider.Serializer -Version 1.0.2                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="FSharp.Data.JsonProvider.Serializer" Version="1.0.2" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add FSharp.Data.JsonProvider.Serializer --version 1.0.2                
#r "nuget: FSharp.Data.JsonProvider.Serializer, 1.0.2"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install FSharp.Data.JsonProvider.Serializer as a Cake Addin
#addin nuget:?package=FSharp.Data.JsonProvider.Serializer&version=1.0.2

// Install FSharp.Data.JsonProvider.Serializer as a Cake Tool
#tool nuget:?package=FSharp.Data.JsonProvider.Serializer&version=1.0.2                

FSharp.Data.JsonProvider.Serializer

NuGet package: https://www.nuget.org/packages/FSharp.Data.JsonProvider.Serializer/ This is not independent package, you still use your current JsonProvider.

This will provide utilities to use the fast System.Text.Json library to serialize the FSharp.Data.JsonProvider items.

Motivation: Serialization speed. Typically JSON Serialization is used either so that the user is watching a progress-bar, or in a big batch-process.

Current FSharp.Data is using custom Json-serializer.

We need a compromise having the convinience of F# JsonProvider, but speed of System.Text.Json.

The idea is to be in-replacement for current functions:

Reading values to type provider (Deserialization)

Current FSharp.Data.JsonProvider:

type MyJsonType = FSharp.Data.JsonProvider<"""{ "model": "..." } """>

let fromJson (response:string) = MyJsonType.Parse response

Using this library:

type MyJsonType = FSharp.Data.JsonProvider<"""{ "model": "..." } """>

let fromJson (response:string) = MyJsonType.Load (Serializer.Deserialize response)

Saving values from type provider (Serialization)

Current FSharp.Data.JsonProvider:

type MyJson = FSharp.Data.JsonProvider<"""{ "model": "..." } """>

let toJson mymodel = mymodel.JsonValue.ToString()

Using this library:

type MyJson = FSharp.Data.JsonProvider<"""{ "model": "..." } """>

let toJson mymodel = Serializer.Serialize (mymodel.JsonValue)

Besides of this, you continue using your existing JsonProvider implementation as is. Currently it uses System.Text.Json style of encoding the quote characters, etc. but if you want to customize your serialization more, you can set JsonReaderOptions and JsonWriterOptions as parameters.

Initial Benchmarks

FSharp.Data 6.3, System.Text.Json 8.0

Test-case:

  • Read JSON to JsonProvider. (Serialization)
  • Verify a property
  • Save JSON back to a string. (Deserialization)

Tested with small JSON file, and with Stripe OpenAPI spec file (+5MB of JSON).

BenchmarkDotNet v0.13.10, Windows 11 (10.0.22621.2715/22H2/2022Update/SunValley2) 13th Gen Intel Core i9-13900H, 1 CPU, 20 logical and 14 physical cores

.NET 8.0 : .NET 8.0.0 (8.0.23.53103), X64 RyuJIT AVX2
Method Mean Error StdDev Gen0 Gen1 Gen2 Allocated
SmallJson_JsonProvider 2.789 μs 0.0314 μs 0.0293 μs 0.4120 - - 5.06 KB
SmallJson_SystemTextJson 1.623 μs 0.0308 μs 0.0288 μs 0.2651 - - 3.27 KB
ListOf1000SmallJsons_JsonProvider 2,849.210 μs 25.9458 μs 20.2568 μs 351.5625 175.7813 58.5938 4224.8 KB
ListOf1000SmallJsons_SystemTextJson 1,424.314 μs 9.3599 μs 8.7553 μs 199.2188 199.2188 199.2188 2469.76 KB
StripeJson_JsonProvider 83,610.123 μs 1,667.5590 μs 3,406.3812 μs 5285.7143 4571.4286 1714.2857 60521.87 KB
StripeJson_SystemTextJsonBytes 42,775.639 μs 822.2020 μs 1,009.7378 μs 2333.3333 2166.6667 750.0000 44305.47 KB
.NET Framework 4.8 : .NET Framework 4.8.1 (4.8.9181.0), X64 RyuJIT VectorSize=256
Method Mean Error StdDev Gen0 Gen1 Gen2 Allocated
SmallJson_JsonProvider 6.613 μs 0.0554 μs 0.0518 μs 0.8621 - - 5.32 KB
SmallJson_SystemTextJson 4.832 μs 0.0542 μs 0.0480 μs 0.5493 - - 3.4 KB
ListOf1000SmallJsons_JsonProvider 7,052.777 μs 53.6100 μs 47.5238 μs 695.3125 343.7500 54.6875 4465.7 KB
ListOf1000SmallJsons_SystemTextJson 4,453.736 μs 43.9446 μs 41.1058 μs 390.6250 195.3125 195.3125 2587.36 KB
StripeJson_JsonProvider 107,016.899 μs 2,094.9813 μs 3,500.2432 μs 8200.0000 3800.0000 1400.0000 61612.22 KB
StripeJson_SystemTextJsonBytes 77,002.389 μs 1,531.7106 μs 2,559.1443 μs 4285.7143 2285.7143 1000.0000 45245.97 KB

To run the test: dotnet run --project tests\Benchmarks\BenchmarkTests.fsproj --configuration=Release --framework=net8.0

API

FSharp.Data uses internally class called FSharp.Data.JsonValue to model the JSON domain.

From JSON to JsonProvider
  • Deserialize: string to FSharp.Data.JsonValue
  • DeserializeWith: string and System.Text.Json.JsonReaderOptions to FSharp.Data.JsonValue
  • DeserializeBytes: byte array to FSharp.Data.JsonValue
  • DeserializeBytesWith: byte array and System.Text.Json.JsonReaderOptions to FSharp.Data.JsonValue
From JsonProvider to JSON
  • Serialize: FSharp.Data.JsonValue to string
  • SerializeWith: FSharp.Data.JsonValue and System.Text.Json.JsonWriterOptions to string
  • SerializeBytes: FSharp.Data.JsonValue to byte array
  • SerializeBytesWith: FSharp.Data.JsonValue and System.Text.Json.JsonWriterOptions to byte array
From JsonProvider to JSON, Streaming

With streaming support you can send JSON-data to output stream record-per-record.

  • SerializeStream: destination stream, FSharp.Data.JsonValue
  • SerializeStreamWith: destination stream, FSharp.Data.JsonValue and System.Text.Json.JsonWriterOptions

Streaming may keep around the same performance characteristics, but reduce a memory allocation a bit and provide partially consumable results faster if JSON is large and the client supports streaming.

.NET 8.0 : .NET 8.0.0 (8.0.23.53103), X64 RyuJIT AVX2

Method Mean Error StdDev Gen0 Gen1 Gen2 Allocated
ListOf1000SmallJsons_SystemTextJsonStream 1,525.970 μs 14.0992 μs 13.1884 μs 158.2031 117.1875 78.1250 2100.46 KB
StripeJson_SystemTextJsonStream 47,112.065 μs 805.5929 μs 753.5521 μs 2333.3333 2250.0000 750.0000 31560.25 KB

.NET Framework 4.8 : .NET Framework 4.8.1 (4.8.9181.0), X64 RyuJIT VectorSize=256

Method Mean Error StdDev Gen0 Gen1 Gen2 Allocated
ListOf1000SmallJsons_SystemTextJsonStream 4,650.089 μs 34.2087 μs 30.3251 μs 312.5000 156.2500 78.1250 2217.05 KB
StripeJson_SystemTextJsonStream 76,921.557 μs 1,448.2545 μs 1,778.5866 μs 4000.0000 2000.0000 1000.0000 32501.88 KB
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 is compatible. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 is compatible.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.2 160 7/15/2024
1.0.1 888 4/1/2024
1.0.0 84 3/29/2024
0.0.4 210 3/13/2024
0.0.3 913 11/29/2023
0.0.2 116 11/23/2023
0.0.1 109 11/22/2023