Refactor to use getSortedReportActions and add unit test

Replace inline sorting logic in getIOUReportActionWithBadge and
getReasonAndReportActionThatRequiresAttention with the existing
getSortedReportActions utility from ReportActionsUtils.

Add a unit test verifying that getIOUReportActionWithBadge returns
the oldest matching report action when multiple actions have badges.

Co-authored-by: Aimane Chnaif <aimane-chnaif@users.noreply.github.com>

Author: MelvinBot

src/libs/ReportUtils.ts

@@ -4279,25 +4279,19 @@ function getReasonAndReportActionThatRequiresAttention(
     }
 
     if (isInvoiceRoom(optionOrReport)) {
-        let earliestAction: ReportAction | undefined;
-        for (const action of Object.values(reportActions)) {
-            if (
-                action.actionName !== CONST.REPORT.ACTIONS.TYPE.REPORT_PREVIEW ||
-                !action.childReportID ||
-                !hasMissingInvoiceBankAccount(action.childReportID) ||
-                isSettled(action.childReportID)
-            ) {
-                continue;
-            }
-            if (!earliestAction?.created || (action.created ?? '') < (earliestAction.created ?? '')) {
-                earliestAction = action;
-            }
-        }
+        const sortedActions = getSortedReportActions(Object.values(reportActions));
+        const reportAction = sortedActions.find(
+            (action) =>
+                action.actionName === CONST.REPORT.ACTIONS.TYPE.REPORT_PREVIEW &&
+                action.childReportID &&
+                hasMissingInvoiceBankAccount(action.childReportID) &&
+                !isSettled(action.childReportID),
+        );
 
-        return earliestAction
+        return reportAction
             ? {
                   reason: CONST.REQUIRES_ATTENTION_REASONS.HAS_MISSING_INVOICE_BANK_ACCOUNT,
-                  reportAction: earliestAction,
+                  reportAction,
               }
             : null;
     }

src/libs/actions/IOU/ReportWorkflow.ts

@@ -17,7 +17,7 @@ import Navigation from '@libs/Navigation/Navigation';
 import {getIsOffline} from '@libs/NetworkState';
 import {buildNextStepNew, buildOptimisticNextStep} from '@libs/NextStepUtils';
 import {arePaymentsEnabled, getSubmitReportManagerAccountID, hasDynamicExternalWorkflow, isPaidGroupPolicy, isPolicyAdmin, isSubmitAndClose} from '@libs/PolicyUtils';
