Skip to content

Stop retrying http requests when script invocation result is failed #11210

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.

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

Open
wants to merge 4 commits into
base: dev
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
11 changes: 9 additions & 2 deletions src/WebJobs.Script/Http/DefaultHttpProxyService.cs
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ internal class DefaultHttpProxyService : IHttpProxyService, IDisposable
private readonly HttpMessageInvoker _messageInvoker;
private readonly ForwarderRequestConfig _forwarderRequestConfig;
private readonly ILogger<DefaultHttpProxyService> _logger;
private readonly HttpTransformer _httpTransformer;

public DefaultHttpProxyService(IHttpForwarder httpForwarder, ILogger<DefaultHttpProxyService> logger)
{
Expand All @@ -39,6 +40,8 @@ public DefaultHttpProxyService(IHttpForwarder httpForwarder, ILogger<DefaultHttp
{
ActivityTimeout = TimeSpan.FromSeconds(240)
};

_httpTransformer = new ScriptInvocationRequestTransformer();
}

public void Dispose()
Expand Down Expand Up @@ -98,8 +101,12 @@ public void StartForwarding(ScriptInvocationContext context, Uri httpUri)
// add invocation id as correlation id, override existing header if present
httpRequest.Headers[ScriptConstants.HttpProxyCorrelationHeader] = context.ExecutionContext.InvocationId.ToString();

var forwardingTask = _httpForwarder.SendAsync(httpContext, httpUri.ToString(), _messageInvoker, _forwarderRequestConfig).AsTask();
// Add the script invocation context for later observation of the ScriptInvocationResult task.
// This helps track failures/cancellations that should halt retrying the http request.
httpContext.Items[ScriptConstants.HttpProxyScriptInvocationContext] = context;

var forwardingTask = _httpForwarder.SendAsync(httpContext, httpUri.ToString(), _messageInvoker, _forwarderRequestConfig, _httpTransformer).AsTask();
context.Properties[ScriptConstants.HttpProxyTask] = forwardingTask;
}
}
}
}
14 changes: 14 additions & 0 deletions src/WebJobs.Script/Http/RetryProxyHandler.cs
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
using System.Net.Http;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.Azure.WebJobs.Script.Description;
using Microsoft.Azure.WebJobs.Script.Exceptions;
using Microsoft.Extensions.Logging;

namespace Microsoft.Azure.WebJobs.Script.Http
Expand All @@ -30,11 +32,23 @@ public RetryProxyHandler(HttpMessageHandler innerHandler, ILogger logger)

