Implement LRO rehydration with static method

sdk/core/Azure.Core.TestFramework/src/MockJsonModel.cs

@@ -0,0 +1,75 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using System;
+using System.ClientModel.Primitives;
+using System.IO;
+using System.Text.Json;
+using Azure.Core.Serialization;
+
+namespace Azure.Core.TestFramework
+{
+    public class MockJsonModel : IJsonModel<MockJsonModel>
+    {
+        internal MockJsonModel()
+        {
+        }
+
+        public int IntValue { get; set; }
+
+        public string StringValue { get; set; }
+
+        public byte[] Utf8BytesValue { get; }
+
+        public MockJsonModel(int intValue, string stringValue)
+        {
+            IntValue = intValue;
+            StringValue = stringValue;
+
+            dynamic json = BinaryData.FromString("{}").ToDynamicFromJson(JsonPropertyNames.CamelCase);
+            json.IntValue = IntValue;
+            json.StringValue = StringValue;
+
+            MemoryStream stream = new();
+            using Utf8JsonWriter writer = new Utf8JsonWriter(stream);
+
+            writer.WriteStartObject();
+            writer.WriteNumber("IntValue", IntValue);
+            writer.WriteString("StringValue", StringValue);
+            writer.WriteEndObject();
+
+            writer.Flush();
+            Utf8BytesValue = stream.ToArray();
+        }
+
+        MockJsonModel IPersistableModel<MockJsonModel>.Create(BinaryData data, ModelReaderWriterOptions options)
+        {
+            dynamic json = data.ToDynamicFromJson(JsonPropertyNames.CamelCase);
+            return new MockJsonModel(json.IntValue, json.StringValue);
+        }
+
+        MockJsonModel IJsonModel<MockJsonModel>.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options)
+        {
+            using JsonDocument doc = JsonDocument.ParseValue(ref reader);
+            int intValue = doc.RootElement.GetProperty("IntValue").GetInt32();
+            string stringValue = doc.RootElement.GetProperty("StringValue").GetString()!;
+            return new MockJsonModel(intValue, stringValue);
+        }
+
+        string IPersistableModel<MockJsonModel>.GetFormatFromOptions(ModelReaderWriterOptions options)
+            => "J";
+
+        BinaryData IPersistableModel<MockJsonModel>.Write(ModelReaderWriterOptions options)
+        {
+            return BinaryData.FromBytes(Utf8BytesValue);
+        }
+
+        void IJsonModel<MockJsonModel>.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options)
+        {
+            writer.WriteStartObject();
+            writer.WriteNumber("IntValue", IntValue);
+            writer.WriteString("StringValue", StringValue);
+            writer.WriteEndObject();
+        }
+    }
+}

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

@@ -138,6 +138,8 @@ protected Operation() { }
         public override int GetHashCode() { throw null; }
         public abstract Azure.Response GetRawResponse();
         public virtual Azure.Core.RehydrationToken? GetRehydrationToken() { throw null; }
+        public static Azure.Operation Rehydrate(Azure.Core.Pipeline.HttpPipeline pipeline, Azure.Core.RehydrationToken? rehydrationToken, Azure.Core.ClientOptions? options = null) { throw null; }
+        public static Azure.Operation<T> Rehydrate<T>(Azure.Core.Pipeline.HttpPipeline pipeline, Azure.Core.RehydrationToken? rehydrationToken, Azure.Core.ClientOptions? options = null) where T : System.ClientModel.Primitives.IPersistableModel<T> { throw null; }
         [System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]
         public override string? ToString() { throw null; }
         public abstract Azure.Response UpdateStatus(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken));

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

@@ -138,6 +138,8 @@ protected Operation() { }
         public override int GetHashCode() { throw null; }
         public abstract Azure.Response GetRawResponse();
         public virtual Azure.Core.RehydrationToken? GetRehydrationToken() { throw null; }
+        public static Azure.Operation Rehydrate(Azure.Core.Pipeline.HttpPipeline pipeline, Azure.Core.RehydrationToken? rehydrationToken, Azure.Core.ClientOptions? options = null) { throw null; }
+        public static Azure.Operation<T> Rehydrate<T>(Azure.Core.Pipeline.HttpPipeline pipeline, Azure.Core.RehydrationToken? rehydrationToken, Azure.Core.ClientOptions? options = null) where T : System.ClientModel.Primitives.IPersistableModel<T> { throw null; }
         [System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]
         public override string? ToString() { throw null; }
         public abstract Azure.Response UpdateStatus(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken));

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

@@ -138,6 +138,8 @@ protected Operation() { }
         public override int GetHashCode() { throw null; }
         public abstract Azure.Response GetRawResponse();
         public virtual Azure.Core.RehydrationToken? GetRehydrationToken() { throw null; }
