Как в контроллеры привязывается CancellationToken?

Question

[Виктор П.]

Добрый день,
Хочу перевести код на асинхронный, но просто переделать методы на async Task и понаставить await-ов недостаточно же, необходимо прокинуть везде CancellationToken
И такой вопрос, а как вообще приложение понимает, что это именно тот токен, который нужен всем. Если будет отмена запроса, прокинется ли значение токена ниже? Я ведь просто руками в параметры метода добавляю еще один параметр с произвольным именем, обычно что-то вроде CancellationToken ct. Что будет, если я его вначале поставлю, например, плюс там еще могут быть какие-то другие параметры? Кто занимается этими вот привязками? В интернете что-то даже вопрос не могу сформулировать нормально

[HttpPost]
public async Task<IActionResult> EditEmployeeAttestation(EmployeeAttestationBlank employeeAttestation, IFormCollection parameter, CancellationToken ct)
{
	if (ModelState.IsValid)
	{
		await _employeesService.EditEmployeeAttestation(employeeAttestation, ct);

		return RedirectToAction("Index");
	}

	return View("EditEmployeeAttestation", employeeAttestation);
}

Comments

[Петр]

"но просто переделать методы на async Task и понаставить await-ов недостаточно же, необходимо прокинуть везде CancellationToken" - достаточно.
Как у вас в примере это самое правильное

Answer 1

[Василий Банников]

Если совсем боишься - можешь брать CancellationToken не из аргументов, а из контекста (HttpContext.RequestAborted)

А подсовывает его тебе рантайм через процесс под названием model binding:
https://learn.microsoft.com/en-us/aspnet/core/mvc/...
Биндинг происходит чисто по совпадению типа и имя аргумента не влияет на него.

Comments

[MVV]

Насчет возможности получения CancellationToken через параметр метода действия за счет привязки к модели меня терзают смутные сомнения. Его ведь нет м ьыит не может ни в запросе - ни в каком виде, хоть в виде параметра в строке URL, хоть в части пути (RouteValues), хоть в теле запроса по POST), - ни в контейнере сервисов (DI-контейнере). Разве что в default values маршрута его запихнуть - дык, а использовать его там как?
А вот вариант использовать HttpContext.RequestAborted - одобряю и поддерживаю.

[Василий Банников]

MVV,

Насчет возможности получения CancellationToken через параметр метода действия за счет привязки к модели меня терзают смутные сомнения.

Ну MS говорит, что прокидывает его как раз через model binding.
Думаю, если покопаться в исходниках - можно найти даже как именно.
Во время model binding вроде бы есть доступ к контексту - так что почему нет?

[Василий Банников]

MVV, вот нашёл в исходниках реализацию IModelBinder для CancellationToken:
https://github.com/dotnet/aspnetcore/blob/045afcd6...

Рядом и ModelBinderProvider, который проверяет, что аргумент имеет тип CancellationToken

// 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 Microsoft.AspNetCore.Mvc.ModelBinding.Validation;

namespace Microsoft.AspNetCore.Mvc.ModelBinding.Binders;

/// <summary>
/// An <see cref="IModelBinderProvider"/> for <see cref="CancellationToken"/>.
/// </summary>
public class CancellationTokenModelBinderProvider : IModelBinderProvider
{
    // CancellationTokenModelBinder does not have any state. Re-use the same instance for binding.

    private readonly CancellationTokenModelBinder _modelBinder = new();

    /// <inheritdoc />
    public IModelBinder? GetBinder(ModelBinderProviderContext context)
    {
        ArgumentNullException.ThrowIfNull(context);

        if (context.Metadata.ModelType == typeof(CancellationToken))
        {
            return _modelBinder;
        }

        return null;
    }
}

/// <summary>
/// <see cref="IModelBinder"/> implementation to bind models of type <see cref="CancellationToken"/>.
/// </summary>
public class CancellationTokenModelBinder : IModelBinder
{
    /// <inheritdoc />
    public Task BindModelAsync(ModelBindingContext bindingContext)
    {
        ArgumentNullException.ThrowIfNull(bindingContext);

        // We need to force boxing now, so we can insert the same reference to the boxed CancellationToken
        // in both the ValidationState and ModelBindingResult.
        //
        // DO NOT simplify this code by removing the cast.
        var model = (object)bindingContext.HttpContext.RequestAborted;
        bindingContext.ValidationState.Add(model, new ValidationStateEntry() { SuppressValidation = true });
        bindingContext.Result = ModelBindingResult.Success(model);

        return Task.CompletedTask;
    }
}

[MVV]

Василий Банников, благодарю, понял: привязка идет к HttpContext.RequestAborted.
Я, правда, по вопросу не понял, это ли нужно автору вопроса.

[Василий Банников]

MVV, ну автор вопроса как раз не был уверен, действительно ли туда прокидывается RequestAborted и не поломается ли всё, если он как-то по другому параметр назовёт или перенесёт параметр в начало.

Ответ - ничего не поломается.