Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Migrate MoneyRequestParticipantsSplitSelector.js to function component #20271

Conversation

multijump
Copy link
Contributor

@multijump multijump commented Jun 6, 2023

Details

Migrate MoneyRequestParticipantsSplitSelector.js to function component

Fixed Issues

$ #16280
PROPOSAL: (#16280 (comment))

Tests

  1. Click on FAB
  2. Click on Split Money
  3. Input money (ex: 15)
  4. Click on Next button
  5. Search Email or Name
  6. Choose more than 1 user
  7. Choose 8 users as maximum.
  8. Click on Split $15 button
  9. Showed split request in chat
  • Verify that no errors appear in the JS console

Offline tests

Follow the same steps listed in the section above

QA Steps

Follow the same steps listed in the section above

  • Verify that no errors appear in the JS console

PR Author Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
    • I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android / native
    • Android / Chrome
    • iOS / native
    • iOS / Safari
    • MacOS / Chrome / Safari
    • MacOS / Desktop
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I followed proper code patterns (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
    • I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
      • If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • If a new component is created I verified that:
    • A similar component doesn't exist in the codebase
    • All props are defined accurately and each prop has a /** comment above it */
    • The file is named correctly
    • The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
    • The only data being stored in the state is data necessary for rendering and nothing else
    • For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
    • Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
    • All JSX used for rendering exists in the render method
    • The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG))
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
  • I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web
Web.mov
Mobile Web - Chrome
Mobile.Web.-.Chrome.mov
Mobile Web - Safari
Mobile.Web.-.Safari.mov
Desktop
Desktop.mov
iOS
iOS.mov
Android
Android.mov

@multijump multijump requested a review from a team as a code owner June 6, 2023 14:36
@github-actions
Copy link
Contributor

github-actions bot commented Jun 6, 2023

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

@melvin-bot melvin-bot bot requested review from marcaaron and removed request for a team June 6, 2023 14:36
@melvin-bot
Copy link

melvin-bot bot commented Jun 6, 2023

@marcaaron Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

@multijump
Copy link
Contributor Author

I have read the CLA Document and I hereby sign the CLA

personalDetails,
userToInvite
});
}, [props.betas, props.reports, props.participants, props.personalDetails, searchTerm])
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @multijump, I think we should re-render if props.translate changes also.

i.e. if the language is changed on device B, device A should re-render.
Does that make sense?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi, @rushatgabhane
Yes, that make sense.
just updated following your instruction.
Thanks.

Copy link
Member

@rushatgabhane rushatgabhane left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@multijump keyboard navigation isn't working on split bill page

@multijump
Copy link
Contributor Author

multijump commented Jun 9, 2023

@multijump keyboard navigation isn't working on split bill page

Hi, @rushatgabhane
As you can see, It seems keyboard navigation is not related with this issue.

return (
      <View style={[styles.flex1, styles.w100, props.participants.length > 0 ? props.safeAreaPaddingBottomStyle : {}]}>
          <OptionsSelector
              canSelectMultipleOptions
              sections={sections}
              selectedOptions={props.participants}
              value={searchTerm}
              onSelectRow={toggleOption}
              onChangeText={setSearchTerm}
              headerMessage={headerMessage}
              boldStyle
              shouldShowConfirmButton
              confirmButtonText={props.translate('common.next')}
              onConfirmSelection={finalizeParticipants}
              textInputLabel={props.translate('optionsSelector.nameEmailOrPhoneNumber')}
              safeAreaPaddingBottomStyle={props.safeAreaPaddingBottomStyle}
              shouldShowOptions={isOptionsDataReady}
          />
      </View>
  );

I think it is related with OptionsSelector component.
Should I change the OptionsSelector component too?

@rushatgabhane
Copy link
Member

@multijump it's failing on this PR only, right?

If It's working on main then we need to fix it

@multijump
Copy link
Contributor Author

@rushatgabhane
Actually, keyboard navigation in this branch is working the same as https://new.expensify.com/split/new
I am not sure what was the keyboard navigation you mean.
can you please let me know failed case?

