TextMessage.toString() does not throw StringIndexOutOfBoundsException for payload with multibyte characters

Issue: SPR-12307
(cherry picked from commit da14aee)

Author: jhoeller

spring-websocket/src/main/java/org/springframework/web/socket/AbstractWebSocketMessage.java

@@ -69,10 +69,6 @@ public boolean isLast() {
 		return this.last;
 	}
 
-	@Override
-	public int hashCode() {
-		return AbstractWebSocketMessage.class.hashCode() * 13 + ObjectUtils.nullSafeHashCode(this.payload);
-	}
 
 	@Override
 	public boolean equals(Object other) {
@@ -86,10 +82,15 @@ public boolean equals(Object other) {
 		return ObjectUtils.nullSafeEquals(this.payload, otherMessage.payload);
 	}
 
+	@Override
+	public int hashCode() {
+		return ObjectUtils.nullSafeHashCode(this.payload);
+	}
+
 	@Override
 	public String toString() {
-		return getClass().getSimpleName() + " payload= " + toStringPayload()
-				+ ", byteCount=" + getPayloadLength() + ", last=" + isLast() + "]";
+		return getClass().getSimpleName() + " payload=[" + toStringPayload() +
+				"], byteCount=" + getPayloadLength() + ", last=" + isLast() + "]";
 	}
 
 	protected abstract String toStringPayload();

spring-websocket/src/main/java/org/springframework/web/socket/BinaryMessage.java

@@ -26,7 +26,6 @@
  */
 public final class BinaryMessage extends AbstractWebSocketMessage<ByteBuffer> {
 
-
 	/**
 	 * Create a new binary WebSocket message with the given ByteBuffer payload.
 	 * @param payload the non-null payload
@@ -78,7 +77,7 @@ public BinaryMessage(byte[] payload, boolean isLast) {
 	 * @param isLast if the message is the last of a series of partial messages
 	 */
 	public BinaryMessage(byte[] payload, int offset, int length, boolean isLast) {
-		super((payload != null) ? ByteBuffer.wrap(payload, offset, length) : null, isLast);
+		super(payload != null ? ByteBuffer.wrap(payload, offset, length) : null, isLast);
 	}
 
 

spring-websocket/src/main/java/org/springframework/web/socket/PingMessage.java

@@ -26,7 +26,6 @@
  */
 public final class PingMessage extends AbstractWebSocketMessage<ByteBuffer> {
 
-
 	/**
 	 * Create a new ping message with an empty payload.
 	 */
@@ -45,12 +44,12 @@ public PingMessage(ByteBuffer payload) {
 
 	@Override
 	public int getPayloadLength() {
-		return (getPayload() != null) ? getPayload().remaining() : 0;
+		return (getPayload() != null ? getPayload().remaining() : 0);
 	}
 
 	@Override
 	protected String toStringPayload() {
-		return (getPayload() != null) ? getPayload().toString() : null;
+		return (getPayload() != null ? getPayload().toString() : null);
 	}
 
 }

spring-websocket/src/main/java/org/springframework/web/socket/PongMessage.java

@@ -26,7 +26,6 @@
  */
 public final class PongMessage extends AbstractWebSocketMessage<ByteBuffer> {
 
-
 	/**
 	 * Create a new pong message with an empty payload.
 	 */
@@ -45,12 +44,12 @@ public PongMessage(ByteBuffer payload) {
 
 	@Override
 	public int getPayloadLength() {
-		return (getPayload() != null) ? getPayload().remaining() : 0;
+		return (getPayload() != null ? getPayload().remaining() : 0);
 	}
 
 	@Override
 	protected String toStringPayload() {
-		return (getPayload() != null) ? getPayload().toString() : null;
+		return (getPayload() != null ? getPayload().toString() : null);
 	}
 
 }

spring-websocket/src/main/java/org/springframework/web/socket/TextMessage.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2013 the original author or authors.
+ * Copyright 2002-2014 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.
@@ -41,9 +41,8 @@ public TextMessage(CharSequence payload) {
 	}
 
 	/**
-	 * Create a new text WebSocket message from the given byte[]. It is assumed the
-	 * byte array can be encoded into an UTF-8 String.
-	 *
+	 * Create a new text WebSocket message from the given byte[]. It is assumed
+	 * the byte array can be encoded into an UTF-8 String.
 	 * @param payload the non-null payload
 	 */
 	public TextMessage(byte[] payload) {
@@ -76,7 +75,8 @@ public byte[] asBytes() {
 
 	@Override
 	protected String toStringPayload() {
-		return (getPayloadLength() > 10) ? getPayload().substring(0, 10) + ".." : getPayload();
+		String payload = getPayload();
+		return (payload.length() > 10 ? payload.substring(0, 10) + ".." : payload);
 	}
 
 }

spring-websocket/src/main/java/org/springframework/web/socket/WebSocketSession.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2013 the original author or authors.
+ * Copyright 2002-2014 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.
@@ -51,12 +51,10 @@ public interface WebSocketSession {
 
 	/**
 	 * Return the map with attributes associated with the WebSocket session.
-	 *
 	 * <p>When the WebSocketSession is created, on the server side, the map can be
 	 * through a {@link org.springframework.web.socket.server.HandshakeInterceptor}.
 	 * On the client side, the map can be populated by passing attributes to the
-	 * {@link org.springframework.web.socket.client.WebSocketClient} handshake
-	 * methods.
+	 * {@link org.springframework.web.socket.client.WebSocketClient} handshake methods.
 	 */
 	Map<String, Object> getAttributes();
 
@@ -110,15 +108,14 @@ public interface WebSocketSession {
 	List<WebSocketExtension> getExtensions();
 
 	/**
-	 * Return whether the connection is still open.
+	 * Send a WebSocket message: either {@link TextMessage} or {@link BinaryMessage}.
 	 */
-	boolean isOpen();
+	void sendMessage(WebSocketMessage<?> message) throws IOException;
 
 	/**
-	 * Send a WebSocket message either {@link TextMessage} or
-	 * {@link BinaryMessage}.
+	 * Return whether the connection is still open.
 	 */
-	void sendMessage(WebSocketMessage<?> message) throws IOException;
+	boolean isOpen();
 
 	/**
 	 * Close the WebSocket connection with status 1000, i.e. equivalent to:

spring-websocket/src/test/java/org/springframework/web/socket/TextMessageTests.java

@@ -0,0 +1,48 @@
+/*
+ * Copyright 2002-2014 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.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.web.socket;
+
+import org.hamcrest.Matchers;
+import org.junit.Test;
+
+import static org.junit.Assert.*;
+
+/**
+ * Test fixture for {@link TextMessage}.
+ *
+ * @author Shinobu Aoki
+ * @author Juergen Hoeller
+ */
+public class TextMessageTests {
+
+	@Test
+	public void toStringWithAscii() {
+		String expected = "foo,bar";
+		TextMessage actual = new TextMessage(expected);
+		assertThat(actual.getPayload(), Matchers.is(expected));
+		assertThat(actual.toString(), Matchers.containsString(expected));
+	}
+
+	@Test
+	public void toStringWithMultibyteString() {
+		String expected = "\u3042\u3044\u3046\u3048\u304a";
+		TextMessage actual = new TextMessage(expected);
+		assertThat(actual.getPayload(), Matchers.is(expected));
+		assertThat(actual.toString(), Matchers.containsString(expected));
+	}
+
+}