Mock endpoints are not encoded

[lbroudoux]

Describe the bug

When retrieving the endpoint name using getRestMockEndpoint() or some others getGraphQLMockEndpoint()... methods, it appears that API name and version and not URL-encoded like the Microcks server expect them to be.

Expected behavior

API names and versions containing accents or special characters should be URL encoded.

As an example, API permettant de gérer les pâtisseries should be encoded into API%20permettant%20de%20g%C3%A9rer%20les%20p%C3%A2tisseries or API+permettant+de+g%C3%A9rer+les+p%C3%A2tisseries.

Actual behavior

As of today, there's no encoding and API permettant de gérer les pâtisseries is returned as is. The workaround being that is the user responsibility to know that it should be URL-encoded before actually used.

How to Reproduce?

See above.

Microcks version or git rev

all

Install method (docker-compose, helm chart, operator, docker-desktop extension,...)

No response

Additional information

No response

[lbroudoux]

It appears that some libraries, like RestAssured, don't expect already encoded endpoints, so they tend to re-encode them. This leads to 404 errors because we're not matching any endpoints on the server side.

I think the option could be to provide an additional set of methods like getEncoded RestMockEndpoint() and people would choose between one or the other depending on their HTTP client library.

Thinking about it, this lib's behavior is the same regardless of the binding language (Java, Go, NodeJS, NET); they all provide non-encoded URLs, and all the clients manage to encode them on the fly.

@f-lopes What do you think? What client are you using that causes you trouble?

[f-lopes]

A new method, getEncodedRestMockEndpoint(), could provide a good alternative.

The client I am using is not representative of my future needs, so I will stick to encoding the URL myself, if needed, or use the new potential method if planned.

Thanks for your quick response!

[lbroudoux]

Ok, thanks. I'm putting a hold on this at the moment. I let the issue open much more as a way to collect feedback whether we have to do something or not.