Release FsCodec.SystemTextJson 3.1.0-rc.4

Add Encoding.GetStringUtf8

Author: bartelink

CHANGELOG.md

@@ -16,7 +16,7 @@ The `Unreleased` section name is replaced by the expected version of next releas
 ### Fixed
 
 <a name="3.1.0"></a>
-## [3.1.0] - rc.3: 2025-01-29
+## [3.1.0] - rc.4: 2025-02-05
 
 ### Added
 

README.md

@@ -859,7 +859,7 @@ module Streams =
     // as we know our event bodies are all UTF8 encoded JSON, we can render the string as a log event property
     // alternately, you can render the EventBody directly and ensure you have appropriate type destructuring configured
     let private render (x: EventBody): string =
-        System.Text.Encoding.UTF8.GetString(x.Span)
+        FsCodec.Encoding.GetStringUtf8 x
     /// Uses the supplied codec to decode the supplied event record `x`
     /// (iff at LogEventLevel.Debug, detail fails to `log` citing the `streamName` and body)
     let decode<'E> (log: Serilog.ILogger) (codec: Codec<'E>) (streamName: FsCodec.StreamName) (x: Event) =
@@ -1094,7 +1094,7 @@ module StoreWithMeta =
         // the metadata is encoded as the normal bodies are
         let down ((_index, meta : Metadata, event : 'E) : Event<'E>) =
             struct (event, ValueSome meta, ValueNone)
-        Codec.Create<Event<'E>, 'E, Metadata>(up, down, serdes = Store.serdes) 
+        Codec.Create<Event<'E>, 'E, Metadata>(up, down, serdes = Store.serdes)
 ```
 
 The above embeds and/or extracts contextual information from the Event's `Meta` field.
@@ -1254,13 +1254,13 @@ module StreamsWithMeta =
 
     // no special requirements for deserializing metadata, so use Default Serdes
     let private serdes = Serdes.Default
-    let codec<'E when 'E :> TypeShape.UnionContract.IUnionContract> : Codec<'E> =
+    let codec<'E when 'E :> TypeShape.UnionContract.IUnionContract>: Codec<'E> =
         // here we surface some metadata from the raw event as part of the application level type  
         let up (raw : Streams.Event) (contract : 'E) : Event<'E> =
             struct (raw.Index, serdes.Deserialize<Metadata> raw.Meta, contract)
         // We are not using this codec to encode events, so we let the encoding side fail very fast
         let down _ = failwith "N/A"
-        Codec.Create<Event<'E>, 'E, Metadata>(up, down, options = Store.options) 
+        Codec.Create<Event<'E>, 'E, Metadata>(up, down, options = Store.options) |> FsCodec.Encoder.Uncompressed
 ```
 
 Then, per the relevant Event contract, we define a Decode pattern to decode relevant events from the stream, if this event is relevant for us:

src/FsCodec.Box/Compression.fs

@@ -8,7 +8,7 @@ type [<Struct>] CompressionOptions = { minSize: int; minGain: int } with
     static member Default = { minSize = 48; minGain = 4 }
     static member Uncompressed = { minSize = Int32.MaxValue; minGain = 0 }
 
-[<Extension; AbstractClass; Sealed; Obsolete "Please use FsCodec.Encoding instead">]
+[<Extension; AbstractClass; Sealed; Obsolete "Please use FsCodec.Encoder instead">]
 type Compression private () =
 
     static member Utf8ToEncodedDirect(x: ReadOnlyMemory<byte>): Encoded =
@@ -17,6 +17,7 @@ type Compression private () =
         FsCodec.Encoding.OfBlobCompress({ minSize = options.minSize; minGain = options.minGain }, x)
     static member EncodedToUtf8(x: Encoded): ReadOnlyMemory<byte> =
         FsCodec.Encoding.ToBlob x
+    /// NOTE if this is for use with System.Text.Encoding.UTF8.GetString, then EncodedToUtf8 >> _.Span is more efficient
     static member EncodedToByteArray(x: Encoded): byte[] =
         FsCodec.Encoding.ToBlob(x).ToArray()
 

src/FsCodec.NewtonsoftJson/FsCodec.NewtonsoftJson.fsproj

@@ -30,7 +30,7 @@
 
   <ItemGroup>
     <ProjectReference Condition=" '$(Configuration)' == 'Debug' " Include="../FsCodec.Box/FsCodec.Box.fsproj" />
-    <PackageReference Condition=" '$(Configuration)' == 'Release' " Include="FsCodec.Box" Version="[3.0.0, 4.0.0)" />
+    <PackageReference Condition=" '$(Configuration)' == 'Release' " Include="FsCodec.Box" Version="[3.1.0-rc.3, 4.0.0)" />
   </ItemGroup>
 
 </Project>

src/FsCodec.NewtonsoftJson/Serdes.fs

@@ -79,6 +79,10 @@ type Serdes(options: JsonSerializerSettings) =
         use jsonReader = Utf8BytesEncoder.makeJsonReader ms
         serializer.Deserialize<'T>(jsonReader)
 
+    /// Deserializes value of given type from a (potentially compressed) Encoded value
+    member x.Deserialize<'T>(utf8Encoded: FsCodec.Encoded): 'T =
+        x.Deserialize<'T>(FsCodec.Encoding.ToBlob utf8Encoded)
+
     /// Deserializes value of given type from a JObject
     member _.Deserialize<'T>(parsed: Newtonsoft.Json.Linq.JObject): 'T =
         parsed.ToObject(typeof<'T>, serializer) :?> 'T

src/FsCodec.SystemTextJson/Serdes.fs

@@ -47,6 +47,10 @@ type Serdes(options: JsonSerializerOptions) =
     member x.Deserialize<'T>(utf8json: System.ReadOnlyMemory<byte>): 'T =
         x.Deserialize<'T>(utf8json.Span)
 
+    /// Deserializes value of given type from a (potentially compressed) Encoded value
+    member x.Deserialize<'T>(utf8Encoded: FsCodec.Encoded): 'T =
+        x.Deserialize<'T>(FsCodec.Encoding.ToBlob utf8Encoded)
+
     /// Deserializes by reading from a stream.
     member _.DeserializeFromStream<'T>(utf8Stream: Stream): 'T =
         JsonSerializer.Deserialize<'T>(utf8Stream, options)

src/FsCodec/Encoding.fs

@@ -75,6 +75,8 @@ type Encoding private () =
         Impl.tryCompress options.minSize options.minGain x
     static member ToBlob(x: Encoded): ReadOnlyMemory<byte> =
         Impl.decode x
+    static member GetStringUtf8(x: Encoded): string =
+        System.Text.Encoding.UTF8.GetString(Encoding.ToBlob(x).Span)
     static member ByteCount((_encoding, data): Encoded) =
         data.Length
 

tests/FsCodec.NewtonsoftJson.Tests/Examples.fsx

@@ -2,7 +2,7 @@
 // dotnet build tests/FsCodec.NewtonsoftJson.Tests before attempting to send this to FSI with Alt-Enter
 
 #if !USE_LOCAL_BUILD
-#I "bin/Debug/net6.0"
+#I "bin/Debug/net9.0"
 #r "FsCodec.dll"
 #r "Newtonsoft.Json.dll"
 #r "FsCodec.NewtonsoftJson.dll"

tests/FsCodec.SystemTextJson.Tests/EncodingTests.fs

@@ -38,7 +38,7 @@ module InternalDecoding =
     let explicitBrotli = struct (2, JsonSerializer.SerializeToElement "CwuAeyJ2YWx1ZSI6IkhlbGxvIFdvcmxkIn0D")
 
     let decode useRom =
-        if useRom then FsCodec.SystemTextJson.Encoding.ToUtf8 >> _.ToArray() >> JsonSerializer.Deserialize
+        if useRom then fun x -> JsonSerializer.Deserialize(FsCodec.SystemTextJson.Encoding.ToUtf8(x).Span)
         else FsCodec.SystemTextJson.Encoding.ToJsonElement >> JsonSerializer.Deserialize
 
     let [<Theory; InlineData false; InlineData true>] ``Can decode all known representations`` useRom =

tests/FsCodec.SystemTextJson.Tests/Examples.fsx

@@ -3,7 +3,7 @@
 
 #if !USE_LOCAL_BUILD
 (* Rider's FSI is not happy without the explicit references :shrug: *)
-#I "bin/Debug/net6.0"
+#I "bin/Debug/net9.0"
 #r "FsCodec.dll"
 #r "System.Text.Json.dll"
 #r "FsCodec.SystemTextJson.dll"
@@ -208,7 +208,7 @@ module Events =
         interface TypeShape.UnionContract.IUnionContract
     let codec = Store.codec<Event>
 
-let utf8 (s: string) = System.Text.Encoding.UTF8.GetBytes(s) |> ReadOnlyMemory
+let utf8 (s: string) = System.Text.Encoding.UTF8.GetBytes(s) |> FsCodec.Encoding.OfBlob
 let streamForClient c = Stream.name (ClientId.parse c)
 let events = [
     Stream.name (ClientId.parse "ClientA"),                 FsCodec.Core.TimelineEvent.Create(0L, "Added",     utf8 """{ "item": "a" }""")
@@ -235,13 +235,13 @@ Log.initWithDebugLevel ()
 
 (* Explicit matching, showing how some ugly things get into the code if you do the streamName matching and event parsing separately *)
 
-// When we obtain events from an event store via streaming notifications, we typically receive them as ReadOnlyMemory<byte> bodies
+// When we obtain events from an event store via streaming notifications, we typically receive them as FsCodec.Encoded or ReadOnlyMemory<byte> bodies
 type Event = FsCodec.ITimelineEvent<EventBody>
-and EventBody = ReadOnlyMemory<byte>
+and EventBody = FsCodec.Encoded
 and Codec<'E> = FsCodec.IEventCodec<'E, EventBody, unit>
 
 let streamCodec<'E when 'E :> TypeShape.UnionContract.IUnionContract> : Codec<'E> =
-    Codec.Create<'E>(serdes = Store.serdes)
+    Codec.Create<'E>(serdes = Store.serdes) |> FsCodec.Encoder.Uncompressed
 
 let dec = streamCodec<Events.Event>
 let [<return:Struct>] (|DecodeEvent|_|) (codec: Codec<'E>) event = codec.Decode event
@@ -299,19 +299,19 @@ module Streams =
     // Events coming from streams are carried as a TimelineEvent; the body type is configurable
     type Event = FsCodec.ITimelineEvent<EventBody>
     // Propulsion's Sinks by default use ReadOnlyMemory<byte> as the storage format
-    and EventBody = ReadOnlyMemory<byte>
+    and EventBody = FsCodec.Encoded
     // the above Events can be decoded by a Codec implementing this interface
     and Codec<'E> = FsCodec.IEventCodec<'E, EventBody, unit>
 
     /// Generates a Codec for the specified Event Union type
     let codec<'E when 'E :> TypeShape.UnionContract.IUnionContract> : Codec<'E> =
         // Borrowing the Store serdes; frequently the events you parse can use less complex options...
-        Codec.Create<'E>(serdes = Store.serdes)
+        Codec.Create<'E>(serdes = Store.serdes) |> FsCodec.Encoder.Uncompressed
 
     // as we know our event bodies are all UTF8 encoded JSON, we can render the string as a log event property
     // alternately, you can render the EventBody directly and ensure you have appropriate type destructuring configured
     let private render (x: EventBody): string =
-        System.Text.Encoding.UTF8.GetString(x.Span)
+        FsCodec.Encoding.GetStringUtf8 x
     /// Uses the supplied codec to decode the supplied event record `x`
     /// (iff at LogEventLevel.Debug, detail fails to `log` citing the `streamName` and body)
     let decode<'E> (log: Serilog.ILogger) (codec: Codec<'E>) (streamName: FsCodec.StreamName) (x: Event) =
@@ -463,11 +463,11 @@ module StreamsWithMeta =
 
     let codec<'E when 'E :> TypeShape.UnionContract.IUnionContract> : Codec<'E> =
         // here we surface some metadata from the raw event as part of the application level type  
-        let up (raw: Streams.Event) (contract: 'E): Event<'E> =
+        let up (raw: FsCodec.ITimelineEvent<ReadOnlyMemory<byte>>) (contract: 'E): Event<'E> =
             struct (raw.Index, serdes.Deserialize<Metadata> raw.Meta, contract)
         // We are not using this codec to encode events, so we let the encoding side fail very fast
         let down _ = failwith "N/A"
-        Codec.Create<Event<'E>, 'E, Metadata>(up, down, serdes = Store.serdes) 
+        Codec.Create<Event<'E>, 'E, Metadata>(up, down, serdes = Store.serdes) |> FsCodec.Encoder.Uncompressed
 
 let eventsWithMeta = seq {
     for sn, e in events ->