Call OnStarting before verifying response length (#1289).

This commit is contained in:
Cesar Blum Silveira 2017-01-10 14:12:07 -08:00
parent cf77813c82
commit e26f91a392
3 changed files with 226 additions and 22 deletions

View File

@ -533,23 +533,29 @@ namespace Microsoft.AspNetCore.Server.Kestrel.Internal.Http
public void Flush() public void Flush()
{ {
ProduceStartAndFireOnStarting().GetAwaiter().GetResult(); InitializeResponse(0).GetAwaiter().GetResult();
Output.Flush(); Output.Flush();
} }
public async Task FlushAsync(CancellationToken cancellationToken) public async Task FlushAsync(CancellationToken cancellationToken)
{ {
await ProduceStartAndFireOnStarting(); await InitializeResponse(0);
await Output.FlushAsync(cancellationToken); await Output.FlushAsync(cancellationToken);
} }
public void Write(ArraySegment<byte> data) public void Write(ArraySegment<byte> data)
{ {
// For the first write, ensure headers are flushed if Write(Chunked)isn't called. // For the first write, ensure headers are flushed if Write(Chunked) isn't called.
var firstWrite = !HasResponseStarted; var firstWrite = !HasResponseStarted;
VerifyAndUpdateWrite(data.Count); if (firstWrite)
ProduceStartAndFireOnStarting().GetAwaiter().GetResult(); {
InitializeResponse(data.Count).GetAwaiter().GetResult();
}
else
{
VerifyAndUpdateWrite(data.Count);
}
if (_canHaveBody) if (_canHaveBody)
{ {
@ -616,9 +622,7 @@ namespace Microsoft.AspNetCore.Server.Kestrel.Internal.Http
public async Task WriteAsyncAwaited(ArraySegment<byte> data, CancellationToken cancellationToken) public async Task WriteAsyncAwaited(ArraySegment<byte> data, CancellationToken cancellationToken)
{ {
VerifyAndUpdateWrite(data.Count); await InitializeResponseAwaited(data.Count);
await ProduceStartAndFireOnStarting();
// WriteAsyncAwaited is only called for the first write to the body. // WriteAsyncAwaited is only called for the first write to the body.
// Ensure headers are flushed if Write(Chunked)Async isn't called. // Ensure headers are flushed if Write(Chunked)Async isn't called.
@ -734,7 +738,7 @@ namespace Microsoft.AspNetCore.Server.Kestrel.Internal.Http
} }
} }
public Task ProduceStartAndFireOnStarting() public Task InitializeResponse(int firstWriteByteCount)
{ {
if (HasResponseStarted) if (HasResponseStarted)
{ {
@ -743,7 +747,7 @@ namespace Microsoft.AspNetCore.Server.Kestrel.Internal.Http
if (_onStarting != null) if (_onStarting != null)
{ {
return ProduceStartAndFireOnStartingAwaited(); return InitializeResponseAwaited(firstWriteByteCount);
} }
if (_applicationException != null) if (_applicationException != null)
@ -751,11 +755,13 @@ namespace Microsoft.AspNetCore.Server.Kestrel.Internal.Http
ThrowResponseAbortedException(); ThrowResponseAbortedException();
} }
VerifyAndUpdateWrite(firstWriteByteCount);
ProduceStart(appCompleted: false); ProduceStart(appCompleted: false);
return TaskCache.CompletedTask; return TaskCache.CompletedTask;
} }
private async Task ProduceStartAndFireOnStartingAwaited() private async Task InitializeResponseAwaited(int firstWriteByteCount)
{ {
await FireOnStarting(); await FireOnStarting();
@ -764,6 +770,7 @@ namespace Microsoft.AspNetCore.Server.Kestrel.Internal.Http
ThrowResponseAbortedException(); ThrowResponseAbortedException();
} }
VerifyAndUpdateWrite(firstWriteByteCount);
ProduceStart(appCompleted: false); ProduceStart(appCompleted: false);
} }

View File

@ -485,7 +485,7 @@ namespace Microsoft.AspNetCore.Server.Kestrel.FunctionalTests
} }
[Fact] [Fact]
public async Task WhenAppWritesMoreThanContentLengthWriteThrowsAndConnectionCloses() public async Task ThrowsAndClosesConnectionWhenAppWritesMoreThanContentLengthWrite()
{ {
var testLogger = new TestApplicationErrorLogger(); var testLogger = new TestApplicationErrorLogger();
var serviceContext = new TestServiceContext { Log = new TestKestrelTrace(testLogger) }; var serviceContext = new TestServiceContext { Log = new TestKestrelTrace(testLogger) };
@ -520,7 +520,7 @@ namespace Microsoft.AspNetCore.Server.Kestrel.FunctionalTests
} }
[Fact] [Fact]
public async Task WhenAppWritesMoreThanContentLengthWriteAsyncThrowsAndConnectionCloses() public async Task ThrowsAndClosesConnectionWhenAppWritesMoreThanContentLengthWriteAsync()
{ {
var testLogger = new TestApplicationErrorLogger(); var testLogger = new TestApplicationErrorLogger();
var serviceContext = new TestServiceContext { Log = new TestKestrelTrace(testLogger) }; var serviceContext = new TestServiceContext { Log = new TestKestrelTrace(testLogger) };
@ -554,15 +554,52 @@ namespace Microsoft.AspNetCore.Server.Kestrel.FunctionalTests
} }
[Fact] [Fact]
public async Task WhenAppWritesMoreThanContentLengthAndResponseNotStarted500ResponseSentAndConnectionCloses() public async Task InternalServerErrorAndConnectionClosedOnWriteWithMoreThanContentLengthAndResponseNotStarted()
{ {
var testLogger = new TestApplicationErrorLogger(); var testLogger = new TestApplicationErrorLogger();
var serviceContext = new TestServiceContext { Log = new TestKestrelTrace(testLogger) }; var serviceContext = new TestServiceContext { Log = new TestKestrelTrace(testLogger) };
using (var server = new TestServer(async httpContext => using (var server = new TestServer(httpContext =>
{ {
var response = Encoding.ASCII.GetBytes("hello, world");
httpContext.Response.ContentLength = 5; httpContext.Response.ContentLength = 5;
await httpContext.Response.WriteAsync("hello, world"); httpContext.Response.Body.Write(response, 0, response.Length);
return TaskCache.CompletedTask;
}, serviceContext))
{
using (var connection = server.CreateConnection())
{
await connection.Send(
"GET / HTTP/1.1",
"",
"");
await connection.ReceiveForcedEnd(
$"HTTP/1.1 500 Internal Server Error",
"Connection: close",
$"Date: {server.Context.DateHeaderValue}",
"Content-Length: 0",
"",
"");
}
}
var logMessage = Assert.Single(testLogger.Messages, message => message.LogLevel == LogLevel.Error);
Assert.Equal(
$"Response Content-Length mismatch: too many bytes written (12 of 5).",
logMessage.Exception.Message);
}
[Fact]
public async Task InternalServerErrorAndConnectionClosedOnWriteAsyncWithMoreThanContentLengthAndResponseNotStarted()
{
var testLogger = new TestApplicationErrorLogger();
var serviceContext = new TestServiceContext { Log = new TestKestrelTrace(testLogger) };
using (var server = new TestServer(httpContext =>
{
var response = Encoding.ASCII.GetBytes("hello, world");
httpContext.Response.ContentLength = 5;
return httpContext.Response.Body.WriteAsync(response, 0, response.Length);
}, serviceContext)) }, serviceContext))
{ {
using (var connection = server.CreateConnection()) using (var connection = server.CreateConnection())
@ -1065,6 +1102,170 @@ namespace Microsoft.AspNetCore.Server.Kestrel.FunctionalTests
} }
} }
[Fact]
public async Task FirstWriteVerifiedAfterOnStarting()
{
using (var server = new TestServer(httpContext =>
{
httpContext.Response.OnStarting(() =>
{
// Change response to chunked
httpContext.Response.ContentLength = null;
return TaskCache.CompletedTask;
});
var response = Encoding.ASCII.GetBytes("hello, world");
httpContext.Response.ContentLength = response.Length - 1;
// If OnStarting is not run before verifying writes, an error response will be sent.
httpContext.Response.Body.Write(response, 0, response.Length);
return TaskCache.CompletedTask;
}, new TestServiceContext()))
{
using (var connection = server.CreateConnection())
{
await connection.Send(
"GET / HTTP/1.1",
"",
"");
await connection.Receive(
"HTTP/1.1 200 OK",
$"Date: {server.Context.DateHeaderValue}",
$"Transfer-Encoding: chunked",
"",
"c",
"hello, world",
"0",
"",
"");
}
}
}
[Fact]
public async Task SubsequentWriteVerifiedAfterOnStarting()
{
using (var server = new TestServer(httpContext =>
{
httpContext.Response.OnStarting(() =>
{
// Change response to chunked
httpContext.Response.ContentLength = null;
return TaskCache.CompletedTask;
});
var response = Encoding.ASCII.GetBytes("hello, world");
httpContext.Response.ContentLength = response.Length - 1;
// If OnStarting is not run before verifying writes, an error response will be sent.
httpContext.Response.Body.Write(response, 0, response.Length / 2);
httpContext.Response.Body.Write(response, response.Length / 2, response.Length - response.Length / 2);
return TaskCache.CompletedTask;
}, new TestServiceContext()))
{
using (var connection = server.CreateConnection())
{
await connection.Send(
"GET / HTTP/1.1",
"",
"");
await connection.Receive(
"HTTP/1.1 200 OK",
$"Date: {server.Context.DateHeaderValue}",
$"Transfer-Encoding: chunked",
"",
"6",
"hello,",
"6",
" world",
"0",
"",
"");
}
}
}
[Fact]
public async Task FirstWriteAsyncVerifiedAfterOnStarting()
{
using (var server = new TestServer(httpContext =>
{
httpContext.Response.OnStarting(() =>
{
// Change response to chunked
httpContext.Response.ContentLength = null;
return TaskCache.CompletedTask;
});
var response = Encoding.ASCII.GetBytes("hello, world");
httpContext.Response.ContentLength = response.Length - 1;
// If OnStarting is not run before verifying writes, an error response will be sent.
return httpContext.Response.Body.WriteAsync(response, 0, response.Length);
}, new TestServiceContext()))
{
using (var connection = server.CreateConnection())
{
await connection.Send(
"GET / HTTP/1.1",
"",
"");
await connection.Receive(
"HTTP/1.1 200 OK",
$"Date: {server.Context.DateHeaderValue}",
$"Transfer-Encoding: chunked",
"",
"c",
"hello, world",
"0",
"",
"");
}
}
}
[Fact]
public async Task SubsequentWriteAsyncVerifiedAfterOnStarting()
{
using (var server = new TestServer(async httpContext =>
{
httpContext.Response.OnStarting(() =>
{
// Change response to chunked
httpContext.Response.ContentLength = null;
return TaskCache.CompletedTask;
});
var response = Encoding.ASCII.GetBytes("hello, world");
httpContext.Response.ContentLength = response.Length - 1;
// If OnStarting is not run before verifying writes, an error response will be sent.
await httpContext.Response.Body.WriteAsync(response, 0, response.Length / 2);
await httpContext.Response.Body.WriteAsync(response, response.Length / 2, response.Length - response.Length / 2);
}, new TestServiceContext()))
{
using (var connection = server.CreateConnection())
{
await connection.Send(
"GET / HTTP/1.1",
"",
"");
await connection.Receive(
"HTTP/1.1 200 OK",
$"Date: {server.Context.DateHeaderValue}",
$"Transfer-Encoding: chunked",
"",
"6",
"hello,",
"6",
" world",
"0",
"",
"");
}
}
}
public static TheoryData<string, StringValues, string> NullHeaderData public static TheoryData<string, StringValues, string> NullHeaderData
{ {
get get

View File

@ -878,11 +878,7 @@ namespace Microsoft.AspNetCore.Server.KestrelTests
throw onStartingException; throw onStartingException;
}, null); }, null);
response.Headers["Content-Length"] = new[] { "11" }; var writeException = await Assert.ThrowsAsync<ObjectDisposedException>(async () => await response.Body.FlushAsync());
var writeException = await Assert.ThrowsAsync<ObjectDisposedException>(async () =>
await response.Body.WriteAsync(Encoding.ASCII.GetBytes("Hello World"), 0, 11));
Assert.Same(onStartingException, writeException.InnerException); Assert.Same(onStartingException, writeException.InnerException);
failedWriteCount++; failedWriteCount++;
@ -896,7 +892,7 @@ namespace Microsoft.AspNetCore.Server.KestrelTests
"GET / HTTP/1.1", "GET / HTTP/1.1",
"", "",
""); "");
await connection.ReceiveEnd( await connection.Receive(
"HTTP/1.1 500 Internal Server Error", "HTTP/1.1 500 Internal Server Error",
$"Date: {testContext.DateHeaderValue}", $"Date: {testContext.DateHeaderValue}",
"Content-Length: 0", "Content-Length: 0",