File: GoContractWriter.cs

package info (click to toggle)
golang-github-microsoft-dev-tunnels 0.0.25-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,988 kB
  • sloc: cs: 9,969; java: 2,767; javascript: 328; xml: 186; makefile: 5
file content (498 lines) | stat: -rw-r--r-- 17,038 bytes parent folder | download
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
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
// <copyright file="GoContractWriter.cs" company="Microsoft">
// Copyright (c) Microsoft. All rights reserved.
// Licensed under the MIT license.
// </copyright>

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Text;
using System.Text.RegularExpressions;
using Microsoft.CodeAnalysis;

namespace Microsoft.DevTunnels.Generator;

internal class GoContractWriter : ContractWriter
{

    public GoContractWriter(string repoRoot, string csNamespace) : base(repoRoot, csNamespace)
    {
    }

    public override void WriteContract(ITypeSymbol type, ICollection<ITypeSymbol> allTypes)
    {
        var csFilePath = GetRelativePath(type.Locations.Single().GetLineSpan().Path);

        var fileName = ToSnakeCase(type.Name) + ".go";
        var filePath = GetAbsolutePath(Path.Combine("go/tunnels", fileName));

        var s = new StringBuilder();
        s.AppendLine("// Copyright (c) Microsoft Corporation.");
        s.AppendLine("// Licensed under the MIT license.");
        s.AppendLine($"// Generated from ../../../{csFilePath}");
        s.AppendLine();
        s.AppendLine("package tunnels");
        s.AppendLine();

        var importsOffset = s.Length;
        var imports = new SortedSet<string>();

        if (!WriteContractType(s, type, imports, allTypes))
        {
            return;
        }

        imports.Remove(type.Name);
        if (imports.Count > 0)
        {
            var importsString = new StringBuilder();
            importsString.AppendLine("import (");

            foreach (var import in imports)
            {
                importsString.AppendLine($"\t\"{import}\"");
            }

            importsString.AppendLine(")");
            importsString.AppendLine();
            s.Insert(importsOffset, importsString.ToString());
        }

        if (!Directory.Exists(Path.GetDirectoryName(filePath)))
        {
            Directory.CreateDirectory(Path.GetDirectoryName(filePath));
        }

        File.WriteAllText(filePath, s.ToString());
    }

    private bool WriteContractType(
        StringBuilder s,
        ITypeSymbol type,
        SortedSet<string> imports,
        ICollection<ITypeSymbol> allTypes)
    {
        var members = type.GetMembers();
        if (type.BaseType?.Name == nameof(Enum) || members.All((m) =>
            m.DeclaredAccessibility != Accessibility.Public ||
            (m is IFieldSymbol field &&
             ((field.IsConst && field.Type.Name == nameof(String)) || field.Name == "All")) ||
            (m is IMethodSymbol method && method.MethodKind == MethodKind.StaticConstructor)))
        {
            WriteEnumContract(s, type);
        }
        else if (type.IsStatic && members.All((m) => m.IsStatic))
        {
            WriteStaticClassContract(s, type, imports);
        }
        else
        {
            // Derived type interfaces will be generated along with the base type.
            if (type.BaseType != null && type.BaseType.Name != nameof(Object))
            {
                return false;
            }

            WriteInterfaceContract(s, type, imports, allTypes);
        }

        var nestedTypes = type.GetTypeMembers()
            .Where((t) => !ContractsGenerator.ExcludedContractTypes.Contains(t.Name))
            .ToArray();
        foreach (var nestedType in nestedTypes.Where(
            (t) => !ContractsGenerator.ExcludedContractTypes.Contains(t.Name)))
        {
            s.AppendLine();
            WriteContractType(s, nestedType, imports, allTypes);
        }

        return true;
    }

