Update naming for status codes 413 and 422 (#87)

Philippus · web-flow · commit d47433467254 · 2023-08-11T13:48:41.000+02:00
diff --git a/docs/src/test/java/docs/http/javadsl/server/directives/MiscDirectivesExamplesTest.java b/docs/src/test/java/docs/http/javadsl/server/directives/MiscDirectivesExamplesTest.java
@@ -93,7 +93,7 @@ public void testWithSizeLimit() {
 
     testRoute(route)
         .run(withEntityOfSize.apply(501))
-        .assertStatusCode(StatusCodes.PAYLOAD_TOO_LARGE);
+        .assertStatusCode(StatusCodes.CONTENT_TOO_LARGE);
     // #withSizeLimitExample
   }
 
@@ -119,7 +119,7 @@ public void testWithSizeLimitNested() {
 
     testRoute(route)
         .run(withEntityOfSize.apply(801))
-        .assertStatusCode(StatusCodes.PAYLOAD_TOO_LARGE);
+        .assertStatusCode(StatusCodes.CONTENT_TOO_LARGE);
     // #withSizeLimitExampleNested
   }
 
diff --git a/docs/src/test/scala/docs/http/scaladsl/server/directives/MiscDirectivesExamplesSpec.scala b/docs/src/test/scala/docs/http/scaladsl/server/directives/MiscDirectivesExamplesSpec.scala
@@ -139,7 +139,7 @@ class MiscDirectivesExamplesSpec extends RoutingSpec with CompileOnlySpec {
     }
 
     Post("/abc", entityOfSize(501)) ~> Route.seal(route) ~> check {
-      status shouldEqual StatusCodes.PayloadTooLarge
+      status shouldEqual StatusCodes.ContentTooLarge
     }
 
     // #withSizeLimit-example
@@ -184,7 +184,7 @@ class MiscDirectivesExamplesSpec extends RoutingSpec with CompileOnlySpec {
     }
 
     Post("/abc", entityOfSize(801)) ~> Route.seal(route) ~> check {
-      status shouldEqual StatusCodes.PayloadTooLarge
+      status shouldEqual StatusCodes.ContentTooLarge
     }
     // #withSizeLimit-nested-example
   }
diff --git a/http-core/src/main/java/org/apache/pekko/http/javadsl/model/StatusCodes.java b/http-core/src/main/java/org/apache/pekko/http/javadsl/model/StatusCodes.java
@@ -97,10 +97,19 @@ private StatusCodes() {}
       org.apache.pekko.http.scaladsl.model.StatusCodes.LengthRequired();
   public static final StatusCode PRECONDITION_FAILED =
       org.apache.pekko.http.scaladsl.model.StatusCodes.PreconditionFailed();
+
+  public static final StatusCode CONTENT_TOO_LARGE =
+      org.apache.pekko.http.scaladsl.model.StatusCodes.ContentTooLarge();
+
+  /** @deprecated deprecated in favor of CONTENT_TOO_LARGE since 1.1.0 */
+  @Deprecated
   public static final StatusCode PAYLOAD_TOO_LARGE =
       org.apache.pekko.http.scaladsl.model.StatusCodes.PayloadTooLarge();
 
-  /** @deprecated deprecated in favor of PAYLOAD_TOO_LARGE */
+  /**
+   * @deprecated deprecated in favor of PAYLOAD_TOO_LARGE, which was later deprecated in favor of
+   *     CONTENT_TOO_LARGE (please switch to CONTENT_TOO_LARGE)
+   */
   @Deprecated
   public static final StatusCode REQUEST_ENTITY_TOO_LARGE =
       org.apache.pekko.http.scaladsl.model.StatusCodes.RequestEntityTooLarge();
@@ -131,8 +140,14 @@ private StatusCodes() {}
       org.apache.pekko.http.scaladsl.model.StatusCodes.EnhanceYourCalm();
   public static final StatusCode MISDIRECTED_REQUEST =
       org.apache.pekko.http.scaladsl.model.StatusCodes.MisdirectedRequest();
