forked from FacilityApi/FacilityJavaScript
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathJavaScriptGenerator.cs
More file actions
1260 lines (1126 loc) · 47 KB
/
JavaScriptGenerator.cs
File metadata and controls
1260 lines (1126 loc) · 47 KB
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
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
using System.Globalization;
using Facility.Definition;
using Facility.Definition.CodeGen;
using Facility.Definition.Fsd;
using Facility.Definition.Http;
namespace Facility.CodeGen.JavaScript
{
/// <summary>
/// Generates JavaScript and TypeScript.
/// </summary>
public sealed class JavaScriptGenerator : CodeGenerator
{
/// <summary>
/// Generates JavaScript/TypeScript.
/// </summary>
/// <param name="parser">The parser.</param>
/// <param name="settings">The settings.</param>
/// <returns>The number of updated files.</returns>
public static int GenerateCSharp(ServiceParser parser, JavaScriptGeneratorSettings settings) =>
FileGenerator.GenerateFiles(parser, new JavaScriptGenerator { GeneratorName = nameof(JavaScriptGenerator) }, settings);
/// <summary>
/// Generates JavaScript/TypeScript.
/// </summary>
/// <param name="settings">The settings.</param>
/// <returns>The number of updated files.</returns>
[Obsolete("Use the overload that takes a parser.")]
public static int GenerateJavaScript(JavaScriptGeneratorSettings settings) =>
FileGenerator.GenerateFiles(new JavaScriptGenerator { GeneratorName = nameof(JavaScriptGenerator) }, settings);
/// <summary>
/// The name of the module (optional).
/// </summary>
public string? ModuleName { get; set; }
/// <summary>
/// True to generate TypeScript.
/// </summary>
public bool TypeScript { get; set; }
/// <summary>
/// True to generate Express service.
/// </summary>
public bool Express { get; set; }
/// <summary>
/// True to generate Fastify plugin.
/// </summary>
/// <remarks>
/// When specified, only the server plugin is generated, not the client.
/// </remarks>
public bool Fastify { get; set; }
/// <summary>
/// True to disable ESLint via code comment.
/// </summary>
public bool DisableESLint { get; set; }
/// <summary>
/// Suffix to append to generated file names before the extension.
/// </summary>
public string? FileNameSuffix { get; set; }
/// <summary>
/// Generates the JavaScript/TypeScript output.
/// </summary>
public override CodeGenOutput GenerateOutput(ServiceInfo service)
{
if (Fastify)
return GenerateFastifyPluginOutput(service);
var httpServiceInfo = HttpServiceInfo.Create(service);
var moduleName = ModuleName ?? service.Name;
var capModuleName = CodeGenUtility.Capitalize(moduleName);
var typesFileNameNoExt = CodeGenUtility.Uncapitalize(moduleName) + "Types" + (FileNameSuffix ?? "");
var typesFileName = typesFileNameNoExt + (TypeScript ? ".ts" : ".js");
var clientFileName = CodeGenUtility.Uncapitalize(moduleName) + (FileNameSuffix ?? "") + (TypeScript ? ".ts" : ".js");
var serverFileName = CodeGenUtility.Uncapitalize(moduleName) + "Server" + (FileNameSuffix ?? "") + (TypeScript ? ".ts" : ".js");
var errors = new List<ServiceDefinitionError>();
var namedTexts = new List<CodeGenFile>();
var typeNames = new List<string>();
if (TypeScript)
{
var externImports = new List<(string Name, string Alias, string Module)>();
var externTypes = service.ExternalDtos.Concat<ServiceMemberInfo>(service.ExternalEnums);
foreach (var externalDtoInfo in externTypes)
{
var jsAttribute = externalDtoInfo.TryGetAttribute(c_jsAttributeName);
if (jsAttribute is null)
{
errors.Add(new ServiceDefinitionError($"Missing required attribute '{c_jsAttributeName}'.", externalDtoInfo.Position));
continue;
}
var module = jsAttribute.TryGetParameterValue(c_jsAttributeModuleParameterName);
if (module is null)
{
errors.Add(new ServiceDefinitionError($"Missing required parameter '{c_jsAttributeModuleParameterName}' for attribute '{c_jsAttributeName}'.", jsAttribute.Position));
continue;
}
var alias = externalDtoInfo is ServiceExternalDtoInfo
? $"I{CodeGenUtility.Capitalize(externalDtoInfo.Name)}"
: CodeGenUtility.Capitalize(externalDtoInfo.Name);
var name = jsAttribute.TryGetParameterValue(c_jsAttributeNameParameterName) ?? alias;
externImports.Add((name, alias, module));
}
if (errors.Count > 0)
throw new ServiceDefinitionException(errors);
namedTexts.Add(CreateFile(typesFileName, code =>
{
WriteFileHeader(code);
var allFields = service.Dtos.SelectMany(x => x.Fields).Concat(service.Methods.SelectMany(x => x.RequestFields.Concat(x.ResponseFields))).ToList();
code.WriteLine();
var facilityImports = new List<string>();
if (httpServiceInfo.Methods.Any() || allFields.Any(x => FieldUsesKind(service, x, ServiceTypeKind.Result)))
facilityImports.Add("IServiceResult");
if (allFields.Any(x => FieldUsesKind(service, x, ServiceTypeKind.Error)))
facilityImports.Add("IServiceError");
WriteImports(code, facilityImports, "facility-core");
// Imports for extern data/enum
foreach (var import in externImports.GroupBy(x => x.Module))
WriteImports(code, import.Select(x => $"{x.Name}{(x.Name != x.Alias ? $" as {x.Alias}" : "")}").ToArray(), import.Key);
typeNames.AddRange(WriteTypes(code, httpServiceInfo));
code.WriteLine();
}));
}
namedTexts.Add(CreateFile(clientFileName, code =>
{
WriteFileHeader(code);
if (!TypeScript)
code.WriteLine("'use strict';");
code.WriteLine();
var facilityImports = new List<string> { "HttpClientUtility" };
if (TypeScript)
{
if (httpServiceInfo.Methods.Any())
facilityImports.Add("IServiceResult");
facilityImports.Add("IHttpClientOptions");
}
WriteImports(code, facilityImports, "facility-core");
if (TypeScript)
{
WriteImports(code, typeNames, $"./{typesFileNameNoExt}");
code.WriteLine($"export * from './{typesFileNameNoExt}';");
}
code.WriteLine();
WriteJsDoc(code, $"Provides access to {capModuleName} over HTTP via fetch.");
using (code.Block("export function createHttpClient(options" + IfTypeScript(": IHttpClientOptions") + ")" + IfTypeScript($": I{capModuleName}") + " {", "}"))
code.WriteLine($"return new {capModuleName}HttpClient(options);");
code.WriteLine();
code.WriteLine("const { fetchResponse, createResponseError, createRequiredRequestFieldError } = HttpClientUtility;");
if (TypeScript)
{
code.WriteLine("type IFetch = HttpClientUtility.IFetch;");
code.WriteLine("type IFetchRequest = HttpClientUtility.IFetchRequest;");
}
// TODO: export this from facility-core?
if (httpServiceInfo.Methods.Any(x => x.RequestHeaderFields.Any(y => service.GetFieldType(y.ServiceField)!.Kind == ServiceTypeKind.Boolean)))
{
code.WriteLine();
using (code.Block("function parseBoolean(value" + IfTypeScript(": string | undefined") + ") {", "}"))
{
using (code.Block("if (typeof value === 'string') {", "}"))
{
code.WriteLine("const lowerValue = value.toLowerCase();");
using (code.Block("if (lowerValue === 'true') {", "}"))
code.WriteLine("return true;");
using (code.Block("if (lowerValue === 'false') {", "}"))
code.WriteLine("return false;");
}
code.WriteLine("return undefined;");
}
}
code.WriteLine();
WriteJsDoc(code, $"Provides access to {capModuleName} over HTTP via fetch.");
using (code.Block($"export class {capModuleName}HttpClient" + IfTypeScript($" implements I{capModuleName}") + " {", "}"))
{
using (code.Block("constructor({ fetch, baseUri }" + IfTypeScript(": IHttpClientOptions") + ") {", "}"))
{
using (code.Block("if (typeof fetch !== 'function') {", "}"))
code.WriteLine("throw new TypeError('fetch must be a function.');");
using (code.Block("if (typeof baseUri === 'undefined') {", "}"))
code.WriteLine($"baseUri = '{httpServiceInfo.Url ?? ""}';");
using (code.Block(@"if (/[^\/]$/.test(baseUri)) {", "}"))
code.WriteLine("baseUri += '/';");
code.WriteLine("this._fetch = fetch;");
code.WriteLine("this._baseUri = baseUri;");
}
foreach (var httpMethodInfo in httpServiceInfo.Methods)
{
var methodName = httpMethodInfo.ServiceMethod.Name;
var capMethodName = CodeGenUtility.Capitalize(methodName);
code.WriteLine();
WriteJsDoc(code, httpMethodInfo.ServiceMethod);
using (code.Block(IfTypeScript("public ") + $"{methodName}(request" + IfTypeScript($": I{capMethodName}Request") + ", context" + IfTypeScript("?: unknown") + ")" + IfTypeScript($": Promise<IServiceResult<I{capMethodName}Response>>") + " {", "}"))
{
var hasPathFields = httpMethodInfo.PathFields.Count != 0;
var jsUriDelim = hasPathFields ? "`" : "'";
#if !NETSTANDARD2_0
var jsUri = string.Concat(jsUriDelim, httpMethodInfo.Path.AsSpan(1), jsUriDelim);
#else
var jsUri = jsUriDelim + httpMethodInfo.Path.Substring(1) + jsUriDelim;
#endif
if (hasPathFields)
{
foreach (var httpPathField in httpMethodInfo.PathFields)
{
code.WriteLine($"const uriPart{CodeGenUtility.Capitalize(httpPathField.ServiceField.Name)} = request.{httpPathField.ServiceField.Name} != null && {RenderUriComponent(httpPathField.ServiceField, service)};");
using (code.Block($"if (!uriPart{CodeGenUtility.Capitalize(httpPathField.ServiceField.Name)}) {{", "}"))
code.WriteLine($"return Promise.resolve(createRequiredRequestFieldError('{httpPathField.ServiceField.Name}'));");
}
foreach (var httpPathField in httpMethodInfo.PathFields)
jsUri = ReplaceOrdinal(jsUri, "{" + httpPathField.Name + "}", $"${{uriPart{CodeGenUtility.Capitalize(httpPathField.ServiceField.Name)}}}");
}
var hasQueryFields = httpMethodInfo.QueryFields.Count != 0;
code.WriteLine((hasQueryFields ? "let" : "const") + $" uri = {jsUri};");
if (hasQueryFields)
{
code.WriteLine("const query" + IfTypeScript(": string[]") + " = [];");
foreach (var httpQueryField in httpMethodInfo.QueryFields)
code.WriteLine($"request.{httpQueryField.ServiceField.Name} == null || query.push('{httpQueryField.Name}=' + {RenderUriComponent(httpQueryField.ServiceField, service)});");
using (code.Block("if (query.length) {", "}"))
code.WriteLine("uri = uri + '?' + query.join('&');");
}
if (httpMethodInfo.RequestBodyField != null)
{
using (code.Block($"if (!request.{httpMethodInfo.RequestBodyField.ServiceField.Name}) {{", "}"))
code.WriteLine($"return Promise.resolve(createRequiredRequestFieldError('{httpMethodInfo.RequestBodyField.ServiceField.Name}'));");
}
using (code.Block("const fetchRequest" + IfTypeScript(": IFetchRequest") + " = {", "};"))
{
if (httpMethodInfo.RequestBodyField == null && httpMethodInfo.RequestNormalFields.Count == 0)
{
code.WriteLine($"method: '{httpMethodInfo.Method}',");
if (httpMethodInfo.RequestHeaderFields.Count != 0)
code.WriteLine("headers: {},");
}
else
{
code.WriteLine($"method: '{httpMethodInfo.Method}',");
code.WriteLine("headers: { 'Content-Type': 'application/json' },");
if (httpMethodInfo.RequestBodyField != null)
{
code.WriteLine($"body: JSON.stringify(request.{httpMethodInfo.RequestBodyField.ServiceField.Name})");
}
else if (httpMethodInfo.ServiceMethod.RequestFields.Count == httpMethodInfo.RequestNormalFields.Count)
{
code.WriteLine("body: JSON.stringify(request)");
}
else
{
using (code.Block("body: JSON.stringify({", "})"))
{
for (var httpFieldIndex = 0; httpFieldIndex < httpMethodInfo.RequestNormalFields.Count; httpFieldIndex++)
{
var httpFieldInfo = httpMethodInfo.RequestNormalFields[httpFieldIndex];
var isLastField = httpFieldIndex == httpMethodInfo.RequestNormalFields.Count - 1;
var fieldName = httpFieldInfo.ServiceField.Name;
code.WriteLine(fieldName + ": request." + fieldName + (isLastField ? "" : ","));
}
}
}
}
}
if (httpMethodInfo.RequestHeaderFields.Count != 0)
{
foreach (var httpHeaderField in httpMethodInfo.RequestHeaderFields)
{
using (code.Block($"if (request.{httpHeaderField.ServiceField.Name} != null) {{", "}"))
code.WriteLine("fetchRequest.headers" + IfTypeScript("!") + $"['{httpHeaderField.Name}'] = {RenderFieldValue(httpHeaderField.ServiceField, service, $"request.{httpHeaderField.ServiceField.Name}")};");
}
}
code.WriteLine("return fetchResponse(this._fetch, this._baseUri + uri, fetchRequest, context)");
using (code.Indent())
using (code.Block(".then(result => {", "});"))
{
code.WriteLine("const status = result.response.status;");
var responseValueType = $"I{capMethodName}Response";
code.WriteLine("let value" + IfTypeScript($": {responseValueType} | null") + " = null;");
var validResponses = httpMethodInfo.ValidResponses;
var elsePrefix = "";
foreach (var validResponse in validResponses)
{
var statusCodeAsString = ((int) validResponse.StatusCode).ToString(CultureInfo.InvariantCulture);
code.WriteLine($"{elsePrefix}if (status === {statusCodeAsString}) {{");
elsePrefix = "else ";
using (code.Indent())
{
var bodyField = validResponse.BodyField;
if (bodyField != null)
{
var responseBodyFieldName = bodyField.ServiceField.Name;
var bodyFieldType = service.GetFieldType(bodyField.ServiceField)!;
if (bodyFieldType.Kind == ServiceTypeKind.Boolean)
{
code.WriteLine($"value = {{ {responseBodyFieldName}: true }};");
}
else
{
using (code.Block("if (result.json) {", "}"))
{
code.WriteLine($"value = {{ {responseBodyFieldName}: result.json }}" + IfTypeScript($" as {responseValueType}") + ";");
}
}
}
else
{
if (validResponse.NormalFields!.Count == 0)
{
code.WriteLine("value = {};");
}
else
{
using (code.Block("if (result.json) {", "}"))
{
code.WriteLine("value = result.json" + IfTypeScript($" as {responseValueType} | null") + ";");
}
}
}
}
code.WriteLine("}");
}
using (code.Block("if (!value) {", "}"))
code.WriteLine("return createResponseError(status, result.json)" + IfTypeScript($" as IServiceResult<I{capMethodName}Response>") + ";");
if (httpMethodInfo.ResponseHeaderFields.Count != 0)
{
code.WriteLine("let headerValue" + IfTypeScript(": string | null | undefined") + ";");
foreach (var httpHeaderField in httpMethodInfo.ResponseHeaderFields)
{
code.WriteLine($"headerValue = result.response.headers.get('{httpHeaderField.Name}');");
using (code.Block("if (headerValue != null) {", "}"))
code.WriteLine($"value.{httpHeaderField.ServiceField.Name} = {ParseFieldValue(httpHeaderField.ServiceField, service, "headerValue")};");
}
}
code.WriteLine("return { value: value };");
}
}
}
if (TypeScript)
{
code.WriteLine();
code.WriteLine("private _fetch: IFetch;");
code.WriteLine("private _baseUri: string;");
}
}
}));
if (Express)
{
namedTexts.Add(CreateFile(serverFileName, code =>
{
WriteFileHeader(code);
if (!TypeScript)
code.WriteLine("'use strict';");
code.WriteLine();
code.WriteLine("import * as bodyParser from 'body-parser';");
code.WriteLine("import * as express from 'express';");
var facilityImports = new List<string>();
if (TypeScript)
facilityImports.Add("IServiceResult");
WriteImports(code, facilityImports, "facility-core");
if (TypeScript)
{
WriteImports(code, typeNames, $"./{typesFileNameNoExt}");
code.WriteLine($"export * from './{typesFileNameNoExt}';");
}
code.WriteLine();
WriteStandardErrorCodesVariable("standardErrorCodes", code, httpServiceInfo.ErrorSets);
code.WriteLine();
WriteParseBooleanFunction("parseBoolean", code);
code.WriteLine();
using (code.Block("export function createApp(service" + IfTypeScript($": I{capModuleName}") + ")" + IfTypeScript(": express.Application") + " {", "}"))
{
code.WriteLine("const app = express();");
code.WriteLine("app.use(bodyParser.json());");
code.WriteLine("app.use(bodyParser.urlencoded({ extended: true }));");
foreach (var httpMethodInfo in httpServiceInfo.Methods)
{
var methodName = httpMethodInfo.ServiceMethod.Name;
var capMethodName = CodeGenUtility.Capitalize(methodName);
var expressMethod = httpMethodInfo.Method.ToLowerInvariant();
var expressPath = httpMethodInfo.Path;
foreach (var httpPathField in httpMethodInfo.PathFields)
expressPath = ReplaceOrdinal(expressPath, "{" + httpPathField.Name + "}", $":{httpPathField.Name}");
code.WriteLine();
WriteJsDoc(code, httpMethodInfo.ServiceMethod);
using (code.Block($"app.{expressMethod}('{expressPath}', function (req, res, next) {{", "});"))
{
code.WriteLine("const request" + IfTypeScript($": I{capMethodName}Request") + " = {};");
foreach (var httpPathField in httpMethodInfo.PathFields)
code.WriteLine($"request.{httpPathField.ServiceField.Name} = {ParseFieldValue(httpPathField.ServiceField, service, $"req.params.{httpPathField.Name}")};");
foreach (var httpQueryField in httpMethodInfo.QueryFields)
{
using (code.Block($"if (typeof req.query['{httpQueryField.Name}'] === 'string') {{", "}"))
code.WriteLine($"request.{httpQueryField.ServiceField.Name} = {ParseFieldValue(httpQueryField.ServiceField, service, $"req.query['{httpQueryField.Name}']")};");
}
if (httpMethodInfo.RequestBodyField != null)
{
code.WriteLine($"request.{httpMethodInfo.RequestBodyField.ServiceField.Name} = req.body;");
}
else
{
foreach (var field in httpMethodInfo.RequestNormalFields)
code.WriteLine($"request.{field.ServiceField.Name} = req.body.{field.ServiceField.Name};");
}
foreach (var field in httpMethodInfo.RequestHeaderFields)
code.WriteLine($"request.{field.ServiceField.Name} = req.header('{field.Name}');");
code.WriteLine();
code.WriteLine($"return service.{methodName}(request)");
using (code.Indent())
{
using (code.Block(".then(result => {", "})"))
{
using (code.Block("if (result.error) {", "}"))
{
code.WriteLine("const status = result.error.code && standardErrorCodes[result.error.code] || 500;");
code.WriteLine("res.status(status).send(result.error);");
code.WriteLine("return;");
}
using (code.Block("if (result.value) {", "}"))
{
foreach (var field in httpMethodInfo.ResponseHeaderFields)
{
using (code.Block($"if (result.value.{field.ServiceField.Name} != null) {{", "}"))
code.WriteLine($"res.setHeader('{field.Name}', result.value.{field.ServiceField.Name});");
}
foreach (var validResponse in httpMethodInfo.ValidResponses.Where(x => x.NormalFields == null || x.NormalFields.Count == 0))
{
var bodyField = validResponse.BodyField;
if (bodyField != null)
{
var responseBodyFieldName = bodyField.ServiceField.Name;
using (code.Block($"if (result.value.{responseBodyFieldName}) {{", "}"))
{
var bodyFieldType = service.GetFieldType(bodyField.ServiceField)!;
if (bodyFieldType.Kind == ServiceTypeKind.Boolean)
{
code.WriteLine($"res.sendStatus({(int) validResponse.StatusCode});");
code.WriteLine("return;");
}
else
{
code.WriteLine($"res.status({(int) validResponse.StatusCode}).send(result.value.{responseBodyFieldName});");
code.WriteLine("return;");
}
}
}
else
{
if (validResponse.NormalFields!.Count == 0)
{
code.WriteLine($"res.sendStatus({(int) validResponse.StatusCode});");
code.WriteLine("return;");
}
}
}
foreach (var validResponse in httpMethodInfo.ValidResponses.Where(x => x.NormalFields != null && x.NormalFields.Count != 0))
{
code.WriteLine($"res.status({(int) validResponse.StatusCode}).send({{");
using (code.Indent())
{
foreach (var field in validResponse.NormalFields!)
{
code.WriteLine($"{field.ServiceField.Name}: result.value.{field.ServiceField.Name},");
}
}
code.WriteLine("});");
code.WriteLine("return;");
}
}
code.WriteLine("throw new Error('Result must have an error or value.');");
}
code.WriteLine(".catch(next);");
}
}
}
code.WriteLine();
code.WriteLine("return app;");
}
}));
}
return new CodeGenOutput(namedTexts, new List<CodeGenPattern>());
}
/// <summary>
/// Applies generator-specific settings.
/// </summary>
public override void ApplySettings(FileGeneratorSettings settings)
{
var ourSettings = (JavaScriptGeneratorSettings) settings;
ModuleName = ourSettings.ModuleName;
TypeScript = ourSettings.TypeScript;
Express = ourSettings.Express;
Fastify = ourSettings.Fastify;
DisableESLint = ourSettings.DisableESLint;
FileNameSuffix = ourSettings.FileNameSuffix;
}
/// <summary>
/// Supports writing output to a single file.
/// </summary>
public override bool SupportsSingleOutput => true;
private CodeGenOutput GenerateFastifyPluginOutput(ServiceInfo service)
{
var httpServiceInfo = HttpServiceInfo.Create(service);
var moduleName = ModuleName ?? service.Name;
var capModuleName = CodeGenUtility.Capitalize(moduleName);
var camelCaseModuleName = CodeGenUtility.ToCamelCase(moduleName);
var pluginFileName = CodeGenUtility.Uncapitalize(moduleName) + "Plugin" + (TypeScript ? ".ts" : ".js");
var customTypes = new HashSet<string>(service.Dtos.Select(x => x.Name).Concat(service.Enums.Select(x => x.Name)));
var file = CreateFile(pluginFileName, code =>
{
WriteFileHeader(code);
if (TypeScript)
{
code.WriteLine();
code.WriteLine("import type * as fastifyTypes from 'fastify';");
code.WriteLine("import type { IServiceResult, IServiceError } from 'facility-core';");
code.WriteLine();
using (code.Block($"export type {capModuleName}PluginOptions = fastifyTypes.RegisterOptions & {{", "}"))
{
WriteJsDoc(code, $"The `I{capModuleName}` service implementation. Can be a service instance or a factory function which is called on each request.");
code.WriteLine($"serviceOrFactory: I{capModuleName} | ((req: fastifyTypes.FastifyRequest) => I{capModuleName});");
code.WriteLine();
WriteJsDoc(code, "Whether to make query string keys case insensitive. Defalts to false.");
code.WriteLine("caseInsenstiveQueryStringKeys?: boolean;");
code.WriteLine();
WriteJsDoc(code, "Whether to include error details in the response. Defaults to false.");
code.WriteLine("includeErrorDetails?: boolean;");
}
}
else
{
code.WriteLine("'use strict';");
}
code.WriteLine();
WriteJsDoc(code, "EXPERIMENTAL: The generated code for this plugin is subject to change/removal without a major version bump.");
using (code.Block($"export const {camelCaseModuleName}Plugin" + IfTypeScript($": fastifyTypes.FastifyPluginAsync<{capModuleName}PluginOptions>") + " = async (fastify, opts) => {", "}"))
{
code.WriteLine("const { serviceOrFactory, caseInsenstiveQueryStringKeys, includeErrorDetails } = opts;");
code.WriteLine();
code.WriteLine("const getService = typeof serviceOrFactory === 'function' ? serviceOrFactory : () => serviceOrFactory;");
code.WriteLine();
using (code.Block("for (const jsonSchema of jsonSchemas) {", "}"))
code.WriteLine("fastify.addSchema(jsonSchema);");
code.WriteLine();
using (code.Block("fastify.setErrorHandler((error, req, res) => {", "});"))
{
code.WriteLine("req.log.error(error);");
using (code.Block("if (includeErrorDetails) {", "}"))
{
code.WriteLine("res.status(500).send({");
using (code.Indent())
{
code.WriteLine("code: 'InternalError',");
code.WriteLine("message: error.message,");
using (code.Block("details: {", "}"))
{
code.WriteLine("stack: error.stack?.split('\\n').filter((x) => x.length > 0),");
}
}
code.WriteLine("});");
}
using (code.Block("else {", "}"))
{
code.WriteLine("res.status(500).send({");
using (code.Indent())
{
code.WriteLine("code: 'InternalError',");
code.WriteLine("message: 'The service experienced an unexpected internal error.',");
}
code.WriteLine("});");
}
}
code.WriteLine();
using (code.Block("if (caseInsenstiveQueryStringKeys) {", "}"))
{
using (code.Block("fastify.addHook('onRequest', async (req, res) => {", "});"))
{
code.WriteLine($"const query = req.query{IfTypeScript(" as Record<string, string>")};");
using (code.Block("for (const key of Object.keys(query)) {", "}"))
{
code.WriteLine("const lowerKey = key.toLowerCase();");
using (code.Block("if (lowerKey !== key) {", "}"))
{
code.WriteLine($"query[lowerKey] = query[key]{IfTypeScript(" as string")};");
code.WriteLine("delete query[key];");
}
}
}
}
foreach (var httpMethodInfo in httpServiceInfo.Methods)
{
var methodName = httpMethodInfo.ServiceMethod.Name;
var capMethodName = CodeGenUtility.Capitalize(methodName);
var fastifyPath = httpMethodInfo.Path;
foreach (var httpPathField in httpMethodInfo.PathFields)
fastifyPath = ReplaceOrdinal(fastifyPath, "{" + httpPathField.Name + "}", $":{httpPathField.Name}");
code.WriteLine();
using (code.Block("fastify.route({", "});"))
{
code.WriteLine($"url: '{fastifyPath}',");
code.WriteLine($"method: '{httpMethodInfo.Method.ToUpperInvariant()}',");
using (code.Block("schema: {", "},"))
{
using (code.Block("response: {", "},"))
{
foreach (var response in httpMethodInfo.ValidResponses)
{
var statusCode = (int) response.StatusCode;
code.Write($"{statusCode}: ");
if (response.BodyField is not null)
{
code.WriteLine($"{GetJsonSchemaType(service.GetFieldType(response.BodyField.ServiceField)!)},");
}
else if (response.NormalFields?.Count > 0)
{
using (code.Block("{", "},"))
{
code.WriteLine("type: 'object',");
using (code.Block("properties: {", "},"))
{
foreach (var normalField in response.NormalFields)
code.WriteLine($"{normalField.ServiceField.Name}: {GetJsonSchemaType(service.GetFieldType(normalField.ServiceField)!)},");
}
}
}
else
{
code.WriteLine("{ type: 'object', additionalProperties: false },");
}
}
}
}
using (code.Block("handler: async function (req, res) {", "}"))
{
code.WriteLine("const request" + IfTypeScript($": Partial<I{capMethodName}Request>") + " = {};");
if (httpMethodInfo.PathFields.Count != 0)
{
code.WriteLine();
code.WriteLine($"const params = req.params{IfTypeScript(" as Record<string, string>")};");
foreach (var pathParam in httpMethodInfo.PathFields)
{
code.WriteLine($"if (typeof params['{pathParam.Name}'] === 'string') request.{pathParam.ServiceField.Name} = {ParseFieldValue(pathParam.ServiceField, service, $"params['{pathParam.Name}']")};");
}
}
if (httpMethodInfo.QueryFields.Count != 0)
{
code.WriteLine();
code.WriteLine($"const query = req.query{IfTypeScript(" as Record<string, string>")};");
foreach (var queryParam in httpMethodInfo.QueryFields)
{
code.WriteLine($"if (typeof query['{queryParam.Name}'] === 'string') request.{queryParam.ServiceField.Name} = {ParseFieldValue(queryParam.ServiceField, service, $"query['{queryParam.Name}']")};");
}
}
if (httpMethodInfo.RequestHeaderFields.Count != 0)
{
code.WriteLine();
code.WriteLine($"const headers = req.headers{IfTypeScript(" as Record<string, string>")};");
foreach (var header in httpMethodInfo.RequestHeaderFields)
{
string lowerHeaderName = header.Name.ToLowerInvariant();
code.WriteLine($"if (typeof headers['{lowerHeaderName}'] === 'string') request.{header.ServiceField.Name} = {ParseFieldValue(header.ServiceField, service, $"headers['{lowerHeaderName}']")};");
}
}
if (httpMethodInfo.RequestBodyField != null)
{
code.WriteLine();
code.WriteLine($"request.{httpMethodInfo.RequestBodyField.ServiceField.Name} = req.body{IfTypeScript(" as never")};");
}
else if (httpMethodInfo.RequestNormalFields.Count != 0)
{
code.WriteLine();
code.WriteLine($"const body = req.body{IfTypeScript(" as Record<string, never>")};");
foreach (var field in httpMethodInfo.RequestNormalFields)
code.WriteLine($"request.{field.ServiceField.Name} = body.{field.ServiceField.Name};");
}
code.WriteLine();
code.WriteLine($"const result = await getService(req).{methodName}(request{IfTypeScript($" as I{capMethodName}Request")});");
code.WriteLine();
using (code.Block("if (result.error) {", "}"))
{
code.WriteLine("const status = result.error.code && standardErrorCodes[result.error.code];");
code.WriteLine("res.status(status || 500).send(result.error);");
code.WriteLine("return;");
}
code.WriteLine();
using (code.Block("if (result.value) {", "}"))
{
if (httpMethodInfo.ResponseHeaderFields.Count != 0)
{
code.WriteLineSkipOnce();
foreach (var field in httpMethodInfo.ResponseHeaderFields)
code.WriteLine($"if (result.value.{field.ServiceField.Name} != null) res.header('{field.Name}', result.value.{field.ServiceField.Name});");
}
var handledResponses = httpMethodInfo.ValidResponses.ToList();
foreach (var validResponse in httpMethodInfo.ValidResponses.Where(x => x.BodyField is not null))
{
handledResponses.Remove(validResponse);
var bodyField = validResponse.BodyField!;
var statusCode = (int) validResponse.StatusCode;
code.WriteLineSkipOnce();
using (code.Block($"if (result.value.{bodyField.ServiceField.Name}) {{", "}"))
{
var bodyFieldType = service.GetFieldType(bodyField.ServiceField)!;
if (bodyFieldType.Kind == ServiceTypeKind.Boolean)
{
code.WriteLine($"res.status({statusCode});");
code.WriteLine("return;");
}
else
{
code.WriteLine($"res.status({statusCode}).send(result.value.{bodyField.ServiceField.Name});");
code.WriteLine("return;");
}
}
}
if (handledResponses.Count == 1)
{
var lastValidResponse = handledResponses[0];
var statusCode = (int) lastValidResponse.StatusCode;
if (lastValidResponse.NormalFields?.Count > 0)
{
code.WriteLineSkipOnce();
code.WriteLine($"res.status({statusCode}).send(result.value);");
}
else
{
code.WriteLineSkipOnce();
code.WriteLine($"res.status({statusCode});");
}
code.WriteLine("return;");
}
else if (handledResponses.Count > 1)
{
throw new InvalidOperationException("More than one response is left.");
}
}
code.WriteLine();
code.WriteLine("throw new Error('Result must have an error or value.');");
}
}
}
}
WriteJsonSchemaDtos(code, service);
code.WriteLine();
WriteStandardErrorCodesVariable("standardErrorCodes", code, httpServiceInfo.ErrorSets);
code.WriteLine();
WriteParseBooleanFunction("parseBoolean", code);
if (TypeScript)
WriteTypes(code, httpServiceInfo);
});
return new CodeGenOutput(file);
string GetJsonSchemaType(ServiceTypeInfo serviceType) => serviceType.Kind switch
{
ServiceTypeKind.String or ServiceTypeKind.Bytes or ServiceTypeKind.DateTime or ServiceTypeKind.ExternalEnum => "{ type: 'string' }",
ServiceTypeKind.Boolean => "{ type: 'boolean' }",
ServiceTypeKind.Float or ServiceTypeKind.Double or ServiceTypeKind.Decimal => "{ type: 'number' }",
ServiceTypeKind.Int32 or ServiceTypeKind.Int64 => "{ type: 'integer' }",
ServiceTypeKind.Object or ServiceTypeKind.ExternalDto => "{ type: 'object', additionalProperties: true }",
ServiceTypeKind.Error => "{ $ref: '_error' }",
ServiceTypeKind.Dto => $"{{ $ref: '{serviceType.Dto!.Name}' }}",
ServiceTypeKind.Enum => $"{{ $ref: '{serviceType.Enum!.Name}' }}",
ServiceTypeKind.Result => $"{{ type: 'object', properties: {{ value: {GetJsonSchemaType(serviceType.ValueType!)}, error: {{ $ref: '_error' }} }} }}",
ServiceTypeKind.Array => $"{{ type: 'array', items: {GetJsonSchemaType(serviceType.ValueType!)} }}",
ServiceTypeKind.Map => $"{{ type: 'object', additionalProperties: {GetJsonSchemaType(serviceType.ValueType!)} }}",
ServiceTypeKind.Nullable => $"{{ oneOf: [ {GetJsonSchemaType(serviceType.ValueType!)}, {{ type: 'null' }} ] }}",
_ => throw new NotSupportedException($"Unknown field type '{serviceType.Kind}'"),
};
void WriteJsonSchemaDtos(CodeWriter code, ServiceInfo service)
{
code.WriteLine();
using (code.Block("const jsonSchemas = [", $"]{IfTypeScript(" as const")};"))
{
using (code.Block("{", $"}}{IfTypeScript(" as const")},"))
{
code.WriteLine("$id: '_error',");
code.WriteLine("type: 'object',");
using (code.Block("properties: {", "}"))
{
code.WriteLine("code: { type: 'string' },");
code.WriteLine("message: { type: 'string' },");
code.WriteLine("details: { type: 'object', additionalProperties: true },");
code.WriteLine("innerError: { $ref: '_error' },");
}
}
foreach (var dto in service.Dtos)
{
using (code.Block("{", $"}}{IfTypeScript(" as const")},"))
{
code.WriteLine($"$id: '{dto.Name}',");
code.WriteLine("type: 'object',");
using (code.Block("properties: {", "}"))
{
foreach (var field in dto.Fields)
code.WriteLine($"{field.Name}: {GetJsonSchemaType(service.GetFieldType(field)!)},");
}
}
}
foreach (var enumInfo in service.Enums)
{
using (code.Block("{", $"}}{IfTypeScript(" as const")},"))
{
code.WriteLine($"$id: '{enumInfo.Name}',");
code.WriteLine("type: 'string',");
code.Write("enum: [ ");
var shouldWriteComma = false;
foreach (var enumValue in enumInfo.Values)
{
if (shouldWriteComma)
code.Write(", ");
else
shouldWriteComma = true;
code.Write($"'{enumValue.Name}'");
}
code.WriteLine(" ],");
}
}
}
}
}
private void WriteFileHeader(CodeWriter code)
{
code.WriteLine($"// DO NOT EDIT: generated by {GeneratorName}");
if (DisableESLint)
code.WriteLine("/* eslint-disable */");
}
private static void WriteDto(CodeWriter code, ServiceDtoInfo dtoInfo, ServiceInfo service)
{
code.WriteLine();
WriteJsDoc(code, dtoInfo);
using (code.Block($"export interface I{CodeGenUtility.Capitalize(dtoInfo.Name)} {{", "}"))
{
foreach (var fieldInfo in dtoInfo.Fields)
{
code.WriteLineSkipOnce();
WriteJsDoc(code, fieldInfo);
code.WriteLine($"{fieldInfo.Name}{(fieldInfo.IsRequired ? "" : "?")}: {RenderFieldType(service.GetFieldType(fieldInfo)!)};");
}
}
}
private string IfTypeScript(string value) => TypeScript ? value : "";
private static string RenderFieldType(ServiceTypeInfo fieldType)
{
switch (fieldType.Kind)
{
case ServiceTypeKind.String:
case ServiceTypeKind.Bytes:
case ServiceTypeKind.DateTime:
return "string";
case ServiceTypeKind.Enum:
return fieldType.Enum!.Name;
case ServiceTypeKind.ExternalEnum:
return fieldType.ExternalEnum!.Name;
case ServiceTypeKind.Boolean:
return "boolean";
case ServiceTypeKind.Float:
case ServiceTypeKind.Double:
case ServiceTypeKind.Int32:
case ServiceTypeKind.Int64:
case ServiceTypeKind.Decimal:
return "number";
case ServiceTypeKind.Object:
return "{ [name: string]: any }";
case ServiceTypeKind.Error:
return "IServiceError";
case ServiceTypeKind.Dto:
return $"I{CodeGenUtility.Capitalize(fieldType.Dto!.Name)}";
case ServiceTypeKind.ExternalDto:
return $"I{CodeGenUtility.Capitalize(fieldType.ExternalDto!.Name)}";
case ServiceTypeKind.Result:
return $"IServiceResult<{RenderFieldType(fieldType.ValueType!)}>";
case ServiceTypeKind.Array:
return $"{RenderFieldType(fieldType.ValueType!)}[]";
case ServiceTypeKind.Map:
return $"{{ [name: string]: {RenderFieldType(fieldType.ValueType!)} }}";
case ServiceTypeKind.Nullable:
return $"({RenderFieldType(fieldType.ValueType!)} | null)";
default:
throw new NotSupportedException("Unknown field type " + fieldType.Kind);
}
}
private static string RenderUriComponent(ServiceFieldInfo field, ServiceInfo service)
{
var fieldTypeKind = service.GetFieldType(field)!.Kind;
var fieldName = field.Name;
switch (fieldTypeKind)
{
case ServiceTypeKind.Enum:
case ServiceTypeKind.ExternalEnum:
return $"request.{fieldName}";
case ServiceTypeKind.String:
case ServiceTypeKind.Bytes:
case ServiceTypeKind.DateTime:
return $"encodeURIComponent(request.{fieldName})";
case ServiceTypeKind.Boolean:
case ServiceTypeKind.Int32:
case ServiceTypeKind.Int64:
case ServiceTypeKind.Decimal:
return $"request.{fieldName}.toString()";
case ServiceTypeKind.Float:
case ServiceTypeKind.Double:
return $"encodeURIComponent(request.{fieldName}.toString())";