[Core] Wiring up rehydration token logic in data-plane

sdk/core/Azure.Core/src/Shared/NextLinkOperationImplementation.cs

@@ -190,7 +190,7 @@ private static string ParseOperationId(Uri startRequestUri, string nextRequestUr
             }
         }
 
-        public RehydrationToken GetRehydrationToken()
+        public RehydrationToken? GetRehydrationToken()
             => GetRehydrationToken(RequestMethod, _startRequestUri, _nextRequestUri, _headerSource.ToString(), _lastKnownLocation, _finalStateVia.ToString(), OperationId);
 
         public static RehydrationToken GetRehydrationToken(
@@ -653,6 +653,8 @@ public CompletedOperation(OperationState operationState)
             }
 
             public ValueTask<OperationState> UpdateStateAsync(bool async, CancellationToken cancellationToken) => new(_operationState);
+
+            public RehydrationToken? GetRehydrationToken() => null;
         }
 
         private sealed class OperationToOperationOfT<T> : IOperation<T>
@@ -685,6 +687,8 @@ public async ValueTask<OperationState<T>> UpdateStateAsync(bool async, Cancellat
 
                 return OperationState<T>.Pending(state.RawResponse);
             }
+
+            public RehydrationToken? GetRehydrationToken() => _operation.GetRehydrationToken();
         }
     }
 }

sdk/core/Azure.Core/src/Shared/OperationInternal.cs

@@ -119,6 +119,8 @@ public OperationToOperationOfTProxy(IOperation operation)
                 _operation = operation;
             }
 
+            public RehydrationToken? GetRehydrationToken() => _operation.GetRehydrationToken();
+
             public async ValueTask<OperationState<VoidValue>> UpdateStateAsync(bool async, CancellationToken cancellationToken)
             {
                 var state = await _operation.UpdateStateAsync(async, cancellationToken).ConfigureAwait(false);
@@ -172,6 +174,11 @@ internal interface IOperation
         /// </list>
         /// </returns>
         ValueTask<OperationState> UpdateStateAsync(bool async, CancellationToken cancellationToken);
+
+        /// <summary>
+        /// Get a token that can be used to rehydrate the operation.
+        /// </summary>
+        RehydrationToken? GetRehydrationToken();
     }
 
     /// <summary>

sdk/core/Azure.Core/src/Shared/OperationInternalOfT.cs

@@ -288,6 +288,9 @@ private class FinalOperation : IOperation<T>
         {
             public ValueTask<OperationState<T>> UpdateStateAsync(bool async, CancellationToken cancellationToken)
                 => throw new NotSupportedException("The operation has already completed");
+
+            // Unreachable path. _operation.GetRehydrationToken() is never invoked.
+            public RehydrationToken? GetRehydrationToken() => null;
         }
     }
 
@@ -328,6 +331,11 @@ internal interface IOperation<T>
         /// </list>
         /// </returns>
         ValueTask<OperationState<T>> UpdateStateAsync(bool async, CancellationToken cancellationToken);
+
+        /// <summary>
+        /// Get a token that can be used to rehydrate the operation.
+        /// </summary>
+        RehydrationToken? GetRehydrationToken();
     }
 
     /// <summary>

sdk/core/Azure.Core/src/Shared/ProtocolOperation.cs

@@ -30,6 +30,9 @@ internal ProtocolOperation(ClientDiagnostics clientDiagnostics, HttpPipeline pip
         public override string Id => throw new NotSupportedException();
 #pragma warning restore CA1822
 
+        /// <inheritdoc />
+        public override RehydrationToken? GetRehydrationToken() => _nextLinkOperation.GetRehydrationToken();
+
         /// <inheritdoc />
         public override T Value => _operation.Value;
 

sdk/core/Azure.Core/src/Shared/ProtocolOperationHelpers.cs

@@ -76,6 +76,7 @@ public ConvertOperation(Operation<TFrom> operation, ClientDiagnostics diagnostic
             public override TTo Value => GetOrCreateValue();
             public override bool HasValue => _operation.HasValue;
             public override bool HasCompleted => _operation.HasCompleted;
+            public override RehydrationToken? GetRehydrationToken() => _operation.GetRehydrationToken();
             public override Response GetRawResponse() => _operation.GetRawResponse();
 
             public override Response UpdateStatus(CancellationToken cancellationToken = default)

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

@@ -518,6 +518,8 @@ public TestOperation(Func<bool, CancellationToken, ValueTask<OperationState<int>
             }
 
             public ValueTask<OperationState<int>> UpdateStateAsync(bool async, CancellationToken cancellationToken) => _updateStateAsyncHandler(async, cancellationToken);
+
+            public RehydrationToken? GetRehydrationToken() => null;
         }
 
         private class CallCountStrategy : DelayStrategy

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

@@ -438,6 +438,8 @@ public TestOperation(Func<bool, CancellationToken, ValueTask<OperationState>> up
             }
 
             public ValueTask<OperationState> UpdateStateAsync(bool async, CancellationToken cancellationToken) => _updateStateAsyncHandler(async, cancellationToken);
+
+            public RehydrationToken? GetRehydrationToken() => null;
         }
 
         private class CallCountStrategy : DelayStrategy

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

