Refine "." separator support for STOMP messaging

After this commit DefaultUserDestinationResolves no longer looks at
whether AntPathMatcher is configured with "." as separator and rather
expects to be explicitly told whether to keep the leading slash in
translated destinations which actually depends on what the message
broker supports (e.g. RabbitMQ "/", Artemis ".") or how it is
configured (simple broker could be either way).

There is also a minor improvement in SimpMessagingTemplate to ensure
user destinations are correctly formed based on what the
DefaultUserDestinationResolver expects. When using "." as separtor it
allows sending messages to "queue.q1" rather than "/queue.q1".

Issue: SPR-16275

Author: rstoyanchev

spring-messaging/src/main/java/org/springframework/messaging/simp/SimpMessagingTemplate.java

@@ -221,6 +221,7 @@ public void convertAndSendToUser(String user, String destination, Object payload
 
 		Assert.notNull(user, "User must not be null");
 		user = StringUtils.replace(user, "/", "%2F");
+		destination = destination.startsWith("/") ? destination : "/" + destination;
 		super.convertAndSend(this.destinationPrefix + user + destination, payload, headers, postProcessor);
 	}
 

spring-messaging/src/main/java/org/springframework/messaging/simp/config/AbstractMessageBrokerConfiguration.java

@@ -17,6 +17,7 @@
 package org.springframework.messaging.simp.config;
 
 import java.util.ArrayList;
+import java.util.Collection;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
@@ -284,7 +285,18 @@ protected void addReturnValueHandlers(List<HandlerMethodReturnValueHandler> retu
 	@Bean
 	public AbstractBrokerMessageHandler simpleBrokerMessageHandler() {
 		SimpleBrokerMessageHandler handler = getBrokerRegistry().getSimpleBroker(brokerChannel());
-		return (handler != null ? handler : new NoOpBrokerMessageHandler());
+		if (handler == null) {
+			return new NoOpBrokerMessageHandler();
+		}
+		updateUserDestinationResolver(handler);
+		return handler;
+	}
+
+	private void updateUserDestinationResolver(AbstractBrokerMessageHandler handler) {
+		Collection<String> prefixes = handler.getDestinationPrefixes();
+		if (!prefixes.isEmpty() && !prefixes.iterator().next().startsWith("/")) {
+			((DefaultUserDestinationResolver) userDestinationResolver()).setRemoveLeadingSlash(true);
+		}
 	}
 
 	@Bean
@@ -303,6 +315,7 @@ public AbstractBrokerMessageHandler stompBrokerRelayMessageHandler() {
 			subscriptions.put(destination, userRegistryMessageHandler());
 		}
 		handler.setSystemSubscriptions(subscriptions);
+		updateUserDestinationResolver(handler);
 		return handler;
 	}
 
@@ -387,7 +400,6 @@ public UserDestinationResolver userDestinationResolver() {
 		if (prefix != null) {
 			resolver.setUserDestinationPrefix(prefix);
 		}
-		resolver.setPathMatcher(getBrokerRegistry().getPathMatcher());
 		return resolver;
 	}
 

spring-messaging/src/main/java/org/springframework/messaging/simp/user/DefaultUserDestinationResolver.java