    private void WriteInterfaceContract(
        StringBuilder s,
        ITypeSymbol type,
        SortedSet<string> imports,
        ICollection<ITypeSymbol> allTypes)
    {
        s.Append(FormatDocComment(type.GetDocumentationCommentXml(), ""));
        s.Append($"type {type.Name} struct {{");

        var derivedTypes = allTypes.Where(
            (t) => SymbolEqualityComparer.Default.Equals(t.BaseType, type)).ToArray();

        var properties = type.GetMembers()
            .OfType<IPropertySymbol>()
            .Where((p) => !p.IsStatic)
            .ToArray();
        var maxPropertyNameLength = properties.Length == 0 ? 0 :
            properties.Select((p) => p.Name.Length).Max();
        foreach (var property in properties)
        {
            var propertyName = FixPropertyNameCasing(property.Name);

            s.AppendLine();
            s.Append(FormatDocComment(property.GetDocumentationCommentXml(), "\t"));
            var alignment = new string(' ', maxPropertyNameLength - propertyName.Length);
            var propertyType = property.Type.ToDisplayString();
            var goType = GetGoTypeForCSType(propertyType, property, imports);
            var jsonTag = GetJsonTagForProperty(property);
            s.AppendLine($"\t{propertyName}{alignment} {goType} `json:\"{jsonTag}\"`");
        }

        if (derivedTypes.Length > 0)
        {
            s.AppendLine();
            foreach (var derivedType in derivedTypes.OrderBy((t) => t.Name))
            {
                s.AppendLine($"\t{derivedType.Name}");
            }
        }

        s.AppendLine("}");

        foreach (var derivedType in derivedTypes.OrderBy((t) => t.Name))
        {
            s.AppendLine();
            WriteInterfaceContract(s, derivedType, imports, allTypes);
        }

        foreach (var field in type.GetMembers().OfType<IFieldSymbol>()
            .Where((f) => f.IsConst))
        {
            var fieldName = FixPropertyNameCasing(field.Name);
            if (field.DeclaredAccessibility == Accessibility.Internal)
            {
                fieldName = TSContractWriter.ToCamelCase(fieldName);
            }
            else if (field.DeclaredAccessibility != Accessibility.Public)
            {
                continue;
            }

            s.AppendLine();
            s.Append(FormatDocComment(field.GetDocumentationCommentXml(), "", GetGoDoc(field)));
            s.AppendLine($"var {fieldName} = \"{field.ConstantValue}\"");
        }

    }

    private void WriteEnumContract(StringBuilder s, ITypeSymbol type)
    {
        s.Append(FormatDocComment(type.GetDocumentationCommentXml(), ""));

        string typeName = type.Name;
        if (type.ContainingType != null)
        {
            typeName = type.ContainingType.Name + typeName;
        }

        if (typeName.EndsWith("s"))
        {
            var pluralTypeName = typeName;
            typeName = typeName.Substring(0, typeName.Length - 1);
            s.AppendLine($"type {pluralTypeName} []{typeName}");
        }

        s.AppendLine($"type {typeName} string");
        s.AppendLine();
        s.Append("const (");

        var fields = type.GetMembers()
            .OfType<IFieldSymbol>()
            .Where((f) => f.HasConstantValue && f.DeclaredAccessibility == Accessibility.Public)
            .ToArray();
        var maxFieldNameLength = fields.Length == 0 ? 0 : fields.Select((p) => p.Name.Length).Max();
        foreach (var field in fields)
        {
            s.AppendLine();
            s.Append(FormatDocComment(field.GetDocumentationCommentXml(), "\t", GetGoDoc(field)));
            var alignment = new string(' ', maxFieldNameLength - field.Name.Length);
            var value = type.BaseType?.Name == "Enum" ? field.Name : field.ConstantValue;
            s.AppendLine($"\t{typeName}{field.Name}{alignment} {typeName} = \"{value}\"");
        }

        s.AppendLine(")");

    }

