remove false comment about try-with-resources statement in StompSubProtocolHandler

Signed-off-by: Vincent Potucek <[email protected]>

Author: Vincent Potucek

spring-web/src/main/java/org/springframework/http/converter/ResourceRegionHttpMessageConverter.java

@@ -38,9 +38,6 @@
 import org.springframework.util.MimeTypeUtils;
 import org.springframework.util.StreamUtils;
 
-import static java.lang.Math.min;
-import static org.springframework.util.StreamUtils.copyRange;
-
 /**
  * Implementation of {@link HttpMessageConverter} that can write a single
  * {@link ResourceRegion} or Collections of {@link ResourceRegion ResourceRegions}.
@@ -166,18 +163,29 @@ private boolean supportsRepeatableWrites(ResourceRegion region) {
 
 	protected void writeResourceRegion(ResourceRegion region, HttpOutputMessage outputMessage) throws IOException {
 		Assert.notNull(region, "ResourceRegion must not be null");
+		HttpHeaders responseHeaders = outputMessage.getHeaders();
 
-		var start = region.getPosition();
-		var resourceLength = region.getResource().contentLength();
-		var end = min(start + region.getCount() - 1, resourceLength - 1);
-		var responseHeaders = outputMessage.getHeaders();
-		responseHeaders.setContentLength(end - start + 1);
+		long start = region.getPosition();
+		long end = start + region.getCount() - 1;
+		long resourceLength = region.getResource().contentLength();
+		end = Math.min(end, resourceLength - 1);
+		long rangeLength = end - start + 1;
 		responseHeaders.add("Content-Range", "bytes " + start + '-' + end + '/' + resourceLength);
+		responseHeaders.setContentLength(rangeLength);
 
-		try (var in = region.getResource().getInputStream()) {
-			copyRange(in, outputMessage.getBody(), start, end);
+		InputStream in = region.getResource().getInputStream();
+		// We cannot use try-with-resources here for the InputStream, since we have
+		// custom handling of the close() method in a finally-block.
+		try {
+			StreamUtils.copyRange(in, outputMessage.getBody(), start, end);
 		}
-		catch (IOException ignored) {
+		finally {
+			try {
+				in.close();
+			}
+			catch (IOException ex) {
+				// ignore
+			}
 		}
 	}
 
@@ -219,14 +227,14 @@ private void writeResourceRegionCollection(Collection<ResourceRegion> resourceRe
 					println(out);
 				}
 				long resourceLength = region.getResource().contentLength();
-				end = min(end, resourceLength - inputStreamPosition - 1);
+				end = Math.min(end, resourceLength - inputStreamPosition - 1);
 				print(out, "Content-Range: bytes " +
 						region.getPosition() + '-' + (region.getPosition() + region.getCount() - 1) +
 						'/' + resourceLength);
 				println(out);
 				println(out);
 				// Printing content
-				copyRange(in, out, start, end);
+				StreamUtils.copyRange(in, out, start, end);
 				inputStreamPosition += (end + 1);
 			}
 		}

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

@@ -531,129 +531,7 @@ public boolean send(Message<?> message, long timeout) {
 		verify(runnable, times(1)).run();
 	}
 
-	@Test
-	void handleMessageFromClientWithBinaryStompFrame() {
-		StompHeaderAccessor headers = StompHeaderAccessor.create(StompCommand.CONNECT);
-		byte[] payload = new StompEncoder().encode(headers.getMessageHeaders(), EMPTY_PAYLOAD);
-		BinaryMessage binaryMessage = new BinaryMessage(payload);
-
-		this.protocolHandler.afterSessionStarted(this.session, this.channel);
-		this.protocolHandler.handleMessageFromClient(this.session, binaryMessage, this.channel);
-
-		verify(this.channel).send(this.messageCaptor.capture());
-		Message<?> actual = this.messageCaptor.getValue();
-		assertThat(actual).isNotNull();
-		assertThat(StompHeaderAccessor.wrap(actual).getCommand()).isEqualTo(StompCommand.CONNECT);
-	}
-
-	@Test
-	void handleMessageFromClientWithPartialStompFrame() {
-		TextMessage partialMessage = new TextMessage("CONNECT\naccept-version:1.2\n\n");
-
-		this.protocolHandler.afterSessionStarted(this.session, this.channel);
-		this.protocolHandler.handleMessageFromClient(this.session, partialMessage, this.channel);
-
-		verifyNoInteractions(this.channel);
-		assertThat(this.session.getSentMessages()).isEmpty();
-	}
-
-	@Test
-	void handleMessageFromClientWithInvalidStompFrame() {
-		TextMessage invalidMessage = new TextMessage("INVALID_COMMAND\n\n\0");
-
-		this.protocolHandler.afterSessionStarted(this.session, this.channel);
-		this.protocolHandler.handleMessageFromClient(this.session, invalidMessage, this.channel);
-
-		verifyNoInteractions(this.channel);
-		assertThat(this.session.getSentMessages()).hasSize(1);
-		TextMessage actual = (TextMessage) this.session.getSentMessages().get(0);
-		assertThat(actual.getPayload()).startsWith("ERROR");
-	}
-
-	@Test
-	void handleMessageToClientWithEmptyPayload() {
-		StompHeaderAccessor headers = StompHeaderAccessor.create(StompCommand.MESSAGE);
-		headers.setDestination("/topic/foo");
-		Message<byte[]> message = MessageBuilder.createMessage(EMPTY_PAYLOAD, headers.getMessageHeaders());
-
-		this.protocolHandler.handleMessageToClient(this.session, message);
-
-		assertThat(this.session.getSentMessages()).hasSize(1);
-		WebSocketMessage<?> textMessage = this.session.getSentMessages().get(0);
-		assertThat(textMessage.getPayload()).isEqualTo("MESSAGE\ndestination:/topic/foo\ncontent-length:0\n\n\u0000");
-	}
-
-	@Test
-	void handleMessageToClientWithLargePayload() {
-		byte[] largePayload = new byte[1024 * 64]; // 64KB
-		Arrays.fill(largePayload, (byte) 'A');
-
-		StompHeaderAccessor headers = StompHeaderAccessor.create(StompCommand.MESSAGE);
-		headers.setDestination("/topic/foo");
-		headers.setContentType(MimeTypeUtils.APPLICATION_OCTET_STREAM);
-		Message<byte[]> message = MessageBuilder.createMessage(largePayload, headers.getMessageHeaders());
-
-		this.protocolHandler.handleMessageToClient(this.session, message);
-
-		assertThat(this.session.getSentMessages()).hasSize(1);
-		WebSocketMessage<?> webSocketMessage = this.session.getSentMessages().get(0);
-		assertThat(webSocketMessage).isInstanceOf(BinaryMessage.class);
-	}
-
-	@Test
-	void handleMessageToClientWithErrorFrame() {
-		StompHeaderAccessor headers = StompHeaderAccessor.create(StompCommand.ERROR);
-		headers.setMessage("Test error");
-		Message<byte[]> message = MessageBuilder.createMessage(EMPTY_PAYLOAD, headers.getMessageHeaders());
-
-		this.protocolHandler.handleMessageToClient(this.session, message);
-
-		assertThat(this.session.getSentMessages()).hasSize(1);
-		TextMessage actual = (TextMessage) this.session.getSentMessages().get(0);
-		assertThat(actual.getPayload()).startsWith("ERROR\nmessage:Test error");
-
-		// Verify session was closed
-		assertThat(this.session.isOpen()).isFalse();
-		assertThat(this.session.getCloseStatus()).isEqualTo(CloseStatus.PROTOCOL_ERROR);
-	}
-
-	@Test
-	void handleMessageToClientWithHeartbeat() {
-		StompHeaderAccessor headers = StompHeaderAccessor.createForHeartbeat();
-		Message<byte[]> message = MessageBuilder.createMessage(EMPTY_PAYLOAD, headers.getMessageHeaders());
 
-		this.protocolHandler.handleMessageToClient(this.session, message);
-
-		assertThat(this.session.getSentMessages()).hasSize(1);
-		TextMessage actual = (TextMessage) this.session.getSentMessages().get(0);
-		assertThat(actual.getPayload()).isEqualTo("\n");
-	}@Test
-	void sessionAttributesArePreserved() {
-		this.session.getAttributes().put("key", "value");
-
-		TextMessage textMessage = StompTextMessageBuilder.create(StompCommand.CONNECT).build();
-		this.protocolHandler.afterSessionStarted(this.session, this.channel);
-		this.protocolHandler.handleMessageFromClient(this.session, textMessage, this.channel);
-
-		verify(this.channel).send(this.messageCaptor.capture());
-		Message<?> actual = this.messageCaptor.getValue();
-		assertThat(SimpMessageHeaderAccessor.getSessionAttributes(actual.getHeaders()))
-				.containsEntry("key", "value");
-	}
-
-	@Test
-	void immutableMessageHandling() {
-		// Create immutable message
-		StompHeaderAccessor headers = StompHeaderAccessor.create(StompCommand.SEND);
-		headers.setImmutable();
-		Message<byte[]> message = MessageBuilder.createMessage(EMPTY_PAYLOAD, headers.getMessageHeaders());
-
-		this.protocolHandler.handleMessageToClient(this.session, message);
-
-		assertThat(this.session.getSentMessages()).hasSize(1);
-		TextMessage actual = (TextMessage) this.session.getSentMessages().get(0);
-		assertThat(actual.getPayload()).contains("SEND");
-	}
 	private static class UniqueUser extends TestPrincipal implements DestinationUserNameProvider {
 
 		private UniqueUser(String name) {