Add AVERAGE_TPS datapoint

AuroraLS3 · AuroraLS3 · commit b03864b2c4ff · 2026-04-19T20:56:00.000+03:00
diff --git a/Plan/common/src/main/java/com/djrapitops/plan/delivery/domain/auth/WebPermission.java b/Plan/common/src/main/java/com/djrapitops/plan/delivery/domain/auth/WebPermission.java
@@ -171,6 +171,7 @@ public enum WebPermission implements Supplier<String>, Lang {
     DATA_PLAYER_DEATHS("See Deaths datapoint of players"),
     DATA_SERVER_DEATHS("See Deaths datapoint of servers"),
     DATA_NETWORK_DEATHS("See Deaths datapoint of network"),
+    DATA_SERVER_AVERAGE_TPS("See Average TPS datapoint of servers"),
 
     ACCESS("Controls access to pages"),
     ACCESS_PLAYER("Allows accessing any /player pages"),
diff --git a/Plan/common/src/main/java/com/djrapitops/plan/delivery/rendering/json/datapoint/Datapoint.java b/Plan/common/src/main/java/com/djrapitops/plan/delivery/rendering/json/datapoint/Datapoint.java
@@ -43,6 +43,6 @@ enum FormatType {
         PERCENTAGE,
         BYTES,
         SPECIAL,
-        NONE
+        DECIMAL, NONE
     }
 }
