Milliseconds per Tick (#4243)

* Spigot MSPT method

* Implement MSPT for Paper, Sponge & Fabric

* Add average mspt and 95th percentile mspt to TPS object

* Add average and 95th percentile MSPT to database

* Update checkstyle to ignore ClassFanOutComplexity for Patches.java

Previously these were in SQLDB.java, which was also ignored, no longer is.

* Improve gathering accuracy by using direct data rather than aggregating averages

* Fix TPSQueries typo

* Add language for MSPT and a couple of small fixes

* Correct mspt access

- Support raw net.minecraft.server package in reflection
- The field contains nanos instead of millis, format accordingly.

* Add mspt to server graphs

* Add MSPT to performance as numbers, insights and network performance

* Increase all performance graph mspt softmax to 50

* Fix label

* Add mspt 95th percentile to Network performance

* Add functions to update themes with missing use cases and mspt colors to themes

* Remove outdated comment

* Map nanos to millis earlier so that overflows are avoided

* Add MSPT specific performance graph permission

* Fix sponge and fabric MSPT gathering

* Fix spigot MSPT field access

Affects issues:
- Close #2279

Author: AuroraLS3

Plan/bukkit/src/main/java/com/djrapitops/plan/BukkitServerShutdownSave.java

@@ -24,7 +24,6 @@
 import com.djrapitops.plan.utilities.java.Reflection;
 import com.djrapitops.plan.utilities.logging.ErrorLogger;
 import net.playeranalytics.plugin.server.PluginLogger;
-import org.bukkit.Bukkit;
 
 import javax.inject.Inject;
 import javax.inject.Singleton;
@@ -52,7 +51,7 @@ public BukkitServerShutdownSave(
 
     @Override
     protected boolean checkServerShuttingDownStatus() {
-        return isStoppedBefore1p17() || isStoppedV1p17() || isStoppedAfterV1p17();
+        return isStoppedBefore1p17() || isStoppedAfterV1p17();
     }
 
     @Override
@@ -65,37 +64,18 @@ private boolean isStoppedBefore1p17() {
             // Special thanks to Fuzzlemann for figuring out the methods required for this check.
             // https://github.com/plan-player-analytics/Plan/issues/769#issuecomment-433898242
             Class<?> minecraftServerClass = Reflection.getMinecraftClass("MinecraftServer");
-            Object minecraftServer = Reflection.getField(minecraftServerClass, "SERVER", minecraftServerClass).get(null);
-
-            return Reflection.getField(minecraftServerClass, IS_STOPPED, boolean.class).get(minecraftServer);
+            return Reflection.getField(minecraftServerClass, IS_STOPPED, boolean.class).get(Reflection.getMinecraftServer().orElse(null));
         } catch (Exception | NoClassDefFoundError | NoSuchFieldError e) {
             return false;
         }
     }
 
-    private boolean isStoppedV1p17() {
-        try {
-            // Special thanks to Fuzzlemann for figuring out the methods required for this check.
-            // https://github.com/plan-player-analytics/Plan/issues/769#issuecomment-433898242
-            Class<?> minecraftServerClass = Class.forName("net.minecraft.server.MinecraftServer");
-            Class<?> craftServerClass = Reflection.getCraftBukkitClass("CraftServer");
-            Object minecraftServer = Reflection.getField(craftServerClass, "console", minecraftServerClass).get(Bukkit.getServer());
-
-            return (Boolean) minecraftServerClass.getMethod(IS_STOPPED).invoke(minecraftServer);
-        } catch (Exception | NoClassDefFoundError | NoSuchFieldError | NoSuchMethodError e) {
-            return false;
-        }
-    }
-
     private boolean isStoppedAfterV1p17() {
         try {
             // Special thanks to Fuzzlemann for figuring out the methods required for this check.
             // https://github.com/plan-player-analytics/Plan/issues/769#issuecomment-433898242
             Class<?> minecraftServerClass = Reflection.getMinecraftClass("MinecraftServer");
-            Class<?> craftServerClass = Reflection.getCraftBukkitClass("CraftServer");
-            Object minecraftServer = Reflection.getField(craftServerClass, "console", minecraftServerClass).get(Bukkit.getServer());
-
-            return (Boolean) minecraftServerClass.getMethod(IS_STOPPED).invoke(minecraftServer);
+            return (Boolean) minecraftServerClass.getMethod(IS_STOPPED).invoke(Reflection.getMinecraftServer().orElse(null));
         } catch (Exception | NoClassDefFoundError | NoSuchFieldError | NoSuchMethodError e) {
             return false;
         }

Plan/bukkit/src/main/java/com/djrapitops/plan/gathering/BukkitSensor.java

@@ -17,6 +17,7 @@
 package com.djrapitops.plan.gathering;
 
 import com.djrapitops.plan.gathering.domain.PluginMetadata;
+import com.djrapitops.plan.gathering.timed.mspt.SpigotMspt;
 import org.bukkit.Bukkit;
 import org.bukkit.OfflinePlayer;
 import org.bukkit.Server;
@@ -28,6 +29,7 @@
 import javax.inject.Singleton;
 import java.util.Arrays;
 import java.util.List;
+import java.util.Optional;
 import java.util.UUID;
 import java.util.stream.Collectors;
 
@@ -155,4 +157,8 @@ public boolean isBanned(UUID playerUUID) {
         return player.isBanned();
     }
 
+    @Override
+    public Optional<long[]> getMspt() {
+        return SpigotMspt.getMspt();
+    }
 }

Plan/bukkit/src/main/java/com/djrapitops/plan/gathering/timed/mspt/SpigotMspt.java

@@ -0,0 +1,44 @@
+/*
+ *  This file is part of Player Analytics (Plan).
+ *
+ *  Plan is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU Lesser General Public License v3 as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  Plan is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU Lesser General Public License for more details.
+ *
+ *  You should have received a copy of the GNU Lesser General Public License
+ *  along with Plan. If not, see <https://www.gnu.org/licenses/>.
+ */
+package com.djrapitops.plan.gathering.timed.mspt;
+
+import com.djrapitops.plan.utilities.java.Reflection;
+
+import java.util.Optional;
+
+/**
+ * Accessor for the average MSPT field in MinecraftServer class which is a long[] array with 100 values.
+ *
+ * @author AuroraLS3
+ */
+public class SpigotMspt {
+
+    public static Optional<long[]> getMspt() {
+        return Optional.ofNullable(getValue());
+    }
+
+    private static long[] getValue() {
+        try {
+            Class<?> minecraftServerClass = Reflection.getMinecraftClass("MinecraftServer");
+            Reflection.FieldAccessor<long[]> field = Reflection.findField(minecraftServerClass, long[].class);
+            return field.get(Reflection.getMinecraftServer().orElse(null));
+        } catch (Exception | NoClassDefFoundError | NoSuchFieldError e) {
+            return null;
+        }
+    }
+
+}

Plan/bukkit/src/main/java/com/djrapitops/plan/utilities/java/Reflection.java

@@ -27,6 +27,7 @@
 import org.bukkit.Server;
 
 import java.lang.reflect.Field;
+import java.util.Optional;
 
 /**
  * An utility class that simplifies reflection in Bukkit plugins.
@@ -46,6 +47,35 @@ private Reflection() {
         // Seal class
     }
 
+    public static Optional<Object> getMinecraftServer() {
+        Optional<Object> minecraftServerBeforeV1p17 = getMinecraftServerBeforeV1p17();
+        if (minecraftServerBeforeV1p17.isPresent()) {return minecraftServerBeforeV1p17;}
+        return getMinecraftServerAfterV1p17();
+    }
+
+    private static Optional<Object> getMinecraftServerBeforeV1p17() {
+        try {
+            Class<?> minecraftServerClass = Reflection.getMinecraftClass("MinecraftServer");
+            Object minecraftServer = Reflection.getField(minecraftServerClass, "SERVER", minecraftServerClass).get(null);
+
+            return Optional.ofNullable(minecraftServer);
+        } catch (Exception | NoClassDefFoundError | NoSuchFieldError e) {
+            return Optional.empty();
+        }
+    }
+
+    private static Optional<Object> getMinecraftServerAfterV1p17() {
+        try {
+            Class<?> minecraftServerClass = Reflection.getMinecraftClass("MinecraftServer");
+            Class<?> craftServerClass = Reflection.getCraftBukkitClass("CraftServer");
+            Object minecraftServer = Reflection.getField(craftServerClass, "console", minecraftServerClass).get(Bukkit.getServer());
+
+            return Optional.ofNullable(minecraftServer);
+        } catch (Exception | NoClassDefFoundError | NoSuchFieldError e) {
+            return Optional.empty();
+        }
+    }
+
     private static String getOBCPrefix() {
         Server server = Bukkit.getServer();
         return server != null ? server.getClass().getPackage().getName() : Server.class.getPackage().getName();
@@ -109,6 +139,46 @@ public boolean hasField(Object target) {
         throw new IllegalArgumentException("Cannot find field with type " + fieldType);
     }
 
+    public static <T> FieldAccessor<T> findField(Class<?> target, Class<T> fieldType) {
+        for (final Field field : target.getDeclaredFields()) {
+            if (fieldType.isAssignableFrom(field.getType())) {
+
+                return new FieldAccessor<>() {
+
+                    @Override
+                    @SuppressWarnings("unchecked")
+                    public T get(Object target) {
+                        try {
+                            if (!field.canAccess(target)) {
+                                field.setAccessible(true);
+                            }
+                            return (T) field.get(target);
+                        } catch (IllegalAccessException e) {
+                            throw new IllegalStateException("Cannot access reflection.", e);
+                        }
+                    }
+
+                    @Override
+                    public void set(Object target, Object value) {
+                        try {
+                            field.set(target, value);
+                        } catch (IllegalAccessException e) {
+                            throw new IllegalStateException("Cannot access reflection.", e);
+                        }
+                    }
+
+                    @Override
+                    public boolean hasField(Object target) {
+                        // target instanceof DeclaringClass
+                        return field.getDeclaringClass().isAssignableFrom(target.getClass());
+                    }
+                };
+            }
+        }
+
+        throw new IllegalArgumentException("Cannot find field with type " + fieldType);
+    }
+
     /**
      * Retrieve a class in the net.minecraft.server.VERSION.* package.
      *
@@ -117,7 +187,16 @@ public boolean hasField(Object target) {
      * @throws IllegalArgumentException If the class doesn't exist.
      */
     public static Class<?> getMinecraftClass(String name) {
-        return getCanonicalClass(NMS_PREFIX + '.' + name);
+        try {
+            return getCanonicalClass(NMS_PREFIX + '.' + name);
+        } catch (IllegalArgumentException suppressed) {
+            try {
+                return getCanonicalClass("net.minecraft.server." + name);
+            } catch (IllegalArgumentException e) {
+                e.addSuppressed(suppressed);
+                throw e;
+            }
+        }
     }
 
     /**

Plan/common/src/main/java/com/djrapitops/plan/delivery/domain/auth/WebPermission.java

@@ -103,6 +103,7 @@ public enum WebPermission implements Supplier<String>, Lang {
     PAGE_SERVER_PERFORMANCE_GRAPHS_CHUNKS("See Chunk count data in Performance graphs"),
     PAGE_SERVER_PERFORMANCE_GRAPHS_DISK("See Disk Space usage Performance graphs"),
     PAGE_SERVER_PERFORMANCE_GRAPHS_PING("See Ping data in Performance graphs"),
+    PAGE_SERVER_PERFORMANCE_GRAPHS_MSPT("See MSPT data in Performance graphs"),
     PAGE_SERVER_PERFORMANCE_OVERVIEW("See Performance numbers"),
     PAGE_SERVER_PLUGIN_HISTORY("See Plugin History"),
     PAGE_SERVER_PLUGINS("See Plugins -tabs of servers"),

Plan/common/src/main/java/com/djrapitops/plan/delivery/domain/mutators/TPSMutator.java

@@ -19,6 +19,7 @@
 import com.djrapitops.plan.delivery.rendering.json.graphs.line.LineGraph;
 import com.djrapitops.plan.delivery.rendering.json.graphs.line.Point;
 import com.djrapitops.plan.gathering.domain.TPS;
+import com.djrapitops.plan.utilities.analysis.Average;
 import com.djrapitops.plan.utilities.comparators.TPSComparator;
 import com.djrapitops.plan.utilities.java.Lists;
 
@@ -300,4 +301,12 @@ private void addMissingPoints(List<Number[]> arrays, Long lastX, long date, Line
             iterate += gapStrategy.fillFrequencyMs;
         }
     }
+
+    public double averageMspt() {
+        Average average = new Average();
+        for (TPS tps : tpsData) {
+            average.addNonNull(tps.getMsptAverage());
+        }
+        return average.getAverageAndReset();
+    }
 }

Plan/common/src/main/java/com/djrapitops/plan/delivery/rendering/json/PerformanceJSONCreator.java

@@ -128,6 +128,10 @@ private Map<String, Object> createNumbersMap(List<TPS> tpsData) {
         numbers.put("min_disk_7d", formatBytes(tpsDataWeek.minFreeDisk()));
         numbers.put("min_disk_24h", formatBytes(tpsDataDay.minFreeDisk()));
 
+        numbers.put("mspt_average_30d", format(tpsDataMonth.averageMspt()));
+        numbers.put("mspt_average_7d", format(tpsDataWeek.averageMspt()));
+        numbers.put("mspt_average_24h", format(tpsDataDay.averageMspt()));
+
         return numbers;
     }
 
@@ -155,11 +159,13 @@ private Map<String, Object> createInsightsMap(List<TPS> tpsData) {
         double averageCPU = lowTPS.averageCPU();
         double averageEntities = lowTPS.averageEntities();
         double averageChunks = lowTPS.averageChunks();
+        double averageMspt = lowTPS.averageMspt();
         insights.put("low_tps_players", avgPlayersOnline != -1 ? decimals.apply(avgPlayersOnline) : HtmlLang.TEXT_NO_LOW_TPS.getKey());
         insights.put("low_tps_tps", averageTPS != -1 ? decimals.apply(averageTPS) : "-");
         insights.put("low_tps_cpu", averageCPU != -1 ? decimals.apply(averageCPU) : "-");
         insights.put("low_tps_entities", averageEntities != -1 ? decimals.apply(averageEntities) : "-");
         insights.put("low_tps_chunks", averageChunks != -1 ? decimals.apply(averageChunks) : "-");
+        insights.put("low_tps_mspt", averageMspt > 0 ? decimals.apply(averageMspt) : "-");
 
         return insights;
     }

Plan/common/src/main/java/com/djrapitops/plan/delivery/rendering/json/graphs/GraphJSONCreator.java

@@ -162,7 +162,7 @@ public Map<String, Object> optimizedPerformanceGraphJSON(ServerUUID serverUUID)
         )));
 
         return Maps.builder(String.class, Object.class)
-                .put("keys", new String[]{"date", "playersOnline", "tps", "cpu", "ram", "entities", "chunks", "disk"})
+                .put("keys", new String[]{"date", "playersOnline", "tps", "cpu", "ram", "entities", "chunks", "disk", "msptAverage", "mspt95thPercentile"})
                 .put("values", values)
                 .put("colors", Maps.builder(String.class, Object.class)
                         .put("playersOnline", ThemeVal.GRAPH_PLAYERS_ONLINE.getDefaultValue())

Plan/common/src/main/java/com/djrapitops/plan/delivery/webserver/ResponseFactory.java

@@ -558,6 +558,7 @@ public Response themeResponse(@Untrusted String themeName, Request request) {
             String resourceName = themeName + ".json";
             WebResource foundTheme = files.attemptToFind(themeDirectory, resourceName)
                     .map(file -> (Resource) new FileResource(file.getName(), file))
+                    .filter(file -> request.getQuery().get("jarOnly").isEmpty())
                     .orElseGet(() -> files.getResourceFromJar("themes/" + themeName + ".json"))
                     .asWebResource();
 

Plan/common/src/main/java/com/djrapitops/plan/delivery/webserver/resolver/json/NetworkPerformanceJSONResolver.java

@@ -66,7 +66,6 @@ public class NetworkPerformanceJSONResolver implements Resolver {
     private final DBSystem dbSystem;
 
     private final Formatter<Double> decimals;
-    private final Formatter<Long> timeAmount;
     private final Formatter<Double> percentage;
     private final Formatter<Double> byteSize;
     private final Gson gson;
@@ -83,7 +82,6 @@ public NetworkPerformanceJSONResolver(
 
         decimals = formatters.decimals();
         percentage = formatters.percentage();
-        timeAmount = formatters.timeAmount();
         byteSize = formatters.byteSize();
         this.gson = gson;
     }
@@ -213,6 +211,9 @@ private Map<String, Object> createNumbersMap(Map<Integer, List<TPS>> tpsData) {
         numbers.put("chunks_30d", format((int) tpsDataMonth.averageChunks()));
         numbers.put("chunks_7d", format((int) tpsDataWeek.averageChunks()));
         numbers.put("chunks_24h", format((int) tpsDataDay.averageChunks()));
+        numbers.put("mspt_average_30d", format(tpsDataMonth.averageMspt()));
+        numbers.put("mspt_average_7d", format(tpsDataWeek.averageMspt()));
+        numbers.put("mspt_average_24h", format(tpsDataDay.averageMspt()));
 
         return numbers;
     }