monthly QOTW leaderboard

Author: danthe1st

src/main/java/net/javadiscord/javabot/systems/qotw/QOTWPointsService.java

@@ -12,6 +12,8 @@
 import org.springframework.stereotype.Service;
 import org.springframework.transaction.annotation.Transactional;
 
+import java.time.LocalDate;
+import java.time.YearMonth;
 import java.util.List;
 import java.util.Optional;
 
@@ -33,14 +35,13 @@ public class QOTWPointsService {
 	@Transactional
 	public QOTWAccount getOrCreateAccount(long userId) throws DataAccessException {
 		QOTWAccount account;
-		Optional<QOTWAccount> optional = pointsRepository.getByUserId(userId);
+		Optional<QOTWAccount> optional = pointsRepository.getByUserId(userId, getCurrentMonth());
 		if (optional.isPresent()) {
 			account = optional.get();
 		} else {
 			account = new QOTWAccount();
 			account.setUserId(userId);
 			account.setPoints(0);
-			pointsRepository.insert(account);
 		}
 		return account;
 	}
@@ -53,7 +54,7 @@ public QOTWAccount getOrCreateAccount(long userId) throws DataAccessException {
 	 */
 	public int getQOTWRank(long userId) {
 		try{
-			List<QOTWAccount> accounts = pointsRepository.sortByPoints();
+			List<QOTWAccount> accounts = pointsRepository.sortByPoints(getCurrentMonth());
 			return accounts.stream()
 					.map(QOTWAccount::getUserId)
 					.toList()
@@ -88,7 +89,7 @@ public long getPoints(long userId) {
 	 */
 	public List<Pair<QOTWAccount, Member>> getTopMembers(int n, Guild guild) {
 		try {
-			List<QOTWAccount> accounts = pointsRepository.sortByPoints();
+			List<QOTWAccount> accounts = pointsRepository.sortByPoints(getCurrentMonth());
 			return accounts.stream()
 					.map(s -> new Pair<>(s, guild.getMemberById(s.getUserId())))
 					.filter(p->p.first().getPoints() > 0)
@@ -110,7 +111,7 @@ public List<Pair<QOTWAccount, Member>> getTopMembers(int n, Guild guild) {
 	 */
 	public List<QOTWAccount> getTopAccounts(int amount, int page) {
 		try {
-			return pointsRepository.getTopAccounts(page, amount);
+			return pointsRepository.getTopAccounts(getCurrentMonth(), page, amount);
 		} catch (DataAccessException e) {
 			ExceptionLogger.capture(e, getClass().getSimpleName());
 			return List.of();
@@ -125,16 +126,17 @@ public List<QOTWAccount> getTopAccounts(int amount, int page) {
 	 */
 	public long increment(long userId) {
 		try {
-			QOTWAccount account = getOrCreateAccount(userId);
-			account.setPoints(account.getPoints() + 1);
-			if (pointsRepository.update(account)) {
-				return account.getPoints();
-			} else {
-				return 0;
-			}
+			LocalDate date=LocalDate.now();
+			int points = pointsRepository.getPointsAtDate(userId, date)+1;
+			pointsRepository.setPointsAtDate(userId, date, points);
+			return pointsRepository.getByUserId(userId, getCurrentMonth()).map(QOTWAccount::getPoints).orElse(0L);
 		} catch (DataAccessException e) {
 			ExceptionLogger.capture(e, getClass().getSimpleName());
 			return 0;
 		}
 	}
+
+	public static LocalDate getCurrentMonth() {
+		return YearMonth.from(LocalDate.now()).atDay(1);
+	}
 }

src/main/java/net/javadiscord/javabot/systems/qotw/commands/QOTWAdminCommand.java

@@ -4,7 +4,6 @@
 import net.dv8tion.jda.api.interactions.commands.build.Commands;
 import net.dv8tion.jda.api.interactions.commands.build.SubcommandGroupData;
 import net.javadiscord.javabot.systems.qotw.commands.qotw_points.IncrementPointsSubcommand;
-import net.javadiscord.javabot.systems.qotw.commands.qotw_points.SetPointsSubcommand;
 import net.javadiscord.javabot.systems.qotw.commands.questions_queue.AddQuestionSubcommand;
 import net.javadiscord.javabot.systems.qotw.commands.questions_queue.ListQuestionsSubcommand;
 import net.javadiscord.javabot.systems.qotw.commands.questions_queue.RemoveQuestionSubcommand;
@@ -23,18 +22,17 @@ public class QOTWAdminCommand extends SlashCommand {
 	 * @param addQuestionSubcommand     /qotw-admin questions-queue add
 	 * @param removeQuestionSubcommand  /qotw-admin questions-queue remove
 	 * @param incrementPointsSubcommand /qotw-admin account increment
-	 * @param setPointsSubcommand       /qotw-admin account set
 	 * @param reviewSubcommand          /qotw-admin submissions review
 	 */
-	public QOTWAdminCommand(ListQuestionsSubcommand listQuestionsSubcommand, AddQuestionSubcommand addQuestionSubcommand, RemoveQuestionSubcommand removeQuestionSubcommand, IncrementPointsSubcommand incrementPointsSubcommand, SetPointsSubcommand setPointsSubcommand, QOTWReviewSubcommand reviewSubcommand) {
+	public QOTWAdminCommand(ListQuestionsSubcommand listQuestionsSubcommand, AddQuestionSubcommand addQuestionSubcommand, RemoveQuestionSubcommand removeQuestionSubcommand, IncrementPointsSubcommand incrementPointsSubcommand, QOTWReviewSubcommand reviewSubcommand) {
 		setCommandData(Commands.slash("qotw-admin", "Administrative tools for managing the Question of the Week.")
 				.setDefaultPermissions(DefaultMemberPermissions.DISABLED)
 				.setGuildOnly(true)
 		);
 		addSubcommands(reviewSubcommand);
 		addSubcommandGroups(
 				SubcommandGroup.of(new SubcommandGroupData("questions-queue", "Commands for interacting with the set of QOTW questions that are in queue."), listQuestionsSubcommand, addQuestionSubcommand, removeQuestionSubcommand),
-				SubcommandGroup.of(new SubcommandGroupData("account", "Commands for interaction with Users Question of the Week points."), incrementPointsSubcommand, setPointsSubcommand),
+				SubcommandGroup.of(new SubcommandGroupData("account", "Commands for interaction with Users Question of the Week points."), incrementPointsSubcommand),
 				SubcommandGroup.of(new SubcommandGroupData("submissions", "Commands for managing QOTW Submissions."), reviewSubcommand)
 		);
 	}

src/main/java/net/javadiscord/javabot/systems/qotw/commands/qotw_points/SetPointsSubcommand.java

@@ -2,89 +2,102 @@
 
 import java.sql.ResultSet;
 import java.sql.SQLException;
+import java.time.LocalDate;
 import java.util.List;
 import java.util.Optional;
 
-import org.jetbrains.annotations.NotNull;
 import org.springframework.dao.DataAccessException;
 import org.springframework.dao.EmptyResultDataAccessException;
 import org.springframework.jdbc.core.JdbcTemplate;
 import org.springframework.stereotype.Repository;
 
 import lombok.RequiredArgsConstructor;
-import lombok.extern.slf4j.Slf4j;
 import net.javadiscord.javabot.systems.qotw.model.QOTWAccount;
 
 /**
  * Dao class that represents the QOTW_POINTS SQL Table.
  */
-@Slf4j
 @RequiredArgsConstructor
 @Repository
 public class QuestionPointsRepository {
 	private final JdbcTemplate jdbcTemplate;
 
 	/**
-	 * Inserts a new {@link QOTWAccount} if none exists.
+	 * Returns a {@link QOTWAccount} based on the given user Id.
 	 *
-	 * @param account The account to insert.
+	 * @param userId The discord Id of the user.
+	 * @param startDate The earliest date where points are counted
+	 * @return The {@link QOTWAccount} object.
 	 * @throws DataAccessException If an error occurs.
 	 */
-	public void insert(QOTWAccount account) throws DataAccessException {
-		int rows = jdbcTemplate.update("INSERT INTO qotw_points (user_id, points) VALUES (?, ?)",
-				account.getUserId(),account.getPoints());
-		if (rows == 0) throw new DataAccessException("User was not inserted.") {};
-		log.info("Inserted new QOTW-Account: {}", account);
+	public Optional<QOTWAccount> getByUserId(long userId, LocalDate startDate) throws DataAccessException {
+		try {
+			return Optional.of(jdbcTemplate.queryForObject("SELECT SUM(points) AS points FROM qotw_points WHERE user_id = ? AND obtained_at >= ?",
+					(rs, row)->{
+						QOTWAccount acc=new QOTWAccount();
+						acc.setUserId(userId);
+						acc.setPoints(rs.getLong(1));
+						return acc;
+					},
+					userId, startDate));
+		}catch (EmptyResultDataAccessException e) {
+			return Optional.empty();
+		}
 	}
 
 	/**
-	 * Returns a {@link QOTWAccount} based on the given user Id.
+	 * Gets the number points given to a user at a certain date.
 	 *
-	 * @param userId The discord Id of the user.
-	 * @return The {@link QOTWAccount} object.
-	 * @throws DataAccessException If an error occurs.
+	 * @param userId the ID of the user
+	 * @param date the date where the points are given to that user
+	 * @return the number of points the user obtained at the given date
 	 */
-	public Optional<QOTWAccount> getByUserId(long userId) throws DataAccessException {
+	public int getPointsAtDate(long userId, LocalDate date) {
 		try {
-			return Optional.of(jdbcTemplate.queryForObject("SELECT * FROM qotw_points WHERE user_id = ?", (rs, row)->this.read(rs),userId));
+			return jdbcTemplate.queryForObject("SELECT SUM(points) FROM qotw_points WHERE user_id = ? AND obtained_at >= ?",
+					(rs, row) -> rs.getInt(1),
+					userId, date);
 		}catch (EmptyResultDataAccessException e) {
-			return Optional.empty();
+			return 0;
 		}
 	}
 
 	/**
-	 * Updates a single QOTW Account.
+	 * Sets the points of a user at a certain date.
 	 *
-	 * @param account The updated QOTW Account.
-	 * @return Whether the update affected rows.
-	 * @throws DataAccessException If an error occurs.
+	 * @param userId the id of the user to set to points of
+	 * @param date the date when the points should be marked as set
+	 * @param points the (new) number of points the user got at that date
+	 * @return {@code true} if a change was made, else {@code false}
 	 */
-	public boolean update(@NotNull QOTWAccount account) throws DataAccessException {
-		return jdbcTemplate.update("UPDATE qotw_points SET points = ? WHERE user_id = ?",
-				account.getPoints(), account.getUserId()) > 0;
+	public boolean setPointsAtDate(long userId, LocalDate date, long points) {
+		return jdbcTemplate.update("MERGE INTO qotw_points (user_id,obtained_at,points) KEY(user_id,obtained_at) VALUES (?,?,?)",
+				userId, date, points) > 0;
 	}
 
 	/**
 	 * Gets all {@link QOTWAccount} and sorts them by their points.
 	 *
+	 * @param startDate the minimum date points are considered
 	 * @return A {@link List} that contains all {@link QOTWAccount}s sorted by their points.
 	 * @throws DataAccessException If an error occurs.
 	 */
-	public List<QOTWAccount> sortByPoints() throws DataAccessException {
-		return jdbcTemplate.query("SELECT * FROM qotw_points ORDER BY points DESC", (rs, row)->this.read(rs));
+	public List<QOTWAccount> sortByPoints(LocalDate startDate) throws DataAccessException {
+		return jdbcTemplate.query("SELECT user_id, SUM(points) FROM qotw_points WHERE obtained_at >= ? GROUP BY user_id ORDER BY SUM(points) DESC", (rs, row)->this.read(rs), startDate);
 	}
 
 	/**
 	 * Gets a specified amount of {@link QOTWAccount}s.
 	 *
-	 * @param page    The page.
-	 * @param size    The amount of {@link QOTWAccount}s to return.
+	 * @param startDate the minimum date points are considered
+	 * @param page The page.
+	 * @param size The amount of {@link QOTWAccount}s to return.
 	 * @return A {@link List} containing the specified amount of {@link QOTWAccount}s.
 	 * @throws DataAccessException If an error occurs.
 	 */
-	public List<QOTWAccount> getTopAccounts(int page, int size) throws DataAccessException {
-		return jdbcTemplate.query("SELECT * FROM qotw_points WHERE points > 0 ORDER BY points DESC LIMIT ? OFFSET ?", (rs,row)->this.read(rs),
-				size, Math.max(0, (page * size) - size));
+	public List<QOTWAccount> getTopAccounts(LocalDate startDate, int page, int size) throws DataAccessException {
+		return jdbcTemplate.query("SELECT user_id, SUM(points) FROM qotw_points WHERE startDate >= ? AND points > 0  GROUP BY user_id ORDER BY SUM(points) DESC LIMIT ? OFFSET ?", (rs,row)->this.read(rs),
+				startDate, size, Math.max(0, (page * size) - size));
 	}
 
 	/**
@@ -96,8 +109,8 @@ public List<QOTWAccount> getTopAccounts(int page, int size) throws DataAccessExc
 	 */
 	private QOTWAccount read(ResultSet rs) throws SQLException {
 		QOTWAccount account = new QOTWAccount();
-		account.setUserId(rs.getLong("user_id"));
-		account.setPoints(rs.getLong("points"));
+		account.setUserId(rs.getLong(1));
+		account.setPoints(rs.getLong(2));
 		return account;
 	}
 }

src/main/java/net/javadiscord/javabot/systems/qotw/dao/QuestionPointsRepository.java

@@ -197,7 +197,7 @@ private void drawUserCard(@NotNull Graphics2D g2d, @NotNull Member member, QOTWP
 	 */
 	private @NotNull String getCacheName() {
 		try {
-			List<QOTWAccount> accounts = qotwPointsRepository.sortByPoints()
+			List<QOTWAccount> accounts = qotwPointsRepository.sortByPoints(QOTWPointsService.getCurrentMonth())
 					.stream()
 					.limit(DISPLAY_COUNT)
 					.toList();

src/main/java/net/javadiscord/javabot/systems/user_commands/leaderboard/QOTWLeaderboardSubcommand.java

@@ -0,0 +1,3 @@
+ALTER TABLE qotw_points ADD obtained_at DATE NOT NULL DEFAULT CURRENT_TIMESTAMP(0);
+ALTER TABLE qotw_points DROP PRIMARY KEY;
+ALTER TABLE qotw_points ADD PRIMARY KEY (user_id, obtained_at);

src/main/resources/database/migrations/12-17-2022_qotw_point_timestamps.sql

@@ -50,6 +50,7 @@ CREATE TABLE qotw_question
 CREATE TABLE qotw_points
 (
 	user_id BIGINT PRIMARY KEY,
+	obtained_at DATE PRIMARY KEY DEFAULT CURRENT_TIMESTAMP(0),
 	points  BIGINT NOT NULL DEFAULT 0
 );