/
ActionMethodExecutor.cs
374 lines (318 loc) · 14.8 KB
/
ActionMethodExecutor.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
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
#nullable enable
using System.Diagnostics;
using Microsoft.AspNetCore.Mvc.Controllers;
using Microsoft.Extensions.Internal;
using Resources = Microsoft.AspNetCore.Mvc.Core.Resources;
namespace Microsoft.AspNetCore.Mvc.Infrastructure;
internal abstract class ActionMethodExecutor
{
private static readonly ActionMethodExecutor[] Executors = new ActionMethodExecutor[]
{
// Executors for sync methods
new VoidResultExecutor(),
new SyncActionResultExecutor(),
new SyncObjectResultExecutor(),
// Executors for async methods
new TaskResultExecutor(),
new AwaitableResultExecutor(),
new TaskOfIActionResultExecutor(),
new TaskOfActionResultExecutor(),
new AwaitableObjectResultExecutor(),
};
public static EmptyResult EmptyResultInstance { get; } = new();
public abstract ValueTask<IActionResult> Execute(
ActionContext actionContext,
IActionResultTypeMapper mapper,
ObjectMethodExecutor executor,
object controller,
object?[]? arguments);
protected abstract bool CanExecute(ObjectMethodExecutor executor);
public abstract ValueTask<object?> Execute(ControllerEndpointFilterInvocationContext invocationContext);
public static ActionMethodExecutor GetExecutor(ObjectMethodExecutor executor)
{
for (var i = 0; i < Executors.Length; i++)
{
if (Executors[i].CanExecute(executor))
{
return Executors[i];
}
}
throw new UnreachableException();
}
public static ActionMethodExecutor GetFilterExecutor(ControllerActionDescriptor actionDescriptor) =>
new FilterActionMethodExecutor(actionDescriptor);
private sealed class FilterActionMethodExecutor : ActionMethodExecutor
{
private readonly ControllerActionDescriptor _controllerActionDescriptor;
public FilterActionMethodExecutor(ControllerActionDescriptor controllerActionDescriptor)
{
_controllerActionDescriptor = controllerActionDescriptor;
}
public override async ValueTask<IActionResult> Execute(
ActionContext actionContext,
IActionResultTypeMapper mapper,
ObjectMethodExecutor executor,
object controller,
object?[]? arguments)
{
var context = new ControllerEndpointFilterInvocationContext(_controllerActionDescriptor, actionContext, executor, mapper, controller, arguments);
var result = await _controllerActionDescriptor.FilterDelegate!(context);
return ConvertToActionResult(mapper, result, executor.IsMethodAsync ? executor.AsyncResultType! : executor.MethodReturnType);
}
public override ValueTask<object?> Execute(ControllerEndpointFilterInvocationContext invocationContext)
{
// This is never called
throw new NotSupportedException();
}
protected override bool CanExecute(ObjectMethodExecutor executor)
{
// This is never called
throw new NotSupportedException();
}
}
// void LogMessage(..)
private sealed class VoidResultExecutor : ActionMethodExecutor
{
public override ValueTask<IActionResult> Execute(
ActionContext actionContext,
IActionResultTypeMapper mapper,
ObjectMethodExecutor executor,
object controller,
object?[]? arguments)
{
executor.Execute(controller, arguments);
return new(EmptyResultInstance);
}
public override ValueTask<object?> Execute(ControllerEndpointFilterInvocationContext invocationContext)
{
var executor = invocationContext.Executor;
var controller = invocationContext.Controller;
var arguments = (object[])invocationContext.Arguments;
executor.Execute(controller, arguments);
return new(EmptyResultInstance);
}
protected override bool CanExecute(ObjectMethodExecutor executor)
=> !executor.IsMethodAsync && executor.MethodReturnType == typeof(void);
}
// IActionResult Post(..)
// CreatedAtResult Put(..)
private sealed class SyncActionResultExecutor : ActionMethodExecutor
{
public override ValueTask<IActionResult> Execute(
ActionContext actionContext,
IActionResultTypeMapper mapper,
ObjectMethodExecutor executor,
object controller,
object?[]? arguments)
{
var actionResult = (IActionResult)executor.Execute(controller, arguments)!;
EnsureActionResultNotNull(executor, actionResult);
return new(actionResult);
}
public override ValueTask<object?> Execute(ControllerEndpointFilterInvocationContext invocationContext)
{
var executor = invocationContext.Executor;
var controller = invocationContext.Controller;
var arguments = (object[])invocationContext.Arguments;
var actionResult = (IActionResult)executor.Execute(controller, arguments)!;
EnsureActionResultNotNull(executor, actionResult);
return new(actionResult);
}
protected override bool CanExecute(ObjectMethodExecutor executor)
=> !executor.IsMethodAsync && typeof(IActionResult).IsAssignableFrom(executor.MethodReturnType);
}
// Person GetPerson(..)
// object Index(..)
private sealed class SyncObjectResultExecutor : ActionMethodExecutor
{
public override ValueTask<IActionResult> Execute(
ActionContext actionContext,
IActionResultTypeMapper mapper,
ObjectMethodExecutor executor,
object controller,
object?[]? arguments)
{
// Sync method returning arbitrary object
var returnValue = executor.Execute(controller, arguments);
var actionResult = ConvertToActionResult(mapper, returnValue, executor.MethodReturnType);
return new(actionResult);
}
public override ValueTask<object?> Execute(ControllerEndpointFilterInvocationContext invocationContext)
{
var executor = invocationContext.Executor;
var controller = invocationContext.Controller;
var arguments = (object[])invocationContext.Arguments;
var mapper = invocationContext.Mapper;
// Sync method returning arbitrary object
var returnValue = executor.Execute(controller, arguments);
var actionResult = ConvertToActionResult(mapper, returnValue, executor.MethodReturnType);
return new(actionResult);
}
// Catch-all for sync methods
protected override bool CanExecute(ObjectMethodExecutor executor) => !executor.IsMethodAsync;
}
// Task SaveState(..)
private sealed class TaskResultExecutor : ActionMethodExecutor
{
public override async ValueTask<IActionResult> Execute(
ActionContext actionContext,
IActionResultTypeMapper mapper,
ObjectMethodExecutor executor,
object controller,
object?[]? arguments)
{
await (Task)executor.Execute(controller, arguments)!;
return EmptyResultInstance;
}
public override async ValueTask<object?> Execute(ControllerEndpointFilterInvocationContext invocationContext)
{
var executor = invocationContext.Executor;
var controller = invocationContext.Controller;
var arguments = (object[])invocationContext.Arguments;
await (Task)executor.Execute(controller, arguments)!;
return EmptyResultInstance;
}
protected override bool CanExecute(ObjectMethodExecutor executor) => executor.MethodReturnType == typeof(Task);
}
// CustomAsync PerformActionAsync(..)
// Custom task-like type with no return value.
private sealed class AwaitableResultExecutor : ActionMethodExecutor
{
public override async ValueTask<IActionResult> Execute(
ActionContext actionContext,
IActionResultTypeMapper mapper,
ObjectMethodExecutor executor,
object controller,
object?[]? arguments)
{
await executor.ExecuteAsync(controller, arguments);
return EmptyResultInstance;
}
public override async ValueTask<object?> Execute(ControllerEndpointFilterInvocationContext invocationContext)
{
var executor = invocationContext.Executor;
var controller = invocationContext.Controller;
var arguments = (object[])invocationContext.Arguments;
await executor.ExecuteAsync(controller, arguments);
return EmptyResultInstance;
}
protected override bool CanExecute(ObjectMethodExecutor executor)
{
// Async method returning void
return executor.IsMethodAsync && executor.AsyncResultType == typeof(void);
}
}
// Task<IActionResult> Post(..)
private sealed class TaskOfIActionResultExecutor : ActionMethodExecutor
{
public override async ValueTask<IActionResult> Execute(
ActionContext actionContext,
IActionResultTypeMapper mapper,
ObjectMethodExecutor executor,
object controller,
object?[]? arguments)
{
// Async method returning Task<IActionResult>
// Avoid extra allocations by calling Execute rather than ExecuteAsync and casting to Task<IActionResult>.
var returnValue = executor.Execute(controller, arguments);
var actionResult = await (Task<IActionResult>)returnValue!;
EnsureActionResultNotNull(executor, actionResult);
return actionResult;
}
public override async ValueTask<object?> Execute(ControllerEndpointFilterInvocationContext invocationContext)
{
var executor = invocationContext.Executor;
var controller = invocationContext.Controller;
var arguments = (object[])invocationContext.Arguments;
// Async method returning Task<IActionResult>
// Avoid extra allocations by calling Execute rather than ExecuteAsync and casting to Task<IActionResult>.
var returnValue = executor.Execute(controller, arguments);
var actionResult = await (Task<IActionResult>)returnValue!;
EnsureActionResultNotNull(executor, actionResult);
return actionResult;
}
protected override bool CanExecute(ObjectMethodExecutor executor)
=> typeof(Task<IActionResult>).IsAssignableFrom(executor.MethodReturnType);
}
// Task<PhysicalFileResult> DownloadFile(..)
// ValueTask<ViewResult> GetViewsAsync(..)
private sealed class TaskOfActionResultExecutor : ActionMethodExecutor
{
public override async ValueTask<IActionResult> Execute(
ActionContext actionContext,
IActionResultTypeMapper mapper,
ObjectMethodExecutor executor,
object controller,
object?[]? arguments)
{
// Async method returning awaitable-of-IActionResult (e.g., Task<ViewResult>)
// We have to use ExecuteAsync because we don't know the awaitable's type at compile time.
var actionResult = (IActionResult)await executor.ExecuteAsync(controller, arguments);
EnsureActionResultNotNull(executor, actionResult);
return actionResult;
}
public override async ValueTask<object?> Execute(ControllerEndpointFilterInvocationContext invocationContext)
{
var executor = invocationContext.Executor;
var controller = invocationContext.Controller;
var arguments = (object[])invocationContext.Arguments;
// Async method returning awaitable-of-IActionResult (e.g., Task<ViewResult>)
// We have to use ExecuteAsync because we don't know the awaitable's type at compile time.
var actionResult = (IActionResult)await executor.ExecuteAsync(controller, arguments);
EnsureActionResultNotNull(executor, actionResult);
return actionResult;
}
protected override bool CanExecute(ObjectMethodExecutor executor)
{
// Async method returning awaitable-of - IActionResult(e.g., Task<ViewResult>)
return executor.IsMethodAsync && typeof(IActionResult).IsAssignableFrom(executor.AsyncResultType);
}
}
// Task<object> GetPerson(..)
// Task<Customer> GetCustomerAsync(..)
private sealed class AwaitableObjectResultExecutor : ActionMethodExecutor
{
public override async ValueTask<IActionResult> Execute(
ActionContext actionContext,
IActionResultTypeMapper mapper,
ObjectMethodExecutor executor,
object controller,
object?[]? arguments)
{
// Async method returning awaitable-of-nonvoid
var returnValue = await executor.ExecuteAsync(controller, arguments);
var actionResult = ConvertToActionResult(mapper, returnValue, executor.AsyncResultType!);
return actionResult;
}
public override async ValueTask<object?> Execute(ControllerEndpointFilterInvocationContext invocationContext)
{
var executor = invocationContext.Executor;
var controller = invocationContext.Controller;
var arguments = (object[])invocationContext.Arguments;
var mapper = invocationContext.Mapper;
var returnValue = await executor.ExecuteAsync(controller, arguments);
var actionResult = ConvertToActionResult(mapper, returnValue, executor.AsyncResultType!);
return actionResult;
}
protected override bool CanExecute(ObjectMethodExecutor executor) => true;
}
private static void EnsureActionResultNotNull(ObjectMethodExecutor executor, IActionResult actionResult)
{
if (actionResult == null)
{
var type = executor.AsyncResultType ?? executor.MethodReturnType;
throw new InvalidOperationException(Resources.FormatActionResult_ActionReturnValueCannotBeNull(type));
}
}
private static IActionResult ConvertToActionResult(IActionResultTypeMapper mapper, object? returnValue, Type declaredType)
{
var result = (returnValue as IActionResult) ?? mapper.Convert(returnValue, declaredType);
if (result == null)
{
throw new InvalidOperationException(Resources.FormatActionResult_ActionReturnValueCannotBeNull(declaredType));
}
return result;
}
}