[CP Staging] fix: ReportScreen props not updating #35638

hurali97 · 2024-02-02T06:55:57Z

Details

This fixes the recent regression which happened due to some report properties not added to the memo. I have added _.isEqual(prevReport, nextReport) and the reason is that we in ReportScreen already construct a new report object leveraging useMemo. So when this object is passed to children it will maintain it's instance if no dependency changes.

Fixed Issues

$ #35590
PROPOSAL: #35590 (comment)

Tests

Go to workspace chat
Create a distance request
Navigate to request details page
Tap Distance
Change the distance and save it
The amount should be updated
Verify that no errors appear in the JS console

Offline tests

QA Steps

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 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 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 form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label 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-fix.mp4

Android: mWeb Chrome

N/A

iOS: Native

ios-fix.mp4

iOS: mWeb Safari

N/A

MacOS: Chrome / Safari

N/A

MacOS: Desktop

N/A

melvin-bot · 2024-02-02T06:56:03Z

@aimane-chnaif 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]

aimane-chnaif · 2024-02-02T06:58:11Z

In this PR, let's make sure that we're not missing any key remaining to be added to memo.
We already discovered many missing keys and the fixes were CP'ed:

report.isPinned
report.visibility
report.managerID
report.chatReportID
report.notificationPreference
currentReportID
viewportOffsetTop

aimane-chnaif · 2024-02-02T06:58:58Z

This time, please check all properties in report object, list them here and ✅ one by one

hurali97 · 2024-02-02T07:01:09Z

This time, please check all properties in report object, list them here and ✅ one by one

Yes, I was aware of that and as I mentioned in PR description, I have used _.isEqual(prevReport, nextReport) so no report property is missed. 👍

aimane-chnaif · 2024-02-02T07:03:53Z

This time, please check all properties in report object, list them here and ✅ one by one

Yes, I was aware of that and as I mentioned in PR description, I have used _.isEqual(prevReport, nextReport) so no report property is missed. 👍

Thanks, also check in useMemo please if any required key is missing

isPinned, chatReportID, visibility were examples

aimane-chnaif · 2024-02-02T07:05:01Z

Lint failing

aimane-chnaif · 2024-02-02T07:12:57Z

This time, please check all properties in report object, list them here and ✅ one by one

Yes, I was aware of that and as I mentioned in PR description, I have used _.isEqual(prevReport, nextReport) so no report property is missed. 👍

Just to confirm: if all values are same but just json object (i.e. order) is changed, this will be treated as equal, right?

i.e.
A = {a: x, b: y, c:z}
B = {b: y, a:x, c:z}
C = {b: y, a:x, c:z, d: undefined}

hurali97 · 2024-02-02T07:16:48Z

Just to confirm: if all values are same but just json object is changed, this will be treated as equal, right?

Yeah that's correct.

hurali97 · 2024-02-02T07:17:28Z

Thanks, also check in useMemo please if any required key is missing

I am verifying all the missing keys and will let you know once done.

hurali97 · 2024-02-02T08:00:49Z

@aimane-chnaif Looks good now, I have verified the report props throughout the React tree and util methods. 🙏

src/pages/home/report/ReportActionsView.js

src/pages/home/ReportScreen.js

trjExpensify · 2024-02-02T10:20:39Z

👋 How are we getting on here, guys? Keen to resolve this as one of the last blockers for the deploy. Thanks!

hurali97 · 2024-02-02T11:00:20Z

@aimane-chnaif I have brought back the individual comparison and double checked it so no property is missing which is used.

src/pages/home/ReportScreen.js

