GH-278 Move updater to eternalcode-commons library (#287)

* Move updater to eternalcode-commons library

* Use gson 2.11.0 for WorldGuard and update gradle.properties to latest standards

Author: Jakubk15

buildSrc/src/main/kotlin/Versions.kt

@@ -16,12 +16,9 @@ object Versions {
     const val ADVENTURE_API = "4.24.0"
 
     const val LITE_COMMANDS = "3.10.5"
-    const val OKAERI_CONFIGS_YAML_BUKKIT = "5.0.6"
     const val OKAERI_CONFIGS_SERDES_COMMONS = "5.0.13"
     const val OKAERI_CONFIGS_SERDES_BUKKIT = "5.0.13"
 
-    const val GIT_CHECK = "1.0.0"
-
     const val CAFFEINE = "3.2.2"
 
     const val B_STATS_BUKKIT = "3.1.0"

eternalcombat-plugin/build.gradle.kts

@@ -9,6 +9,17 @@ plugins {
     id("xyz.jpenilla.run-paper")
 }
 
+configurations.all {
+    resolutionStrategy {
+        eachDependency {
+            if (requested.group == "com.google.code.gson" && requested.name == "gson") {
+                useVersion("2.11.0")
+                because("WorldGuard requires strictly gson 2.11.0")
+            }
+        }
+    }
+}
+
 dependencies {
     implementation(project(":eternalcombat-api"))
 
@@ -29,9 +40,6 @@ dependencies {
     implementation("eu.okaeri:okaeri-configs-serdes-commons:${Versions.OKAERI_CONFIGS_SERDES_COMMONS}")
     implementation("eu.okaeri:okaeri-configs-serdes-bukkit:${Versions.OKAERI_CONFIGS_SERDES_BUKKIT}")
 
-    // GitCheck
-    implementation("com.eternalcode:gitcheck:${Versions.GIT_CHECK}")
-
     // bstats
     implementation("org.bstats:bstats-bukkit:${Versions.B_STATS_BUKKIT}")
 
@@ -42,6 +50,7 @@ dependencies {
     implementation("com.eternalcode:eternalcode-commons-bukkit:${Versions.ETERNALCODE_COMMONS}")
     implementation("com.eternalcode:eternalcode-commons-shared:${Versions.ETERNALCODE_COMMONS}")
     implementation("com.eternalcode:eternalcode-commons-folia:${Versions.ETERNALCODE_COMMONS}")
+    implementation("com.eternalcode:eternalcode-commons-updater:${Versions.ETERNALCODE_COMMONS}")
 
     // worldguard
     compileOnly("com.sk89q.worldguard:worldguard-bukkit:${Versions.WORLD_GUARD_BUKKIT}")

eternalcombat-plugin/src/main/java/com/eternalcode/combat/updater/UpdaterNotificationController.java

@@ -1,6 +1,7 @@
 package com.eternalcode.combat.updater;
 
 import com.eternalcode.combat.config.implementation.PluginConfig;
+import com.eternalcode.commons.concurrent.FutureHandler;
 import net.kyori.adventure.audience.Audience;
 import net.kyori.adventure.platform.AudienceProvider;
 import net.kyori.adventure.text.minimessage.MiniMessage;
@@ -9,12 +10,9 @@
 import org.bukkit.event.Listener;
 import org.bukkit.event.player.PlayerJoinEvent;
 
-import java.util.concurrent.CompletableFuture;
-
 public class UpdaterNotificationController implements Listener {
 
     private static final String NEW_VERSION_AVAILABLE = "<b><gradient:#8a1212:#fc6b03>EternalCombat:</gradient></b> <color:#fce303>New version of EternalCombat is available, please update!";
-    private static final String RECEIVE_UPDATES_PERMISSION = "eternalcombat.receiveupdates";
 
     private final UpdaterService updaterService;
     private final PluginConfig pluginConfig;
@@ -33,23 +31,21 @@ void onJoin(PlayerJoinEvent event) {
         Player player = event.getPlayer();
         Audience audience = this.audienceProvider.player(player.getUniqueId());
 
-        if (!player.hasPermission(RECEIVE_UPDATES_PERMISSION) || !this.pluginConfig.settings.notifyAboutUpdates) {
+        if (!shouldNotify(player)) {
             return;
         }
 
-        CompletableFuture<Boolean> upToDate = this.updaterService.isUpToDate();
-
-        upToDate.whenComplete((isUpToDate, throwable) -> {
-            if (throwable != null) {
-                throwable.printStackTrace();
-
-                return;
-            }
+        this.updaterService.checkForUpdate()
+            .thenAccept(result -> {
+                if (result.isUpdateAvailable()) {
+                    audience.sendMessage(this.miniMessage.deserialize(NEW_VERSION_AVAILABLE));
+                }
+            })
+            .exceptionally(FutureHandler::handleException);
+    }
 
-            if (!isUpToDate) {
-                audience.sendMessage(this.miniMessage.deserialize(NEW_VERSION_AVAILABLE));
-            }
-        });
+    private boolean shouldNotify(Player player) {
+        return player.hasPermission("eternalcombat.receiveupdates") && this.pluginConfig.settings.notifyAboutUpdates;
     }
 
 }

eternalcombat-plugin/src/main/java/com/eternalcode/combat/updater/UpdaterService.java

@@ -1,35 +1,33 @@
 package com.eternalcode.combat.updater;
 
-import com.eternalcode.gitcheck.GitCheck;
-import com.eternalcode.gitcheck.GitCheckResult;
-import com.eternalcode.gitcheck.git.GitRepository;
-import com.eternalcode.gitcheck.git.GitTag;
-import dev.rollczi.litecommands.shared.Lazy;
+import com.eternalcode.commons.updater.UpdateResult;
+import com.eternalcode.commons.updater.Version;
+import com.eternalcode.commons.updater.impl.ModrinthUpdateChecker;
+import com.github.benmanes.caffeine.cache.AsyncLoadingCache;
+import com.github.benmanes.caffeine.cache.Caffeine;
 import org.bukkit.plugin.PluginDescriptionFile;
 
+import java.time.Duration;
 import java.util.concurrent.CompletableFuture;
 
 public class UpdaterService {
 
-    private static final GitRepository GIT_REPOSITORY = GitRepository.of("EternalCodeTeam", "EternalCombat");
+    private static final String MODRINTH_PROJECT_ID = "EternalCombat";
+    private static final String CACHE_KEY = "modrinth-update";
 
-    private final GitCheck gitCheck = new GitCheck();
-    private final Lazy<GitCheckResult> gitCheckResult;
+    private final AsyncLoadingCache<String, UpdateResult> updateCache;
 
     public UpdaterService(PluginDescriptionFile descriptionFile) {
-        this.gitCheckResult = new Lazy<>(() -> {
-            String version = descriptionFile.getVersion();
+        Version currentVersion = new Version(descriptionFile.getVersion());
+        ModrinthUpdateChecker updateChecker = new ModrinthUpdateChecker();
 
-            return this.gitCheck.checkRelease(GIT_REPOSITORY, GitTag.of("v" + version));
-        });
+        this.updateCache = Caffeine.newBuilder()
+            .expireAfterWrite(Duration.ofHours(1))
+            .buildAsync(key -> updateChecker.check(MODRINTH_PROJECT_ID, currentVersion));
     }
 
-    public CompletableFuture<Boolean> isUpToDate() {
-        return CompletableFuture.supplyAsync(() -> {
-            GitCheckResult result = this.gitCheckResult.get();
-
-            return result.isUpToDate();
-        });
+    CompletableFuture<UpdateResult> checkForUpdate() {
+        return this.updateCache.get(CACHE_KEY);
     }
 
-}
+}

gradle.properties

@@ -1,4 +1,4 @@
-org.gradle.configuration-cache=true
-org.gradle.caching=true
 org.gradle.parallel=true
-org.gradle.vfs.watch=false
+org.gradle.caching=true
+org.gradle.configuration-cache=true
+org.gradle.configuration-cache.parallel=true