Merge branch 'master' into mc1.21.1

Author: TBlueF

common/build.gradle.kts

@@ -31,6 +31,7 @@ node {
     version = "20.14.0"
     download = true
     nodeProjectDir = file("webapp/")
+    npmInstallCommand = "ci"
 }
 
 tasks.register("buildWebapp", type = NpmTask::class) {

common/src/main/java/de/bluecolored/bluemap/common/api/BlueMapAPIImpl.java

@@ -24,7 +24,6 @@
  */
 package de.bluecolored.bluemap.common.api;
 
-import com.github.benmanes.caffeine.cache.Caffeine;
 import com.github.benmanes.caffeine.cache.LoadingCache;
 import de.bluecolored.bluemap.api.BlueMapAPI;
 import de.bluecolored.bluemap.api.BlueMapMap;
@@ -35,6 +34,7 @@
 import de.bluecolored.bluemap.core.BlueMap;
 import de.bluecolored.bluemap.core.logger.Logger;
 import de.bluecolored.bluemap.core.map.BmMap;
+import de.bluecolored.bluemap.core.util.Caches;
 import de.bluecolored.bluemap.core.world.World;
 import lombok.NonNull;
 import org.jetbrains.annotations.Nullable;
@@ -68,12 +68,10 @@ public BlueMapAPIImpl(BlueMapService blueMapService, @Nullable Plugin plugin) {
         this.webAppImpl = new WebAppImpl(blueMapService, plugin);
         this.pluginImpl = plugin != null ? new PluginImpl(plugin) : null;
 
-        this.worldCache = Caffeine.newBuilder()
-                .executor(BlueMap.THREAD_POOL)
+        this.worldCache = Caches.with()
                 .weakKeys()
                 .build(this::getWorldUncached);
-        this.mapCache = Caffeine.newBuilder()
-                .executor(BlueMap.THREAD_POOL)
+        this.mapCache = Caches.with()
                 .weakKeys()
                 .build(this::getMapUncached);
     }

common/src/main/java/de/bluecolored/bluemap/common/commands/Commands.java

@@ -26,7 +26,6 @@
 
 import com.flowpowered.math.vector.Vector3d;
 import com.github.benmanes.caffeine.cache.Cache;
-import com.github.benmanes.caffeine.cache.Caffeine;
 import com.github.benmanes.caffeine.cache.LoadingCache;
 import de.bluecolored.bluecommands.*;
 import de.bluecolored.bluemap.common.commands.arguments.MapBackedArgumentParser;
@@ -39,8 +38,8 @@
 import de.bluecolored.bluemap.common.serverinterface.CommandSource;
 import de.bluecolored.bluemap.common.serverinterface.ServerWorld;
 import de.bluecolored.bluemap.core.map.BmMap;
+import de.bluecolored.bluemap.core.util.Caches;
 import de.bluecolored.bluemap.core.world.World;
-import net.kyori.adventure.text.event.ClickEvent;
 import org.jetbrains.annotations.Nullable;
 
 import java.util.Map;
@@ -53,10 +52,10 @@
 
 public class Commands {
 
-    private static final Cache<String, RenderTask> REF_TO_RENDERTASK = Caffeine.newBuilder()
+    private static final Cache<String, RenderTask> REF_TO_RENDERTASK = Caches.with()
             .weakValues()
             .build();
-    private static final LoadingCache<RenderTask, String> RENDERTASK_TO_REF = Caffeine.newBuilder()
+    private static final LoadingCache<RenderTask, String> RENDERTASK_TO_REF = Caches.with()
             .weakKeys()
             .build(Commands::safeRandomRef);
 

common/src/main/java/de/bluecolored/bluemap/common/commands/commands/DebugCommand.java

@@ -73,7 +73,7 @@ public int dump(CommandSource source) {
                     text(BlueMapConfigManager.formatPath(file)).color(HIGHLIGHT_COLOR)
             ).color(POSITIVE_COLOR));
             return 1;
-        } catch (IOException ex) {
+        } catch (Exception ex) {
             Logger.global.logError("Failed to create dump!", ex);
             source.sendMessage(text("Exception trying to create debug-dump! See console for details.").color(NEGATIVE_COLOR));
             return 0;

common/src/main/java/de/bluecolored/bluemap/common/debug/StateDumper.java

@@ -24,6 +24,8 @@
  */
 package de.bluecolored.bluemap.common.debug;
 
+import com.github.benmanes.caffeine.cache.Cache;
+import com.github.benmanes.caffeine.cache.stats.CacheStats;
 import com.google.gson.stream.JsonWriter;
 import de.bluecolored.bluemap.core.BlueMap;
 import de.bluecolored.bluemap.core.util.Key;
@@ -117,7 +119,57 @@ private void dumpInstance(Object instance, JsonWriter writer, Set<Object> alread
             String identityString = toIdentityString(instance);
             writer.name("#identity").value(identityString);
 
+            if (instance instanceof Cache<?,?> cache) {
+                writer.name("stats");
+                dumpInstance(cache.stats(), writer, alreadyDumped);
+
+                writer.name("estimated-size").value(cache.estimatedSize());
+
+                writer.name("entries").beginArray();
+                int count = 0;
+                for (Map.Entry<?, ?> entry : cache.asMap().entrySet()) {
+                    if (++count > 10) {
+                        writer.value("<<more elements>>");
+                        break;
+                    }
+
+                    writer.beginObject();
+                    try {
+
+                        writer.name("key");
+                        dumpInstance(entry.getKey(), writer, alreadyDumped);
+
+                        writer.name("value");
+                        dumpInstance(entry.getValue(), writer, alreadyDumped);
+
+                    } finally {
+                        writer.endObject();
+                    }
+
+                }
+                writer.endArray();
+                return;
+            }
+
+            if (instance instanceof CacheStats cacheStats) {
+                writer.name("request-count").value(cacheStats.requestCount());
+                writer.name("hit-count").value(cacheStats.hitCount());
+                writer.name("hit-rate").value(cacheStats.hitRate());
+                writer.name("miss-count").value(cacheStats.missCount());
+                writer.name("miss-rate").value(cacheStats.missRate());
+                writer.name("load-count").value(cacheStats.loadCount());
+                writer.name("load-success-count").value(cacheStats.loadSuccessCount());
+                writer.name("load-failure-count").value(cacheStats.loadFailureCount());
+                writer.name("load-failure-rate").value(cacheStats.loadFailureRate());
+                writer.name("total-load-time").value(cacheStats.totalLoadTime());
+                writer.name("average-load-penalty").value(cacheStats.averageLoadPenalty());
+                writer.name("eviction-count").value(cacheStats.evictionCount());
+                writer.name("eviction-weight").value(cacheStats.evictionWeight());
+                return;
+            }
+
             if (instance instanceof Map<?, ?> map) {
+                writer.name("size").value(map.size());
                 writer.name("entries").beginArray();
 
                 int count = 0;
@@ -128,21 +180,25 @@ private void dumpInstance(Object instance, JsonWriter writer, Set<Object> alread
                     }
 
                     writer.beginObject();
+                    try {
 
-                    writer.name("key");
-                    dumpInstance(entry.getKey(), writer, alreadyDumped);
+                        writer.name("key");
+                        dumpInstance(entry.getKey(), writer, alreadyDumped);
 
-                    writer.name("value");
-                    dumpInstance(entry.getValue(), writer, alreadyDumped);
+                        writer.name("value");
+                        dumpInstance(entry.getValue(), writer, alreadyDumped);
 
-                    writer.endObject();
+                    } finally {
+                        writer.endObject();
+                    }
                 }
 
                 writer.endArray();
                 return;
             }
 
             if (instance instanceof Collection<?> collection) {
+                writer.name("size").value(collection.size());
                 writer.name("entries").beginArray();
 
                 int count = 0;
@@ -160,6 +216,7 @@ private void dumpInstance(Object instance, JsonWriter writer, Set<Object> alread
             }
 
             if (instance instanceof Object[] array) {
+                writer.name("length").value(array.length);
                 writer.name("entries").beginArray();
 
                 int count = 0;

common/src/main/java/de/bluecolored/bluemap/common/plugin/MapUpdateService.java

@@ -26,11 +26,11 @@
 
 import com.flowpowered.math.vector.Vector2i;
 import com.github.benmanes.caffeine.cache.Cache;
-import com.github.benmanes.caffeine.cache.Caffeine;
 import de.bluecolored.bluemap.common.rendermanager.RenderManager;
 import de.bluecolored.bluemap.common.rendermanager.WorldRegionRenderTask;
 import de.bluecolored.bluemap.core.logger.Logger;
 import de.bluecolored.bluemap.core.map.BmMap;
+import de.bluecolored.bluemap.core.util.Caches;
 import de.bluecolored.bluemap.core.util.WatchService;
 
 import java.io.IOException;
@@ -60,7 +60,7 @@ public MapUpdateService(RenderManager renderManager, BmMap map, Duration regionU
         this.regionUpdateCooldown = regionUpdateCooldown;
         this.closed = false;
         this.scheduledUpdates = new HashMap<>();
-        this.lastUpdateTimes = Caffeine.newBuilder()
+        this.lastUpdateTimes = Caches.with()
                 .expireAfterWrite(regionUpdateCooldown)
                 .build();
         this.watchService = map.getWorld().createRegionWatchService();

common/src/main/java/de/bluecolored/bluemap/common/serverinterface/Server.java

@@ -25,9 +25,8 @@
 package de.bluecolored.bluemap.common.serverinterface;
 
 import com.github.benmanes.caffeine.cache.Cache;
-import com.github.benmanes.caffeine.cache.Caffeine;
-import com.github.benmanes.caffeine.cache.LoadingCache;
 import de.bluecolored.bluemap.common.debug.DebugDump;
+import de.bluecolored.bluemap.core.util.Caches;
 import de.bluecolored.bluemap.core.util.Tristate;
 import de.bluecolored.bluemap.core.world.World;
 import de.bluecolored.bluemap.core.world.mca.MCAWorld;
@@ -36,12 +35,10 @@
 import java.nio.file.Path;
 import java.util.Collection;
 import java.util.Optional;
-import java.util.concurrent.TimeUnit;
 
 public interface Server {
 
-    Cache<World, Optional<ServerWorld>> SERVER_WORLD_CACHE = Caffeine.newBuilder()
-            .expireAfterWrite(10, TimeUnit.SECONDS)
+    Cache<World, Optional<ServerWorld>> SERVER_WORLD_CACHE = Caches.with()
             .weakKeys()
             .weakValues()
             .build();

common/src/main/resources/de/bluecolored/bluemap/config/core.conf

@@ -3,46 +3,47 @@
 ##       Core-Config        ##
 ##                          ##
 
-# By changing the setting (accept-download) below to TRUE you are indicating that you have accepted mojang's EULA (https://account.mojang.com/documents/minecraft_eula),
-# you confirm that you own a license to Minecraft (Java Edition)
-# and you agree that BlueMap will download and use a minecraft-client file (depending on the minecraft-version) from mojangs servers (https://piston-meta.mojang.com/) for you.
-# This file contains resources that belong to mojang and you must not redistribute it or do anything else that is not compliant with mojang's EULA.
-# BlueMap uses resources in this file to generate the 3D-Models used for the map and texture them. (BlueMap will not work without those resources.)
+# By changing the setting (accept-download) below to TRUE you are indicating that you have accepted Mojang's EULA (https://account.mojang.com/documents/minecraft_eula),
+# you confirm that you own a license to Minecraft (Java Edition),
+# and you agree that BlueMap will download and use a Minecraft client file (depending on the Minecraft version) from Mojang's servers (https://piston-meta.mojang.com/) for you.
+# This file contains resources that belong to Mojang and you must not redistribute it or do anything else that is not compliant with Mojang's EULA.
+# BlueMap uses resources in this file to generate the 3D models used for the map and texture them. Without these, BlueMap will not work.
 # ${timestamp}
 accept-download: false
 
-# The folder where bluemap saves data-files it needs during runtime or to save e.g. the render-progress to resume it later.
+# The folder where BlueMap saves data files it needs during runtime.
+# For example, the render progress file, which is used to resume the render across restarts.
 # Default is "bluemap"
 data: "${data}"
 
 # This changes the amount of threads that BlueMap will use to render the maps.
-# A higher value can improve render-speed but could impact performance on the host machine.
-# This should be always below or equal to the number of available processor-cores.
-# Zero or a negative value means the amount of available processor-cores subtracted by the value.
-# (So a value of -2 with 6 cores results in 4 render-processes)
+# A higher value can improve the render speed, but could impact performance on the host machine.
+# This should be always below or equal to the number of available processor cores.
+# Zero or a negative value means the amount of available processor cores subtracted by the value.
+# For example, on a machine with 6 cores, a value of -2 would result in 4 render threads.
 # Default is 1
 render-thread-count: ${render-thread-count}
 
-# Controls whether BlueMap should try to find and load mod-resources and datapacks from the server/world-directories.
+# Controls whether BlueMap should try to find and load mod resources and datapacks from the server/world directories.
 # Default is true
 scan-for-mod-resources: true
 ${metrics<<
-# If this is true, BlueMap might send really basic metrics reports containing only the implementation-type and the version that is being used to https://metrics.bluecolored.de/bluemap/
+# If this is true, BlueMap might send really basic metric reports containing only the implementation type and the version that is being used to https://metrics.bluecolored.de/bluemap/
 # This allows me to track the basic usage of BlueMap and helps me stay motivated to further develop this tool! Please leave it on :)
 # An example report looks like this: {"implementation":"${implementation}","version":"${version}","mcVersion":"${mcVersion}"}
 # Default is true
 metrics: true
 >>}
-# Config-section for debug-logging
+# Config-section for debug logging:
 log: {
-  # The file where the debug-log will be written to.
-  # Comment out to disable debug-logging completely.
-  # Java String formatting syntax can be used to add time, see: https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html
-  # Default is no logging
+  # The file where the debug log will be written to.
+  # Comment out to disable debug logging completely.
+  # Java String formatting syntax can be used to add timestamps, see: https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html
+  # Default is no logging.
   file: "${logfile}"
   #file: "${logfile-with-time}"
 
-  # Whether the logger should append to an existing file, or overwrite it
-  # Default is false
+  # Whether the logger should append to an existing file, or overwrite it.
+  # Default is false (overwrite the file).
   append: false
 }