Add JsonTypeInfo overloads to System.Memory.Data

[eerhardt]

Background and Motivation

In 6.0, we have added APIs to System.Text.Json and System.Net.Http.Json that take a JsonTypeInfo or JsonSerializerContext. See #1568 for the reasons and advantages of these overloads.

We have very thin wrapper APIs in System.Memory.Data around JsonSerializer, however these APIs weren't updated for JsonTypeInfo overloads. We should add them to get the same advantages as listed above.

Proposed API

namespace System
{
    public partial class BinaryData
    {
        // exisitng APIs
        public BinaryData(object? jsonSerializable, System.Text.Json.JsonSerializerOptions? options = null, System.Type? type = null) { }
        public static System.BinaryData FromObjectAsJson<T>(T jsonSerializable, System.Text.Json.JsonSerializerOptions? options = null) { throw null; }
        public T? ToObjectFromJson<T>(System.Text.Json.JsonSerializerOptions? options = null) { throw null; }

        // new proposed APIs
+       public BinaryData(object? jsonSerializable, System.Text.Json.Serialization.JsonSerializerContext context, System.Type? type = null) { }
+       public static System.BinaryData FromObjectAsJson<T>(T jsonSerializable, System.Text.Json.Serialization.Metadata.JsonTypeInfo<T> jsonTypeInfo) { throw null; }
+       public T? ToObjectFromJson<T>(System.Text.Json.Serialization.Metadata.JsonTypeInfo<T> jsonTypeInfo) { throw null; }
    }
}

Usage Examples

var myObject = new MyType();

var binaryData = new BinaryData(myObject, JsonContext.Default);
// --- or ---
var binaryData = BinaryData.FromObjectAsJson(myObject, JsonContext.Default.MyType);


var myObject2 = binaryData.ToObjectFromJson(JsonContext.Default.MyType);

Alternative Designs

N/A

Risks

None

cc @layomia @JoshLove-msft @KrzysztofCwalina

[ghost]

Tagging subscribers to this area: @GrabYourPitchforks, @dotnet/area-system-memory
See info in area-owners.md if you want to be subscribed.

Issue Details

---

Background and Motivation

In 6.0, we have added APIs to System.Text.Json and System.Net.Http.Json that take a JsonTypeInfo or JsonSerializerContext. See #1568 for the reasons and advantages of these overloads.

We have very thin wrapper APIs in System.Memory.Data around JsonSerializer, however these APIs weren't updated for JsonTypeInfo overloads. We should add them to get the same advantages as listed above.

Proposed API

namespace System
{
    public partial class BinaryData
    {
        // exisitng APIs
        public BinaryData(object? jsonSerializable, System.Text.Json.JsonSerializerOptions? options = null, System.Type? type = null) { }
        public static System.BinaryData FromObjectAsJson<T>(T jsonSerializable, System.Text.Json.JsonSerializerOptions? options = null) { throw null; }
        public T? ToObjectFromJson<T>(System.Text.Json.JsonSerializerOptions? options = null) { throw null; }

        // new proposed APIs
+       public BinaryData(object? jsonSerializable, System.Text.Json.Serialization.JsonSerializerContext context, System.Type? type = null) { }
+       public static System.BinaryData FromObjectAsJson<T>(T jsonSerializable, System.Text.Json.Serialization.Metadata.JsonTypeInfo<T> jsonTypeInfo) { throw null; }
+       public T? ToObjectFromJson<T>(System.Text.Json.Serialization.Metadata.JsonTypeInfo<T> jsonTypeInfo) { throw null; }
    }
}

Usage Examples

var myObject = new MyType();

var binaryData = new BinaryData(myObject, JsonContext.Default);
// --- or ---
var binaryData = BinaryData.FromObjectAsJson(myObject, JsonContext.Default.MyType);


var myObject2 = binaryData.ToObjectFromJson(JsonContext.Default.MyType);

Alternative Designs

N/A

Risks

None

cc @layomia @JoshLove-msft @KrzysztofCwalina

Author:	eerhardt
Assignees:	-
Labels:	api-suggestion, area-System.Memory
Milestone:	-

[eerhardt]

Given there hasn't been any feedback on this. I'm going to move it to ready for review.

[terrajobst]

Video

• Looks good as proposed

namespace System;

public partial class BinaryData
{
    // Existing APIs
    // public BinaryData(object? jsonSerializable, JsonSerializerOptions? options = null, Type? type = null);
    // public static BinaryData FromObjectAsJson<T>(T jsonSerializable, JsonSerializerOptions? options = null);
    // public T? ToObjectFromJson<T>(JsonSerializerOptions? options = null);

    // New APIs
    public BinaryData(object? jsonSerializable, JsonSerializerContext context, Type? type = null);
    public static BinaryData FromObjectAsJson<T>(T jsonSerializable, JsonTypeInfo<T> jsonTypeInfo);
    public T? ToObjectFromJson<T>(JsonTypeInfo<T> jsonTypeInfo);
}

[danmoseley]

@eerhardt should this be labeled 'up for grabs'

[Tarun047]

Hi guys I'd like to take this one up.
@eerhardt, @danmoseley please review my for Initial implementation and suggest if any changes are needed

[KrzysztofCwalina]

Will System.Memory.Data remain a NetStandard 2.0 package after this change?

[eerhardt]

Yes, System.Memory.Data still supports netstandard2.0 after this change:

runtime/src/libraries/System.Memory.Data/src/System.Memory.Data.csproj

Line 3 in fededf1

<TargetFrameworks>$(NetCoreAppCurrent);$(NetCoreAppMinimum);netstandard2.0;$(NetFrameworkMinimum)</TargetFrameworks>

The JsonTypeInfo type comes from System.Text.Json, which also supports netstandard2.0.