@rushatgabhane
Copy link
Member

@multijump @Julesssss sorry im out sick and won't be able to review this PR in time.

@allroundexperts on c+ channel said that they're taking over, thanks!

@Julesssss
Copy link
Contributor

Julesssss commented Jun 12, 2023

Hey @allroundexperts, just wanted to double check your taking over the review? If so I'll update the linked issue.

@allroundexperts
Copy link
Contributor

Hey @allroundexperts, just wanted to double check your taking over the review? If so I'll update the linked issue.

Yes. I'll be reviewing this today.

personalDetails,
userToInvite,
});
props.onAddParticipants(newSelectedOptions);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why are you changing the order here?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi, @allroundexperts
There was not special reason.
I thought simply props change (for participants) doesn't affect to toggleOption function running so it doesn't matter where it is.
But I thought changing order was more readable and understandable.
If you require to change the order, I will change it.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's very difficult to compare the before and after code with the order changed. Can you please change the order as it was previously? Thanks!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi, @allroundexperts
Restored order per your request.

Comment on lines 147 to 151
setNewChatOptions({
recentReports,
personalDetails,
userToInvite,
});
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please use this inside the callback like it was being done previously.

Copy link
Contributor Author

@multijump multijump Jun 20, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@allroundexperts
This setState doesn't depend on previous state so previousState will be the unused variable.
Do we need to implement to use the callback?

Comment on lines 156 to 160
* Once a single or more users are selected, navigates to next step
*/
const finalizeParticipants = () => {
props.onStepComplete();
};
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Again, why is the order being changed here?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi, @allroundexperts
There is no reason.
I paid more attention to convert toggleOption and getSections function because these functions are main functions in this component.
So I converted them first and then finalizeParticipants.
That's why changed the order.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just for my understanding, why don't we use withCallback here? I assume it's not necessary, but I'm still trying to understand hooks.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we don't need to even wrap this inside the function since the function does nothing other than calling the function supplied in the prop. @multijump can you please remove this and use the prop directly?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi, @allroundexperts
Updated to use the prop directly.

this.props.onStepComplete();
}
return newSections;
// eslint-disable-next-line react-hooks/exhaustive-deps -- props does not need to be a dependency as it will always exist
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why are you disabling this check?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image I got this warning when I checked lint. So I checked the useMemo and useCallback functions in other components and I noticed they did same comment. That's why I disabled it.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems like we're no longer disabling the check, but I think it dows make sense, right? We shouldn't update after ANY prop is changed, just specific ones?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's correct @Julesssss. We've added into dependency all the properties that should trigger a re-calculation of values in the function.

setSearchTerm('');
}
},
// eslint-disable-next-line react-hooks/exhaustive-deps -- props does not need to be a dependency as it will always exist
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same question

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I got a warning when I checked lint. So I checked the useMemo and useCallback functions in other components and I noticed they did same comment. That's why I disabled it.

@allroundexperts
Copy link
Contributor

@multijump It's looking good largely. Can you please resolve the conflict and reply to a few more comments?

@multijump
Copy link
Contributor Author

@multijump It's looking good largely. Can you please resolve the conflict and reply to a few more comments?

Hi, @allroundexperts
I fixed conflicts and replied to your comments.
Thanks

@allroundexperts
Copy link
Contributor

@multijump It's looking good largely. Can you please resolve the conflict and reply to a few more comments?

Hi, @allroundexperts I fixed conflicts and replied to your comments. Thanks

Thanks @multijump!
I am on it now.

@allroundexperts
Copy link
Contributor

