Move BinaryData extensions to Core (Azure#18205)

JoshLove-msft · web-flow · commit 08d2f3ea09ba · 2021-01-28T13:28:39.000-08:00
* Move BinaryData extensions to Core

* PR fb

* Rename

* SB test

* update proj ref
diff --git a/sdk/core/Azure.Core.Experimental/CHANGELOG.md b/sdk/core/Azure.Core.Experimental/CHANGELOG.md
@@ -1,7 +1,7 @@
 # Release History
 
 ## 0.1.0-preview.8 (Unreleased)
-
+- Methods from `SerializationExtensions` moved into `Azure.Core` package.
 
 ## 0.1.0-preview.7 (2020-10-28)
 
diff --git a/sdk/core/Azure.Core.Experimental/api/Azure.Core.Experimental.netstandard2.0.cs b/sdk/core/Azure.Core.Experimental/api/Azure.Core.Experimental.netstandard2.0.cs
@@ -1,13 +1,3 @@
-namespace Azure
-{
-    public static partial class SerializationExtensions
-    {
-        public static System.BinaryData SerializeToBinaryData(this Azure.Core.Serialization.ObjectSerializer serializer, object? value, System.Type? inputType = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
-        public static System.Threading.Tasks.ValueTask<System.BinaryData> SerializeToBinaryDataAsync(this Azure.Core.Serialization.ObjectSerializer serializer, object? value, System.Type? inputType = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { 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 T? ToObject<T>(this System.BinaryData data, Azure.Core.Serialization.ObjectSerializer serializer, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
-    }
-}
 namespace Azure.Core
 {
     public partial class DynamicJson : System.Dynamic.IDynamicMetaObjectProvider
diff --git a/sdk/core/Azure.Core.Experimental/src/Azure.Core.Experimental.csproj b/sdk/core/Azure.Core.Experimental/src/Azure.Core.Experimental.csproj
@@ -13,10 +13,6 @@
     <ProjectReference Include="../../Azure.Core/src/Azure.Core.csproj" />
   </ItemGroup>
 
-  <ItemGroup>
-    <PackageReference Include="System.Memory.Data" />
-  </ItemGroup>
-
   <ItemGroup>
     <Compile Include="$(AzureCoreSharedSources)Argument.cs" />
     <Compile Include="$(AzureCoreSharedSources)HashCodeBuilder.cs" />
diff --git a/sdk/core/Azure.Core.Experimental/src/Serialization/SerializationExtensions.cs b/sdk/core/Azure.Core.Experimental/src/Serialization/SerializationExtensions.cs
diff --git a/sdk/core/Azure.Core/CHANGELOG.md b/sdk/core/Azure.Core/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 ## 1.9.0-beta.1 (Unreleased)
 
+## Added
+- Added Serialize overloads on `ObjectSerializer` that serialize to `BinaryData`.
+- Added AzureCoreExtensions containing extensions methods for `BinaryData` that allow deserializing with an `ObjectSerializer`.
+
 ### Key Bug Fixes
 
 - Avoid `ObjectDisposedException` when the request is cancelled during content upload over HTTPS.
diff --git a/sdk/core/Azure.Core/api/Azure.Core.net461.cs b/sdk/core/Azure.Core/api/Azure.Core.net461.cs
@@ -15,6 +15,11 @@ protected AsyncPageable(System.Threading.CancellationToken cancellationToken) {
         [System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]
         public override string? ToString() { throw null; }
     }
+    public static partial class AzureCoreExtensions
+    {
+        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 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
     {
         public AzureKeyCredential(string key) { }
@@ -550,6 +555,8 @@ protected ObjectSerializer() { }
         public abstract object? Deserialize(System.IO.Stream stream, System.Type returnType, System.Threading.CancellationToken cancellationToken);
         public abstract System.Threading.Tasks.ValueTask<object?> DeserializeAsync(System.IO.Stream stream, System.Type returnType, System.Threading.CancellationToken cancellationToken);
         public abstract void Serialize(System.IO.Stream stream, object? value, System.Type inputType, System.Threading.CancellationToken cancellationToken);
+        public virtual System.BinaryData Serialize(object? value, System.Type? inputType = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
         public abstract System.Threading.Tasks.ValueTask SerializeAsync(System.IO.Stream stream, object? value, System.Type inputType, System.Threading.CancellationToken cancellationToken);
+        public virtual System.Threading.Tasks.ValueTask<System.BinaryData> SerializeAsync(object? value, System.Type? inputType = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
     }
 }
diff --git a/sdk/core/Azure.Core/api/Azure.Core.net5.0.cs b/sdk/core/Azure.Core/api/Azure.Core.net5.0.cs
@@ -15,6 +15,11 @@ protected AsyncPageable(System.Threading.CancellationToken cancellationToken) {
         [System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]
         public override string? ToString() { throw null; }
     }
+    public static partial class AzureCoreExtensions
+    {
+        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 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
     {
         public AzureKeyCredential(string key) { }
@@ -550,6 +555,8 @@ protected ObjectSerializer() { }
         public abstract object? Deserialize(System.IO.Stream stream, System.Type returnType, System.Threading.CancellationToken cancellationToken);
         public abstract System.Threading.Tasks.ValueTask<object?> DeserializeAsync(System.IO.Stream stream, System.Type returnType, System.Threading.CancellationToken cancellationToken);
         public abstract void Serialize(System.IO.Stream stream, object? value, System.Type inputType, System.Threading.CancellationToken cancellationToken);
+        public virtual System.BinaryData Serialize(object? value, System.Type? inputType = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
         public abstract System.Threading.Tasks.ValueTask SerializeAsync(System.IO.Stream stream, object? value, System.Type inputType, System.Threading.CancellationToken cancellationToken);
+        public virtual System.Threading.Tasks.ValueTask<System.BinaryData> SerializeAsync(object? value, System.Type? inputType = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
     }
 }
diff --git a/sdk/core/Azure.Core/api/Azure.Core.netstandard2.0.cs b/sdk/core/Azure.Core/api/Azure.Core.netstandard2.0.cs
@@ -15,6 +15,11 @@ protected AsyncPageable(System.Threading.CancellationToken cancellationToken) {
         [System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]
         public override string? ToString() { throw null; }
     }
+    public static partial class AzureCoreExtensions
+    {
+        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 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
     {
         public AzureKeyCredential(string key) { }
@@ -550,6 +555,8 @@ protected ObjectSerializer() { }
         public abstract object? Deserialize(System.IO.Stream stream, System.Type returnType, System.Threading.CancellationToken cancellationToken);
         public abstract System.Threading.Tasks.ValueTask<object?> DeserializeAsync(System.IO.Stream stream, System.Type returnType, System.Threading.CancellationToken cancellationToken);
         public abstract void Serialize(System.IO.Stream stream, object? value, System.Type inputType, System.Threading.CancellationToken cancellationToken);
+        public virtual System.BinaryData Serialize(object? value, System.Type? inputType = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
         public abstract System.Threading.Tasks.ValueTask SerializeAsync(System.IO.Stream stream, object? value, System.Type inputType, System.Threading.CancellationToken cancellationToken);
+        public virtual System.Threading.Tasks.ValueTask<System.BinaryData> SerializeAsync(object? value, System.Type? inputType = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
     }
 }
diff --git a/sdk/core/Azure.Core/src/Azure.Core.csproj b/sdk/core/Azure.Core/src/Azure.Core.csproj
@@ -20,6 +20,7 @@
     <PackageReference Include="System.Numerics.Vectors" />
     <PackageReference Include="System.Threading.Tasks.Extensions" />
     <PackageReference Include="System.Text.Json" />
+    <PackageReference Include="System.Memory.Data" />
   </ItemGroup>
 
   <ItemGroup>
diff --git a/sdk/core/Azure.Core/src/Serialization/AzureCoreExtensions.cs b/sdk/core/Azure.Core/src/Serialization/AzureCoreExtensions.cs
@@ -0,0 +1,48 @@
+﻿// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using System;
+using System.Diagnostics.CodeAnalysis;
+using System.IO;
+using System.Threading;
+using System.Threading.Tasks;
+using Azure.Core;
+using Azure.Core.Pipeline;
+using Azure.Core.Serialization;
+
+namespace Azure
+{
+    /// <summary>
+    /// Extensions that can be used for serialization.
+    /// </summary>
+    public static class AzureCoreExtensions
+    {
+        /// <summary>
+        /// Converts the <see cref="BinaryData"/> to the specified type using
+        /// the provided <see cref="ObjectSerializer"/>.
+        /// </summary>
+        /// <typeparam name="T">The type that the data should be
+        /// converted to.</typeparam>
+        /// <param name="data">The <see cref="BinaryData"/> instance to convert.</param>
+        /// <param name="serializer">The serializer to use
+        /// when deserializing the data.</param>
+        /// <param name="cancellationToken">The <see cref="CancellationToken"/> to use during deserialization.</param>
+        ///<returns>The data converted to the specified type.</returns>
+        public static T? ToObject<T>(this BinaryData data, ObjectSerializer serializer, CancellationToken cancellationToken = default) =>
+            (T?)serializer.Deserialize(data.ToStream(), typeof(T), cancellationToken);
+
+        /// <summary>
+        /// Converts the <see cref="BinaryData"/> to the specified type using
+        /// the provided <see cref="ObjectSerializer"/>.
+        /// </summary>
+        /// <typeparam name="T">The type that the data should be
+        /// converted to.</typeparam>
+        /// <param name="data">The <see cref="BinaryData"/> instance to convert.</param>
+        /// <param name="serializer">The serializer to use
+        /// when deserializing the data.</param>
+        /// <param name="cancellationToken">The <see cref="CancellationToken"/> to use during deserialization.</param>
+        ///<returns>The data converted to the specified type.</returns>
+        public static async ValueTask<T?> ToObjectAsync<T>(this BinaryData data, ObjectSerializer serializer, CancellationToken cancellationToken = default) =>
+            (T?)await serializer.DeserializeAsync(data.ToStream(), typeof(T), cancellationToken).ConfigureAwait(false);
+    }
+}
diff --git a/sdk/core/Azure.Core/src/Serialization/ObjectSerializer.cs b/sdk/core/Azure.Core/src/Serialization/ObjectSerializer.cs
@@ -49,5 +49,40 @@ public abstract class ObjectSerializer
         /// <param name="returnType">The type of the object to convert to and return.</param>
         /// <param name="cancellationToken">The <see cref="CancellationToken"/> to use during deserialization.</param>
         public abstract ValueTask<object?> DeserializeAsync(Stream stream, Type returnType, CancellationToken cancellationToken);
+
+        /// <summary>
+        /// Convert the provided value to it's binary representation and return it as a <see cref="BinaryData"/> instance.
+        /// </summary>
+        /// <param name="value">The value to convert.</param>
+        /// <param name="inputType">The type to use when serializing <paramref name="value"/>. If omitted, the type will be determined using <see cref="object.GetType"/>().</param>
+        /// <param name="cancellationToken">The <see cref="CancellationToken"/> to use during serialization.</param>
+        /// <returns>The object's binary representation as <see cref="BinaryData"/>.</returns>
+        public virtual BinaryData Serialize(object? value, Type? inputType = default, CancellationToken cancellationToken = default) =>
+            SerializeToBinaryDataInternalAsync(value, inputType, false, cancellationToken).EnsureCompleted();
+
+        /// <summary>
+        /// Convert the provided value to it's binary representation and return it as a <see cref="BinaryData"/> instance.
+        /// </summary>
+        /// <param name="value">The value to convert.</param>
+        /// <param name="inputType">The type to use when serializing <paramref name="value"/>. If omitted, the type will be determined using <see cref="object.GetType"/>().</param>
+        /// <param name="cancellationToken">The <see cref="CancellationToken"/> to use during serialization.</param>
+        /// <returns>The object's binary representation as <see cref="BinaryData"/>.</returns>
+        public virtual async ValueTask<BinaryData> SerializeAsync(object? value, Type? inputType = default, CancellationToken cancellationToken = default) =>
+            await SerializeToBinaryDataInternalAsync(value, inputType, true, cancellationToken).ConfigureAwait(false);
+
+        private async ValueTask<BinaryData> SerializeToBinaryDataInternalAsync(object? value, Type? inputType, bool async, CancellationToken cancellationToken)
+        {
+            using var stream = new MemoryStream();
+            inputType ??= value?.GetType() ?? typeof(object);
+            if (async)
+            {
+                await SerializeAsync(stream, value, inputType, cancellationToken).ConfigureAwait(false);
+            }
+            else
+            {
+                Serialize(stream, value, inputType, cancellationToken);
+            }
+            return new BinaryData(stream.GetBuffer().AsMemory(0, (int)stream.Position));
+        }
     }
 }
diff --git a/sdk/core/Azure.Core/tests/BinaryDataSerializationTests.cs b/sdk/core/Azure.Core/tests/BinaryDataSerializationTests.cs
diff --git a/sdk/servicebus/Azure.Messaging.ServiceBus/tests/Azure.Messaging.ServiceBus.Tests.csproj b/sdk/servicebus/Azure.Messaging.ServiceBus/tests/Azure.Messaging.ServiceBus.Tests.csproj
diff --git a/sdk/servicebus/Azure.Messaging.ServiceBus/tests/Message/MessageLiveTests.cs b/sdk/servicebus/Azure.Messaging.ServiceBus/tests/Message/MessageLiveTests.cs

Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,11 @@ protected AsyncPageable(System.Threading.CancellationToken cancellationToken) {`
`15`	`15`	`[System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]`
`16`	`16`	`public override string? ToString() { throw null; }`
`17`	`17`	`}`
	`18`	`+ public static partial class AzureCoreExtensions`
	`19`	`+ {`
	`20`	`+ 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; }`
	`21`	`+ public static T? ToObject<T>(this System.BinaryData data, Azure.Core.Serialization.ObjectSerializer serializer, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }`
	`22`	`+ }`
`18`	`23`	`public partial class AzureKeyCredential`
`19`	`24`	`{`
`20`	`25`	`public AzureKeyCredential(string key) { }`
`@@ -550,6 +555,8 @@ protected ObjectSerializer() { }`
`550`	`555`	`public abstract object? Deserialize(System.IO.Stream stream, System.Type returnType, System.Threading.CancellationToken cancellationToken);`
`551`	`556`	`public abstract System.Threading.Tasks.ValueTask<object?> DeserializeAsync(System.IO.Stream stream, System.Type returnType, System.Threading.CancellationToken cancellationToken);`
`552`	`557`	`public abstract void Serialize(System.IO.Stream stream, object? value, System.Type inputType, System.Threading.CancellationToken cancellationToken);`
	`558`	`+ public virtual System.BinaryData Serialize(object? value, System.Type? inputType = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }`
`553`	`559`	`public abstract System.Threading.Tasks.ValueTask SerializeAsync(System.IO.Stream stream, object? value, System.Type inputType, System.Threading.CancellationToken cancellationToken);`
	`560`	`+ public virtual System.Threading.Tasks.ValueTask<System.BinaryData> SerializeAsync(object? value, System.Type? inputType = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }`
`554`	`561`	`}`
`555`	`562`	`}`