-import {getAllReportActions, getReportActionHtml, getReportActionText, hasPendingDEWApprove, isCreatedAction, isDeletedAction} from '@libs/ReportActionsUtils';
+import {getAllReportActions, getReportActionHtml, getReportActionText, getSortedReportActions, hasPendingDEWApprove, isCreatedAction, isDeletedAction} from '@libs/ReportActionsUtils';
 import {
     buildOptimisticApprovedReportAction,
     buildOptimisticChangeApproverReportAction,
@@ -308,21 +308,19 @@ function getIOUReportActionWithBadge(
     const chatReportActions = getAllReportActionsFromIOU()?.[`${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${chatReport?.reportID}`] ?? {};
 
     let actionBadge: ValueOf<typeof CONST.REPORT.ACTION_BADGE> | undefined;
-    let reportAction: OnyxEntry<ReportAction>;
-    for (const action of Object.values(chatReportActions)) {
+    const sortedActions = getSortedReportActions(Object.values(chatReportActions));
+    const reportAction = sortedActions.find((action) => {
         if (action?.actionName !== CONST.REPORT.ACTIONS.TYPE.REPORT_PREVIEW || isDeletedAction(action)) {
-            continue;
+            return false;
         }
         const iouReport = getReportOrDraftReport(action.childReportID);
         const badge = getBadgeFromIOUReport(iouReport, chatReport, policy, reportMetadata, invoiceReceiverPolicy, currentUserLogin, currentUserAccountID);
-        if (!badge) {
-            continue;
-        }
-        if (!reportAction?.created || (action.created ?? '') < (reportAction.created ?? '')) {
-            reportAction = action;
+        if (badge) {
             actionBadge = badge;
+            return true;
         }
-    }
+        return false;
+    });
 
     return {reportAction, actionBadge};
 }

tests/actions/IOUTest/ReportWorkflowTest.ts

@@ -3500,6 +3500,96 @@ describe('actions/IOU/ReportWorkflow', () => {
             expect(result.actionBadge).toBeUndefined();
         });
 
+        it('should return the oldest matching report action when multiple actions have badges', async () => {
+            const chatReportID = '500';
+            const olderIouReportID = '501';
+            const newerIouReportID = '502';
+            const policyID = '503';
+
+            const fakePolicy: Policy = {
+                ...createRandomPolicy(Number(policyID)),
+                id: policyID,
+                type: CONST.POLICY.TYPE.TEAM,
+                approvalMode: CONST.POLICY.APPROVAL_MODE.BASIC,
+            };
+
+            const fakeChatReport: Report = {
+                ...createRandomReport(Number(chatReportID), CONST.REPORT.CHAT_TYPE.POLICY_EXPENSE_CHAT),
+                reportID: chatReportID,
+                policyID,
+            };
+
+            // Two submitted expense reports — both will produce APPROVE badges
+            const olderIouReport: Report = {
+                ...createRandomReport(Number(olderIouReportID), CONST.REPORT.CHAT_TYPE.POLICY_EXPENSE_CHAT),
+                reportID: olderIouReportID,
+                type: CONST.REPORT.TYPE.EXPENSE,
+                policyID,
+                stateNum: CONST.REPORT.STATE_NUM.SUBMITTED,
+                statusNum: CONST.REPORT.STATUS_NUM.SUBMITTED,
+                managerID: RORY_ACCOUNT_ID,
+            };
+
+            const newerIouReport: Report = {
+                ...createRandomReport(Number(newerIouReportID), CONST.REPORT.CHAT_TYPE.POLICY_EXPENSE_CHAT),
+                reportID: newerIouReportID,
+                type: CONST.REPORT.TYPE.EXPENSE,
+                policyID,
+                stateNum: CONST.REPORT.STATE_NUM.SUBMITTED,
+                statusNum: CONST.REPORT.STATUS_NUM.SUBMITTED,
+                managerID: RORY_ACCOUNT_ID,
+            };
+
+            const olderTransaction: Transaction = {
+                ...createRandomTransaction(0),
+                reportID: olderIouReportID,
+                amount: 100,
+                status: CONST.TRANSACTION.STATUS.POSTED,
+                bank: '',
+            };
+
+            const newerTransaction: Transaction = {
+                ...createRandomTransaction(1),
+                reportID: newerIouReportID,
+                amount: 200,
+                status: CONST.TRANSACTION.STATUS.POSTED,
+                bank: '',
+            };
+
+            await Onyx.set(`${ONYXKEYS.COLLECTION.POLICY}${policyID}`, fakePolicy);
+            await Onyx.set(`${ONYXKEYS.COLLECTION.REPORT}${chatReportID}`, fakeChatReport);
+            await Onyx.set(`${ONYXKEYS.COLLECTION.REPORT}${olderIouReportID}`, olderIouReport);
+            await Onyx.set(`${ONYXKEYS.COLLECTION.REPORT}${newerIouReportID}`, newerIouReport);
+            await Onyx.set(`${ONYXKEYS.COLLECTION.TRANSACTION}${olderTransaction.transactionID}`, olderTransaction);
+            await Onyx.set(`${ONYXKEYS.COLLECTION.TRANSACTION}${newerTransaction.transactionID}`, newerTransaction);
+
+            const olderReportPreview = {
+                reportActionID: 'older-preview',
+                actionName: CONST.REPORT.ACTIONS.TYPE.REPORT_PREVIEW,
+                created: '2024-08-08 18:00:00.000',
+                childReportID: olderIouReportID,
+                message: [{type: 'TEXT', text: 'Older report preview'}],
+            };
+
+            const newerReportPreview = {
+                reportActionID: 'newer-preview',
+                actionName: CONST.REPORT.ACTIONS.TYPE.REPORT_PREVIEW,
+                created: '2024-08-08 20:00:00.000',
+                childReportID: newerIouReportID,
+                message: [{type: 'TEXT', text: 'Newer report preview'}],
+            };
+
+            await Onyx.set(`${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${chatReportID}`, {
+                [newerReportPreview.reportActionID]: newerReportPreview,
+                [olderReportPreview.reportActionID]: olderReportPreview,
+            });
+            await waitForBatchedUpdates();
+
+            const result = getIOUReportActionWithBadge(fakeChatReport, fakePolicy, {}, undefined, RORY_EMAIL, RORY_ACCOUNT_ID);
+            expect(result.reportAction).toMatchObject(olderReportPreview);
+            expect(result.actionBadge).toBe(CONST.REPORT.ACTION_BADGE.APPROVE);
+        });
+
         it('should return undefined actionBadge when report is settled', async () => {
             const chatReportID = '400';
             const iouReportID = '401';