Bug with catch-all routing

[istanko]

Hello,

I have a problem with two get routes. One of them is not getting hit.

Expected Behavior / New Feature

With the following configuration, expected behavior should be that calling /api/products?query=test is redirected to the downstream path template /api/products?query=test, and that calling /api/products/1 is redirected to the downstream path template /api/products/1

{
  "UpstreamPathTemplate": "/api/products?{everything}",
  "UpstreamHttpMethod": [
    "Get",
    "Options"
  ],
  "DownstreamPathTemplate": "/api/products-something?{everything}",
  "DownstreamScheme": "http",
  "DownstreamHostAndPorts": [
    {
      "Host": "localhost",
      "Port": 80
    }
  ]
},
{
  "UpstreamPathTemplate": "/api/products/{id}",
  "UpstreamHttpMethod": [
    "Get",
    "Options"
  ],
  "DownstreamPathTemplate": "/api/products/{id}",
  "DownstreamScheme": "http",
  "DownstreamHostAndPorts": [
    {
      "Host": "localhost",
      "Port": 80
    }
  ]
}

Actual Behavior / Motivation for New Feature

Calling /api/products/1 will be routed to downstream path template /api/products?1

Steps to Reproduce the Problem

Use the provided configuration and make calls to both endpoints.

Specifications

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

[raman-m]

Hello, Mr. I. Stanko! What's happening? Also, why was the issue closed? Was there no bug? :)

[raman-m]

{
  "UpstreamPathTemplate": "/api/products?{everything}",
  "DownstreamPathTemplate": "/api/products-something?{everything}",
 },
{
  "UpstreamPathTemplate": "/api/products/{id}",
  "DownstreamPathTemplate": "/api/products/{id}",
}

The configuration appears to be slightly incorrect. The 2nd route is a catch-all, while the first route processes all query strings. Defining the 1st route when the 2nd one is a catch-all seems redundant, as the 2nd route should be able to process all URLs from the first route, including all query strings.

Merging both routes into one could be done as follows:

{
  "UpstreamPathTemplate": "/api/products/{everything}",
  "DownstreamPathTemplate": "/api/products/{everything}",
}

Wouldn't this approach be effective?

[raman-m]

Please read this doc carefully → Empty Placeholders

[raman-m]

Actual Behavior / Motivation for New Feature

Calling /api/products/1 will be routed to downstream path template /api/products?1

Steps to Reproduce the Problem

Use the provided configuration and make calls to both endpoints.

Are you sure? 😉
Please attach logs of your testing session with log level Debug
And we will continue this funny talk...

---

Calling /api/products/1 will be routed to downstream path template /api/products?1

This ought to be verified by our routing tests, and it's concerning if it's not, as it may indicate a bug.
Yes, you've reported the old problem: here is more Routing fun

• Catch All functionality priority routing partially broken #2134
• Incorrect routing when the query parameter is in the configuration #2064
• Incorrect Routing when a configuration exists with query param wildcard #2132

[raman-m]

Duplicate of #2132

[raman-m]

Duplicate of #2064

[istanko]

{
  "UpstreamPathTemplate": "/api/products?{everything}",
  "DownstreamPathTemplate": "/api/products-something?{everything}",
 },
{
  "UpstreamPathTemplate": "/api/products/{id}",
  "DownstreamPathTemplate": "/api/products/{id}",
}

The configuration appears to be slightly incorrect. The 2nd route is a catch-all, while the first route processes all query strings. Defining the 1st route when the 2nd one is a catch-all seems redundant, as the 2nd route should be able to process all URLs from the first route, including all query strings.

Merging both routes into one could be done as follows:

{
  "UpstreamPathTemplate": "/api/products/{everything}",
  "DownstreamPathTemplate": "/api/products/{everything}",
}

Wouldn't this approach be effective?

Hello,

Thanks for reply. The problem here is that the downstream route is different.

[raman-m]

Thanks for reply. The problem here is that the downstream route is different.

OK, but when you have one service instance with different downstream paths, why do merge paths in upstream?
You have to have different upstream paths too!
Your final solution is:

{
  "UpstreamPathTemplate": "/api/products-something?{everything}",
  "DownstreamPathTemplate": "/api/products-something?{everything}",
},
{
  "UpstreamPathTemplate": "/api/products/{id}",
  "DownstreamPathTemplate": "/api/products/{id}",
}

and moreover, it must be one Catch All route ❗

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

Don't say "thank you"

[raman-m]

Mr. I, what's your full name?
How do you use Ocelot now? Learning?
Do you have Ocelot app in Production environment?

[istanko]

Thanks for reply. The problem here is that the downstream route is different.

OK, but when you have one service instance with different downstream paths, why do merge paths in upstream? You have to have different upstream paths too! Your final solution is:

{
  "UpstreamPathTemplate": "/api/products-something?{everything}",
  "DownstreamPathTemplate": "/api/products-something?{everything}",
},
{
  "UpstreamPathTemplate": "/api/products/{id}",
  "DownstreamPathTemplate": "/api/products/{id}",
}

and moreover, it must be one Catch All route ❗

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

Don't say "thank you"

The thing here is that the {id} should not be Catch All, but placeholder for variable.

[raman-m]

Mr. @istanko, will you open a PR in November'24?

[raman-m]

@int0x81, welcome to your assignment!

[ggnaegi]

@istanko could you please check if you observe the same behavior with #2200? Thanks