Merge pull request #529 from playframework/mergify/bp/2.9.x/pr-526

[2.9.x] Run tests with netty backend + mention netty backend in each `README` (backport #526) by @mkurz

.github/workflows/build-test.yml

@@ -19,8 +19,8 @@ jobs:
 #    with:
 #      cmd: sbt validateCode
 
-  tests:
-    name: Sbt Tests
+  tests-akka-http:
+    name: Sbt Tests Akka HTTP
 #    needs:
 #      - "check-code-style"
     uses: playframework/.github/.github/workflows/cmd.yml@v3
@@ -31,6 +31,17 @@ jobs:
         # sudo add-apt-repository -y ppa:ondrej/php && sudo apt-get -qq update && sudo apt-get install -y libsodium-dev # for secure session examples
         ./test.sh
 
+  tests-netty-http:
+    name: Sbt Tests Netty HTTP
+#    needs:
+#      - "check-code-style"
+    uses: playframework/.github/.github/workflows/cmd.yml@v3
+    with:
+      java: 17, 11
+      scala: 2.13.x, 3.x
+      cmd: |
+        ./test.sh --netty
+
   gradle-tests:
     name: Gradle Tests
     uses: playframework/.github/.github/workflows/cmd.yml@v3
@@ -44,6 +55,7 @@ jobs:
     name: Finish
     if: github.event_name == 'pull_request'
     needs: # Should be last
-      - "tests"
+      - "tests-akka-http"
+      - "tests-netty-http"
       - "gradle-tests"
     uses: playframework/.github/.github/workflows/rtm.yml@v3

play-java-akka-cluster-example/README.md

@@ -32,6 +32,12 @@ See the source code in [`modules/AppModule.java`](modules/AppModule.java) for th
 
 but it doesn't demonstrate the [`Akka Cluster Bootstrap`](https://doc.akka.io/docs/akka/2.6/typed/cluster.html#joining-automatically-to-seed-nodes-with-cluster-bootstrap)
 
+## Server backend
+
+By default, the project uses the Akka HTTP Server backend. To switch to the Netty Server backend, enable the `PlayNettyServer` sbt plugin in the `build.sbt` file.
+In the `build.sbt` of this project, you'll find a commented line for this setting; simply uncomment it to make the switch.
+For more detailed information, refer to the Play Framework [documentation](https://www.playframework.com/documentation/3.0.x/Server).
+
 ## Running this sample in Dev Mode
 
 To run this sample in `Dev Mode` use the regular 

play-java-akka-cluster-example/build.sbt

@@ -6,6 +6,7 @@ organization := "com.example"
 version := "1.0-SNAPSHOT"
 
 lazy val root = (project in file(".")).enablePlugins(PlayJava)
+  //.enablePlugins(PlayNettyServer).disablePlugins(PlayAkkaHttpServer) // uncomment to use the Netty backend
 
 crossScalaVersions := Seq("2.13.12", "3.3.1")
 

play-java-chatroom-example/README.md

@@ -61,6 +61,12 @@ sbt run
 
 Go to <http://localhost:9000> and open it in two different browsers.  Typing into one browser will cause it to show up in another browser.
 
+## Server backend
+
+By default, the project uses the Akka HTTP Server backend. To switch to the Netty Server backend, enable the `PlayNettyServer` sbt plugin in the `build.sbt` file.
+In the `build.sbt` of this project, you'll find a commented line for this setting; simply uncomment it to make the switch.
+For more detailed information, refer to the Play Framework [documentation](https://www.playframework.com/documentation/3.0.x/Server).
+
 ## Tributes
 
 This project is originally taken from Johan Andrén's [Akka-HTTP version](https://github.com/johanandren/chat-with-akka-http-websockets/tree/akka-2.4.10):

play-java-chatroom-example/build.sbt

@@ -1,5 +1,6 @@
 lazy val root = (project in file("."))
   .enablePlugins(PlayJava)
+  //.enablePlugins(PlayNettyServer).disablePlugins(PlayAkkaHttpServer) // uncomment to use the Netty backend
   .settings(
     name := """play-java-chatroom-example""",
     version := "1.0-SNAPSHOT",

play-java-compile-di-example/README.md

@@ -16,3 +16,10 @@ sbt run
 ```
 
 Then go to the server at <http://localhost:9000> to see "Hello".
+
+## Server backend
+
+By default, the project uses the Akka HTTP Server backend. To switch to the Netty Server backend, enable the `PlayNettyServer` sbt plugin in the `build.sbt` file.
+In the `build.sbt` of this project, you'll find a commented line for this setting; simply uncomment it to make the switch.
+For more detailed information, refer to the Play Framework [documentation](https://www.playframework.com/documentation/3.0.x/Server).
+

play-java-compile-di-example/build.sbt

@@ -3,6 +3,7 @@ name := """play-java-compile-di-example"""
 version := "1.0-SNAPSHOT"
 
 lazy val root = (project in file(".")).enablePlugins(PlayJava)
+//.enablePlugins(PlayNettyServer).disablePlugins(PlayAkkaHttpServer) // uncomment to use the Netty backend
 
 crossScalaVersions := Seq("2.13.12", "3.3.1")
 

play-java-dagger2-example/README.md

@@ -12,6 +12,12 @@ Then go to http://localhost:9000 to see the time and change the time zone.
 
 Go to http://localhost:9000/ws to see the WS client pull the time from a remote service (really the app itself). 
 
+## Server backend
+
+By default, the project uses the Akka HTTP Server backend. To switch to the Netty Server backend, enable the `PlayNettyServer` sbt plugin in the `build.sbt` file.
+In the `build.sbt` of this project, you'll find a commented line for this setting; simply uncomment it to make the switch.
+For more detailed information, refer to the Play Framework [documentation](https://www.playframework.com/documentation/3.0.x/Server).
+
 ## Background
 
 [Dagger 2](https://google.github.io/dagger/) is a compile time dependency injection system. This means that [dependencies are still declared](https://google.github.io/dagger/users-guide.html#declaring-dependencies) with `@Inject`, but the compiler is responsible for resolving the graph.

play-java-dagger2-example/build.sbt

@@ -1,5 +1,6 @@
 lazy val root = (project in file("."))
   .enablePlugins(PlayJava)
+  //.enablePlugins(PlayNettyServer).disablePlugins(PlayAkkaHttpServer) // uncomment to use the Netty backend
   .settings(
     name := """play-java-dagger2-example""",
     version := "1.0-SNAPSHOT",

play-java-ebean-example/README.md

@@ -6,6 +6,12 @@ The GitHub location for this project is inside:
 
 <https://github.com/playframework/play-samples>
 
+## Server backend
+
+By default, the project uses the Akka HTTP Server backend. To switch to the Netty Server backend, enable the `PlayNettyServer` sbt plugin in the `build.sbt` file.
+In the `build.sbt` of this project, you'll find a commented line for this setting; simply uncomment it to make the switch.
+For more detailed information, refer to the Play Framework [documentation](https://www.playframework.com/documentation/3.0.x/Server).
+
 ## Play
 
 Play documentation is here:

play-java-ebean-example/build.sbt

@@ -1,5 +1,6 @@
 lazy val root = (project in file("."))
   .enablePlugins(PlayJava, PlayEbean)
+  //.enablePlugins(PlayNettyServer).disablePlugins(PlayAkkaHttpServer) // uncomment to use the Netty backend
   .settings(
     name := "play-java-ebean-example",
     version := "1.0.0-SNAPSHOT",

play-java-fileupload-example/README.md

@@ -92,3 +92,9 @@ abstract Function<Multipart.FileInfo, Accumulator<ByteString, Http.MultipartForm
 ```
 
 `DelegatingMultipartFormDataBodyParser` does not know about any particular type, only `FilePart<A>`, and so it falls to the implementation to fill in the details. 
+
+## Server backend
+
+By default, the project uses the Akka HTTP Server backend. To switch to the Netty Server backend, enable the `PlayNettyServer` sbt plugin in the `build.sbt` file.
+In the `build.sbt` of this project, you'll find a commented line for this setting; simply uncomment it to make the switch.
+For more detailed information, refer to the Play Framework [documentation](https://www.playframework.com/documentation/3.0.x/Server).

play-java-fileupload-example/build.sbt

@@ -1,5 +1,6 @@
 lazy val root = (project in file("."))
   .enablePlugins(PlayJava)
+  //.enablePlugins(PlayNettyServer).disablePlugins(PlayAkkaHttpServer) // uncomment to use the Netty backend
   .settings(
     name := """play-java-fileupload-example""",
     version := "1.0-SNAPSHOT",

play-java-forms-example/README.md

@@ -12,6 +12,12 @@ sbt run
 
 And open <http://localhost:9000/>
 
+## Server backend
+
+By default, the project uses the Akka HTTP Server backend. To switch to the Netty Server backend, enable the `PlayNettyServer` sbt plugin in the `build.sbt` file.
+In the `build.sbt` of this project, you'll find a commented line for this setting; simply uncomment it to make the switch.
+For more detailed information, refer to the Play Framework [documentation](https://www.playframework.com/documentation/3.0.x/Server).
+
 ## Documentation
 
 Please see <https://playframework.com/documentation/latest/JavaForms>.

play-java-forms-example/build.sbt

@@ -3,6 +3,7 @@ name := """play-java-forms-example"""
 version := "1.0-SNAPSHOT"
 
 lazy val root = (project in file(".")).enablePlugins(PlayJava)
+  //.enablePlugins(PlayNettyServer).disablePlugins(PlayAkkaHttpServer) // uncomment to use the Netty backend
 
 crossScalaVersions := Seq("2.13.12", "3.3.1")
 

play-java-hello-world-tutorial/README.md

@@ -35,3 +35,9 @@ To build and run the project:
 3. After the message `Server started, ...` displays, enter the following URL in a browser: <http://localhost:9000>
 
 The Play application responds: `Welcome to the Hello World Tutorial!`
+
+## Server backend
+
+By default, the project uses the Akka HTTP Server backend. To switch to the Netty Server backend, enable the `PlayNettyServer` sbt plugin in the `build.sbt` file.
+In the `build.sbt` of this project, you'll find a commented line for this setting; simply uncomment it to make the switch.
+For more detailed information, refer to the Play Framework [documentation](https://www.playframework.com/documentation/3.0.x/Server).

play-java-hello-world-tutorial/build.sbt

@@ -4,6 +4,7 @@ organization := "com.example"
 version := "1.0-SNAPSHOT"
 
 lazy val root = (project in file(".")).enablePlugins(PlayJava)
+  //.enablePlugins(PlayNettyServer).disablePlugins(PlayAkkaHttpServer) // uncomment to use the Netty backend
 
 crossScalaVersions := Seq("2.13.12", "3.3.1")
 

play-java-jpa-example/README.md

@@ -7,3 +7,9 @@ Please see the Play documentation for more details:
 * https://www.playframework.com/documentation/latest/JavaJPA
 * https://www.playframework.com/documentation/latest/ThreadPools
 * https://www.playframework.com/documentation/latest/JavaAsync
+
+## Server backend
+
+By default, the project uses the Akka HTTP Server backend. To switch to the Netty Server backend, enable the `PlayNettyServer` sbt plugin in the `build.sbt` file.
+In the `build.sbt` of this project, you'll find a commented line for this setting; simply uncomment it to make the switch.
+For more detailed information, refer to the Play Framework [documentation](https://www.playframework.com/documentation/3.0.x/Server).

play-java-jpa-example/build.sbt

@@ -1,5 +1,6 @@
 lazy val root = (project in file("."))
   .enablePlugins(PlayJava)
+  //.enablePlugins(PlayNettyServer).disablePlugins(PlayAkkaHttpServer) // uncomment to use the Netty backend
   .settings(
     name := """play-java-jpa-example""",
     version := "1.0-SNAPSHOT",

play-java-rest-api-example/README.md

@@ -45,3 +45,9 @@ Once the test completes, you'll see an HTML file containing the load test chart,
 ```
 
 That will contain your load test results.
+
+## Server backend
+
+By default, the project uses the Akka HTTP Server backend. To switch to the Netty Server backend, enable the `PlayNettyServer` sbt plugin in the `build.sbt` file.
+In the `build.sbt` of this project, you'll find a commented line for this setting; simply uncomment it to make the switch.
+For more detailed information, refer to the Play Framework [documentation](https://www.playframework.com/documentation/3.0.x/Server).

play-java-rest-api-example/build.sbt

@@ -3,6 +3,7 @@ lazy val scala3 = "3.3.1"
 
 lazy val root = (project in file("."))
   .enablePlugins(PlayJava)
+  //.enablePlugins(PlayNettyServer).disablePlugins(PlayAkkaHttpServer) // uncomment to use the Netty backend
   .settings(
     name := "play-java-rest-api-example",
     version := "1.0-SNAPSHOT",

play-java-starter-example/README.md

@@ -49,3 +49,9 @@ There are several demonstration files available in this template.
 - `ExampleFilter.java`:
 
   A simple filter that adds a header to every response.
+
+## Server backend
+
+By default, the project uses the Akka HTTP Server backend. To switch to the Netty Server backend, enable the `PlayNettyServer` sbt plugin in the `build.sbt` file.
+In the `build.sbt` of this project, you'll find a commented line for this setting; simply uncomment it to make the switch.
+For more detailed information, refer to the Play Framework [documentation](https://www.playframework.com/documentation/3.0.x/Server).

play-java-starter-example/build.sbt

@@ -1,5 +1,6 @@
 lazy val root = (project in file("."))
   .enablePlugins(PlayJava)
+  //.enablePlugins(PlayNettyServer).disablePlugins(PlayAkkaHttpServer) // uncomment to use the Netty backend
   .settings(
     name := """play-java-starter-example""",
     version := "1.0-SNAPSHOT",

play-java-streaming-example/README.md

@@ -5,3 +5,9 @@ This is an example Play template that demonstrates Streaming with Server Sent Ev
 Please see the documentation at:
 
 * <https://www.playframework.com/documentation/latest/JavaComet>
+
+## Server backend
+
+By default, the project uses the Akka HTTP Server backend. To switch to the Netty Server backend, enable the `PlayNettyServer` sbt plugin in the `build.sbt` file.
+In the `build.sbt` of this project, you'll find a commented line for this setting; simply uncomment it to make the switch.
+For more detailed information, refer to the Play Framework [documentation](https://www.playframework.com/documentation/3.0.x/Server).

play-java-streaming-example/build.sbt

@@ -6,6 +6,7 @@ crossScalaVersions := Seq("2.13.12", "3.3.1")
 scalaVersion := crossScalaVersions.value.head
 
 lazy val root = (project in file(".")).enablePlugins(PlayJava)
+  //.enablePlugins(PlayNettyServer).disablePlugins(PlayAkkaHttpServer) // uncomment to use the Netty backend
 
 libraryDependencies += guice
 

play-java-websocket-example/README.md

@@ -6,6 +6,12 @@ The Websocket API is built on Akka Streams, and so is async, non-blocking, and b
 
 There are also tests showing how Junit and Akka Testkit are used to test actors and flows.
 
+## Server backend
+
+By default, the project uses the Akka HTTP Server backend. To switch to the Netty Server backend, enable the `PlayNettyServer` sbt plugin in the `build.sbt` file.
+In the `build.sbt` of this project, you'll find a commented line for this setting; simply uncomment it to make the switch.
+For more detailed information, refer to the Play Framework [documentation](https://www.playframework.com/documentation/3.0.x/Server).
+
 ## Reactive Push
 
 This application uses a WebSocket to push data to the browser in real-time.  To create a WebSocket connection in Play, first a route must be defined in the `routes` file.  Here is the route which will be used to setup the WebSocket connection:

play-java-websocket-example/build.sbt

@@ -1,5 +1,6 @@
 lazy val root = (project in file("."))
   .enablePlugins(PlayJava)
+  //.enablePlugins(PlayNettyServer).disablePlugins(PlayAkkaHttpServer) // uncomment to use the Netty backend
   .settings(
     name := "play-java-websocket-example",
     version := "1.0",

play-scala-anorm-example/README.md

@@ -2,6 +2,12 @@
 
 This is an example Play application that uses Scala on the front end, and communicates with an in memory database using Anorm.
 
+## Server backend
+
+By default, the project uses the Akka HTTP Server backend. To switch to the Netty Server backend, enable the `PlayNettyServer` sbt plugin in the `build.sbt` file.
+In the `build.sbt` of this project, you'll find a commented line for this setting; simply uncomment it to make the switch.
+For more detailed information, refer to the Play Framework [documentation](https://www.playframework.com/documentation/3.0.x/Server).
+
 ## Play
 
 Play documentation is here:

play-scala-anorm-example/build.sbt

@@ -1,5 +1,6 @@
 lazy val root = (project in file("."))
   .enablePlugins(PlayScala)
+  //.enablePlugins(PlayNettyServer).disablePlugins(PlayAkkaHttpServer) // uncomment to use the Netty backend
   .settings(
     name := "play-scala-anorm-example",
     version := "1.0-SNAPSHOT",

play-scala-chatroom-example/README.md

@@ -67,6 +67,12 @@ sbt run
 
 Go to <http://localhost:9000> and open it in two different browsers.  Typing into one browser will cause it to show up in another browser.
 
+## Server backend
+
+By default, the project uses the Akka HTTP Server backend. To switch to the Netty Server backend, enable the `PlayNettyServer` sbt plugin in the `build.sbt` file.
+In the `build.sbt` of this project, you'll find a commented line for this setting; simply uncomment it to make the switch.
+For more detailed information, refer to the Play Framework [documentation](https://www.playframework.com/documentation/3.0.x/Server).
+
 ## Tributes
 
 This project is originally taken from Johan Andrén's [Akka-HTTP version](https://github.com/johanandren/chat-with-akka-http-websockets/tree/akka-2.4.10):

play-scala-chatroom-example/build.sbt

@@ -2,6 +2,7 @@ import play.core.PlayVersion.akkaVersion
 
 lazy val root = (project in file("."))
   .enablePlugins(PlayScala)
+  //.enablePlugins(PlayNettyServer).disablePlugins(PlayAkkaHttpServer) // uncomment to use the Netty backend
   .settings(
     name := """play-scala-chatroom-example""",
     version := "1.0-SNAPSHOT",

play-scala-compile-di-example/README.md

@@ -47,6 +47,12 @@ class ServerSpec extends PlaySpec
 }
 ```
 
+## Server backend
+
+By default, the project uses the Akka HTTP Server backend. To switch to the Netty Server backend, enable the `PlayNettyServer` sbt plugin in the `build.sbt` file.
+In the `build.sbt` of this project, you'll find a commented line for this setting; simply uncomment it to make the switch.
+For more detailed information, refer to the Play Framework [documentation](https://www.playframework.com/documentation/3.0.x/Server).
+
 ## Further Documentation
 
 * [Compile Time Dependency Injection](https://www.playframework.com/documentation/latest/ScalaCompileTimeDependencyInjection)

play-scala-compile-di-example/build.sbt

@@ -1,5 +1,6 @@
 lazy val root = (project in file("."))
   .enablePlugins(PlayScala)
+  //.enablePlugins(PlayNettyServer).disablePlugins(PlayAkkaHttpServer) // uncomment to use the Netty backend
   .settings(
     name := """play-scala-compile-di-example""",
     version := "1.0-SNAPSHOT",

play-scala-fileupload-example/README.md

@@ -4,6 +4,12 @@ This is a sample project that shows how to upload a file through Akka Streams us
 
 Play's Scala API for `parse.multipartFormData` uses a `BodyParser[MultipartFormData[TemporaryFile]]`.  The `TemporaryFile` wrapper class creates a file under a "temporary" name and then deletes it only when the system is under GC pressure.
 
+## Server backend
+
+By default, the project uses the Akka HTTP Server backend. To switch to the Netty Server backend, enable the `PlayNettyServer` sbt plugin in the `build.sbt` file.
+In the `build.sbt` of this project, you'll find a commented line for this setting; simply uncomment it to make the switch.
+For more detailed information, refer to the Play Framework [documentation](https://www.playframework.com/documentation/3.0.x/Server).
+
 ## Customizing the Body Parser
 
 There are cases where it's useful to have more control over where and Play uploads multi part form data.  In this case, we'd like to get access to the accumulated byte stream for each file part and generate a file directly, without going through `TemporaryFile`.

play-scala-fileupload-example/build.sbt

@@ -1,5 +1,6 @@
 lazy val root = (project in file("."))
   .enablePlugins(PlayScala)
+  //.enablePlugins(PlayNettyServer).disablePlugins(PlayAkkaHttpServer) // uncomment to use the Netty backend
   .settings(
     name := """play-scala-fileupload-example""",
     version := "1.0-SNAPSHOT",

play-scala-forms-example/README.md

@@ -12,6 +12,13 @@ sbt run
 
 And open [http://localhost:9000/](http://localhost:9000/)
 
+## Server backend
+
+By default, the project uses the Akka HTTP Server backend. To switch to the Netty Server backend, enable the `PlayNettyServer` sbt plugin in the `build.sbt` file.
+In the `build.sbt` of this project, you'll find a commented line for this setting; simply uncomment it to make the switch.
+For more detailed information, refer to the Play Framework [documentation](https://www.playframework.com/documentation/3.0.x/Server).
+
+
 ## Credits
 
 Originally written by Chris Birchall and the Guardian Team: <https://github.com/cb372/play-forms-tutorial>.  Much thanks, especially for the [article](https://www.theguardian.com/info/developer-blog/2015/dec/30/how-to-add-a-form-to-a-play-application).

play-scala-forms-example/build.sbt

@@ -1,5 +1,6 @@
 lazy val root = (project in file("."))
   .enablePlugins(PlayScala)
+  //.enablePlugins(PlayNettyServer).disablePlugins(PlayAkkaHttpServer) // uncomment to use the Netty backend
   .settings(
     name := """play-scala-forms-example""",
     version := "1.0-SNAPSHOT",

play-scala-hello-world-tutorial/README.md

@@ -35,3 +35,9 @@ To build and run the project:
 3. After the message `Server started, ...` displays, enter the following URL in a browser: <http://localhost:9000>
 
 The Play application responds: `Welcome to the Hello World Tutorial!`
+
+## Server backend
+
+By default, the project uses the Akka HTTP Server backend. To switch to the Netty Server backend, enable the `PlayNettyServer` sbt plugin in the `build.sbt` file.
+In the `build.sbt` of this project, you'll find a commented line for this setting; simply uncomment it to make the switch.
+For more detailed information, refer to the Play Framework [documentation](https://www.playframework.com/documentation/3.0.x/Server).