feat(dpg): support logicalPath of lro

# Conflicts: # src/TypeSpec.Extension/Emitter.Csharp/src/lib/operation.ts - pass in `logicalPath` info from emitter - in generator, generate convert lambda to fetch the return value from `logicalPath` - add test case resolve #3837
Azure · Oct 16, 2023 · 0479e75 · 0479e75
1 parent bb1b965
commit 0479e75
Show file tree

Hide file tree

Showing 15 changed files with 977 additions and 483 deletions.
diff --git a/src/AutoRest.CSharp/Common/Input/CodeModelConverter.cs b/src/AutoRest.CSharp/Common/Input/CodeModelConverter.cs
@@ -146,6 +146,7 @@ public List<InputParameter> CreateOperationParameters(IReadOnlyCollection<Reques
         public OperationResponse CreateOperationResponse(ServiceResponse response) => new(
             StatusCodes: response.HttpResponse.IntStatusCodes.ToList(),
             BodyType: GetResponseBodyType(response),
+            ResultPath: null,
             BodyMediaType: GetBodyFormat(response.HttpResponse.KnownMediaType),
             Headers: GetResponseHeaders(response.HttpResponse.Headers),
             IsErrorResponse: false

diff --git a/src/AutoRest.CSharp/Common/Input/InputTypes/OperationResponse.cs b/src/AutoRest.CSharp/Common/Input/InputTypes/OperationResponse.cs
@@ -3,10 +3,30 @@
 
 using System;
 using System.Collections.Generic;
+using System.Linq;
+using AutoRest.CSharp.Utilities;
 
 namespace AutoRest.CSharp.Common.Input;
 
-internal record OperationResponse(IReadOnlyList<int> StatusCodes, InputType? BodyType, BodyMediaType BodyMediaType, IReadOnlyList<OperationResponseHeader> Headers, bool IsErrorResponse)
+internal record OperationResponse(IReadOnlyList<int> StatusCodes, InputType? BodyType, BodyMediaType BodyMediaType, IReadOnlyList<OperationResponseHeader> Headers, bool IsErrorResponse, string? ResultPath)
 {
-    public OperationResponse() : this(StatusCodes: Array.Empty<int>(), BodyType: null, BodyMediaType: BodyMediaType.None, Headers: Array.Empty<OperationResponseHeader>(), IsErrorResponse: false) { }
+    public OperationResponse() : this(StatusCodes: Array.Empty<int>(), BodyType: null, BodyMediaType: BodyMediaType.None, Headers: Array.Empty<OperationResponseHeader>(), IsErrorResponse: false, ResultPath: null) { }
+
+    /// <summary>
+    /// Meaninngful return type of the long running operation.
+    /// </summary>
+    public InputType? ReturnType
+    {
+        get
+        {
+            if (BodyType is null)
+                return null;
+
+            if (ResultPath is null)
+                return BodyType;
+
+            var rawResponseType = (InputModelType)BodyType;
+            return rawResponseType.Properties.FirstOrDefault(p => p.SerializedName == ResultPath)!.Type;
+        }
+    }
 }
diff --git a/src/AutoRest.CSharp/Common/Output/Models/LongRunningOperation.cs b/src/AutoRest.CSharp/Common/Output/Models/LongRunningOperation.cs
@@ -30,7 +30,7 @@ protected LongRunningOperation(InputOperation operation, BuildContext context, L
             FinalStateVia = operation.LongRunning.FinalStateVia;
 
             var finalResponse = operation.LongRunning.FinalResponse;
-            var finalResponseType = finalResponse.BodyType;
+            var finalResponseType = finalResponse.ReturnType;
 
             if (finalResponseType != null)
             {

diff --git a/src/AutoRest.CSharp/LowLevel/Generation/DpgClientWriter.cs b/src/AutoRest.CSharp/LowLevel/Generation/DpgClientWriter.cs
@@ -360,12 +360,26 @@ private void WriteConvenienceLroMethod(LowLevelClientMethod clientMethod, Conven
                         .LineRaw(";");
                     // return ProtocolOperationHelpers.Convert(response, r => responseType.FromResponse(r), ClientDiagnostics, scopeName);
                     var diagnostic = convenienceMethod.Diagnostic ?? clientMethod.ProtocolMethodDiagnostic;
-                    _writer.Line($"return {typeof(ProtocolOperationHelpers)}.{nameof(ProtocolOperationHelpers.Convert)}({responseVariable:I}, {responseType}.FromResponse, {fields.ClientDiagnosticsProperty.Name}, {diagnostic.ScopeName:L});");
+                    _writer.Line($"return {typeof(ProtocolOperationHelpers)}.{nameof(ProtocolOperationHelpers.Convert)}({responseVariable:I}, {GetConvertMethodStatement(clientMethod.LongRunning!, responseType)}, {fields.ClientDiagnosticsProperty.Name}, {diagnostic.ScopeName:L});");
                 }
             }
             _writer.Line();
         }
 
+        private string GetConvertMethodStatement(OperationLongRunning longRunning, CSharpType responseType)
+        {
+            if (longRunning.FinalResponse.ResultPath.IsNullOrEmpty())
+            {
+                return $"{responseType.Name}.FromResponse";
+            }
+
+            var bodyType = longRunning.FinalResponse.BodyType!;
+            return @$"r => {{
+                {bodyType.Name} rawResponse = {bodyType.Name}.FromResponse(r);
+                return rawResponse.{longRunning.FinalResponse.ResultPath!.ToCleanName()};
+            }}";
+        }
+
         private void WriteConveniencePageableMethod(LowLevelClientMethod clientMethod, ConvenienceMethod convenienceMethod, ProtocolMethodPaging pagingInfo, ClientFields fields, bool async)
         {
             _writer.WritePageable(convenienceMethod, clientMethod.RequestMethod, pagingInfo.NextPageMethod, fields.ClientDiagnosticsProperty, fields.PipelineField, clientMethod.ProtocolMethodDiagnostic.ScopeName, pagingInfo.ItemName, pagingInfo.NextLinkName, async);

diff --git a/src/AutoRest.CSharp/LowLevel/Output/OperationMethodChainBuilder.cs b/src/AutoRest.CSharp/LowLevel/Output/OperationMethodChainBuilder.cs
@@ -327,7 +327,7 @@ private ReturnTypeChain BuildReturnTypes()
         {
             if (Operation.LongRunning != null)
             {
-                return Operation.LongRunning.FinalResponse.BodyType;
+                return Operation.LongRunning.FinalResponse.ReturnType;
             }
 
             var operationBodyTypes = Operation.Responses.Where(r => !r.IsErrorResponse).Select(r => r.BodyType).Distinct();

diff --git a/src/TypeSpec.Extension/Emitter.Csharp/src/lib/operation.ts b/src/TypeSpec.Extension/Emitter.Csharp/src/lib/operation.ts
@@ -388,7 +388,9 @@ export function loadOperation(
         if (op.verb !== "delete") {
             const formattedType = getFormattedType(
                 program,
-                metadata.logicalResult
+                metadata.logicalPath
+                    ? metadata.envelopeResult
+                    : metadata.logicalResult
             );
             bodyType = getInputType(context, formattedType, models, enums);
         }
@@ -400,6 +402,7 @@ export function loadOperation(
                 // for now, let assume we don't allow return type
                 StatusCodes: op.verb === "delete" ? [204] : [200],
                 BodyType: bodyType,
+                ResultPath: metadata.logicalPath,
                 BodyMediaType: BodyMediaType.Json
             } as OperationResponse
         } as OperationLongRunning;

diff --git a/src/TypeSpec.Extension/Emitter.Csharp/src/type/operationResponse.ts b/src/TypeSpec.Extension/Emitter.Csharp/src/type/operationResponse.ts
@@ -11,4 +11,5 @@ export interface OperationResponse {
     BodyMediaType: BodyMediaType;
     Headers: HttpResponseHeader[];
     IsErrorResponse: boolean;
+    ResultPath?: string;
 }