Невозможно отменить задачу, возвращенную TaskCompletionSource, путем введения тайм-аута в C#

Если SendRequestToAcquireDataAsync корректно отменяется, когда его CancellationToken отменяется, то вы, вероятно, просто ждете, чтобы OnResultReady уволили, даже после того, как ваш CancellationToken был отменен.

Итак, вам, вероятно, потребуется зарегистрировать действие с помощью CancellationToken, чтобы отменить TaskCompletionSource в случае его отмены. Что-то вроде:

private async Task<string?> RequestDataAsync(string? remoteEntity, CancellationToken cancellationToken)
{
    var taskCompletionSource = new TaskCompletionSource<string?>();
    try
    {
        if (remoteEntity is not null)
        {
            var handler = GetHandler();
            handler.Event.OnResultReady += result =>
            {
                taskCompletionSource.TrySetResult(result);
            };
            await SendRequestToAcquireDataAsync(cancellationToken);
        }
        else
        {
            taskCompletionSource.SetResult(null);
        }
    }
    catch (Exception ex)
    {
        taskCompletionSource.SetException(ex);
    }

    using (cancellationToken.Register(() => taskCompletionSource.TrySetCanceled())
    {
        return await taskCompletionSource.Task;
    }
}

Я также изменил SetResult на TrySetResult, чтобы избежать исключения, если событие будет запущено после отмены CancellationToken.

Вероятно, вам также следует отказаться от подписки на это событие, когда все закончится:

private async Task<string?> RequestDataAsync(string? remoteEntity, CancellationToken cancellationToken)
{
    var taskCompletionSource = new TaskCompletionSource<string?>();
    Handler? handler = null;

    void ResultReadyHandler(string result)
    {
        taskCompletionSource.TrySetResult(result);
    }

    try
    {
        if (remoteEntity is not null)
        {
            handler = GetHandler();
            handler.Event.OnResultReady += ResultReadyHandler;
            await SendRequestToAcquireDataAsync(cancellationToken);
        }
        else
        {
            taskCompletionSource.SetResult(null);
        }
    }
    catch (Exception ex)
    {
        taskCompletionSource.SetException(ex);
    }

    using (cancellationToken.Register(() => taskCompletionSource.TrySetCanceled())
    {
        try
        {
            return await taskCompletionSource.Task;
        }
        finally
        {
            if (handler != null)
            {
                handler.Event.OnResultReady -= ResultReadyHandler;
            }
        }
    }
}

(Очевидно, исправьте тип Handler).

Тем не менее, вы делаете это более сложным, чем должно быть. В вашем catch вы устанавливаете исключение для TaskCompletionSource, а затем ожидаете TaskCompletionSource.Task, который просто повторно генерирует исключение. Это просто многоречивый способ просто позволить исключению всплыть, что происходит автоматически. То же самое с возвратом null:

private async Task<string?> RequestDataAsync(string? remoteEntity, CancellationToken cancellationToken)
{
    if (remoteEntity is null)
    {
        return null;
    }
  
    var taskCompletionSource = new TaskCompletionSource<string?>();

    void ResultReadyHandler(Result result)
    {
        taskCompletionSource.TrySetResult(result);
    }

    var handler = GetHandler();
    handler.Event.OnResultReady += ResultReadyHandler;

    try
    {
        await SendRequestToAcquireDataAsync(cancellationToken)
        using (cancellationToken.Register(() => taskCompletionSource.TrySetCanceled())
        {
            return await taskCompletionSource.Task;
        }
    }
    finally
    {
        handler.Event.OnResultReady -= ResultReadyHandler;
    }
}

Тем не менее, почему у SendRequestToAcquireDataAsync такой неуклюжий API? Почему он возвращает Task, который нужно дождаться, а затем запускает событие, на которое нужно подписаться?