Reviewer Checklist

  • I have verified the author checklist is complete (all boxes are checked off).
  • I verified the correct issue is linked in the ### Fixed Issues section above
  • I verified testing steps are clear and they cover the changes made in this PR
    • I verified the steps for local testing are in the Tests section
    • I verified the steps for Staging and/or Production testing are in the QA steps section
    • I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
  • I checked that screenshots or videos are included for tests on all platforms
  • I included screenshots or videos for tests on all platforms
  • I verified tests pass on all platforms & I tested again on:
    • Android / native
    • Android / Chrome
    • iOS / native
    • iOS / Safari
    • MacOS / Chrome / Safari
    • MacOS / Desktop
  • If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
  • I verified proper code patterns were followed (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
    • I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I verified that this PR follows the guidelines as stated in the Review Guidelines
  • I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
  • If a new component is created I verified that:
    • A similar component doesn't exist in the codebase
    • All props are defined accurately and each prop has a /** comment above it */
    • The file is named correctly
    • The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
    • The only data being stored in the state is data necessary for rendering and nothing else
    • For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
    • Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
    • All JSX used for rendering exists in the render method
    • The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG)
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Web
Screen.Recording.2023-06-24.at.3.08.33.AM.mov
Mobile Web - Chrome
Screen.Recording.2023-06-24.at.3.25.06.AM.mov
Mobile Web - Safari
Screen.Recording.2023-06-24.at.3.24.23.AM.mov
Desktop
Screen.Recording.2023-06-24.at.3.12.27.AM.mov
iOS
Screen.Recording.2023-06-24.at.3.26.18.AM.mov
Android
Screen.Recording.2023-06-24.at.3.29.56.AM.mov

Copy link
Contributor

@allroundexperts allroundexperts left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking good. Thanks for the changes and your patience @multijump!

@melvin-bot melvin-bot bot requested a review from Julesssss June 23, 2023 22:41
@allroundexperts
Copy link
Contributor

Actually, we had another discussion here and it was decided that we'll be favouring prop de-structuring instead disabling the exhastive-dependency lint rule. @multijump Can you please make the changes? Should be fairly quick.

@multijump
Copy link
Contributor Author

Actually, we had another discussion here and it was decided that we'll be favouring prop de-structuring instead disabling the exhastive-dependency lint rule. @multijump Can you please make the changes? Should be fairly quick.

Hi, @allroundexperts
Destructured props and removed lint disable.

@Julesssss
Copy link
Contributor

@allroundexperts could you please resolve the threads that have been addressed, thanks.

@allroundexperts
Copy link
Contributor

@allroundexperts could you please resolve the threads that have been addressed, thanks.

@Julesssss All threads have been fixed. I can not resolve them because I just commented on the lines.

@Expensify Expensify deleted a comment from rushatgabhane Jul 4, 2023
@Julesssss
Copy link
Contributor

Tests well

@Julesssss Julesssss merged commit e23cd16 into Expensify:main Jul 4, 2023
@OSBotify
Copy link
Contributor

OSBotify commented Jul 4, 2023

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

@OSBotify
Copy link
Contributor

OSBotify commented Jul 5, 2023

🚀 Deployed to staging by https://github.com/Julesssss in version: 1.3.37-0 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 web 🕸 success ✅

@allroundexperts
Copy link
Contributor

@Julesssss This took a lot of time to review back and forth. If possible, can we please consider bumping this to our standard bounty price of $1k?

@Julesssss
Copy link
Contributor

I agree this took longer than average, but personally, I think that balances out against simpler reviews that still have the $1000 bounty. Also, I don't think the bounty itself should be updated, as it would encourage that a slower contributor PR ends up being paid more than a faster one.

If you disagree I'm happy to share with others internally though to get more peoples thoughts! Let me know what you think.

@allroundexperts
Copy link
Contributor

I agree this took longer than average, but personally, I think that balances out against simpler reviews that still have the $1000 bounty. Also, I don't think the bounty itself should be updated, as it would encourage that a slower contributor PR ends up being paid more than a faster one.

If you disagree I'm happy to share with others internally though to get more peoples thoughts! Let me know what you think.

Nopes. I agree with you 👍

@Julesssss
Copy link
Contributor

Great, thanks for understanding. Maybe the circumstances will be different next time 👍

@OSBotify
Copy link
Contributor

OSBotify commented Jul 7, 2023

🚀 Deployed to production by https://github.com/Julesssss in version: 1.3.37-7 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 failure ❌
🕸 web 🕸 success ✅

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants