[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 contributors@expensify.com 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