Skip to content

Guard exploded string-struct query parameters against null ToString in C# emitter #11439

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Copilot wants to merge 8 commits into
base: main
Choose a base branch
from
Open

Guard exploded string-struct query parameters against null ToString in C# emitter #11439

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
d79f3a6
Initial plan
Copilot Jul 29, 2026
770dd54
Guard exploded string-struct query params against null ToString in C#…
Copilot Jul 29, 2026
764fbcf
Fix dictionary explode enum serialization to use KeyValuePair value
Copilot Jul 29, 2026
5f1e227
Cache ToString() result in local variable for extensible string enum …
Copilot Jul 29, 2026
51e61a3
Refactor explode query param codegen: use StringSnippets.IsNullOrEmpt…
Copilot Jul 29, 2026
dd8b3ed
fix: remove doc comment on IsExtensibleStringEnum, add scalar extensi…
Copilot Jul 29, 2026
f473482
Add nullable optional extensible string enum test case (p13) with nul…
Copilot Jul 29, 2026
511a71e
fix: change null guard from IsNullOrEmpty to null-only check for exte…
Copilot Jul 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 27 additions & 3 deletions ...rp/generator/Microsoft.TypeSpec.Generator.ClientModel/src/Providers/RestClientProvider.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -637,9 +637,9 @@ private static MethodBodyStatement BuildAppendQueryStatement(
valueExpression.AsDictionary(paramType),
out KeyValuePairExpression item);
var convertedItem = paramType.ElementType.IsEnum
? paramType.ElementType.ToSerial(item)
? paramType.ElementType.ToSerial(item.Value)
: item.Value;
forEachStatement.Add(uri.AppendQuery(item.Key, convertedItem, true).Terminate());
AddExplodeQueryItem(forEachStatement, uri, item.Key, convertedItem, paramType.ElementType);
return forEachStatement;
}
else
Expand Down Expand Up @@ -674,11 +674,35 @@ private static MethodBodyStatement BuildAppendQueryStatement(
{
convertedItem = item;
}
forEachStatement.Add(uri.AppendQuery(Literal(inputQueryParameter.SerializedName), convertedItem, true).Terminate());
AddExplodeQueryItem(forEachStatement, uri, Literal(inputQueryParameter.SerializedName), convertedItem, paramType.ElementType);
return forEachStatement;
}
}

private static bool IsExtensibleStringEnum(CSharpType type)
=> type.IsEnum && type.IsStruct && type.UnderlyingEnumType == typeof(string);

private static void AddExplodeQueryItem(
ForEachStatement forEachStatement,
ScopedApi uri,
ValueExpression key,
ValueExpression convertedItem,
CSharpType elementType)
{
if (IsExtensibleStringEnum(elementType))
{
forEachStatement.Add(Declare("paramStr", typeof(string), convertedItem, out VariableExpression cachedVar));
forEachStatement.Add(new IfStatement(cachedVar.As<string>().NotEqual(Null))
{
uri.AppendQuery(key, cachedVar, true).Terminate()
});
}
else
{
forEachStatement.Add(uri.AppendQuery(key, convertedItem, true).Terminate());
}
}