diff --git a/Plan/common/src/main/java/com/djrapitops/plan/delivery/rendering/json/datapoint/DatapointType.java b/Plan/common/src/main/java/com/djrapitops/plan/delivery/rendering/json/datapoint/DatapointType.java
@@ -48,7 +48,8 @@ public enum DatapointType {
     CURRENT_UPTIME(CurrentUptime.class),
     MOB_KILLS(MobKills.class, DatapointCacheKey.SESSION),
     PLAYER_KILLS(PlayerKills.class, DatapointCacheKey.SESSION),
-    DEATHS(Deaths.class, DatapointCacheKey.SESSION);
+    DEATHS(Deaths.class, DatapointCacheKey.SESSION),
+    AVERAGE_TPS(AverageTPS.class, DatapointCacheKey.TPS);
 
     private final Class<? extends Datapoint<?>> datapointClass;
     private final DatapointCacheKey[] cacheKeys;
diff --git a/Plan/common/src/main/java/com/djrapitops/plan/delivery/rendering/json/datapoint/types/AverageTPS.java b/Plan/common/src/main/java/com/djrapitops/plan/delivery/rendering/json/datapoint/types/AverageTPS.java
@@ -0,0 +1,80 @@
+/*
+ *  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.delivery.rendering.json.datapoint.types;
+
+import com.djrapitops.plan.delivery.domain.auth.WebPermission;
+import com.djrapitops.plan.delivery.domain.datatransfer.GenericFilter;
+import com.djrapitops.plan.delivery.rendering.json.datapoint.Datapoint;
+import com.djrapitops.plan.delivery.rendering.json.datapoint.DatapointType;
+import com.djrapitops.plan.delivery.web.resolver.exception.BadRequestException;
+import com.djrapitops.plan.storage.database.DBSystem;
+import com.djrapitops.plan.storage.database.queries.objects.TPSQueries;
+
+import javax.inject.Inject;
+import javax.inject.Singleton;
+import java.util.Optional;
+
+/**
+ * Datapoint for looking up Average TPS within the timeframe.
+ *
+ * @author AuroraLS3
+ */
+@Singleton
+public class AverageTPS implements Datapoint<Double> {
+
+    private final DBSystem dbSystem;
+
+    @Inject
+    public AverageTPS(DBSystem dbSystem) {
+        this.dbSystem = dbSystem;
+    }
+
+    @Override
+    public Optional<Double> getValue(GenericFilter filter) {
+        if (filter.getPlayerUUID().isPresent()) {
+            throw new BadRequestException("AVERAGE_TPS does not support player parameter");
+        }
+
+        if (filter.getServerUUIDs().isEmpty()) {
+            throw new BadRequestException("AVERAGE_TPS is only available for servers");
+        }
+
+        double average = dbSystem.getDatabase().query(TPSQueries.averageTPS(filter.getAfter(), filter.getBefore(), filter.getServerUUIDs()));
+        return average != -1.0 ? Optional.of(average) : Optional.empty();
+    }
+
+    @Override
+    public WebPermission getPermission(GenericFilter filter) {
+        if (filter.getPlayerUUID().isPresent()) {
+            return WebPermission.DATA_PLAYER;
+        } else if (!filter.getServerUUIDs().isEmpty()) {
+            return WebPermission.DATA_SERVER_AVERAGE_TPS;
+        } else {
+            return WebPermission.DATA_NETWORK;
+        }
+    }
+
+    @Override
+    public DatapointType getType() {
+        return DatapointType.AVERAGE_TPS;
+    }
+
+    @Override
+    public FormatType getFormatType() {
+        return FormatType.DECIMAL;
+    }
+}
diff --git a/Plan/common/src/main/java/com/djrapitops/plan/delivery/rendering/json/datapoint/types/DatapointModule.java b/Plan/common/src/main/java/com/djrapitops/plan/delivery/rendering/json/datapoint/types/DatapointModule.java
@@ -107,4 +107,8 @@ public interface DatapointModule {
     @Binds
     @IntoSet
     Datapoint<?> bindPlayerKills(PlayerKills playerKills);
+
+    @Binds
+    @IntoSet
+    Datapoint<?> bindAverageTPS(AverageTPS averageTPS);
 }
diff --git a/Plan/common/src/main/java/com/djrapitops/plan/storage/database/queries/objects/TPSQueries.java b/Plan/common/src/main/java/com/djrapitops/plan/storage/database/queries/objects/TPSQueries.java
@@ -425,18 +425,25 @@ public Optional<TPS> processResults(ResultSet set) throws SQLException {
     }
 
     public static Query<Double> averageTPS(long after, long before, ServerUUID serverUUID) {
+        return averageTPS(after, before, Collections.singletonList(serverUUID));
+    }
+
+    public static Query<Double> averageTPS(long after, long before, List<ServerUUID> serverUUIDs) {
+        if (serverUUIDs.isEmpty()) {
+            return db -> -1.0;
+        }
+
         String sql = SELECT + "AVG(" + TPS + ") as average" + FROM + TABLE_NAME + " t" +
                 INNER_JOIN + ServerTable.TABLE_NAME + " s ON s." + ServerTable.ID + "=t." + SERVER_ID +
-                WHERE + "s." + ServerTable.SERVER_UUID + "=?" +
+                WHERE + "s." + ServerTable.SERVER_UUID + " IN (" + ServerTable.uuids(serverUUIDs) + ")" +
                 AND + TPS + ">=0" +
                 AND + DATE + "<?" +
                 AND + DATE + ">?";
         return new QueryStatement<>(sql) {
             @Override
             public void prepare(PreparedStatement statement) throws SQLException {
-                statement.setString(1, serverUUID.toString());
-                statement.setLong(2, before);
-                statement.setLong(3, after);
+                statement.setLong(1, before);
+                statement.setLong(2, after);
             }
 
             @Override
diff --git a/Plan/common/src/test/java/com/djrapitops/plan/delivery/webserver/AccessControlTest.java b/Plan/common/src/test/java/com/djrapitops/plan/delivery/webserver/AccessControlTest.java
@@ -236,7 +236,10 @@ static Stream<Arguments> testCases() {
                 Arguments.of("/v1/datapoint?type=PLAYER_KILLS&player=" + TestConstants.PLAYER_ONE_UUID_STRING, WebPermission.DATA_PLAYER_PLAYER_KILLS, 200, 403),
                 Arguments.of("/v1/datapoint?type=MOB_KILLS", WebPermission.DATA_NETWORK_MOB_KILLS, 200, 403),
                 Arguments.of("/v1/datapoint?type=MOB_KILLS&server=" + TestConstants.SERVER_UUID_STRING, WebPermission.DATA_SERVER_MOB_KILLS, 200, 403),
-                Arguments.of("/v1/datapoint?type=MOB_KILLS&player=" + TestConstants.PLAYER_ONE_UUID_STRING, WebPermission.DATA_PLAYER_MOB_KILLS, 200, 403)
+                Arguments.of("/v1/datapoint?type=MOB_KILLS&player=" + TestConstants.PLAYER_ONE_UUID_STRING, WebPermission.DATA_PLAYER_MOB_KILLS, 200, 403),
+                Arguments.of("/v1/datapoint?type=AVERAGE_TPS", WebPermission.DATA_SERVER_AVERAGE_TPS, 400, 403),
+                Arguments.of("/v1/datapoint?type=AVERAGE_TPS&server=" + TestConstants.SERVER_UUID_STRING, WebPermission.DATA_SERVER_AVERAGE_TPS, 200, 403),
+                Arguments.of("/v1/datapoint?type=AVERAGE_TPS&player=" + TestConstants.PLAYER_ONE_UUID_STRING, WebPermission.DATA_SERVER_AVERAGE_TPS, 400, 403)
         );
     }
 
diff --git a/Plan/react/dashboard/src/dataHooks/model/datapoint/Datapoint.ts b/Plan/react/dashboard/src/dataHooks/model/datapoint/Datapoint.ts
@@ -6,7 +6,15 @@ import {baseAddress, staticSite} from "../../../service/backendConfiguration";
 import {filterToQueryString, GenericFilter} from "../GenericFilter";
 import {MS_24H, MS_WEEK} from "../../../util/format/useDateFormatter";
 
-export type FormatType = 'NONE' | 'TIME_AMOUNT' | 'TIME_SINCE' | 'DATE' | 'PERCENTAGE' | 'BYTES' | 'SPECIAL';
+export type FormatType =
+    'NONE'
+    | 'TIME_AMOUNT'
+    | 'TIME_SINCE'
+    | 'DATE'
+    | 'DECIMAL'
+    | 'PERCENTAGE'
+    | 'BYTES'
+    | 'SPECIAL';
 
 export enum DatapointType {
     WORLD_PIE = 'WORLD_PIE',
@@ -29,6 +37,7 @@ export enum DatapointType {
     DEATHS = "DEATHS",
     PLAYER_KILLS = "PLAYER_KILLS",
     MOB_KILLS = "MOB_KILLS",
+    AVERAGE_TPS = "AVERAGE_TPS",
 }
 
 export type DatapointTypeMap = {
@@ -47,6 +56,7 @@ export type DatapointTypeMap = {
     DEATHS: number;
     PLAYER_KILLS: number;
     MOB_KILLS: number;
+    AVERAGE_TPS: number;
     SERVER_OCCUPIED: OutOf;
     MOST_ACTIVE_WORLD: OutOfCategory;
     MOST_ACTIVE_GAME_MODE: OutOfCategory;
diff --git a/Plan/react/dashboard/src/views/server/ServerOverview.jsx b/Plan/react/dashboard/src/views/server/ServerOverview.jsx
@@ -25,14 +25,20 @@ import ExtendableRow from "../../components/layout/extension/ExtendableRow";
 import {useAuth} from "../../hooks/authenticationHook.tsx";
 import {FontAwesomeIcon} from "@fortawesome/react-fontawesome";
 import FormattedTime from "../../components/text/FormattedTime.jsx";
+import {QueryDatapoint, useDatapointQuery} from "../../components/datapoint/QueryDatapoint.tsx";
+import {DatapointType} from "../../dataHooks/model/datapoint/Datapoint.ts";
+import {MS_WEEK} from "../../util/format/useDateFormatter.js";
+import {GenericFilterContextProvider} from "../../dataHooks/genericFilterContextHook.tsx";
 
 const Last7DaysCard = ({data}) => {
     const {t} = useTranslation();
+    const {identifier} = useParams();
 
-    if (!data) return <CardLoader/>;
 
-    const noData = data.average_tps === 'plugin.generic.unavailable'
+    const {error} = useDatapointQuery(true, DatapointType.AVERAGE_TPS, {server: identifier, afterMillisAgo: MS_WEEK})
+    const noData = error?.status === 404
 
+    if (!data) return <CardLoader/>;
     return (
         <Card id={"last-7-days"}>
             <Card.Header>
@@ -43,31 +49,38 @@ const Last7DaysCard = ({data}) => {
             {noData && <Alert className='alert-warning mb-0'>
                 <FontAwesomeIcon icon={faInfoCircle}/> {t('html.description.noData7d')}
             </Alert>}
-            <Card.Body>
-                <Datapoint name={t('html.label.uniquePlayers')}
-                           color={'players-unique'} icon={faUsers}
-                           value={data.unique_players} bold/>
-                <Datapoint name={t('html.label.uniquePlayers') + ' ' + t('html.label.perDay')}
-                           color={'players-unique'} icon={faUser}
-                           value={data.unique_players_day} bold/>
-                <Datapoint name={t('html.label.newPlayers')}
-                           color={'players-new'} icon={faUsers}
-                           value={data.new_players} bold/>
-                <Datapoint name={t('html.label.newPlayerRetention')}
-                           color={'players-new'} icon={faUserCircle}
-                           value={data.new_players_retention_perc}
-                           valueLabel={data.new_players_retention + '/' + data.new_players} bold/>
-                <hr/>
-                <Datapoint name={t('html.label.averageTps')}
-                           color={'tps-average'} icon={faTachometerAlt}
-                           value={data.average_tps} bold/>
-                <Datapoint name={t('html.label.lowTpsSpikes')}
-                           color={'tps-low-spikes'} icon={faExclamationCircle}
-                           value={data.low_tps_spikes} bold/>
-                <Datapoint name={t('html.label.downtime')}
-                           color={'downtime'} icon={faPowerOff}
-                           value={<FormattedTime timeMs={data.downtime}/>}/>
-            </Card.Body>
+            <GenericFilterContextProvider initialValue={{server: identifier, afterMillisAgo: MS_WEEK}}>
+                {filter => (
+                    <Card.Body>
+                        <QueryDatapoint name={t('html.label.uniquePlayers')}
+                                        color={'players-unique'} icon={faUsers}
+                                        dataType={DatapointType.UNIQUE_PLAYERS}
+                                        filter={filter} bold/>
+                        <Datapoint name={t('html.label.uniquePlayers') + ' ' + t('html.label.perDay')}
+                                   color={'players-unique'} icon={faUser}
+                                   value={data.unique_players_day} bold/>
+                        <QueryDatapoint name={t('html.label.newPlayers')}
+                                        color={'players-new'} icon={faUsers}
+                                        dataType={DatapointType.NEW_PLAYERS}
+                                        filter={filter} bold/>
+                        <Datapoint name={t('html.label.newPlayerRetention')}
+                                   color={'players-new'} icon={faUserCircle}
+                                   value={data.new_players_retention_perc}
+                                   valueLabel={data.new_players_retention + '/' + data.new_players} bold/>
+                        <hr/>
+                        <QueryDatapoint name={t('html.label.averageTps')}
+                                        color={'tps-average'} icon={faTachometerAlt}
+                                        dataType={DatapointType.AVERAGE_TPS}
+                                        filter={filter} bold/>
+                        <Datapoint name={t('html.label.lowTpsSpikes')}
+                                   color={'tps-low-spikes'} icon={faExclamationCircle}
+                                   value={data.low_tps_spikes} bold/>
+                        <Datapoint name={t('html.label.downtime')}
+                                   color={'downtime'} icon={faPowerOff}
+                                   value={<FormattedTime timeMs={data.downtime}/>}/>
+                    </Card.Body>
+                )}
+            </GenericFilterContextProvider>
         </Card>
     )
 }

Original file line number	Diff line number	Diff line change
`@@ -43,6 +43,6 @@ enum FormatType {`
`43`	`43`	`PERCENTAGE,`
`44`	`44`	`BYTES,`
`45`	`45`	`SPECIAL,`
`46`		`- NONE`
	`46`	`+ DECIMAL, NONE`
`47`	`47`	`}`
`48`	`48`	`}`
Original file line number	Diff line number	Diff line change
`@@ -107,4 +107,8 @@ public interface DatapointModule {`
`107`	`107`	`@Binds`
`108`	`108`	`@IntoSet`
`109`	`109`	`Datapoint<?> bindPlayerKills(PlayerKills playerKills);`
	`110`	`+`
	`111`	`+ @Binds`
	`112`	`+ @IntoSet`
	`113`	`+ Datapoint<?> bindAverageTPS(AverageTPS averageTPS);`
`110`	`114`	`}`