give the task service an ability to execute completable futures

Author: Marc-Spector

src/main/java/com/faforever/client/game/GameRunner.java

@@ -38,8 +38,6 @@
 import com.faforever.client.preferences.PreferencesService;
 import com.faforever.client.remote.FafServerAccessor;
 import com.faforever.client.replay.ReplayServer;
-import com.faforever.client.task.BackgroundTask;
-import com.faforever.client.task.CompletableTask.Priority;
 import com.faforever.client.task.TaskService;
 import com.faforever.client.theme.UiService;
 import com.faforever.client.ui.StageHolder;
@@ -188,9 +186,9 @@ CompletableFuture<Void> startOnlineGame(GameLaunchResponse gameLaunchResponse) {
     CompletableFuture<Void> downloadMapFuture = mapFolderName == null ? completedFuture(
         null) : mapService.downloadIfNecessary(mapFolderName).toFuture();
 
-    CompletableFuture<League> loadLeagueInfoFuture = hasLeague ? completedFuture(null) : runInBackground("league.loadInfo", getDivisionInfo(leaderboard).toFuture());
-    CompletableFuture<Integer> runReplayServerFuture = runInBackground("replayServer.connecting", replayServer.start(uid));
-    CompletableFuture<Integer> runIceAdapterFuture = runInBackground("iceAdapter.connecting", startIceAdapter(uid));
+    CompletableFuture<League> loadLeagueInfoFuture = hasLeague ? completedFuture(null) : taskService.submitFutureTask("league.loadInfo", () -> getDivisionInfo(leaderboard).toFuture());
+    CompletableFuture<Integer> runReplayServerFuture = taskService.submitFutureTask("replayServer.connecting", () -> replayServer.start(uid));
+    CompletableFuture<Integer> runIceAdapterFuture = taskService.submitFutureTask("iceAdapter.connecting", () -> startIceAdapter(uid));
 
     return CompletableFuture.allOf(downloadMapFuture, loadLeagueInfoFuture, runReplayServerFuture, runIceAdapterFuture)
                             .thenApply(_ -> gameMapper.map(gameLaunchResponse, loadLeagueInfoFuture.join()))
@@ -215,10 +213,6 @@ CompletableFuture<Void> startOnlineGame(GameLaunchResponse gameLaunchResponse) {
                             }, fxApplicationThreadExecutor);
   }
 