@@ -57,6 +57,8 @@ public void WaitForCompletionResponseCancelled()
         private class EndlessOperation : IOperation
         {
             public ValueTask<OperationState> UpdateStateAsync(bool async, CancellationToken cancellationToken) => new(OperationState.Pending(new MockResponse(200)));
+
+            public RehydrationToken? GetRehydrationToken() => default;
         }
 
         private class TestDelayStrategy : DelayStrategy

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

@@ -0,0 +1,110 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using System;
+using System.IO;
+using System.Text;
+using System.Threading.Tasks;
+using Azure.Core.Pipeline;
+using Azure.Core.TestFramework;
+using NUnit.Framework;
+
+namespace Azure.Core.Tests
+{
+    public class ProtocolOperationTests
+    {
+        [Test]
+        public void GetRehydrationToken()
+        {
+            const string OperationId = "oper-ati-oni-d00";
+            const string RequestUri = "https://www.example.com/request";
+            const string LocationUri = $"https://www.example.com/{OperationId}";
+
+            using var request = new MockRequest() { Method = RequestMethod.Post };
+            using var response = new MockResponse(200);
+            var transport = new MockTransport();
+            var pipeline = new HttpPipeline(transport);
+
+            request.Uri.Reset(new Uri(RequestUri));
+            response.AddHeader("Location", LocationUri);
+
+            var operation = new ProtocolOperation<MockJsonModel>(null, pipeline, request, response, OperationFinalStateVia.Location, null, null);
+            var token = operation.GetRehydrationToken();
+
+            Assert.True(token.HasValue);
+            Assert.AreEqual(OperationId, token.Value.Id);
+            Assert.AreEqual(NextLinkOperationImplementation.RehydrationTokenVersion, token.Value.Version);
+            Assert.AreEqual("Location", token.Value.HeaderSource);
+            Assert.AreEqual(LocationUri, token.Value.NextRequestUri);
+            Assert.AreEqual(RequestUri, token.Value.InitialUri);
+            Assert.AreEqual(RequestMethod.Post, token.Value.RequestMethod);
+            Assert.AreEqual(LocationUri, token.Value.LastKnownLocation);
+            Assert.AreEqual("Location", token.Value.FinalStateVia);
+        }
+
+        [Test]
+        [TestCase(true)]
+        [TestCase(false)]
+        public async Task RehydrationOperationCanPoll(bool isAsync)
+        {
+            const string RequestUri = "https://www.example.com/request";
+            const string LocationUri = "https://www.example.com/oper-ati-oni-d00";
+
+            using var request = new MockRequest() { Method = RequestMethod.Post };
+            using var response = new MockResponse(200);
+            var transport = new MockTransport(response);
+            var pipeline = new HttpPipeline(transport);
+
+            request.Uri.Reset(new Uri(RequestUri));
+            response.AddHeader("Location", LocationUri);
+
+            var operation = new ProtocolOperation<MockJsonModel>(null, pipeline, request, response, OperationFinalStateVia.Location, null, null);
+            var token = operation.GetRehydrationToken();
+            _ = isAsync
+                ? await Operation.RehydrateAsync(pipeline, token.Value)
+                : Operation.Rehydrate(pipeline, token.Value);
+            var rehydrationUpdateRequest = transport.SingleRequest;
+
+            Assert.AreEqual(LocationUri, rehydrationUpdateRequest.Uri.ToString());
+            Assert.AreEqual(RequestMethod.Get, rehydrationUpdateRequest.Method);
+        }
+
+        [Test]
+        [TestCase(true)]
+        [TestCase(false)]
+        public async Task RehydrationOperationOfTCanPoll(bool isAsync)
+        {
+            const string RequestUri = "https://www.example.com/request";
+            const string LocationUri = "https://www.example.com/oper-ati-oni-d00";
+
+            using var request = new MockRequest() { Method = RequestMethod.Post };
+            using var response = new MockResponse(200);
+            var transport = new MockTransport(response);
+            var pipeline = new HttpPipeline(transport);
+            using var responseContentStream = new MemoryStream(Encoding.UTF8.GetBytes("""
+                {
+                    "IntValue": 1,
+                    "StringValue": "one"
+                }
+                """));
+
+            request.Uri.Reset(new Uri(RequestUri));
+            response.AddHeader("Location", LocationUri);
+            response.ContentStream = responseContentStream;
+
+            var operation = new ProtocolOperation<MockJsonModel>(null, pipeline, request, response, OperationFinalStateVia.Location, null, null);
+            var token = operation.GetRehydrationToken();
+            var rehydrationOperation = isAsync
+                ? await Operation.RehydrateAsync<MockJsonModel>(pipeline, token.Value)
+                : Operation.Rehydrate<MockJsonModel>(pipeline, token.Value);
+            var rehydrationUpdateRequest = transport.SingleRequest;
+
+            Assert.AreEqual(LocationUri, rehydrationUpdateRequest.Uri.ToString());
+            Assert.AreEqual(RequestMethod.Get, rehydrationUpdateRequest.Method);
+
+            Assert.True(rehydrationOperation.HasValue);
+            Assert.AreEqual(rehydrationOperation.Value.IntValue, 1);
+            Assert.AreEqual(rehydrationOperation.Value.StringValue, "one");
+        }
+    }
+}