+        public static Azure.Operation Rehydrate(Azure.Core.Pipeline.HttpPipeline pipeline, Azure.Core.RehydrationToken? rehydrationToken, Azure.Core.ClientOptions? options = null) { throw null; }
+        public static Azure.Operation<T> Rehydrate<T>(Azure.Core.Pipeline.HttpPipeline pipeline, Azure.Core.RehydrationToken? rehydrationToken, Azure.Core.ClientOptions? options = null) where T : System.ClientModel.Primitives.IPersistableModel<T> { throw null; }
         [System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]
         public override string? ToString() { throw null; }
         public abstract Azure.Response UpdateStatus(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken));

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

@@ -138,6 +138,8 @@ protected Operation() { }
         public override int GetHashCode() { throw null; }
         public abstract Azure.Response GetRawResponse();
         public virtual Azure.Core.RehydrationToken? GetRehydrationToken() { throw null; }
+        public static Azure.Operation Rehydrate(Azure.Core.Pipeline.HttpPipeline pipeline, Azure.Core.RehydrationToken? rehydrationToken, Azure.Core.ClientOptions? options = null) { throw null; }
+        public static Azure.Operation<T> Rehydrate<T>(Azure.Core.Pipeline.HttpPipeline pipeline, Azure.Core.RehydrationToken? rehydrationToken, Azure.Core.ClientOptions? options = null) where T : System.ClientModel.Primitives.IPersistableModel<T> { throw null; }
         [System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]
         public override string? ToString() { throw null; }
         public abstract Azure.Response UpdateStatus(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken));

sdk/core/Azure.Core/src/Azure.Core.csproj

@@ -59,12 +59,15 @@
     <Compile Include="Shared\FixedDelayWithNoJitterStrategy.cs" />
     <Compile Include="Shared\HashCodeBuilder.cs" />
     <Compile Include="Shared\HttpMessageSanitizer.cs" />
+    <Compile Include="Shared\IOperationSource.cs" />
     <Compile Include="Shared\InitializationConstructorAttribute.cs" />
     <Compile Include="Shared\Multipart\MemoryResponse.cs" />
+    <Compile Include="Shared\NextLinkOperationImplementation.cs" />
     <Compile Include="Shared\NullableAttributes.cs" />
     <Compile Include="Shared\OperationInternalBase.cs" />
     <Compile Include="Shared\TrimmingAttribute.cs" />
     <Compile Include="Shared\VoidValue.cs" />
+    <Compile Include="Shared\OperationFinalStateVia.cs" />
     <Compile Include="Shared\OperationInternal.cs" />
     <Compile Include="Shared\OperationInternalOfT.cs" />
     <Compile Include="Shared\SequentialDelayStrategy.cs" />

sdk/core/Azure.Core/src/Internal/GenericOperationSource.cs

@@ -0,0 +1,22 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using System.ClientModel.Primitives;
+using System.Diagnostics.CodeAnalysis;
+using System.Threading;
+using System.Threading.Tasks;
+
+namespace Azure.Core
+{
+    internal class GenericOperationSource<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicConstructors | DynamicallyAccessedMemberTypes.NonPublicConstructors)] T> : IOperationSource<T> where T : IPersistableModel<T>
+    {
+        T IOperationSource<T>.CreateResult(Response response, CancellationToken cancellationToken)
+            => CreateResult(response);
+
+        ValueTask<T> IOperationSource<T>.CreateResultAsync(Response response, CancellationToken cancellationToken)
+            => new ValueTask<T>(CreateResult(response));
+
+        private T CreateResult(Response response)
+            => (T)ModelReaderWriter.Read(response.Content, typeof(T))!;
+    }
+}

sdk/core/Azure.Core/src/Internal/RehydrationOperation.cs

@@ -0,0 +1,40 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+#nullable disable
+
+using System.Threading;
+using System.Threading.Tasks;
+using Azure.Core.Pipeline;
+
+namespace Azure.Core
+{
+    internal class RehydrationOperation : Operation
+    {
+        private readonly NextLinkOperationImplementation _nextLinkOperation;
+        private readonly OperationInternal _operation;
+
+        public RehydrationOperation(HttpPipeline pipeline, RehydrationToken? rehydrationToken, ClientOptions options = null)
+        {
+            Argument.AssertNotNull(pipeline, nameof(pipeline));
+            Argument.AssertNotNull(rehydrationToken, nameof(rehydrationToken));
+            _nextLinkOperation = (NextLinkOperationImplementation)NextLinkOperationImplementation.Create(pipeline, rehydrationToken);
+            var operationState = _nextLinkOperation.UpdateStateAsync(false, default).EnsureCompleted();
+            _operation = operationState.HasCompleted
+                ? _operation = new OperationInternal(operationState)
+                : new OperationInternal(_nextLinkOperation, new ClientDiagnostics(options ?? ClientOptions.Default), operationState.RawResponse, requestMethod: _nextLinkOperation.RequestMethod);
+        }
+
+        public override string Id => _nextLinkOperation?.OperationId ?? null;
+
+        public override RehydrationToken? GetRehydrationToken() => _nextLinkOperation?.GetRehydrationToken();
+
+        public override bool HasCompleted => _operation.HasCompleted;
+
+        public override Response GetRawResponse() => _operation.RawResponse;
+
+        public override Response UpdateStatus(CancellationToken cancellationToken = default) => _operation.UpdateStatus(cancellationToken);
+
+        public override ValueTask<Response> UpdateStatusAsync(CancellationToken cancellationToken = default) => _operation.UpdateStatusAsync(cancellationToken);
+    }
+}