aimane-chnaif · 2024-02-02T11:27:42Z

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 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(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 form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label 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

Android: mWeb Chrome

iOS: Native

Screen.Recording.2024-02-02.at.12.22.29.PM.mov

iOS: mWeb Safari

Screen.Recording.2024-02-02.at.12.26.30.PM.mov

MacOS: Chrome / Safari

MacOS: Desktop

aimane-chnaif · 2024-02-02T11:28:30Z

Seems like there's navigation bug on back button on main (after ideal nav PR merge)
Whatever current page is, back button always goes to LHN

aimane-chnaif

Works well on iOS.
Not able to test other mobile platforms because of navigation bug - #35626
I used tricky way to test iOS (swipe left instead of back button)

[CP Staging] fix: ReportScreen props not updating (cherry picked from commit d02ee8d)

OSBotify · 2024-02-02T11:50:02Z

✋ 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 · 2024-02-02T12:20:33Z

🚀 Cherry-picked to staging by https://github.com/mountiny in version: 1.4.35-7 🚀

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

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

OSBotify · 2024-02-02T13:27:27Z

🚀 Cherry-picked to staging by https://github.com/mountiny in version: 1.4.35-7 🚀

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

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

OSBotify · 2024-02-02T14:30:18Z

🚀 Cherry-picked to staging by https://github.com/mountiny in version: 1.4.35-7 🚀

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 · 2024-02-02T15:14:18Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.35-7 🚀

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

fix: props not updating

7eba6d5

hurali97 requested a review from a team as a code owner February 2, 2024 06:55

melvin-bot bot requested review from aimane-chnaif and removed request for a team February 2, 2024 06:56

fix: lint

77be07c

fix: add missing report props

3b9b29b

aimane-chnaif reviewed Feb 2, 2024

View reviewed changes

src/pages/home/report/ReportActionsView.js Show resolved Hide resolved

aimane-chnaif reviewed Feb 2, 2024

View reviewed changes

src/pages/home/ReportScreen.js Outdated Show resolved Hide resolved

mountiny assigned hurali97 Feb 2, 2024

refactor: prefer individual comparison in favor of isEqual

442fea5

aimane-chnaif reviewed Feb 2, 2024

View reviewed changes

src/pages/home/ReportScreen.js Show resolved Hide resolved

aimane-chnaif reviewed Feb 2, 2024

View reviewed changes

src/pages/home/ReportScreen.js Outdated Show resolved Hide resolved

mountiny changed the title ~~fix: props not updating~~ [CP Staging] fix: ReportScreen props not updating Feb 2, 2024

refactor: use isEqual in favor of individual comparison

04795f9

mountiny approved these changes Feb 2, 2024

View reviewed changes

aimane-chnaif approved these changes Feb 2, 2024

View reviewed changes

melvin-bot bot requested a review from deetergp February 2, 2024 11:29

mountiny merged commit d02ee8d into Expensify:main Feb 2, 2024
18 of 19 checks passed

OSBotify pushed a commit that referenced this pull request Feb 2, 2024

Merge pull request #35638 from callstack-internal/hur/fix-35590

edb62a4

[CP Staging] fix: ReportScreen props not updating (cherry picked from commit d02ee8d)

github-actions bot mentioned this pull request Feb 2, 2024

Deploy Checklist: New Expensify 2024-01-31 #35524

Closed

37 tasks

melvin-bot bot mentioned this pull request Feb 2, 2024

[HOLD for payment 2024-02-09] [$500] Distance - Total amount is not updated after changing distance and returning via back icon #35590

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[CP Staging] fix: ReportScreen props not updating #35638

[CP Staging] fix: ReportScreen props not updating #35638

hurali97 commented Feb 2, 2024 •

edited

Loading

melvin-bot bot commented Feb 2, 2024

aimane-chnaif commented Feb 2, 2024 •

edited

Loading

aimane-chnaif commented Feb 2, 2024

hurali97 commented Feb 2, 2024

aimane-chnaif commented Feb 2, 2024

aimane-chnaif commented Feb 2, 2024

aimane-chnaif commented Feb 2, 2024 •

edited

Loading

hurali97 commented Feb 2, 2024

hurali97 commented Feb 2, 2024

hurali97 commented Feb 2, 2024

trjExpensify commented Feb 2, 2024

hurali97 commented Feb 2, 2024

aimane-chnaif commented Feb 2, 2024

aimane-chnaif commented Feb 2, 2024

aimane-chnaif left a comment •

edited

Loading

OSBotify commented Feb 2, 2024

OSBotify commented Feb 2, 2024

OSBotify commented Feb 2, 2024

OSBotify commented Feb 2, 2024

OSBotify commented Feb 2, 2024

[CP Staging] fix: ReportScreen props not updating #35638

[CP Staging] fix: ReportScreen props not updating #35638

Conversation

hurali97 commented Feb 2, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Feb 2, 2024

aimane-chnaif commented Feb 2, 2024 • edited Loading

aimane-chnaif commented Feb 2, 2024

hurali97 commented Feb 2, 2024

aimane-chnaif commented Feb 2, 2024

aimane-chnaif commented Feb 2, 2024

aimane-chnaif commented Feb 2, 2024 • edited Loading

hurali97 commented Feb 2, 2024

hurali97 commented Feb 2, 2024

hurali97 commented Feb 2, 2024

trjExpensify commented Feb 2, 2024

hurali97 commented Feb 2, 2024

aimane-chnaif commented Feb 2, 2024

Reviewer Checklist

Screenshots/Videos

aimane-chnaif commented Feb 2, 2024

aimane-chnaif left a comment • edited Loading

Choose a reason for hiding this comment

OSBotify commented Feb 2, 2024

OSBotify commented Feb 2, 2024

OSBotify commented Feb 2, 2024

OSBotify commented Feb 2, 2024

OSBotify commented Feb 2, 2024

hurali97 commented Feb 2, 2024 •

edited

Loading

aimane-chnaif commented Feb 2, 2024 •

edited

Loading

aimane-chnaif commented Feb 2, 2024 •

edited

Loading

aimane-chnaif left a comment •

edited

Loading