Pass cancellationToken in MultipartForm WriteToAsync (#8615)

Author: JoshLove-msft

packages/http-client-csharp/generator/Microsoft.TypeSpec.Generator.ClientModel/src/Providers/MultiPartFormDataBinaryContentDefinition.cs

@@ -342,7 +342,7 @@ private MethodProvider BuildWriteToMethod()
             var streamParam = new ParameterProvider("stream", FormattableStringHelpers.Empty, typeof(Stream));
             var streamExpression = (ValueExpression)streamParam;
             var cancellationTokenParam = KnownParameters.CancellationTokenParameter;
-            var cancellatinTokenExpression = (ValueExpression)cancellationTokenParam;
+            var cancellationTokenExpression = (ValueExpression)cancellationTokenParam;
             var signature = new MethodSignature(
                 Name: "WriteTo",
                 Description: null,
@@ -363,7 +363,7 @@ private MethodProvider BuildWriteToMethod()
                 new IfElsePreprocessorStatement(
                     "NET6_0_OR_GREATER",
                     /*_multipartContent.CopyTo(stream, cancellationToken);*/
-                    _multipartContentExpression.CopyTo(streamExpression, cancellatinTokenExpression).Terminate(),
+                    _multipartContentExpression.CopyTo(streamExpression, cancellationTokenExpression).Terminate(),
                     taskWaitCompletedStatementsList.ToArray()),
             };
             return new MethodProvider(signature, body, this);
@@ -374,7 +374,7 @@ private MethodProvider BuildWriteToAsyncMethod()
             var streamParam = new ParameterProvider("stream", FormattableStringHelpers.Empty, typeof(Stream));
             var streamExpression = (ValueExpression)streamParam;
             var cancellationTokenParam = KnownParameters.CancellationTokenParameter;
-            var cancellatinTokenExpression = (ValueExpression)cancellationTokenParam;
+            var cancellationTokenExpression = (ValueExpression)cancellationTokenParam;
 
             var signature = new MethodSignature(
                 Name: "WriteToAsync",
@@ -392,7 +392,7 @@ private MethodProvider BuildWriteToAsyncMethod()
                 new IfElsePreprocessorStatement(
                     "NET6_0_OR_GREATER",
                     /*await _multipartContent.CopyToAsync(stream, cancellationToken).ConfigureAwait(false);,*/
-                    _multipartContentExpression.CopyToAsync(streamExpression, cancellatinTokenExpression).Terminate(),
+                    _multipartContentExpression.CopyToAsync(streamExpression, cancellationTokenExpression).Terminate(),
                     /*await _multipartContent.CopyToAsync(stream).ConfigureAwait(false);*/
                     _multipartContentExpression.CopyToAsync(streamExpression).Terminate()),
             };

packages/http-client-csharp/generator/Microsoft.TypeSpec.Generator.ClientModel/src/Snippets/MultiPartFormDataContentSnippets.cs

@@ -14,11 +14,12 @@ internal static class MultiPartFormDataContentSnippets
         public static ScopedApi<HttpContentHeaders> Headers(this ScopedApi<MultipartFormDataContent> multipartContent)
             => multipartContent.Property(nameof(MultipartFormDataContent.Headers)).As<HttpContentHeaders>();
 
+        // Older .NET versions do not have the CancellationToken parameter, so we provide an overload without it.
         public static InvokeMethodExpression CopyToAsync(this ScopedApi<MultipartFormDataContent> multipartContent, ValueExpression destination, bool isAsync = true)
             => multipartContent.Invoke(nameof(MultipartFormDataContent.CopyToAsync), [destination], null, isAsync, isAsync);
 
         public static InvokeMethodExpression CopyToAsync(this ScopedApi<MultipartFormDataContent> multipartContent, ValueExpression destination, ValueExpression cancellationTokenExpression)
-            => multipartContent.Invoke(nameof(MultipartFormDataContent.CopyToAsync), [destination], null, true, true);
+            => multipartContent.Invoke(nameof(MultipartFormDataContent.CopyToAsync), [destination, cancellationTokenExpression], null, true, true);
 
         public static InvokeMethodExpression CopyTo(this ScopedApi<MultipartFormDataContent> multipartContent, ValueExpression destination, ValueExpression cancellationTokenExpression)
             => multipartContent.Invoke(nameof(MultipartFormDataContent.CopyTo), [destination, Default, cancellationTokenExpression]);

packages/http-client-csharp/generator/Microsoft.TypeSpec.Generator.ClientModel/test/Providers/Definitions/MultiPartFormDataBinaryContentDefinitionTests.cs

@@ -0,0 +1,39 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using System.Linq;
+using Microsoft.TypeSpec.Generator.ClientModel.Providers;
+using Microsoft.TypeSpec.Generator.Tests.Common;
+using NUnit.Framework;
+
+namespace Microsoft.TypeSpec.Generator.ClientModel.Tests.Providers.Definitions
+{
+    public class MultiPartFormDataBinaryContentDefinitionTests
+    {
+        [Test]
+        public void WriteToMethodIsCorrectlyDefined()
+        {
+            MockHelpers.LoadMockGenerator();
+
+            var multiPartFormData = new MultiPartFormDataBinaryContentDefinition();
+            Assert.IsNotNull(multiPartFormData.Methods);
+            var writeToMethod = multiPartFormData.Methods.Single(m => m.Signature.Name == "WriteTo");
+            Assert.IsNotNull(writeToMethod);
+            Assert.IsNotNull(writeToMethod.BodyStatements);
+            Assert.AreEqual(Helpers.GetExpectedFromFile(), writeToMethod.BodyStatements!.ToDisplayString());
+        }
+
+        [Test]
+        public void WriteToAsyncMethodIsCorrectlyDefined()
+        {
+            MockHelpers.LoadMockGenerator();
+
+            var multiPartFormData = new MultiPartFormDataBinaryContentDefinition();
+            Assert.IsNotNull(multiPartFormData.Methods);
+            var writeToMethod = multiPartFormData.Methods.Single(m => m.Signature.Name == "WriteToAsync");
+            Assert.IsNotNull(writeToMethod);
+            Assert.IsNotNull(writeToMethod.BodyStatements);
+            Assert.AreEqual(Helpers.GetExpectedFromFile(), writeToMethod.BodyStatements!.ToDisplayString());
+        }
+    }
+}

packages/http-client-csharp/generator/Microsoft.TypeSpec.Generator.ClientModel/test/Providers/Definitions/TestData/MultiPartFormDataBinaryContentDefinitionTests/WriteToAsyncMethodIsCorrectlyDefined.cs

@@ -0,0 +1,5 @@
+#if NET6_0_OR_GREATER
+await _multipartContent.CopyToAsync(stream, cancellationToken).ConfigureAwait(false);
+#else
+await _multipartContent.CopyToAsync(stream).ConfigureAwait(false);
+#endif

packages/http-client-csharp/generator/Microsoft.TypeSpec.Generator.ClientModel/test/Providers/Definitions/TestData/MultiPartFormDataBinaryContentDefinitionTests/WriteToMethodIsCorrectlyDefined.cs

@@ -0,0 +1,5 @@
+#if NET6_0_OR_GREATER
+_multipartContent.CopyTo(stream, default, cancellationToken);
+#else
+_multipartContent.CopyToAsync(stream).GetAwaiter().GetResult();
+#endif