Merge pull request #6 from tommyskeff/patch/joining

better promise joining and combining

futur-api/src/main/java/dev/tommyjs/futur/executor/PromiseExecutor.java

@@ -10,4 +10,12 @@ public interface PromiseExecutor {
 
     void runAsync(@NotNull Runnable task, long delay, @NotNull TimeUnit unit);
 
+    default void runSync(@NotNull Runnable task) {
+        runSync(task, 0L, TimeUnit.MILLISECONDS);
+    }
+
+    default void runAsync(@NotNull Runnable task) {
+        runAsync(task, 0L, TimeUnit.MILLISECONDS);
+    }
+
 }

futur-api/src/main/java/dev/tommyjs/futur/promise/AbstractPromise.java

@@ -13,7 +13,6 @@ import java.util.Collection;
 import java.util.concurrent.ConcurrentLinkedQueue;
 import java.util.concurrent.TimeUnit;
 import java.util.concurrent.TimeoutException;
-import java.util.concurrent.atomic.AtomicBoolean;
 import java.util.concurrent.atomic.AtomicReference;
 
 public abstract class AbstractPromise<T> implements Promise<T> {
@@ -30,28 +29,42 @@ public abstract class AbstractPromise<T> implements Promise<T> {
 
     protected abstract Logger getLogger();
 
+    @Deprecated
     @Override
-    public T join(long interval, long timeout) throws TimeoutException {
-        long start = System.currentTimeMillis();
-        while (!isCompleted()) {
-            if (System.currentTimeMillis() > start + timeout)
-                throw new TimeoutException("Promise timed out after " + timeout + "ms");
+    public T join(long interval, long timeoutMillis) throws TimeoutException {
+        return join(timeoutMillis);
+    }
 
+    @Override
+    public T join(long timeoutMillis) throws TimeoutException {
+        PromiseCompletion<T> completion = this.completion.get();
+        if (completion != null) return joinCompletion(completion);
+
+        long start = System.currentTimeMillis();
+        long remainingTimeout = timeoutMillis;
+
+        synchronized (this.completion) {
+            while (completion == null && remainingTimeout > 0){
                 try {
-                Thread.sleep(interval);
+                    this.completion.wait(remainingTimeout);
                 } catch (InterruptedException e) {
                     throw new RuntimeException(e);
                 }
+
+                completion = this.completion.get();
+                remainingTimeout = timeoutMillis - (System.currentTimeMillis() - start);
+            }
         }
 
-        PromiseCompletion<T> completion = getCompletion();
-        if (completion == null) {
-            throw new IllegalStateException();
+        if (completion == null)
+            throw new TimeoutException("Promise timed out after " + timeoutMillis + "ms");
+
+        return joinCompletion(completion);
     }
 
-        if (completion.isError()) {
+    private T joinCompletion(PromiseCompletion<T> completion) {
+        if (completion.isError())
             throw new RuntimeException(completion.getException());
-        }
 
         return completion.getResult();
     }
@@ -275,15 +288,21 @@ public abstract class AbstractPromise<T> implements Promise<T> {
 
     @Override
     public @NotNull Promise<T> logExceptions() {
+        return logExceptions("Exception caught in promise chain");
+    }
+
+    @Override
+    public @NotNull Promise<T> logExceptions(@NotNull String message) {
         return addListener(ctx -> {
             if (ctx.isError()) {
-                getLogger().error("Exception caught in promise chain", ctx.getException());
+                getLogger().error(message, ctx.getException());
             }
         });
     }
 
     @Override
     public @NotNull Promise<T> addListener(@NotNull PromiseListener<T> listener) {
+        synchronized (completion) {
             if (isCompleted()) {
                 getExecutor().runAsync(() -> {
                     try {
@@ -292,10 +311,11 @@ public abstract class AbstractPromise<T> implements Promise<T> {
                     } catch (Exception e) {
                         getLogger().error("Exception caught in promise listener", e);
                     }
-            }, 0L, TimeUnit.MILLISECONDS);
+                });
             } else {
                 getListeners().add(listener);
             }
+        }
 
         return this;
     }
@@ -316,24 +336,11 @@ public abstract class AbstractPromise<T> implements Promise<T> {
         return timeout(ms, TimeUnit.MILLISECONDS);
     }
 
-    protected void handleCompletion(@NotNull PromiseCompletion<T> ctx) {
-        AtomicBoolean success = new AtomicBoolean();
-        completion.getAndUpdate(c -> {
-            if (c == null) {
-                success.set(true);
-                return ctx;
-            } else {
-                success.set(false);
-                return c;
-            }
-        });
+    private void handleCompletion(@NotNull PromiseCompletion<T> ctx) {
+        synchronized (completion) {
+            if (!setCompletion(ctx)) return;
 
-        if (success.get()) {
-            handleCompletion0(ctx);
-        }
-    }
-
-    protected void handleCompletion0(@NotNull PromiseCompletion<T> ctx) {
+            completion.notifyAll();
             getExecutor().runAsync(() -> {
                 for (PromiseListener<T> listener : getListeners()) {
                     if (!ctx.isActive()) return;
@@ -344,7 +351,12 @@ public abstract class AbstractPromise<T> implements Promise<T> {
                         getLogger().error("Exception caught in promise listener", e);
                     }
                 }
-        }, 0L, TimeUnit.MILLISECONDS);
+            });
+        }
+    }
+
+    private boolean setCompletion(PromiseCompletion<T> completion) {
+        return this.completion.compareAndSet(null, completion);
     }
 
     @Override
@@ -367,7 +379,7 @@ public abstract class AbstractPromise<T> implements Promise<T> {
         return completion.get();
     }
 
-    protected Collection<PromiseListener<T>> getListeners() {
+    private Collection<PromiseListener<T>> getListeners() {
         return listeners;
     }
 

futur-api/src/main/java/dev/tommyjs/futur/promise/Promise.java

@@ -31,8 +31,11 @@ public interface Promise<T> {
 
     PromiseFactory getFactory();
 
+    @Deprecated
     T join(long interval, long timeout) throws TimeoutException;
 
+    T join(long timeout) throws TimeoutException;
+
     @NotNull Promise<Void> thenRunSync(@NotNull ExceptionalRunnable task);
 
     @NotNull Promise<Void> thenRunDelayedSync(@NotNull ExceptionalRunnable task, long delay, @NotNull TimeUnit unit);
@@ -73,6 +76,8 @@ public interface Promise<T> {
 
     @NotNull Promise<T> logExceptions();
 
+    @NotNull Promise<T> logExceptions(@NotNull String message);
+
     @NotNull Promise<T> addListener(@NotNull PromiseListener<T> listener);
 
     @NotNull Promise<T> timeout(long time, @NotNull TimeUnit unit);

futur-api/src/main/java/dev/tommyjs/futur/promise/Promises.java

@@ -42,15 +42,13 @@ public class Promises {
     }
 
     public static <K, V> @NotNull Promise<Map<K, V>> combine(@NotNull Map<K, Promise<V>> promises, long timeout, @Nullable BiConsumer<K, Throwable> exceptionHandler, PromiseFactory factory) {
-        Map<K, V> map = new HashMap<>();
-        ReentrantLock lock = new ReentrantLock();
+        if (promises.isEmpty()) return factory.resolve(Collections.emptyMap());
 
+        Map<K, V> map = new HashMap<>();
         Promise<Map<K, V>> promise = factory.unresolved();
         for (Map.Entry<K, Promise<V>> entry : promises.entrySet()) {
             entry.getValue().addListener((ctx) -> {
-                lock.lock();
-
-                try {
+                synchronized (map) {
                     if (ctx.isError()) {
                         if (exceptionHandler == null) {
                             //noinspection ConstantConditions
@@ -63,8 +61,6 @@ public class Promises {
                         map.put(entry.getKey(), ctx.getResult());
                     }
                     if (map.size() == promises.size()) promise.complete(map);
-                } finally {
-                    lock.unlock();
                 }
             });
         }
@@ -105,6 +101,8 @@ public class Promises {
     }
 
     public static @NotNull Promise<Void> all(@NotNull List<Promise<?>> promises, PromiseFactory factory) {
+        if (promises.isEmpty()) return factory.resolve(null);
+
         Promise<Void> promise = factory.unresolved();
         for (Promise<?> p : promises) {
             p.addListener((ctx) -> {

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
-#Sun Nov 19 18:44:26 GMT 2023
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.0-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.7-bin.zip
+networkTimeout=10000
 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/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/.
@@ -80,10 +80,10 @@ 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##*/}
+APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
 
 # 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"'
@@ -143,12 +143,16 @@ fi
 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
@@ -205,6 +209,12 @@ set -- \
         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

@@ -26,6 +26,7 @@ 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%
 
@@ -40,7 +41,7 @@ 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.
@@ -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