Skip to content

Handle IIS OnCompleted callbacks later #17756

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

Merged
merged 2 commits into from
Dec 11, 2019
Merged

Handle IIS OnCompleted callbacks later #17756

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
f7b4651
Handle IIS OnCompleted callbacks later #17268
Tratcher Dec 10, 2019
28d14db
Add negative test
Tratcher Dec 11, 2019
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
15 changes: 2 additions & 13 deletions src/Servers/IIS/IIS/src/Core/IISHttpContext.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -409,7 +409,7 @@ public unsafe void SetResponseHeaders()
}
}

public abstract Task<bool> ProcessRequestAsync();
public abstract Task ProcessRequestAsync();

public void OnStarting(Func<object, Task> callback, object state)
{
Expand Down Expand Up @@ -599,30 +599,19 @@ public void Execute()

private async Task HandleRequest()
{
bool successfulRequest = false;
try
{
successfulRequest = await ProcessRequestAsync();
await ProcessRequestAsync();
}
catch (Exception ex)
{
_logger.LogError(0, ex, $"Unexpected exception in {nameof(IISHttpContext)}.{nameof(HandleRequest)}.");
}
finally
{
// Post completion after completing the request to resume the state machine
PostCompletion(ConvertRequestCompletionResults(successfulRequest));


// Dispose the context
Dispose();
}
}

private static NativeMethods.REQUEST_NOTIFICATION_STATUS ConvertRequestCompletionResults(bool success)
{
return success ? NativeMethods.REQUEST_NOTIFICATION_STATUS.RQ_NOTIFICATION_CONTINUE
: NativeMethods.REQUEST_NOTIFICATION_STATUS.RQ_NOTIFICATION_FINISH_REQUEST;
}
}
}
106 changes: 59 additions & 47 deletions src/Servers/IIS/IIS/src/Core/IISHttpContextOfT.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,32 +21,33 @@ public IISHttpContextOfT(MemoryPool<byte> memoryPool, IHttpApplication<TContext>
_application = application;
}

public override async Task<bool> ProcessRequestAsync()
public override async Task ProcessRequestAsync()
{
InitializeContext();

var context = default(TContext);
var success = true;

try
{
context = _application.CreateContext(this);
InitializeContext();

try
{
context = _application.CreateContext(this);

await _application.ProcessRequestAsync(context);
}
catch (BadHttpRequestException ex)
{
SetBadRequestState(ex);
ReportApplicationError(ex);
success = false;
}
catch (Exception ex)
{
ReportApplicationError(ex);
success = false;
}

await _application.ProcessRequestAsync(context);
}
catch (BadHttpRequestException ex)
{
SetBadRequestState(ex);
ReportApplicationError(ex);
success = false;
}
catch (Exception ex)
{
ReportApplicationError(ex);
success = false;
}
finally
{
await CompleteResponseBodyAsync();
_streams.Stop();

Expand All @@ -56,36 +57,18 @@ public override async Task<bool> ProcessRequestAsync()
// Dispose
}

if (_onCompleted != null)
if (!_requestAborted)
{
await FireOnCompleted();
await ProduceEnd();
}
else if (!HasResponseStarted && _requestRejectedException == null)
{
// If the request was aborted and no response was sent, there's no
// meaningful status code to log.
StatusCode = 0;
success = false;
}
}

if (!_requestAborted)
{
await ProduceEnd();
}
else if (!HasResponseStarted && _requestRejectedException == null)
{
// If the request was aborted and no response was sent, there's no
// meaningful status code to log.
StatusCode = 0;
success = false;
}

try
{
_application.DisposeContext(context, _applicationException);
}
catch (Exception ex)
{
// TODO Log this
_applicationException = _applicationException ?? ex;
success = false;
}
finally
{
// Complete response writer and request reader pipe sides
_bodyOutput.Dispose();
_bodyInputPipe?.Reader.Complete();
Expand All @@ -104,7 +87,36 @@ public override async Task<bool> ProcessRequestAsync()
await _readBodyTask;
}
}
return success;
catch (Exception ex)
{
success = false;
ReportApplicationError(ex);
}
finally
{
// We're done with anything that touches the request or response, unblock the client.
PostCompletion(ConvertRequestCompletionResults(success));

if (_onCompleted != null)
{
await FireOnCompleted();
}

try
{
_application.DisposeContext(context, _applicationException);
}
catch (Exception ex)
{
ReportApplicationError(ex);
}
}
}

private static NativeMethods.REQUEST_NOTIFICATION_STATUS ConvertRequestCompletionResults(bool success)
{
return success ? NativeMethods.REQUEST_NOTIFICATION_STATUS.RQ_NOTIFICATION_CONTINUE
: NativeMethods.REQUEST_NOTIFICATION_STATUS.RQ_NOTIFICATION_FINISH_REQUEST;
}
}
}
7 changes: 7 additions & 0 deletions src/Servers/IIS/IIS/test/Common.FunctionalTests/Inprocess/ResponseBodyTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,5 +30,12 @@ public async Task ResponseBodyTest_FlushedPipeAndThenUnflushedPipe_AutoFlushed()
{
Assert.Equal(20, (await _fixture.Client.GetByteArrayAsync($"/FlushedPipeAndThenUnflushedPipe")).Length);
}

[ConditionalFact]
[RequiresNewHandler]
public async Task ResponseBodyTest_BodyCompletionNotBlockedByOnCompleted()
{
Assert.Equal("SlowOnCompleted", await _fixture.Client.GetStringAsync($"/SlowOnCompleted"));
}
}
}
7 changes: 7 additions & 0 deletions src/Servers/IIS/IIS/test/testassets/InProcessWebSite/Startup.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1016,5 +1016,12 @@ public async Task HTTPS_PORT(HttpContext context)

await context.Response.WriteAsync(httpsPort.HasValue ? httpsPort.Value.ToString() : "NOVALUE");
}

public async Task SlowOnCompleted(HttpContext context)
{
// This shouldn't block the response or the server from shutting down.
context.Response.OnCompleted(() => Task.Delay(TimeSpan.FromMinutes(5)));
await context.Response.WriteAsync("SlowOnCompleted");
}
}
}