[nkdengineer]

Details

Fixed Issues

$ #44924
PROPOSAL: #44924 (comment)

Tests

1. Go to a 1:1 Conversation. Make sure your seeing both account at the same time
2. As user A request money from User B
3. As user A go the IOU report that was just created and click on the Plus button to bring the menu
4. While the menu is still open Go to User B and Pay the expense
5. As user A click on "submit expense" on the menu that was opened in step 3.
6. Click the back button
7. Verify that: Clicking back takes you to the IOU report page

• Verify that no errors appear in the JS console

Offline tests

QA Steps

1. Go to a 1:1 Conversation. Make sure your seeing both account at the same time
2. As user A request money from User B
3. As user A go the IOU report that was just created and click on the Plus button to bring the menu
4. While the menu is still open Go to User B and Pay the expense
5. As user A click on "submit expense" on the menu that was opened in step 3.
6. Click the back button
7. Verify that: Clicking back takes you to the IOU report page

• 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: mWeb Chrome
  • iOS: Native
  • iOS: mWeb 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
  • 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 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(theme.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 the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
• If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
  • I verified that all the inputs inside a form are aligned with each other.
  • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
• 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.

Screenshots/Videos

Android: Native

android.mov

Android: mWeb Chrome

ios-mweb.mov

iOS: Native

ios.mov

iOS: mWeb Safari

ios-mweb.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

[melvin-bot]

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

[thesahindia]

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: mWeb Chrome
  • iOS: Native
  • iOS: mWeb 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
  • 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(theme.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 the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
• If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
  • I verified that all the inputs inside a form are aligned with each other.
  • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
• 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

Android: Native

Screen.Recording.2024-07-18.at.11.36.15.PM.mov

Android: mWeb Chrome

Screen.Recording.2024-07-19.at.12.52.56.AM.mov

iOS: Native

Screen.Recording.2024-07-19.at.1.51.28.AM.mov

iOS: mWeb Safari

Screen.Recording.2024-07-19.at.1.50.09.AM.mov

MacOS: Chrome / Safari

Screen.Recording.2024-07-18.at.11.25.44.PM.mov

MacOS: Desktop

Screen.Recording.2024-07-18.at.11.28.23.PM.mov

[thesahindia]

Looks good!

[roryabraham]

@nkdengineer reassure has been fixed on main. Can you please merge main?

[roryabraham]

hmmm looks like this might be a legitimate regression causing an extra render in ReportActionCompose

[nkdengineer]

Let me check again.

[thesahindia]

@nkdengineer, what you just did here isn't a good practice. You proposed that you will be solving two issues but ended up only fixing one.

We have two bugs here

1. When the expense is paid, the submit expense options doesn't disappear immediately. The RCA is we compare the menuItems prop wrong here so when it's changed, the component doesn't re-render.

App/src/components/PopoverMenu.tsx

Line 266 in b0947e0

!lodashIsEqual(prevProps.menuItems, nextProps.menuItems) &&

2. Clicking back "on page not found" page takes you to a workspace page
   . The RCA is in AccessOrNotFoundWrapper, we always go back to policy page when we click on back button if the policyID exists.

App/src/pages/workspace/AccessOrNotFoundWrapper.tsx

Line 98 in b0947e0

onBackButtonPress={() => Navigation.goBack(policyID ? ROUTES.WORKSPACE_PROFILE.getRoute(policyID) : undefined)}

The fix for the first issue caused a regression and you reverted it back without any explanation.
Shridhar had proposed a solution for the second issue before you and I would have selected that but since you were fixing another issue I went with yours. Now you have reverted the change instead of finding another solution. If we aren't fixing that issue then it won't be fair for Shridhar.

cc: @roryabraham for thoughts

[nkdengineer]

@thesahindia Sorry, I missed to give some updates.

1. I'm reverting some changes to test the perf-test to find what causing the error and I'm trying to resolve this with the change in my proposal.

Shridhar had #44924 (comment) a solution for the second issue before you and I would have selected that but since you were fixing another issue I went with yours. Now you have reverted the change instead of finding another solution. If we aren't fixing that issue then it won't be fair for Shridhar.

2. The proposal that you mentioned needs to pass shouldOpenProfileOnBackPress to many places meanwhile my proposal only needs to update in AccessOrNotFoundWrapper

[thesahindia]

1. I'm reverting some changes to test the perf-test to find what causing the error and I'm trying to resolve this with the change in my proposal.

Thanks for letting us know

2. The proposal that you mentioned needs to pass shouldOpenProfileOnBackPress to many places meanwhile my proposal only needs to update in AccessOrNotFoundWrapper

I agree that your approach is better but rejecting Shridher's proposal only based on that would have been wrong. I selected your proposal because it was also adding an improvement.

Let's find a solution for that issue.

[nkdengineer]

@roryabraham I checked the perf-test again and the only problem is ReportActionComposer is re-render
more times. Is this acceptable.

[nkdengineer]

@roryabraham The perf-test is fixed by only comparing the length of menuItems. Do you agree with that?

[roryabraham]

No, I don't think just checking the length of menuItems is safe, because if the content changes we'd need to re-render the popover

[roryabraham]

I'm not sure that one extra render in Composer should be treated as a blocker though. We can always merge through failing Reassure if we agree it's an acceptable cost to fix the bug

[nkdengineer]

@roryabraham In the past we didn't re-render if the menuItems is changed so I think it's fine if we only compare the length of menuItems here.

Or If we agree with more re-rendering, I will add the previous change back.

[roryabraham]

In the past we didn't re-render if the menuItems is changed

What makes you say that? It looks like it was using a deep equality comparison in the React.memo?

[nkdengineer]

@roryabraham Because we used !lodashIsEqual(prevProps.menuItems, nextProps.menuItems) not lodashIsEqual(prevProps.menuItems, nextProps.menuItems)

[roryabraham]

Pretty sure !lodashIsEqual was a bug before, since the 2nd arg to React.memo should return true if the props are equal

[OSBotify]

✋ 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]

🚀 Cherry-picked to staging by https://github.com/roryabraham in version: 9.0.14-1 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

[OSBotify]

🚀 Deployed to production by https://github.com/roryabraham in version: 9.0.14-6 🚀

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