[Due for payment 2025-03-27] [$125] Refactor showContextMenu to use a parameter object

[neil-marcellini]

As part of the tracking issue, and as advised in its description, refactor showContextMenu to use a parameter object.

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~021897773577658804259
• Upwork Job ID: 1897773577658804259
• Last Price Increase: 2025-03-06
• Automatic offers:
• mkzie2 | Contributor | 106461933

Issue Owner

Current Issue Owner: @slafortune

[melvin-bot]

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

[melvin-bot]

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

[melvin-bot]

Triggered auto assignment to @slafortune (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.

[adnit]

Proposal

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

The showContextMenu function currently accepts a long list of individual parameters, making it difficult to read, maintain, and extend. This approach can lead to errors when calling the function and makes the code less readable.

What is the root cause of that problem?

The root cause is that the showContextMenu function was designed to accept multiple individual parameters instead of a single parameter object. This design choice results in a cumbersome function signature and makes it harder to manage and understand the function's usage.

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

To solve this problem, we will refactor the showContextMenu function to accept a single parameter object. This will involve the following steps:

1. Define a new interface for the parameter object that includes all the current parameters of the showContextMenu function.
2. Update the showContextMenu function to accept a single parameter of the newly defined interface type.
3. Modify the function implementation to destructure the properties from the parameter object.
4. Update all calls to the showContextMenu function to pass an object instead of individual parameters.

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

To ensure the refactor does not introduce any regressions, we should cover the following scenarios in automated tests:

1. Basic Functionality: Verify that the showContextMenu function correctly displays the context menu with all the expected options when called with valid parameters.
2. Optional Parameters: Test the function with various combinations of optional parameters to ensure they are handled correctly and default values are applied where necessary.
3. Edge Cases: Test edge cases such as missing required parameters, null or undefined values, and invalid parameter types to ensure the function handles these gracefully.
4. Integration Tests: Verify that all components and functions that call showContextMenu are updated correctly and continue to work as expected after the refactor.

What alternative solutions did you explore? (Optional)

An alternative solution could be to refactor the function to use named parameters with default values, but this approach would still result in a long function signature and would not provide the same level of readability and maintainability as using a parameter object.

[melvin-bot]

📣 @adnit! 📣
Hey, it seems we don’t have your contributor details yet! You'll only have to do this once, and this is how we'll hire you on Upwork.
Please follow these steps:

1. Make sure you've read and understood the contributing guidelines.
2. Get the email address used to login to your Expensify account. If you don't already have an Expensify account, create one here. If you have multiple accounts (e.g. one for testing), please use your main account email.
3. Get the link to your Upwork profile. It's necessary because we only pay via Upwork. You can access it by logging in, and then clicking on your name. It'll look like this. If you don't already have an account, sign up for one here.
4. Copy the format below and paste it in a comment on this issue. Replace the placeholder text with your actual details.
   
   Format:

Contributor details
Your Expensify account email: <REPLACE EMAIL HERE>
Upwork Profile Link: <REPLACE LINK HERE>

[melvin-bot]

✅ Contributor details stored successfully. Thank you for contributing to Expensify!

[mkzie2]

Proposal

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

Refactor showContextMenu function to use a parameter object

What is the root cause of that problem?

Improvement

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

Wrap all parameters of this function into one object and in this object, we can have some sub-objects that will wrap the related data.

App/src/pages/home/report/ContextMenu/ReportActionContextMenu.ts

Line 104 in 8a019d4

function showContextMenu(

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

Just a refactor, no need the test

What alternative solutions did you explore? (Optional)