Encode query parameters for AutoClient (#4437)

Co-authored-by: Sebastien Ros <sebastienros@gmail.com>
dotnet · Sep 18, 2023 · 6edde33 · 6edde33
1 parent 124514d
commit 6edde33
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 2 deletions.
diff --git a/src/Generators/Microsoft.Gen.AutoClient/Emitter.cs b/src/Generators/Microsoft.Gen.AutoClient/Emitter.cs
@@ -232,18 +232,25 @@ private void GenRestApiMethod(RestApiMethod restApiMethod, RestApiType restApiTy
         var firstQuery = true;
         foreach (var param in restApiMethod.AllParameters.Where(m => m.IsQuery))
         {
+            var escapedParamName = $"{param.Name}Escaped";
+
+            // Use interpolated string to handle any null values from any type like nullable value types or reference types.
+            OutLn($"var {escapedParamName} = {Uri}.EscapeDataString($\"{{{param.Name}}}\");");
+
             if (firstQuery)
             {
-                _ = pathSb.Append($"?{param.QueryKey}={{{param.Name}}}");
+                _ = pathSb.Append($"?{param.QueryKey}={{{escapedParamName}}}");
             }
             else
             {
-                _ = pathSb.Append($"&{param.QueryKey}={{{param.Name}}}");
+                _ = pathSb.Append($"&{param.QueryKey}={{{escapedParamName}}}");
             }
 
             firstQuery = false;
         }
 
+        OutLn();
+
         var definePath = restApiMethod.FormatParameters.Count > 0 || !firstQuery;
         var body = restApiMethod.AllParameters.FirstOrDefault(m => m.IsBody);
 

diff --git a/test/Generators/Microsoft.Gen.AutoClient/Generated/QueryTests.cs b/test/Generators/Microsoft.Gen.AutoClient/Generated/QueryTests.cs
@@ -59,6 +59,27 @@ public async Task QueryFromParameter()
         Assert.Equal("Success!", response);
     }
 
+    [Fact]
+    public async Task QueryIsEscaped()
+    {
+        _handlerMock
+            .Protected()
+            .Setup<Task<HttpResponseMessage>>("SendAsync", ItExpr.Is<HttpRequestMessage>(message =>
+                message.Method == HttpMethod.Get &&
+                message.RequestUri != null &&
+                message.RequestUri.PathAndQuery == "/api/users?paramQuery=http%3A%2F%2Fmicrosoft.com"),
+                ItExpr.IsAny<CancellationToken>())
+            .ReturnsAsync(new HttpResponseMessage
+            {
+                StatusCode = HttpStatusCode.OK,
+                Content = new StringContent("Success!")
+            });
+
+        var response = await _sut.GetUsers("http://microsoft.com");
+
+        Assert.Equal("Success!", response);
+    }
+
     [Fact]
     public async Task QueryFromParameterCustom()
     {