JsonModel for protocol models (#53701)

Author: christothes

sdk/core/System.ClientModel/api/System.ClientModel.net8.0.cs

@@ -263,6 +263,17 @@ public JsonModelConverter(System.ClientModel.Primitives.ModelReaderWriterOptions
         public override System.ClientModel.Primitives.IJsonModel<object>? Read(ref System.Text.Json.Utf8JsonReader reader, System.Type typeToConvert, System.Text.Json.JsonSerializerOptions options) { throw null; }
         public override void Write(System.Text.Json.Utf8JsonWriter writer, System.ClientModel.Primitives.IJsonModel<object> value, System.Text.Json.JsonSerializerOptions options) { }
     }
+    public abstract partial class JsonModel<T> : System.ClientModel.Primitives.IJsonModel<T>, System.ClientModel.Primitives.IPersistableModel<T>
+    {
+        protected JsonModel() { }
+        public T Create(System.BinaryData data, System.ClientModel.Primitives.ModelReaderWriterOptions? options = null) { throw null; }
+        protected abstract T CreateCore(ref System.Text.Json.Utf8JsonReader reader, System.ClientModel.Primitives.ModelReaderWriterOptions options);
+        T System.ClientModel.Primitives.IJsonModel<T>.Create(ref System.Text.Json.Utf8JsonReader reader, System.ClientModel.Primitives.ModelReaderWriterOptions options) { throw null; }
+        void System.ClientModel.Primitives.IJsonModel<T>.Write(System.Text.Json.Utf8JsonWriter writer, System.ClientModel.Primitives.ModelReaderWriterOptions options) { }
+        string System.ClientModel.Primitives.IPersistableModel<T>.GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions options) { throw null; }
+        System.BinaryData System.ClientModel.Primitives.IPersistableModel<T>.Write(System.ClientModel.Primitives.ModelReaderWriterOptions options) { throw null; }
+        protected abstract void WriteCore(System.Text.Json.Utf8JsonWriter writer, System.ClientModel.Primitives.ModelReaderWriterOptions options);
+    }
     [System.Diagnostics.CodeAnalysis.ExperimentalAttribute("SCME0001")]
     [System.Runtime.InteropServices.StructLayoutAttribute(System.Runtime.InteropServices.LayoutKind.Sequential)]
     public partial struct JsonPatch

sdk/core/System.ClientModel/api/System.ClientModel.net9.0.cs

@@ -263,6 +263,17 @@ public JsonModelConverter(System.ClientModel.Primitives.ModelReaderWriterOptions
         public override System.ClientModel.Primitives.IJsonModel<object>? Read(ref System.Text.Json.Utf8JsonReader reader, System.Type typeToConvert, System.Text.Json.JsonSerializerOptions options) { throw null; }
         public override void Write(System.Text.Json.Utf8JsonWriter writer, System.ClientModel.Primitives.IJsonModel<object> value, System.Text.Json.JsonSerializerOptions options) { }
     }
+    public abstract partial class JsonModel<T> : System.ClientModel.Primitives.IJsonModel<T>, System.ClientModel.Primitives.IPersistableModel<T>
+    {
+        protected JsonModel() { }
+        public T Create(System.BinaryData data, System.ClientModel.Primitives.ModelReaderWriterOptions? options = null) { throw null; }
+        protected abstract T CreateCore(ref System.Text.Json.Utf8JsonReader reader, System.ClientModel.Primitives.ModelReaderWriterOptions options);
+        T System.ClientModel.Primitives.IJsonModel<T>.Create(ref System.Text.Json.Utf8JsonReader reader, System.ClientModel.Primitives.ModelReaderWriterOptions options) { throw null; }
+        void System.ClientModel.Primitives.IJsonModel<T>.Write(System.Text.Json.Utf8JsonWriter writer, System.ClientModel.Primitives.ModelReaderWriterOptions options) { }
+        string System.ClientModel.Primitives.IPersistableModel<T>.GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions options) { throw null; }
+        System.BinaryData System.ClientModel.Primitives.IPersistableModel<T>.Write(System.ClientModel.Primitives.ModelReaderWriterOptions options) { throw null; }
+        protected abstract void WriteCore(System.Text.Json.Utf8JsonWriter writer, System.ClientModel.Primitives.ModelReaderWriterOptions options);
+    }
     [System.Diagnostics.CodeAnalysis.ExperimentalAttribute("SCME0001")]
     [System.Runtime.InteropServices.StructLayoutAttribute(System.Runtime.InteropServices.LayoutKind.Sequential)]
     public partial struct JsonPatch

sdk/core/System.ClientModel/api/System.ClientModel.netstandard2.0.cs

@@ -262,6 +262,17 @@ public JsonModelConverter(System.ClientModel.Primitives.ModelReaderWriterOptions
         public override System.ClientModel.Primitives.IJsonModel<object>? Read(ref System.Text.Json.Utf8JsonReader reader, System.Type typeToConvert, System.Text.Json.JsonSerializerOptions options) { throw null; }
         public override void Write(System.Text.Json.Utf8JsonWriter writer, System.ClientModel.Primitives.IJsonModel<object> value, System.Text.Json.JsonSerializerOptions options) { }
     }
+    public abstract partial class JsonModel<T> : System.ClientModel.Primitives.IJsonModel<T>, System.ClientModel.Primitives.IPersistableModel<T>
+    {
+        protected JsonModel() { }
+        public T Create(System.BinaryData data, System.ClientModel.Primitives.ModelReaderWriterOptions? options = null) { throw null; }
+        protected abstract T CreateCore(ref System.Text.Json.Utf8JsonReader reader, System.ClientModel.Primitives.ModelReaderWriterOptions options);
+        T System.ClientModel.Primitives.IJsonModel<T>.Create(ref System.Text.Json.Utf8JsonReader reader, System.ClientModel.Primitives.ModelReaderWriterOptions options) { throw null; }
+        void System.ClientModel.Primitives.IJsonModel<T>.Write(System.Text.Json.Utf8JsonWriter writer, System.ClientModel.Primitives.ModelReaderWriterOptions options) { }
+        string System.ClientModel.Primitives.IPersistableModel<T>.GetFormatFromOptions(System.ClientModel.Primitives.ModelReaderWriterOptions options) { throw null; }
+        System.BinaryData System.ClientModel.Primitives.IPersistableModel<T>.Write(System.ClientModel.Primitives.ModelReaderWriterOptions options) { throw null; }
+        protected abstract void WriteCore(System.Text.Json.Utf8JsonWriter writer, System.ClientModel.Primitives.ModelReaderWriterOptions options);
+    }
     [System.Runtime.InteropServices.StructLayoutAttribute(System.Runtime.InteropServices.LayoutKind.Sequential)]
     public partial struct JsonPatch
     {

sdk/core/System.ClientModel/src/ModelReaderWriter/JsonModel.cs

@@ -0,0 +1,80 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using System.Text.Json;
+
+namespace System.ClientModel.Primitives;
+
+/// <summary>
+/// Helper class for JSON models implementing <see cref="IJsonModel{T}"/>.
+/// </summary>
+/// <typeparam name="T">The type of the model represented by this JSON model.</typeparam>
+public abstract class JsonModel<T> : IJsonModel<T>, IPersistableModel<T>
+{
+    /// <summary>
+    /// Writes the model to the provided <see cref="Utf8JsonWriter"/>.
+    /// </summary>
+    /// <param name="writer">The <see cref="Utf8JsonWriter"/> to write into.</param>
+    /// <param name="options">The <see cref="ModelReaderWriterOptions"/> to use.</param>
+    protected abstract void WriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
+
+    /// <summary>
+    /// Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
+    /// </summary>
+    /// <param name="reader">The <see cref="Utf8JsonReader"/> to read from.</param>
+    /// <param name="options">The <see cref="ModelReaderWriterOptions"/> to use.</param>
+    /// <returns>The model created from the JSON value.</returns>
+    protected abstract T CreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
+
+    #region MRW
+    T IJsonModel<T>.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options)
+    {
+        ValidateFormat(options);
+        return CreateCore(ref reader, options);
+    }
+
+    /// <summary>
+    /// Converts the provided <see cref="BinaryData"/> into a model.
+    /// </summary>
+    /// <param name="data">The <see cref="BinaryData"/> to parse.</param>
+    /// <param name="options">The <see cref="ModelReaderWriterOptions"/> to use.</param>
+    /// <returns>The model created from the data.</returns>
+    public T Create(BinaryData data, ModelReaderWriterOptions? options = null)
+    {
+        options ??= ModelReaderWriterOptions.Json;
+        ValidateFormat(options);
+
+        var reader = new Utf8JsonReader(data.ToMemory().Span);
+        return CreateCore(ref reader, options);
+    }
+
+    string IPersistableModel<T>.GetFormatFromOptions(ModelReaderWriterOptions options) => "J";
+
+    void IJsonModel<T>.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options)
+    {
+        ValidateFormat(options);
+        WriteCore(writer, options);
+    }
+
+    BinaryData IPersistableModel<T>.Write(ModelReaderWriterOptions options)
+    {
+        ValidateFormat(options);
+        using MemoryStream stream = new MemoryStream();
+        using Utf8JsonWriter writer = new Utf8JsonWriter(stream);
+        WriteCore(writer, options);
+        writer.Flush();
+        byte[] buffer = stream.GetBuffer();
+        ReadOnlyMemory<byte> memory = buffer.AsMemory(0, (int)stream.Position);
+        return new BinaryData(memory);
+    }
+
+    private static void ValidateFormat(ModelReaderWriterOptions options)
+    {
+        if (options.Format != "J" && options.Format != "W")
+        {
+            throw new FormatException($"The model does not support '{options.Format}' format. Supported formats are 'J' and 'W'.");
+        }
+    }
+
+    #endregion
+}