Allow for user privacy (opt out of leaderboard)

Author: Raymo111

src/commandDetails/coin/leaderboard.ts

@@ -10,6 +10,7 @@ import {
 import {
   getCurrentCoinLeaderboard,
   getCoinBalanceByUserId,
+  getPrivateUserIdList,
   UserCoinEntry,
   getUserIdCurrentCoinPosition
 } from '../../components/coin';
@@ -27,6 +28,7 @@ const getCurrentCoinLeaderboardEmbed = async (
   // Initialise user's coin balance if they have not already
   const userBalance = await getCoinBalanceByUserId(currentUserId);
   const currentPosition = await getUserIdCurrentCoinPosition(currentUserId);
+  const isUserPrivate = await getPrivateUserIdList(currentUserId);
 
   const leaderboardArray: string[] = [];
   for (let i = 0; i < leaderboard.length && leaderboardArray.length < limit; i++) {
@@ -38,8 +40,10 @@ const getCurrentCoinLeaderboardEmbed = async (
       continue;
     }
     if (user.bot) continue;
-    const userTag = user?.tag ?? '<unknown>';
-    const userCoinEntryText = `${leaderboardArray.length + 1}. ${userTag} - ${userCoinEntry.balance} ${getCoinEmoji()}`;
+    const userTag = user?.tag;
+    const displayTag = userTag && !isUserPrivate ? userTag : '<unknown>';
+    const userCoinEntryText =
+      `${leaderboardArray.length + 1}. ${displayTag} - ${userCoinEntry.balance} ${getCoinEmoji()}`;
     leaderboardArray.push(userCoinEntryText);
   }
   const currentLeaderboardText = leaderboardArray.join('\n');

src/components/coin.ts

@@ -81,6 +81,14 @@ export const getCoinBalanceByUserId = async (userId: string): Promise<number> =>
   return _.get(res, 'balance', 0);
 };
 
+export const getPrivateUserIdList = async (userId: string): Promise<number> => {
+  const db = await openDB();
+  // Query user privacy from DB.
+  const res = await db.get('SELECT is_private FROM user_coin WHERE user_id = ?', userId);
+  // If user doesn't have a privacy value, default to false (public).
+  return _.get(res, 'is_private', 0);
+};
+
 /*
   If user doesn't exist, create row with newBalance as the balance.
   Otherwise, update balance to newBalance.