-  private <T> CompletableFuture<T> runInBackground(String taskTitleI18nKey, CompletableFuture<T> task) {
-    return taskService.submitTask(new BackgroundTask<>(i18n.get(taskTitleI18nKey), task, Priority.MEDIUM)).getFuture();
-  }
-
   @VisibleForTesting
   CompletableFuture<Void> prepareAndLaunchGameWhenReady(String featuredModName, Set<String> simModUids,
                                                         @Nullable String mapFolderName,

src/main/java/com/faforever/client/task/BackgroundTask.java

@@ -12,13 +12,13 @@ public abstract class CompletableTask<V> extends Task<V> implements PrioritizedC
   private final CompletableFuture<V> future;
   private Priority priority;
 
-  public CompletableTask(Priority priority) {
-    this(priority, new CompletableFuture<>());
+  public CompletableTask() {
+    this(Priority.MEDIUM);
   }
 
-  protected CompletableTask(Priority priority, CompletableFuture<V> future) {
+  public CompletableTask(Priority priority) {
     this.priority = priority;
-    this.future = future;
+    this.future = new CompletableFuture<>();
     setOnCancelled(_ -> future.cancel(true));
     setOnFailed(_ -> future.completeExceptionally(getException()));
     setOnSucceeded(_ -> future.complete(getValue()));

src/main/java/com/faforever/client/task/CompletableTask.java

@@ -0,0 +1,27 @@
+package com.faforever.client.task;
+
+import org.apache.commons.lang3.StringUtils;
+
+import java.util.concurrent.CompletableFuture;
+import java.util.concurrent.Future;
+import java.util.function.Supplier;
+
+public class SimpleTask<V> extends CompletableTask<V> {
+
+  private final Supplier<? extends CompletableFuture<V>> futureSupplier;
+
+  public SimpleTask(Supplier<? extends CompletableFuture<V>> futureSupplier) {
+    this(null, futureSupplier);
+  }
+
+  public SimpleTask(String title, Supplier<? extends CompletableFuture<V>> futureSupplier) {
+    this.futureSupplier = futureSupplier;
+    updateTitle(StringUtils.defaultIfBlank(title, StringUtils.EMPTY));
+  }
+
+  @Override
+  protected V call() throws Exception {
+    Future<V> task = futureSupplier.get();
+    return task.get();
+  }
+}

src/main/java/com/faforever/client/task/SimpleTask.java

@@ -1,6 +1,7 @@
 package com.faforever.client.task;
 
 import com.faforever.client.fx.FxApplicationThreadExecutor;
+import com.faforever.client.i18n.I18n;
 import javafx.collections.FXCollections;
 import javafx.collections.ObservableList;
 import javafx.concurrent.Worker;
@@ -9,7 +10,9 @@
 import org.springframework.context.annotation.Lazy;
 import org.springframework.stereotype.Service;
 
+import java.util.concurrent.CompletableFuture;
 import java.util.concurrent.ExecutorService;
+import java.util.function.Supplier;
 
 /**
  * Enqueues and runs tasks in background. Services that need to run a task (tasks that finish, not long-running
@@ -25,6 +28,7 @@ public class TaskService {
 
   private final ExecutorService taskExecutor;
   private final FxApplicationThreadExecutor fxApplicationThreadExecutor;
+  private final I18n i18n;
 
   private final ObservableList<Worker<?>> activeTasks = FXCollections.synchronizedObservableList(FXCollections.observableArrayList());
   private final ObservableList<Worker<?>> unmodifiableObservableList = FXCollections.unmodifiableObservableList(activeTasks);
@@ -36,7 +40,7 @@ public class TaskService {
    * @param task the task to execute
    */
   public <T extends PrioritizedCompletableTask<?>> T submitTask(T task) {
-    task.getFuture().whenComplete((o, throwable) -> {
+    task.getFuture().whenComplete((_, throwable) -> {
       fxApplicationThreadExecutor.execute(() -> activeTasks.remove(task));
       if (throwable != null) {
         log.error("Task failed", throwable);
@@ -50,6 +54,15 @@ public <T extends PrioritizedCompletableTask<?>> T submitTask(T task) {
     return task;
   }
 
+  public <V> CompletableFuture<V> submitFutureTask(Supplier<CompletableFuture<V>> task) {
+    return submitFutureTask(null, task);
+  }
+
+  public <V> CompletableFuture<V> submitFutureTask(String titleI18nKey, Supplier<CompletableFuture<V>> task) {
+    String title = titleI18nKey != null ? i18n.get(titleI18nKey) : null;
+    return submitTask(new SimpleTask<>(title, task)).getFuture();
+  }
+
   public ObservableList<Worker<?>> getActiveWorkers() {
     return unmodifiableObservableList;
   }

src/main/java/com/faforever/client/task/TaskService.java

@@ -13,7 +13,6 @@
 import com.faforever.client.domain.server.PlayerInfo;
 import com.faforever.client.fa.ForgedAllianceLaunchService;
 import com.faforever.client.fa.GameParameters;
-import com.faforever.client.fa.GameParameters.League;
 import com.faforever.client.fa.relay.ice.CoturnService;
 import com.faforever.client.fa.relay.ice.IceAdapter;
 import com.faforever.client.featuredmod.FeaturedModService;
@@ -38,8 +37,7 @@
 import com.faforever.client.preferences.PreferencesService;
 import com.faforever.client.remote.FafServerAccessor;
 import com.faforever.client.replay.ReplayServer;
-import com.faforever.client.task.BackgroundTask;
-import com.faforever.client.task.CompletableTask;
+import com.faforever.client.task.SimpleTask;
 import com.faforever.client.task.TaskService;
 import com.faforever.client.test.ServiceTest;
 import com.faforever.client.theme.UiService;
@@ -152,7 +150,7 @@ public class GameRunnerTest extends ServiceTest {
   @Spy
   private NotificationPrefs notificationPrefs;
   @Captor
-  private ArgumentCaptor<BackgroundTask<?>> backgroundTaskCaptor;
+  private ArgumentCaptor<SimpleTask<?>> simpleTaskCaptor;
 
   @Mock
   private EnterPasswordController enterPasswordController;
@@ -203,8 +201,8 @@ private void mockStartGameProcess(GameLaunchResponse gameLaunchResponse) throws
     lenient().when(iceAdapter.start(anyInt(), anyBoolean())).thenReturn(completedFuture(GPG_PORT));
     lenient().when(coturnService.getIceSession(anyInt()))
              .thenReturn(Mono.just(new IceSession("someSessionId", false, List.of())));
-    lenient().when(taskService.submitTask(backgroundTaskCaptor.capture())).thenAnswer(_ -> {
-      BackgroundTask<?> task = backgroundTaskCaptor.getValue();
+    lenient().when(taskService.submitTask(simpleTaskCaptor.capture())).thenAnswer(_ -> {
+      SimpleTask<?> task = simpleTaskCaptor.getValue();
       task.getFuture().join();
       return task;
     });