Update to BinaryData deserializer to support Any and AnyObject (Azure#27599)

* update to BinaryData deserializer to support Any and AnyObject

* update api

* update test case for net461

* clean up test case from comments

* update test references

* missed using

* Update sdk/core/Azure.Core/src/Serialization/AzureCoreExtensions.cs

Co-authored-by: Christopher Scott <chriss@microsoft.com>

* update comment

Co-authored-by: Christopher Scott <chriss@microsoft.com>

Author: m-nash

sdk/compute/Azure.ResourceManager.Compute/tests/Scenario/VirtualMachineTestBase.cs

@@ -64,7 +64,7 @@ protected async Task<GenericResource> CreateVirtualNetwork()
 
         protected ResourceIdentifier GetSubnetId(GenericResource vnet)
         {
-            var properties = vnet.Data.Properties.ToDictionaryFromJson();
+            var properties = vnet.Data.Properties.ToObjectFromJson() as Dictionary<string, object>;
             var subnets = properties["subnets"] as IEnumerable<object>;
             var subnet = subnets.First() as IDictionary<string, object>;
             return new ResourceIdentifier(subnet["id"] as string);

sdk/core/Azure.Core/api/Azure.Core.net461.cs

@@ -17,8 +17,8 @@ protected AsyncPageable(System.Threading.CancellationToken cancellationToken) {
     }
     public static partial class AzureCoreExtensions
     {
-        public static System.Collections.Generic.IDictionary<string, object?> ToDictionaryFromJson(this System.BinaryData data) { throw null; }
         public static System.Threading.Tasks.ValueTask<T?> ToObjectAsync<T>(this System.BinaryData data, Azure.Core.Serialization.ObjectSerializer serializer, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
+        public static object? ToObjectFromJson(this System.BinaryData data) { throw null; }
         public static T? ToObject<T>(this System.BinaryData data, Azure.Core.Serialization.ObjectSerializer serializer, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
     }
     public partial class AzureKeyCredential

sdk/core/Azure.Core/api/Azure.Core.net5.0.cs

@@ -17,8 +17,8 @@ protected AsyncPageable(System.Threading.CancellationToken cancellationToken) {
     }
     public static partial class AzureCoreExtensions
     {
-        public static System.Collections.Generic.IDictionary<string, object?> ToDictionaryFromJson(this System.BinaryData data) { throw null; }
         public static System.Threading.Tasks.ValueTask<T?> ToObjectAsync<T>(this System.BinaryData data, Azure.Core.Serialization.ObjectSerializer serializer, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
+        public static object? ToObjectFromJson(this System.BinaryData data) { throw null; }
         public static T? ToObject<T>(this System.BinaryData data, Azure.Core.Serialization.ObjectSerializer serializer, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
     }
     public partial class AzureKeyCredential

sdk/core/Azure.Core/api/Azure.Core.netcoreapp2.1.cs

@@ -17,8 +17,8 @@ protected AsyncPageable(System.Threading.CancellationToken cancellationToken) {
     }
     public static partial class AzureCoreExtensions
     {
-        public static System.Collections.Generic.IDictionary<string, object?> ToDictionaryFromJson(this System.BinaryData data) { throw null; }
         public static System.Threading.Tasks.ValueTask<T?> ToObjectAsync<T>(this System.BinaryData data, Azure.Core.Serialization.ObjectSerializer serializer, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
+        public static object? ToObjectFromJson(this System.BinaryData data) { throw null; }
         public static T? ToObject<T>(this System.BinaryData data, Azure.Core.Serialization.ObjectSerializer serializer, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
     }
     public partial class AzureKeyCredential

sdk/core/Azure.Core/api/Azure.Core.netstandard2.0.cs

@@ -17,8 +17,8 @@ protected AsyncPageable(System.Threading.CancellationToken cancellationToken) {
     }
     public static partial class AzureCoreExtensions
     {
-        public static System.Collections.Generic.IDictionary<string, object?> ToDictionaryFromJson(this System.BinaryData data) { throw null; }
         public static System.Threading.Tasks.ValueTask<T?> ToObjectAsync<T>(this System.BinaryData data, Azure.Core.Serialization.ObjectSerializer serializer, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
+        public static object? ToObjectFromJson(this System.BinaryData data) { throw null; }
         public static T? ToObject<T>(this System.BinaryData data, Azure.Core.Serialization.ObjectSerializer serializer, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
     }
     public partial class AzureKeyCredential

sdk/core/Azure.Core/perf/DynamicObjectBenchmark.cs

@@ -88,7 +88,7 @@ public void DeserializeWithBinaryData()
         public void DeserializeWithBinaryDataAndAccess()
         {
             var model = ModelWithBinaryData.DeserializeModelWithBinaryData(_jsonDocument.RootElement);
-            var properties = model.Properties.ToDictionaryFromJson();
+            var properties = model.Properties.ToObjectFromJson() as Dictionary<string, object>;
             var innerProperties = properties["innerProperties"] as Dictionary<string, object>;
             var innerA = innerProperties["a"] as string;
         }

sdk/core/Azure.Core/src/Serialization/AzureCoreExtensions.cs

@@ -44,17 +44,18 @@ public static class AzureCoreExtensions
             (T?)await serializer.DeserializeAsync(data.ToStream(), typeof(T), cancellationToken).ConfigureAwait(false);
 
         /// <summary>
-        /// Converts the <see cref="BinaryData"/> to a Dictionary of string to object.
-        /// Each value in the key value pair will be strongly typed as an int, long, string, Guid, double or bool.
-        /// Each value can also be another Dictionary of string object representing an inner object or
-        /// a List of objects representing an array.
+        /// Converts the json value represented by <see cref="BinaryData"/> to an object of a specific type.
         /// </summary>
         /// <param name="data">The <see cref="BinaryData"/> instance to convert.</param>
-        /// <returns>The data converted to the Dictionary of string to object.</returns>
-        public static IDictionary<string, object?> ToDictionaryFromJson(this BinaryData data)
+        /// <returns> The object value of the json value.
+        /// If the object contains a primitive type such as string, int, double, bool, or null literal, it returns that type.
+        /// Otherwise, it returns either an object[] or Dictionary&lt;string, object&gt;.
+        /// Each value in the key value pair or list will also be converted into a primitive or another complex type recursively.
+        /// </returns>
+        public static object? ToObjectFromJson(this BinaryData data)
         {
             JsonElement element = data.ToObjectFromJson<JsonElement>();
-            return element.GetObject() as Dictionary<string, object?> ?? throw new InvalidOperationException("The BinaryData instance did not represent a JSON object so it cannot be converted into a dictionary.");
+            return element.GetObject();
         }
 
         private static object? GetObject(in this JsonElement element)

sdk/core/Azure.Core/tests/BinaryDataSerializationTests.cs

@@ -16,13 +16,74 @@ namespace Azure.Core.Tests
 {
     public class BinaryDataSerializationTests
     {
+        [Test]
+        public void DeserializeModelWithDictionaryOfBinaryData()
+        {
+            using var fs = File.Open(GetFileName("JsonFormattedStringDictOfBinaryData.json"), FileMode.Open, FileAccess.Read, FileShare.Read);
+            using var document = JsonDocument.Parse(fs);
+            var data = ModelWithBinaryDataInDictionary.DeserializeModelWithBinaryDataInDictionary(document.RootElement);
+
+            Assert.AreEqual("a.value", data.A);
+            Assert.AreEqual("1", data.Details["strValue"].ToObjectFromJson<string>());
+            Assert.IsTrue(data.Details["strValue"].ToObjectFromJson() is string);
+            Assert.AreEqual(1, data.Details["intValue"].ToObjectFromJson<int>());
+            Assert.IsTrue(data.Details["intValue"].ToObjectFromJson() is int);
+            Assert.AreEqual(1.1, data.Details["doubleValue"].ToObjectFromJson<double>());
+            Assert.IsTrue(data.Details["doubleValue"].ToObjectFromJson() is double);
+
+            var toObjectWithT = data.Details["innerProperties"].ToObjectFromJson<Dictionary<string, object>>();
+            var jsonElementObject = data.Details["innerProperties"].ToObjectFromJson<object>();
+            Assert.IsTrue(jsonElementObject is JsonElement);
+            var jsonDictionary = data.Details["innerProperties"].ToObjectFromJson();
+            Assert.IsTrue(jsonDictionary is Dictionary<string, object>);
+            Assert.IsTrue(toObjectWithT["strValue"] is JsonElement);
+
+            var dict = data.Details["innerProperties"].ToObjectFromJson() as Dictionary<string, object>;
+            Assert.AreEqual("2", (string)dict["strValue"]);
+            Assert.AreEqual(2, (int)dict["intValue"]);
+            Assert.AreEqual(2.2, (double)dict["doubleValue"]);
+        }
+
+        [Test]
+        public void CanConvertInt()
+        {
+            using var fs = File.Open(GetFileName("JsonFormattedStringInt.json"), FileMode.Open, FileAccess.Read, FileShare.Read);
+            using var document = JsonDocument.Parse(fs);
+            var data = ModelWithBinaryData.DeserializeModelWithBinaryData(document.RootElement);
+
+            Assert.AreEqual("a.value", data.A);
+            Assert.AreEqual(1, data.Properties.ToObjectFromJson<int>());
+        }
+
+        [Test]
+        public void CanConvertDouble()
+        {
+            using var fs = File.Open(GetFileName("JsonFormattedStringDouble.json"), FileMode.Open, FileAccess.Read, FileShare.Read);
+            using var document = JsonDocument.Parse(fs);
+            var data = ModelWithBinaryData.DeserializeModelWithBinaryData(document.RootElement);
+
+            Assert.AreEqual("a.value", data.A);
+            Assert.AreEqual(1.1, data.Properties.ToObjectFromJson<double>());
+        }
+
+        [Test]
+        public void CanConvertString()
+        {
+            using var fs = File.Open(GetFileName("JsonFormattedStringString.json"), FileMode.Open, FileAccess.Read, FileShare.Read);
+            using var document = JsonDocument.Parse(fs);
+            var data = ModelWithBinaryData.DeserializeModelWithBinaryData(document.RootElement);
+
+            Assert.AreEqual("a.value", data.A);
+            Assert.AreEqual("1", data.Properties.ToObjectFromJson<string>());
+        }
+
         [Test]
         public void CanConvertDifferentValueTypes()
         {
             var expected = File.ReadAllText(GetFileName("PropertiesWithDifferentValueTypes.json")).TrimEnd();
             var model = BinaryData.FromString(expected);
 
-            var properties = model.ToDictionaryFromJson();
+            var properties = model.ToObjectFromJson() as Dictionary<string, object>;
             Assert.AreEqual(typeof(string), properties["stringValue"].GetType());
             Assert.AreEqual(typeof(string), properties["dateTimeValue"].GetType());
             Assert.AreEqual(typeof(int), properties["intValue"].GetType());
@@ -41,7 +102,7 @@ public void CanConvertArrays()
             var expected = File.ReadAllText(GetFileName("PropertiesWithArrays.json")).TrimEnd();
             var model = BinaryData.FromString(expected);
 
-            var properties = model.ToDictionaryFromJson();
+            var properties = model.ToObjectFromJson() as Dictionary<string, object>;
             Assert.IsTrue(AllValuesAreType(typeof(string), properties["stringArray"]));
             Assert.IsTrue(AllValuesAreType(typeof(string), properties["dateTimeArray"]));
             Assert.IsTrue(AllValuesAreType(typeof(int), properties["intArray"]));
@@ -72,7 +133,7 @@ public void CanConvertArrayOfObjects()
         {
             var expected = File.ReadAllText(GetFileName("PropertiesWithArraysOfObjects.json")).TrimEnd();
             var model = BinaryData.FromString(expected);
-            var properties = model.ToDictionaryFromJson();
+            var properties = model.ToObjectFromJson() as Dictionary<string, object>;
             var objArray = properties["objectArray"] as object[];
             for (int i = 0; i < 3; i++)
             {
@@ -91,7 +152,7 @@ public void CanConvertArrayOfArrays()
         {
             var expected = File.ReadAllText(GetFileName("PropertiesWithArraysOfArrays.json")).TrimEnd();
             var model = BinaryData.FromString(expected);
-            var properties = model.ToDictionaryFromJson();
+            var properties = model.ToObjectFromJson() as Dictionary<string, object>;
             var arrayArray = properties["arrayArray"] as object[];
             Assert.IsNotNull(arrayArray);
             for (int i = 0; i < 2; i++)
@@ -141,7 +202,7 @@ public void DeserializeJsonFormattedStringWithBinaryData()
                 var data = ModelWithBinaryData.DeserializeModelWithBinaryData(document.RootElement);
                 Assert.AreEqual("a.value", data.A);
 
-                var properties = data.Properties.ToDictionaryFromJson();
+                var properties = data.Properties.ToObjectFromJson() as Dictionary<string, object>;
                 Assert.AreEqual("properties.a.value", properties["a"]);
                 var innerProperties = properties["innerProperties"] as IDictionary<string, object>;
                 Assert.AreEqual("properties.innerProperties.a.value", innerProperties["a"]);
@@ -177,6 +238,34 @@ public void SerailizeUsingJsonFormattedString()
             Assert.AreEqual(expected, actual);
         }
 
+        [Test]
+        public void SerailizeUsingJsonFormattedStringForDictOfBinaryData()
+        {
+#if NET461
+            var expected = File.ReadAllText(GetFileName("JsonFormattedStringDictOfBinaryDataNet461.json")).TrimEnd();
+#else
+            var expected = File.ReadAllText(GetFileName("JsonFormattedStringDictOfBinaryData.json")).TrimEnd();
+#endif
+
+            var payload = new ModelWithBinaryDataInDictionary { A = "a.value" };
+
+            var details = new Dictionary<string, BinaryData>();
+            details["strValue"] = BinaryData.FromObjectAsJson("1");
+            details["intValue"] = BinaryData.FromObjectAsJson(1);
+            details["doubleValue"] = BinaryData.FromObjectAsJson(1.1);
+
+            var innerProperties = new Dictionary<string, object>();
+            innerProperties["strValue"] = "2";
+            innerProperties["intValue"] = 2;
+            innerProperties["doubleValue"] = 2.2;
+
+            details["innerProperties"] = BinaryData.FromObjectAsJson(innerProperties);
+            payload.Details = details;
+
+            string actual = GetSerializedString(payload);
+            Assert.AreEqual(expected, actual);
+        }
+
         [Test]
         public void SerailizeUsingStream()
         {

sdk/core/Azure.Core/tests/ModelWithBinaryDataInDictionary.cs

@@ -0,0 +1,82 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using System;
+using Azure.Core;
+using System.Text.Json;
+using System.IO;
+using System.Collections.Generic;
+
+namespace Azure.Core.Tests
+{
+    internal class ModelWithBinaryDataInDictionary : IUtf8JsonSerializable
+    {
+        public string A { get; set; }
+        public IReadOnlyDictionary<string, BinaryData> Details { get; set; }
+
+        public ModelWithBinaryDataInDictionary() { }
+
+        private ModelWithBinaryDataInDictionary(string a, IReadOnlyDictionary<string, BinaryData> details)
+        {
+            A = a;
+            Details = details;
+        }
+
+        public void Write(Utf8JsonWriter writer)
+        {
+            writer.WriteStartObject();
+            if (Optional.IsDefined(A))
+            {
+                writer.WritePropertyName("a");
+                writer.WriteStringValue(A);
+            }
+            if (Optional.IsDefined(Details))
+            {
+                //THIS DOESN'T WORK WITH OUR CURRENT AUTOREST
+                writer.WritePropertyName("details");
+                writer.WriteStartObject();
+                foreach (var kv in Details)
+                {
+                    writer.WritePropertyName(kv.Key);
+#if NET6_0_OR_GREATER
+                    writer.WriteRawValue(kv.Value);
+#else
+                    JsonSerializer.Serialize(writer, JsonDocument.Parse(kv.Value.ToString()).RootElement);
+#endif
+                }
+                writer.WriteEndObject();
+            }
+            writer.WriteEndObject();
+        }
+
+        internal static ModelWithBinaryDataInDictionary DeserializeModelWithBinaryDataInDictionary(JsonElement element)
+        {
+            Optional<string> a = default;
+            Optional<IReadOnlyDictionary<string, BinaryData>> details = default;
+            foreach (var property in element.EnumerateObject())
+            {
+                if (property.NameEquals("a"))
+                {
+                    a = property.Value.GetString();
+                    continue;
+                }
+                if (property.NameEquals("details"))
+                {
+                    if (property.Value.ValueKind == JsonValueKind.Null)
+                    {
+                        property.ThrowNonNullablePropertyIsNull();
+                        continue;
+                    }
+                    Dictionary<string, BinaryData> dictionary = new Dictionary<string, BinaryData>();
+                    foreach (var property1 in property.Value.EnumerateObject())
+                    {
+                        dictionary.Add(property1.Name, BinaryData.FromString(property1.Value.GetRawText()));
+                    }
+                    details = dictionary;
+                    continue;
+                }
+            }
+            return new ModelWithBinaryDataInDictionary(a.Value, details.Value);
+        }
+    }
+}

sdk/core/Azure.Core/tests/TestData/BinaryData/JsonFormattedStringDictOfBinaryData.json

@@ -0,0 +1 @@
+{"a":"a.value","details":{"strValue":"1","intValue":1,"doubleValue":1.1,"innerProperties":{"strValue":"2","intValue":2,"doubleValue":2.2}}}