Count echos received per peer & improved cleanup of peer state

.github/workflows/build.yml

@@ -11,7 +11,7 @@ jobs:
     container: eclipse-temurin:17-jdk
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Grant execute permission for gradlew
         run: chmod +x ./gradlew
       - name: Run Checks

gradle.properties

@@ -2,7 +2,7 @@ version=snapshot
 javafxVersion=18.0.2
 javafxPlatform=linux
 javafxClasspath=included
-lombokVersion=1.18.24
+lombokVersion=1.18.32
 picocliVersion=4.6.3
 gsonVersion=2.9.1
 guavaVersion=32.1.2-jre

gradle/wrapper/gradle-wrapper.properties

@@ -1,5 +1,7 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.5.1-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.8-bin.zip
+networkTimeout=10000
+validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

gradlew

@@ -55,7 +55,7 @@
 #       Darwin, MinGW, and NonStop.
 #
 #   (3) This script is generated from the Groovy template
-#       https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
+#       https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
 #       within the Gradle project.
 #
 #       You can find Gradle at https://github.com/gradle/gradle/.
@@ -80,13 +80,11 @@ do
     esac
 done
 
-APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
-
-APP_NAME="Gradle"
+# This is normally unused
+# shellcheck disable=SC2034
 APP_BASE_NAME=${0##*/}
-
-# 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"'
+# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
+APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit
 
 # Use the maximum available, or set MAX_FD != -1 to use that value.
 MAX_FD=maximum
@@ -133,22 +131,29 @@ 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.
+    if ! command -v java >/dev/null 2>&1
+    then
+        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
 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=SC2039,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=SC2039,SC3045
         ulimit -n "$MAX_FD" ||
             warn "Could not set maximum file descriptor limit to $MAX_FD"
     esac
@@ -193,18 +198,28 @@ if "$cygwin" || "$msys" ; then
     done
 fi
 
-# 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.
+
+# 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, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
+#     and any embedded shellness will be escaped.
+#   * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be
+#     treated as '${Hostname}' itself on the command line.
 
 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.

gradlew.bat

@@ -14,7 +14,7 @@
 @rem limitations under the License.
 @rem
 
-@if "%DEBUG%" == "" @echo off
+@if "%DEBUG%"=="" @echo off
 @rem ##########################################################################
 @rem
 @rem  Gradle startup script for Windows
@@ -25,7 +25,8 @@
 if "%OS%"=="Windows_NT" setlocal
 
 set DIRNAME=%~dp0
-if "%DIRNAME%" == "" set DIRNAME=.
+if "%DIRNAME%"=="" set DIRNAME=.
+@rem This is normally unused
 set APP_BASE_NAME=%~n0
 set APP_HOME=%DIRNAME%
 
@@ -40,13 +41,13 @@ if defined JAVA_HOME goto findJavaFromJavaHome
 
 set JAVA_EXE=java.exe
 %JAVA_EXE% -version >NUL 2>&1
-if "%ERRORLEVEL%" == "0" goto execute
+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.
+echo. 1>&2
+echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2
+echo. 1>&2
+echo Please set the JAVA_HOME variable in your environment to match the 1>&2
+echo location of your Java installation. 1>&2
 
 goto fail
 
@@ -56,11 +57,11 @@ 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.
+echo. 1>&2
+echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2
+echo. 1>&2
+echo Please set the JAVA_HOME variable in your environment to match the 1>&2
+echo location of your Java installation. 1>&2
 
 goto fail
 
@@ -75,13 +76,15 @@ set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
 
 :end
 @rem End local scope for the variables with windows NT shell
-if "%ERRORLEVEL%"=="0" goto mainEnd
+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!
-if  not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
-exit /b 1
+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

ice-adapter/src/main/java/com/faforever/iceadapter/debug/DebugWindow.java

@@ -177,14 +177,17 @@ public void peerStateChanged(Peer peer) {
 
     @Override
     public void peerConnectivityUpdate(Peer peer) {
-        new Thread(() -> {
+        runOnUIThread(() -> {
             synchronized (peers) {
                 peers.stream().filter(p -> p.id.get() == peer.getRemoteId()).forEach(p -> {
-                    p.averageRtt.set(Optional.ofNullable(peer.getIce().getConnectivityChecker()).map(PeerConnectivityCheckerModule::getAverageRTT).orElse(-1.0f).intValue());
-                    p.lastReceived.set(Optional.ofNullable(peer.getIce().getConnectivityChecker()).map(PeerConnectivityCheckerModule::getLastPacketReceived).map(last -> System.currentTimeMillis() - last).orElse(-1L).intValue());
+                    Optional<PeerConnectivityCheckerModule> connectivityChecker = Optional.ofNullable(peer.getIce().getConnectivityChecker());
+                    p.averageRtt.set(connectivityChecker.map(PeerConnectivityCheckerModule::getAverageRTT).orElse(-1.0f).intValue());
+                    p.lastReceived.set(connectivityChecker.map(PeerConnectivityCheckerModule::getLastPacketReceived).map(last -> System.currentTimeMillis() - last).orElse(-1L).intValue());
+                    p.echosReceived.set(connectivityChecker.map(PeerConnectivityCheckerModule::getEchosReceived).orElse(-1L).intValue());
+                    p.echosReceived.set(connectivityChecker.map(PeerConnectivityCheckerModule::getEchosReceived).orElse(-1L).intValue());
                 });
             }
-        }).start();
+        });
     }
 
     private void runOnUIThread(Runnable runnable) {
@@ -210,6 +213,8 @@ public static class DebugPeer {
         public SimpleStringProperty state = new SimpleStringProperty("");
         public SimpleIntegerProperty averageRtt = new SimpleIntegerProperty(-1);
         public SimpleIntegerProperty lastReceived = new SimpleIntegerProperty(-1);
+        public SimpleIntegerProperty echosReceived = new SimpleIntegerProperty(-1);
+        public SimpleIntegerProperty invalidEchosReceived = new SimpleIntegerProperty(-1);
         public SimpleStringProperty localCandidate = new SimpleStringProperty("");
         public SimpleStringProperty remoteCandidate = new SimpleStringProperty("");
 
@@ -269,6 +274,18 @@ public SimpleIntegerProperty lastReceivedProperty() {
             return lastReceived;
         }
 
+        public int getEchosReceived() {
+            return echosReceived.get();
+        }
+
+        public int getInvalidEchosReceived() {
+            return invalidEchosReceived.get();
+        }
+
+        public SimpleIntegerProperty echosReceivedProperty() { return echosReceived; }
+
+        public SimpleIntegerProperty invalidEchosReceivedProperty() { return invalidEchosReceived; }
+
         public String getLocalCandidate() {
             return localCandidate.get();
         }

ice-adapter/src/main/java/com/faforever/iceadapter/debug/DebugWindowController.java

@@ -36,6 +36,8 @@ public class DebugWindowController {
 	public TableColumn stateColumn;
 	public TableColumn rttColumn;
 	public TableColumn lastColumn;
+	public TableColumn echosRcvColumn;
+	public TableColumn invalidEchosRcvColumn;
 	public TableColumn localCandColumn;
 	public TableColumn remoteCandColumn;
 
@@ -64,6 +66,8 @@ private void initialize() {
 		stateColumn.setCellValueFactory(new PropertyValueFactory<>("state"));
 		rttColumn.setCellValueFactory(new PropertyValueFactory<>("averageRtt"));
 		lastColumn.setCellValueFactory(new PropertyValueFactory<>("lastReceived"));
+		echosRcvColumn.setCellValueFactory(new PropertyValueFactory<>("echosReceived"));
+		invalidEchosRcvColumn.setCellValueFactory(new PropertyValueFactory<>("invalidEchosReceived"));
 		localCandColumn.setCellValueFactory(new PropertyValueFactory<>("localCandidate"));
 		remoteCandColumn.setCellValueFactory(new PropertyValueFactory<>("remoteCandidate"));
 

ice-adapter/src/main/java/com/faforever/iceadapter/ice/PeerConnectivityCheckerModule.java

@@ -23,6 +23,8 @@ public class PeerConnectivityCheckerModule {
 
     @Getter private float averageRTT = 0.0f;
     @Getter private long lastPacketReceived;
+    @Getter private long echosReceived = 0;
+    @Getter private long invalidEchosReceived = 0;
 
     public PeerConnectivityCheckerModule(PeerIceModule ice) {
         this.ice = ice;
@@ -56,7 +58,7 @@ synchronized void stop() {
         running = false;
 
         if (checkerThread != null) {
-            checkerThread.stop();
+            checkerThread.interrupt();
             checkerThread = null;
         }
     }
@@ -68,8 +70,11 @@ synchronized void stop() {
      * @param length
      */
     void echoReceived(byte[] data, int offset, int length) {
+        echosReceived++;
+
         if (length != 9) {
             log.trace("Received echo of wrong length, length: {}", length);
+            invalidEchosReceived++;
         }
 
         int rtt = (int) (System.currentTimeMillis() - Longs.fromByteArray(Arrays.copyOfRange(data, offset + 1, length)));
@@ -86,7 +91,7 @@ void echoReceived(byte[] data, int offset, int length) {
     }
 
     private void checkerThread() {
-        while (running) {
+        while (!Thread.currentThread().isInterrupted()) {
             log.trace("Running connectivity checker");
 
             byte[] data = new byte[9];
@@ -102,7 +107,9 @@ private void checkerThread() {
             try {
                 Thread.sleep(ECHO_INTERVAL);
             } catch (InterruptedException e) {
-                log.warn("Sleeping checkerThread was interrupted");
+                log.warn("{} (sleeping checkerThread) was interrupted", Thread.currentThread().getName());
+                Thread.currentThread().interrupt();
+                return;
             }
 
             if (System.currentTimeMillis() - lastPacketReceived > 10000) {
@@ -112,6 +119,6 @@ private void checkerThread() {
             }
         }
 
-        log.info(getThreadName()+" stopped gracefully");
+        log.info("{} stopped gracefully", Thread.currentThread().getName());
     }
 }

ice-adapter/src/main/java/com/faforever/iceadapter/ice/PeerIceModule.java

@@ -279,24 +279,14 @@ private void startIce() {
      * Will then reinitiate ICE
      */
     public synchronized void onConnectionLost() {
-        if(peer.isClosing()) {
-            log.warn(getLogPrefix() + "Peer not connected anymore, aborting onConnectionLost of ICE");
-            return;
-        }
-
-        if(peer.getGameSession().isGameEnded()) {
-            log.warn("GAME ENDED, ABORTING onConnectionLost of ICE for peer " + getLogPrefix());
-            return;
-        }
-
         if (iceState == DISCONNECTED) {
+            log.warn(getLogPrefix() + "Lost connection, albeit already in ice state disconnected");
             return;//TODO: will this kill the life cycle?
         }
 
         IceState previousState = getIceState();
 
         if (listenerThread != null) {
-//            listenerThread.stop();//TODO what if cancelled during sending TO FA???
             listenerThread.interrupt();
             listenerThread = null;
         }
@@ -325,6 +315,16 @@ public synchronized void onConnectionLost() {
 
         debug().peerStateChanged(this.peer);
 
+        if(peer.isClosing()) {
+            log.warn(getLogPrefix() + "Peer not connected anymore, aborting onConnectionLost of ICE");
+            return;
+        }
+
+        if(peer.getGameSession().isGameEnded()) {
+            log.warn(getLogPrefix() + "GAME ENDED, ABORTING onConnectionLost of ICE for peer ");
+            return;
+        }
+
         if (previousState == CONNECTED) {
             TrayIcon.showMessage("Reconnecting to " + this.peer.getRemoteLogin() + " (connection lost)");
         }

ice-adapter/src/main/resources/debugWindow.fxml

@@ -62,6 +62,8 @@
                     <TableColumn fx:id="offerColumn" prefWidth="100.0" text="localOffer" />
                     <TableColumn fx:id="rttColumn" prefWidth="100.0" text="average rtt" />
                     <TableColumn fx:id="lastColumn" prefWidth="100.0" text="last recv" />
+                    <TableColumn fx:id="echosRcvColumn" prefWidth="100.0" text="echos recv" />
+                    <TableColumn fx:id="invalidEchosRcvColumn" prefWidth="100.0" text="invalid echos recv" />
                 </columns>
             </TableView>