Adding modcommands for avatar libraries (#675)

Author: kev306

src/clients/s3/S3Agent.ts

@@ -1,3 +1,6 @@
+import User from '../../models/user';
+import { getAvatarLibrarySizeForUser } from '../../rewards/getRewards';
+
 enum FolderName {
   APPROVED = 'approved_avatars',
   PENDING = 'pending_avatars',
@@ -11,12 +14,8 @@ interface S3AvatarLinks {
 }
 
 export interface IS3Controller {
-  listObjectKeys(prefixes: string[]): any;
-  uploadFile(
-    key: string,
-    fileContent: Buffer,
-    contentType: string,
-  ): any;
+  listObjectKeys(prefixes: string[]): Promise<string[]>;
+  uploadFile(key: string, fileContent: Buffer, contentType: string): any;
   deleteFile(link: string): any;
   moveFile(oldLink: string, newLink: string): any;
 }
@@ -161,4 +160,20 @@ export class S3Agent {
       s3AvatarLinks.spyLink.includes(FolderName.PENDING)
     );
   }
+
+  public async getApprovedAvatarIdsForUser(usernameLower: string) {
+    // Assumes each res avatar has a corresponding spy avatar with same id
+    const existingResObjectKeys = await this.s3Controller.listObjectKeys([
+      `${FolderName.APPROVED}/${usernameLower}/${usernameLower}_res_`,
+    ]);
+
+    return existingResObjectKeys
+      .map((key) => {
+        // Match format: Number of digits following _res_
+        const match = key.match(/_res_(\d+)/);
+        return match ? Number(match[1]) : NaN;
+      })
+      .filter((approvedAvatarId) => !isNaN(approvedAvatarId))
+      .sort((a, b) => a - b);
+  }
 }

src/clients/s3/tests/S3Agent.test.ts

@@ -130,7 +130,7 @@ describe('S3Agent', () => {
     expect(mockS3Controller.moveFile).not.toHaveBeenCalled();
   });
 
