Extending Route configuration

[nurhat]

New Feature

We need a way to access the custom properties defined for Routes when using Ocelot configuration merge option.

Motivation for New Feature

When having multiple ocelot configuration files and using Ocelot configuration merge option, custom configurations defined for Routes are lost in the merged ocelot.json.

Steps to Reproduce the Problem

1. Create a ocelot.xservices.json file

{
  "Routes": [ 
    {
      "DownstreamPathTemplate": "/xservice.svc/serviceMethodA/byNumber/{number}",
      "UpstreamPathTemplate": "/gw/serviceMethodA/byNumber/{number}",
      "UpstreamHttpMethod": [
        "Get",
        "Post"
      ],
      "DownstreamScheme": "http",
      "DownstreamHostAndPorts": [
        {
          "Host": "host",
          "Port": 80
        }
      ],
      "CustomStrategyProperty": {
        "GET": [
          "SomeCustomStrategyMethodA" 
        ],
      "POST": [ 
          "SomeCustomeStrategyMethodB"
        ]
      }
    },
  ]
}

3. Create a ocelot.yservices.json file
4. Use AddOcelot to merge configurations and create ocelot.json config file
5. The merged file created at the root directory, and ocelot.json does not contain custom property (e.g. "CustomerStrategyProperty") added to any Route item.

Specifications

• Version: 12.0.1 - 19.0.2, latest

[TomPallister]

@nurhat this isn't something I intend to change at the moment, however happy to accept a PR :)

I will keep the issue open!

[raman-m]

@nurhat Congratulations! 🎉
Your issue has been accepted due to the creation of a great PR #1183 by @jlukawska 😺

• #651 Merge custom JSON properties across multiple ocelot.X.json configuration files using Newtonsoft's JToken merge functionality #1183

[raman-m]

@TomPallister commented on Oct 7, 2018:

@nurhat this isn't something I intend to change at the moment, however happy to accept a PR :)
I will keep the issue open!

It is accepted twice! 😉
God blesses you, because you have been keeping the issue open these 5 years! 🤣
We have some progress nowadays in 2023... 😊

[raman-m]

@nurhat commented on Oct 3, 2018:

The merged file created at the root directory, and ocelot.json does not contain custom property (e.g. "CustomerStrategyProperty") added to any Route item.

🆗 Imagine you have this property in some route.
What's next? How are you going to reuse this custom property in current implementations?

I see one possible user scenario, when you would like to create custom solution by custom concreate implementations of current interfaces, and add these concrete objects to DI-container and then reuse these concrete objects in your custom classes.
Am I right?

But, I'm still curious... Could you show your user scenario?
Could you write an example when you will use custom JSON-property of a route object?

That will be very interesting challenge! 😉
Good luck!

[raman-m]

Hey @nurhat !
Are you still with Ocelot?

[raman-m]

Hi @guerinsylvain!
Are you @nurhat ? 🤣
Do you know @nurhat? 😄

[raman-m]

Dear @nurhat,
The functionality you requested is already in place as the Metadata feature, introduced by PR #1843 (refer to commit 573a9d9) and included in release 23.3.0. However, we utilize a different concept inspired by MS Reverse Proxy metadata.
The same, in Ocelot all extended properties are stored within the Metadata property →

Ocelot/src/Ocelot/Configuration/File/FileRoute.cs

Line 65 in da9d6fa

public IDictionary<string, string> Metadata { get; set; }

Your feature request is somewhat unique, and in light of the ongoing PR #1183, we aim to accommodate it.