feat: add Yardstick URL to review workflow

Add a Yardstick deep-link URL field to the review request modal so
reviewers know where to submit their review results. Validate the URL
requires page=hackerrank, candidate, and zohoId query params. Reformat
the acceptance message to be more scannable with action links at top.

Author: kylehoehns

src/bot/__tests__/acceptReviewRequest.test.ts

@@ -20,32 +20,25 @@ describe('acceptReviewRequest', () => {
     activeReviewRepo.getReviewByThreadIdOrUndefined = jest.fn();
   });
 
-  const expectedHackerRankUrlBlock = {
+  const expectedLinksBlock = {
     type: 'section',
     text: {
       type: 'mrkdwn',
-      text: '*HackerRank Report:* <https://www.sourceallies.com|View Candidate Assessment>',
+      text: '*:paperclip: <https://www.sourceallies.com|View Candidate Assessment>*\n*:paperclip: <https://yardstick.example.com|Submit Review Results>*',
     },
   };
-  const expectedHackerRankInstructionsBlock = {
+  const expectedInstructionsBlock = {
     type: 'section',
     text: {
       type: 'mrkdwn',
-      text: '_To review the candidate\u2019s test, visit the URL above and log in with your Source Allies HackerRank account. If you have questions about using HackerRank\u2019s review features, please visit our <https://allies.atlassian.net/wiki/spaces/REI/pages/4868112402/Helpful+HackerRank+Features|documentation>._',
-    },
-  };
-  const expectedHackerRankAccountHelpBlock = {
-    type: 'section',
-    text: {
-      type: 'mrkdwn',
-      text: "_Don't have a HackerRank account? Ping <@requester123> and they'll make one for you._",
+      text: "_Log in with your SA HackerRank account._\n_No account? Ping <@requester123> and they'll make one for you._\n_Questions? See our <https://allies.atlassian.net/wiki/spaces/REI/pages/4868112402/Helpful+HackerRank+Features|documentation>._",
     },
   };
   const expectedTestInfoBlock = {
     type: 'section',
     text: {
       type: 'mrkdwn',
-      text: '*Test Information:*\nThe test has 4 questions: 2 easy and 2 medium difficulty.\nSection 1 contains the easy questions, Section 2 contains the medium questions.\nCandidates should try to solve one problem from each section.\nThey have 70 minutes total to complete the test.',
+      text: '*Test Info:* 4 questions (2 easy, 2 medium) · 70 min · candidates answer 1 per section (2 total)',
     },
   };
 
@@ -77,6 +70,7 @@ describe('acceptReviewRequest', () => {
     // Mock review with user in pending list
     (activeReviewRepo.getReviewByThreadIdOrUndefined as jest.Mock).mockResolvedValue({
       hackerRankUrl: 'https://www.sourceallies.com',
+      yardstickUrl: 'https://yardstick.example.com',
       requestorId: 'requester123',
       candidateType: CandidateType.FULL_TIME,
       acceptedReviewers: [],
@@ -134,9 +128,8 @@ describe('acceptReviewRequest', () => {
       );
       expectUpdatedWithBlocks(
         action,
-        expectedHackerRankUrlBlock,
-        expectedHackerRankInstructionsBlock,
-        expectedHackerRankAccountHelpBlock,
+        expectedLinksBlock,
+        expectedInstructionsBlock,
         expectedTestInfoBlock,
       );
       expect(reviewCloser.closeReviewIfComplete).toHaveBeenCalledWith(app, '123');
@@ -162,6 +155,7 @@ describe('acceptReviewRequest', () => {
       // Mock review where user already accepted (not in pending)
       (activeReviewRepo.getReviewByThreadIdOrUndefined as jest.Mock).mockResolvedValue({
         hackerRankUrl: 'https://www.sourceallies.com',
+        yardstickUrl: 'https://yardstick.example.com',
         acceptedReviewers: [{ userId }],
         declinedReviewers: [],
         pendingReviewers: [],
@@ -202,6 +196,7 @@ describe('acceptReviewRequest', () => {
       // Mock review where user already declined (not in pending)
       (activeReviewRepo.getReviewByThreadIdOrUndefined as jest.Mock).mockResolvedValue({
         hackerRankUrl: 'https://www.sourceallies.com',
+        yardstickUrl: 'https://yardstick.example.com',
         acceptedReviewers: [],
         declinedReviewers: [{ userId }],
         pendingReviewers: [],

src/bot/__tests__/getReviewInfo.test.ts

@@ -53,6 +53,7 @@ describe('getReviewInfo', () => {
         declinedReviewers: [],
         pendingReviewers: [],
         hackerRankUrl: '',
+        yardstickUrl: '',
       };
       activeReviewRepo.getReviewByThreadIdOrFail = jest.fn().mockResolvedValue(review);
       userRepo.listAll = jest.fn().mockResolvedValue([]);

src/bot/__tests__/requestReview.test.ts

@@ -184,6 +184,27 @@ describe('requestReview', () => {
           },
         });
       });
+
+      it('should setup the seventh response block for the Yardstick URL input', () => {
+        const { mock } = param.client.views.open as jest.Mock;
+        const blocks = mock.calls[0][0].view.blocks;
+        expect(blocks[6]).toEqual({
+          type: 'input',
+          block_id: ActionId.YARDSTICK_URL,
+          label: {
+            text: 'Yardstick URL',
+            type: 'plain_text',
+          },
+          element: {
+            type: 'plain_text_input',
+            action_id: ActionId.YARDSTICK_URL,
+            placeholder: {
+              text: 'Enter Yardstick URL...',
+              type: 'plain_text',
+            },
+          },
+        });
+      });
     });
 
     describe('when the language cannot be retrieved', () => {
@@ -287,6 +308,13 @@ describe('requestReview', () => {
           value: 'https://www.hackerrank.com/test/example123?authkey=validkey123',
         },
       },
+      [ActionId.YARDSTICK_URL]: {
+        [ActionId.YARDSTICK_URL]: {
+          type: 'plain_text_input',
+          value:
+            'https://script.google.com/a/sourceallies.com/macros/s/abc123/exec?page=hackerrank&candidate=John+Doe&zohoId=12345',
+        },
+      },
     };
 
     async function callCallback(param = buildParam()) {
@@ -385,6 +413,8 @@ _Candidate Identifier: some-identifier_
           },
         ],
         hackerRankUrl: 'https://www.hackerrank.com/test/example123?authkey=validkey123',
+        yardstickUrl:
+          'https://script.google.com/a/sourceallies.com/macros/s/abc123/exec?page=hackerrank&candidate=John+Doe&zohoId=12345',
       });
     });
 
@@ -439,6 +469,65 @@ _Candidate Identifier: some-identifier_
         expect(param.client.chat.postMessage).toHaveBeenCalled();
       });
 
+      it('should reject submission when Yardstick URL is invalid', async () => {
+        const invalidUrlValues = {
+          ...defaultValues,
+          [ActionId.YARDSTICK_URL]: {
+            [ActionId.YARDSTICK_URL]: {
+              type: 'plain_text_input',
+              value: 'https://example.com/not-yardstick',
+            },
+          },
+        };
+
+        const param = buildParam(invalidUrlValues);
+        await requestReview.callback(param);
+
+        expect(param.ack).toHaveBeenCalledWith({
+          response_action: 'errors',
+          errors: {
+            [ActionId.YARDSTICK_URL]:
+              'Please provide a valid Yardstick URL with page=hackerrank, candidate, and zohoId parameters.',
+          },
+        });
+
+        expect(activeReviewRepo.create).not.toHaveBeenCalled();
+        expect(param.client.chat.postMessage).not.toHaveBeenCalled();
+      });
+
+      it('should return errors for both URLs when both are invalid', async () => {
+        const invalidUrlValues = {
+          ...defaultValues,
+          [ActionId.HACKERRANK_URL]: {
+            [ActionId.HACKERRANK_URL]: {
+              type: 'plain_text_input',
+              value: 'not-a-valid-url',
+            },
+          },
+          [ActionId.YARDSTICK_URL]: {
+            [ActionId.YARDSTICK_URL]: {
+              type: 'plain_text_input',
+              value: 'also-not-valid',
+            },
+          },
+        };
+
+        const param = buildParam(invalidUrlValues);
+        await requestReview.callback(param);
+
+        expect(param.ack).toHaveBeenCalledWith({
+          response_action: 'errors',
+          errors: {
+            [ActionId.HACKERRANK_URL]:
+              'Please provide a valid HackerRank URL with an authkey. Use the "Share Report" button to get the correct URL.',
+            [ActionId.YARDSTICK_URL]:
+              'Please provide a valid Yardstick URL with page=hackerrank, candidate, and zohoId parameters.',
+          },
+        });
+
+        expect(activeReviewRepo.create).not.toHaveBeenCalled();
+      });
+
       it('should reject submission when HackerRank URL is invalid format', async () => {
         const invalidUrlValues = {
           ...defaultValues,

src/bot/acceptReviewRequest.ts

@@ -83,25 +83,22 @@ export const acceptReviewRequest = {
         const blocks = blockUtils.removeBlock(body, BlockId.REVIEWER_DM_BUTTONS);
         blocks.push(textBlock('*You accepted this review.*'));
 
-        // Add HackerRank URL with instructions if available
+        // Add action links and instructions
         const review = await activeReviewRepo.getReviewByThreadIdOrUndefined(threadId);
         if (review) {
-          blocks.push(
-            textBlock(`*HackerRank Report:* <${review.hackerRankUrl}|View Candidate Assessment>`),
-          );
           blocks.push(
             textBlock(
-              '_To review the candidate\u2019s test, visit the URL above and log in with your Source Allies HackerRank account. If you have questions about using HackerRank\u2019s review features, please visit our <https://allies.atlassian.net/wiki/spaces/REI/pages/4868112402/Helpful+HackerRank+Features|documentation>._',
+              `*:paperclip: <${review.hackerRankUrl}|View Candidate Assessment>*\n*:paperclip: <${review.yardstickUrl}|Submit Review Results>*`,
             ),
           );
           blocks.push(
             textBlock(
-              `_Don't have a HackerRank account? Ping ${mention({ id: review.requestorId })} and they'll make one for you._`,
+              `_Log in with your SA HackerRank account._\n_No account? Ping ${mention({ id: review.requestorId })} and they'll make one for you._\n_Questions? See our <https://allies.atlassian.net/wiki/spaces/REI/pages/4868112402/Helpful+HackerRank+Features|documentation>._`,
             ),
           );
           blocks.push(
             textBlock(
-              '*Test Information:*\nThe test has 4 questions: 2 easy and 2 medium difficulty.\nSection 1 contains the easy questions, Section 2 contains the medium questions.\nCandidates should try to solve one problem from each section.\nThey have 70 minutes total to complete the test.',
+              '*Test Info:* 4 questions (2 easy, 2 medium) · 70 min · candidates answer 1 per section (2 total)',
             ),
           );
           await chatService.updateDirectMessage(client, user.id, messageTimestamp, blocks);

src/bot/enums.ts

@@ -23,6 +23,7 @@ export const enum ActionId {
   REVIEWER_DM_ACCEPT = 'reviewer-dm-accept',
   REVIEWER_DM_DECLINE = 'reviewer-dm-deny',
   HACKERRANK_URL = 'hackerrank-url',
+  YARDSTICK_URL = 'yardstick-url',
 }
 
 export const enum BlockId {

src/bot/requestReview.ts

@@ -19,7 +19,7 @@ import {
 } from './enums';
 import { chatService } from '@/services/ChatService';
 import { determineExpirationTime } from '@utils/reviewExpirationUtils';
-import { validateHackerRankUrl } from '@utils/urlValidation';
+import { validateHackerRankUrl, validateYardstickUrl } from '@utils/urlValidation';
 
 export const requestReview = {
   app: undefined as unknown as App,
@@ -126,6 +126,22 @@ export const requestReview = {
           },
         },
       },
+      {
+        type: 'input',
+        block_id: ActionId.YARDSTICK_URL,
+        label: {
+          text: 'Yardstick URL',
+          type: 'plain_text',
+        },
+        element: {
+          type: 'plain_text_input',
+          action_id: ActionId.YARDSTICK_URL,
+          placeholder: {
+            text: 'Enter Yardstick URL...',
+            type: 'plain_text',
+          },
+        },
+      },
     ];
 
     return {
@@ -173,17 +189,26 @@ export const requestReview = {
       log.d('callback called for non-submit action');
     }
 
-    // Extract and validate HackerRank URL before acknowledging
+    // Extract and validate URLs before acknowledging
     const hackerRankUrl = blockUtils.getBlockValue(body, ActionId.HACKERRANK_URL);
     const hackerRankUrlValue = hackerRankUrl.value;
+    const yardstickUrl = blockUtils.getBlockValue(body, ActionId.YARDSTICK_URL);
+    const yardstickUrlValue = yardstickUrl.value;
 
+    const errors: Record<string, string> = {};
     if (!validateHackerRankUrl(hackerRankUrlValue)) {
+      errors[ActionId.HACKERRANK_URL] =
+        'Please provide a valid HackerRank URL with an authkey. Use the "Share Report" button to get the correct URL.';
+    }
+    if (!validateYardstickUrl(yardstickUrlValue)) {
+      errors[ActionId.YARDSTICK_URL] =
+        'Please provide a valid Yardstick URL with page=hackerrank, candidate, and zohoId parameters.';
+    }
+
+    if (Object.keys(errors).length > 0) {
       await ack({
         response_action: 'errors',
-        errors: {
-          [ActionId.HACKERRANK_URL]:
-            'Please provide a valid HackerRank URL with an authkey. Use the "Share Report" button to get the correct URL.',
-        },
+        errors,
       });
       return;
     }
@@ -290,6 +315,7 @@ export const requestReview = {
       declinedReviewers: [],
       pendingReviewers: pendingReviewers,
       hackerRankUrl: hackerRankUrlValue,
+      yardstickUrl: yardstickUrlValue,
     });
   },
 };

src/cron/__tests__/reviewProcessor.test.ts

@@ -23,6 +23,7 @@ function mockReview(pendingReviewers: PendingReviewer[]): ActiveReview {
     requestorId: 'some-id',
     reviewersNeededCount: 2,
     hackerRankUrl: '',
+    yardstickUrl: '',
   };
 }
 

src/database/models/ActiveReview.ts

@@ -27,6 +27,10 @@ export interface ActiveReview {
    * The URL to the HackerRank report for this review
    */
   hackerRankUrl: string;
+  /**
+   * The URL to the HackerRank Yardstick review form
+   */
+  yardstickUrl: string;
 }
 
 export interface PartialPendingReviewer {

src/database/repos/activeReviewsRepo.ts

@@ -17,6 +17,7 @@ enum Column {
   PENDING_REVIEWERS = 'pendingReviewers',
   DECLINED_REVIEWERS = 'declinedReviewers',
   HACKERRANK_URL = 'hackerRankUrl',
+  YARDSTICK_URL = 'yardstickUrl',
 }
 
 function mapRowsToActiveReviews(rows: GoogleSpreadsheetRow[]): ActiveReview[] {
@@ -41,6 +42,7 @@ function mapRowToActiveReview(row: GoogleSpreadsheetRow): ActiveReview {
     pendingReviewers: JSON.parse(row.get(Column.PENDING_REVIEWERS)),
     declinedReviewers: JSON.parse(row.get(Column.DECLINED_REVIEWERS)),
     hackerRankUrl: row.get(Column.HACKERRANK_URL),
+    yardstickUrl: row.get(Column.YARDSTICK_URL),
   };
 }
 
@@ -58,6 +60,7 @@ function mapActiveReviewToRow(activeReview: ActiveReview): Record<string, any> {
     [Column.PENDING_REVIEWERS]: JSON.stringify(activeReview.pendingReviewers),
     [Column.DECLINED_REVIEWERS]: JSON.stringify(activeReview.declinedReviewers),
     [Column.HACKERRANK_URL]: activeReview.hackerRankUrl,
+    [Column.YARDSTICK_URL]: activeReview.yardstickUrl,
   };
 }
 

src/services/__tests__/QueueService.test.ts

@@ -156,6 +156,7 @@ describe('Queue Service', () => {
           declinedReviewers: [],
           pendingReviewers: [{ userId: 'expectedUser1', messageTimestamp: '123', expiresAt: 123 }],
           hackerRankUrl: '',
+          yardstickUrl: '',
         },
       ];