chore: 10.6.0 updates (#61)

.github/workflows/ci.yml

@@ -2,6 +2,9 @@ name: Build and test
 
 on:
   pull_request:
+  push:
+    branches:
+      - main
 
 jobs:
   build-test:
@@ -12,13 +15,21 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v2
 
-     - name: Set up JDK 11
-         uses: olafurpg/setup-scala@v10
-         with:
-           java-version: [email protected]
+      - name: Set up JDK 17
+        uses: coursier/setup-[email protected]
+        with:
+          jvm: temurin:1.17
 
       - name: Cache Coursier cache
-        uses: coursier/cache-action@v6.3
+        uses: coursier/cache-action@v6.4.0
 
       - name: sbt & Paradox
         run: sbt test docs/paradox
+
+      - name: Maven
+        run: |-
+          sbt new file://$PWD --name=hello-world --force && pushd hello-world &&  mvn test
+
+      - name: Gradle
+        run: |-
+          sbt new file://$PWD --name=hello-world --force && pushd hello-world &&  ./gradlew --console=plain build

README.md

@@ -6,12 +6,12 @@ walk through the code.
 You can use [Giter8][g8] to create your own project from the quickstart. Or, download and extract the zip file(https://example.lightbend.com/v1/download/akka-quickstart-scala?name=akka-quickstart-scala) to a convenient location.
 
 Prerequisites:
-- JDK 11
-- [sbt][sbt] 1.4.5 or higher ([download here][sbt_download])
+- JDK 17
+- [sbt][sbt] 1.9.6 or higher ([download here][sbt_download])
 
 Open a console and run the following command to apply this template:
  ```
-sbt -Dsbt.version=1.4.5 new akka/akka-http-java-seed.g8
+sbt new akka/akka-http-java-seed.g8
  ```
 
 This template will prompt for the following parameters. Press `Enter` if the default values suit you:
@@ -22,7 +22,7 @@ This template will prompt for the following parameters. Press `Enter` if the def
 
 This template comes with example for an Akka HTTP server on Java `QuickstartServer`, along with their respective tests.
 
-Once inside the project folder, to run this code, you can following command to run server:
+Once inside the project folder, to run this code, you can issue the following command to run the server:
 ```
 sbt run
 ```

project/build.properties

@@ -1 +1 @@
-sbt.version=1.7.2
+sbt.version=1.9.6

project/paradox.sbt

@@ -1 +1 @@
-addSbtPlugin("com.lightbend.paradox" % "sbt-paradox" % "0.9.0")
+addSbtPlugin("com.lightbend.paradox" % "sbt-paradox" % "0.10.5")

src/main/g8/default.properties

@@ -1,5 +1,6 @@
 name=My Akka HTTP Project
-akka_http_version=maven(com.typesafe.akka, akka-http-core_2.13, stable)
-akka_version=maven(com.typesafe.akka, akka-actor_2.13, stable)
+akka_http_version=10.6.0
+akka_version=2.9.0
 organization=com.example
 package=$organization$
+verbatim=gradlew gradlew.bat gradle-wrapper.properties gradle-wrapper.jar

src/main/g8/gradle/wrapper/gradle-wrapper.properties

@@ -0,0 +1,6 @@
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.6-bin.zip
+networkTimeout=10000
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists

src/main/g8/gradlew

@@ -0,0 +1,245 @@
+#!/bin/sh
+
+#
+# Copyright © 2015-2021 the original authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+##############################################################################
+#
+#   Gradle start up script for POSIX generated by Gradle.
+#
+#   Important for running:
+#
+#   (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is
+#       noncompliant, but you have some other compliant shell such as ksh or
+#       bash, then to run this script, type that shell name before the whole
+#       command line, like:
+#
+#           ksh Gradle
+#
+#       Busybox and similar reduced shells will NOT work, because this script
+#       requires all of these POSIX shell features:
+#         * functions;
+#         * expansions «$var», «${var}», «${var:-default}», «${var+SET}»,
+#           «${var#prefix}», «${var%suffix}», and «$( cmd )»;
+#         * compound commands having a testable exit status, especially «case»;
+#         * various built-in commands including «command», «set», and «ulimit».
+#
+#   Important for patching:
+#
+#   (2) This script targets any POSIX shell, so it avoids extensions provided
+#       by Bash, Ksh, etc; in particular arrays are avoided.
+#
+#       The "traditional" practice of packing multiple parameters into a
+#       space-separated string is a well documented source of bugs and security
+#       problems, so this is (mostly) avoided, by progressively accumulating
+#       options in "$@", and eventually passing that to Java.
+#
+#       Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS,
+#       and GRADLE_OPTS) rely on word-splitting, this is performed explicitly;
+#       see the in-line comments for details.
+#
+#       There are tweaks for specific operating systems such as AIX, CygWin,
+#       Darwin, MinGW, and NonStop.
+#
+#   (3) This script is generated from the Groovy template
+#       https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
+#       within the Gradle project.
+#
+#       You can find Gradle at https://github.com/gradle/gradle/.
+#
+##############################################################################
+
+# Attempt to set APP_HOME
+
+# Resolve links: $0 may be a link
+app_path=$0
+
+# Need this for daisy-chained symlinks.
+while
+    APP_HOME=${app_path%"${app_path##*/}"}  # leaves a trailing /; empty if no leading path
+    [ -h "$app_path" ]
+do
+    ls=$( ls -ld "$app_path" )
+    link=${ls#*' -> '}
+    case $link in             #(
+      /*)   app_path=$link ;; #(
+      *)    app_path=$APP_HOME$link ;;
+    esac
+done
+
+# This is normally unused
+# shellcheck disable=SC2034
+APP_BASE_NAME=${0##*/}
+APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
+
+# Use the maximum available, or set MAX_FD != -1 to use that value.
+MAX_FD=maximum
+
+warn () {
+    echo "$*"
+} >&2
+
+die () {
+    echo
+    echo "$*"
+    echo
+    exit 1
+} >&2
+
+# OS specific support (must be 'true' or 'false').
+cygwin=false
+msys=false
+darwin=false
+nonstop=false
+case "$( uname )" in                #(
+  CYGWIN* )         cygwin=true  ;; #(
+  Darwin* )         darwin=true  ;; #(
+  MSYS* | MINGW* )  msys=true    ;; #(
+  NONSTOP* )        nonstop=true ;;
+esac
+
+CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
+
+
+# Determine the Java command to use to start the JVM.
+if [ -n "$JAVA_HOME" ] ; then
+    if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
+        # IBM's JDK on AIX uses strange locations for the executables
+        JAVACMD=$JAVA_HOME/jre/sh/java
+    else
+        JAVACMD=$JAVA_HOME/bin/java
+    fi
+    if [ ! -x "$JAVACMD" ] ; then
+        die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+    fi
+else
+    JAVACMD=java
+    which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+fi
+
+# Increase the maximum file descriptors if we can.
+if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
+    case $MAX_FD in #(
+      max*)
+        # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
+        # shellcheck disable=SC3045
+        MAX_FD=$( ulimit -H -n ) ||
+            warn "Could not query maximum file descriptor limit"
+    esac
+    case $MAX_FD in  #(
+      '' | soft) :;; #(
+      *)
+        # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
+        # shellcheck disable=SC3045
+        ulimit -n "$MAX_FD" ||
+            warn "Could not set maximum file descriptor limit to $MAX_FD"
+    esac
+fi
+
+# Collect all arguments for the java command, stacking in reverse order:
+#   * args from the command line
+#   * the main class name
+#   * -classpath
+#   * -D...appname settings
+#   * --module-path (only if needed)
+#   * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables.
+
+# For Cygwin or MSYS, switch paths to Windows format before running java
+if "$cygwin" || "$msys" ; then
+    APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
+    CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" )
+
+    JAVACMD=$( cygpath --unix "$JAVACMD" )
+
+    # Now convert the arguments - kludge to limit ourselves to /bin/sh
+    for arg do
+        if
+            case $arg in                                #(
+              -*)   false ;;                            # don't mess with options #(
+              /?*)  t=${arg#/} t=/${t%%/*}              # looks like a POSIX filepath
+                    [ -e "$t" ] ;;                      #(
+              *)    false ;;
+            esac
+        then
+            arg=$( cygpath --path --ignore --mixed "$arg" )
+        fi
+        # Roll the args list around exactly as many times as the number of
+        # args, so each arg winds up back in the position where it started, but
+        # possibly modified.
+        #
+        # NB: a `for` loop captures its iteration list before it begins, so
+        # changing the positional parameters here affects neither the number of
+        # iterations, nor the values presented in `arg`.
+        shift                   # remove old arg
+        set -- "$@" "$arg"      # push replacement arg
+    done
+fi
+
+
+# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
+
+# Collect all arguments for the java command;
+#   * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of
+#     shell script including quotes and variable substitutions, so put them in
+#     double quotes to make sure that they get re-expanded; and
+#   * put everything else in single quotes, so that it's not re-expanded.
+
+set -- \
+        "-Dorg.gradle.appname=$APP_BASE_NAME" \
+        -classpath "$CLASSPATH" \
+        org.gradle.wrapper.GradleWrapperMain \
+        "$@"
+
+# Stop when "xargs" is not available.
+if ! command -v xargs >/dev/null 2>&1
+then
+    die "xargs is not available"
+fi
+
+# Use "xargs" to parse quoted args.
+#
+# With -n1 it outputs one arg per line, with the quotes and backslashes removed.
+#
+# In Bash we could simply go:
+#
+#   readarray ARGS < <( xargs -n1 <<<"$var" ) &&
+#   set -- "${ARGS[@]}" "$@"
+#
+# but POSIX shell has neither arrays nor command substitution, so instead we
+# post-process each arg (as a line of input to sed) to backslash-escape any
+# character that might be a shell metacharacter, then use eval to reverse
+# that process (while maintaining the separation between arguments), and wrap
+# the whole thing up as a single "set" statement.
+#
+# This will of course break if any of these variables contains a newline or
+# an unmatched quote.
+#
+
+eval "set -- $(
+        printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" |
+        xargs -n1 |
+        sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
+        tr '\n' ' '
+    )" '"$@"'
+
+exec "$JAVACMD" "$@"