    private void WriteStaticClassContract(
        StringBuilder s,
        ITypeSymbol type,
        SortedSet<string> imports)
    {
        var constLines = new List<string>();
        var varLines = new List<string>();

        foreach (var member in type.GetMembers())
        {
            var property = member as IPropertySymbol;
            var field = member as IFieldSymbol;
            if (!member.IsStatic || !(property?.IsReadOnly == true || field?.IsConst == true))
            {
                continue;
            }

            var memberName = FixPropertyNameCasing(member.Name);
            var value = GetMemberInitializer(member);

            if (value != null)
            {
                foreach (var package in new[] { "strings", "strconv", "regexp" })
                {
                    if (value.Contains(package + ".") && !imports.Contains(package))
                    {
                        imports.Add(package);
                    }
                }

                var lines = (value.All((c) => char.IsDigit(c)) ||
                    (value.StartsWith("\"") && value.EndsWith("\""))) ? constLines : varLines;
                lines.Add(FormatDocComment(member.GetDocumentationCommentXml(), "\t", GetGoDoc(member))
                    .Replace("// Gets a ", "// A ").TrimEnd());
                lines.Add($"\t{type.Name}{memberName} = {value}");
                lines.Add(string.Empty);
            }
        }

        if (constLines.Count > 0)
        {
            constLines.RemoveAt(constLines.Count - 1);
            s.AppendLine("const (");
            constLines.ForEach((line) => s.AppendLine(line));
            s.AppendLine(")");
        }

        if (varLines.Count > 0)
        {
            varLines.RemoveAt(varLines.Count - 1);
            s.AppendLine("var (");
            varLines.ForEach((line) => s.AppendLine(line));
            s.AppendLine(")");
        }
    }

    private static string ToSnakeCase(string name)
    {
        var s = new StringBuilder(name);

        for (int i = 0; i < s.Length; i++)
        {
            if (char.IsUpper(s[i]))
            {
                if (i > 0)
                {
                    s.Insert(i, '_');
                    i++;
                }

                s[i] = char.ToLowerInvariant(s[i]);
            }
        }

        return s.ToString();
    }

    private string FormatDocComment(string? comment, string prefix, List<string>? godoc = null)
    {
        if (comment == null)
        {
            return string.Empty;
        }

        comment = comment.Replace("\r", "");
        comment = new Regex("\n *").Replace(comment, " ");
        comment = new Regex($"<see cref=\".:({this.csNamespace}\\.)?(\\w+)\\.(\\w+)\" ?/>")
            .Replace(comment, (m) => $"`{m.Groups[2].Value}.{m.Groups[3].Value}`");
        comment = new Regex($"<see cref=\".:({this.csNamespace}\\.)?([^\"]+)\" ?/>")
            .Replace(comment, "`$2`");

        var summary = new Regex("<summary>(.*)</summary>").Match(comment).Groups[1].Value.Trim();
        var remarks = new Regex("<remarks>(.*)</remarks>").Match(comment).Groups[1].Value.Trim();

        var s = new StringBuilder();

        foreach (var commentLine in WrapComment(summary, 90 - 3 - prefix.Length))
        {
            s.AppendLine(prefix + "// " + commentLine);
        }

        if (!string.IsNullOrEmpty(remarks))
        {
            s.AppendLine(prefix + "//");
            foreach (var commentLine in WrapComment(remarks, 90 - 3 - prefix.Length))
            {
                s.AppendLine(prefix + "// " + commentLine);
            }
        }

        if (godoc != null)
        {
            foreach (var doc in godoc)
            {
                s.AppendLine(prefix + "// " + doc);
            }
        }

        return s.ToString();
    }

    private static string? GetMemberInitializer(ISymbol member)
    {
        var location = member.Locations.Single();
        var sourceSpan = location.SourceSpan;
        var sourceText = location.SourceTree!.ToString();
        var eolIndex = sourceText.IndexOf('\n', sourceSpan.End);
        var equalsIndex = sourceText.IndexOf('=', sourceSpan.End);

        if (equalsIndex < 0 || equalsIndex > eolIndex)
        {
            // The member does not have an initializer.
            return null;
        }

        var semicolonIndex = sourceText.IndexOf(';', equalsIndex);
        if (semicolonIndex < 0)
        {
            // Invalid syntax??
            return null;
        }

        var csExpression = sourceText.Substring(
            equalsIndex + 1, semicolonIndex - equalsIndex - 1).Trim();

        // Attempt to convert the CS expression to a Go expression. This involves several
        // weak assumptions, and will not work for many kinds of expressions. But it might
        // be good enough.
        var goExpression = csExpression.Replace("new Regex", "regexp.MustCompile");
        goExpression = new Regex("(\\w+)\\.Replace\\(([^,]*), ([^)]*)\\)")
            .Replace(goExpression, "strings.Replace($1, $2, $3, -1)");

        // Assume any PascalCase identifiers are referncing other variables in scope.
        // Contvert integer constants to strings, allowing for integer offsets.
        goExpression = new Regex("([A-Z][a-z]+){2,6}\\b(?!\\()").Replace(
            goExpression, (m) => $"{member.ContainingType.Name}{m.Value}");
        goExpression = new Regex("\\(([A-Z][a-z]+){4,7} - \\d\\)").Replace(
            goExpression, (m) => $"strconv.Itoa{m.Value}");
        goExpression = new Regex("\\b([A-Z][a-z]+){3,6}Length\\b(?! - \\d)").Replace(
            goExpression, (m) => $"strconv.Itoa({m.Value})");
        goExpression = FixPropertyNameCasing(goExpression);
        goExpression = goExpression.Replace("        ", "\t\t");

        return goExpression;
    }

