Spring/spring-framework
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Deprecate HttpStatus 103 CHECKPOINT in favor of new EARLY_HINTS (#29816)

Browse Source 
This commit takes rfc8297 into account and introduces a newer code 103
HttpStatus value which uses `Early Hints` as the more correct reason
phrase, deprecating the outdated `CHECKPOINT` enum value for 103.

Additionally:
  - `HttpStatus.valueOf(103)` will return the new enum value
  - `HttpStatusCode#isSameCodeAs(HttpStatusCode)` is introduced to ease
  comparison of deprecated enums vs their newer counterparts (or any
  instance of a more generic `HttpStatusCode`) by comparing the integer
  `value()`
  - `HttpStatusTests` covers the new deprecation as well as the three
  previously deprecated codes, including a check with the above new
  method to ensure they have comparable integer values

Supersedes and Closes gh-27960
This commit is contained in:
Simon Baslé
2023-01-16 11:22:43 +01:00
committed by GitHub
parent 312db36849
commit 5de1460f88
5 changed files with 77 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

43
spring-web/src/test/java/org/springframework/http/HttpStatusTests.java
View File

@@ -17,12 +17,19 @@
package org.springframework.http;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.stream.Collectors;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.Arguments;
import org.junit.jupiter.params.provider.MethodSource;
import static org.assertj.core.api.Assertions.assertThat;
import static org.junit.jupiter.params.provider.Arguments.arguments;
/**
* @author Arjen Poutsma
@@ -37,7 +44,7 @@ class HttpStatusTests {
statusCodes.put(100, "CONTINUE");
statusCodes.put(101, "SWITCHING_PROTOCOLS");
statusCodes.put(102, "PROCESSING");
statusCodes.put(103, "CHECKPOINT");
statusCodes.put(103, "EARLY_HINTS");
statusCodes.put(200, "OK");
statusCodes.put(201, "CREATED");
@@ -120,8 +127,7 @@ class HttpStatusTests {
void fromEnumToMap() {
for (HttpStatus status : HttpStatus.values()) {
int code = status.value();
// The following status codes have more than one corresponding HttpStatus enum constant.
if (code == 302 || code == 413 || code == 414) {
if (DEPRECATED_CODES.contains(status)) {
continue;
}
assertThat(statusCodes).as("Map has no value for [" + code + "]").containsKey(code);
@@ -138,4 +144,35 @@ class HttpStatusTests {
}
}
@ParameterizedTest(name = "[{index}] code {0}")
@MethodSource("codesWithAliases")
void codeWithDeprecatedAlias(int code, HttpStatus expected, HttpStatus outdated) {
HttpStatus resolved = HttpStatus.valueOf(code);
assertThat(resolved)
.as("HttpStatus.valueOf(" + code + ")")
.isSameAs(expected)
.isNotEqualTo(outdated);
assertThat(outdated.isSameCodeAs(resolved))
.as("outdated isSameCodeAs(resolved)")
.isTrue();
assertThat(outdated.value())
.as("outdated value()")
.isEqualTo(resolved.value());
}
private static final Set<HttpStatus> DEPRECATED_CODES = codesWithAliases()
.stream()
.map(args -> (HttpStatus) args.get()[2])
.collect(Collectors.toUnmodifiableSet());
@SuppressWarnings("deprecation")
static List<Arguments> codesWithAliases() {
return List.of(
arguments(103, HttpStatus.EARLY_HINTS, HttpStatus.CHECKPOINT),
arguments(302, HttpStatus.FOUND, HttpStatus.MOVED_TEMPORARILY),
arguments(413, HttpStatus.PAYLOAD_TOO_LARGE, HttpStatus.REQUEST_ENTITY_TOO_LARGE),
arguments(414, HttpStatus.URI_TOO_LONG, HttpStatus.REQUEST_URI_TOO_LONG)
);
}
}