Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Don't log message read cancellation as an error in client #724

Merged
merged 2 commits into from
Jan 21, 2020
Merged

Don't log message read cancellation as an error in client #724

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2ab9e0b
Don't log message read cancellation as an error in client
JamesNK Jan 16, 2020
73a6a31
Update test
JamesNK Jan 16, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion src/Grpc.Net.Client/Internal/StreamExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,8 +173,9 @@ private static Status CreateUnknownMessageEncodingMessageStatus(string unsupport
GrpcCallLog.ReceivedMessage(logger);
return message;
}
catch (Exception ex)
catch (Exception ex) when (!(ex is OperationCanceledException && cancellationToken.IsCancellationRequested))
{
// Don't write error when user cancels read
GrpcCallLog.ErrorReadingMessage(logger, ex);
throw;
}
Expand Down
55 changes: 48 additions & 7 deletions test/Grpc.Net.Client.Tests/HttpContentClientStreamReaderTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,16 +17,17 @@
#endregion

using System;
using System.Linq;
using System.Net;
using System.Net.Http;
using System.Threading;
using System.Threading.Tasks;
using Greet;
using Grpc.Core;
using Grpc.Net.Client.Internal;
using Grpc.Net.Client.Tests.Infrastructure;
using Grpc.Tests.Shared;
using Microsoft.Extensions.Logging.Abstractions;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Logging.Testing;
using NUnit.Framework;

namespace Grpc.Net.Client.Tests
Expand All @@ -48,7 +49,10 @@ public async Task MoveNext_TokenCanceledBeforeCall_ThrowError()
return Task.FromResult(ResponseUtils.CreateResponse(HttpStatusCode.OK, content));
});

var channel = GrpcChannel.ForAddress(httpClient.BaseAddress, new GrpcChannelOptions { HttpClient = httpClient });
var testSink = new TestSink(e => e.LogLevel >= LogLevel.Error);
var testLoggerFactory = new TestLoggerFactory(testSink, enabled: true);

var channel = CreateChannel(httpClient, loggerFactory: testLoggerFactory);
var call = CreateGrpcCall(channel);
call.StartServerStreaming(new HelloRequest());

Expand All @@ -60,6 +64,8 @@ public async Task MoveNext_TokenCanceledBeforeCall_ThrowError()
var ex = await ExceptionAssert.ThrowsAsync<RpcException>(() => moveNextTask).DefaultTimeout();

Assert.AreEqual(StatusCode.Cancelled, ex.StatusCode);

Assert.AreEqual(0, testSink.Writes.Count);
}

[Test]
Expand All @@ -76,7 +82,10 @@ public async Task MoveNext_TokenCanceledBeforeCall_ThrowOperationCanceledExcepti
return Task.FromResult(ResponseUtils.CreateResponse(HttpStatusCode.OK, content));
});

var channel = GrpcChannel.ForAddress(httpClient.BaseAddress, new GrpcChannelOptions { HttpClient = httpClient, ThrowOperationCanceledOnCancellation = true });
var testSink = new TestSink(e => e.LogLevel >= LogLevel.Error);
var testLoggerFactory = new TestLoggerFactory(testSink, enabled: true);

var channel = CreateChannel(httpClient, loggerFactory: testLoggerFactory, throwOperationCanceledOnCancellation: true);
var call = CreateGrpcCall(channel);
call.StartServerStreaming(new HelloRequest());

Expand All @@ -86,6 +95,8 @@ public async Task MoveNext_TokenCanceledBeforeCall_ThrowOperationCanceledExcepti
// Assert
Assert.IsTrue(moveNextTask.IsCompleted);
await ExceptionAssert.ThrowsAsync<OperationCanceledException>(() => moveNextTask).DefaultTimeout();

Assert.AreEqual(0, testSink.Writes.Count);
}

[Test]
Expand All @@ -101,7 +112,10 @@ public async Task MoveNext_TokenCanceledDuringCall_ThrowError()
return Task.FromResult(ResponseUtils.CreateResponse(HttpStatusCode.OK, content));
});

