| | | 1 | | // Copyright (c) ZeroC, Inc. |
| | | 2 | | |
| | | 3 | | using IceRpc.Extensions.DependencyInjection; |
| | | 4 | | using IceRpc.Features; |
| | | 5 | | using ZeroC.Slice.Codec; |
| | | 6 | | |
| | | 7 | | namespace IceRpc.Deadline; |
| | | 8 | | |
| | | 9 | | /// <summary>Represents an interceptor that sets deadlines on requests without deadlines, and enforces these deadlines. |
| | | 10 | | /// </summary> |
| | | 11 | | /// <remarks>When a request doesn't carry an <see cref="IDeadlineFeature"/> feature, this interceptor computes a |
| | | 12 | | /// deadline using its configured default timeout; otherwise, it uses the request's existing deadline feature. It then |
| | | 13 | | /// encodes the deadline value as a <see cref="RequestFieldKey.Deadline" /> field and makes the invocation throw a |
| | | 14 | | /// <see cref="TimeoutException" /> upon expiration of this deadline.<br/> |
| | | 15 | | /// The dispatch of a one-way request cannot be canceled since the invocation typically completes before this dispatch |
| | | 16 | | /// starts; as a result, for a one-way request, the deadline must be enforced by a <see cref="DeadlineMiddleware"/>. |
| | | 17 | | /// <br/> |
| | | 18 | | /// If the server installs a <see cref="DeadlineMiddleware"/>, this deadline middleware decodes the deadline and |
| | | 19 | | /// enforces it. In the unlikely event the middleware detects the expiration of the deadline before this interceptor, |
| | | 20 | | /// the invocation will return an <see cref="OutgoingResponse"/> carrying status code |
| | | 21 | | /// <see cref="StatusCode.DeadlineExceeded"/>.<br/> |
| | | 22 | | /// The deadline interceptor must be installed before any interceptor than can run multiple times per request. In |
| | | 23 | | /// particular, it must be installed before the retry interceptor.</remarks> |
| | | 24 | | /// <seealso cref="DeadlinePipelineExtensions"/> |
| | | 25 | | /// <seealso cref="DeadlineInvokerBuilderExtensions"/> |
| | | 26 | | public class DeadlineInterceptor : IInvoker |
| | | 27 | | { |
| | | 28 | | private readonly bool _alwaysEnforceDeadline; |
| | | 29 | | private readonly IInvoker _next; |
| | | 30 | | private readonly TimeSpan _defaultTimeout; |
| | | 31 | | private readonly TimeProvider _timeProvider; |
| | | 32 | | |
| | | 33 | | /// <summary>Constructs a Deadline interceptor.</summary> |
| | | 34 | | /// <param name="next">The next invoker in the invocation pipeline.</param> |
| | | 35 | | /// <param name="defaultTimeout">The default timeout. When not infinite, the interceptor adds a deadline to requests |
| | | 36 | | /// without a deadline.</param> |
| | | 37 | | /// <param name="timeProvider">The optional time provider used to obtain the current time. If <see langword="null"/> |
| | | 38 | | /// <see cref="TimeProvider.System"/>.</param> |
| | | 39 | | /// <param name="alwaysEnforceDeadline">When <see langword="true" /> and the request carries a deadline, the |
| | | 40 | | /// interceptor always creates a cancellation token source to enforce this deadline. When <see langword="false" /> |
| | | 41 | | /// and the request carries a deadline, the interceptor creates a cancellation token source to enforce this deadline |
| | | 42 | | /// only when the invocation's cancellation token cannot be canceled. The default value is <see langword="false" />. |
| | | 43 | | /// </param> |
| | 11 | 44 | | public DeadlineInterceptor(IInvoker next, TimeSpan defaultTimeout, bool alwaysEnforceDeadline, TimeProvider? timePro |
| | 11 | 45 | | { |
| | 11 | 46 | | if (defaultTimeout != Timeout.InfiniteTimeSpan && defaultTimeout <= TimeSpan.Zero) |
| | 2 | 47 | | { |
| | 2 | 48 | | throw new ArgumentException( |
| | 2 | 49 | | $"The {nameof(defaultTimeout)} value must be positive or Timeout.InfiniteTimeSpan.", |
| | 2 | 50 | | nameof(defaultTimeout)); |
| | | 51 | | } |
| | | 52 | | |
| | 9 | 53 | | _next = next; |
| | 9 | 54 | | _alwaysEnforceDeadline = alwaysEnforceDeadline; |
| | 9 | 55 | | _defaultTimeout = defaultTimeout; |
| | 9 | 56 | | _timeProvider = timeProvider ?? TimeProvider.System; |
| | 9 | 57 | | } |
| | | 58 | | |
| | | 59 | | /// <inheritdoc/> |
| | | 60 | | public Task<IncomingResponse> InvokeAsync(OutgoingRequest request, CancellationToken cancellationToken = default) |
| | 8 | 61 | | { |
| | 8 | 62 | | TimeSpan? timeout = null; |
| | 8 | 63 | | DateTime deadline = DateTime.MaxValue; |
| | | 64 | | |
| | 8 | 65 | | DateTime now = _timeProvider.GetUtcNow().UtcDateTime; |
| | 8 | 66 | | if (request.Features.Get<IDeadlineFeature>() is IDeadlineFeature deadlineFeature) |
| | 6 | 67 | | { |
| | | 68 | | // Normalize to UTC. |
| | 6 | 69 | | deadline = deadlineFeature.Value == DateTime.MaxValue ? |
| | 6 | 70 | | DateTime.MaxValue : deadlineFeature.Value.ToUniversalTime(); |
| | 6 | 71 | | if (deadline != DateTime.MaxValue && (_alwaysEnforceDeadline || !cancellationToken.CanBeCanceled)) |
| | 5 | 72 | | { |
| | 5 | 73 | | timeout = deadline - now; |
| | 5 | 74 | | } |
| | 6 | 75 | | } |
| | 2 | 76 | | else if (_defaultTimeout != Timeout.InfiniteTimeSpan) |
| | 2 | 77 | | { |
| | 2 | 78 | | timeout = _defaultTimeout; |
| | 2 | 79 | | deadline = now + timeout.Value; |
| | 2 | 80 | | } |
| | | 81 | | |
| | 8 | 82 | | if (timeout is not null && timeout.Value <= TimeSpan.Zero) |
| | 0 | 83 | | { |
| | 0 | 84 | | throw new TimeoutException("The request deadline has expired."); |
| | | 85 | | } |
| | | 86 | | |
| | 8 | 87 | | if (deadline != DateTime.MaxValue) |
| | 8 | 88 | | { |
| | 8 | 89 | | request.Fields = request.Fields.With( |
| | 8 | 90 | | RequestFieldKey.Deadline, |
| | 8 | 91 | | deadline, |
| | 13 | 92 | | (ref SliceEncoder encoder, DateTime deadline) => encoder.EncodeTimeStamp(deadline)); |
| | 8 | 93 | | } |
| | | 94 | | |
| | 8 | 95 | | return timeout is null ? _next.InvokeAsync(request, cancellationToken) : PerformInvokeAsync(timeout.Value); |
| | | 96 | | |
| | | 97 | | async Task<IncomingResponse> PerformInvokeAsync(TimeSpan timeout) |
| | 7 | 98 | | { |
| | 7 | 99 | | using var timeoutTokenSource = CancellationTokenSource.CreateLinkedTokenSource(cancellationToken); |
| | 7 | 100 | | timeoutTokenSource.CancelAfter(timeout); |
| | | 101 | | |
| | | 102 | | try |
| | 7 | 103 | | { |
| | 7 | 104 | | return await _next.InvokeAsync(request, timeoutTokenSource.Token).ConfigureAwait(false); |
| | | 105 | | } |
| | 2 | 106 | | catch (OperationCanceledException exception) when (exception.CancellationToken == timeoutTokenSource.Token) |
| | 2 | 107 | | { |
| | 2 | 108 | | cancellationToken.ThrowIfCancellationRequested(); |
| | 2 | 109 | | throw new TimeoutException("The request deadline has expired."); |
| | | 110 | | } |
| | 5 | 111 | | } |
| | 8 | 112 | | } |
| | | 113 | | } |