-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathOperationVisitor.cs
More file actions
252 lines (230 loc) · 11.1 KB
/
OperationVisitor.cs
File metadata and controls
252 lines (230 loc) · 11.1 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
using Json.Pointer;
using DarkPatterns.OpenApi.Transformations;
using DarkPatterns.OpenApi.Abstractions;
using DarkPatterns.Json.Specifications;
using DarkPatterns.Json.Specifications.Keywords.Draft2020_12Applicator;
using DarkPatterns.Json.Specifications.Keywords.Draft2020_12Validation;
using System;
using System.Collections.Generic;
using System.Linq;
using DarkPatterns.OpenApiCodegen.CSharp.Client.Templates;
using DarkPatterns.OpenApi.CSharp;
using DarkPatterns.Json.Documents;
namespace DarkPatterns.OpenApiCodegen.CSharp.Client;
class OperationVisitor(ISchemaRegistry schemaRegistry, CSharpSchemaOptions options, string controllerClassName) : OpenApiDocumentVisitor<OperationVisitor.Argument>
{
private readonly CSharpInlineSchemas inlineSchemas = new(options, schemaRegistry.DocumentRegistry);
public record Argument(
OpenApiTransformDiagnostic Diagnostic,
RegisterControllerOperation RegisterControllerOperation,
OperationBuilder? Builder = null,
OpenApiPath? CurrentPath = null,
OpenApiOperation? CurrentOperation = null
);
public delegate void RegisterControllerOperation(Operation operation);
public class OperationBuilder
{
public OperationBuilder(OpenApiOperation operation)
{
Operation = operation;
}
public List<Func<OperationParameter[], OperationRequestBody>> RequestBodies { get; } = new();
public OperationResponse? DefaultResponse { get; set; }
public Dictionary<int, OperationResponse> StatusResponses { get; } = new();
public List<OperationSecurityRequirement> SecurityRequirements { get; } = new();
public List<OperationParameter> SharedParameters { get; } = new();
public OpenApiOperation Operation { get; }
}
public override void VisitWebhook(OpenApiPath value, string key, Argument? argument)
{
}
public override void Visit(OpenApiPath path, Argument argument)
{
base.Visit(path, argument with { CurrentPath = path });
}
public override void Visit(OpenApiOperation operation, string httpMethod, Argument argument)
{
if (argument.CurrentPath is not OpenApiPath pathObj)
throw new ArgumentException("Could not find path in argument; be sure to visit a whole OpenAPI doc", nameof(argument));
var path = JsonPointer.Parse(pathObj.Id.Fragment).Segments.Last().Value;
if (path == null)
throw new ArgumentException("Context is not initialized properly - key expected for path items", nameof(argument));
var builder = new OperationBuilder(operation);
var operationId = operation.OperationId ?? httpMethod + path;
var noBody = OperationRequestBodyFactory(operationId, null, Enumerable.Empty<OperationParameter>(), false);
if (operation.RequestBody == null || !operation.RequestBody.Required)
builder.RequestBodies.Add(noBody);
base.Visit(operation, httpMethod, argument with { Builder = builder, CurrentOperation = operation });
var sharedParameters = builder.SharedParameters.ToArray();
var requestBodies = builder.RequestBodies.DefaultIfEmpty(noBody).Select(transform => transform(sharedParameters))
.Where(body => body.RequestBodyType != "application/xml") // exclude xml, since we don't support it
.ToArray();
if (requestBodies.Length > 0)
{
argument.RegisterControllerOperation(
new Operation(
HttpMethod: CSharpNaming.ToTitleCaseIdentifier(httpMethod, []),
Summary: operation.Summary,
Description: operation.Description,
Name: CSharpNaming.ToTitleCaseIdentifier(operationId, options.ReservedIdentifiers("ControllerBase", controllerClassName)),
Path: path,
RequestBodies: requestBodies,
HasQueryStringEmbedded: path.Contains("?"),
Responses: new OperationResponses(
DefaultResponse: builder.DefaultResponse,
StatusResponse: new(builder.StatusResponses)
),
SecurityRequirements: builder.SecurityRequirements.ToArray()
));
}
}
public override void Visit(OpenApiParameter param, Argument argument)
{
var info = param.Schema?.ResolveSchemaInfo();
var dataType = inlineSchemas.SafeToInlineDataType(param.Schema, argument.Diagnostic) ?? CSharpInlineSchemas.AnyObject;
argument.Builder?.SharedParameters.Add(new OperationParameter(
RawName: param.Name,
ParamName: CSharpNaming.ToParameterName(param.Name, options.ReservedIdentifiers()),
Description: param.Description,
DataType: dataType.Text,
DataTypeNullable: dataType.Nullable,
DataTypeEnumerable: dataType.IsEnumerable,
IsPathParam: param.In == ParameterLocation.Path,
IsQueryParam: param.In == ParameterLocation.Query,
IsHeaderParam: param.In == ParameterLocation.Header,
IsCookieParam: param.In == ParameterLocation.Cookie,
IsBodyParam: false,
IsFormParam: false,
Required: param.Required,
Pattern: info?.TryGetAnnotation<PatternKeyword>()?.Pattern,
MinLength: info?.TryGetAnnotation<MinLengthKeyword>()?.Value,
MaxLength: info?.TryGetAnnotation<MaxLengthKeyword>()?.Value,
Minimum: info?.TryGetAnnotation<MinimumKeyword>()?.Value,
Maximum: info?.TryGetAnnotation<MaximumKeyword>()?.Value
));
}
public override void Visit(OpenApiResponse response, int? statusCode, Argument argument)
{
string statusCodeName;
if (!statusCode.HasValue)
statusCodeName = "other status code";
else if (!HttpStatusCodes.StatusCodeNames.TryGetValue(statusCode.Value, out statusCodeName))
statusCodeName = $"status code {statusCode}";
if (argument.Builder?.Operation is not OpenApiOperation op)
throw new ArgumentException("Could not find operation in argument; be sure to visit a whole OpenAPI doc", nameof(argument));
var content = response.Content;
var contentCount = content?.Count ?? 0;
var result = new OperationResponse(
Description: response.Description,
Content: (from entry in (from c in content ?? Enumerable.Empty<KeyValuePair<string, OpenApiMediaTypeObject>>()
select (c.Key, c.Value.Schema)).DefaultIfEmpty((Key: "", Schema: null))
let dataType = entry.Schema != null ? inlineSchemas.SafeToInlineDataType(entry.Schema, argument.Diagnostic) : null
where entry.Key != "application/xml" // exclude xml, since we don't support it
select new OperationResponseContentOption(
MediaType: entry.Key,
ResponseMethodName: CSharpNaming.ToTitleCaseIdentifier($"{(contentCount > 1 ? entry.Key : "")} {statusCodeName}", options.ReservedIdentifiers()),
DataType: dataType?.Text
)).ToArray(),
Headers: (from entry in response.Headers
let required = entry.Required
let info = entry.Schema?.ResolveSchemaInfo()
let dataType = inlineSchemas.SafeToInlineDataType(entry.Schema, argument.Diagnostic)
select new OperationResponseHeader(
RawName: entry.Name,
ParamName: CSharpNaming.ToParameterName("header " + entry.Name, options.ReservedIdentifiers()),
Description: entry.Description,
DataType: dataType.Text,
DataTypeNullable: dataType.Nullable,
Required: entry.Required,
Pattern: info?.TryGetAnnotation<PatternKeyword>()?.Pattern,
MinLength: info?.TryGetAnnotation<MinLengthKeyword>()?.Value,
MaxLength: info?.TryGetAnnotation<MaxLengthKeyword>()?.Value,
Minimum: info?.TryGetAnnotation<MinimumKeyword>()?.Value,
Maximum: info?.TryGetAnnotation<MaximumKeyword>()?.Value
)).ToArray()
);
if (statusCode.HasValue)
argument.Builder.StatusResponses.Add(statusCode.Value, result);
else
argument.Builder.DefaultResponse = result;
}
//public override void Visit(OpenApiRequestBody requestBody, Argument argument)
//{
//}
public override void Visit(OpenApiMediaTypeObject mediaType, Argument argument)
{
// All media type visitations should be for request bodies
var mimeType = mediaType.GetLastContextPart();
var isForm = mimeType == "application/x-www-form-urlencoded";
var singleContentType = argument.Builder?.Operation.RequestBody?.Content?.Count is not > 1;
var mediaTypeSchemaInfo = mediaType.Schema?.ResolveSchemaInfo();
argument.Builder?.RequestBodies.Add(OperationRequestBodyFactory(argument.Builder?.Operation.OperationId + (singleContentType ? "" : mimeType), mimeType, isForm ? GetFormParams() : GetStandardParams(), isForm));
IEnumerable<OperationParameter> GetFormParams() =>
from param in mediaTypeSchemaInfo?.TryGetAnnotation<PropertiesKeyword>()?.Properties
let required = mediaTypeSchemaInfo?.TryGetAnnotation<RequiredKeyword>()?.RequiredProperties.Contains(param.Key) ?? false
let info = param.Value?.ResolveSchemaInfo()
let dataType = inlineSchemas.SafeToInlineDataType(param.Value, argument.Diagnostic)
select new OperationParameter(
RawName: param.Key,
ParamName: CSharpNaming.ToParameterName(param.Key, options.ReservedIdentifiers()),
Description: null,
DataType: dataType.Text,
DataTypeNullable: dataType.Nullable,
DataTypeEnumerable: dataType.IsEnumerable,
IsPathParam: false,
IsQueryParam: false,
IsHeaderParam: false,
IsCookieParam: false,
IsBodyParam: false,
IsFormParam: true,
Required: required,
Pattern: info?.TryGetAnnotation<PatternKeyword>()?.Pattern,
MinLength: info?.TryGetAnnotation<MinLengthKeyword>()?.Value,
MaxLength: info?.TryGetAnnotation<MaxLengthKeyword>()?.Value,
Minimum: info?.TryGetAnnotation<MinimumKeyword>()?.Value,
Maximum: info?.TryGetAnnotation<MaximumKeyword>()?.Value
);
IEnumerable<OperationParameter> GetStandardParams() =>
from ct in new[] { mediaType }
let info = ct.Schema?.ResolveSchemaInfo()
let dataType = inlineSchemas.SafeToInlineDataType(ct.Schema, argument.Diagnostic)
select new OperationParameter(
RawName: null,
ParamName: CSharpNaming.ToParameterName(argument.Builder?.Operation.OperationId + " body", options.ReservedIdentifiers()),
Description: null,
DataType: dataType.Text,
DataTypeNullable: dataType.Nullable,
DataTypeEnumerable: dataType.IsEnumerable,
IsPathParam: false,
IsQueryParam: false,
IsHeaderParam: false,
IsCookieParam: false,
IsBodyParam: true,
IsFormParam: false,
Required: true,
Pattern: info?.TryGetAnnotation<PatternKeyword>()?.Pattern,
MinLength: info?.TryGetAnnotation<MinLengthKeyword>()?.Value,
MaxLength: info?.TryGetAnnotation<MaxLengthKeyword>()?.Value,
Minimum: info?.TryGetAnnotation<MinimumKeyword>()?.Value,
Maximum: info?.TryGetAnnotation<MaximumKeyword>()?.Value
);
}
private Func<OperationParameter[], OperationRequestBody> OperationRequestBodyFactory(string operationName, string? requestBodyMimeType, IEnumerable<OperationParameter> parameters, bool isForm)
{
return sharedParams => new OperationRequestBody(
Name: CSharpNaming.ToTitleCaseIdentifier(operationName, options.ReservedIdentifiers()),
IsForm: isForm,
IsFile: parameters.Any(t => t.IsFile),
HasQueryParam: sharedParams.Concat(parameters).Any(p => p.IsQueryParam),
RequestBodyType: requestBodyMimeType,
AllParams: sharedParams.Concat(parameters)
);
}
public override void Visit(OpenApiSecurityRequirement securityRequirement, Argument argument)
{
argument.Builder?.SecurityRequirements.Add(new OperationSecurityRequirement(
(from scheme in securityRequirement.SchemeRequirements
select new OperationSecuritySchemeRequirement(scheme.SchemeName, scheme.ScopeNames.ToArray())).ToArray())
);
}
}