src/main/g8/gradlew.bat

@@ -0,0 +1,92 @@
+@rem
+@rem Copyright 2015 the original author or authors.
+@rem
+@rem Licensed under the Apache License, Version 2.0 (the "License");
+@rem you may not use this file except in compliance with the License.
+@rem You may obtain a copy of the License at
+@rem
+@rem      https://www.apache.org/licenses/LICENSE-2.0
+@rem
+@rem Unless required by applicable law or agreed to in writing, software
+@rem distributed under the License is distributed on an "AS IS" BASIS,
+@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+@rem See the License for the specific language governing permissions and
+@rem limitations under the License.
+@rem
+
+@if "%DEBUG%"=="" @echo off
+@rem ##########################################################################
+@rem
+@rem  Gradle startup script for Windows
+@rem
+@rem ##########################################################################
+
+@rem Set local scope for the variables with windows NT shell
+if "%OS%"=="Windows_NT" setlocal
+
+set DIRNAME=%~dp0
+if "%DIRNAME%"=="" set DIRNAME=.
+@rem This is normally unused
+set APP_BASE_NAME=%~n0
+set APP_HOME=%DIRNAME%
+
+@rem Resolve any "." and ".." in APP_HOME to make it shorter.
+for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
+
+@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
+
+@rem Find java.exe
+if defined JAVA_HOME goto findJavaFromJavaHome
+
+set JAVA_EXE=java.exe
+%JAVA_EXE% -version >NUL 2>&1
+if %ERRORLEVEL% equ 0 goto execute
+
+echo.
+echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+echo.
+echo Please set the JAVA_HOME variable in your environment to match the
+echo location of your Java installation.
+
+goto fail
+
+:findJavaFromJavaHome
+set JAVA_HOME=%JAVA_HOME:"=%
+set JAVA_EXE=%JAVA_HOME%/bin/java.exe
+
+if exist "%JAVA_EXE%" goto execute
+
+echo.
+echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
+echo.
+echo Please set the JAVA_HOME variable in your environment to match the
+echo location of your Java installation.
+
+goto fail
+
+:execute
+@rem Setup the command line
+
+set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
+
+
+@rem Execute Gradle
+"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %*
+
+:end
+@rem End local scope for the variables with windows NT shell
+if %ERRORLEVEL% equ 0 goto mainEnd
+
+:fail
+rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
+rem the _cmd.exe /c_ return code!
+set EXIT_CODE=%ERRORLEVEL%
+if %EXIT_CODE% equ 0 set EXIT_CODE=1
+if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE%
+exit /b %EXIT_CODE%
+
+:mainEnd
+if "%OS%"=="Windows_NT" endlocal
+
+:omega

