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

Fix GBR and RBR show up at the same time in the LHN #18137

Merged
merged 3 commits into from
May 2, 2023

Conversation

hungvu193
Copy link
Contributor

Details

This PR fixes problem with GBR and RBR show up at the same time in the OptionRowLHN

Fixed Issues

$ #17912
PROPOSAL: #17912 (comment)

Tests

  1. Request money from userA to userB
  2. As userB notice the GBR indicator in the LHN
  3. Perform an action that will result in an error
  4. Verify that only RBR show up
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

  1. Request money from userA to userB
  2. As userB notice the GBR indicator in the LHN
  3. Perform an action that will result in an error
  4. Verify that only RBR show up
  • 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-04-28.at.16.21.19.mov
Mobile Web - Chrome
Screen.Recording.2023-04-28.at.16.18.21.mov
Mobile Web - Safari
Screen.Recording.2023-04-28.at.16.25.27.mov
Desktop
Screen.Recording.2023-04-28.at.16.30.11.mov
iOS
Screen.Recording.2023-04-28.at.16.36.23.mov
Android
Screen.Recording.2023-04-28.at.16.39.27.mov

@hungvu193 hungvu193 requested a review from a team as a code owner April 28, 2023 09:40
@melvin-bot melvin-bot bot requested review from luacmartins and mananjadhav and removed request for a team April 28, 2023 09:40
@MelvinBot
Copy link

@luacmartins @mananjadhav One of you needs to 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]

Copy link
Contributor

@luacmartins luacmartins left a comment

Choose a reason for hiding this comment

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

@hungvu193 can we also address this comment? We also have conflicts now.

@hungvu193
Copy link
Contributor Author

@luacmartins sure, I updated the PR.

@mananjadhav
Copy link
Collaborator

mananjadhav commented May 1, 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
web-one-dot-indicator.mov
web-lhs-indicator
Mobile Web - Chrome
mweb-chrome-one-dot-indicator.mov
mweb-chrome-lhs-indicator
Mobile Web - Safari
mweb-safari-one-dot-indicator.mov
mweb-safari-lhs-indicator.mov
Desktop
desktop-one-dot-indicator.mov
desktop-lhs-indicator
iOS
ios-one-dot-indicator.mov
ios-lhs-indicator.mov
Android
android-one-dot-indicator.mov
android-lhs-indicator.mov

mananjadhav
mananjadhav previously approved these changes May 1, 2023
@luacmartins
Copy link
Contributor

@hungvu193 Thanks for addressing my previous comment. As I mentioned before, we are still displaying the pinned icon and according to our new design, the green/red indicator should replace the pinned icon. Could you please address that?

Screenshot 2023-05-01 at 9 00 08 PM

@mananjadhav
Copy link
Collaborator

mananjadhav commented May 1, 2023

@luacmartins Sorry I didn't understand the change. Can you elaborate what we mean by should replace the pinned icon?

The comment mentioned here talks about removing the indicator from between the pin and pencil, but not about replacing?

@luacmartins
Copy link
Contributor

My comment comes from the new design doc and the section that introduced this behavior:

When an admin needs to pay a request, a green dot will appear on the expense/IOU report row for them. The report will also remain auto-pinned in the LHN until the report is settled, because they have an action they need to take.
Note: We replace the pin icon with the green dot icon in this case to minimize clutter in the LHN chat row.

@luacmartins
Copy link
Contributor

I thought that's what Shawn had mentioned in his comment, but I can see how that was confusing.

@hungvu193
Copy link
Contributor Author

When an admin needs to pay a request, a green dot will appear on the expense/IOU report row for them. The report will also remain auto-pinned in the LHN until the report is settled, because they have an action they need to take.
Note: We replace the pin icon with the green dot icon in this case to minimize clutter in the LHN chat row.

@luacmartins if we replace the pin icon in LHN when green dot is visible, should we need to replace the pin icon in the header inside LHN? I think it's confused for user when they didn't see the pin icon outside but still saw it inside of LHN.
Also the purpose of this PR was fixing the logic between RBR and GBR, do you think it's out of scope of this PR?

@luacmartins
Copy link
Contributor

@hungvu193 I don't think we should change the logic in the header, this should affect the LHN only. I think it's an easy enough change to incorporate in this PR.

@hungvu193
Copy link
Contributor Author

@luacmartins just to confirm, when the green dot is visible, we also need to hide the pin icon right?

@luacmartins
Copy link
Contributor

Yes

@hungvu193
Copy link
Contributor Author

@luacmartins Cool, I've updated the PR again.

@luacmartins
Copy link
Contributor

LGTM!

@luacmartins
Copy link
Contributor

@mananjadhav do you wanna review again since we changed some of the logic?

@mananjadhav
Copy link
Collaborator

@luacmartins I was just reviewing and testing it. I just want to confirm, if we have a RBR, we can always have Pin and Pencil icon right?

image

I tried accessing the design doc google link, but it says Access denied.

@luacmartins
Copy link
Contributor

@mananjadhav yes, that seems to be the expected behavior for RBR.

@mananjadhav
Copy link
Collaborator

@luacmartins I've updated the new screenshots on the same checklist here. Does that work?

@luacmartins
Copy link
Contributor

luacmartins commented May 2, 2023

Yea, that's good. Thank you!

@luacmartins luacmartins merged commit c9f6606 into Expensify:main May 2, 2023
@OSBotify
Copy link
Contributor

OSBotify commented May 2, 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.

height={variables.iconSizeNormal}
width={variables.iconSizeNormal}
src={Expensicons.DotIndicator}
fill={colors.green}
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 themeColors.success is better here.
@hungvu193 is there any reason for replacing with colors.green?

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 think that's from previous commit, cc @puneetlath, since I think that's diff from you

Copy link
Contributor

Choose a reason for hiding this comment

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

Nice catch @aimane-chnaif! We should not import colors directly 😬

Copy link
Contributor

Choose a reason for hiding this comment

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

I see that we are doing that in multiple places though. I think we should put up a PR to fix that.

Copy link
Contributor

Choose a reason for hiding this comment

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

Nice catch @aimane-chnaif! We should not import colors directly 😬

Agree, this is important for dark/light theme switch which will be implemented very soon

Copy link
Collaborator

Choose a reason for hiding this comment

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

I think we should create a separate issue for this.

Copy link
Contributor

Choose a reason for hiding this comment

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

Agree that we should be using success here

Copy link
Contributor

Choose a reason for hiding this comment

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

Ah weird. I thought I had changed this to success in a previous PR.

@OSBotify
Copy link
Contributor

OSBotify commented May 3, 2023

🚀 Deployed to staging by https://github.com/luacmartins in version: 1.3.9-12 🚀

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

@mountiny
Copy link
Contributor

mountiny commented May 4, 2023

@mananjadhav @hungvu193 @aimane-chnaif could you please test this in staging just to make sure, I think QA has tested it but forgot to check off the checklist.

@aimane-chnaif
Copy link
Contributor

Tests pass on staging

Screen.Recording.2023-05-04.at.8.13.51.AM.mov

One thing I noticed unusual - #18384 but it seems it's new expected behavior

@OSBotify
Copy link
Contributor

OSBotify commented May 9, 2023

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.12-0 🚀

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.

9 participants