chore: make RepositoryManager a composite ReleaseRepository (#711)

The public interface of `RepositoryManager` is basically that of `ReleaseRepository`. Its purpose is to combine the different sources for game releases and hide where exactly a release is coming from. Thus, make it implement `ReleaseRepository` and use the interface in more places instead of the specific class. Also, drop the `...Adapter` suffixes as I'm not sure what they were intended to express anymore. The interface is called `ReleaseRepository` (with Adapter), and the two classes are implementing that interface. In addition, this also deletes the unused class `JobResult`.
MovingBlocks · Nov 26, 2023 · 1410948 · 1410948
1 parent da5d3b2
commit 1410948
Show file tree

Hide file tree

Showing 9 changed files with 36 additions and 41 deletions.
diff --git a/src/main/java/org/terasology/launcher/LauncherConfiguration.java b/src/main/java/org/terasology/launcher/LauncherConfiguration.java
@@ -4,7 +4,7 @@
 package org.terasology.launcher;
 
 import org.terasology.launcher.game.GameManager;
-import org.terasology.launcher.repositories.RepositoryManager;
+import org.terasology.launcher.repositories.ReleaseRepository;
 import org.terasology.launcher.settings.Settings;
 
 import java.nio.file.Path;
@@ -22,17 +22,17 @@ public class LauncherConfiguration {
     private final Path downloadDirectory;
     private final Settings launcherSettings;
     private final GameManager gameManager;
-    private final RepositoryManager repositoryManager;
+    private final ReleaseRepository releaseRepository;
 
     public LauncherConfiguration(final Path launcherDirectory,
                                  final Path downloadDirectory,
                                  final Settings launcherSettings,
-                                 GameManager gameManager, RepositoryManager repositoryManager) {
+                                 GameManager gameManager, ReleaseRepository releaseRepository) {
         this.launcherDirectory = launcherDirectory;
         this.downloadDirectory = downloadDirectory;
         this.launcherSettings = launcherSettings;
         this.gameManager = gameManager;
-        this.repositoryManager = repositoryManager;
+        this.releaseRepository = releaseRepository;
     }
 
     public Path getLauncherDirectory() {
@@ -51,7 +51,7 @@ public GameManager getGameManager() {
         return gameManager;
     }
 
-    public RepositoryManager getRepositoryManager() {
-        return repositoryManager;
+    public ReleaseRepository getReleaseRepository() {
+        return releaseRepository;
     }
 }
diff --git a/src/main/java/org/terasology/launcher/LauncherInitTask.java b/src/main/java/org/terasology/launcher/LauncherInitTask.java
@@ -12,7 +12,7 @@
 import org.slf4j.LoggerFactory;
 import org.terasology.launcher.game.GameManager;
 import org.terasology.launcher.model.LauncherVersion;
-import org.terasology.launcher.repositories.RepositoryManager;
+import org.terasology.launcher.repositories.CombinedRepository;
 import org.terasology.launcher.settings.LauncherSettingsValidator;
 import org.terasology.launcher.settings.Settings;
 import org.terasology.launcher.ui.Dialogs;
@@ -92,7 +92,7 @@ protected LauncherConfiguration call() {
             updateMessage(I18N.getLabel("splash_fetchReleases"));
             logger.info("Fetching game releases ...");
             // implicitly fetches game releases and cache them
-            final RepositoryManager repositoryManager = new RepositoryManager(client);
+            final CombinedRepository releaseRepository = new CombinedRepository(client);
 
             // implicitly scans the game directory for installed games and cache them
             final GameManager gameManager = new GameManager(cacheDirectory, gameDirectory);
@@ -111,7 +111,7 @@ protected LauncherConfiguration call() {
                     downloadDirectory,
                     launcherSettings,
                     gameManager,
-                    repositoryManager);
+                    releaseRepository);
         } catch (LauncherStartFailedException e) {
             logger.warn("Could not configure launcher.");
         }

diff --git a/...ncher/repositories/RepositoryManager.java → ...cher/repositories/CombinedRepository.java b/...ncher/repositories/RepositoryManager.java → ...cher/repositories/CombinedRepository.java
@@ -3,6 +3,7 @@
 
 package org.terasology.launcher.repositories;
 
+import com.google.common.collect.Lists;
 import com.google.common.collect.Sets;
 import com.google.gson.Gson;
 import okhttp3.OkHttpClient;
@@ -14,7 +15,7 @@
 import java.util.Set;
 import java.util.stream.Collectors;
 
-public class RepositoryManager {
+public class CombinedRepository implements ReleaseRepository {
 
     private final Set<GameRelease> releases;
 
@@ -23,11 +24,11 @@ public class RepositoryManager {
      *
      * @param httpClient the HTTP client to be used for remote requests
      */
-    public RepositoryManager(OkHttpClient httpClient) {
+    public CombinedRepository(OkHttpClient httpClient) {
         JenkinsClient client = new JenkinsClient(httpClient, new Gson());
 
-        ReleaseRepository omegaNightly = new JenkinsRepositoryAdapter(Profile.OMEGA, Build.NIGHTLY, client);
-        ReleaseRepository github = new GithubRepositoryAdapter(httpClient);
+        ReleaseRepository omegaNightly = new JenkinsRepository(Profile.OMEGA, Build.NIGHTLY, client);
+        ReleaseRepository github = new GithubRepository(httpClient);
 
         Set<ReleaseRepository> all = Sets.newHashSet(github, omegaNightly);
 
@@ -46,4 +47,8 @@ public Set<GameRelease> getReleases() {
         return releases;
     }
 
+    @Override
+    public List<GameRelease> fetchReleases() {
+        return Lists.newArrayList(getReleases());
+    }
 }
diff --git a/...repositories/GithubRepositoryAdapter.java → ...uncher/repositories/GithubRepository.java b/...repositories/GithubRepositoryAdapter.java → ...uncher/repositories/GithubRepository.java
@@ -29,13 +29,13 @@
 import java.util.Optional;
 import java.util.stream.Collectors;
 
-public class GithubRepositoryAdapter implements ReleaseRepository {
+public class GithubRepository implements ReleaseRepository {
 
-    private static final Logger logger = LoggerFactory.getLogger(GithubRepositoryAdapter.class);
+    private static final Logger logger = LoggerFactory.getLogger(GithubRepository.class);
 
     private GitHub github;
 
-    public GithubRepositoryAdapter(final OkHttpClient httpClient) {
+    public GithubRepository(final OkHttpClient httpClient) {
         try {
             github = GitHubBuilder.fromEnvironment()
                     .withConnector(new OkHttpConnector(httpClient))
@@ -86,7 +86,7 @@ public List<GameRelease> fetchReleases() {
                 final GHRepository repository = github.getRepository("MovingBlocks/Terasology");
                 final List<GHRelease> githubReleases = repository.listReleases().toList();
                 final List<GameRelease> releases = githubReleases.stream()
-                        .map(GithubRepositoryAdapter::fromGithubRelease)
+                        .map(GithubRepository::fromGithubRelease)
                         .filter(Objects::nonNull)
                         .collect(Collectors.toList());
                 logger.debug("Github rate limit: {}", github.getRateLimit());

diff --git a/...epositories/JenkinsRepositoryAdapter.java → ...ncher/repositories/JenkinsRepository.java b/...epositories/JenkinsRepositoryAdapter.java → ...ncher/repositories/JenkinsRepository.java
@@ -30,9 +30,9 @@
  * However, this means that we are doing {@code n + 1} API calls for fetching {@code n} release packages on each
  * launcher start.
  */
-class JenkinsRepositoryAdapter implements ReleaseRepository {
+class JenkinsRepository implements ReleaseRepository {
 
-    private static final Logger logger = LoggerFactory.getLogger(JenkinsRepositoryAdapter.class);
+    private static final Logger logger = LoggerFactory.getLogger(JenkinsRepository.class);
 
     private static final String BASE_URL = "http://jenkins.terasology.io/teraorg/job/Terasology/";
 
@@ -53,7 +53,7 @@ class JenkinsRepositoryAdapter implements ReleaseRepository {
 
     private final URL apiUrl;
 
-    JenkinsRepositoryAdapter(Profile profile, Build buildProfile, JenkinsClient client) {
+    JenkinsRepository(Profile profile, Build buildProfile, JenkinsClient client) {
         this.client = client;
         this.buildProfile = buildProfile;
         this.profile = profile;

diff --git a/src/main/java/org/terasology/launcher/repositories/ReleaseRepository.java b/src/main/java/org/terasology/launcher/repositories/ReleaseRepository.java
@@ -13,7 +13,7 @@
  * <p>
  * Each release repository provides a list of game releases. This is a common API for potentially different sources,
  * such as GitHub, Jenkins build servers, or other similar. A new release repository has to be added in-code by
- * implementing this interface and registering it in the {@link RepositoryManager}.
+ * implementing this interface and registering it in the {@link CombinedRepository}.
  * </p>
  */
 public interface ReleaseRepository {

diff --git a/src/main/java/org/terasology/launcher/ui/ApplicationController.java b/src/main/java/org/terasology/launcher/ui/ApplicationController.java
@@ -3,6 +3,7 @@
 
 package org.terasology.launcher.ui;
 
+import com.google.common.collect.Sets;
 import javafx.animation.Transition;
 import javafx.beans.binding.Bindings;
 import javafx.beans.binding.ObjectBinding;
@@ -43,7 +44,7 @@
 import org.terasology.launcher.model.GameRelease;
 import org.terasology.launcher.model.Profile;
 import org.terasology.launcher.model.ReleaseMetadata;
-import org.terasology.launcher.repositories.RepositoryManager;
+import org.terasology.launcher.repositories.ReleaseRepository;
 import org.terasology.launcher.settings.Settings;
 import org.terasology.launcher.tasks.DeleteTask;
 import org.terasology.launcher.tasks.DownloadTask;
@@ -213,12 +214,11 @@ public void initialize() {
     private void initComboBoxes() {
         final ObjectBinding<ObservableList<GameRelease>> releases = Bindings.createObjectBinding(() -> {
             LauncherConfiguration cfg = config.getValue();
-            if (cfg == null || cfg.getRepositoryManager() == null) {
+            if (cfg == null || cfg.getReleaseRepository() == null) {
                 return FXCollections.emptyObservableList();
             } else {
-                RepositoryManager mngr = config.getValue().getRepositoryManager();
-
-                Set<GameRelease> onlineReleases = mngr.getReleases();
+                ReleaseRepository repository = config.getValue().getReleaseRepository();
+                Set<GameRelease> onlineReleases = Sets.newHashSet(repository.fetchReleases());
                 // Create dummy game release objects from locally installed games.
                 // We need this in case of running the launcher in "offline" mode
                 // and the list of game releases fetched via the repository manager

diff --git a/src/main/java/org/terasology/launcher/util/JobResult.java b/src/main/java/org/terasology/launcher/util/JobResult.java
diff --git a/...itories/JenkinsRepositoryAdapterTest.java → ...r/repositories/JenkinsRepositoryTest.java b/...itories/JenkinsRepositoryAdapterTest.java → ...r/repositories/JenkinsRepositoryTest.java
@@ -30,7 +30,7 @@
 import static org.junit.jupiter.api.Assertions.assertTrue;
 
 @DisplayName("JenkinsRepositoryAdapter#fetchReleases() should")
-class JenkinsRepositoryAdapterTest {
+class JenkinsRepositoryTest {
 
     static Gson gson;
     static Jenkins.ApiResult validResult;
@@ -56,7 +56,7 @@ static Stream<Arguments> incompleteResults() {
     @DisplayName("handle null Jenkins response gracefully")
     void handleNullJenkinsResponseGracefully() {
         final JenkinsClient nullClient = new StubJenkinsClient(url -> null, url -> null);
-        final JenkinsRepositoryAdapter adapter = new JenkinsRepositoryAdapter(Profile.OMEGA, Build.STABLE, nullClient);
+        final JenkinsRepository adapter = new JenkinsRepository(Profile.OMEGA, Build.STABLE, nullClient);
         assertTrue(adapter.fetchReleases().isEmpty());
     }
 
@@ -67,7 +67,7 @@ void skipBuildsWithoutVersionInfo() {
 
         final JenkinsClient stubClient = new StubJenkinsClient(url -> validResult, url -> emptyVersionInfo);
 
-        final JenkinsRepositoryAdapter adapter = new JenkinsRepositoryAdapter(Profile.OMEGA, Build.STABLE, stubClient);
+        final JenkinsRepository adapter = new JenkinsRepository(Profile.OMEGA, Build.STABLE, stubClient);
 
         assertTrue(adapter.fetchReleases().isEmpty());
     }
@@ -93,7 +93,7 @@ void processValidResponseCorrectly() {
         final ReleaseMetadata releaseMetadata = new ReleaseMetadata("", new Date(1604285977306L));
         final GameRelease expected = new GameRelease(id, expectedArtifactUrl, releaseMetadata);
 
-        final JenkinsRepositoryAdapter adapter = new JenkinsRepositoryAdapter(Profile.OMEGA, Build.STABLE, stubClient);
+        final JenkinsRepository adapter = new JenkinsRepository(Profile.OMEGA, Build.STABLE, stubClient);
 
         assertEquals(1, adapter.fetchReleases().size());
         assertAll(
@@ -108,7 +108,7 @@ void processValidResponseCorrectly() {
     @MethodSource("incompleteResults")
     void skipIncompatibleApiResults(Jenkins.ApiResult incompleteResult) {
         final JenkinsClient stubClient = new StubJenkinsClient(url -> incompleteResult, url -> null);
-        final JenkinsRepositoryAdapter adapter = new JenkinsRepositoryAdapter(Profile.OMEGA, Build.STABLE, stubClient);
+        final JenkinsRepository adapter = new JenkinsRepository(Profile.OMEGA, Build.STABLE, stubClient);
         assertTrue(adapter.fetchReleases().isEmpty());
     }
 }