Polishing contribution

Closes gh-35224

spring-messaging/src/main/java/org/springframework/messaging/simp/stomp/DefaultStompSession.java

@@ -351,7 +351,6 @@ public class DefaultStompSession implements ConnectionHandlingStompSession {
 		if (headers == null){
 			headers = new StompHeaders();
 		}
-
 		String receiptId = checkOrAddReceipt(headers);
 		Receiptable receiptable = new ReceiptHandler(receiptId);
 

spring-messaging/src/main/java/org/springframework/messaging/simp/stomp/StompSession.java

@@ -182,13 +182,15 @@ public interface StompSession {
 
 		/**
 		 * Remove the subscription by sending an UNSUBSCRIBE frame.
+		 * <p>As of 7.0, this method returns {@link Receiptable}.
 		 */
 		Receiptable unsubscribe();
 
 		/**
 		 * Alternative to {@link #unsubscribe()} with additional custom headers
-		 * to send to the server.
+		 * to send to the server. Note, however, there is no need to set the
-		 * <p><strong>Note:</strong> There is no need to set the subscription id.
+		 * subscription id.
+		 * <p>As of 7.0, this method returns {@link Receiptable}.
 		 * @param headers the custom headers, if any
 		 * @since 5.0
 		 */

spring-messaging/src/test/java/org/springframework/messaging/simp/stomp/DefaultStompSessionTests.java

@@ -664,7 +664,7 @@ public class DefaultStompSessionTests {
 	}
 
 	@Test
-	void unsubscribeWithReceipt() {
+	void unsubscribeWithoutReceipt() {
 		this.session.afterConnected(this.connection);
 		assertThat(this.session.isConnected()).isTrue();
 		Subscription subscription = this.session.subscribe("/topic/foo", mock());
@@ -672,62 +672,40 @@ public class DefaultStompSessionTests {
 		Receiptable receipt = subscription.unsubscribe();
 		assertThat(receipt).isNotNull();
 		assertThat(receipt.getReceiptId()).isNull();
-
-		Message<byte[]> message = this.messageCaptor.getValue();
-		StompHeaderAccessor accessor = MessageHeaderAccessor.getAccessor(message, StompHeaderAccessor.class);
-		assertThat(accessor.getCommand()).isEqualTo(StompCommand.UNSUBSCRIBE);
-
-		StompHeaders stompHeaders = StompHeaders.readOnlyStompHeaders(accessor.getNativeHeaders());
-		assertThat(stompHeaders).hasSize(1);
-		assertThat(stompHeaders.getId()).isEqualTo(subscription.getSubscriptionId());
 	}
 
 	@Test
-	void unsubscribeWithCustomHeaderAndReceipt() {
+	void unsubscribeWithReceipt() {
 		this.session.afterConnected(this.connection);
 		this.session.setTaskScheduler(mock());
 		this.session.setAutoReceipt(true);
+		Subscription subscription = this.session.subscribe("/topic/foo", mock());
 
-		StompHeaders subHeaders = new StompHeaders();
+		Receiptable receipt = subscription.unsubscribe();
-		subHeaders.setDestination("/topic/foo");
-		Subscription subscription = this.session.subscribe(subHeaders, mock());
-
-		StompHeaders custom = new StompHeaders();
-		custom.set("x-cust", "value");
-
-		Receiptable receipt = subscription.unsubscribe(custom);
 		assertThat(receipt).isNotNull();
 		assertThat(receipt.getReceiptId()).isNotNull();
 
 		Message<byte[]> message = this.messageCaptor.getValue();
 		StompHeaderAccessor accessor = MessageHeaderAccessor.getAccessor(message, StompHeaderAccessor.class);
-		assertThat(accessor.getCommand()).isEqualTo(StompCommand.UNSUBSCRIBE);
+		assertThat(accessor.getReceipt()).isEqualTo(receipt.getReceiptId());
-
-		StompHeaders stompHeaders = StompHeaders.readOnlyStompHeaders(accessor.getNativeHeaders());
-		assertThat(stompHeaders.getId()).isEqualTo(subscription.getSubscriptionId());
-		assertThat(stompHeaders.get("x-cust")).containsExactly("value");
-		assertThat(stompHeaders.getReceipt()).isEqualTo(receipt.getReceiptId());
 	}
 
 	@Test
 	void receiptReceivedOnUnsubscribe() {
 		this.session.afterConnected(this.connection);
-		TaskScheduler scheduler = mock();
+		this.session.setTaskScheduler(mock());
-		this.session.setTaskScheduler(scheduler);
 		this.session.setAutoReceipt(true);
 
 		Subscription subscription = this.session.subscribe("/topic/foo", mock());
 		Receiptable receipt = subscription.unsubscribe();
 
-		StompHeaderAccessor ack = StompHeaderAccessor.create(StompCommand.RECEIPT);
-		ack.setReceiptId(receipt.getReceiptId());
-		ack.setLeaveMutable(true);
-		Message<byte[]> receiptMessage = MessageBuilder.createMessage(new byte[0], ack.getMessageHeaders());
-
 		AtomicBoolean called = new AtomicBoolean(false);
 		receipt.addReceiptTask(() -> called.set(true));
 
-		this.session.handleMessage(receiptMessage);
+		StompHeaderAccessor ack = StompHeaderAccessor.create(StompCommand.RECEIPT);
+		ack.setReceiptId(receipt.getReceiptId());
+		ack.setLeaveMutable(true);
+		this.session.handleMessage(MessageBuilder.createMessage(new byte[0], ack.getMessageHeaders()));
 
 		assertThat(called.get()).isTrue();
 	}