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

Update Who Paid section when can modify participants #21945

Merged
merged 4 commits into from
Jul 6, 2023

Conversation

ginsuma
Copy link
Contributor

@ginsuma ginsuma commented Jun 30, 2023

Details

Web - Mouse cursor is shown as hand icon (on a not clickable section) on who paid, split bill.

Fixed Issues

$ #21695
PROPOSAL: #21695 (comment)

Tests

  1. Click Global Create or FAB (+) -> new group -> select members.
  2. Click create group.
  3. Now it should show a new group page.
  4. Click Actions Button (+) on the Composer -> Split Bill -> type the amount -> next.
  5. Hover over the "Who paid?" section and verify the cursor is the not-allowed (disabled) style.
  • Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Same as tests

  • 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
Screen.Recording.2023-07-06.at.9.14.09.PM.mp4
Mobile Web - Safari
ios_safari.mov
Mobile Web - Chrome
android_chrome.mov
Desktop
Screen.Recording.2023-07-06.at.9.17.31.PM.mp4
iOS
ios.mov
Android
android_app.mov

@ginsuma ginsuma requested a review from a team as a code owner June 30, 2023 11:42
@melvin-bot melvin-bot bot requested review from chiragsalian and removed request for a team June 30, 2023 11:43
@melvin-bot
Copy link

melvin-bot bot commented Jun 30, 2023

@chiragsalian 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]

@Santhosh-Sellavel
Copy link
Collaborator

Santhosh-Sellavel commented Jun 30, 2023

@chiragsalian please assign me as reviewer, seems the contributor linked issue improperly.

@amyevans amyevans requested review from Santhosh-Sellavel and amyevans and removed request for chiragsalian June 30, 2023 14:41
@Santhosh-Sellavel
Copy link
Collaborator

Santhosh-Sellavel commented Jun 30, 2023

@ginsuma This looks really over-engineered, this was not the proposal which was approved. Seems you updated the proposal after assigning you.

Can you explain why you made these changes?

cc: @amyevans

@ginsuma
Copy link
Contributor Author

ginsuma commented Jun 30, 2023

@Santhosh-Sellavel According that conversation, I think I should make like the video.
Screen Shot 2023-07-01 at 12 47 21 AM

But if you want to make like the previous proposal like below, I can update.
image

@Santhosh-Sellavel
Copy link
Collaborator

Maybe I miss understood, We can select the user by clicking anywhere in the row, showing disabled only there near the check mark alone does not make sense and it's kind of misleading as we still show the cursor over the user name. Disabling the whole row should be good only when it's from a group.

cc: @amyevans any thoughts?

@ginsuma
Copy link
Contributor Author

ginsuma commented Jun 30, 2023

Please check and correct me if I'm wrong. That is how the previous proposal looks.

Split from Group
Split.from.Group.mov
Split from FAB
Split.From.FAB.mov

@Santhosh-Sellavel
Copy link
Collaborator

Santhosh-Sellavel commented Jun 30, 2023

Yes looks good 👍

Please check the above and confirm. Let's be sure that our OP expectations are aligned

cc: @shawnborton @amyevans

@ginsuma
Copy link
Contributor Author

ginsuma commented Jul 3, 2023

Quick bump for confirmation @shawnborton @amyevans .

@shawnborton
Copy link
Contributor

I think this makes sense, so all good on my end. Curious for @amyevans's thoughts too.

@ginsuma
Copy link
Contributor Author

ginsuma commented Jul 3, 2023

I think I can continue my work. She asked you about what we should proceed before.

@ginsuma
Copy link
Contributor Author

ginsuma commented Jul 3, 2023

@Santhosh-Sellavel I have just pushed commit, and updated screenshots/videos.

@Santhosh-Sellavel
Copy link
Collaborator

Santhosh-Sellavel commented Jul 3, 2023

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 & Desktop
Screen.Recording.2023-07-04.at.1.17.24.AM.mov
Mobile Web - Chrome && Mobile Web - Safari
Screen.Recording.2023-07-05.at.3.02.06.AM.mov
iOS & Android
Screen.Recording.2023-07-06.at.3.19.37.AM.mov

