-
Notifications
You must be signed in to change notification settings - Fork 7
/
CsvRecordGenerator.cs
411 lines (349 loc) · 16.7 KB
/
CsvRecordGenerator.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
// Copyright (c) .NET Foundation. All rights reserved.
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
using System.Collections.Immutable;
using Humanizer;
using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.CSharp;
using Microsoft.CodeAnalysis.CSharp.Syntax;
using Microsoft.CodeAnalysis.Text;
namespace NuGet.Insights
{
[Generator]
public class CsvRecordGenerator : ISourceGenerator
{
internal const string Category = "NuGet.Insights.SourceGenerator";
private const string InterfaceNameSuffix = "ICsvRecord";
private const string FullInterfaceName = "NuGet.Insights.ICsvRecord";
private const string FullKustoTypeAttributeName = "NuGet.Insights.KustoTypeAttribute";
private const string NoKustoDDLAttributeName = "NuGet.Insights.NoKustoDDLAttribute";
private static readonly string AutoGenerated = @"// <auto-generated />
";
private static readonly string CsvRecordTemplate = AutoGenerated + @"// Copyright (c) .NET Foundation. All rights reserved.
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
using System;
using System.Collections.Generic;
using System.IO;
using System.Threading.Tasks;
using NuGet.Insights;
namespace {0}
{{
/* Kusto DDL:
.drop table {1} ifexists;
.create table {1} (
{2}
) with (docstring = ""See https://github.com/NuGet/Insights/blob/main/docs/tables/{1}.md"", folder = """");
.alter-merge table {1} policy retention softdelete = 30d;
.alter table {1} policy partitioning {3};
.create table {1} ingestion csv mapping '{13}'
'['
{4}
']'
*/
partial {5} {6}
{{
public static int FieldCount => {7};
public static void WriteHeader(TextWriter writer)
{{
{8}
}}
public void Write(List<string> fields)
{{
{9}
}}
public void Write(TextWriter writer)
{{
{10}
}}
public async Task WriteAsync(TextWriter writer)
{{
{11}
}}
public static {6} ReadNew(Func<string> getNextField)
{{
return new {6}
{{
{12}
}};
}}
public void SetEmptyStrings()
{{
{14}
}}
}}
}}
";
private static readonly string KustoDDLTemplate = AutoGenerated + @"// Copyright (c) .NET Foundation. All rights reserved.
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
using System.Collections.Generic;
namespace NuGet.Insights
{{
static partial class KustoDDL
{{
public const string {3}DefaultTableName = ""{1}"";
public static readonly IReadOnlyList<string> {3}DDL = new[]
{{
"".drop table __TABLENAME__ ifexists"",
@"".create table __TABLENAME__ (
{2}
) with (docstring = __DOCSTRING__, folder = __FOLDER__)"",
"".alter-merge table __TABLENAME__ policy retention softdelete = 30d"",
@"".create table __TABLENAME__ ingestion csv mapping '{6}'
'['
{5}
']'"",
}};
public const string {3}PartitioningPolicy = @"".alter table __TABLENAME__ policy partitioning {4}"";
private static readonly bool {3}AddTypeToDefaultTableName = AddTypeToDefaultTableName(typeof({0}.{3}), {3}DefaultTableName);
private static readonly bool {3}AddTypeToDDL = AddTypeToDDL(typeof({0}.{3}), {3}DDL);
private static readonly bool {3}AddTypeToPartitioningPolicy = AddTypeToPartitioningPolicy(typeof({0}.{3}), {3}PartitioningPolicy);
}}
}}
";
public void Initialize(GeneratorInitializationContext context)
{
context.RegisterForSyntaxNotifications(() => new SyntaxReceiver());
}
public void Execute(GeneratorExecutionContext context)
{
if (!(context.SyntaxReceiver is SyntaxReceiver receiver))
{
return;
}
// This is a very hacky way of not adding duplicate types. For example, the KustoDDL type really only needs
// to exist in NuGet.Insights.Worker.Logic and in no other project.
var isTestAssembly = context.Compilation.AssemblyName.EndsWith(".Test", StringComparison.Ordinal);
// Debugger.Launch();
var nullable = context.Compilation.GetTypeByMetadataName("System.Nullable`1");
var interfaceType = context.Compilation.GetTypeByMetadataName(FullInterfaceName);
if (interfaceType == null)
{
context.ReportDiagnostic(Diagnostic.Create(
new DiagnosticDescriptor(
id: DiagnosticIds.MissingICsvRecordInterface,
title: $"{InterfaceNameSuffix} interface could not be found",
messageFormat: $"The {FullInterfaceName} interface could not be found.",
Category,
DiagnosticSeverity.Error,
isEnabledByDefault: true),
Location.None));
}
var kustoTypeAttributeType = context.Compilation.GetTypeByMetadataName(FullKustoTypeAttributeName);
if (kustoTypeAttributeType == null)
{
context.ReportDiagnostic(Diagnostic.Create(
new DiagnosticDescriptor(
id: DiagnosticIds.MissingKustoTypeAttribute,
title: $"{FullKustoTypeAttributeName.Split('.').Last()} type could not be found",
messageFormat: $"The {FullKustoTypeAttributeName} type could not be found.",
Category,
DiagnosticSeverity.Error,
isEnabledByDefault: true),
Location.None));
}
var noKustoDDLAttributeType = context.Compilation.GetTypeByMetadataName(NoKustoDDLAttributeName);
if (noKustoDDLAttributeType == null)
{
context.ReportDiagnostic(Diagnostic.Create(
new DiagnosticDescriptor(
id: DiagnosticIds.MissingNoKustoDDLAttribute,
title: $"{NoKustoDDLAttributeName.Split('.').Last()} type could not be found",
messageFormat: $"The {NoKustoDDLAttributeName} type could not be found.",
Category,
DiagnosticSeverity.Error,
isEnabledByDefault: true),
Location.None));
}
var requiredAttributeType = context.Compilation.GetTypeByMetadataName("System.ComponentModel.DataAnnotations.RequiredAttribute");
var infos = receiver
.CandidateClasses
.Select(x => new { Keyword = "class", Candidate = (TypeDeclarationSyntax)x, x.Identifier, x.Modifiers })
.Concat(receiver
.CandidateRecords
.Select(x => new { Keyword = "record", Candidate = (TypeDeclarationSyntax)x, x.Identifier, x.Modifiers }));
var sourceAdded = false;
foreach (var info in infos)
{
var model = context.Compilation.GetSemanticModel(info.Candidate.SyntaxTree);
var symbol = model.GetDeclaredSymbol(info.Candidate);
var attributes = symbol.GetAttributes();
var hasNoDDLAttribute = attributes.Any(x => SymbolEqualityComparer.Default.Equals(x.AttributeClass, noKustoDDLAttributeType));
ITypeSymbol typeSymbol = symbol;
if (!typeSymbol.AllInterfaces.OfType<INamedTypeSymbol>().Any(x => SymbolEqualityComparer.Default.Equals(interfaceType, x.OriginalDefinition)))
{
continue;
}
if (!info.Modifiers.Any(x => x.IsKind(SyntaxKind.PartialKeyword)))
{
context.ReportDiagnostic(Diagnostic.Create(
new DiagnosticDescriptor(
id: DiagnosticIds.CsvRecordNotMarkedAsPartial,
title: $"{InterfaceNameSuffix} implementor is not partial",
messageFormat: $"The type {{0}} implements {InterfaceNameSuffix} but is not declared as partial.",
Category,
DiagnosticSeverity.Error,
isEnabledByDefault: true),
info.Candidate.GetLocation(),
info.Identifier.Text));
continue;
}
var typeNamespacePrefix = symbol.ContainingNamespace.ToString() + ".";
var kustoTableCommentBuilder = new KustoTableBuilder(indent: 8);
var kustoPartitioningPolicyCommentBuilder = new KustoPartitioningPolicyBuilder(indent: 4, escapeQuotes: false);
var kustoMappingCommentBuilder = new KustoMappingBuilder(indent: 8, escapeQuotes: false);
var writeHeaderBuilder = new WriteHeaderBuilder(indent: 12);
var writeListBuilder = new WriteListBuilder(indent: 12);
var writeTextWriterBuilder = new WriteTextWriterBuilder(indent: 12);
var writeAsyncTextWriterBuilder = new WriteAsyncTextWriterBuilder(indent: 12);
var readerBuilder = new ReadBuilder(indent: 16);
var setEmptyStringsBuilder = new SetEmptyStringsBuilder(indent: 12);
var kustoTableConstantBuilder = new KustoTableBuilder(indent: 4);
var kustoPartitioningPolicyConstantBuilder = new KustoPartitioningPolicyBuilder(indent: 0, escapeQuotes: true);
var kustoMappingConstantBuilder = new KustoMappingBuilder(indent: 4, escapeQuotes: true);
var validatePropertyNullability = new ValidatePropertyNullability();
var visitors = new IPropertyVisitor[]
{
kustoTableCommentBuilder,
kustoPartitioningPolicyCommentBuilder,
kustoMappingCommentBuilder,
writeHeaderBuilder,
writeListBuilder,
writeTextWriterBuilder,
writeAsyncTextWriterBuilder,
readerBuilder,
setEmptyStringsBuilder,
kustoTableConstantBuilder,
kustoPartitioningPolicyConstantBuilder,
kustoMappingConstantBuilder,
validatePropertyNullability,
};
var sortedProperties = new List<IPropertySymbol>();
var currentType = symbol;
while (currentType != null)
{
sortedProperties.AddRange(currentType
.GetMembers()
.Where(x => !x.IsImplicitlyDeclared)
.OfType<IPropertySymbol>()
.OrderByDescending(x => x.Locations.First().SourceSpan.Start));
currentType = currentType.BaseType;
}
sortedProperties.Reverse();
var propertyNames = sortedProperties.Select(x => x.Name).ToImmutableHashSet();
var propertyVisitorContext = new PropertyVisitorContext(
context,
info.Candidate.SyntaxTree,
info.Candidate,
hasNoDDLAttribute,
nullable,
kustoTypeAttributeType,
requiredAttributeType);
foreach (var propertySymbol in sortedProperties)
{
var propType = propertySymbol.Type.ToString();
var propName = propertySymbol.Name;
var prettyType = PropertyHelper.GetPrettyType(typeNamespacePrefix, propertyNames, propertySymbol);
foreach (var visitor in visitors)
{
visitor.OnProperty(propertyVisitorContext, propertySymbol, prettyType);
}
}
foreach (var visitor in visitors)
{
visitor.Finish(propertyVisitorContext);
}
var typeName = info.Identifier.Text;
var kustoTableName = typeName;
var suffixesToRemove = new[]
{
"CsvRecord",
"Record",
}.OrderByDescending(x => x.Length).ThenBy(x => x, StringComparer.Ordinal);
foreach (var suffix in suffixesToRemove)
{
if (kustoTableName.EndsWith(suffix, StringComparison.OrdinalIgnoreCase))
{
kustoTableName = kustoTableName.Substring(0, kustoTableName.Length - suffix.Length);
}
}
kustoTableName = kustoTableName.Pluralize();
context.AddSource(
$"{typeName}.{InterfaceNameSuffix}.cs",
SourceText.From(
string.Format(
CsvRecordTemplate,
symbol.ContainingNamespace,
kustoTableName,
kustoTableCommentBuilder.GetResult(),
kustoPartitioningPolicyCommentBuilder.GetResult(),
kustoMappingCommentBuilder.GetResult(),
info.Keyword,
typeName,
propertyNames.Count,
writeHeaderBuilder.GetResult(),
writeListBuilder.GetResult(),
writeTextWriterBuilder.GetResult(),
writeAsyncTextWriterBuilder.GetResult(),
readerBuilder.GetResult(),
KustoDDL.CsvMappingName,
setEmptyStringsBuilder.GetResult()),
Encoding.UTF8));
if (!isTestAssembly && !hasNoDDLAttribute)
{
context.AddSource(
$"{typeName}.KustoDDL.cs",
SourceText.From(
string.Format(
KustoDDLTemplate,
symbol.ContainingNamespace,
kustoTableName,
kustoTableConstantBuilder.GetResult(),
typeName,
kustoPartitioningPolicyConstantBuilder.GetResult(),
kustoMappingConstantBuilder.GetResult(),
KustoDDL.CsvMappingName),
Encoding.UTF8));
}
sourceAdded = true;
}
if (sourceAdded && !isTestAssembly)
{
AddType(context, typeof(CsvUtility));
AddType(context, typeof(KustoDDL));
}
}
private static void AddType(GeneratorExecutionContext context, Type type)
{
var typeName = type.Name;
using (var stream = typeof(CsvRecordGenerator)
.Assembly
.GetManifestResourceStream($"{type.Namespace}.{type.Name}.cs"))
using (var reader = new StreamReader(stream))
{
var source = AutoGenerated + reader.ReadToEnd();
context.AddSource($"{typeName}.cs", SourceText.From(source, Encoding.UTF8));
}
}
private class SyntaxReceiver : ISyntaxReceiver
{
public List<ClassDeclarationSyntax> CandidateClasses { get; } = new List<ClassDeclarationSyntax>();
public List<RecordDeclarationSyntax> CandidateRecords { get; } = new List<RecordDeclarationSyntax>();
public void OnVisitSyntaxNode(SyntaxNode syntaxNode)
{
if (syntaxNode is ClassDeclarationSyntax classDeclarationSyntax && IsCandidateDeclaration(classDeclarationSyntax))
{
CandidateClasses.Add(classDeclarationSyntax);
}
else if (syntaxNode is RecordDeclarationSyntax recordDeclarationSyntax && IsCandidateDeclaration(recordDeclarationSyntax))
{
CandidateRecords.Add(recordDeclarationSyntax);
}
}
private static bool IsCandidateDeclaration<T>(T declaration) where T : TypeDeclarationSyntax
{
return declaration.BaseList?.Types.Any() == true
&& declaration.Modifiers.Any(SyntaxKind.PublicKeyword)
&& !declaration.Modifiers.Any(SyntaxKind.AbstractKeyword);
}
}
}
}