@@ -58,7 +58,7 @@ public class DefaultUserDestinationResolver implements UserDestinationResolver {
 
 	private String prefix = "/user/";
 
-	private boolean keepLeadingSlash = true;
+	private boolean removeLeadingSlash = false;
 
 
 	/**
@@ -97,6 +97,29 @@ public String getDestinationPrefix() {
 		return this.prefix;
 	}
 
+	/**
+	 * Use this property to indicate whether the leading slash from translated
+	 * user destinations should be removed or not. This depends on the
+	 * destination prefixes the message broker is configured with.
+	 * <p>By default this is set to {@code false}, i.e. "do not change the
+	 * target destination", although
+	 * {@link org.springframework.messaging.simp.config.AbstractMessageBrokerConfiguration
+	 * AbstractMessageBrokerConfiguration} may change that to {@code true} if
+	 * the configured destinations do not have a leading slash.
+	 * @param remove whether to remove the leading slash
+	 * @since 4.3.14
+	 */
+	public void setRemoveLeadingSlash(boolean remove) {
+		this.removeLeadingSlash = remove;
+	}
+
+	/**
+	 * Whether to remove the leading slash from target destinations.
+	 */
+	public boolean isRemoveLeadingSlash() {
+		return this.removeLeadingSlash;
+	}
+
 	/**
 	 * Provide the {@code PathMatcher} in use for working with destinations
 	 * which in turn helps to determine whether the leading slash should be
@@ -110,11 +133,14 @@ public String getDestinationPrefix() {
 	 * jms.queue.position-updates}.
 	 * @param pathMatcher the PathMatcher used to work with destinations
 	 * @since 4.3
+	 * @deprecated as of 4.3.14 this property is no longer used and is replaced
+	 * by {@link #setRemoveLeadingSlash(boolean)} that indicates more explicitly
+	 * whether to keep the leading slash which may or may not be the case
+	 * regardless of how the {@code PathMatcher} is configured.
 	 */
+	@Deprecated
 	public void setPathMatcher(PathMatcher pathMatcher) {
-		if (pathMatcher != null) {
-			this.keepLeadingSlash = pathMatcher.combine("1", "2").equals("1/2");
-		}
+		// Do nothing
 	}
 
 
@@ -166,7 +192,7 @@ private ParseResult parseSubscriptionMessage(Message<?> message, String sourceDe
 		}
 		int prefixEnd = this.prefix.length() - 1;
 		String actualDestination = sourceDestination.substring(prefixEnd);
-		if (!this.keepLeadingSlash) {
+		if (isRemoveLeadingSlash()) {
 			actualDestination = actualDestination.substring(1);
 		}
 		Principal principal = SimpMessageHeaderAccessor.getUser(headers);
@@ -193,7 +219,7 @@ private ParseResult parseMessage(MessageHeaders headers, String sourceDestinatio
 		else {
 			sessionIds = getSessionIdsByUser(userName, sessionId);
 		}
-		if (!this.keepLeadingSlash) {
+		if (isRemoveLeadingSlash()) {
 			actualDestination = actualDestination.substring(1);
 		}
 		return new ParseResult(sourceDestination, actualDestination, subscribeDestination,

spring-messaging/src/test/java/org/springframework/messaging/simp/config/MessageBrokerConfigurationTests.java

@@ -25,13 +25,13 @@
 import org.hamcrest.Matchers;
 import org.junit.Test;
 
-import org.springframework.beans.DirectFieldAccessor;
 import org.springframework.context.ApplicationContext;
 import org.springframework.context.annotation.AnnotationConfigApplicationContext;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.support.StaticApplicationContext;
 import org.springframework.messaging.Message;
+import org.springframework.messaging.MessageChannel;
 import org.springframework.messaging.MessageHandler;
 import org.springframework.messaging.converter.ByteArrayMessageConverter;
 import org.springframework.messaging.converter.CompositeMessageConverter;
@@ -44,7 +44,9 @@
 import org.springframework.messaging.handler.annotation.SendTo;
 import org.springframework.messaging.handler.invocation.HandlerMethodArgumentResolver;
 import org.springframework.messaging.handler.invocation.HandlerMethodReturnValueHandler;
+import org.springframework.messaging.simp.SimpMessageHeaderAccessor;
 import org.springframework.messaging.simp.SimpMessageType;
+import org.springframework.messaging.simp.SimpMessagingTemplate;
 import org.springframework.messaging.simp.annotation.SubscribeMapping;
 import org.springframework.messaging.simp.annotation.support.SimpAnnotationMethodMessageHandler;
 import org.springframework.messaging.simp.broker.DefaultSubscriptionRegistry;
@@ -66,6 +68,7 @@
 import org.springframework.stereotype.Controller;
 import org.springframework.util.AntPathMatcher;
 import org.springframework.util.MimeTypeUtils;
+import org.springframework.util.PathMatcher;
 import org.springframework.validation.Errors;
 import org.springframework.validation.Validator;
 import org.springframework.validation.beanvalidation.OptionalValidatorFactoryBean;
@@ -412,7 +415,7 @@ public void customPathMatcher() {
 
 		DefaultUserDestinationResolver resolver = context.getBean(DefaultUserDestinationResolver.class);
 		assertNotNull(resolver);
-		assertEquals(false, new DirectFieldAccessor(resolver).getPropertyValue("keepLeadingSlash"));
+		assertEquals(false, resolver.isRemoveLeadingSlash());
 	}
 
 	@Test
@@ -460,6 +463,67 @@ public void userBroadcastsDisabledWithSimpleBroker() {
 		assertNotEquals(UserRegistryMessageHandler.class, messageHandler.getClass());
 	}
 
+	@Test // SPR-16275
+	public void dotSeparatorWithBrokerSlashConvention() {
+		ApplicationContext context = loadConfig(DotSeparatorWithSlashBrokerConventionConfig.class);
+		testDotSeparator(context, true);
+	}
+
+	@Test // SPR-16275
+	public void dotSeparatorWithBrokerDotConvention() {
+		ApplicationContext context = loadConfig(DotSeparatorWithDotBrokerConventionConfig.class);
+		testDotSeparator(context, false);
+	}
+
+	private void testDotSeparator(ApplicationContext context, boolean expectLeadingSlash) {
+		MessageChannel inChannel = context.getBean("clientInboundChannel", MessageChannel.class);
+		TestChannel outChannel = context.getBean("clientOutboundChannel", TestChannel.class);
+		MessageChannel brokerChannel = context.getBean("brokerChannel", MessageChannel.class);
+
+
+		// 1. Subscribe to user destination
+
+		StompHeaderAccessor headers = StompHeaderAccessor.create(StompCommand.SUBSCRIBE);
+		headers.setSessionId("sess1");
+		headers.setSubscriptionId("subs1");
+		headers.setDestination("/user/queue.q1");
+		Message<?> message = MessageBuilder.createMessage(new byte[0], headers.getMessageHeaders());
+		inChannel.send(message);
+
+		// 2. Send message to user via inboundChannel
+
+		headers = StompHeaderAccessor.create(StompCommand.SEND);
+		headers.setSessionId("sess1");
+		headers.setDestination("/user/sess1/queue.q1");
+		message = MessageBuilder.createMessage("123".getBytes(), headers.getMessageHeaders());
+		inChannel.send(message);
+
+		assertEquals(1, outChannel.messages.size());
+		Message<?> outputMessage = outChannel.messages.remove(0);
+		headers = StompHeaderAccessor.wrap(outputMessage);
+
+		assertEquals(SimpMessageType.MESSAGE, headers.getMessageType());
+		assertEquals(expectLeadingSlash ? "/queue.q1-usersess1" : "queue.q1-usersess1", headers.getDestination());
+		assertEquals("123", new String((byte[]) outputMessage.getPayload()));
+
+
+		// 3. Send message via broker channel
+
+		SimpMessagingTemplate template = new SimpMessagingTemplate(brokerChannel);
+		SimpMessageHeaderAccessor accessor = SimpMessageHeaderAccessor.create();
+		accessor.setSessionId("sess1");
+		template.convertAndSendToUser("sess1", "queue.q1", "456".getBytes(), accessor.getMessageHeaders());
+
+		assertEquals(1, outChannel.messages.size());
+		outputMessage = outChannel.messages.remove(0);
+		headers = StompHeaderAccessor.wrap(outputMessage);
+
+		assertEquals(SimpMessageType.MESSAGE, headers.getMessageType());
+		assertEquals(expectLeadingSlash ? "/queue.q1-usersess1" : "queue.q1-usersess1", headers.getDestination());
+		assertEquals("456", new String((byte[]) outputMessage.getPayload()));
+
+	}
+
 	private AnnotationConfigApplicationContext loadConfig(Class<?> configClass) {
 		return new AnnotationConfigApplicationContext(configClass);
 	}
@@ -575,6 +639,60 @@ protected void configureMessageBroker(MessageBrokerRegistry registry) {
 	}
 
 
+	@Configuration
+	static abstract class BaseDotSeparatorConfig extends BaseTestMessageBrokerConfig {
+
+		@Override
+		protected void configureMessageBroker(MessageBrokerRegistry registry) {
+			registry.setPathMatcher(new AntPathMatcher("."));
+		}
+
+		@Override
+		@Bean
+		public AbstractSubscribableChannel clientInboundChannel() {
+			// synchronous
+			return new ExecutorSubscribableChannel(null);
+		}
+
+		@Override
+		@Bean
+		public AbstractSubscribableChannel clientOutboundChannel() {
+			return new TestChannel();
+		}
+
+		@Override
+		@Bean
+		public AbstractSubscribableChannel brokerChannel() {
+			// synchronous
+			return new ExecutorSubscribableChannel(null);
+		}
+	}
+
+	@Configuration
+	static class DotSeparatorWithSlashBrokerConventionConfig extends BaseDotSeparatorConfig {
+
+		// RabbitMQ-style broker convention for STOMP destinations
+
+		@Override
+		protected void configureMessageBroker(MessageBrokerRegistry registry) {
+			super.configureMessageBroker(registry);
+			registry.enableSimpleBroker("/topic", "/queue");
+		}
+	}
+
+	@Configuration
+	static class DotSeparatorWithDotBrokerConventionConfig extends BaseDotSeparatorConfig {
+
+		// Artemis-style broker convention for STOMP destinations
+
+		@Override
+		protected void configureMessageBroker(MessageBrokerRegistry registry) {
+			super.configureMessageBroker(registry);
+			registry.enableSimpleBroker("topic.", "queue.");
+		}
+	}
+
+
 	private static class TestChannel extends ExecutorSubscribableChannel {
 
 		private final List<Message<?>> messages = new ArrayList<>();

spring-messaging/src/test/java/org/springframework/messaging/simp/user/DefaultUserDestinationResolverTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2016 the original author or authors.
+ * Copyright 2002-2018 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -16,9 +16,6 @@
 
 package org.springframework.messaging.simp.user;
 
-import static org.junit.Assert.*;
-import static org.mockito.Mockito.*;
-
 import java.security.Principal;
 
 import org.junit.Before;
@@ -29,9 +26,11 @@
 import org.springframework.messaging.simp.SimpMessageType;
 import org.springframework.messaging.simp.TestPrincipal;
 import org.springframework.messaging.support.MessageBuilder;
-import org.springframework.util.AntPathMatcher;
 import org.springframework.util.StringUtils;
 
+import static org.junit.Assert.*;
+import static org.mockito.Mockito.*;
+
 /**
  * Unit tests for
  * {@link org.springframework.messaging.simp.user.DefaultUserDestinationResolver}.
@@ -74,9 +73,7 @@ public void handleSubscribe() {
 
 	@Test // SPR-14044
 	public void handleSubscribeForDestinationWithoutLeadingSlash() {
-		AntPathMatcher pathMatcher = new AntPathMatcher();
-		pathMatcher.setPathSeparator(".");
-		this.resolver.setPathMatcher(pathMatcher);
+		this.resolver.setRemoveLeadingSlash(true);
 
 		TestPrincipal user = new TestPrincipal("joe");
 		String destination = "/user/jms.queue.call";
@@ -142,9 +139,7 @@ public void handleMessage() {
 
 	@Test // SPR-14044
 	public void handleMessageForDestinationWithDotSeparator() {
-		AntPathMatcher pathMatcher = new AntPathMatcher();
-		pathMatcher.setPathSeparator(".");
-		this.resolver.setPathMatcher(pathMatcher);
+		this.resolver.setRemoveLeadingSlash(true);
 
 		TestPrincipal user = new TestPrincipal("joe");
 		String destination = "/user/joe/jms.queue.call";