GH-92 Improve the general plugin security, code style and performance.

Author: imDMK

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
-#Mon Dec 23 12:09:35 CET 2024
+#Fri Apr 04 19:27:25 CEST 2025
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.10-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.13-bin.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

spenttime-api/build.gradle.kts

@@ -5,6 +5,7 @@ version = "2.0.0"
 
 dependencies {
     implementation("com.github.ben-manes.caffeine:caffeine:3.1.8")
+    implementation("org.jetbrains:annotations:26.0.2")
 }
 
 tasks.withType<ShadowJar> {

spenttime-api/src/main/java/com/github/imdmk/spenttime/SpentTimeApi.java

@@ -1,15 +1,29 @@
 package com.github.imdmk.spenttime;
 
 import com.github.imdmk.spenttime.user.UserCache;
-import com.github.imdmk.spenttime.user.UserService;
 import com.github.imdmk.spenttime.user.repository.UserRepository;
+import org.jetbrains.annotations.NotNull;
 
+/**
+ * Main API interface for accessing user-related components of the SpentTime module.
+ * <p>
+ * Provides access to:
+ * - {@link UserCache}: in-memory user cache (by UUID and name)
+ * - {@link UserRepository}: persistence layer for users
+ */
 public interface SpentTimeApi {
 
-    UserCache getUserCache();
-
-    UserService getUserService();
-
-    UserRepository getUserRepository();
+    /**
+     * Returns the in-memory user cache.
+     *
+     * @return {@link UserCache} the user cache instance
+     */
+    @NotNull UserCache getUserCache();
 
+    /**
+     * Returns the user repository for data access operations.
+     *
+     * @return {@link UserRepository} the user repository
+     */
+    @NotNull UserRepository getUserRepository();
 }

spenttime-api/src/main/java/com/github/imdmk/spenttime/SpentTimeApiProvider.java

@@ -1,5 +1,13 @@
 package com.github.imdmk.spenttime;
 
+import org.jetbrains.annotations.NotNull;
+
+/**
+ * Static access point for the {@link SpentTimeApi}.
+ * Acts as a global registry for the current instance.
+ * <p>
+ * Not thread-safe.
+ */
 public class SpentTimeApiProvider {
 
     private static SpentTimeApi SPENT_TIME_API;
@@ -8,25 +16,49 @@ private SpentTimeApiProvider() {
         throw new UnsupportedOperationException("This class cannot be instantiated.");
     }
 
-    public static SpentTimeApi get() {
+    /**
+     * Returns the registered {@link SpentTimeApi}.
+     *
+     * @return the registered API
+     * @throws IllegalStateException if the API is not yet registered
+     */
+    public synchronized static SpentTimeApi get() {
         if (SPENT_TIME_API == null) {
-            throw new IllegalStateException("The DiscordIntegrationAPI isn't registered.");
+            throw new IllegalStateException("The SpentTimeApi isn't registered.");
         }
 
         return SPENT_TIME_API;
     }
 
-    static void register(SpentTimeApi spentTimeApi) {
+    /**
+     * Registers the {@link SpentTimeApi} instance.
+     *
+     * @param spentTimeApi the API instance to register
+     * @throws IllegalStateException if already registered
+     */
+    static synchronized void register(@NotNull SpentTimeApi spentTimeApi) {
         if (SPENT_TIME_API != null) {
-            throw new IllegalStateException("The DiscordIntegrationAPI is already registered.");
+            throw new IllegalStateException("The SpentTimeApi is already registered.");
         }
 
         SPENT_TIME_API = spentTimeApi;
     }
 
-    static void unregister() {
+    /**
+     * Forces to register the {@link SpentTimeApi} instance.
+     */
+    static void forceRegister(@NotNull SpentTimeApi api) {
+        SPENT_TIME_API = api;
+    }
+
+    /**
+     * Unregisters the {@link SpentTimeApi}.
+     *
+     * @throws IllegalStateException if no API was registered
+     */
+    static synchronized void unregister() {
         if (SPENT_TIME_API == null) {
-            throw new IllegalStateException("The DiscordIntegrationAPI isn't registered.");
+            throw new IllegalStateException("The SpentTimeApi isn't registered.");
         }
 
         SPENT_TIME_API = null;

spenttime-api/src/main/java/com/github/imdmk/spenttime/configuration/ConfigSection.java

@@ -0,0 +1,12 @@
+package com.github.imdmk.spenttime.configuration;
+
+import eu.okaeri.configs.OkaeriConfig;
+import eu.okaeri.configs.serdes.OkaeriSerdesPack;
+import org.jetbrains.annotations.NotNull;
+
+public abstract class ConfigSection extends OkaeriConfig {
+
+    public abstract @NotNull OkaeriSerdesPack getSerdesPack();
+
+    public abstract @NotNull String getFileName();
+}

spenttime-api/src/main/java/com/github/imdmk/spenttime/configuration/ConfigurationLoadException.java

@@ -0,0 +1,16 @@
+package com.github.imdmk.spenttime.configuration;
+
+public class ConfigurationLoadException extends RuntimeException {
+    public ConfigurationLoadException(Throwable cause) {
+        super("Failed to load configuration", cause);
+    }
+
+    public ConfigurationLoadException(String message) {
+        super(message);
+    }
+
+    public ConfigurationLoadException(String message, Throwable cause) {
+        super(message, cause);
+    }
+
+}

spenttime-api/src/main/java/com/github/imdmk/spenttime/configuration/ConfigurationManager.java

@@ -0,0 +1,94 @@
+package com.github.imdmk.spenttime.configuration;
+
+import eu.okaeri.configs.ConfigManager;
+import eu.okaeri.configs.OkaeriConfig;
+import eu.okaeri.configs.exception.OkaeriException;
+import eu.okaeri.configs.yaml.snakeyaml.YamlSnakeYamlConfigurer;
+import org.jetbrains.annotations.NotNull;
+import org.yaml.snakeyaml.DumperOptions;
+import org.yaml.snakeyaml.LoaderOptions;
+import org.yaml.snakeyaml.Yaml;
+import org.yaml.snakeyaml.constructor.Constructor;
+import org.yaml.snakeyaml.representer.Representer;
+import org.yaml.snakeyaml.resolver.Resolver;
+
+import java.io.File;
+import java.util.Objects;
+import java.util.Set;
+import java.util.concurrent.CompletableFuture;
+import java.util.concurrent.ConcurrentHashMap;
+import java.util.concurrent.ExecutorService;
+import java.util.concurrent.Executors;
+import java.util.logging.Level;
+import java.util.logging.Logger;
+
+public final class ConfigurationManager {
+
+    private final Set<ConfigSection> configs = ConcurrentHashMap.newKeySet();
+
+    private final Logger logger;
+    private final ExecutorService executor;
+
+    public ConfigurationManager(@NotNull Logger logger) {
+        this.logger = Objects.requireNonNull(logger, "logger cannot be null");
+        this.executor = Executors.newSingleThreadExecutor();
+    }
+
+    public <T extends ConfigSection> T create(@NotNull Class<T> config, @NotNull File dataFolder) {
+        T configFile = ConfigManager.create(config);
+        File file = new File(dataFolder, configFile.getFileName());
+
+        YamlSnakeYamlConfigurer yamlSnakeYamlConfigurer = this.createYamlSnakeYamlConfigurer();
+
+        configFile.withConfigurer(yamlSnakeYamlConfigurer);
+        configFile.withSerdesPack(configFile.getSerdesPack());
+        configFile.withBindFile(file);
+        configFile.withRemoveOrphans(true);
+        configFile.saveDefaults();
+        configFile.load(true);
+
+        this.configs.add(configFile);
+
+        return configFile;
+    }
+
+    private @NotNull YamlSnakeYamlConfigurer createYamlSnakeYamlConfigurer() {
+        LoaderOptions loaderOptions = new LoaderOptions();
+        Constructor constructor = new Constructor(loaderOptions);
+
+        DumperOptions dumperOptions = new DumperOptions();
+        dumperOptions.setDefaultFlowStyle(DumperOptions.FlowStyle.AUTO);
+        dumperOptions.setIndent(2);
+        dumperOptions.setSplitLines(false);
+
+        Representer representer = new CustomRepresenter(dumperOptions);
+        Resolver resolver = new Resolver();
+
+        Yaml yaml = new Yaml(constructor, representer, dumperOptions, loaderOptions, resolver);
+        return new YamlSnakeYamlConfigurer(yaml);
+    }
+
+    public @NotNull CompletableFuture<Void> reloadAll() {
+        return CompletableFuture.runAsync(this::loadAll, this.executor);
+    }
+
+    private void loadAll() {
+        this.configs.forEach(this::load);
+    }
+
+    public void load(@NotNull OkaeriConfig config) {
+        try {
+            config.load(true);
+        }
+        catch (OkaeriException exception) {
+            this.logger.log(Level.SEVERE, "Failed to load config: " + config.getClass().getSimpleName(), exception);
+            throw new ConfigurationLoadException(exception);
+        }
+    }
+
+    public void shutdown() {
+        this.logger.info("Shutting down ConfigurationManager executor");
+        this.executor.shutdownNow();
+    }
+
+}

spenttime-api/src/main/java/com/github/imdmk/spenttime/configuration/CustomRepresenter.java

@@ -11,7 +11,7 @@
 import java.util.LinkedHashMap;
 import java.util.Map;
 
-public class CustomRepresenter extends Representer {
+public final class CustomRepresenter extends Representer {
 
     public CustomRepresenter(DumperOptions options) {
         super(options);

…spenttime/database/DatabaseSettings.java …time/database/DatabaseConfiguration.javaspenttime-api/src/main/java/com/github/imdmk/spenttime/database/DatabaseSettings.java renamed to spenttime-api/src/main/java/com/github/imdmk/spenttime/database/DatabaseConfiguration.java spenttime-api/src/main/java/com/github/imdmk/spenttime/database/DatabaseSettings.java renamed to spenttime-api/src/main/java/com/github/imdmk/spenttime/database/DatabaseConfiguration.java

@@ -1,9 +1,11 @@
 package com.github.imdmk.spenttime.database;
 
-import eu.okaeri.configs.OkaeriConfig;
+import com.github.imdmk.spenttime.configuration.ConfigSection;
 import eu.okaeri.configs.annotation.Comment;
+import eu.okaeri.configs.serdes.OkaeriSerdesPack;
+import org.jetbrains.annotations.NotNull;
 
-public class DatabaseSettings extends OkaeriConfig {
+public class DatabaseConfiguration extends ConfigSection {
 
     @Comment({
             "# Database mode",
@@ -16,4 +18,14 @@ public class DatabaseSettings extends OkaeriConfig {
     public String username = "root";
     public String password = "ExamplePassword1101";
     public int port = 3306;
+
+    @Override
+    public @NotNull OkaeriSerdesPack getSerdesPack() {
+        return registry -> {};
+    }
+
+    @Override
+    public @NotNull String getFileName() {
+        return "databaseConfiguration.yml";
+    }
 }