-
-
Notifications
You must be signed in to change notification settings - Fork 723
/
FilterConvention.cs
412 lines (351 loc) · 13.5 KB
/
FilterConvention.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
412
using System;
using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
using System.Globalization;
using System.Linq;
using System.Reflection;
using HotChocolate.Configuration;
using HotChocolate.Data.Utilities;
using HotChocolate.Internal;
using HotChocolate.Resolvers;
using HotChocolate.Types;
using HotChocolate.Types.Descriptors;
using HotChocolate.Utilities;
using static HotChocolate.Data.ThrowHelper;
namespace HotChocolate.Data.Filters;
/// <summary>
/// The filter convention provides defaults for inferring filters.
/// </summary>
public class FilterConvention
: Convention<FilterConventionDefinition>
, IFilterConvention
{
private const string _inputPostFix = "FilterInput";
private const string _inputTypePostFix = "FilterInputType";
private Action<IFilterConventionDescriptor>? _configure;
private INamingConventions _namingConventions = default!;
private IReadOnlyDictionary<int, FilterOperation> _operations = default!;
private IDictionary<Type, Type> _bindings = default!;
private IDictionary<ITypeReference, List<ConfigureFilterInputType>> _configs = default!;
private NameString _argumentName;
private IFilterProvider _provider = default!;
private ITypeInspector _typeInspector = default!;
private bool _useAnd;
private bool _useOr;
protected FilterConvention()
{
_configure = Configure;
}
public FilterConvention(Action<IFilterConventionDescriptor> configure)
{
_configure = configure ??
throw new ArgumentNullException(nameof(configure));
}
internal new FilterConventionDefinition? Definition => base.Definition;
/// <inheritdoc />
protected override FilterConventionDefinition CreateDefinition(IConventionContext context)
{
if (_configure is null)
{
throw new InvalidOperationException(
DataResources.FilterConvention_NoConfigurationSpecified);
}
var descriptor = FilterConventionDescriptor.New(
context.DescriptorContext,
context.Scope);
_configure!(descriptor);
_configure = null;
return descriptor.CreateDefinition();
}
/// <summary>
/// This method is called on initialization of the convention but before the convention is
/// completed. The default implementation of this method does nothing. It can be overriden
/// by a derived class such that the convention can be further configured before it is
/// completed
/// </summary>
/// <param name="descriptor">
/// The descriptor that can be used to configure the convention
/// </param>
protected virtual void Configure(IFilterConventionDescriptor descriptor)
{
}
/// <inheritdoc />
protected internal override void Complete(IConventionContext context)
{
if (Definition?.Provider is null)
{
throw FilterConvention_NoProviderFound(GetType(), Definition?.Scope);
}
if (Definition.ProviderInstance is null)
{
_provider =
context.Services.GetOrCreateService<IFilterProvider>(Definition.Provider) ??
throw FilterConvention_NoProviderFound(GetType(), Definition.Scope);
}
else
{
_provider = Definition.ProviderInstance;
}
_namingConventions = context.DescriptorContext.Naming;
_operations =
Definition.Operations.ToDictionary(x => x.Id, FilterOperation.FromDefinition);
_bindings = Definition.Bindings;
_configs = Definition.Configurations;
_argumentName = Definition.ArgumentName;
_useAnd = Definition.UseAnd;
_useOr = Definition.UseOr;
if (_provider is IFilterProviderConvention init)
{
IReadOnlyList<IFilterProviderExtension> extensions =
CollectExtensions(context.Services, Definition);
init.Initialize(context, this);
MergeExtensions(context, init, extensions);
init.Complete(context);
}
_typeInspector = context.DescriptorContext.TypeInspector;
// It is important to always call base to continue the cleanup and the disposal of the
// definition
base.Complete(context);
}
/// <inheritdoc />
public virtual NameString GetTypeName(Type runtimeType)
{
if (runtimeType is null)
{
throw new ArgumentNullException(nameof(runtimeType));
}
if (typeof(IEnumOperationFilterInputType).IsAssignableFrom(runtimeType) &&
runtimeType.GenericTypeArguments.Length == 1 &&
runtimeType.GetGenericTypeDefinition() == typeof(EnumOperationFilterInputType<>))
{
NameString genericName =
_namingConventions.GetTypeName(runtimeType.GenericTypeArguments[0]);
return genericName.Value + "OperationFilterInput";
}
if (typeof(IComparableOperationFilterInputType).IsAssignableFrom(runtimeType) &&
runtimeType.GenericTypeArguments.Length == 1 &&
runtimeType.GetGenericTypeDefinition() ==
typeof(ComparableOperationFilterInputType<>))
{
NameString genericName =
_namingConventions.GetTypeName(runtimeType.GenericTypeArguments[0]);
return $"Comparable{genericName.Value}OperationFilterInput";
}
if (typeof(IListFilterInputType).IsAssignableFrom(runtimeType) &&
runtimeType.GenericTypeArguments.Length == 1 &&
runtimeType.GetGenericTypeDefinition() == typeof(ListFilterInputType<>))
{
Type genericType = runtimeType.GenericTypeArguments[0];
NameString genericName;
if (typeof(FilterInputType).IsAssignableFrom(genericType))
{
genericName = GetTypeName(genericType);
}
else
{
genericName = _namingConventions.GetTypeName(genericType);
}
return "List" + genericName.Value;
}
string name = _namingConventions.GetTypeName(runtimeType);
var isInputObjectType = typeof(FilterInputType).IsAssignableFrom(runtimeType);
var isEndingInput = name.EndsWith(_inputPostFix, StringComparison.Ordinal);
var isEndingInputType = name.EndsWith(_inputTypePostFix, StringComparison.Ordinal);
if (isInputObjectType && isEndingInputType)
{
return name.Substring(0, name.Length - 4);
}
if (isInputObjectType && !isEndingInput && !isEndingInputType)
{
return name + _inputPostFix;
}
if (!isInputObjectType && !isEndingInput)
{
return name + _inputPostFix;
}
return name;
}
/// <inheritdoc />
public NameString GetTypeName(
IFilterInputType parentType,
FilterFieldDefinition fieldDefinition)
{
const string operationInputPostFix = $"Operation{_inputPostFix}";
const string operationInputTypePostFix = $"Operation{_inputTypePostFix}";
string parentName = parentType.Name;
if (parentName.EndsWith(_inputPostFix, StringComparison.Ordinal))
{
parentName = parentName.Remove(parentName.Length - _inputPostFix.Length);
}
else if (parentName.EndsWith(operationInputPostFix, StringComparison.Ordinal))
{
parentName = parentName.Remove(parentName.Length - operationInputPostFix.Length);
}
else if (parentName.EndsWith(_inputTypePostFix, StringComparison.Ordinal))
{
parentName = parentName.Remove(parentName.Length - _inputTypePostFix.Length);
}
else if (parentName.EndsWith(operationInputTypePostFix, StringComparison.Ordinal))
{
parentName = parentName.Remove(parentName.Length - operationInputTypePostFix.Length);
}
return parentName + NameHelpers.UppercaseFirstLetter(fieldDefinition.Name) + _inputPostFix;
}
/// <inheritdoc />
public virtual string? GetTypeDescription(Type runtimeType) =>
_namingConventions.GetTypeDescription(runtimeType, TypeKind.InputObject);
/// <inheritdoc />
public virtual NameString GetFieldName(MemberInfo member) =>
_namingConventions.GetMemberName(member, MemberKind.InputObjectField);
/// <inheritdoc />
public virtual string? GetFieldDescription(MemberInfo member) =>
_namingConventions.GetMemberDescription(member, MemberKind.InputObjectField);
/// <inheritdoc />
public virtual ExtendedTypeReference GetFieldType(MemberInfo member)
{
if (member is null)
{
throw new ArgumentNullException(nameof(member));
}
if (TryCreateFilterType(_typeInspector.GetReturnType(member, true), out Type? rt))
{
return _typeInspector.GetTypeRef(rt, TypeContext.Input, Scope);
}
throw FilterConvention_TypeOfMemberIsUnknown(member);
}
/// <inheritdoc />
public NameString GetOperationName(int operation)
{
if (_operations.TryGetValue(operation, out FilterOperation? operationConvention))
{
return operationConvention.Name;
}
throw FilterConvention_OperationNameNotFound(operation);
}
/// <inheritdoc />
public string? GetOperationDescription(int operationId)
{
if (_operations.TryGetValue(operationId, out FilterOperation? operationConvention))
{
return operationConvention.Description;
}
return null;
}
/// <inheritdoc />
public NameString GetArgumentName() => _argumentName;
/// <inheritdoc cref="IFilterConvention"/>
public void ApplyConfigurations(
ITypeReference typeReference,
IFilterInputTypeDescriptor descriptor)
{
if (_configs.TryGetValue(
typeReference,
out List<ConfigureFilterInputType>? configurations))
{
foreach (ConfigureFilterInputType configure in configurations)
{
configure(descriptor);
}
}
}
public FieldMiddleware CreateExecutor<TEntityType>() =>
_provider.CreateExecutor<TEntityType>(_argumentName);
public virtual void ConfigureField(IObjectFieldDescriptor descriptor) =>
_provider.ConfigureField(_argumentName, descriptor);
public bool IsAndAllowed()
{
return _useAnd;
}
public bool IsOrAllowed()
{
return _useOr;
}
public bool TryGetHandler(
ITypeCompletionContext context,
IFilterInputTypeDefinition typeDefinition,
IFilterFieldDefinition fieldDefinition,
[NotNullWhen(true)] out IFilterFieldHandler? handler)
{
foreach (IFilterFieldHandler filterFieldHandler in _provider.FieldHandlers)
{
if (filterFieldHandler.CanHandle(context, typeDefinition, fieldDefinition))
{
handler = filterFieldHandler;
return true;
}
}
handler = null;
return false;
}
public IFilterMetadata? CreateMetaData(
ITypeCompletionContext context,
IFilterInputTypeDefinition typeDefinition,
IFilterFieldDefinition fieldDefinition)
=> _provider.CreateMetaData(context, typeDefinition, fieldDefinition);
private bool TryCreateFilterType(
IExtendedType runtimeType,
[NotNullWhen(true)] out Type? type)
{
if (_bindings.TryGetValue(runtimeType.Source, out type))
{
return true;
}
if (runtimeType.IsArrayOrList)
{
if (runtimeType.ElementType is { } &&
TryCreateFilterType(runtimeType.ElementType, out Type? elementType))
{
type = typeof(ListFilterInputType<>).MakeGenericType(elementType);
return true;
}
}
if (runtimeType.Type.IsEnum)
{
type = typeof(EnumOperationFilterInputType<>).MakeGenericType(runtimeType.Source);
return true;
}
if (runtimeType.Type.IsClass ||
runtimeType.Type.IsInterface)
{
type = typeof(FilterInputType<>).MakeGenericType(runtimeType.Source);
return true;
}
type = null;
return false;
}
private static IReadOnlyList<IFilterProviderExtension> CollectExtensions(
IServiceProvider serviceProvider,
FilterConventionDefinition definition)
{
List<IFilterProviderExtension> extensions = new List<IFilterProviderExtension>();
extensions.AddRange(definition.ProviderExtensions);
foreach (Type? extensionType in definition.ProviderExtensionsTypes)
{
if (serviceProvider.TryGetOrCreateService<IFilterProviderExtension>(
extensionType,
out IFilterProviderExtension? createdExtension))
{
extensions.Add(createdExtension);
}
}
return extensions;
}
private void MergeExtensions(
IConventionContext context,
IFilterProviderConvention provider,
IReadOnlyList<IFilterProviderExtension> extensions)
{
if (provider is Convention providerConvention)
{
for (var m = 0; m < extensions.Count; m++)
{
if (extensions[m] is IFilterProviderConvention extensionConvention)
{
extensionConvention.Initialize(context, this);
extensions[m].Merge(context, providerConvention);
extensionConvention.Complete(context);
}
}
}
}
}