Merge pull request 'Make various improvements to UpdateChecker' (#315) from feat/update-checker-improvements into master

Reviewed-on: https://codeberg.org/Andre601/AdvancedServerList/pulls/315

core/src/main/java/ch/andre601/advancedserverlist/core/check/UpdateChecker.java

@@ -54,54 +54,61 @@ public class UpdateChecker{
     @SuppressWarnings("FieldCanBeLocal")
     // 'https://api.modrinth.com/v2/project/advancedserverlist/version?loaders=["%s"]' URL encoded.
     private final String url = "https://api.modrinth.com/v2/project/advancedserverlist/version?loaders=%%5B%%22%s%%22%%5D";
-    private final HttpClient client = HttpClient.newHttpClient();
     
     private final Type listType = new TypeToken<ArrayList<ModrinthVersion>>(){}.getType();
     private final Gson gson = new GsonBuilder()
         .setFieldNamingPolicy(FieldNamingPolicy.LOWER_CASE_WITH_UNDERSCORES)
         .setPrettyPrinting()
-        .setLenient()
         .create();
     
     private final ScheduledExecutorService executor = Executors.newSingleThreadScheduledExecutor(new UpdateCheckThread());
     
-    private final CacheUtil<ModrinthVersion> cache = new CacheUtil<>(Duration.ofMinutes(5));
+    private final CacheUtil<CompletableFuture<ModrinthVersion>> cache = new CacheUtil<>(Duration.ofMinutes(5));
     
     private final AdvancedServerList<?> core;
     private final PluginLogger logger;
     private final String loader;
+    private final HttpClient client;
     
     public UpdateChecker(AdvancedServerList<?> core){
         this.core = core;
         this.logger = core.getPlugin().getPluginLogger();
         this.loader = core.getPlugin().getLoader();
+        this.client = HttpClient.newBuilder().executor(Executors.newSingleThreadExecutor(new UpdateCheckThread())).build();
         
         startUpdateChecker();
     }
     
     public void performCachedUpdateCheck(CmdSender sender){
-        ModrinthVersion version = cache.get(() -> {
-            try{
-                return performUpdateCheck().join();
-            }catch(Exception ex){
-                return null;
+        CompletableFuture<ModrinthVersion> modrinthVersion = cache.get(this::performUpdateCheck);
+        
+        modrinthVersion.whenComplete((version, throwable) -> {
+            if(throwable != null){
+                logger.warn("Encountered an Exception while checking for an update!", throwable);
+                sender.sendErrorMsg("There was an exception while checking for an update. Please check the console for details.");
+                return;
+            }
+            
+            if(version == null)
+                return;
+            
+            int result = version.compare(core.getVersion());
+            if(result == -1){
+                sender.sendPrefixedMsg("<green>A new Version of AdvancedServerList is available!");
+                sender.sendPrefixedMsg("<green>Your version: <white>%s", core.getVersion());
+                sender.sendPrefixedMsg("<green>Version on Modrinth: <white>%s", version.versionNumber());
+                sender.sendPrefixedMsg(
+                    "<click:open_url:'https://modrinth.com/plugin/advancedserverlist/version/%s'>" +
+                    "<green>[<white>Download Page</white>]" +
+                    "</click>",
+                    version.id()
+                );
+            }else
+            if(result == 1){
+                sender.sendPrefixedMsg("You seem to run a newer Version (<white>%</white>) than what is available on Modrinth (<white>%s</white>).", core.getVersion(), version.versionNumber());
+                sender.sendPrefixedMsg("Are you running a development build?");
             }
         });
-        
-        if(version == null)
-            return;
-        
-        int result = version.compare(core.getVersion());
-        if(result == -1){
-            sender.sendPrefixedMsg("<green>A new version of AdvancedServerList is available!");
-            sender.sendPrefixedMsg("<green>Your version: <white>%s", core.getVersion());
-            sender.sendPrefixedMsg("<green>Modrinth: <white>%s", version.versionNumber());
-            sender.sendPrefixedMsg("<click:open_url:'https://modrinth.com/plugin/advancedserverlist/version/%s'><green>[<white>Download Page</white>]</click>", version.id());
-        }else
-        if(result == 1){
-            sender.sendPrefixedMsg("Your version (<white>%s</white>) seems newer than the latest release on Modrinth (<white>%s</white>)", core.getVersion(), version.versionNumber);
-            sender.sendPrefixedMsg("Are you running a dev-build?");
-        }
     }
     
     public void disable(){
@@ -157,6 +164,7 @@ public class UpdateChecker{
         try{
             request = HttpRequest.newBuilder()
                 .uri(new URI(finalUrl))
+                .timeout(Duration.ofSeconds(5))
                 .header("User-Agent", "AdvancedServerList-" + loader + "/" + core.getVersion())
                 .build();
         }catch(URISyntaxException ex){

core/src/main/java/ch/andre601/advancedserverlist/core/commands/CommandHandler.java

@@ -297,14 +297,12 @@ public class CommandHandler{
             
             switch(args[0].toLowerCase(Locale.ROOT)){
                 case "list" -> {
-                    List<ServerListProfile> profiles = core.getFileHandler().getProfiles().stream()
-                        .sorted(Comparator.comparing(ServerListProfile::priority).reversed())
-                        .toList();
-                    
                     sender.sendPrefixedMsg("Available Profiles:");
-                    for(ServerListProfile profile : profiles){
-                        sender.sendPrefixedMsg("- <white><hover:show_text:\"%s\">%s</hover></white>", getHover(profile), profile.file());
-                    }
+                    core.getFileHandler().getProfiles().stream()
+                        .sorted(Comparator.comparingInt(ServerListProfile::priority).reversed())
+                        .forEach(
+                            profile -> sender.sendPrefixedMsg("- <white><hover:show_text:\"%s\">%s</hover></white>", getHover(profile), profile.file())
+                        );
                 }
                 case "add" -> {
                     if(args.length == 1){
@@ -316,7 +314,7 @@ public class CommandHandler{
                     String name = getProfileName(args[1]);
                     
                     if(core.getFileHandler().getProfiles().stream().anyMatch(profile -> profile.file().equalsIgnoreCase(name))){
-                        sender.sendErrorMsg("<red>A profile with file name</red> %s <red>already exists!");
+                        sender.sendErrorMsg("<red>A profile with file name</red> %s <red>already exists!", name);
                         return;
                     }
                     
@@ -359,7 +357,7 @@ public class CommandHandler{
                     try{
                         Files.createFile(profilePath);
                     }catch(IOException ex){
-                        sender.sendErrorMsg("<red>There was an error while creating the file</red> %s<red>!");
+                        sender.sendErrorMsg("<red>There was an error while creating the file</red> %s<red>!", copy);
                         sender.sendErrorMsg("<red>Check console for further details.");
                         
                         core.getPlugin().getPluginLogger().warn("Encountered IOException while creating file %s", ex, copy);
@@ -377,7 +375,7 @@ public class CommandHandler{
                     try{
                         node = loader.load();
                     }catch(IOException ex){
-                        sender.sendErrorMsg("<red>There was an error while loading the file</red> %s<red>!");
+                        sender.sendErrorMsg("<red>There was an error while loading the file</red> %s<red>!", copy);
                         sender.sendErrorMsg("<red>Check console for further details.");
                         
                         core.getPlugin().getPluginLogger().warn("Encountered IOException while loading file %s", ex, copy);
@@ -399,6 +397,8 @@ public class CommandHandler{
                     }catch(SerializationException ex){
                         sender.sendErrorMsg("<red>There was an Error while copying values from</red> %s <red>to</red> %s<red>.", name, copy);
                         sender.sendErrorMsg("<red>Check console for details.");
+                        
+                        core.getPlugin().getPluginLogger().warn("Encountered SerializationException while set values for %s!", ex, copy);
                         return;
                     }
                     
@@ -409,6 +409,8 @@ public class CommandHandler{
                     }catch(IOException ex){
                         sender.sendErrorMsg("<red>There was an Error while trying to save</red> %s<red>!", copy);
                         sender.sendErrorMsg("<red>Check console for details.");
+                        
+                        core.getPlugin().getPluginLogger().warn("Encountered IOException while saving ConfigurationNode for %s!", ex, copy);
                     }
                 }
                 default -> {
@@ -420,9 +422,9 @@ public class CommandHandler{
         
         @Override
         public String usage(){
-            return "<aqua>/asl <white>profiles</white> <grey><" +
-                "<white>add</white> <<white>name</white>> | " +
-                "<white>copy</white> <<white>profile</white>> <<white>name</white>> | " +
+            return "<aqua>/asl <white>profiles</white> <grey>\\<" +
+                "<white>add</white> \\<<white>name</white>> | " +
+                "<white>copy</white> \\<<white>profile</white>> \\<<white>name</white>> | " +
                 "<white>list</white>" +
                 "></grey></aqua>";
         }

core/src/main/java/ch/andre601/advancedserverlist/core/compat/papi/PAPIUtil.java

@@ -34,7 +34,6 @@ import java.util.List;
 import java.util.Set;
 import java.util.UUID;
 import java.util.concurrent.CancellationException;
-import java.util.concurrent.CompletableFuture;
 import java.util.concurrent.CompletionException;
 
 public class PAPIUtil{
@@ -88,8 +87,7 @@ public class PAPIUtil{
     
     public String parse(String text, UUID carrier, UUID player){
         try{
-            CompletableFuture<String> future = papi.formatPlaceholders(text, carrier, player);
-            return future.getNow(text);
+            return papi.formatPlaceholders(text, carrier, player).getNow(text);
         }catch(IllegalArgumentException | CancellationException | CompletionException ex){
             return text;
         }

core/src/main/java/ch/andre601/advancedserverlist/core/migration/minimotd/MiniMOTDConfigMigrator.java

@@ -145,7 +145,7 @@ public class MiniMOTDConfigMigrator{
             .map(ProfileEntry.Builder::build)
             .toList();
         
-        boolean profilesInvalid = profiles.isEmpty() || profiles.stream().anyMatch(ProfileEntry::isInvalid);
+        boolean profilesInvalid = profiles.isEmpty() || profiles.stream().allMatch(ProfileEntry::isInvalid);
         if(entry.isInvalid() && profilesInvalid){
             logger.warn("[Migrator - MiniMOTD] Main ProfileEntry was invalid and profiles were empty.");
             sender.sendErrorMsg(" -> <red>Received invalid configuration.");
@@ -187,7 +187,7 @@ public class MiniMOTDConfigMigrator{
         }
         
         if(migrated == null){
-            logger.warn("[Migrator - MiniMOTD] Cannot migrate Configuration. ConfiguationNode was null.");
+            logger.warn("[Migrator - MiniMOTD] Cannot migrate Configuration. ConfigurationNode was null.");
             sender.sendErrorMsg(" -> <red>File loading error.");
             
             return false;

core/src/main/java/ch/andre601/advancedserverlist/core/profiles/ServerListProfile.java

@@ -28,8 +28,8 @@ package ch.andre601.advancedserverlist.core.profiles;
 import ch.andre601.advancedserverlist.api.objects.GenericPlayer;
 import ch.andre601.advancedserverlist.api.objects.GenericServer;
 import ch.andre601.advancedserverlist.api.profiles.ProfileEntry;
+import ch.andre601.advancedserverlist.core.AdvancedServerList;
 import ch.andre601.advancedserverlist.core.interfaces.PluginLogger;
-import ch.andre601.advancedserverlist.core.profiles.conditions.ProfileConditionParser;
 import ch.andre601.expressionparser.ParseWarnCollector;
 import org.spongepowered.configurate.ConfigurationNode;
 import org.spongepowered.configurate.serialize.SerializationException;
@@ -41,13 +41,14 @@ import java.util.Random;
 public record ServerListProfile(int priority, String condition, ProfileEntry defaultProfile, List<ProfileEntry> profiles, String file){
     private static final Random random = new Random();
     
-    public boolean evalConditions(ProfileConditionParser parser, PluginLogger logger, GenericPlayer player, GenericServer server){
+    public boolean evalConditions(AdvancedServerList<?> core, GenericPlayer player, GenericServer server){
         if(condition == null || condition.isEmpty())
             return true;
         
         ParseWarnCollector collector = new ParseWarnCollector(condition);
+        PluginLogger logger = core.getPlugin().getPluginLogger();
         
-        boolean result = parser.evaluate(condition, player, server, collector);
+        boolean result = core.getParser().evaluate(condition, player, server, collector);
         
         if(collector.hasWarnings()){
             logger.warn("Encountered %d Error(s) while parsing condition for file '%s':", collector.getWarnings().size(), file);
@@ -120,13 +121,6 @@ public record ServerListProfile(int priority, String condition, ProfileEntry def
             this.logger = logger;
         }
         
-        public Builder(String filename, int priority, PluginLogger logger){
-            this.fileName = filename;
-            this.node = null;
-            this.priority = priority;
-            this.logger = logger;
-        }
-        
         public static Builder resolve(String fileName, ConfigurationNode node, PluginLogger logger){
             return new Builder(fileName, node, logger)
                 .resolveCondition()

core/src/main/java/ch/andre601/advancedserverlist/core/profiles/profile/ProfileManager.java

@@ -36,6 +36,7 @@ import org.spongepowered.configurate.serialize.SerializationException;
 
 import java.util.Collections;
 import java.util.List;
+import java.util.function.Function;
 
 public class ProfileManager{
     
@@ -44,22 +45,21 @@ public class ProfileManager{
      * If the random profile's value is not null will it be used instead of the default one.
      */
     public static ProfileEntry merge(ServerListProfile profile){
-        ProfileEntry entry = profile.getRandomProfile();
         ProfileEntry defEntry = profile.defaultProfile();
+        ProfileEntry entry = profile.getRandomProfile();
         
-        List<String> motd = resolveMOTD(entry, defEntry);
-        List<String> players = resolvePlayers(entry, defEntry);
-        String playerCountText = resolvePlayerCountText(entry, defEntry);
-        String favicon = resolveFavicon(entry, defEntry);
-        boolean isHidePlayersEnabled = resolveHidePlayersEnabled(entry, defEntry);
-        boolean isExtraPlayersEnabled = resolveExtraPlayersEnabled(entry, defEntry);
-        boolean isMaxPlayersEnabled = resolveMaxPlayersEnabled(entry, defEntry);
-        Integer extraPlayersCount = resolveExtraPlayersCount(entry, defEntry);
-        Integer maxPlayersCount = resolveMaxPlayersCount(entry, defEntry);
+        List<String> motd = resolve(defEntry, entry, ProfileEntry::motd);
+        List<String> players = resolve(defEntry, entry, ProfileEntry::players);
+        String playerCountText = resolve(defEntry, entry, ProfileEntry::playerCountText);
+        String favicon = resolve(defEntry, entry, ProfileEntry::favicon);
+        NullBool hidePlayersEnabled = resolve(defEntry, entry, ProfileEntry::hidePlayersEnabled);
+        NullBool extraPlayersEnabled = resolve(defEntry, entry, ProfileEntry::extraPlayersEnabled);
+        NullBool maxPlayersEnabled = resolve(defEntry, entry, ProfileEntry::maxPlayersEnabled);
+        Integer extraPlayersCount = resolve(defEntry, entry, ProfileEntry::extraPlayersCount);
+        Integer maxPlayersCount = resolve(defEntry, entry, ProfileEntry::maxPlayersCount);
         
-        return new ProfileEntry(motd, players, playerCountText, favicon, 
-            NullBool.resolve(isHidePlayersEnabled), NullBool.resolve(isExtraPlayersEnabled), NullBool.resolve(isMaxPlayersEnabled),
-            extraPlayersCount, maxPlayersCount);
+        return new ProfileEntry(motd, players, playerCountText, favicon, hidePlayersEnabled, extraPlayersEnabled,
+            maxPlayersEnabled, extraPlayersCount, maxPlayersCount);
     }
     
     public static ServerListProfile resolveProfile(AdvancedServerList<?> core, GenericPlayer player, GenericServer server){
@@ -67,7 +67,7 @@ public class ProfileManager{
             if(profile.isInvalidProfile())
                 continue;
             
-            if(profile.evalConditions(core.getParser(), core.getPlugin().getPluginLogger(), player, server))
+            if(profile.evalConditions(core, player, server))
                 return profile;
         }
         
@@ -115,67 +115,11 @@ public class ProfileManager{
         return false;
     }
     
-    private static List<String> resolveMOTD(ProfileEntry profile, ProfileEntry defaultProfile){
-        if(profile == null || !checkOption(profile.motd()))
-            return defaultProfile.motd();
+    private static <T> T resolve(ProfileEntry defProfile, ProfileEntry profile, Function<ProfileEntry, T> function){
+        if(profile == null || !checkOption(function.apply(profile)))
+            return function.apply(defProfile);
         
-        return profile.motd();
-    }
-    
-    private static List<String> resolvePlayers(ProfileEntry profile, ProfileEntry defaultProfile){
-        if(profile == null || !checkOption(profile.players()))
-            return defaultProfile.players();
-        
-        return profile.players();
-    }
-    
-    private static String resolvePlayerCountText(ProfileEntry profile, ProfileEntry defaultProfile){
-        if(profile == null || !checkOption(profile.playerCountText()))
-            return defaultProfile.playerCountText();
-        
-        return profile.playerCountText();
-    }
-    
-    private static String resolveFavicon(ProfileEntry profile, ProfileEntry defaultProfile){
-        if(profile == null || !checkOption(profile.favicon()))
-            return defaultProfile.favicon();
-        
-        return profile.favicon();
-    }
-    
-    private static boolean resolveHidePlayersEnabled(ProfileEntry profile, ProfileEntry defaultProfile){
-        if(profile == null || !checkOption(profile.hidePlayersEnabled()))
-            return defaultProfile.hidePlayersEnabled().getOrDefault(false);
-        
-        return profile.hidePlayersEnabled().getOrDefault(false);
-    }
-    
-    private static boolean resolveExtraPlayersEnabled(ProfileEntry profile, ProfileEntry defaultProfile){
-        if(profile == null || !checkOption(profile.extraPlayersEnabled()))
-            return defaultProfile.extraPlayersEnabled().getOrDefault(false);
-        
-        return profile.extraPlayersEnabled().getOrDefault(false);
-    }
-    
-    private static boolean resolveMaxPlayersEnabled(ProfileEntry profile, ProfileEntry defaultProfile){
-        if(profile == null || !checkOption(profile.maxPlayersEnabled()))
-            return defaultProfile.maxPlayersEnabled().getOrDefault(false);
-        
-        return profile.maxPlayersEnabled().getOrDefault(false);
-    }
-    
-    private static Integer resolveExtraPlayersCount(ProfileEntry profile, ProfileEntry defaultProfile){
-        if(profile == null || profile.extraPlayersCount() == null)
-            return defaultProfile.extraPlayersCount() == null ? 0 : defaultProfile.extraPlayersCount();
-        
-        return profile.extraPlayersCount();
-    }
-    
-    private static Integer resolveMaxPlayersCount(ProfileEntry profile, ProfileEntry defaultProfile){
-        if(profile == null || profile.maxPlayersCount() == null)
-            return defaultProfile.maxPlayersCount() == null ? 0 : defaultProfile.maxPlayersCount();
-        
-        return profile.maxPlayersCount();
+        return function.apply(profile);
     }
     
     private static List<String> resolveList(ConfigurationNode node, Object... path){

paper/pom.xml

@@ -99,7 +99,7 @@
         <dependency>
             <groupId>com.viaversion</groupId>
             <artifactId>viaversion-api</artifactId>
-            <version>5.0.1</version>
+            <version>5.0.2</version>
             <scope>provided</scope>
         </dependency>
 

pom.xml

@@ -37,7 +37,7 @@
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         
-        <plugin.version>4.12.0</plugin.version>
+        <plugin.version>4.12.1</plugin.version>
         <plugin.description>Create multiple Server lists based on conditions.</plugin.description>
         
         <api.version>3.3.0</api.version>

requirements.txt

@@ -1,3 +1,3 @@
-mkdocs-material==9.5.28
+mkdocs-material==9.5.30
 mkdocs-glightbox==0.4.0
 git+https://github.com/Andre601/mkdocs-pagenav-generator

version-uploader/pom.xml

@@ -70,7 +70,7 @@
         <dependency>
             <groupId>dev.masecla</groupId>
             <artifactId>Modrinth4J</artifactId>
-            <version>2.0.0</version>
+            <version>2.2.0</version>
             <scope>compile</scope>
         </dependency>
         <dependency>