Self referencing loop issue after updating RestEase from 1.4.5 to 1.5.5

[ryanbuening]

After updating RestEase from 1.4.5 to 1.5.5, we receive the following error on a request:

Newtonsoft.Json.JsonSerializationException: Self referencing loop detected for property 'module' with type 'System.Reflection.RuntimeModule'. Path 'requestMessage.properties.RestEaseRequestInfo.methodInfo.module.assembly.entryPoint'.
   at Newtonsoft.Json.Serialization.JsonSerializerInternalWriter.CheckForCircularReference(JsonWriter writer, Object value, JsonProperty property, JsonContract contract, JsonContainerContract containerContract, JsonProperty containerProperty)
   at Newtonsoft.Json.Serialization.JsonSerializerInternalWriter.CalculatePropertyValues(JsonWriter writer, Object value, JsonContainerContract contract, JsonProperty member, JsonProperty property, JsonContract& memberContract, Object& memberValue)
   at Newtonsoft.Json.Serialization.JsonSerializerInternalWriter.SerializeObject(JsonWriter writer, Object value, JsonObjectContract contract, JsonProperty member, JsonContainerContract collectionContract, JsonProperty containerProperty)
   at Newtonsoft.Json.Serialization.JsonSerializerInternalWriter.SerializeObject(JsonWriter writer, Object value, JsonObjectContract contract, JsonProperty member, JsonContainerContract collectionContract, JsonProperty containerProperty)
   at Newtonsoft.Json.Serialization.JsonSerializerInternalWriter.SerializeObject(JsonWriter writer, Object value, JsonObjectContract contract, JsonProperty member, JsonContainerContract collectionContract, JsonProperty containerProperty)
   at Newtonsoft.Json.Serialization.JsonSerializerInternalWriter.SerializeObject(JsonWriter writer, Object value, JsonObjectContract contract, JsonProperty member, JsonContainerContract collectionContract, JsonProperty containerProperty)
   at Newtonsoft.Json.Serialization.JsonSerializerInternalWriter.SerializeObject(JsonWriter writer, Object value, JsonObjectContract contract, JsonProperty member, JsonContainerContract collectionContract, JsonProperty containerProperty)
   at Newtonsoft.Json.Serialization.JsonSerializerInternalWriter.SerializeDictionary(JsonWriter writer, IDictionary values, JsonDictionaryContract contract, JsonProperty member, JsonContainerContract collectionContract, JsonProperty containerProperty)
   at Newtonsoft.Json.Serialization.JsonSerializerInternalWriter.SerializeObject(JsonWriter writer, Object value, JsonObjectContract contract, JsonProperty member, JsonContainerContract collectionContract, JsonProperty containerProperty)
   at Newtonsoft.Json.Serialization.JsonSerializerInternalWriter.SerializeObject(JsonWriter writer, Object value, JsonObjectContract contract, JsonProperty member, JsonContainerContract collectionContract, JsonProperty containerProperty)
   at Newtonsoft.Json.Serialization.JsonSerializerInternalWriter.Serialize(JsonWriter jsonWriter, Object value, Type objectType)
   at Newtonsoft.Json.JsonSerializer.SerializeInternal(JsonWriter jsonWriter, Object value, Type objectType)
   at Microsoft.AspNetCore.Mvc.Formatters.NewtonsoftJsonOutputFormatter.WriteResponseBodyAsync(OutputFormatterWriteContext context, Encoding selectedEncoding)
   at Microsoft.AspNetCore.Mvc.Formatters.NewtonsoftJsonOutputFormatter.WriteResponseBodyAsync(OutputFormatterWriteContext context, Encoding selectedEncoding)
   at Microsoft.AspNetCore.Mvc.Formatters.NewtonsoftJsonOutputFormatter.WriteResponseBodyAsync(OutputFormatterWriteContext context, Encoding selectedEncoding)
   at Microsoft.AspNetCore.Mvc.Infrastructure.ResourceInvoker.<InvokeResultFilters>g__Awaited|27_0(ResourceInvoker invoker, Task lastTask, State next, Scope scope, Object state, Boolean isCompleted)
   at Microsoft.AspNetCore.Mvc.Infrastructure.ResourceInvoker.<InvokeFilterPipelineAsync>g__Awaited|19_0(ResourceInvoker invoker, Task lastTask, State next, Scope scope, Object state, Boolean isCompleted)
   at Microsoft.AspNetCore.Mvc.Infrastructure.ResourceInvoker.<InvokeAsync>g__Logged|17_1(ResourceInvoker invoker)
   at Microsoft.AspNetCore.Routing.EndpointMiddleware.<Invoke>g__AwaitRequestTask|6_0(Endpoint endpoint, Task requestTask, ILogger logger)
   at Microsoft.AspNetCore.Authorization.AuthorizationMiddleware.Invoke(HttpContext context)
   at Microsoft.AspNetCore.Authentication.AuthenticationMiddleware.Invoke(HttpContext context)
   at Microsoft.AspNetCore.Diagnostics.DeveloperExceptionPageMiddleware.Invoke(HttpContext context)

Not sure if requestMessage.properties.RestEaseRequestInfo.methodInfo.module.assembly.entryPoint points to an issue in my model or something in RestEase that is getting hung up? Any ideas of what to look at?

[canton7]

Looks like you're trying to serialise a HttpRequestMessage? Can you share a repro?

[ryanbuening]

Below is the interface...

[Put("/{id}/Submit")]
Task<System.Net.Http.HttpResponseMessage> Submit([Path] string id);

and the calling code...

[HttpPut]
[Route("{quoteId}")]
public async Task<IActionResult> Submit(string id)
{
	  try
	  {
		  var submitResponse = await _restService.GetFooApi().Submit(id);
		  return Ok(submitResponse); // submitResponse is a string
	  }
	  catch (RestEase.ApiException apiException)
	  {
		  _loggingService.LogApiException(apiException);
		  return BadRequest(new ApiErrorResponse((int)apiException.StatusCode, apiException.Message));
	  }
}

[canton7]

How is submitResponse a string, given that Submit returns a Task<HttpResponseMessage>?

Also, which line there throws the exception? Is it the Ok, the logging, or the BadRequest?

[canton7]

This all makes sense if it's the Ok path that's failing, and it's failing because you're giving it a HttpResponseMessage to serialize (and not a string). The HttpResponseMessage references the corresponding HttpRequestMessage, which references the RestEaseRequestInfo, which has a MethodInfo, and then you're into trying to serialize stuff in System.Reflection which is never going to go well.

v1.4.11 added the RestEaseRequestInfo to HttpRequestMessage, so that fits your timeline.

The solution is to not try and serialize a HttpResponseMessage as JSON - they're not intended to be serialized. submitResponse is not a string. If you want a string, get one (either by returning a Task<string> from Submit, or by appropriately deserializing the response into a string)

[ryanbuening]

That is probably it. I'll look into making those changes. Thanks for the reply.