Add NEW_PLAYER_RETENTION Datapoint

Author: AuroraLS3

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

@@ -150,6 +150,8 @@ public enum WebPermission implements Supplier<String>, Lang {
     DATA_NETWORK_REGULAR_PLAYERS("See Regular players -datapoint of network"),
     DATA_SERVER_NEW_PLAYERS("See New players -datapoint of servers"),
     DATA_NETWORK_NEW_PLAYERS("See New players -datapoint of network"),
+    DATA_SERVER_NEW_PLAYER_RETENTION("See New player retention -datapoint of servers"),
+    DATA_NETWORK_NEW_PLAYER_RETENTION("See New player retention -datapoint of network"),
     DATA_PLAYER_SESSION_COUNT("See Session count -datapoint of players"),
     DATA_SERVER_SESSION_COUNT("See Session count -datapoint of servers"),
     DATA_NETWORK_SESSION_COUNT("See Session count -datapoint of network"),
@@ -160,8 +162,8 @@ public enum WebPermission implements Supplier<String>, Lang {
     DATA_NETWORK_PLAYTIME_PER_PLAYER_AVERAGE("See Average playtime per player -datapoint of network"),
     DATA_SERVER_PLAYERS_ONLINE_PEAK("See Player online peak -datapoint of servers"),
     DATA_NETWORK_PLAYERS_ONLINE_PEAK("See Player online peak -datapoint of network"),
-    DATA_SERVER_PLAYERS_ONLINE("See Players online -datapoint of servers"),
-    DATA_NETWORK_PLAYERS_ONLINE("See Players online -datapoint of network"),
+    DATA_SERVER_PLAYERS_ONLINE_CURRENT("See Players online -datapoint of servers"),
+    DATA_NETWORK_PLAYERS_ONLINE_CURRENT("See Players online -datapoint of network"),
     DATA_SERVER_UPTIME_CURRENT("See Current uptime -datapoint of servers"),
     DATA_NETWORK_UPTIME_CURRENT("See Current uptime -datapoint of network"),
     DATA_PLAYER_MOB_KILLS("See Mob kills -datapoint of players"),

Plan/common/src/main/java/com/djrapitops/plan/delivery/export/ServerPageExporter.java

@@ -170,6 +170,7 @@ public void exportJSON(Path toDirectory, ServerUUID serverUUID) throws IOExcepti
                 datapointType + DatapointType.UPTIME_CURRENT + server,
                 datapointType + DatapointType.TPS_AVERAGE + afterMillis + TimeUnit.DAYS.toMillis(7) + server,
                 datapointType + DatapointType.UNIQUE_PLAYERS_AVERAGE + afterMillis + TimeUnit.DAYS.toMillis(7) + server,
+                datapointType + DatapointType.NEW_PLAYER_RETENTION + afterMillis + TimeUnit.DAYS.toMillis(7) + server,
                 // Week comparison
                 datapointType + DatapointType.UNIQUE_PLAYERS_COUNT + afterMillis + TimeUnit.DAYS.toMillis(14) + beforeMillis + TimeUnit.DAYS.toMillis(7L) + server,
                 datapointType + DatapointType.NEW_PLAYERS + afterMillis + TimeUnit.DAYS.toMillis(14) + beforeMillis + TimeUnit.DAYS.toMillis(7L) + server,

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

@@ -44,7 +44,7 @@ public enum DatapointType {
     SESSION_LENGTH_AVERAGE(SessionLengthAverage.class, DatapointCacheKey.SESSION),
     PLAYTIME_PER_PLAYER_AVERAGE(PlaytimePerPlayerAverage.class, DatapointCacheKey.SESSION),
     PLAYERS_ONLINE_PEAK(PlayersOnlinePeak.class, DatapointCacheKey.TPS),
-    PLAYERS_ONLINE(PlayersOnline.class, DatapointCacheKey.TPS),
+    PLAYERS_ONLINE(PlayersOnlineCurrent.class, DatapointCacheKey.TPS),
     UPTIME_CURRENT(UptimeCurrent.class),
     MOB_KILLS(MobKills.class, DatapointCacheKey.SESSION),
     PLAYER_KILLS(PlayerKills.class, DatapointCacheKey.SESSION),
@@ -56,7 +56,8 @@ public enum DatapointType {
     RAM_AVERAGE(RAMAverage.class, DatapointCacheKey.TPS),
     ENTITIES_AVERAGE(EntitiesAverage.class, DatapointCacheKey.TPS),
     CHUNKS_AVERAGE(ChunksAverage.class, DatapointCacheKey.TPS),
-    UNIQUE_PLAYERS_AVERAGE(UniquePlayersPerDayAverage.class, DatapointCacheKey.SESSION);
+    UNIQUE_PLAYERS_AVERAGE(UniquePlayersPerDayAverage.class, DatapointCacheKey.SESSION),
+    NEW_PLAYER_RETENTION(NewPlayerRetention.class, DatapointCacheKey.SESSION);
 
     private final Class<? extends Datapoint<?>> datapointClass;
     private final DatapointCacheKey[] cacheKeys;

Plan/common/src/main/java/com/djrapitops/plan/delivery/rendering/json/datapoint/types/DatapointModule.java

@@ -96,7 +96,7 @@ public interface DatapointModule {
 
     @Binds
     @IntoSet
-    Datapoint<?> bindPlayersOnline(PlayersOnline playersOnline);
+    Datapoint<?> bindPlayersOnline(PlayersOnlineCurrent playersOnlineCurrent);
 
     @Binds
     @IntoSet
@@ -140,5 +140,9 @@ public interface DatapointModule {
 
     @Binds
     @IntoSet
-    Datapoint<?> bindUniquePlayersAveragePerDay(UniquePlayersPerDayAverage uniquePlayersPerDayAverage);
+    Datapoint<?> bindUniquePlayersPerDayAverage(UniquePlayersPerDayAverage uniquePlayersPerDayAverage);
+
+    @Binds
+    @IntoSet
+    Datapoint<?> bindNewPlayerRetention(NewPlayerRetention newPlayerRetention);
 }

Plan/common/src/main/java/com/djrapitops/plan/delivery/rendering/json/datapoint/types/NewPlayerRetention.java

@@ -0,0 +1,81 @@
+/*
+ *  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.OutOf;
+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.Database;
+import com.djrapitops.plan.storage.database.queries.analysis.PlayerCountQueries;
+
+import javax.inject.Inject;
+import javax.inject.Singleton;
+import java.util.Optional;
+
+/**
+ * Datapoint for New player retention.
+ * <p>
+ * New player retention is calculated by checking if a player registered within the timeframe,
+ * and played within the latter half of the timeframe.
+ *
+ * @author AuroraLS3
+ */
+@Singleton
+public class NewPlayerRetention implements Datapoint<OutOf> {
+
+    private final DBSystem dbSystem;
+
+    @Inject
+    public NewPlayerRetention(DBSystem dbSystem) {this.dbSystem = dbSystem;}
+
+    @Override
+    public Optional<OutOf> getValue(GenericFilter filter) {
+        if (filter.getPlayerUUID().isPresent()) {
+            throw new BadRequestException("NEW_PLAYER_RETENTION does not support player parameter");
+        }
+
+        Database db = dbSystem.getDatabase();
+        int new7d = db.query(PlayerCountQueries.newPlayerCount(filter.getAfter(), filter.getBefore(), filter.getServerUUIDs()));
+        int retained7d = db.query(PlayerCountQueries.retainedPlayerCount(filter.getAfter(), filter.getBefore(), filter.getServerUUIDs()));
+        return Optional.of(new OutOf(retained7d, new7d, FormatType.NONE));
+    }
+
+    @Override
+    public WebPermission getPermission(GenericFilter filter) {
+        if (filter.getPlayerUUID().isPresent()) {
+            return WebPermission.DATA_PLAYER;
+        } else if (!filter.getServerUUIDs().isEmpty()) {
+            return WebPermission.DATA_SERVER_NEW_PLAYER_RETENTION;
+        } else {
+            return WebPermission.DATA_NETWORK_NEW_PLAYER_RETENTION;
+        }
+    }
+
+    @Override
+    public DatapointType getType() {
+        return DatapointType.NEW_PLAYER_RETENTION;
+    }
+
+    @Override
+    public FormatType getFormatType() {
+        return FormatType.SPECIAL;
+    }
+}

…/json/datapoint/types/PlayersOnline.java …atapoint/types/PlayersOnlineCurrent.javaPlan/common/src/main/java/com/djrapitops/plan/delivery/rendering/json/datapoint/types/PlayersOnline.java renamed to Plan/common/src/main/java/com/djrapitops/plan/delivery/rendering/json/datapoint/types/PlayersOnlineCurrent.java Plan/common/src/main/java/com/djrapitops/plan/delivery/rendering/json/datapoint/types/PlayersOnline.java renamed to Plan/common/src/main/java/com/djrapitops/plan/delivery/rendering/json/datapoint/types/PlayersOnlineCurrent.java

@@ -40,14 +40,14 @@
  * @author AuroraLS3
  */
 @Singleton
-public class PlayersOnline implements Datapoint<Integer> {
+public class PlayersOnlineCurrent implements Datapoint<Integer> {
 
     private final DBSystem dbSystem;
     private final ServerInfo serverInfo;
     private final ServerSensor<?> serverSensor;
 
     @Inject
-    public PlayersOnline(DBSystem dbSystem, ServerInfo serverInfo, ServerSensor<?> serverSensor) {
+    public PlayersOnlineCurrent(DBSystem dbSystem, ServerInfo serverInfo, ServerSensor<?> serverSensor) {
         this.dbSystem = dbSystem;
         this.serverInfo = serverInfo;
         this.serverSensor = serverSensor;
@@ -95,9 +95,9 @@ public WebPermission getPermission(GenericFilter filter) {
         if (filter.getPlayerUUID().isPresent()) {
             return WebPermission.DATA_PLAYER;
         } else if (!filter.getServerUUIDs().isEmpty()) {
-            return WebPermission.DATA_SERVER_PLAYERS_ONLINE;
+            return WebPermission.DATA_SERVER_PLAYERS_ONLINE_CURRENT;
         } else {
-            return WebPermission.DATA_NETWORK_PLAYERS_ONLINE;
+            return WebPermission.DATA_NETWORK_PLAYERS_ONLINE_CURRENT;
         }
     }
 

Plan/common/src/main/java/com/djrapitops/plan/settings/theme/ThemeVal.java

@@ -53,7 +53,7 @@ public enum ThemeVal {
     WHITE("Colors.Extra.White", "#fff"),
 
     GRAPH_PUNCHCARD("GraphColors.PunchCard", "#222"),
-    GRAPH_PLAYERS_ONLINE("GraphColors.PlayersOnline", "#1E90FF"),
+    GRAPH_PLAYERS_ONLINE("GraphColors.PlayersOnlineCurrent", "#1E90FF"),
     GRAPH_TPS_HIGH("GraphColors.TPS.High", "#267F00"),
     GRAPH_TPS_MED("GraphColors.TPS.Medium", "#e5cc12"),
     GRAPH_TPS_LOW("GraphColors.TPS.Low", "#b74343"),

Plan/common/src/main/java/com/djrapitops/plan/storage/database/queries/analysis/PlayerCountQueries.java

@@ -446,6 +446,10 @@ public static Query<Integer> averageNewPlayerCount(long after, long before, long
     }
 
     public static Query<Integer> retainedPlayerCount(long after, long before, ServerUUID serverUUID) {
+        return retainedPlayerCount(after, before, List.of(serverUUID));
+    }
+
+    public static Query<Integer> retainedPlayerCount(long after, long before, List<ServerUUID> serverUUIDs) {
         String selectUniqueUUIDs = SELECT + DISTINCT + "s." + SessionsTable.USER_ID +
                 FROM + SessionsTable.TABLE_NAME + " s" +
                 INNER_JOIN + UserInfoTable.TABLE_NAME + " ux" +
@@ -456,7 +460,7 @@ public static Query<Integer> retainedPlayerCount(long after, long before, Server
                 AND + UserInfoTable.REGISTERED + "<=?" +
                 AND + SessionsTable.SESSION_START + ">=?" +
                 AND + SessionsTable.SESSION_END + "<=?" +
-                AND + "se." + ServerTable.SERVER_UUID + "=?";
+                (serverUUIDs.isEmpty() ? "" : AND + "se." + ServerTable.SERVER_UUID + " IN (" + ServerTable.uuids(serverUUIDs) + ')');
 
         return new QueryStatement<>(selectUniqueUUIDs) {
             @Override
@@ -468,7 +472,6 @@ public void prepare(PreparedStatement statement) throws SQLException {
                 long half = before - (before - after) / 2;
                 statement.setLong(3, half);
                 statement.setLong(4, before);
-                statement.setString(5, serverUUID.toString());
             }
 
             @Override

Plan/common/src/test/java/com/djrapitops/plan/delivery/webserver/AccessControlTest.java

@@ -210,6 +210,9 @@ static Stream<Arguments> testCases() {
                 Arguments.of("/v1/datapoint?type=NEW_PLAYERS", WebPermission.DATA_NETWORK_NEW_PLAYERS, 200, 403),
                 Arguments.of("/v1/datapoint?type=NEW_PLAYERS&server=" + TestConstants.SERVER_UUID_STRING, WebPermission.DATA_SERVER_NEW_PLAYERS, 200, 403),
                 Arguments.of("/v1/datapoint?type=NEW_PLAYERS&player=" + TestConstants.PLAYER_ONE_UUID_STRING, WebPermission.DATA_PLAYER, 400, 403),
+                Arguments.of("/v1/datapoint?type=NEW_PLAYER_RETENTION", WebPermission.DATA_NETWORK_NEW_PLAYER_RETENTION, 200, 403),
+                Arguments.of("/v1/datapoint?type=NEW_PLAYER_RETENTION&server=" + TestConstants.SERVER_UUID_STRING, WebPermission.DATA_SERVER_NEW_PLAYER_RETENTION, 200, 403),
+                Arguments.of("/v1/datapoint?type=NEW_PLAYER_RETENTION&player=" + TestConstants.PLAYER_ONE_UUID_STRING, WebPermission.DATA_PLAYER, 400, 403),
                 Arguments.of("/v1/datapoint?type=SESSION_COUNT", WebPermission.DATA_NETWORK_SESSION_COUNT, 200, 403),
                 Arguments.of("/v1/datapoint?type=SESSION_COUNT&server=" + TestConstants.SERVER_UUID_STRING, WebPermission.DATA_SERVER_SESSION_COUNT, 200, 403),
                 Arguments.of("/v1/datapoint?type=SESSION_COUNT&player=" + TestConstants.PLAYER_ONE_UUID_STRING, WebPermission.DATA_PLAYER_SESSION_COUNT, 200, 403),
@@ -222,8 +225,8 @@ static Stream<Arguments> testCases() {
                 Arguments.of("/v1/datapoint?type=PLAYERS_ONLINE_PEAK", WebPermission.DATA_NETWORK_PLAYERS_ONLINE_PEAK, 200, 403),
                 Arguments.of("/v1/datapoint?type=PLAYERS_ONLINE_PEAK&server=" + TestConstants.SERVER_UUID_STRING, WebPermission.DATA_SERVER_PLAYERS_ONLINE_PEAK, 200, 403),
                 Arguments.of("/v1/datapoint?type=PLAYERS_ONLINE_PEAK&player=" + TestConstants.PLAYER_ONE_UUID_STRING, WebPermission.DATA_PLAYER, 400, 403),
-                Arguments.of("/v1/datapoint?type=PLAYERS_ONLINE", WebPermission.DATA_NETWORK_PLAYERS_ONLINE, 200, 403),
-                Arguments.of("/v1/datapoint?type=PLAYERS_ONLINE&server=" + TestConstants.SERVER_UUID_STRING, WebPermission.DATA_SERVER_PLAYERS_ONLINE, 200, 403),
+                Arguments.of("/v1/datapoint?type=PLAYERS_ONLINE", WebPermission.DATA_NETWORK_PLAYERS_ONLINE_CURRENT, 200, 403),
+                Arguments.of("/v1/datapoint?type=PLAYERS_ONLINE&server=" + TestConstants.SERVER_UUID_STRING, WebPermission.DATA_SERVER_PLAYERS_ONLINE_CURRENT, 200, 403),
                 Arguments.of("/v1/datapoint?type=PLAYERS_ONLINE&player=" + TestConstants.PLAYER_ONE_UUID_STRING, WebPermission.DATA_PLAYER, 400, 403),
                 Arguments.of("/v1/datapoint?type=UPTIME_CURRENT", WebPermission.DATA_NETWORK_UPTIME_CURRENT, 200, 403),
                 Arguments.of("/v1/datapoint?type=UPTIME_CURRENT&server=" + TestConstants.SERVER_UUID_STRING, WebPermission.DATA_SERVER_UPTIME_CURRENT, 200, 403),

Plan/react/dashboard/src/components/datapoint/QueryDatapoint.tsx

@@ -45,6 +45,8 @@ const FormattedOutOf = ({outOf}: { outOf: OutOf }) => {
     return (
         <>
             <Format value={outOf.value} formatType={outOf.formatType}/>
+            {' / '}
+            <Format value={outOf.max} formatType={outOf.formatType}/>
             {' '}({formatDecimals(outOf.percentage * 100)}%)
         </>
     )