var channel = GrpcChannel.ForAddress(httpClient.BaseAddress, new GrpcChannelOptions { HttpClient = httpClient });
var testSink = new TestSink(e => e.LogLevel >= LogLevel.Error);
var testLoggerFactory = new TestLoggerFactory(testSink, enabled: true);

var channel = CreateChannel(httpClient, loggerFactory: testLoggerFactory);
var call = CreateGrpcCall(channel);
call.StartServerStreaming(new HelloRequest());

Expand All @@ -116,6 +130,8 @@ public async Task MoveNext_TokenCanceledDuringCall_ThrowError()
var ex = await ExceptionAssert.ThrowsAsync<RpcException>(() => moveNextTask).DefaultTimeout();

Assert.AreEqual(StatusCode.Cancelled, ex.StatusCode);

Assert.AreEqual(0, testSink.Writes.Count);
}

[Test]
Expand All @@ -131,7 +147,10 @@ public async Task MoveNext_TokenCanceledDuringCall_ThrowOperationCanceledOnCance
return Task.FromResult(ResponseUtils.CreateResponse(HttpStatusCode.OK, content));
});

var channel = GrpcChannel.ForAddress(httpClient.BaseAddress, new GrpcChannelOptions { HttpClient = httpClient, ThrowOperationCanceledOnCancellation = true });
var testSink = new TestSink(e => e.LogLevel >= LogLevel.Error);
var testLoggerFactory = new TestLoggerFactory(testSink, enabled: true);

var channel = CreateChannel(httpClient, loggerFactory: testLoggerFactory, throwOperationCanceledOnCancellation: true);
var call = CreateGrpcCall(channel);
call.StartServerStreaming(new HelloRequest());

Expand All @@ -144,6 +163,8 @@ public async Task MoveNext_TokenCanceledDuringCall_ThrowOperationCanceledOnCance
cts.Cancel();

await ExceptionAssert.ThrowsAsync<OperationCanceledException>(() => moveNextTask).DefaultTimeout();

Assert.AreEqual(0, testSink.Writes.Count);
}

[Test]
Expand All @@ -157,7 +178,10 @@ public async Task MoveNext_MultipleCallsWithoutAwait_ThrowError()
return Task.FromResult(ResponseUtils.CreateResponse(HttpStatusCode.OK, content));
});

var channel = GrpcChannel.ForAddress(httpClient.BaseAddress, new GrpcChannelOptions { HttpClient = httpClient });
var testSink = new TestSink(e => e.LogLevel >= LogLevel.Error);
var testLoggerFactory = new TestLoggerFactory(testSink, enabled: true);

var channel = CreateChannel(httpClient, loggerFactory: testLoggerFactory);
var call = CreateGrpcCall(channel);
call.StartServerStreaming(new HelloRequest());

Expand All @@ -170,6 +194,11 @@ public async Task MoveNext_MultipleCallsWithoutAwait_ThrowError()

var ex = await ExceptionAssert.ThrowsAsync<InvalidOperationException>(() => moveNextTask2).DefaultTimeout();
Assert.AreEqual("Can't read the next message because the previous read is still in progress.", ex.Message);

Assert.AreEqual(1, testSink.Writes.Count);
var write = testSink.Writes.ElementAt(0);
Assert.AreEqual("ReadMessageError", write.EventId.Name);
Assert.AreEqual(ex, write.Exception);
}

private static GrpcCall<HelloRequest, HelloReply> CreateGrpcCall(GrpcChannel channel)
Expand All @@ -182,5 +211,17 @@ private static GrpcCall<HelloRequest, HelloReply> CreateGrpcCall(GrpcChannel cha
new CallOptions(),
channel);
}

private static GrpcChannel CreateChannel(HttpClient httpClient, ILoggerFactory? loggerFactory = null, bool? throwOperationCanceledOnCancellation = null)
{
return GrpcChannel.ForAddress(
httpClient.BaseAddress,
new GrpcChannelOptions
{
HttpClient = httpClient,
LoggerFactory = loggerFactory,
ThrowOperationCanceledOnCancellation = throwOperationCanceledOnCancellation ?? false
});
}
}
}