ProxyFeature - Add Headers

tobi · May 13, 2022, 1:51pm

Hi demis,
my use case: proxy an api & append some header fields.

docs (https://docs.servicestack.net/proxy-feature):

// Customize the HTTP Request Headers that are sent to downstream server
Action<IHttpRequest, HttpWebRequest> ProxyRequestFilter

How are we supposed to e.g. add a header value?

As soon is i add this line, the proxy wont work anymore:
ProxyRequestFilter = (request, webRequest) => webRequest.Headers.Add("Some-Header", "xxx"),

the ss-api interestingly returns with a 200, but the request never hits my downstream server + there is no response.

request.Headers.Add() throws not implemented exception. my downstream is a simple requestbin.com to test.

Full code:

Plugins.Add(new ProxyFeature(
            matchingRequests: req => req.PathInfo.StartsWith("/proxy-api"),
            resolveUrl: req => $"https://XXXXXXX.x.pipedream.net" + req.RawUrl.Replace("/proxy-api", ""))
        {
            ProxyRequestFilter = (request, webRequest) => webRequest.Headers.Add("XXX", "YYY"),
        });

mythz · May 13, 2022, 2:03pm

That’s how the ProxyFeature is adding the forwarding Request Headers:

github.com

ServiceStack/ServiceStack/blob/1753fc85e472f1a5482ddea0da07275e01d90820/ServiceStack/src/ServiceStack/ProxyFeature.cs#L168


      
          
                  try
                  {
                      if (header.StartsWith(":"))
                      {
                          if (Log.IsDebugEnabled)
                              Log.Debug($"Ignoring Invalid Proxy Request Header '{header}'");
                          continue;
                      }
                      
                      webReq.Headers[header] = httpReq.Headers[header];
                  }
                  catch (Exception e)
                  {
                      Log.Error($"Could not set Proxy Header: {header} = {httpReq.Headers[header]}\n{e.Message}", e);
                  }
              }
          }
          
          public async Task ProxyToResponse(IHttpResponse res, HttpWebRequest webReq)
          {

So it should also work for your user-defined headers, try using a HTTP Inspector like WIreShark or Fiddler to see what the downstream request is.

request is the incoming IHttpRequest which is immutable, the outgoing proxied HttpWebRequest is the second parameter which should be used to customize the proxy request.