Fallback on report #19127

luacmartins · 2023-05-17T17:05:17Z

Details

When the parentReportID key was undefined, we returned reports_ to Onyx which resulted in it returning the entire report collection to the header component 😅 Additionally, this conditional always returned true.

@thienlnam not sure if we can clean up more of the logic and make Onyx always return either the parentReport or the report as a report prop so we don't need to check for it within the component.

cc @thienlnam

Fixed Issues

$ #19123

Tests

Create a new chat with user CMD + K
Verify that the chat header displays the user's name and avatar

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

web.mov

Mobile Web - Chrome

chrome.mov

Mobile Web - Safari

safari.mov

Desktop

desktop.mov

iOS

ios.mov

Android

android.mov

melvin-bot · 2023-05-17T17:05:56Z

@fedirjh @srikarparsi 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]

thienlnam

Oh wow, thanks!

github-actions · 2023-05-17T17:07:53Z

⚠️ ⚠️ Heads up! This pull request has the CP Staging label ⚠️ ⚠️
If you applied the CP Staging label before the PR was merged, the PR will be be immediately deployed to staging even if the open StagingDeployCash deploy checklist is locked.
However if you applied the CP Staging after the PR was merged it's possible it won't be CP'ed automatically. If you need it to be CP'ed to staging, tag a member of @Expensify/mobile-deployers to CP it manually, otherwise you can wait for it to go out with the next deploy.

thienlnam · 2023-05-17T17:08:32Z

Also yeah, will be a good clean up item to add a bunch of these checks when we're returning data from php so we can keep these conditionals minimal in App

mountiny · 2023-05-17T17:15:22Z

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-05-17.at.18.19.16.mov

Mobile Web - Chrome

Having issus with chrome on android

Mobile Web - Safari

Screen.Recording.2023-05-17.at.18.23.04.mov

Desktop

iOS

Android

Screen.Recording.2023-05-17.at.18.21.49.mov

thienlnam · 2023-05-17T17:16:01Z

src/pages/home/HeaderView.js

-            key: ({report}) => `${ONYXKEYS.COLLECTION.REPORT}${report.parentReportID}`,
+            key: ({report}) => `${ONYXKEYS.COLLECTION.REPORT}${report.parentReportID || report.reportID}`,


I don't know if this change makes sense - the parentReport is never the report.reportID right? Like can we just return nothing here if it doesn't exist?

Was wondering the same, we should not retrun a wrong report as parent. I think we should return 0 in this case and make sure we check for that -> its root does not have a parent

Without this, Onyx will return all the reports in the report collection if report.parentReportID is undefined because the key will be report_. I spoke to @tgolen about this and we agreed that falling back to the report was a good solution in this case. As I mentioned in the OP, we could probably consolidate these into a single Onyx key report so the component always gets the right data and doesn't need to have any logic to decide which report it should use.

Without this, Onyx will return all the reports in the report collection if report.parentReportID is undefined because the key will be report_.

Does that also happen with report_0?

Not sure, but lately I've started seeing a report_0 key in Onyx (which seems to be coming from PHP somewhere) so I assume that'd be returned instead.

Does that also happen with report_0?

I don't think it should, no. It's expected that if you subscribe to a key like report_ that it gives you the entire collection and that is normal behavior. The undefined reportID is a nasty gotcha that results in subscribing to the entire collection.

mountiny

Tests well, thanks!

Fallback on report (cherry picked from commit 3e5d81b)

…-19127 🍒 Cherry pick PR #19127 to staging 🍒

OSBotify · 2023-05-17T18:59:03Z

🚀 Cherry-picked to staging by https://github.com/luacmartins in version: 1.3.15-5 🚀

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 · 2023-05-18T06:50:14Z

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.3.15-12 🚀

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

OSBotify · 2023-06-15T01:28:57Z

🚀 Cherry-picked to staging by https://github.com/AndrewGable in version: 1.3.28-2 🚀

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 · 2023-06-16T18:46:45Z

🚀 Deployed to production by https://github.com/AndrewGable in version: 1.3.28-5 🚀

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

luacmartins added 2 commits May 17, 2023 10:47

fallback on report

da5acb0

fix conditional

942b4fc

luacmartins self-assigned this May 17, 2023