/// <summary>
/// Builds the statements for a model-typed query parameter that uses form-style `explode`.
/// Each (simple) property of the model is emitted as its own query entry using the property's
Expand Down
8 changes: 8 additions & 0 deletions ...eSpec.Generator.ClientModel/test/Providers/RestClientProviders/RestClientProviderTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1054,6 +1054,10 @@ public void TestBuildCreateRequestMethodWithQueryParameters()
var inputStringEnum = InputFactory.StringEnum(
"foo",
stringEnumValues);
var inputExtensibleStringEnum = InputFactory.StringEnum(
"extensibleFoo",
stringEnumValues,
isExtensible: true);
var inputIntEnum = InputFactory.Int32Enum(
"intFoo",
intEnumValues);
Expand All @@ -1078,6 +1082,10 @@ public void TestBuildCreateRequestMethodWithQueryParameters()
InputFactory.QueryParameter("p7Explode", InputFactory.Dictionary(inputIntEnum), isRequired: true, explode: true),
InputFactory.QueryParameter("p8Explode", InputFactory.Array(inputFloatEnum), isRequired: true, explode: true),
InputFactory.QueryParameter("p9Explode", InputFactory.Array(inputDoubleEnum), isRequired: true, explode: true),
InputFactory.QueryParameter("p10Explode", InputFactory.Array(inputExtensibleStringEnum), isRequired: true, explode: true),
InputFactory.QueryParameter("p11Explode", InputFactory.Dictionary(inputExtensibleStringEnum), isRequired: true, explode: true),
Comment thread
jorgerangel-msft marked this conversation as resolved.
InputFactory.QueryParameter("p12", inputExtensibleStringEnum, isRequired: true),
InputFactory.QueryParameter("p13", new InputNullableType(inputExtensibleStringEnum), isRequired: false),
];
var operation = InputFactory.Operation(
"sampleOp",
Expand Down
33 changes: 30 additions & 3 deletions ...iders/TestData/RestClientProviderTests/TestBuildCreateRequestMethodWithQueryParameters.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ namespace Sample
{
public partial class TestClient
{
internal global::System.ClientModel.Primitives.PipelineMessage CreateSampleOpRequest(global::System.Collections.Generic.IEnumerable<string> p1Explode, global::System.Collections.Generic.IEnumerable<string> p1, global::System.Collections.Generic.IEnumerable<int> p2Explode, global::System.Collections.Generic.IEnumerable<int> p2, global::System.Collections.Generic.IDictionary<string, int> p3Explode, global::System.Collections.Generic.IDictionary<string, int> p3, global::System.Collections.Generic.IEnumerable<global::Sample.Models.Foo> p4Explode, global::System.Collections.Generic.IEnumerable<global::Sample.Models.IntFoo> p5Explode, global::System.Collections.Generic.IDictionary<string, global::Sample.Models.Foo> p6Explode, global::System.Collections.Generic.IDictionary<string, global::Sample.Models.IntFoo> p7Explode, global::System.Collections.Generic.IEnumerable<global::Sample.Models.FloatFoo> p8Explode, global::System.Collections.Generic.IEnumerable<global::Sample.Models.DoubleFoo> p9Explode, string optionalParam, global::System.ClientModel.Primitives.RequestOptions options)
internal global::System.ClientModel.Primitives.PipelineMessage CreateSampleOpRequest(global::System.Collections.Generic.IEnumerable<string> p1Explode, global::System.Collections.Generic.IEnumerable<string> p1, global::System.Collections.Generic.IEnumerable<int> p2Explode, global::System.Collections.Generic.IEnumerable<int> p2, global::System.Collections.Generic.IDictionary<string, int> p3Explode, global::System.Collections.Generic.IDictionary<string, int> p3, global::System.Collections.Generic.IEnumerable<global::Sample.Models.Foo> p4Explode, global::System.Collections.Generic.IEnumerable<global::Sample.Models.IntFoo> p5Explode, global::System.Collections.Generic.IDictionary<string, global::Sample.Models.Foo> p6Explode, global::System.Collections.Generic.IDictionary<string, global::Sample.Models.IntFoo> p7Explode, global::System.Collections.Generic.IEnumerable<global::Sample.Models.FloatFoo> p8Explode, global::System.Collections.Generic.IEnumerable<global::Sample.Models.DoubleFoo> p9Explode, global::System.Collections.Generic.IEnumerable<global::Sample.Models.ExtensibleFoo> p10Explode, global::System.Collections.Generic.IDictionary<string, global::Sample.Models.ExtensibleFoo> p11Explode, string p12, string optionalParam, string p13, global::System.ClientModel.Primitives.RequestOptions options)
{
global::Sample.ClientUriBuilder uri = new global::Sample.ClientUriBuilder();
uri.Reset(_endpoint);
Expand Down Expand Up @@ -75,14 +75,14 @@ public partial class TestClient
{
foreach (var @param in p6Explode)
{
uri.AppendQuery(@param.Key, @param.ToSerialString(), true);
uri.AppendQuery(@param.Key, @param.Value.ToSerialString(), true);
}
}
if (((p7Explode != null) && !((p7Explode is global::Sample.ChangeTrackingDictionary<string, global::Sample.Models.IntFoo> changeTrackingDictionary2) && changeTrackingDictionary2.IsUndefined)))
{
foreach (var @param in p7Explode)
{
uri.AppendQuery(@param.Key, ((int)@param), true);
uri.AppendQuery(@param.Key, ((int)@param.Value), true);
}
}
if (((p8Explode != null) && !((p8Explode is global::Sample.ChangeTrackingList<global::Sample.Models.FloatFoo> changeTrackingList5) && changeTrackingList5.IsUndefined)))
Expand All @@ -99,6 +99,33 @@ public partial class TestClient
uri.AppendQuery("p9Explode", ((double)@param), true);
}
}
if (((p10Explode != null) && !((p10Explode is global::Sample.ChangeTrackingList<global::Sample.Models.ExtensibleFoo> changeTrackingList7) && changeTrackingList7.IsUndefined)))
{
foreach (var @param in p10Explode)
{
string paramStr = @param.ToString();
if ((paramStr != null))
{
uri.AppendQuery("p10Explode", paramStr, true);
}
}
}
if (((p11Explode != null) && !((p11Explode is global::Sample.ChangeTrackingDictionary<string, global::Sample.Models.ExtensibleFoo> changeTrackingDictionary3) && changeTrackingDictionary3.IsUndefined)))
{
foreach (var @param in p11Explode)
{
string paramStr = @param.Value.ToString();
if ((paramStr != null))
{
uri.AppendQuery(@param.Key, paramStr, true);
}
}
}
uri.AppendQuery("p12", p12, true);
Comment thread
jorgerangel-msft marked this conversation as resolved.
if ((p13 != null))
{
uri.AppendQuery("p13", p13, true);
}
global::System.ClientModel.Primitives.PipelineMessage message = Pipeline.CreateMessage(uri.ToUri(), "GET", PipelineMessageClassifier200);
global::System.ClientModel.Primitives.PipelineRequest request = message.Request;
message.Apply(options);
Expand Down