Skip to content

fix: handle tuple types in custom code #7482

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

Merged
merged 2 commits into from
May 28, 2025
Merged

fix: handle tuple types in custom code #7482

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0849fcd
fix: handle tuple types in custom code
jorgerangel-msft May 27, 2025
183b702
cleanup
jorgerangel-msft May 27, 2025
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
57 changes: 33 additions & 24 deletions ...lient-csharp/generator/Microsoft.TypeSpec.Generator/src/Utilities/TypeSymbolExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ internal static class TypeSymbolExtensions
{
private const string GlobalPrefix = "global::";
private const string NullableTypeName = "System.Nullable";
private const string TupleTypeName = "System.ValueTuple";

public static bool IsSameType(this INamedTypeSymbol symbol, CSharpType type)
{
Expand Down Expand Up @@ -105,38 +106,46 @@ public static string GetFullyQualifiedName(this ITypeSymbol typeSymbol)
{
return GetFullyQualifiedName(arrayTypeSymbol.ElementType) + "[]";
}

// Handle generic types
if (typeSymbol is INamedTypeSymbol namedTypeSymbol && namedTypeSymbol.IsGenericType)
// Handle tuples & generic types
if (typeSymbol is INamedTypeSymbol namedTypeSymbol)
{
// Handle nullable types
if (typeSymbol.NullableAnnotation == NullableAnnotation.Annotated && !IsCollectionType(namedTypeSymbol))
if (typeSymbol.IsTupleType)
{
var argTypeSymbol = namedTypeSymbol.TypeArguments.FirstOrDefault();
string[] elementTypes = [.. namedTypeSymbol.TupleElements.Select(e => GetFullyQualifiedName(e.Type))];
return $"{TupleTypeName}`{elementTypes.Length}[{string.Join(", ", elementTypes)}]";
}

if (argTypeSymbol != null)
if (namedTypeSymbol.IsGenericType)
{
// Handle nullable types
if (typeSymbol.NullableAnnotation == NullableAnnotation.Annotated && !IsCollectionType(namedTypeSymbol))
{
// If the argument type is an error type, then fall back to using the ToString of the arg type symbol. This means that the
// arg may not be fully qualified, but it is better than not having any type information at all.
if (argTypeSymbol.TypeKind == TypeKind.Error)
var argTypeSymbol = namedTypeSymbol.TypeArguments.FirstOrDefault();

if (argTypeSymbol != null)
{
return $"{NullableTypeName}`1[{argTypeSymbol}]";
// If the argument type is an error type, then fall back to using the ToString of the arg type symbol. This means that the
// arg may not be fully qualified, but it is better than not having any type information at all.
if (argTypeSymbol.TypeKind == TypeKind.Error)
{
return $"{NullableTypeName}`1[{argTypeSymbol}]";
}

string[] typeArguments = [.. namedTypeSymbol.TypeArguments.Select(arg => "[" + GetFullyQualifiedName(arg) + "]")];
return $"{NullableTypeName}`{namedTypeSymbol.TypeArguments.Length}[{string.Join(", ", typeArguments)}]";
}

string[] typeArguments = [.. namedTypeSymbol.TypeArguments.Select(arg => "[" + GetFullyQualifiedName(arg) + "]")];
return $"{NullableTypeName}`{namedTypeSymbol.TypeArguments.Length}[{string.Join(", ", typeArguments)}]";
}
}
else if (namedTypeSymbol.TypeArguments.Length > 0 && !IsCollectionType(namedTypeSymbol))
{
return GetNonNullableGenericTypeName(namedTypeSymbol);
}
else if (namedTypeSymbol.TypeArguments.Length > 0 && !IsCollectionType(namedTypeSymbol))
{
return GetNonNullableGenericTypeName(namedTypeSymbol);
}

var typeNameSpan = namedTypeSymbol.ConstructedFrom.ToDisplayString(SymbolDisplayFormat.FullyQualifiedFormat).AsSpan();
var start = typeNameSpan.IndexOf(':') + 2;
var end = typeNameSpan.IndexOf('<');
typeNameSpan = typeNameSpan.Slice(start, end - start);
return $"{typeNameSpan}`{namedTypeSymbol.TypeArguments.Length}";
var typeNameSpan = namedTypeSymbol.ConstructedFrom.ToDisplayString(SymbolDisplayFormat.FullyQualifiedFormat).AsSpan();
var start = typeNameSpan.IndexOf(':') + 2;
var end = typeNameSpan.IndexOf('<');
typeNameSpan = typeNameSpan.Slice(start, end - start);
return $"{typeNameSpan}`{namedTypeSymbol.TypeArguments.Length}";
}
}

// Default to fully qualified name
Expand Down
2 changes: 2 additions & 0 deletions ...ypeSpec.Generator/test/Providers/NamedTypeSymbolProviders/NamedTypeSymbolProviderTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

using System;
using System.Collections.Generic;
using System.Configuration;
using System.Linq;
using Microsoft.CodeAnalysis;
using Microsoft.TypeSpec.Generator.Expressions;
Expand Down Expand Up @@ -96,6 +97,7 @@ public void ValidateProperties()
[TestCase(typeof(SomeEnum), true)]
[TestCase(typeof(SomeEnum?), true)]
[TestCase(typeof(IDictionary<string, SomeEnum>))]
[TestCase(typeof((List<PropertyType> Values, string Foo, int Bar)))]
public void ValidatePropertyTypes(Type propertyType, bool isEnum = false)
{
// setup
Expand Down
Loading