-  it('Reverts overall avatar approval if one fails', async () => {
+  it('reverts overall avatar approval if one fails', async () => {
     mockS3Controller.moveFile.mockResolvedValueOnce(undefined);
     mockS3Controller.moveFile.mockRejectedValueOnce(
       new Error('Move File failed'),
@@ -191,4 +191,33 @@ describe('S3Agent', () => {
     expect(errorCaught).toEqual(true);
     expect(mockS3Controller.deleteFile).not.toHaveBeenCalled();
   });
+
+  it('gets the approved avatar IDs for a user in ascending order', async () => {
+    mockS3Controller.listObjectKeys.mockResolvedValueOnce([
+      'approved_avatars/usernamelower/usernamelower_res_1.png',
+      'approved_avatars/usernamelower/usernamelower_res_11.png',
+      'approved_avatars/usernamelower/usernamelower_res_2.png',
+      'approved_avatars/usernamelower/usernamelower_res_3.png',
+    ]);
+
+    const result1 = await s3Agent.getApprovedAvatarIdsForUser('usernamelower');
+
+    expect(result1).toEqual([1, 2, 3, 11]);
+
+    expect(mockS3Controller.listObjectKeys).toHaveBeenCalledWith([
+      `approved_avatars/usernamelower/usernamelower_res_`,
+    ]);
+  });
+
+  it('returns an empty array for users with no approved avatars', async () => {
+    mockS3Controller.listObjectKeys.mockResolvedValueOnce([]);
+
+    const result1 = await s3Agent.getApprovedAvatarIdsForUser('usernamelower');
+
+    expect(result1).toEqual([]);
+
+    expect(mockS3Controller.listObjectKeys).toHaveBeenCalledWith([
+      `approved_avatars/usernamelower/usernamelower_res_`,
+    ]);
+  });
 });

src/gameplay/types.ts

@@ -43,6 +43,7 @@ export interface IUser {
   emailTokenExpiry?: Date;
   avatarImgRes?: string | null;
   avatarImgSpy?: string | null;
+  avatarLibrary?: Number[];
   avatarHide?: boolean;
   hideStats?: boolean;
   pronoun?: string | null;

src/models/user.ts

@@ -33,6 +33,7 @@ const UserSchema = new mongoose.Schema<IUser>({
     type: String,
     default: null,
   },
+  avatarLibrary: [Number],
   avatarHide: Boolean,
 
   hideStats: Boolean,

src/rewards/getRewards.ts

@@ -12,12 +12,11 @@ import { isDev } from '../modsadmins/developers';
 import { PatreonAgent } from '../clients/patreon/patreonAgent';
 import { IUser } from '../gameplay/types';
 import { PatreonController } from '../clients/patreon/patreonController';
+import constants from './constants';
 
-export async function getAllPatreonRewardsForUser(
+export async function getPatreonRewardTierForUser(
   usernameLower: string,
-): Promise<RewardType[]> {
-  const rewardsSatisfied: RewardType[] = [];
-
+): Promise<RewardType> {
   const patreonAgent = new PatreonAgent(new PatreonController());
 
   const patronDetails = await patreonAgent.findOrUpdateExistingPatronDetails(
@@ -28,26 +27,31 @@ export async function getAllPatreonRewardsForUser(
     return null;
   }
 
+  let highestTierReward: RewardType = null;
+  let highestDonationAmount = 0;
+
   for (const key in PatreonRewards) {
     const reward = AllRewards[key as RewardType];
-    if (reward.donationReq <= patronDetails.amountCents) {
-      rewardsSatisfied.push(key as RewardType);
+    if (
+      reward.donationReq <= patronDetails.amountCents &&
+      reward.donationReq > highestDonationAmount
+    ) {
+      highestTierReward = key as RewardType;
+      highestDonationAmount = reward.donationReq;
     }
   }
 
-  return rewardsSatisfied;
+  return highestTierReward;
 }
 
-async function getAllRewardsForUser(user: IUser): Promise<RewardType[]> {
+export async function getAllRewardsForUser(user: IUser): Promise<RewardType[]> {
   const rewardsSatisfied: RewardType[] = [];
-  const patreonRewards = await getAllPatreonRewardsForUser(
+  const patreonReward = await getPatreonRewardTierForUser(
     user.username.toLowerCase(),
   );
 
-  if (patreonRewards) {
-    patreonRewards.forEach((reward) => {
-      rewardsSatisfied.push(reward);
-    });
+  if (patreonReward) {
+    rewardsSatisfied.push(patreonReward);
   }
 
   for (const key in AllRewardsExceptPatreon) {
@@ -60,7 +64,7 @@ async function getAllRewardsForUser(user: IUser): Promise<RewardType[]> {
   return rewardsSatisfied;
 }
 
-async function userHasReward(
+export async function userHasReward(
   user: IUser,
   rewardType: RewardType,
 ): Promise<boolean> {
@@ -91,4 +95,20 @@ async function userHasReward(
   return true;
 }
 
-export { userHasReward, getAllRewardsForUser };
+export async function getAvatarLibrarySizeForUser(
+  usernameLower: string,
+): Promise<number> {
+  const patreonReward = await getPatreonRewardTierForUser(usernameLower);
+
+  if (!patreonReward) {
+    return 1;
+  } else if (patreonReward === constants.TIER1_BADGE) {
+    return 2;
+  } else if (patreonReward === constants.TIER2_BADGE) {
+    return 3;
+  } else if (patreonReward === constants.TIER3_BADGE) {
+    return 5;
+  } else if (patreonReward === constants.TIER4_BADGE) {
+    return 10;
+  }
+}

src/sockets/commands/mod/index.ts

@@ -17,6 +17,8 @@ import { miplinkedaccs } from './miplinkedaccs';
 import { mtogglepause } from './mtogglepause';
 import { mrevealallroles } from './mrevealallroles';
 import { mforcemove } from './mforcemove';
+import { mpushavatartolibrary } from './mpushavatartolibrary';
+import { msetavatar } from './msetavatar';
 
 export const modCommands: Commands = {
   [m.command]: m,
@@ -29,7 +31,9 @@ export const modCommands: Commands = {
   [mtoggleregistration.command]: mtoggleregistration,
   [mtempenableregistration.command]: mtempenableregistration,
   [mwhisper.command]: mwhisper,
+  [msetavatar.command]: msetavatar,
   [mremoveavatar.command]: mremoveavatar,
+  [mpushavatartolibrary.command]: mpushavatartolibrary,
   [mclose.command]: mclose,
   [mannounce.command]: mannounce,
   [mkill.command]: mkill,

src/sockets/commands/mod/mpushavatartolibrary.ts

@@ -0,0 +1,66 @@
+import { Command } from '../types';
+import { sendReplyToCommand } from '../../sockets';
+import { SocketUser } from '../../types';
+import User from '../../../models/user';
+import { S3Agent } from '../../../clients/s3/S3Agent';
+import S3Controller from '../../../clients/s3/S3Controller';
+import { getAvatarLibrarySizeForUser } from '../../../rewards/getRewards';
+
+export const mpushavatartolibrary: Command = {
+  command: 'mpushavatartolibrary',
+  help: "/mpushavatartolibrary <player name> <avatar id>: Add an approved avatar ID to a user's avatar library. It will remove the oldest avatar in their library if the max avatar library size has been exceeded.",
+  async run(args: string[], senderSocket: SocketUser) {
+    if (args.length !== 3) {
+      sendReplyToCommand(senderSocket, 'Please specify <username> <avatar id>');
+      return;
+    }
+
+    const usernameLower = args[1].toLowerCase();
+    const user = await User.findOne({ usernameLower });
+
+    if (!user) {
+      sendReplyToCommand(
+        senderSocket,
+        `Invalid username. Could not find: ${usernameLower}`,
+      );
+      return;
+    }
+
+    const toBeAddedAvatarId = Number(args[2]);
+    const s3Agent = new S3Agent(new S3Controller());
+    const approvedIds = await s3Agent.getApprovedAvatarIdsForUser(
+      usernameLower,
+    );
+
+    if (isNaN(toBeAddedAvatarId) || !approvedIds.includes(toBeAddedAvatarId)) {
+      sendReplyToCommand(
+        senderSocket,
+        `Invalid avatar ID received. List of valid IDs: ${approvedIds}`,
+      );
+      return;
+    }
+
+    if (user.avatarLibrary.includes(toBeAddedAvatarId)) {
+      sendReplyToCommand(
+        senderSocket,
+        `Avatar ID already exists in user's library: [${user.avatarLibrary}]`,
+      );
+      return;
+    }
+
+    const librarySize = await getAvatarLibrarySizeForUser(usernameLower);
+    user.avatarLibrary.push(toBeAddedAvatarId);
+
+    if (user.avatarLibrary.length > librarySize) {
+      user.avatarLibrary.shift();
+    }
+    user.markModified('avatarLibrary');
+    await user.save();
+
+    sendReplyToCommand(
+      senderSocket,
+      `Successfully updated ${usernameLower}'s avatar library: [${user.avatarLibrary}]`,
+    );
+    return;
+  },
+};

src/sockets/commands/mod/mremoveavatar.ts

@@ -3,7 +3,7 @@ import User from '../../../models/user';
 
 export const mremoveavatar: Command = {
   command: 'mremoveavatar',
-  help: '/mremoveavatar <player name>: Remove <player name>\'s avatar.',
+  help: "/mremoveavatar <player name>: Remove <player name>'s avatars.",
   async run(args, senderSocket) {
     if (!args[1]) {
       senderSocket.emit('messageCommandReturnStr', {
@@ -35,4 +35,4 @@ export const mremoveavatar: Command = {
         }
       });
   },
-};
+};

src/sockets/commands/mod/msetavatar.ts

@@ -0,0 +1,51 @@
+import { Command } from '../types';
+import { sendReplyToCommand } from '../../sockets';
+import { SocketUser } from '../../types';
+import User from '../../../models/user';
+
+export const msetavatar: Command = {
+  command: 'msetavatar',
+  help: "/msetavatar <player name> <avatar resLink> <avatar spyLink>: Set a <player name>'s resistance and spy avatars.",
+  async run(args: string[], senderSocket: SocketUser) {
+    if (args.length !== 4) {
+      sendReplyToCommand(
+        senderSocket,
+        'Please specify <username> <resLink> <spyLink>.',
+      );
+      return;
+    }
+
+    const usernameLower = args[1].toLowerCase();
+    const resLink = args[2];
+    const spyLink = args[3];
+
+    if (
+      (!resLink.startsWith(process.env.S3_PUBLIC_FILE_LINK_PREFIX) &&
+        !resLink.includes('res')) ||
+      (!spyLink.startsWith(process.env.S3_PUBLIC_FILE_LINK_PREFIX) &&
+        !spyLink.includes('spy'))
+    ) {
+      sendReplyToCommand(senderSocket, `Invalid avatar links provided`);
+      return;
+    }
+
+    const user = await User.findOne({ usernameLower });
+
+    if (!user) {
+      sendReplyToCommand(
+        senderSocket,
+        `Invalid username. Could not find: ${usernameLower}`,
+      );
+      return;
+    }
+
+    user.avatarImgRes = resLink;
+    user.avatarImgSpy = spyLink;
+    await user.save();
+
+    sendReplyToCommand(
+      senderSocket,
+      `Successfully changed avatars for user: ${usernameLower}.`,
+    );
+  },
+};