[Due for payment 2025-04-02] [$250] [Dev] Console Error: A props object containing a "key" prop is being spread into JSX

[m-natarajan]

If you haven’t already, check out our contributing guidelines for onboarding and email [email protected] to request to join our Slack channel!

---

Version Number: v9.1.10-3 Develop
Reproducible in staging?: Needs Reproduction
Reproducible in production?: Needs Reproduction
If this was caught on HybridApp, is this reproducible on New Expensify Standalone?:
If this was caught during regression testing, add the test name, ID and link from TestRail:
Email or phone of affected tester (no customers):
Logs: https://stackoverflow.com/c/expensify/questions/4856
Expensify/Expensify Issue URL:
Issue reported by: @QichenZhu
Slack conversation (hyperlinked to channel name): #Expensify Bugs

Action Performed:

1. Log in to the development HybridApp on Android or iOS.
2. Go to the Reports page.

Expected Result:

No console errors on the Reports page.

Actual Result:

Console Error: A props object containing a "key" prop is being spread into JSX.

Workaround:

Unknown

Platforms:

Which of our officially supported platforms is this issue occurring on?

• Android: Standalone
• Android: HybridApp
• Android: mWeb Chrome
• iOS: Standalone
• iOS: HybridApp
• iOS: mWeb Safari
• MacOS: Chrome / Safari
• MacOS: Desktop

Screenshots/Videos

Add any screenshot/video evidence

View all open jobs on GitHub

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~021899899286639282267
• Upwork Job ID: 1899899286639282267
• Last Price Increase: 2025-03-12

Issue Owner

Current Issue Owner: @dominictb

[melvin-bot]

Triggered auto assignment to @isabelastisser (Bug), see https://stackoverflow.com/c/expensify/questions/14418 for more details. Please add this bug to a GH project, as outlined in the SO.

[MelvinBot]

This has been labelled "Needs Reproduction". Follow the steps here: https://stackoverflowteams.com/c/expensify/questions/16989

[dominictb]

@isabelastisser I can reproduce this with the following steps:

Precondition: Have saved search items. If you don't, create some.

1. Open Reports tab
2. The console error shows up

Please assign this to me as per this Slack thread.

[github-actions]

⚠️ @Shahidullah-Muffakir Thanks for your proposal. Please update it to follow the proposal template, as proposals are only reviewed if they follow that format (note the mandatory sections).

[Shahidullah-Muffakir]

Proposal

Please re-state the problem that we are trying to solve in this issue.

We're seeing console errors on the Reports page stating "A props object containing a 'key' prop is being spread into JSX.

What is the root cause of that problem?

The SavedSearchMenuItem type includes a key property. When these menu items are mapped in the PopoverMenu component, all properties including key are spread into the JSX using {...menuItemProps}. React treats key as a special prop that shouldn't be passed to components, which causes the console error.

App/src/components/PopoverMenu.tsx

Line 304 in 80cbd29

{...menuItemProps}

App/src/components/Search/SearchPageHeader/SearchTypeMenuPopover.tsx

Lines 32 to 37 in 80cbd29

	type SavedSearchMenuItem = MenuItemWithLink & {
	key: string;
	hash: string;
	query: string;
	styles?: Array<ViewStyle | TextStyle>;
	};

What changes do you think we should make in order to solve the problem?

We should keep the key property for identification purposes but prevent it from being passed as a prop to React components. There are 4 options:

1. In SearchTypeMenuPopover.tsx, rename the key property in SavedSearchMenuItem to something like itemKey or searchKey and update all references to use this new name.

type SavedSearchMenuItem = MenuItemWithLink & {
    itemKey: string; // Changed from 'key' to 'itemKey'
    hash: string;
    query: string;
    styles?: Array<ViewStyle | TextStyle>;
};

