Skip to content

Adds auto-generated NodeIdValueSerializer for composite ids #8129

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.

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
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -201,4 +201,10 @@ public static IRequestExecutorBuilder AddNodeIdValueSerializer<T>(
builder.Services.AddSingleton<INodeIdValueSerializer>(serializer);
return builder;
}

public static IRequestExecutorBuilder AddNodeIdValueSerializerFrom<TFrom>(
this IRequestExecutorBuilder builder)
{
throw new NotImplementedException("HotChocolate.Types.Analyzers is required to use this method.");
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.CSharp.Syntax;

namespace HotChocolate.Types.Analyzers.Filters;

internal sealed class AddNodeIdValueSerializerFromMethod : ISyntaxFilter
{
private AddNodeIdValueSerializerFromMethod() { }

public static AddNodeIdValueSerializerFromMethod Instance { get; } = new();

public bool IsMatch(SyntaxNode node)
=> node is InvocationExpressionSyntax
{
Expression: MemberAccessExpressionSyntax
{
Name.Identifier.ValueText: "AddNodeIdValueSerializerFrom",
},
};
}
109 changes: 109 additions & 0 deletions src/HotChocolate/Core/src/Types.Analyzers/Generators/CodeFile.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
using System.Buffers.Text;
using System.Security.Cryptography;
using System.Text;
using HotChocolate.Types.Analyzers.Helpers;

namespace HotChocolate.Types.Analyzers.Generators;

public sealed class CodeFile : IDisposable
{
private StringBuilder? _sb;
private CodeWriter? _codeWriter;
private bool _disposed;

private CodeFile(string @namespace, string typeName)
{
FullName = CreateFileName(@namespace, typeName);
_sb = PooledObjects.GetStringBuilder();
}

public string FullName { get; }

public CodeWriter Writer
{
get
{
if (_disposed)
{
throw new ObjectDisposedException(nameof(CodeFile));
}

_sb ??= PooledObjects.GetStringBuilder();
return _codeWriter ??= new CodeWriter(_sb!);
}
}

public override string ToString()
{
if (_disposed)
{
throw new ObjectDisposedException(nameof(CodeFile));
}

if (_sb is null)
{
return string.Empty;
}

return _sb.ToString();
}

public void Dispose()
{
if (_disposed)
{
return;
}

if (_sb is not null)
{
_sb!.Clear();
PooledObjects.Return(_sb);
}
_codeWriter = null;
_sb = null;
_disposed = true;
}

public static CodeFile Create(string @namespace, string typeName)
{
return new CodeFile(@namespace, typeName);
}

static string CreateFileName(string @namespace, string typeName)
{
#if NET8_0_OR_GREATER
Span<byte> hash = stackalloc byte[64];
var bytes = Encoding.UTF8.GetBytes(@namespace);
MD5.HashData(bytes, hash);
Base64.EncodeToUtf8InPlace(hash, 16, out var written);
hash = hash[..written];

for (var i = 0; i < hash.Length; i++)
{
if (hash[i] == (byte)'+')
{
hash[i] = (byte)'-';
}
else if (hash[i] == (byte)'/')
{
hash[i] = (byte)'_';
}
else if (hash[i] == (byte)'=')
{
hash = hash[..i];
break;
}
}

return $"{typeName}.{Encoding.UTF8.GetString(hash)}.hc.g.cs";
#else
var bytes = Encoding.UTF8.GetBytes(@namespace);
var md5 = MD5.Create();
var hash = md5.ComputeHash(bytes);
var hashString = Convert.ToBase64String(hash, Base64FormattingOptions.None);
hashString = hashString.Replace("+", "-").Replace("/", "_").TrimEnd('=');
return $"{typeName}.{hashString}.hc.g.cs";
#endif
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,196 @@
using System.Collections.Immutable;
using HotChocolate.Types.Analyzers.Helpers;
using HotChocolate.Types.Analyzers.Models;
using Microsoft.CodeAnalysis;

namespace HotChocolate.Types.Analyzers.Generators;

public sealed class NodeIdValueSerializerGenerator : ISyntaxGenerator
{
public void Generate(
SourceProductionContext context,
string assemblyName,
ImmutableArray<SyntaxInfo> syntaxInfos)
{
foreach (var syntaxInfo in syntaxInfos)
{
if (syntaxInfo is not NodeIdValueSerializerInfo compositeNodeIdSerializer)
{
continue;
}

using var codeFile = CodeFile.Create(
compositeNodeIdSerializer.CompositeId.ContainingNamespace.ToDisplayString(),
$"{compositeNodeIdSerializer.CompositeId.Name}NodeIdValueSerializer.g.cs");

GenerateNodeIdSerializer(
compositeNodeIdSerializer.CompositeId,
codeFile.Writer);

context.AddSource(codeFile.FullName, codeFile.ToString());
}

GenerateInterceptor(context, syntaxInfos);
}

private static void GenerateNodeIdSerializer(
INamedTypeSymbol compositeId,
CodeWriter sourceFile)
{
var typeName = compositeId.Name;
var serializerName = $"{typeName}NodeIdValueSerializer";

sourceFile.WriteIndentedLine($"private sealed class {serializerName} : CompositeNodeIdValueSerializer<{typeName}>");
using (sourceFile.WithCurlyBrace())
{
using (sourceFile.WriteMethod("protected override", "NodeIdFormatterResult", "Format", $"Span<byte> buffer", $"{typeName} value", "out int written"))
{
sourceFile.WriteIndentedLine("int offset = 0;");

foreach (var member in compositeId.GetMembers().OfType<IPropertySymbol>().Where(m => !m.IsStatic && m.DeclaredAccessibility == Accessibility.Public && m.GetMethod != null))
{
var formatMethod = GetFormatMethod(member.Type);
if (formatMethod != null)
{
sourceFile.WriteIndentedLine($"if (!{formatMethod}(buffer.Slice(offset), value.{member.Name}, out var {member.Name.ToLower()}Written))");
using (sourceFile.WithCurlyBrace())
{
sourceFile.WriteIndentedLine("return NodeIdFormatterResult.BufferTooSmall;");
}
sourceFile.WriteIndentedLine($"offset += {member.Name.ToLower()}Written;");
}
}

sourceFile.WriteIndentedLine("written = offset;");
sourceFile.WriteIndentedLine("return NodeIdFormatterResult.Success;");
}

// Generate TryParse method
using (sourceFile.WriteMethod("protected override", "bool", "TryParse", "ReadOnlySpan<byte> buffer", $"out {typeName} value"))
{
sourceFile.WriteIndentedLine("int offset = 0;");

var parsedValues = new List<string>();

foreach (var member in compositeId.GetMembers().OfType<IPropertySymbol>())
{
if (member.IsStatic || member.DeclaredAccessibility != Accessibility.Public ||
(member.SetMethod == null
&& !compositeId.IsRecord
&& !HasConstructorParameter(compositeId, member.Name)))
{
continue;
}

var parseMethod = GetParseMethod(member.Type);
if (parseMethod != null)
{
string varName = member.Name.ToLower();
sourceFile.WriteIndentedLine($"if (!{parseMethod}(buffer.Slice(offset), out var {varName}, out var {varName}Consumed))");
using (sourceFile.WithCurlyBrace())
{
sourceFile.WriteIndentedLine("value = default;");
sourceFile.WriteIndentedLine("return false;");
}
sourceFile.WriteIndentedLine($"offset += {varName}Consumed;");
parsedValues.Add(varName);
}
}

if (compositeId.IsRecord || HasConstructorParameters(compositeId))
{
sourceFile.WriteIndentedLine($"value = new {typeName}({string.Join(", ", parsedValues)});");
}
else
{
sourceFile.WriteIndentedLine($"value = new {typeName}()");
using (sourceFile.WithCurlyBrace())
{
foreach (var member in compositeId.GetMembers().OfType<IPropertySymbol>().Where(m => !m.IsStatic && m.DeclaredAccessibility == Accessibility.Public && (m.SetMethod != null || compositeId.IsRecord)))
{
sourceFile.WriteIndentedLine($"{member.Name} = {member.Name.ToLower()},");
}
}
sourceFile.WriteIndentedLine(";");
}
sourceFile.WriteIndentedLine("return true;");
}
}
}

private static void GenerateInterceptor(
SourceProductionContext context,
ImmutableArray<SyntaxInfo> syntaxInfos)
{
using var codeFile = CodeFile.Create(
"HotChocolate.Execution.Generated",
"HotChocolateNodeIdValueSerializers");

codeFile.Writer.WriteIndentedLine("namespace HotChocolate.Execution.Generated;");
codeFile.Writer.WriteLine();
codeFile.Writer.WriteIndentedLine("public static class HotChocolateNodeIdValueSerializers");
using (codeFile.Writer.WithCurlyBrace())
{
foreach (var syntaxInfo in syntaxInfos)
{
if (syntaxInfo is not NodeIdValueSerializerInfo compositeNodeIdSerializer)
{
continue;
}

var typeName = compositeNodeIdSerializer.CompositeId.Name;
var serializerName = $"{typeName}NodeIdValueSerializer";

codeFile.Writer.WriteIndentedLine("[InterceptsLocation(\"HotChocolate.Types.Relay.IRequestExecutorBuilder\", \"AddNodeIdValueSerializerFrom\")]");
using (codeFile.Writer.WriteMethod(
"public static",
"IRequestExecutorBuilder",
"AddNodeIdValueSerializerFromOurType",
"this IRequestExecutorBuilder builder"))
{
codeFile.Writer.WriteIndentedLine($"return RequestExecutorBuilderExtensions.AddNodeIdValueSerializer<{serializerName}>(builder);");
}
}
}

context.AddSource(codeFile.FullName, codeFile.ToString());
}

private static bool HasConstructorParameter(INamedTypeSymbol typeSymbol, string propertyName)
{
return typeSymbol.Constructors.Any(c => c.Parameters.Any(p => p.Name.Equals(propertyName, StringComparison.OrdinalIgnoreCase)));
}

private static bool HasConstructorParameters(INamedTypeSymbol typeSymbol)
{
return typeSymbol.Constructors.Any(c => c.Parameters.Length > 0);
}

private static string? GetFormatMethod(ITypeSymbol type)
{
return type.SpecialType switch
{
SpecialType.System_String => "TryFormatIdPart",
SpecialType.System_Int32 => "TryFormatIdPart",
SpecialType.System_Int16 => "TryFormatIdPart",
SpecialType.System_Int64 => "TryFormatIdPart",
SpecialType.System_Boolean => "TryFormatIdPart",
_ when type.ToString() == "System.Guid" => "TryFormatIdPart",
_ => null
};
}

private static string? GetParseMethod(ITypeSymbol type)
{
return type.SpecialType switch
{
SpecialType.System_String => "TryParseIdPart",
SpecialType.System_Int32 => "TryParseIdPart",
SpecialType.System_Int16 => "TryParseIdPart",
SpecialType.System_Int64 => "TryParseIdPart",
SpecialType.System_Boolean => "TryParseIdPart",
_ when type.ToString() == "System.Guid" => "TryParseIdPart",
_ => null
};
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@ public class GraphQLServerGenerator : IIncrementalGenerator
new ObjectTypeInspector(),
new InterfaceTypeInfoInspector(),
new RequestMiddlewareInspector(),
new ConnectionInspector()
new ConnectionInspector(),
new NodeIdValueSerializerInspector()
];

private static readonly IPostCollectSyntaxTransformer[] _postCollectTransformers =
Expand All @@ -40,7 +41,8 @@ public class GraphQLServerGenerator : IIncrementalGenerator
new TypesSyntaxGenerator(),
new MiddlewareGenerator(),
new DataLoaderModuleGenerator(),
new DataLoaderGenerator()
new DataLoaderGenerator(),
new NodeIdValueSerializerGenerator(),
];

private static readonly FrozenDictionary<SyntaxKind, ImmutableArray<ISyntaxInspector>> _inspectorLookup;
Expand Down
Loading
Loading