+  public static final StatusCode UNPROCESSABLE_CONTENT =
+      org.apache.pekko.http.scaladsl.model.StatusCodes.UnprocessableContent();
+
+  /** @deprecated deprecated in favor of UNPROCESSABLE_CONTENT since 1.1.0 */
+  @Deprecated
   public static final StatusCode UNPROCESSABLE_ENTITY =
       org.apache.pekko.http.scaladsl.model.StatusCodes.UnprocessableEntity();
+
   public static final StatusCode LOCKED = org.apache.pekko.http.scaladsl.model.StatusCodes.Locked();
   public static final StatusCode FAILED_DEPENDENCY =
       org.apache.pekko.http.scaladsl.model.StatusCodes.FailedDependency();
diff --git a/http-core/src/main/scala/org/apache/pekko/http/impl/engine/parsing/HttpRequestParser.scala b/http-core/src/main/scala/org/apache/pekko/http/impl/engine/parsing/HttpRequestParser.scala
@@ -228,7 +228,7 @@ private[http] final class HttpRequestParser(
               setCompletionHandling(HttpMessageParser.CompletionOk)
               startNewMessage(input, bodyStart)
             } else if (!method.isEntityAccepted) {
-              failMessageStart(UnprocessableEntity, s"${method.name} requests must not have an entity")
+              failMessageStart(UnprocessableContent, s"${method.name} requests must not have an entity")
             } else if (contentLength <= input.size - bodyStart) {
               val cl = contentLength.toInt
               emitRequestStart(strictEntity(cth, input, bodyStart, cl))
@@ -240,7 +240,7 @@ private[http] final class HttpRequestParser(
             }
           } else {
             if (!method.isEntityAccepted) {
-              failMessageStart(UnprocessableEntity, s"${method.name} requests must not have an entity")
+              failMessageStart(UnprocessableContent, s"${method.name} requests must not have an entity")
             } else {
               if (clh.isEmpty) {
                 emitRequestStart(chunkedEntity(cth), headers)
diff --git a/http-core/src/main/scala/org/apache/pekko/http/impl/engine/server/HttpServerBluePrint.scala b/http-core/src/main/scala/org/apache/pekko/http/impl/engine/server/HttpServerBluePrint.scala
@@ -546,7 +546,7 @@ private[http] object HttpServerBluePrint {
                   }
                   val info =
                     ErrorInfo(summary, "Consider increasing the value of pekko.http.server.parsing.max-content-length")
-                  finishWithIllegalRequestError(StatusCodes.PayloadTooLarge, info)
+                  finishWithIllegalRequestError(StatusCodes.ContentTooLarge, info)
 
                 case IllegalUriException(errorInfo) =>
                   finishWithIllegalRequestError(StatusCodes.BadRequest, errorInfo)
diff --git a/http-core/src/main/scala/org/apache/pekko/http/scaladsl/model/StatusCode.scala b/http-core/src/main/scala/org/apache/pekko/http/scaladsl/model/StatusCode.scala
@@ -151,9 +151,11 @@ object StatusCodes extends ObjectRegistry[Int, StatusCode] {
   val Gone                         = reg(c(410)("Gone", "The resource requested is no longer available and will not be available again."))
   val LengthRequired               = reg(c(411)("Length Required", "The request did not specify the length of its content, which is required by the requested resource."))
   val PreconditionFailed           = reg(c(412)("Precondition Failed", "The server does not meet one of the preconditions that the requester put on the request."))
-  val PayloadTooLarge              = reg(c(413)("Payload Too Large", "The request payload is larger than the server is willing or able to process."))
-  @deprecated("deprecated in favor of PayloadTooLarge", "Akka HTTP 10.1.11")
-  val RequestEntityTooLarge        = PayloadTooLarge
+  val ContentTooLarge              = reg(c(413)("Content Too Large", "The request content is larger than the server is willing or able to process."))
+  @deprecated("deprecated in favor of ContentTooLarge", "1.1.0")
+  val PayloadTooLarge              = ContentTooLarge
+  @deprecated("deprecated in favor of PayloadTooLarge, which was later deprecated in favor of ContentTooLarge (please switch to ContentTooLarge)", "Akka HTTP 10.1.11")
+  val RequestEntityTooLarge        = ContentTooLarge
   val UriTooLong                   = reg(c(414)("URI Too Long", "The URI provided was too long for the server to process."))
   @deprecated("deprecated in favor of UriTooLong", "Akka HTTP 10.1.11")
   val RequestUriTooLong            = UriTooLong
@@ -165,7 +167,9 @@ object StatusCodes extends ObjectRegistry[Int, StatusCode] {
   val ImATeapot                    = reg(c(418)("I'm a teapot", "The resulting entity body MAY be short and stout."))
   val EnhanceYourCalm              = reg(c(420)("Enhance Your Calm", "You are being rate-limited.")) // Twitter only
   val MisdirectedRequest           = reg(c(421)("Misdirected Request", "The request was directed at a server that is not able to produce a response.")) // HTTP/2 only. https://tools.ietf.org/html/rfc7540#section-9.1.2
-  val UnprocessableEntity          = reg(c(422)("Unprocessable Entity", "The request was well-formed but was unable to be followed due to semantic errors."))
+  val UnprocessableContent         = reg(c(422)("Unprocessable Content", "The request was well-formed but was unable to be followed due to semantic errors."))
+  @deprecated("deprecated in favor of UnprocessableContent", "1.1.0")
+  val UnprocessableEntity          = UnprocessableContent
   val Locked                       = reg(c(423)("Locked", "The resource that is being accessed is locked."))
   val FailedDependency             = reg(c(424)("Failed Dependency", "The request failed due to failure of a previous request."))
   val TooEarly                     = reg(c(425)("Too Early", "The server is unwilling to risk processing a request that might be replayed.")) // RFC 8470
diff --git a/http-core/src/test/scala/org/apache/pekko/http/impl/engine/server/HttpServerSpec.scala b/http-core/src/test/scala/org/apache/pekko/http/impl/engine/server/HttpServerSpec.scala
@@ -1394,7 +1394,7 @@ class HttpServerSpec extends PekkoSpec(
                 responses.sendError(error.asInstanceOf[Exception])
 
                 expectResponseWithWipedDate(
-                  s"""HTTP/1.1 413 Payload Too Large
+                  s"""HTTP/1.1 413 Content Too Large
                       |Server: pekko-http/test
                       |Date: XXXX
                       |Connection: close
@@ -1418,7 +1418,7 @@ class HttpServerSpec extends PekkoSpec(
                 responses.sendError(error.asInstanceOf[Exception])
 
                 expectResponseWithWipedDate(
-                  s"""HTTP/1.1 413 Payload Too Large
+                  s"""HTTP/1.1 413 Content Too Large
                     |Server: pekko-http/test
                     |Date: XXXX
                     |Connection: close
diff --git a/http-tests/src/test/java/org/apache/pekko/http/javadsl/server/directives/MiscDirectivesTest.java b/http-tests/src/test/java/org/apache/pekko/http/javadsl/server/directives/MiscDirectivesTest.java
@@ -99,7 +99,7 @@ public void testWithSizeLimit() {
 
     route.run(withEntityOfSize(500)).assertStatusCode(StatusCodes.OK);
 
-    route.run(withEntityOfSize(501)).assertStatusCode(StatusCodes.PAYLOAD_TOO_LARGE);
+    route.run(withEntityOfSize(501)).assertStatusCode(StatusCodes.CONTENT_TOO_LARGE);
   }
 
   private HttpRequest withEntityOfSize(int sizeLimit) {
diff --git a/http-tests/src/test/java/org/apache/pekko/http/javadsl/server/directives/RouteDirectivesTest.java b/http-tests/src/test/java/org/apache/pekko/http/javadsl/server/directives/RouteDirectivesTest.java
@@ -97,7 +97,7 @@ public void testEntitySizeLargerThanLimit() {
 
     route
         .run(HttpRequest.create("/limit-5").withEntity("1234567890"))
-        .assertStatusCode(StatusCodes.PAYLOAD_TOO_LARGE)
+        .assertStatusCode(StatusCodes.CONTENT_TOO_LARGE)
         .assertEntity(
             "EntityStreamSizeException: incoming entity size (10) exceeded size limit (5 bytes)! "
                 + "This may have been a parser limit (set via `pekko.http.[server|client].parsing.max-content-length`), "
diff --git a/http-tests/src/test/scala/org/apache/pekko/http/scaladsl/server/SizeLimitSpec.scala b/http-tests/src/test/scala/org/apache/pekko/http/scaladsl/server/SizeLimitSpec.scala
@@ -78,7 +78,7 @@ class SizeLimitSpec extends AnyWordSpec with Matchers with RequestBuilding with
 
     "not accept entities bigger than configured with pekko.http.parsing.max-content-length" in {
       Http().singleRequest(Post(s"http:/${binding.localAddress}/noDirective", entityOfSize(maxContentLength + 1)))
-        .futureValue.status shouldEqual StatusCodes.PayloadTooLarge
+        .futureValue.status shouldEqual StatusCodes.ContentTooLarge
     }
   }
 
@@ -116,7 +116,7 @@ class SizeLimitSpec extends AnyWordSpec with Matchers with RequestBuilding with
       data.size should be > decodeMaxSize
 
       Http().singleRequest(request)
-        .futureValue.status shouldEqual StatusCodes.PayloadTooLarge
+        .futureValue.status shouldEqual StatusCodes.ContentTooLarge
     }
   }
 
@@ -139,7 +139,7 @@ class SizeLimitSpec extends AnyWordSpec with Matchers with RequestBuilding with
       val request =
         Post(s"http:/${binding.localAddress}/noDirective", "x").withHeaders(`Content-Encoding`(HttpEncoding("custom")))
       val response = Http().singleRequest(request).futureValue
-      response.status shouldEqual StatusCodes.PayloadTooLarge
+      response.status shouldEqual StatusCodes.ContentTooLarge
     }
   }
 
@@ -162,7 +162,7 @@ class SizeLimitSpec extends AnyWordSpec with Matchers with RequestBuilding with
       val request =
         Post(s"http:/${binding.localAddress}/noDirective", "x").withHeaders(`Content-Encoding`(HttpEncoding("custom")))
       val response = Http().singleRequest(request).futureValue
-      response.status shouldEqual StatusCodes.PayloadTooLarge
+      response.status shouldEqual StatusCodes.ContentTooLarge
     }
   }
 
diff --git a/http-tests/src/test/scala/org/apache/pekko/http/scaladsl/server/directives/MiscDirectivesSpec.scala b/http-tests/src/test/scala/org/apache/pekko/http/scaladsl/server/directives/MiscDirectivesSpec.scala
@@ -117,7 +117,7 @@ class MiscDirectivesSpec extends RoutingSpec {
       }
 
       Post("/abc", entityOfSize(501)) ~> Route.seal(route) ~> check {
-        status shouldEqual StatusCodes.PayloadTooLarge
+        status shouldEqual StatusCodes.ContentTooLarge
         entityAs[String] should include("exceeded size limit")
       }
     }
@@ -135,7 +135,7 @@ class MiscDirectivesSpec extends RoutingSpec {
       }
 
       Post("/abc", formDataOfSize(128)) ~> Route.seal(route) ~> check {
-        status shouldEqual StatusCodes.PayloadTooLarge
+        status shouldEqual StatusCodes.ContentTooLarge
         responseAs[String] shouldEqual "The request content was malformed:\n" +
         "EntityStreamSizeException: incoming entity size (134) " +
         "exceeded size limit (64 bytes)! " +
@@ -160,7 +160,7 @@ class MiscDirectivesSpec extends RoutingSpec {
       }
 
       Post("/abc", entityOfSize(801)) ~> Route.seal(route) ~> check {
-        status shouldEqual StatusCodes.PayloadTooLarge
+        status shouldEqual StatusCodes.ContentTooLarge
         entityAs[String] should include("exceeded size limit")
       }
 
@@ -178,7 +178,7 @@ class MiscDirectivesSpec extends RoutingSpec {
       }
 
       Post("/abc", entityOfSize(401)) ~> Route.seal(route2) ~> check {
-        status shouldEqual StatusCodes.PayloadTooLarge
+        status shouldEqual StatusCodes.ContentTooLarge
         entityAs[String] should include("exceeded size limit")
       }
     }
diff --git a/http/src/main/scala/org/apache/pekko/http/scaladsl/server/ExceptionHandler.scala b/http/src/main/scala/org/apache/pekko/http/scaladsl/server/ExceptionHandler.scala
@@ -63,9 +63,9 @@ object ExceptionHandler {
           ctx.complete((status, info.format(settings.verboseErrorMessages)))
         }
       case e: EntityStreamSizeException => ctx => {
-          ctx.log.error(e, ErrorMessageTemplate, e, PayloadTooLarge)
+          ctx.log.error(e, ErrorMessageTemplate, e, ContentTooLarge)
           ctx.request.discardEntityBytes(ctx.materializer)
-          ctx.complete((PayloadTooLarge, e.getMessage))
+          ctx.complete((ContentTooLarge, e.getMessage))
         }
       case e: ExceptionWithErrorInfo => ctx => {
           ctx.log.error(e, ErrorMessageTemplate, e.info.formatPretty, InternalServerError)
diff --git a/http/src/main/scala/org/apache/pekko/http/scaladsl/server/RejectionHandler.scala b/http/src/main/scala/org/apache/pekko/http/scaladsl/server/RejectionHandler.scala
@@ -202,7 +202,7 @@ object RejectionHandler {
         case MalformedRequestContentRejection(msg, throwable) => {
           val rejectionMessage = "The request content was malformed:\n" + msg
           throwable match {
-            case _: EntityStreamSizeException => rejectRequestEntityAndComplete((PayloadTooLarge, rejectionMessage))
+            case _: EntityStreamSizeException => rejectRequestEntityAndComplete((ContentTooLarge, rejectionMessage))
             case _                            => rejectRequestEntityAndComplete((BadRequest, rejectionMessage))
           }
         }

Original file line number	Diff line number	Diff line change
`@@ -93,7 +93,7 @@ public void testWithSizeLimit() {`
`93`	`93`
`94`	`94`	`testRoute(route)`
`95`	`95`	`.run(withEntityOfSize.apply(501))`
`96`		`- .assertStatusCode(StatusCodes.PAYLOAD_TOO_LARGE);`
	`96`	`+ .assertStatusCode(StatusCodes.CONTENT_TOO_LARGE);`
`97`	`97`	`// #withSizeLimitExample`
`98`	`98`	`}`
`99`	`99`
`@@ -119,7 +119,7 @@ public void testWithSizeLimitNested() {`
`119`	`119`
`120`	`120`	`testRoute(route)`
`121`	`121`	`.run(withEntityOfSize.apply(801))`
`122`		`- .assertStatusCode(StatusCodes.PAYLOAD_TOO_LARGE);`
	`122`	`+ .assertStatusCode(StatusCodes.CONTENT_TOO_LARGE);`
`123`	`123`	`// #withSizeLimitExampleNested`
`124`	`124`	`}`
`125`	`125`
Original file line number	Diff line number	Diff line change
`@@ -139,7 +139,7 @@ class MiscDirectivesExamplesSpec extends RoutingSpec with CompileOnlySpec {`
`139`	`139`	`}`
`140`	`140`
`141`	`141`	`Post("/abc", entityOfSize(501)) ~> Route.seal(route) ~> check {`
`142`		`- status shouldEqual StatusCodes.PayloadTooLarge`
	`142`	`+ status shouldEqual StatusCodes.ContentTooLarge`
`143`	`143`	`}`
`144`	`144`
`145`	`145`	`// #withSizeLimit-example`
`@@ -184,7 +184,7 @@ class MiscDirectivesExamplesSpec extends RoutingSpec with CompileOnlySpec {`
`184`	`184`	`}`
`185`	`185`
`186`	`186`	`Post("/abc", entityOfSize(801)) ~> Route.seal(route) ~> check {`
`187`		`- status shouldEqual StatusCodes.PayloadTooLarge`
	`187`	`+ status shouldEqual StatusCodes.ContentTooLarge`
`188`	`188`	`}`
`189`	`189`	`// #withSizeLimit-nested-example`
`190`	`190`	`}`
Original file line number	Diff line number	Diff line change
`@@ -546,7 +546,7 @@ private[http] object HttpServerBluePrint {`
`546`	`546`	`}`
`547`	`547`	`val info =`
`548`	`548`	`ErrorInfo(summary, "Consider increasing the value of pekko.http.server.parsing.max-content-length")`
`549`		`- finishWithIllegalRequestError(StatusCodes.PayloadTooLarge, info)`
	`549`	`+ finishWithIllegalRequestError(StatusCodes.ContentTooLarge, info)`
`550`	`550`
`551`	`551`	`case IllegalUriException(errorInfo) =>`
`552`	`552`	`finishWithIllegalRequestError(StatusCodes.BadRequest, errorInfo)`
Original file line number	Diff line number	Diff line change
`@@ -99,7 +99,7 @@ public void testWithSizeLimit() {`
`99`	`99`
`100`	`100`	`route.run(withEntityOfSize(500)).assertStatusCode(StatusCodes.OK);`
`101`	`101`
`102`		`- route.run(withEntityOfSize(501)).assertStatusCode(StatusCodes.PAYLOAD_TOO_LARGE);`
	`102`	`+ route.run(withEntityOfSize(501)).assertStatusCode(StatusCodes.CONTENT_TOO_LARGE);`
`103`	`103`	`}`
`104`	`104`
`105`	`105`	`private HttpRequest withEntityOfSize(int sizeLimit) {`
Original file line number	Diff line number	Diff line change
`@@ -78,7 +78,7 @@ class SizeLimitSpec extends AnyWordSpec with Matchers with RequestBuilding with`
`78`	`78`
`79`	`79`	`"not accept entities bigger than configured with pekko.http.parsing.max-content-length" in {`
`80`	`80`	`Http().singleRequest(Post(s"http:/${binding.localAddress}/noDirective", entityOfSize(maxContentLength + 1)))`
`81`		`- .futureValue.status shouldEqual StatusCodes.PayloadTooLarge`
	`81`	`+ .futureValue.status shouldEqual StatusCodes.ContentTooLarge`
`82`	`82`	`}`
`83`	`83`	`}`
`84`	`84`
`@@ -116,7 +116,7 @@ class SizeLimitSpec extends AnyWordSpec with Matchers with RequestBuilding with`
`116`	`116`	`data.size should be > decodeMaxSize`
`117`	`117`
`118`	`118`	`Http().singleRequest(request)`
`119`		`- .futureValue.status shouldEqual StatusCodes.PayloadTooLarge`
	`119`	`+ .futureValue.status shouldEqual StatusCodes.ContentTooLarge`
`120`	`120`	`}`
`121`	`121`	`}`
`122`	`122`
`@@ -139,7 +139,7 @@ class SizeLimitSpec extends AnyWordSpec with Matchers with RequestBuilding with`
`139`	`139`	`val request =`
`140`	`140`	Post(s"http:/${binding.localAddress}/noDirective", "x").withHeaders(`Content-Encoding`(HttpEncoding("custom")))
`141`	`141`	`val response = Http().singleRequest(request).futureValue`
`142`		`- response.status shouldEqual StatusCodes.PayloadTooLarge`
	`142`	`+ response.status shouldEqual StatusCodes.ContentTooLarge`
`143`	`143`	`}`
`144`	`144`	`}`
`145`	`145`
`@@ -162,7 +162,7 @@ class SizeLimitSpec extends AnyWordSpec with Matchers with RequestBuilding with`
`162`	`162`	`val request =`
`163`	`163`	Post(s"http:/${binding.localAddress}/noDirective", "x").withHeaders(`Content-Encoding`(HttpEncoding("custom")))
`164`	`164`	`val response = Http().singleRequest(request).futureValue`
`165`		`- response.status shouldEqual StatusCodes.PayloadTooLarge`
	`165`	`+ response.status shouldEqual StatusCodes.ContentTooLarge`
`166`	`166`	`}`
`167`	`167`	`}`
`168`	`168`