    private string GetJsonTagForProperty(IPropertySymbol property)
    {
        var tag = TSContractWriter.ToCamelCase(property.Name);
        if (property.TryGetJsonPropertyName(out var jsonPropertyName))
        {
            tag = jsonPropertyName!;
        }

        var jsonIgnoreAttribute = property.GetAttributes()
            .SingleOrDefault((a) => a.AttributeClass!.Name == "JsonIgnoreAttribute");
        if (jsonIgnoreAttribute != null)
        {
            if (jsonIgnoreAttribute.NamedArguments.Length != 1 ||
                jsonIgnoreAttribute.NamedArguments[0].Key != "Condition")
            {
                // TODO: Diagnostic
                throw new ArgumentException("JsonIgnoreAttribute must have a condition argument.");
            }

            tag += ",omitempty";
        }

        return tag;
    }

    private static string FixPropertyNameCasing(string propertyName)
    {
        propertyName = propertyName.Replace("Id", "ID");
        propertyName = propertyName.Replace("Uri", "URI");
        return propertyName;
    }

    private string GetGoTypeForCSType(string csType, IPropertySymbol property, SortedSet<string> imports)
    {
        var isNullable = csType.EndsWith("?");
        if (isNullable)
        {
            csType = csType.Substring(0, csType.Length - 1);
        }

        var prefix = "";
        if (csType.EndsWith("[]"))
        {
            prefix = "[]";
            csType = csType.Substring(0, csType.Length - 2);
            isNullable = false;
        }

        string goType;
        if (csType.StartsWith(this.csNamespace + "."))
        {
            goType = csType.Substring(csNamespace.Length + 1);
        }
        else
        {
            goType = csType switch
            {
                "bool" => "bool",
                "short" => "int16",
                "ushort" => "uint16",
                "int" => "int32",
                "uint" => "uint32",
                "long" => "int64",
                "ulong" => "uint64",
                "string" => "string",
                "System.DateTime" => "time.Time",
                "System.Text.RegularExpressions.Regex" => "regexp.Regexp",
                "System.Collections.Generic.IDictionary<string, string>"
                    => $"map[{(property.Name == "AccessTokens" ? "TunnelAccessScope" : "string")}]string",
                "System.Collections.Generic.IDictionary<string, string[]>" => "map[string][]string",
                _ => throw new NotSupportedException("Unsupported C# type: " + csType),
            };

            if (!goType.Contains("."))
            {
                // Struct members of type string and other basic types, arrays, and maps are
                // conventionally not represented as pointers in Go. An implication is that partial
                // resource updates may require custom marshalling to omit non-updated fields.
                isNullable = false;
            }
        }

        if (isNullable)
        {
            prefix = "*" + prefix;
        }

        if (goType.Contains('.'))
        {
            var package = goType.Split('.')[0];
            if (!imports.Contains(package))
            {
                imports.Add(package);
            }
        }

        goType = prefix + goType;
        return goType;
    }

    private static List<string> GetGoDoc(ISymbol symbol)
    {
        var doc = new List<string>();
        var obsoleteAttribute = GetObsoleteAttribute(symbol);
        if (obsoleteAttribute != null)
        {
            var message = GetObsoleteMessage(obsoleteAttribute);
            doc.Add($"Deprecated: {message}");
        }

        return doc;
    }
}