luacmartins marked this pull request as ready for review May 17, 2023 17:05

luacmartins requested a review from a team as a code owner May 17, 2023 17:05

melvin-bot bot requested review from fedirjh and srikarparsi and removed request for a team May 17, 2023 17:05

thienlnam previously approved these changes May 17, 2023

View reviewed changes

luacmartins added the CP Staging label May 17, 2023

Julesssss previously approved these changes May 17, 2023

View reviewed changes

update onyx key

4fbb188

luacmartins dismissed stale reviews from Julesssss and thienlnam via 4fbb188 May 17, 2023 17:12

Julesssss approved these changes May 17, 2023

View reviewed changes

thienlnam reviewed May 17, 2023

View reviewed changes

mountiny approved these changes May 17, 2023

View reviewed changes

luacmartins merged commit 3e5d81b into main May 17, 2023
10 of 14 checks passed

luacmartins deleted the cmartins-fixReportHeader branch May 17, 2023 17:38

OSBotify pushed a commit that referenced this pull request May 17, 2023

Merge pull request #19127 from Expensify/cmartins-fixReportHeader

98389d4

Fallback on report (cherry picked from commit 3e5d81b)

OSBotify mentioned this pull request May 17, 2023

🍒 Cherry pick PR #19127 to staging 🍒 #19131

Merged

OSBotify added a commit that referenced this pull request May 17, 2023

Merge pull request #19131 from Expensify/OSBotify-cherry-pick-staging…

da6b062

…-19127 🍒 Cherry pick PR #19127 to staging 🍒

OSBotify mentioned this pull request May 17, 2023

Deploy Checklist: New Expensify 2023-05-16 #19088

Closed

71 tasks

melvin-bot bot mentioned this pull request May 18, 2023

[HOLD for payment 2023-05-29] in workspace chat, workspace details are missing in header #19123

Closed

6 tasks

OSBotify mentioned this pull request May 18, 2023

Deploy Checklist: New Expensify 2023-05-18 #19175

Closed

39 tasks

OSBotify mentioned this pull request Jun 15, 2023

Deploy Checklist: New Expensify 2023-06-14 #20782

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fallback on report #19127

Fallback on report #19127

luacmartins commented May 17, 2023 •

edited

Loading

melvin-bot bot commented May 17, 2023

thienlnam left a comment

github-actions bot commented May 17, 2023

thienlnam commented May 17, 2023

mountiny commented May 17, 2023 •

edited

Loading

thienlnam May 17, 2023

mountiny May 17, 2023

luacmartins May 17, 2023 •

edited

Loading

thienlnam May 17, 2023

luacmartins May 17, 2023

tgolen May 17, 2023

mountiny left a comment

OSBotify commented May 17, 2023

OSBotify commented May 18, 2023

OSBotify commented Jun 15, 2023

OSBotify commented Jun 16, 2023

		key: ({report}) => `${ONYXKEYS.COLLECTION.REPORT}${report.parentReportID}`,
		key: ({report}) => `${ONYXKEYS.COLLECTION.REPORT}${report.parentReportID \|\| report.reportID}`,

Fallback on report #19127

Fallback on report #19127

Conversation

luacmartins commented May 17, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented May 17, 2023

thienlnam left a comment

Choose a reason for hiding this comment

github-actions bot commented May 17, 2023

thienlnam commented May 17, 2023

mountiny commented May 17, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

thienlnam May 17, 2023

Choose a reason for hiding this comment

mountiny May 17, 2023

Choose a reason for hiding this comment

luacmartins May 17, 2023 • edited Loading

Choose a reason for hiding this comment

thienlnam May 17, 2023

Choose a reason for hiding this comment

luacmartins May 17, 2023

Choose a reason for hiding this comment

tgolen May 17, 2023

Choose a reason for hiding this comment

mountiny left a comment

Choose a reason for hiding this comment

OSBotify commented May 17, 2023

OSBotify commented May 18, 2023

OSBotify commented Jun 15, 2023

OSBotify commented Jun 16, 2023

luacmartins commented May 17, 2023 •

edited

Loading

mountiny commented May 17, 2023 •

edited

Loading

luacmartins May 17, 2023 •

edited

Loading