Skip to content

Commit 8da4529

Browse files
committed
Rethrow First Exception
Since the most common case is that there will be just one exception, this commit propagates that one, suppressing any additional Signed-off-by: Josh Cummings <[email protected]>
1 parent 6f8544f commit 8da4529

3 files changed

Lines changed: 73 additions & 9 deletions

File tree

‎web/src/main/java/org/springframework/security/web/header/writers/CompositeHeaderWriter.java‎

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@
1616

1717
package org.springframework.security.web.header.writers;
1818

19-
import java.util.ArrayList;
2019
import java.util.List;
2120

2221
import jakarta.servlet.http.HttpServletRequest;
@@ -47,20 +46,23 @@ public CompositeHeaderWriter(List<HeaderWriter> headerWriters) {
4746

4847
@Override
4948
public void writeHeaders(HttpServletRequest request, HttpServletResponse response) {
50-
List<RuntimeException> exceptions = new ArrayList<>();
51-
this.headerWriters.forEach((headerWriter) -> {
49+
RuntimeException failure = null;
50+
for (HeaderWriter headerWriter : this.headerWriters) {
5251
// Don't fail fast so that other protection headers could still be written
5352
try {
5453
headerWriter.writeHeaders(request, response);
5554
}
5655
catch (RuntimeException ex) {
57-
exceptions.add(ex);
56+
if (failure == null) {
57+
failure = ex;
58+
}
59+
else if (ex != failure) {
60+
failure.addSuppressed(ex);
61+
}
5862
}
59-
});
60-
if (!exceptions.isEmpty()) {
61-
RuntimeException ex = new RuntimeException("Exception(s) thrown when writing headers");
62-
exceptions.forEach(ex::addSuppressed);
63-
throw ex;
63+
}
64+
if (failure != null) {
65+
throw failure;
6466
}
6567
}
6668

‎web/src/test/java/org/springframework/security/web/header/writers/CompositeHeaderWriterTests.java‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@
2828
import org.springframework.mock.web.MockHttpServletResponse;
2929
import org.springframework.security.web.header.HeaderWriter;
3030

31+
import static org.assertj.core.api.Assertions.assertThat;
32+
import static org.assertj.core.api.Assertions.assertThatExceptionOfType;
3133
import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException;
3234
import static org.assertj.core.api.Assertions.assertThatRuntimeException;
3335
import static org.mockito.BDDMockito.then;
@@ -68,6 +70,56 @@ void writeHeadersWhenSomeWriterThrowsThenOthersStillWrite() {
6870
then(writer2).should().writeHeaders(request, response);
6971
}
7072

73+
@Test
74+
void writeHeadersWhenOneWriterThrowsThenThatExceptionIsPropagated() {
75+
HttpServletRequest request = new MockHttpServletRequest();
76+
HttpServletResponse response = new MockHttpServletResponse();
77+
HeaderWriter writer1 = mock(HeaderWriter.class);
78+
HeaderWriter writer2 = mock(HeaderWriter.class);
79+
CompositeHeaderWriter headerWriter = new CompositeHeaderWriter(List.of(writer1, writer2));
80+
IllegalStateException failure = new IllegalStateException("failed");
81+
willThrow(failure).given(writer1).writeHeaders(request, response);
82+
assertThatExceptionOfType(IllegalStateException.class)
83+
.isThrownBy(() -> headerWriter.writeHeaders(request, response))
84+
.isSameAs(failure);
85+
assertThat(failure.getSuppressed()).isEmpty();
86+
then(writer2).should().writeHeaders(request, response);
87+
}
88+
89+
@Test
90+
void writeHeadersWhenSeveralWritersThrowThenFirstIsPropagatedWithOthersSuppressed() {
91+
HttpServletRequest request = new MockHttpServletRequest();
92+
HttpServletResponse response = new MockHttpServletResponse();
93+
HeaderWriter writer1 = mock(HeaderWriter.class);
94+
HeaderWriter writer2 = mock(HeaderWriter.class);
95+
HeaderWriter writer3 = mock(HeaderWriter.class);
96+
CompositeHeaderWriter headerWriter = new CompositeHeaderWriter(List.of(writer1, writer2, writer3));
97+
IllegalStateException first = new IllegalStateException("first");
98+
IllegalArgumentException second = new IllegalArgumentException("second");
99+
willThrow(first).given(writer1).writeHeaders(request, response);
100+
willThrow(second).given(writer2).writeHeaders(request, response);
101+
assertThatExceptionOfType(IllegalStateException.class)
102+
.isThrownBy(() -> headerWriter.writeHeaders(request, response))
103+
.isSameAs(first);
104+
assertThat(first.getSuppressed()).containsExactly(second);
105+
then(writer3).should().writeHeaders(request, response);
106+
}
107+
108+
@Test
109+
void writeHeadersWhenSeveralWritersThrowSameExceptionThenItIsPropagated() {
110+
HttpServletRequest request = new MockHttpServletRequest();
111+
HttpServletResponse response = new MockHttpServletResponse();
112+
HeaderWriter writer1 = mock(HeaderWriter.class);
113+
HeaderWriter writer2 = mock(HeaderWriter.class);
114+
CompositeHeaderWriter headerWriter = new CompositeHeaderWriter(List.of(writer1, writer2));
115+
IllegalStateException failure = new IllegalStateException("failed");
116+
willThrow(failure).given(writer1).writeHeaders(request, response);
117+
willThrow(failure).given(writer2).writeHeaders(request, response);
118+
assertThatExceptionOfType(IllegalStateException.class)
119+
.isThrownBy(() -> headerWriter.writeHeaders(request, response))
120+
.isSameAs(failure);
121+
}
122+
71123
@Test
72124
public void constructorWhenPassingEmptyListThenThrowsException() {
73125
assertThatIllegalArgumentException().isThrownBy(() -> new CompositeHeaderWriter(Collections.emptyList()));

‎web/src/test/java/org/springframework/security/web/server/header/CompositeServerHttpHeadersWriterTests.java‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,16 @@ void writeHttpHeadersWhenSomeWriterThrowsThenOthersStillWrite() {
9797
then(this.writer2).should().writeHttpHeaders(this.exchange);
9898
}
9999

100+
@Test
101+
void writeHttpHeadersWhenOneWriterErrorsThenThatErrorIsPropagated() {
102+
IllegalStateException failure = new IllegalStateException("failed");
103+
given(this.writer1.writeHttpHeaders(this.exchange)).willReturn(Mono.error(failure));
104+
given(this.writer2.writeHttpHeaders(this.exchange)).willReturn(Mono.empty());
105+
Mono<Void> result = this.writer.writeHttpHeaders(this.exchange);
106+
StepVerifier.create(result).expectErrorSatisfies((ex) -> assertThat(ex).isSameAs(failure)).verify();
107+
then(this.writer2).should().writeHttpHeaders(this.exchange);
108+
}
109+
100110
@Test
101111
public void writeHttpHeadersSequential() throws Exception {
102112
AtomicBoolean slowDone = new AtomicBoolean();

0 commit comments

Comments
 (0)