Web api 2.1 does not work with a chunked request

Question

User-747114348 posted

I have a application running correctly on web api 2.0 platform.

When I upgrade web api to version 2.1, it does not work.

The client request code such as :

HttpWebRequest hRqst = (HttpWebRequest)WebRequest.Create("http://localhost:7897/api/Test");

hRqst.Method = "Post";

hRqst.ContentType = "application/json";

hRqst.SendChunked = true; // The key code of the problem.

Web api 2.1 would not deserialize the json content, it will deserialize the json data as a null object.

Answer 1

User1594254982 posted

Can you share the following details?

1. Your controller's action, parameters (if complex type,then its information)

2. Check for ModelState to see if there are any errors.

Answer 2

User-747114348 posted

Model : Test Object

public class TestObject
{
	public Int32 UserId { get; set; }

	public Int32 PageIndex { get; set; }

	public Int32 PageSize { get; set; }
}

Controller : Test Controller

public class TestController : ApiController
{
	public TestObject Test(TestObject request)
	{
		return request;
	}
}

Reappear step : 

1. Create a web api project

2. Upgrade project to .net framework 4.5

3. Upgrade all nuget package

4. Then if you send a chunked request, it does not work.

Answer 3

User-747114348 posted

If I reinstall the Microsoft.AspNet.WebApi.* nuget package to 5.0.0, it works.

But when those packages upgrade to 5.1 or above, it does not work.

Answer 4

User401294542 posted

I have the same problem with my ASP.NET Web Api

 

mangohappy

If I reinstall the Microsoft.AspNet.WebApi.* nuget package to 5.0.0, it works.

But when those packages upgrade to 5.1 or above, it does not work.

I have tried with version <package id="Microsoft.AspNet.WebApi" version="5.0.0" targetFramework="net45" /> and with version <package id="Ninject.Web.WebApi" version="3.2.1.0" targetFramework="net45" />

but none of these versions seem to handle Chunked Encoded Transfer requests. I also have MVC <package id="Microsoft.AspNet.Mvc" version="5.1.2" targetFramework="net45" /> and <package id="Microsoft.AspNet.Mvc" version="5.2.0" targetFramework="net45" /> but no luck.

If I send an HTTP PUT request with JSON and with Chunked Encoded Transfer (Content-Length is 0), the request reaches the ASP.NET WebApi, the controller redirects it properly to the HttpPost method but the JSON is not de-serialized and the object is NULL. That does not happen if the request is not Chunked Encoded Transfer.

This is my code

[assembly: log4net.Config.XmlConfigurator(Watch = true)]
namespace AMS.WebAPI.Controllers
{
    public class SyncController : ApiController
    {

        [HttpPut]
        public HttpStatusCode SendData(int id, int count, [FromBody]MyData records, HttpRequestMessage requestMessage)
        {
            var content = requestMessage.Content;
            string jsonContent = content.ReadAsStringAsync().Result; //this jsonContent has the proper Json
            return HttpStatusCode.OK;
        }
    }
}

and this is the class that the framework should "magically" instantiate mapping all the JSON fields to the properties:

namespace AMS.WebAPI.Models
{
    public class MyData
    {
        public string NamePerson {get; set;}
        public int Age {get; set;}
        public string Color {get; set;}
    }
}

Has anybody found out a way to handle de-serialization of http requests that come chunked transfer encoded in Asp.Net Web Api?

Answer 5

User-1832007585 posted

Sounds like real bug. Simple workaround :

public class TestController : ApiController
        {
            public async Task<TestObject> Test()
            {
                TestObject request = JsonConvert.DeserializeObject<RecordingOptions>(await Request.Content.ReadAsStringAsync());
                return request;
            }
        }

Answer 6

User-598086722 posted

Is this fixed? Or do we have some other workaround to read request to before calling web api framework? Maybe before model binding?

Answer 7

User191977431 posted

We are experiencing the same issue, is there any beta version of those nuget packages ?
A github repo to open an issue ?

Answer 8

User-455500886 posted

I had the same issue but I was able to resolve it with the following code:

    internal class ChunkedTransferEncodingFix : DelegatingHandler
    {
        protected override Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, 
            CancellationToken cancellationToken)
        {
            if (request.Headers.TransferEncodingChunked ?? false)
            {
                request.Content.Headers.ContentLength = null;
            }
            return base.SendAsync(request, cancellationToken);
        }
    }

And then add the following line to the Register method of the WebApiConfig class.

config.MessageHandlers.Add(new ChunkedTransferEncodingFix());

Answer 9

User1570830926 posted

I had the same problem and was able to resolve it by updating this packages

"Microsoft.AspNet.WebApi" => FROM version="5.2.3" TO version="5.2.7"
"Microsoft.AspNet.WebApi.Client" =>FROM version="5.2.3" TO version="5.2.7"
"Microsoft.AspNet.WebApi.Core" => FROM version="5.2.3" TO version="5.2.7"
"Microsoft.AspNet.WebApi.WebHost" => FROM version="5.2.3" TO version="5.2.7"

Answer 10

User-11004883 posted

Great call. This was fixed specifically in 5.2.7. 

Thanks!