Routing not working with special character in UpstreamPathTemplate

[amorelIM]

Hi,

we're using ocelot as an API gateway for a service using OData. In OData, one feature is to have a route with $query in the name.
For example: /v3/Orders/$query

Here is the documentation for that specific thing : https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part2-url-conventions.html#sec_PassingQueryOptionsintheRequestBody

Expected Behavior / New Feature

Having the next route exposed in Ocelot and being able to call the $query route on the underlying service.

{
  "UpstreamPathTemplate": "/v3/Orders/$query",
  "DownstreamPathTemplate": "/v1/Orders/$query"
}

Actual Behavior / Motivation for New Feature

A 404 is returned with those warnings in the logs:

[13:10:56 WRN] requestId: , previousRequestId: No PreviousRequestId, message: 'DownstreamRouteFinderMiddleware setting pipeline errors. IDownstreamRouteFinder returned Error Code: UnableToFindDownstreamRouteError Message: Failed to match Route configuration for upstream path: /v3/orders/$query, verb: POST.'
[13:10:56 WRN] requestId: , previousRequestId: No PreviousRequestId, message: 'Error Code: UnableToFindDownstreamRouteError Message: Failed to match Route configuration for upstream path: /v3/orders/$query, verb: POST. errors found in ResponderMiddleware. Setting error response for request path:/v3/orders/$query, request method: POST'

Steps to Reproduce the Problem

See previous sections. Using the '$' character in the upstream route.

Workaround

Remove the $ character from the upstreamPathTemplate, but it won't respect the OData protocol.

{
  "UpstreamPathTemplate": "/v3/Orders/query",
  "DownstreamPathTemplate": "/v1/Orders/$query"
}

Specifications

• Version: 23.3.3.0
• Platform: .NET 8
• Subsystem: Windows

[raman-m]

Alexis, thanks for reporting this!

This bug is probably related to

• Regex exception when route template placeholder contains invalid character ) #2116
• Incorrect Routing when a configuration exists with query param wildcard #2132

but I'm not sure

[raman-m]

Having the next route exposed in Ocelot and being able to call the $query route on the underlying service.

{
  "UpstreamPathTemplate": "/v3/Orders/$query",
  "DownstreamPathTemplate": "/v1/Orders/$query"
}

I concur that all static routes with special characters should be functional and forwarded. However, I'm curious about the rationale for defining a static route.

Why not utilize placeholders and convert templates instead?

{
  "UpstreamPathTemplate": "/v3/Orders/{query}",
  "DownstreamPathTemplate": "/v1/Orders/{query}"
}

or even more short version?

{
  "UpstreamPathTemplate": "/v3/{everything}",
  "DownstreamPathTemplate": "/v1/{everything}"
}

Why don't you utilize placeholders?

[raman-m]

OData query is supported via using placeholders, see examples in code & docs
My old answers in discussions with the same problem.

[raman-m]

Duplicate of #859

[amorelIM]

Thank you, it worked.

[raman-m]

Reopen to address triple:

• this Routing not working with special character in UpstreamPathTemplate #2143
• UnableToFindDownstreamRouteError when the UpstreamPathTemplate contains $ #859
• How to define route templates containing `$` in URL paths? #1930

[raman-m]

@int0x81, welcome to your assignment!