Skip to content

Fix session cookie writes for string responses #3763

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Sanjay44NS wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Fix session cookie writes for string responses #3763

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ce0e105
Fix session commits for explicit zero content length
Sanjay44NS May 21, 2026
b29b9dc
Add sample checks for string response session cookies
Sanjay44NS May 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions ...n-core/src/main/java/org/springframework/session/web/http/OnCommittedResponseWrapper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,8 @@ abstract class OnCommittedResponseWrapper extends HttpServletResponseWrapper {
*/
private long contentLength;

private boolean contentLengthSet;

/**
* The size of data written to the response body. The field will only be updated when
* {@link #disableOnCommitted} is false.
Expand Down Expand Up @@ -107,7 +109,8 @@ public void setContentLength(int len) {

private void setContentLength(long len) {
this.contentLength = len;
checkContentLength(0);
this.contentLengthSet = true;
checkContentLength(0, false);
}

/**
Expand Down Expand Up @@ -259,8 +262,13 @@ private void trackContentLength(String content) {
* @param contentLengthToWrite the size of the content that is about to be written.
*/
private void checkContentLength(long contentLengthToWrite) {
checkContentLength(contentLengthToWrite, true);
}

private void checkContentLength(long contentLengthToWrite, boolean bodyWriteOccurred) {
this.contentWritten += contentLengthToWrite;
boolean isBodyFullyWritten = this.contentLength > 0 && this.contentWritten >= this.contentLength;
boolean isBodyFullyWritten = this.contentLengthSet && this.contentWritten >= this.contentLength
&& (this.contentLength > 0 || bodyWriteOccurred);
int bufferSize = getBufferSize();
boolean requiresFlush = bufferSize > 0 && this.contentWritten >= bufferSize;
if (isBodyFullyWritten || requiresFlush) {
Expand Down
27 changes: 27 additions & 0 deletions ...e/src/test/java/org/springframework/session/web/http/OnCommittedResponseWrapperTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -631,6 +631,33 @@ void printWriterWriteStringContentLengthCommits() throws IOException {
assertThat(this.committed).isTrue();
}

@Test
void explicitZeroContentLengthPrintWriterWriteStringCommits() throws IOException {
this.response.setContentLength(0);

this.response.getWriter().write("ok");

assertThat(this.committed).isTrue();
}

@Test
void explicitZeroContentLengthPrintWriterWriteEmptyStringCommits() throws IOException {
this.response.setContentLength(0);

this.response.getWriter().write("");

assertThat(this.committed).isTrue();
}

@Test
void explicitZeroContentLengthOutputStreamWriteEmptyByteArrayCommits() throws IOException {
this.response.setContentLength(0);

this.response.getOutputStream().write(new byte[0]);

assertThat(this.committed).isTrue();
}

@Test
void printWriterWriteStringDoesNotCommit() throws IOException {
String body = "something";
Expand Down
31 changes: 31 additions & 0 deletions ...core/src/test/java/org/springframework/session/web/http/SessionRepositoryFilterTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
package org.springframework.session.web.http;

import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.time.Instant;
import java.util.ArrayList;
import java.util.Arrays;
Expand Down Expand Up @@ -973,6 +974,36 @@ public void doFilter(HttpServletRequest wrappedRequest, HttpServletResponse wrap
});
}

@Test
void doFilterOutputWriteWithExplicitZeroContentLengthCommitsSession() throws Exception {
doFilter(new DoInFilter() {
@Override
public void doFilter(HttpServletRequest wrappedRequest, HttpServletResponse wrappedResponse)
throws IOException {
String id = wrappedRequest.getSession().getId();
wrappedResponse.setContentLength(0);
wrappedResponse.getOutputStream().write("ok".getBytes(StandardCharsets.UTF_8));
assertThat(SessionRepositoryFilterTests.this.sessionRepository.findById(id)).isNotNull();
assertThat(SessionRepositoryFilterTests.this.response.getCookie("SESSION")).isNotNull();
}
});
}

@Test
void doFilterOutputWriteEmptyBodyWithExplicitZeroContentLengthCommitsSession() throws Exception {
doFilter(new DoInFilter() {
@Override
public void doFilter(HttpServletRequest wrappedRequest, HttpServletResponse wrappedResponse)
throws IOException {
String id = wrappedRequest.getSession().getId();
wrappedResponse.setContentLength(0);
wrappedResponse.getOutputStream().write(new byte[0]);
assertThat(SessionRepositoryFilterTests.this.sessionRepository.findById(id)).isNotNull();
assertThat(SessionRepositoryFilterTests.this.response.getCookie("SESSION")).isNotNull();
}
});
}

@Test // gh-1243
void doFilterInclude() throws Exception {
doFilter(new DoInFilter() {
Expand Down
14 changes: 14 additions & 0 deletions ...n-samples/spring-session-sample-boot-jdbc/src/integration-test/java/sample/BootTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,11 @@
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.htmlunit.webdriver.MockMvcHtmlUnitDriverBuilder;

import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.cookie;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;

/**
* @author Eddú Meléndez
* @author Vedran Pavic
Expand Down Expand Up @@ -82,4 +87,13 @@ void logout() {
login.assertAt();
}

@Test
void stringResponseSetsSessionCookie() throws Exception {
this.mockMvc.perform(get("/string"))
.andExpect(status().isOk())
.andExpect(content().string("ok"))
.andExpect(cookie().exists("SESSION"))
.andExpect(cookie().doesNotExist("JSESSIONID"));
}

}
10 changes: 10 additions & 0 deletions ...session-samples/spring-session-sample-boot-jdbc/src/main/java/sample/IndexController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,10 @@

package sample;

import jakarta.servlet.http.HttpSession;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RequestMapping;

/**
Expand All @@ -33,4 +36,11 @@ public String index() {
return "index";
}

@GetMapping("/string")
@ResponseBody
public String string(HttpSession session) {
session.setAttribute("sample", "value");
return "ok";
}

}
1 change: 1 addition & 0 deletions ...n-samples/spring-session-sample-boot-jdbc/src/main/java/sample/config/SecurityConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ SecurityFilterChain securityFilterChain(HttpSecurity http) throws Exception {
return http
.authorizeHttpRequests((authorize) -> authorize
.requestMatchers(PathRequest.toStaticResources().atCommonLocations()).permitAll()
.requestMatchers("/string").permitAll()
.anyRequest().authenticated()
)
.formLogin((formLogin) -> formLogin
Expand Down
14 changes: 14 additions & 0 deletions ...-samples/spring-session-sample-boot-redis/src/integration-test/java/sample/BootTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,11 @@
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.htmlunit.webdriver.MockMvcHtmlUnitDriverBuilder;

import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.cookie;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;

/**
* @author Eddú Meléndez
* @author Vedran Pavic
Expand Down Expand Up @@ -85,6 +90,15 @@ void logout() {
login.assertAt();
}

@Test
void stringResponseSetsSessionCookie() throws Exception {
this.mockMvc.perform(get("/string"))
.andExpect(status().isOk())
.andExpect(content().string("ok"))
.andExpect(cookie().exists("SESSION"))
.andExpect(cookie().doesNotExist("JSESSIONID"));
}

@TestConfiguration
static class Config {

Expand Down
9 changes: 9 additions & 0 deletions ...samples/spring-session-sample-boot-redis/src/main/java/sample/config/IndexController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,10 @@

package sample.config;

import jakarta.servlet.http.HttpSession;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.ResponseBody;

/**
* An index controller.
Expand All @@ -32,4 +34,11 @@ String index() {
return "index";
}

@GetMapping("/string")
@ResponseBody
String string(HttpSession session) {
session.setAttribute("sample", "value");
return "ok";
}

}
1 change: 1 addition & 0 deletions ...-samples/spring-session-sample-boot-redis/src/main/java/sample/config/SecurityConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ SecurityFilterChain securityFilterChain(HttpSecurity http) throws Exception {
return http
.authorizeHttpRequests((authorize) -> authorize
.requestMatchers(PathRequest.toStaticResources().atCommonLocations()).permitAll()
.requestMatchers("/string").permitAll()
.anyRequest().authenticated()
)
.formLogin((formLogin) -> formLogin
Expand Down