Add a cooldown for updating the same region multiple times in a row, closes #698

Author: TBlueF

common/src/main/java/de/bluecolored/bluemap/common/config/CoreConfig.java

@@ -24,12 +24,14 @@
  */
 package de.bluecolored.bluemap.common.config;
 
+import lombok.Getter;
 import org.spongepowered.configurate.objectmapping.ConfigSerializable;
 
 import java.nio.file.Path;
 
 @SuppressWarnings({"FieldMayBeFinal", "FieldCanBeLocal"})
 @ConfigSerializable
+@Getter
 public class CoreConfig {
 
     private boolean acceptDownload = false;
@@ -39,54 +41,22 @@ public class CoreConfig {
     private boolean metrics = true;
 
     private Path data = Path.of("bluemap");
-
     private boolean scanForModResources = true;
 
     private LogConfig log = new LogConfig();
 
-    public boolean isAcceptDownload() {
-        return acceptDownload;
-    }
-
-    public int getRenderThreadCount() {
-        return renderThreadCount;
-    }
-
     public int resolveRenderThreadCount() {
         if (renderThreadCount > 0) return renderThreadCount;
         return Math.max(Runtime.getRuntime().availableProcessors() + renderThreadCount, 1);
     }
 
-    public boolean isMetrics() {
-        return metrics;
-    }
-
-    public Path getData() {
-        return data;
-    }
-
-    public boolean isScanForModResources() {
-        return scanForModResources;
-    }
-
-    public LogConfig getLog() {
-        return log;
-    }
-
     @ConfigSerializable
+    @Getter
     public static class LogConfig {
 
         private String file = null;
         private boolean append = false;
 
-        public String getFile() {
-            return file;
-        }
-
-        public boolean isAppend() {
-            return append;
-        }
-
     }
 
 }

common/src/main/java/de/bluecolored/bluemap/common/config/PluginConfig.java

@@ -24,13 +24,16 @@
  */
 package de.bluecolored.bluemap.common.config;
 
+import lombok.Getter;
 import org.spongepowered.configurate.objectmapping.ConfigSerializable;
 
+import java.time.Duration;
 import java.util.ArrayList;
 import java.util.List;
 
 @SuppressWarnings({"FieldMayBeFinal", "FieldCanBeLocal"})
 @ConfigSerializable
+@Getter
 public class PluginConfig {
 
     private boolean livePlayerMarkers = true;
@@ -50,58 +53,15 @@ public class PluginConfig {
 
     private int playerRenderLimit = -1;
 
+    private int updateCooldown = 60;
     private int fullUpdateInterval = 1440;
 
-    public boolean isLivePlayerMarkers() {
-        return livePlayerMarkers;
+    public Duration getUpdateCooldown() {
+        return Duration.ofSeconds(updateCooldown);
     }
 
-    public List<String> getHiddenGameModes() {
-        return hiddenGameModes;
-    }
-
-    public boolean isHideVanished() {
-        return hideVanished;
-    }
-
-    public boolean isHideInvisible() {
-        return hideInvisible;
-    }
-
-    public boolean isHideSneaking() {
-        return hideSneaking;
-    }
-
-    public boolean isHideDifferentWorld() {
-        return hideDifferentWorld;
-    }
-
-    public int getHideBelowSkyLight() {
-        return hideBelowSkyLight;
-    }
-
-    public int getHideBelowBlockLight() {
-        return hideBelowBlockLight;
-    }
-
-    public int getWriteMarkersInterval() {
-        return writeMarkersInterval;
-    }
-
-    public int getWritePlayersInterval() {
-        return writePlayersInterval;
-    }
-
-    public boolean isSkinDownload() {
-        return skinDownload;
-    }
-
-    public int getPlayerRenderLimit() {
-        return playerRenderLimit;
-    }
-
-    public int getFullUpdateInterval() {
-        return fullUpdateInterval;
+    public Duration getFullUpdateInterval() {
+        return Duration.ofMinutes(fullUpdateInterval);
     }
 
 }

common/src/main/java/de/bluecolored/bluemap/common/config/WebappConfig.java

@@ -24,6 +24,7 @@
  */
 package de.bluecolored.bluemap.common.config;
 
+import lombok.Getter;
 import org.spongepowered.configurate.objectmapping.ConfigSerializable;
 
 import java.nio.file.Path;
@@ -33,6 +34,7 @@
 
 @SuppressWarnings({"FieldMayBeFinal", "FieldCanBeLocal"})
 @ConfigSerializable
+@Getter
 public class WebappConfig {
 
     private boolean enabled = true;
@@ -65,80 +67,8 @@ public class WebappConfig {
     private Set<String> scripts = new HashSet<>();
     private Set<String> styles = new HashSet<>();
 
-    public boolean isEnabled() {
-        return enabled;
-    }
-
-    public Path getWebroot() {
-        return webroot;
-    }
-
-    public boolean isUpdateSettingsFile() {
-        return updateSettingsFile;
-    }
-
-    public boolean isUseCookies() {
-        return useCookies;
-    }
-
-    public boolean isDefaultToFlatView() {
-        return defaultToFlatView;
-    }
-
     public Optional<String> getStartLocation() {
         return Optional.ofNullable(startLocation);
     }
 
-    public float getResolutionDefault() {
-        return resolutionDefault;
-    }
-
-    public int getMinZoomDistance() {
-        return minZoomDistance;
-    }
-
-    public int getMaxZoomDistance() {
-        return maxZoomDistance;
-    }
-
-    public int getHiresSliderMax() {
-        return hiresSliderMax;
-    }
-
-    public int getHiresSliderDefault() {
-        return hiresSliderDefault;
-    }
-
-    public int getHiresSliderMin() {
-        return hiresSliderMin;
-    }
-
-    public int getLowresSliderMax() {
-        return lowresSliderMax;
-    }
-
-    public int getLowresSliderDefault() {
-        return lowresSliderDefault;
-    }
-
-    public int getLowresSliderMin() {
-        return lowresSliderMin;
-    }
-
-    public String getMapDataRoot() {
-        return mapDataRoot;
-    }
-
-    public String getLiveDataRoot() {
-        return liveDataRoot;
-    }
-
-    public Set<String> getScripts() {
-        return scripts;
-    }
-
-    public Set<String> getStyles() {
-        return styles;
-    }
-
 }

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

@@ -25,13 +25,16 @@
 package de.bluecolored.bluemap.common.plugin;
 
 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.WatchService;
 
 import java.io.IOException;
+import java.time.Duration;
 import java.util.HashMap;
 import java.util.Map;
 import java.util.Timer;
@@ -41,19 +44,25 @@ public class MapUpdateService extends Thread {
 
     private final BmMap map;
     private final RenderManager renderManager;
+    private final Duration regionUpdateCooldown;
     private final WatchService<Vector2i> watchService;
 
     private volatile boolean closed;
 
     private Timer delayTimer;
 
     private final Map<Vector2i, TimerTask> scheduledUpdates;
+    private final Cache<Vector2i, Long> lastUpdateTimes;
 
-    public MapUpdateService(RenderManager renderManager, BmMap map) throws IOException {
+    public MapUpdateService(RenderManager renderManager, BmMap map, Duration regionUpdateCooldown) throws IOException {
         this.renderManager = renderManager;
         this.map = map;
+        this.regionUpdateCooldown = regionUpdateCooldown;
         this.closed = false;
         this.scheduledUpdates = new HashMap<>();
+        this.lastUpdateTimes = Caffeine.newBuilder()
+                .expireAfterWrite(regionUpdateCooldown)
+                .build();
         this.watchService = map.getWorld().createRegionWatchService();
     }
 
@@ -83,7 +92,7 @@ public void run() {
     private synchronized void updateRegion(Vector2i regionPos) {
         if (closed) return;
 
-        // we only want to start the render when there were no changes on a file for 5 seconds
+        // we only want to start the render when there were no changes on a file for at least 5 seconds
         TimerTask task = scheduledUpdates.remove(regionPos);
         if (task != null) task.cancel();
 
@@ -94,13 +103,19 @@ public void run() {
                     WorldRegionRenderTask task = new WorldRegionRenderTask(map, regionPos);
                     scheduledUpdates.remove(regionPos);
                     renderManager.scheduleRenderTask(task);
+                    lastUpdateTimes.put(regionPos, System.currentTimeMillis());
 
                     Logger.global.logDebug("Scheduled update for region-file: " + regionPos + " (Map: " + map.getId() + ")");
                 }
             }
         };
+
+        Long lastUpdateTime = lastUpdateTimes.getIfPresent(regionPos);
+        if (lastUpdateTime == null) lastUpdateTime = 0L;
+        long timeSinceLastUpdate = System.currentTimeMillis() - lastUpdateTime;
+        long delay = Math.max(regionUpdateCooldown.toMillis() - timeSinceLastUpdate, 5000);
         scheduledUpdates.put(regionPos, task);
-        delayTimer.schedule(task, 5000);
+        delayTimer.schedule(task, delay);
     }
 
     public synchronized void close() {

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

@@ -67,6 +67,7 @@
 import java.net.UnknownHostException;
 import java.nio.file.Files;
 import java.nio.file.Path;
+import java.time.Duration;
 import java.time.Instant;
 import java.time.ZoneId;
 import java.time.ZonedDateTime;
@@ -328,8 +329,8 @@ public void run() {
                 daemonTimer.schedule(fileWatcherRestartTask, TimeUnit.HOURS.toMillis(1), TimeUnit.HOURS.toMillis(1));
 
                 //periodically update all (non frozen) maps
-                if (pluginConfig.getFullUpdateInterval() > 0) {
-                    long fullUpdateTime = TimeUnit.MINUTES.toMillis(pluginConfig.getFullUpdateInterval());
+                long fullUpdateInterval = pluginConfig.getFullUpdateInterval().toMillis();
+                if (fullUpdateInterval > 0) {
                     TimerTask updateAllMapsTask = new TimerTask() {
                         @Override
                         public void run() {
@@ -340,7 +341,7 @@ public void run() {
                                     .toArray(RenderTask[]::new));
                         }
                     };
-                    daemonTimer.scheduleAtFixedRate(updateAllMapsTask, 0, fullUpdateTime);
+                    daemonTimer.scheduleAtFixedRate(updateAllMapsTask, 0, fullUpdateInterval);
                 }
 
                 //metrics
@@ -565,8 +566,10 @@ public void savePlayerStates() {
     public synchronized void startWatchingMap(BmMap map) {
         stopWatchingMap(map);
 
+        if (blueMap == null) return;
+
         try {
-            MapUpdateService watcher = new MapUpdateService(renderManager, map);
+            MapUpdateService watcher = new MapUpdateService(renderManager, map, blueMap.getConfig().getPluginConfig().getUpdateCooldown());
             watcher.start();
             mapUpdateServices.put(map.getId(), watcher);
         } catch (IOException ex) {

implementations/cli/src/main/java/de/bluecolored/bluemap/cli/BlueMapCLI.java

@@ -103,7 +103,7 @@ public void renderMaps(BlueMapService blueMap, boolean watch, TileUpdateStrategy
         if (watch) {
             for (BmMap map : maps.values()) {
                 try {
-                    MapUpdateService watcher = new MapUpdateService(renderManager, map);
+                    MapUpdateService watcher = new MapUpdateService(renderManager, map, blueMap.getConfig().getPluginConfig().getUpdateCooldown());
                     watcher.start();
                     mapUpdateServices.add(watcher);
                 } catch (IOException ex) {