protected override async Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
{
TaskCompletionSource<ScriptInvocationResult> resultSource = null;
if (request.Options.TryGetValue(ScriptConstants.HttpProxyScriptInvocationContext, out ScriptInvocationContext scriptInvocationContext))
{
resultSource = scriptInvocationContext.ResultSource;
}

var currentDelay = InitialDelay;
for (int attemptCount = 1; attemptCount <= MaxRetries; attemptCount++)
{
try
{
if (resultSource is not null && resultSource.Task.IsFaulted)
{
throw resultSource.Task.Exception.InnerException ??
new Exception($"The function invocation tied to this HTTP request failed. Invocation ID: {scriptInvocationContext.ExecutionContext.InvocationId}");
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Still undecided on what exception to throw here - we don't want to throw something that will cause retries (see below lines), but what makes the most sense (some cancellation-related exception? do we change the check for HttpRequestException below so we don't retry in some cases?

}

return await base.SendAsync(request, cancellationToken);
}
catch (TaskCanceledException) when (cancellationToken.IsCancellationRequested)
Expand Down
28 changes: 28 additions & 0 deletions src/WebJobs.Script/Http/ScriptInvocationRequestTransformer.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
// Copyright (c) .NET Foundation. All rights reserved.
// Licensed under the MIT License. See License.txt in the project root for license information.

using System.Collections.Generic;
using System.Net.Http;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Http;
using Microsoft.Azure.WebJobs.Script.Description;
using Yarp.ReverseProxy.Forwarder;

namespace Microsoft.Azure.WebJobs.Script.Http
{
internal sealed class ScriptInvocationRequestTransformer : HttpTransformer
{
public override async ValueTask TransformRequestAsync(HttpContext httpContext, HttpRequestMessage proxyRequest, string destinationPrefix, CancellationToken cancellationToken)
{
// this preserves previous behavior (which called the default transformer) - base method is also called inside of here
await HttpTransformer.Default.TransformRequestAsync(httpContext, proxyRequest, destinationPrefix, cancellationToken);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel calling await base.TransformRequestAsync instead here provides more clarity. you can also remove the comment.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It has to be HttpTransformer.Default.TransformRequestAsync - the base method does not add the X-Forwarded headers. I can remove the comment since tests should be able to catch if this is changed, but I wanted to make sure it was clear that choosing this method was intentional.


if (httpContext.Items.TryGetValue(ScriptConstants.HttpProxyScriptInvocationContext, out object result)
&& result is ScriptInvocationContext scriptContext)
{
proxyRequest.Options.TryAdd(ScriptConstants.HttpProxyScriptInvocationContext, scriptContext);
}
}
}
}
1 change: 1 addition & 0 deletions src/WebJobs.Script/ScriptConstants.cs
Original file line number Diff line number Diff line change
Expand Up @@ -261,6 +261,7 @@ public static class ScriptConstants
public static readonly string HttpProxyingEnabled = "HttpProxyingEnabled";
public static readonly string HttpProxyCorrelationHeader = "x-ms-invocation-id";
public static readonly string HttpProxyTask = "HttpProxyTask";
public static readonly string HttpProxyScriptInvocationContext = "HttpProxyScriptInvocationContext";

public static readonly string OperationNameKey = "OperationName";

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
using Xunit;
using Yarp.ReverseProxy.Forwarder;

namespace Microsoft.Azure.WebJobs.Script.Tests
namespace Microsoft.Azure.WebJobs.Script.Tests.Http
{
public class DefaultHttpProxyServiceTests
{
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,199 @@
// Copyright (c) .NET Foundation. All rights reserved.
// Licensed under the MIT License. See License.txt in the project root for license information.

using System;
using System.Net.Http;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Http;
using Microsoft.Azure.WebJobs.Script.Description;
using Microsoft.Azure.WebJobs.Script.Http;
using Xunit;

namespace Microsoft.Azure.WebJobs.Script.Tests.Http
{
public class ScriptInvocationRequestTransformerTests
{
private readonly ScriptInvocationRequestTransformer _transformer;

public ScriptInvocationRequestTransformerTests()
{
_transformer = new ScriptInvocationRequestTransformer();
}

[Theory]
[InlineData(true)]
[InlineData(false)]
public async Task TransformRequestAsync_IncludesXForwardedHeaders(bool includeScriptInvocationContext)
{
var httpContext = new DefaultHttpContext();
httpContext.Request.Scheme = "https";
httpContext.Request.Host = new HostString("example.com", 443);
httpContext.Request.PathBase = "/api";
httpContext.Request.Path = "/test";
httpContext.Request.QueryString = new QueryString("?param=value");

var remoteAddress = "192.168.1.100";
httpContext.Connection.RemoteIpAddress = System.Net.IPAddress.Parse(remoteAddress);

if (includeScriptInvocationContext)
{
var scriptContext = new ScriptInvocationContext
{
FunctionMetadata = new FunctionMetadata { Name = "TestFunction" },
ExecutionContext = new ExecutionContext { InvocationId = Guid.NewGuid() }
};

httpContext.Items[ScriptConstants.HttpProxyScriptInvocationContext] = scriptContext;
}

var proxyRequest = new HttpRequestMessage(HttpMethod.Get, "http://localhost:7071/api/test");
const string destinationPrefix = "http://localhost:7071";

await _transformer.TransformRequestAsync(httpContext, proxyRequest, destinationPrefix, CancellationToken.None);

Assert.True(proxyRequest.Headers.Contains("X-Forwarded-For"), "X-Forwarded-For header should be present");
Assert.True(proxyRequest.Headers.Contains("X-Forwarded-Host"), "X-Forwarded-Host header should be present");
Assert.True(proxyRequest.Headers.Contains("X-Forwarded-Proto"), "X-Forwarded-Proto header should be present");

var forwardedFor = proxyRequest.Headers.GetValues("X-Forwarded-For");
Assert.Contains(remoteAddress, forwardedFor);

var forwardedHost = proxyRequest.Headers.GetValues("X-Forwarded-Host");
Assert.Contains("example.com:443", forwardedHost);

var forwardedProto = proxyRequest.Headers.GetValues("X-Forwarded-Proto");
Assert.Contains("https", forwardedProto);
}

[Fact]
public async Task TransformRequestAsync_WithScriptInvocationContext_AddsContextToRequestOptions()
{
var httpContext = new DefaultHttpContext();
httpContext.Request.Scheme = "http";
httpContext.Request.Host = new HostString("localhost", 7071);
var remoteAddress = "192.168.1.100";
httpContext.Connection.RemoteIpAddress = System.Net.IPAddress.Parse(remoteAddress);

var scriptContext = new ScriptInvocationContext
{
FunctionMetadata = new FunctionMetadata { Name = "TestFunction" },
ExecutionContext = new ExecutionContext { InvocationId = Guid.NewGuid() }
};

httpContext.Items[ScriptConstants.HttpProxyScriptInvocationContext] = scriptContext;

var proxyRequest = new HttpRequestMessage(HttpMethod.Get, "http://localhost:7071/api/test");
const string destinationPrefix = "http://localhost:7071";

await _transformer.TransformRequestAsync(httpContext, proxyRequest, destinationPrefix, CancellationToken.None);

Assert.True(proxyRequest.Options.TryGetValue(ScriptConstants.HttpProxyScriptInvocationContext, out ScriptInvocationContext contextValue));
Assert.Equal(scriptContext.ExecutionContext.InvocationId, contextValue.ExecutionContext.InvocationId);

Assert.True(proxyRequest.Headers.Contains("X-Forwarded-For"));
Assert.True(proxyRequest.Headers.Contains("X-Forwarded-Host"));
Assert.True(proxyRequest.Headers.Contains("X-Forwarded-Proto"));
}

[Fact]
public async Task TransformRequestAsync_PreservesExistingXForwardedHeaders()
{
var httpContext = new DefaultHttpContext();
httpContext.Request.Scheme = "https";
httpContext.Request.Host = new HostString("proxy.example.com");
var requestRemoteAddress = "172.16.0.1";
httpContext.Connection.RemoteIpAddress = System.Net.IPAddress.Parse(requestRemoteAddress);

// Add existing X-Forwarded headers to simulate request through multiple proxies
var originalFor = "203.0.113.195," + requestRemoteAddress;
var originalHost = "proxy.example.com";
var originalProto = "https";
httpContext.Request.Headers["X-Forwarded-For"] = originalFor;
httpContext.Request.Headers["X-Forwarded-Host"] = originalHost;
httpContext.Request.Headers["X-Forwarded-Proto"] = originalProto;

var proxyRequest = new HttpRequestMessage(HttpMethod.Get, "http://localhost:7071/api/test");
const string destinationPrefix = "http://localhost:7071";

await _transformer.TransformRequestAsync(httpContext, proxyRequest, destinationPrefix, CancellationToken.None);

Assert.True(proxyRequest.Headers.Contains("X-Forwarded-For"));
Assert.True(proxyRequest.Headers.Contains("X-Forwarded-Host"));
Assert.True(proxyRequest.Headers.Contains("X-Forwarded-Proto"));

var forwardedFor = proxyRequest.Headers.GetValues("X-Forwarded-For");
Assert.Contains(requestRemoteAddress, forwardedFor);

var forwardedHost = proxyRequest.Headers.GetValues("X-Forwarded-Host");
Assert.Contains(originalHost, forwardedHost);

var forwardedProto = proxyRequest.Headers.GetValues("X-Forwarded-Proto");
Assert.Contains(originalProto, forwardedProto);
}

[Fact]
public async Task TransformRequestAsync_PreservesStandardRequestHeaders()
{
var httpContext = new DefaultHttpContext();
httpContext.Request.Scheme = "https";
httpContext.Request.Host = new HostString("example.com");
httpContext.Request.Path = "/api/test";
var remoteAddress = "192.168.1.100";
httpContext.Connection.RemoteIpAddress = System.Net.IPAddress.Parse(remoteAddress);

// Add various standard headers that should be preserved
httpContext.Request.Headers["Authorization"] = "Bearer token123";
httpContext.Request.Headers["User-Agent"] = "TestClient/1.0";
httpContext.Request.Headers["Accept"] = "application/json";
httpContext.Request.Headers["Content-Type"] = "application/json";
httpContext.Request.Headers["X-Custom-Header"] = "custom-value";
httpContext.Request.Headers["Cache-Control"] = "no-cache";
httpContext.Request.Headers["Accept-Encoding"] = "gzip, deflate";

var proxyRequest = new HttpRequestMessage(HttpMethod.Post, "http://localhost:7071/api/test");
const string destinationPrefix = "http://localhost:7071";

await _transformer.TransformRequestAsync(httpContext, proxyRequest, destinationPrefix, CancellationToken.None);

// Verify that standard headers are preserved
Assert.True(proxyRequest.Headers.Contains("Authorization"), "Authorization header should be preserved");
Assert.True(proxyRequest.Headers.Contains("User-Agent"), "User-Agent header should be preserved");
Assert.True(proxyRequest.Headers.Contains("Accept"), "Accept header should be preserved");
Assert.True(proxyRequest.Headers.Contains("X-Custom-Header"), "Custom headers should be preserved");
Assert.True(proxyRequest.Headers.Contains("Cache-Control"), "Cache-Control header should be preserved");
Assert.True(proxyRequest.Headers.Contains("Accept-Encoding"), "Accept-Encoding header should be preserved");

// Verify header values
var authHeader = proxyRequest.Headers.GetValues("Authorization");
Assert.Contains("Bearer token123", authHeader);

var userAgentHeader = proxyRequest.Headers.GetValues("User-Agent");
Assert.Contains("TestClient/1.0", userAgentHeader);

var acceptHeader = proxyRequest.Headers.GetValues("Accept");
Assert.Contains("application/json", acceptHeader);

var customHeader = proxyRequest.Headers.GetValues("X-Custom-Header");
Assert.Contains("custom-value", customHeader);

var cacheControlHeader = proxyRequest.Headers.GetValues("Cache-Control");
Assert.Contains("no-cache", cacheControlHeader);

var acceptEncodingHeader = proxyRequest.Headers.GetValues("Accept-Encoding");
Assert.Contains("gzip", acceptEncodingHeader);
Assert.Contains("deflate", acceptEncodingHeader);

// Verify that Content-Type is properly handled for the request content
if (proxyRequest.Content != null)
{
Assert.Equal("application/json", proxyRequest.Content.Headers.ContentType?.MediaType);
}

// Also verify X-Forwarded headers are still added
Assert.True(proxyRequest.Headers.Contains("X-Forwarded-For"));
Assert.True(proxyRequest.Headers.Contains("X-Forwarded-Host"));
Assert.True(proxyRequest.Headers.Contains("X-Forwarded-Proto"));
}
}
}
Loading
Loading