sdk/core/Azure.Core/src/Internal/RehydrationOperationOfT.cs

@@ -0,0 +1,50 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+#nullable disable
+
+using System.ClientModel.Primitives;
+using System.Threading;
+using System.Threading.Tasks;
+using Azure.Core.Pipeline;
+
+namespace Azure.Core
+{
+#pragma warning disable SA1649 // File name should match first type name
+    internal class RehydrationOperation<T> : Operation<T> where T : IPersistableModel<T>
+#pragma warning restore SA1649 // File name should match first type name
+    {
+        private readonly OperationInternal<T> _operation;
+        private readonly NextLinkOperationImplementation _nextLinkOperation;
+
+        public RehydrationOperation(HttpPipeline pipeline, RehydrationToken? rehydrationToken, ClientOptions options = null)
+        {
+            Argument.AssertNotNull(pipeline, nameof(pipeline));
+            Argument.AssertNotNull(rehydrationToken, nameof(rehydrationToken));
+
+            IOperationSource<T> source = new GenericOperationSource<T>();
+            _nextLinkOperation = (NextLinkOperationImplementation)NextLinkOperationImplementation.Create(pipeline, rehydrationToken);
+            var operation = NextLinkOperationImplementation.Create(source, _nextLinkOperation);
+            var operationState = operation.UpdateStateAsync(false, default).EnsureCompleted();
+            _operation = operationState.HasCompleted
+                    ? new OperationInternal<T>(operationState)
+                    :  new OperationInternal<T>(operation, new ClientDiagnostics(options ?? ClientOptions.Default), operationState.RawResponse);
+        }
+
+        public override T Value => _operation.Value;
+
+        public override bool HasValue => _operation.HasValue;
+
+        public override string Id => _nextLinkOperation.OperationId ?? null;
+
+        public override RehydrationToken? GetRehydrationToken() => _nextLinkOperation?.GetRehydrationToken();
+
+        public override bool HasCompleted => _operation.HasCompleted;
+
+        public override Response GetRawResponse() => _operation.RawResponse;
+
+        public override Response UpdateStatus(CancellationToken cancellationToken = default) => _operation.UpdateStatus(cancellationToken);
+
+        public override ValueTask<Response> UpdateStatusAsync(CancellationToken cancellationToken = default) => _operation.UpdateStatusAsync(cancellationToken);
+    }
+}

sdk/core/Azure.Core/src/Operation.cs

@@ -2,10 +2,12 @@
 // Licensed under the MIT License.
 
 using System;
+using System.ClientModel.Primitives;
 using System.ComponentModel;
 using System.Threading;
 using System.Threading.Tasks;
 using Azure.Core;
+using Azure.Core.Pipeline;
 
 namespace Azure
 {
@@ -16,6 +18,26 @@ namespace Azure
     public abstract class Operation
 #pragma warning restore AZC0012 // Avoid single word type names
     {
+        /// <summary>
+        /// Rehydrates an operation from a <see cref="RehydrationToken"/>.
+        /// </summary>
+        /// <param name="pipeline">The Http pipeline.</param>
+        /// <param name="rehydrationToken">The rehydration token.</param>
+        /// <param name="options">The client options.</param>
+        /// <returns>The long-running operation.</returns>
+        public static Operation<T> Rehydrate<T>(HttpPipeline pipeline, RehydrationToken? rehydrationToken, ClientOptions? options = null) where T : IPersistableModel<T>
+            => new RehydrationOperation<T>(pipeline, rehydrationToken, options);
+
+        /// <summary>
+        /// Rehydrates an operation from a <see cref="RehydrationToken"/>.
+        /// </summary>
+        /// <param name="pipeline">The Http pipeline.</param>
+        /// <param name="rehydrationToken">The rehydration token.</param>
+        /// <param name="options">The client options.</param>
+        /// <returns>The long-running operation.</returns>
+        public static Operation Rehydrate(HttpPipeline pipeline, RehydrationToken? rehydrationToken, ClientOptions? options = null)
+            => new RehydrationOperation(pipeline, rehydrationToken, options);
+
         /// <summary>
         /// Get a token that can be used to rehydrate the operation.
         /// </summary>

sdk/core/Azure.Core/src/RehydrationToken.cs

@@ -15,7 +15,7 @@ public readonly partial struct RehydrationToken
         public string? Id { get; }
 
         // Version for this contract itself since we might change the members in the future.
-        internal string Version { get; } = "1.0.0";
+        internal string Version { get; } = NextLinkOperationImplementation.RehydartionTokenVersion;
 
         // The below members are used to re-construct <cref="NextLinkOperationImplemenation">.
         // Value of <cref="NextLinkOperationImplemenration.HeaderSrouce">.