refactor(signups): add more allowed hosts than fflogs

ssilve1989 · Apr 14, 2024 · 615c021 · 615c021
1 parent 87ec756
commit 615c021
Show file tree

Hide file tree

Showing 8 changed files with 72 additions and 18 deletions.
diff --git a/src/commands/signup/signup-command.handler.spec.ts b/src/commands/signup/signup-command.handler.spec.ts
@@ -45,7 +45,7 @@ describe('Signup Command Handler', () => {
               return Encounter.DSR;
             case 'character':
               return 'Test Character';
-            case 'fflogs':
+            case 'prog-proof-link':
               return 'https://www.fflogs.com/reports/foo';
             case 'availability':
               return 'Monday, Wednesday, Friday';

diff --git a/src/commands/signup/signup-command.handler.ts b/src/commands/signup/signup-command.handler.ts
@@ -77,13 +77,13 @@ class SignupCommandHandler implements ICommandHandler<SignupCommand> {
 
     const embed = this.createSignupConfirmationEmbed(signupRequest);
 
-    const ConfirmationRow = new ActionRowBuilder().addComponents(
+    const confirmationRow = new ActionRowBuilder().addComponents(
       ConfirmButton,
       CancelButton,
     );
 
     const confirmationInteraction = await interaction.editReply({
-      components: [ConfirmationRow as any], // the typings are wrong here? annoying af
+      components: [confirmationRow as any], // the typings are wrong here? annoying af
       embeds: [embed],
     });
     try {
@@ -153,7 +153,7 @@ class SignupCommandHandler implements ICommandHandler<SignupCommand> {
       character: options.getString('character')!,
       discordId: user.id,
       encounter: options.getString('encounter')! as Encounter,
-      fflogsLink: options.getString('fflogs'),
+      proofOfProgLink: options.getString('prog-proof-link'),
       progPointRequested: options.getString('prog-point')!,
       role: options.getString('job')!,
       screenshot: options.getAttachment('screenshot')?.url,
@@ -175,7 +175,7 @@ class SignupCommandHandler implements ICommandHandler<SignupCommand> {
     availability,
     character,
     encounter,
-    fflogsLink,
+    proofOfProgLink,
     role,
     screenshot,
     world,
@@ -196,11 +196,11 @@ class SignupCommandHandler implements ICommandHandler<SignupCommand> {
         { name: 'Role', value: role, inline: true },
       ]);
 
-    if (fflogsLink) {
+    if (proofOfProgLink) {
       embed = embed.addFields([
         {
           name: 'FF Logs Link',
-          value: `[View Report](${fflogsLink})`,
+          value: `[View Report](${proofOfProgLink})`,
           inline: true,
         },
       ]);

diff --git a/src/commands/signup/signup-interaction.dto.ts b/src/commands/signup/signup-interaction.dto.ts
@@ -3,6 +3,7 @@ import { ToLowercase } from '../../common/decorators/to-lowercase.js';
 import { TransformUrl } from '../../common/decorators/transform-url.js';
 import { Encounter } from '../../encounters/encounters.consts.js';
 import { SignupDocument } from '../../firebase/models/signup.model.js';
+import { PROG_PROOF_HOSTS_WHITELIST } from './signup.consts.js';
 
 class SignupInteractionDto
   implements Omit<SignupDocument, 'status' | 'partyType' | 'expiresAt'>
@@ -27,20 +28,20 @@ class SignupInteractionDto
   encounter: Encounter;
 
   @IsUrl(
-    { host_whitelist: [/fflogs\.com/] },
+    // biome-ignore lint/style/useNamingConvention: <we don't controls this property>
+    { host_whitelist: PROG_PROOF_HOSTS_WHITELIST },
     {
-      message:
-        'A valid fflogs URL must be provided if no screenshot is attached',
+      message: `A link from one of these sources must be provided if no screenshot is attached: ${PROG_PROOF_HOSTS_WHITELIST}`,
     },
   )
   @TransformUrl()
   @ValidateIf(({ screenshot }) => !screenshot)
-  fflogsLink?: string | null;
+  proofOfProgLink?: string | null;
 
   @IsString({
-    message: 'A screenshot must be attached if no fflogs link is provided',
+    message: 'A screenshot must be attached if no link is provided',
   })
-  @ValidateIf(({ fflogsLink }) => !fflogsLink)
+  @ValidateIf(({ proofOfProgLink }) => !proofOfProgLink)
   screenshot?: string | null;
 
   @IsString()

diff --git a/src/commands/signup/signup-slash-command.ts b/src/commands/signup/signup-slash-command.ts
@@ -43,7 +43,7 @@ export const SignupSlashCommand = new SlashCommandBuilder()
   .addStringOption((option) =>
     option
       .setDescription('FF Logs Link for selected encounter showing prog point')
-      .setName('fflogs'),
+      .setName('prog-proof-link'),
   )
   .addAttachmentOption((option) =>
     option

diff --git a/src/commands/signup/signup.command.dto.spec.ts b/src/commands/signup/signup.command.dto.spec.ts
@@ -0,0 +1,43 @@
+import { plainToInstance } from 'class-transformer';
+import { validate } from 'class-validator';
+import { Encounter } from '../../encounters/encounters.consts.js';
+import { SignupInteractionDto } from './signup-interaction.dto.js';
+import { PROG_PROOF_HOSTS_WHITELIST } from './signup.consts.js';
+
+function createBaseObject(proofOfProgLink: string) {
+  return {
+    availability: 'test',
+    character: 'test',
+    discordId: 'test',
+    role: 'test',
+    progPointRequested: 'test',
+    encounter: Encounter.TOP,
+    proofOfProgLink,
+    username: 'test',
+    world: 'test',
+  };
+}
+
+describe('SignupInteractionDto', () => {
+  it.each(PROG_PROOF_HOSTS_WHITELIST)(
+    'should allow URLs from host %s',
+    async (host) => {
+      const dto = plainToInstance(
+        SignupInteractionDto,
+        createBaseObject(`${host.source.replace(/\\/g, '')}`),
+      );
+      const errors = await validate(dto);
+      expect(errors).toHaveLength(0);
+    },
+  );
+
+  it('should not allow URLs not in the whitelist', async () => {
+    const dto = plainToInstance(
+      SignupInteractionDto,
+      createBaseObject('https://not-in-whitelist.com/test'),
+    );
+    const errors = await validate(dto);
+    expect(errors).toHaveLength(1);
+    expect(errors[0].property).toBe('proofOfProgLink');
+  });
+});
diff --git a/src/commands/signup/signup.consts.ts b/src/commands/signup/signup.consts.ts
@@ -37,3 +37,13 @@ export const SIGNUP_REVIEW_REACTIONS: Record<
   DECLINED: '❌',
   PENDING: ':question:',
 };
+
+export const PROG_PROOF_HOSTS_WHITELIST = [
+  /fflogs.com/,
+  /gyazo.com/,
+  /imgur.com/,
+  /streamable.com/,
+  /tomestone.gg/,
+  /twitch.tv/,
+  /youtube.com/,
+];
diff --git a/src/commands/signup/subcommands/send-signup-review/send-signup-review-command.handler.ts b/src/commands/signup/subcommands/send-signup-review/send-signup-review-command.handler.ts
@@ -73,7 +73,7 @@ class SendSignupReviewCommandHandler
     availability,
     character,
     encounter,
-    fflogsLink,
+    proofOfProgLink,
     screenshot,
     world,
     role,
@@ -100,9 +100,9 @@ class SendSignupReviewCommandHandler
         { name: 'Job', value: role, inline: true },
       ]);
 
-    if (fflogsLink) {
+    if (proofOfProgLink) {
       embed = embed.addFields([
-        { name: 'FFLogs Link', value: `[View Report](${fflogsLink})` },
+        { name: 'Prog Proof Link', value: `[View](${proofOfProgLink})` },
       ]);
     }
 

diff --git a/src/firebase/models/signup.model.ts b/src/firebase/models/signup.model.ts
@@ -18,7 +18,7 @@ export interface SignupDocument {
   character: string;
   discordId: string;
   encounter: Encounter;
-  fflogsLink?: string | null;
+  proofOfProgLink?: string | null;
   // freeform field representing the characters job/role/class
   role: string;
   // the prog point specified by the coodinator upon review