src/main/g8/pom.xml

@@ -82,8 +82,8 @@
                 <artifactId>maven-compiler-plugin</artifactId>
                 <version>3.5.1</version>
                 <configuration>
-                    <source>11</source>
-                    <target>11</target>
+                    <source>17</source>
+                    <target>17</target>
                 </configuration>
             </plugin>
             <plugin>

src/main/g8/project/build.properties

@@ -1 +1 @@
-sbt.version=1.4.5
+sbt.version=1.9.6

src/main/g8/src/main/java/$package$/UserRegistry.java

@@ -15,77 +15,26 @@
 public class UserRegistry extends AbstractBehavior<UserRegistry.Command>  {
 
   // actor protocol
-  interface Command {}
+  sealed interface Command {}
 
-  public final static class GetUsers implements Command {
-    public final ActorRef<Users> replyTo;
-    public GetUsers(ActorRef<Users> replyTo) {
-      this.replyTo = replyTo;
-    }
-  }
+  public final static record GetUsers(ActorRef<Users> replyTo) implements Command {}
 
-  public final static class CreateUser implements Command {
-    public final User user;
-    public final ActorRef<ActionPerformed> replyTo;
-    public CreateUser(User user, ActorRef<ActionPerformed> replyTo) {
-      this.user = user;
-      this.replyTo = replyTo;
-    }
-  }
+  public final static record CreateUser(User user, ActorRef<ActionPerformed> replyTo) implements Command {}
 
-  public final static class GetUserResponse {
-    public final Optional<User> maybeUser;
-    public GetUserResponse(Optional<User> maybeUser) {
-      this.maybeUser = maybeUser;
-    }
-  }
+  public final static record GetUserResponse(Optional<User> maybeUser) {}
 
-  public final static class GetUser implements Command {
-    public final String name;
-    public final ActorRef<GetUserResponse> replyTo;
-    public GetUser(String name, ActorRef<GetUserResponse> replyTo) {
-      this.name = name;
-      this.replyTo = replyTo;
-    }
-  }
+  public final static record GetUser(String name, ActorRef<GetUserResponse> replyTo) implements Command {}
 
 
-  public final static class DeleteUser implements Command {
-    public final String name;
-    public final ActorRef<ActionPerformed> replyTo;
-    public DeleteUser(String name, ActorRef<ActionPerformed> replyTo) {
-      this.name = name;
-      this.replyTo = replyTo;
-    }
-  }
+  public final static record DeleteUser(String name, ActorRef<ActionPerformed> replyTo) implements Command {}
 
 
-  public final static class ActionPerformed implements Command {
-    public final String description;
-    public ActionPerformed(String description) {
-      this.description = description;
-    }
-  }
+  public final static record ActionPerformed(String description) implements Command {}
 
   //#user-case-classes
-  public final static class User {
-    public final String name;
-    public final int age;
-    public final String countryOfResidence;
-    @JsonCreator
-    public User(@JsonProperty("name") String name, @JsonProperty("age") int age, @JsonProperty("countryOfRecidence") String countryOfResidence) {
-      this.name = name;
-      this.age = age;
-      this.countryOfResidence = countryOfResidence;
-    }
-  }
+  public final static record User(String name, int age, String countryOfResidence) {}
 
-  public final static class Users{
-    public final List<User> users;
-    public Users(List<User> users) {
-      this.users = users;
-    }
-  }
+  public final static record Users(List<User> users) {}
   //#user-case-classes
 
   private final List<User> users = new ArrayList<>();
@@ -111,27 +60,27 @@ public Receive<Command> createReceive() {
   private Behavior<Command> onGetUsers(GetUsers command) {
     // We must be careful not to send out users since it is mutable
     // so for this response we need to make a defensive copy
-    command.replyTo.tell(new Users(Collections.unmodifiableList(new ArrayList<>(users))));
+    command.replyTo().tell(new Users(Collections.unmodifiableList(new ArrayList<>(users))));
     return this;
   }
 
   private Behavior<Command> onCreateUser(CreateUser command) {
-    users.add(command.user);
-    command.replyTo.tell(new ActionPerformed(String.format("User %s created.", command.user.name)));
+    users.add(command.user());
+    command.replyTo().tell(new ActionPerformed(String.format("User %s created.", command.user().name())));
     return this;
   }
 
   private Behavior<Command> onGetUser(GetUser command) {
     Optional<User> maybeUser = users.stream()
-        .filter(user -> user.name.equals(command.name))
+        .filter(user -> user.name().equals(command.name()))
         .findFirst();
-    command.replyTo.tell(new GetUserResponse(maybeUser));
+    command.replyTo().tell(new GetUserResponse(maybeUser));
     return this;
   }
 
   private Behavior<Command> onDeleteUser(DeleteUser command) {
-    users.removeIf(user -> user.name.equals(command.name));
-    command.replyTo.tell(new ActionPerformed(String.format("User %s deleted.", command.name)));
+    users.removeIf(user -> user.name().equals(command.name()));
+    command.replyTo().tell(new ActionPerformed(String.format("User %s deleted.", command.name)));
     return this;
   }
 

src/main/g8/src/main/java/$package$/UserRoutes.java

@@ -72,7 +72,7 @@ public Route userRoutes() {
                             Jackson.unmarshaller(User.class),
                             user ->
                                 onSuccess(createUser(user), performed -> {
-                                  log.info("Create result: {}", performed.description);
+                                  log.info("Create result: {}", performed.description());
                                   return complete(StatusCodes.CREATED, performed, Jackson.marshaller());
                                 })
                         )
@@ -87,15 +87,15 @@ public Route userRoutes() {
                             //#retrieve-user-info
                             rejectEmptyResponse(() ->
                                 onSuccess(getUser(name), performed ->
-                                    complete(StatusCodes.OK, performed.maybeUser, Jackson.marshaller())
+                                    complete(StatusCodes.OK, performed.maybeUser(), Jackson.marshaller())
                                 )
                             )
                         //#retrieve-user-info
                     ),
                     delete(() ->
                             //#users-delete-logic
                             onSuccess(deleteUser(name), performed -> {
-                                  log.info("Delete result: {}", performed.description);
+                                  log.info("Delete result: {}", performed.description());
                                   return complete(StatusCodes.OK, performed, Jackson.marshaller());
                                 }
                             )