2. Alternatively, we can distructure the Key separately here, so it won't be passed in the props spreading:
   Update this:

   App/src/components/PopoverMenu.tsx

   Line 271 in 80cbd29

   const renderedMenuItems = currentMenuItems.map((item, menuIndex) => {

   
   as:

const renderedMenuItems = currentMenuItems.map(({ key, ...item }, menuIndex)

3. Alternatively, we can remove the 'key' prop dynamically, as the key prop is already passed, update this:

   App/src/components/PopoverMenu.tsx

   Line 304 in 80cbd29

   {...menuItemProps}

to this:

                {...Object.fromEntries(Object.entries(menuItemProps).filter(([key]) => key !== 'key'))} 

4. Alternatively, in PopoverMenu.tsx, we could extract and use the key for React's list rendering but exclude it from props spreading:

const renderedMenuItems = currentMenuItems.map((item, menuIndex) => {
    const {text, onSelected, subMenuItems, shouldCallAfterModalHide, key, ...menuItemProps} = item;
    return (
        <OfflineWithFeedback
             key={key || `${item.text}_${menuIndex}`}
            pendingAction={item.pendingAction}
        >
            <FocusableMenuItem
                  key={key || `${item.text}_${menuIndex}`}
                pressableTestID={`PopoverMenuItem-${item.text}`}
                title={text}
                onPress={() => selectItem(menuIndex)}
                // other props...
                {...menuItemProps}
            />
        </OfflineWithFeedback>
    );
});

What specific scenarios should we cover in automated tests to prevent reintroducing this issue in the future?

We can write test to ensure the menuItemProps does not have key prop in it, while passing it here:

App/src/components/PopoverMenu.tsx

Line 304 in 80cbd29

{...menuItemProps}

What alternative solutions did you explore? (Optional)

[daledah]

Proposal

Please re-state the problem that we are trying to solve in this issue.

Console Error: A props object containing a "key" prop is being spread into JSX.

What is the root cause of that problem?

SavedSearchMenuItem has a key prop:

App/src/components/Search/SearchPageHeader/SearchTypeMenuPopover.tsx

Line 33 in 80cbd29

key: string;

When adding saved search to menu items all props are passed

App/src/components/Search/SearchPageHeader/SearchTypeMenuPopover.tsx

Line 195 in 80cbd29

items.push(...savedSearchItems);

So when rendering Popover menu the key props is also passed

App/src/components/PopoverMenu.tsx

Line 304 in 80cbd29

{...menuItemProps}

What changes do you think we should make in order to solve the problem?

I don't see any use of key for SavedSearchMenuItem, so we can simply remove this prop.

Additionally, there are two similar SavedSearchMenuItem defined:

App/src/components/Search/SearchPageHeader/SearchTypeMenuPopover.tsx

Lines 32 to 37 in 80cbd29

	type SavedSearchMenuItem = MenuItemWithLink & {
	key: string;
	hash: string;
	query: string;
	styles?: Array<ViewStyle | TextStyle>;
	};

App/src/libs/SearchUIUtils.ts

Lines 102 to 107 in 80cbd29

	type SavedSearchMenuItem = MenuItemWithLink & {
	key: string;
	hash: string;
	query: string;
	styles?: Array<ViewStyle | TextStyle>;
	};

So we should DRY code and use type from SearchUIUtils.ts only.

What specific scenarios should we cover in automated tests to prevent reintroducing this issue in the future?

This is a typecast error so I think no test is required

What alternative solutions did you explore? (Optional)

NA

Reminder: Please use plain English, be brief and avoid jargon. Feel free to use images, charts or pseudo-code if necessary. Do not post large multi-line diffs or write walls of text. Do not create PRs unless you have been hired for this job.

[melvin-bot]

Job added to Upwork: https://www.upwork.com/jobs/~021899899286639282267

[melvin-bot]

Triggered auto assignment to Contributor-plus team member for initial proposal review - @ntdiary (External)

[dominictb]

@isabelastisser You might have missed to assign me 😄

[dominictb]

@daledah @Shahidullah-Muffakir Can you confirm if we can safely remove the key (or rename key to itemKey) from SavedSearchMenuItem? Let's find out why it was added at the beginning and where it is used currently.

[daledah]

@dominictb

SavedSearchMenuItems is used in two places:

• In SearchTypeMenuPopover, where we have the bug in this issue
• In SearchTypeMenu, where an array of SavedSearchMenuItems is passed to MenuItemList:

App/src/pages/Search/SearchTypeMenu.tsx

Line 159 in 925c0fe

menuItems={menuItems}

Then in MenuItemList, key prop is used in two places:

App/src/components/MenuItemList.tsx

Line 78 in 925c0fe

key={key ?? menuItemProps.title}

App/src/components/MenuItemList.tsx

Line 85 in 925c0fe

key={key ?? menuItemProps.title}

But both places already have fallback value to be title.

I also ran all tests with the key prop removed and passed all of them. So I believe key prop is not in use here.

The prop was added in #56326. I don't see any place mentioned this, so I asked the author here

[ntdiary]

@isabelastisser, can you please help unassign me? seems I can't unassign myself. :D

[melvin-bot]

Triggered auto assignment to @mollfpr, see https://stackoverflow.com/c/expensify/questions/7972 for more details.

[mollfpr]

@Shahidullah-Muffakir proposal looks good to me! Assigning!

[Shahidullah-Muffakir]

PR is ready for review.
cc. @dominictb

[mvtglobally]

Issue not reproducible during KI retests. (First week)

[melvin-bot]

Reviewing label has been removed, please complete the "BugZero Checklist".

[melvin-bot]

The solution for this issue has been 🚀 deployed to production 🚀 in version 9.1.18-4 and is now subject to a 7-day regression period 📆. Here is the list of pull requests that resolve this issue:

• Fix console error by excluding "key" prop from props spreading #58865

If no regressions arise, payment will be issued on 2025-04-02. 🎊

For reference, here are some details about the assignees on this issue:

• @Shahidullah-Muffakir requires payment (Needs manual offer from BZ)
• @dominictb requires payment (Needs manual offer from BZ)

[melvin-bot]

@dominictb @isabelastisser @dominictb The PR fixing this issue has been merged! The following checklist (instructions) will need to be completed before the issue can be closed. Please copy/paste the BugZero Checklist from here into a new comment on this GH and complete it. If you have the K2 extension, you can simply click: [this button]

[dominictb]

BugZero Checklist:

• [Contributor] Classify the bug:

Bug classification

Source of bug:

• 1a. Result of the original design (eg. a case wasn't considered)
• 1b. Mistake during implementation
• 1c. Backend bug
• 1z. Other:

Where bug was reported:

• 2a. Reported on production (eg. bug slipped through the normal regression and PR testing process on staging)
• 2b. Reported on staging (eg. found during regression or PR testing)
• 2d. Reported on a PR
• 2z. Other:

Who reported the bug:

• 3a. Expensify user
• 3b. Expensify employee
• 3c. Contributor
• 3d. QA
• 3z. Other:

• [Contributor] The offending PR has been commented on, pointing out the bug it caused and why, so the author and reviewers can learn from the mistake.

  Link to comment: Add search input to mobile search page(with fixed performance) #56326 (comment)

• [Contributor] If the regression was CRITICAL (e.g. interrupts a core flow) A discussion in #expensify-open-source has been started about whether any other steps should be taken (e.g. updating the PR review checklist) in order to catch this type of bug sooner.

  Link to discussion: NA

• [Contributor] If it was decided to create a regression test for the bug, please propose the regression test steps using the template below to ensure the same bug will not reach production again.

  No regression test is needed because this is a dev-only issue.

[melvin-bot]

Payment Summary

Upwork Job

• ROLE: @Shahidullah-Muffakir paid $(AMOUNT) via Upwork (LINK)
• ROLE: @dominictb paid $(AMOUNT) via Upwork (LINK)

BugZero Checklist (@isabelastisser)

• I have verified the correct assignees and roles are listed above and updated the necessary manual offers
• I have verified that there are no duplicate or incorrect contracts on Upwork for this job (https://www.upwork.com/ab/applicants/1899899286639282267/hired)
• I have paid out the Upwork contracts or cancelled the ones that are incorrect
• I have verified the payment summary above is correct

[isabelastisser]

Payment summary:

Contributor @Shahidullah-Muffakir paid $250 via Upwork https://www.upwork.com/nx/wm/offer/106762783
C+ @dominictb $250 pending in Upwork. https://www.upwork.com/jobs/~021899899286639282267

[isabelastisser]

@dominictb what's your Upwork profile?

[dominictb]

@isabelastisser My Upwork profile is https://www.upwork.com/freelancers/~01f70bed1934fd35d5. Could you please send an offer? TIA!

[melvin-bot]

@dominictb Whoops! This issue is 2 days overdue. Let's get this updated quick!

[isabelastisser]

@dominictb, I messaged you in Upwork.