HTTP Adapter URI mappings are sensitive to trailing slashes [INT-3135]

[spring-operator]

Ronald D Kurr opened INT-3135 and commented

I have a working inbound HTTP gateway that uses the path "/resources/{firstName}" that works fine when the GET is issued from Chrome.
The same GET fails when issued from the REST Shell. I watched things in the debugger and it looks to me that the REST Shell adds a trailing slash to its request - /resources/bob/
which causes the HashMap lookup to fail because the path that is stored doesn't have a trailing slash.
My guess is that we need to lop off any trailing slashes prior to doing the look up.

This was done in the context of a Spring MVC application so UriPathHandlerMapping was in play. Here is the relevant XML bits:

<int-http:inbound-gateway id="inboundGateway"
mapped-request-headers="*"
mapped-response-headers="*"
path="/resources/{firstName}"
supported-methods="POST,GET"
request-channel="request-channel"
reply-channel="response-channel">
<int-http:header name="firstName" expression="#pathVariables.firstName"/>
</int-http:inbound-gateway>

<int:service-activator input-channel="request-channel" output-channel="response-channel" requires-reply="true">
<bean class="com.transparent.molde.adapter.inbound.rest.SimpleServiceActivator"/>
</int:service-activator>

<bean class="org.springframework.integration.http.inbound.UriPathHandlerMapping"/>

---

Affects: 2.2.5

Issue Links:

• Add support for full RESTFul request-mappings to the HTTP inbound adapters [INT-2312] #6250 Add support for full RESTFul request-mappings to the HTTP inbound adapters
  ("depends on")

[spring-operator]

Gary Russell commented

There is something peculiar about your text above - notice how the ending quote on the path shows on the new line?

Also, when I added { code } tags it doesn't format properly - what character set are you using? Do you have some non-printable character within that string?

[spring-operator]

Artem Bilan commented

Ronald,

The issue us really here, it is covered with Spring MVC 3.1: RequestMappingHandlerMapping#useTrailingSlashMatch.
And this new MVC infrastructure will be addresed soon with SI 3.0: #723.
But as you correctly noticed UriPathHandlerMapping is based only on AbstractDetectingUrlHandlerMapping.
And now there is no way to handler the same path with trailing slash and without by the same handler.
Here is a workaround for you:

<int-http:inbound-gateway id="inboundGateway"
                             mapped-request-headers="*"
                             mapped-response-headers="*"
                             path="/resources/{firstName}"
                             supported-methods="POST,GET"
                             request-channel="request-channel"
                             reply-channel="response-channel">
       <int-http:header name="firstName" expression="#pathVariables.firstName"/>
</int-http:inbound-gateway>

<int-http:inbound-gateway id="inboundGatewayWithSlash"
                             mapped-request-headers="*"
                             mapped-response-headers="*"
                             path="/resources/{firstName}/"
                             supported-methods="POST,GET"
                             request-channel="request-channel"
                             reply-channel="response-channel">
       <int-http:header name="firstName" expression="#pathVariables.firstName"/>
</int-http:inbound-gateway>

It's funny, but it works.
And if you won't mind we'll decrease an importancy of issue and address it with mentioned PR.
Thanks

[spring-operator]

Artem Bilan commented

BTW, I can't make JIRA description fine...(?)

[spring-operator]

Ronald D Kurr commented

Ok, I'll try adding trailing slashes to my mappings and see if it works for both the REST Shell and a web browser. I'll let you know what I find.

Thanks,
Ron

[spring-operator]

Artem Bilan commented

Ronald,

Another workaround:

public class MyUriPathHandlerMapping extends UriPathHandlerMapping {

	protected String[] determineUrlsForHandler(String beanName) {
		String[] urls = super.determineUrlsForHandler(beanName);
		if (urls != null) {
			String path = urls[0];
			boolean endsWithSlash = path.endsWith("/");
			urls = endsWithSlash ? new String[]{path, path.substring(0, path.length() - 2)} : new String[]{path, path + "/"};
		}
		return urls;
	}
}

[spring-operator]

Artem Bilan commented

Anyway, this issue is covered by
PR: #723