huahaofeng
/
aspnetcore
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Log errors in OnStarting and OnCompleted

This commit is contained in:
Stephen Halter 2015-10-14 15:23:56 -07:00
parent b98425d3b1
commit 513abb4561
3 changed files with 95 additions and 66 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/Microsoft.AspNet.Server.Kestrel/Http/Frame.FeatureCollection.cs
View File

@ -275,7 +275,7 @@ namespace Microsoft.AspNet.Server.Kestrel.Http
ResponseHeaders["Upgrade"] = values; ResponseHeaders["Upgrade"] = values;
} }
} }
ProduceStart(); ProduceStartAndFireOnStarting(immediate: true).GetAwaiter().GetResult();
return Task.FromResult(DuplexStream); return Task.FromResult(DuplexStream);
} }

108
src/Microsoft.AspNet.Server.Kestrel/Http/Frame.cs
View File

@ -42,6 +42,7 @@ namespace Microsoft.AspNet.Server.Kestrel.Http
private bool _responseStarted; private bool _responseStarted;
private bool _keepAlive; private bool _keepAlive;
private bool _autoChunk; private bool _autoChunk;
private bool _applicationFailed;
public Frame(ConnectionContext context) : base(context) public Frame(ConnectionContext context) : base(context)
{ {
@ -172,28 +173,27 @@ namespace Microsoft.AspNet.Server.Kestrel.Http
ResponseBody = new FrameResponseStream(this); ResponseBody = new FrameResponseStream(this);
DuplexStream = new FrameDuplexStream(RequestBody, ResponseBody); DuplexStream = new FrameDuplexStream(RequestBody, ResponseBody);
Exception error = null;
try try
{ {
await Application.Invoke(this).ConfigureAwait(false); await Application.Invoke(this).ConfigureAwait(false);
}
catch (Exception ex)
{
ReportApplicationError(ex);
}
finally
{
// Trigger FireOnStarting if ProduceStart hasn't been called yet. // Trigger FireOnStarting if ProduceStart hasn't been called yet.
// We call it here, so it can go through our normal error handling // We call it here, so it can go through our normal error handling
// and respond with a 500 if an OnStarting callback throws. // and respond with a 500 if an OnStarting callback throws.
if (!_responseStarted) if (!_responseStarted)
{ {
FireOnStarting(); await FireOnStarting();
} }
}
catch (Exception ex) await FireOnCompleted();
{
Log.ApplicationError(ex); await ProduceEnd();
error = ex;
}
finally
{
FireOnCompleted();
ProduceEnd(error);
} }
terminated = !_keepAlive; terminated = !_keepAlive;
@ -250,7 +250,7 @@ namespace Microsoft.AspNet.Server.Kestrel.Http
} }
} }
private void FireOnStarting() private async Task FireOnStarting()
{ {
List<KeyValuePair<Func<object, Task>, object>> onStarting = null; List<KeyValuePair<Func<object, Task>, object>> onStarting = null;
lock (_onStartingSync) lock (_onStartingSync)
@ -262,12 +262,19 @@ namespace Microsoft.AspNet.Server.Kestrel.Http
{ {
foreach (var entry in onStarting) foreach (var entry in onStarting)
{ {
entry.Key.Invoke(entry.Value).Wait(); try
{
await entry.Key.Invoke(entry.Value);
}
catch (Exception ex)
{
ReportApplicationError(ex);
}
} }
} }
} }
private void FireOnCompleted() private async Task FireOnCompleted()
{ {
List<KeyValuePair<Func<object, Task>, object>> onCompleted = null; List<KeyValuePair<Func<object, Task>, object>> onCompleted = null;
lock (_onCompletedSync) lock (_onCompletedSync)
@ -281,11 +288,11 @@ namespace Microsoft.AspNet.Server.Kestrel.Http
{ {
try try
{ {
entry.Key.Invoke(entry.Value).Wait(); await entry.Key.Invoke(entry.Value);
} }
catch catch (Exception ex)
{ {
// Ignore exceptions ReportApplicationError(ex);
} }
} }
} }
@ -293,19 +300,19 @@ namespace Microsoft.AspNet.Server.Kestrel.Http
public void Flush() public void Flush()
{ {
ProduceStart(immediate: false); ProduceStartAndFireOnStarting(immediate: false).GetAwaiter().GetResult();
SocketOutput.Write(_emptyData, immediate: true); SocketOutput.Write(_emptyData, immediate: true);
} }
public Task FlushAsync(CancellationToken cancellationToken) public async Task FlushAsync(CancellationToken cancellationToken)
{ {
ProduceStart(immediate: false); await ProduceStartAndFireOnStarting(immediate: false);
return SocketOutput.WriteAsync(_emptyData, immediate: true); await SocketOutput.WriteAsync(_emptyData, immediate: true);
} }
public void Write(ArraySegment<byte> data) public void Write(ArraySegment<byte> data)
{ {
ProduceStart(immediate: false); ProduceStartAndFireOnStarting(immediate: false).GetAwaiter().GetResult();
if (_autoChunk) if (_autoChunk)
{ {
@ -321,21 +328,21 @@ namespace Microsoft.AspNet.Server.Kestrel.Http
} }
} }
public Task WriteAsync(ArraySegment<byte> data, CancellationToken cancellationToken) public async Task WriteAsync(ArraySegment<byte> data, CancellationToken cancellationToken)
{ {
ProduceStart(immediate: false); await ProduceStartAndFireOnStarting(immediate: false);
if (_autoChunk) if (_autoChunk)
{ {
if (data.Count == 0) if (data.Count == 0)
{ {
return TaskUtilities.CompletedTask; return;
} }
return WriteChunkedAsync(data, cancellationToken); await WriteChunkedAsync(data, cancellationToken);
} }
else else
{ {
return SocketOutput.WriteAsync(data, immediate: true, cancellationToken: cancellationToken); await SocketOutput.WriteAsync(data, immediate: true, cancellationToken: cancellationToken);
} }
} }
@ -387,12 +394,6 @@ namespace Microsoft.AspNet.Server.Kestrel.Http
SocketOutput.Write(_endChunkedResponseBytes, immediate: true); SocketOutput.Write(_endChunkedResponseBytes, immediate: true);
} }
public void Upgrade(IDictionary<string, object> options, Func<object, Task> callback)
{
_keepAlive = false;
ProduceStart();
}
private static ArraySegment<byte> CreateAsciiByteArraySegment(string text) private static ArraySegment<byte> CreateAsciiByteArraySegment(string text)
{ {
var bytes = Encoding.ASCII.GetBytes(text); var bytes = Encoding.ASCII.GetBytes(text);
@ -412,23 +413,38 @@ namespace Microsoft.AspNet.Server.Kestrel.Http
} }
} }
public void ProduceStart(bool immediate = true, bool appCompleted = false) public async Task ProduceStartAndFireOnStarting(bool immediate = true)
{
if (_responseStarted) return;
await FireOnStarting();
if (_applicationFailed)
{
throw new ObjectDisposedException(typeof(Frame).FullName);
}
await ProduceStart(immediate, appCompleted: false);
}
private async Task ProduceStart(bool immediate, bool appCompleted)
{ {
// ProduceStart shouldn't no-op in the future just b/c FireOnStarting throws.
if (_responseStarted) return; if (_responseStarted) return;
FireOnStarting();
_responseStarted = true; _responseStarted = true;
var status = ReasonPhrases.ToStatus(StatusCode, ReasonPhrase); var status = ReasonPhrases.ToStatus(StatusCode, ReasonPhrase);
var responseHeader = CreateResponseHeader(status, appCompleted); var responseHeader = CreateResponseHeader(status, appCompleted);
SocketOutput.Write(responseHeader.Item1, immediate: immediate);
responseHeader.Item2.Dispose(); using (responseHeader.Item2)
{
await SocketOutput.WriteAsync(responseHeader.Item1, immediate: immediate);
}
} }
public void ProduceEnd(Exception ex) private async Task ProduceEnd()
{ {
if (ex != null) if (_applicationFailed)
{ {
if (_responseStarted) if (_responseStarted)
{ {
@ -450,7 +466,7 @@ namespace Microsoft.AspNet.Server.Kestrel.Http
} }
} }
ProduceStart(immediate: true, appCompleted: true); await ProduceStart(immediate: true, appCompleted: true);
// _autoChunk should be checked after we are sure ProduceStart() has been called // _autoChunk should be checked after we are sure ProduceStart() has been called
// since ProduceStart() may set _autoChunk to true. // since ProduceStart() may set _autoChunk to true.
@ -728,5 +744,11 @@ namespace Microsoft.AspNet.Server.Kestrel.Http
statusCode != 205 && statusCode != 205 &&
statusCode != 304; statusCode != 304;
} }
private void ReportApplicationError(Exception ex)
{
_applicationFailed = true;
Log.ApplicationError(ex);
}
} }
} }