@Santhosh-Sellavel
Copy link
Collaborator

Santhosh-Sellavel commented Jul 3, 2023

@ginsuma Fix the lint checks.

Make sure you linked the issue properly issue as follows

$ https://github.com/Expensify/App/issues/21695 not as #21695

In preview, both will look like #21695 so don't get confused!

Tests steps could be improved

Step 1

Instead of
Go to '+" -> new .....

Modify as

Click Global Create or FAB (+) -> new...

For Step 4

Click Actions Button (+) on the Composer -> Split ....

@@ -132,6 +132,7 @@ function MoneyRequestConfirmationList(props) {

const selectedParticipants = useMemo(() => _.filter(props.participants, (participant) => participant.selected), [props.participants]);
const payeePersonalDetails = useMemo(() => props.payeePersonalDetails || props.currentUserPersonalDetails, [props.payeePersonalDetails, props.currentUserPersonalDetails]);
const canModifyParticipants = !props.isReadOnly && props.canModifyParticipants && props.hasMultipleParticipants;
Copy link
Collaborator

Choose a reason for hiding this comment

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

Can we have a better naming here canModifyParticipants off as we are not modifying who paid anyway?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

How's about shouldDisableWhoPaidSection?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Okayish make the changes, 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.

I made it, thank you.

@ginsuma ginsuma requested a review from Santhosh-Sellavel July 4, 2023 13:34
Copy link
Collaborator

@Santhosh-Sellavel Santhosh-Sellavel left a comment

Choose a reason for hiding this comment

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

LGTM, All your @amyevans!

getParticipantsWithAmount,
selectedParticipants,
payeePersonalDetails,
translate,
Copy link
Collaborator

Choose a reason for hiding this comment

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

Not sure why we need translate here.

NAB (as it's not added here)

Copy link
Contributor

Choose a reason for hiding this comment

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

It gets flagged as a missing dependency by the linter otherwise (of course we could ignore the linter in this case, but I think it's fine to just include it).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

translate is a prop from withLocalize, and it is used in above useMemo.
When user change their language from another tab/window, it should update the title in section.

Copy link
Contributor

Choose a reason for hiding this comment

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

Oh interesting, thanks for calling that out. I was previously under the impression that including translate in the dependency array was in case the function changed, not what the function returns 🙃

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, you're right. Maybe the below make it clear.

// Destructure functions from props to pass it as a dependecy to useCallback/useMemo hooks.
// Prop functions pass props itself as a "this" value to the function which means they change every time props change.
const {translate, onSendMoney, onConfirm, onSelectParticipant} = props;

Copy link
Contributor

@amyevans amyevans left a comment

Choose a reason for hiding this comment

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

Code looks good, but let's update step 5 of the test for clarity. Instead of

Notice who paid? card section, the cursor is shown as the mouse pointer

Perhaps this:

Hover over the who paid? section and verify the cursor is the not-allowed (disabled) style

Also your web/desktop recordings are outdated (based on first iteration of code), so please update those

getParticipantsWithAmount,
selectedParticipants,
payeePersonalDetails,
translate,
Copy link
Contributor

Choose a reason for hiding this comment

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

It gets flagged as a missing dependency by the linter otherwise (of course we could ignore the linter in this case, but I think it's fine to just include it).

@ginsuma
Copy link
Contributor Author

ginsuma commented Jul 6, 2023

Code looks good, but let's update step 5 of the test for clarity. Instead of

Notice who paid? card section, the cursor is shown as the mouse pointer

Perhaps this:

Hover over the who paid? section and verify the cursor is the not-allowed (disabled) style

Also your web/desktop recordings are outdated (based on first iteration of code), so please update those

I updated it. Thank you.

@amyevans amyevans merged commit b595101 into Expensify:main Jul 6, 2023
@OSBotify
Copy link
Contributor

OSBotify commented Jul 6, 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 7, 2023

🚀 Deployed to staging by https://github.com/amyevans in version: 1.3.38-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/francoisl in version: 1.3.38-7 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 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.

5 participants