51
test/Microsoft.AspNet.Server.KestrelTests/EngineTests.cs
View File

@ -550,7 +550,7 @@ namespace Microsoft.AspNet.Server.KestrelTests
[MemberData(nameof(ConnectionFilterData))] [MemberData(nameof(ConnectionFilterData))]
public async Task ThrowingResultsIn500Response(ServiceContext testContext) public async Task ThrowingResultsIn500Response(ServiceContext testContext)
{ {
bool onStartingCalled = false; var onStartingCallCount = 0;
var testLogger = new TestApplicationErrorLogger(); var testLogger = new TestApplicationErrorLogger();
testContext.Log = new KestrelTrace(testLogger); testContext.Log = new KestrelTrace(testLogger);
@ -560,7 +560,7 @@ namespace Microsoft.AspNet.Server.KestrelTests
var response = frame.Get<IHttpResponseFeature>(); var response = frame.Get<IHttpResponseFeature>();
response.OnStarting(_ => response.OnStarting(_ =>
{ {
onStartingCalled = true; onStartingCallCount++;
return Task.FromResult<object>(null); return Task.FromResult<object>(null);
}, null); }, null);
@ -597,7 +597,7 @@ namespace Microsoft.AspNet.Server.KestrelTests
"", "",
""); "");
Assert.False(onStartingCalled); Assert.Equal(2, onStartingCallCount);
Assert.Equal(2, testLogger.ApplicationErrorsLogged); Assert.Equal(2, testLogger.ApplicationErrorsLogged);
} }
} }
@ -758,22 +758,30 @@ namespace Microsoft.AspNet.Server.KestrelTests
[Theory] [Theory]
[MemberData(nameof(ConnectionFilterData))] [MemberData(nameof(ConnectionFilterData))]
public async Task ThrowingInOnStartingResultsIn500Response(ServiceContext testContext) public async Task ThrowingInOnStartingResultsInFailedWritesAnd500Response(ServiceContext testContext)
{ {
using (var server = new TestServer(frame => var onStartingCallCount = 0;
var failedWriteCount = 0;
var testLogger = new TestApplicationErrorLogger();
testContext.Log = new KestrelTrace(testLogger);
using (var server = new TestServer(async frame =>
{ {
var response = frame.Get<IHttpResponseFeature>(); var response = frame.Get<IHttpResponseFeature>();
response.OnStarting(_ => response.OnStarting(_ =>
{ {
onStartingCallCount++;
throw new Exception(); throw new Exception();
}, null); }, null);
response.Headers.Clear(); response.Headers.Clear();
response.Headers["Content-Length"] = new[] { "11" }; response.Headers["Content-Length"] = new[] { "11" };
// If we write to the response stream, we will not get a 500. await Assert.ThrowsAsync<ObjectDisposedException>(async () =>
await response.Body.WriteAsync(Encoding.ASCII.GetBytes("Hello World"), 0, 11));
return Task.FromResult<object>(null); failedWriteCount++;
}, testContext)) }, testContext))
{ {
using (var connection = new TestConnection()) using (var connection = new TestConnection())
@ -802,34 +810,31 @@ namespace Microsoft.AspNet.Server.KestrelTests
"Connection: close", "Connection: close",
"", "",
""); "");
Assert.Equal(2, onStartingCallCount);
Assert.Equal(2, testLogger.ApplicationErrorsLogged);
} }
} }
} }
[Theory]
[MemberData(nameof(ConnectionFilterData))] [MemberData(nameof(ConnectionFilterData))]
public async Task ThrowingInOnStartingResultsInFailedWrites(ServiceContext testContext) public async Task ThrowingInOnCompletedIsLoggedAndClosesConnection(ServiceContext testContext)
{ {
var testLogger = new TestApplicationErrorLogger();
testContext.Log = new KestrelTrace(testLogger);
using (var server = new TestServer(async frame => using (var server = new TestServer(async frame =>
{ {
var onStartingException = new Exception();
var response = frame.Get<IHttpResponseFeature>(); var response = frame.Get<IHttpResponseFeature>();
response.OnStarting(_ => response.OnCompleted(_ =>
{ {
throw onStartingException; throw new Exception();
}, null); }, null);
response.Headers.Clear(); response.Headers.Clear();
response.Headers["Content-Length"] = new[] { "11" }; response.Headers["Content-Length"] = new[] { "11" };
var writeException = await Assert.ThrowsAsync<Exception>(async () => await response.Body.WriteAsync(Encoding.ASCII.GetBytes("Hello World"), 0, 11);
await response.Body.WriteAsync(Encoding.ASCII.GetBytes("Hello World"), 0, 11));
Assert.Same(onStartingException, writeException);
// The second write should succeed since the OnStarting callback will not be called again
await response.Body.WriteAsync(Encoding.ASCII.GetBytes("Exception!!"), 0, 11);
}, testContext)) }, testContext))
{ {
using (var connection = new TestConnection()) using (var connection = new TestConnection())
@ -838,12 +843,14 @@ namespace Microsoft.AspNet.Server.KestrelTests
"GET / HTTP/1.1", "GET / HTTP/1.1",
"", "",
""); "");
await connection.Receive( await connection.ReceiveEnd(
"HTTP/1.1 200 OK", "HTTP/1.1 200 OK",
"Content-Length: 11", "Content-Length: 11",
"", "",
"Exception!!"); ; "Hello World");
} }
Assert.Equal(1, testLogger.ApplicationErrorsLogged);
} }
} }