fix: ensure composer not full size when onyx state missing #31602

erquhart · 2023-11-21T01:44:42Z

Details

Note: this bug only occured on Desktop and desktop web - small screens don't trigger the double redirect on root domain load that is required to reproduce this bug, as they only show the LHN on root domain load.

getReportID() was supposed to be returning "null" (null as a string) rather than empty strings, but lodash.get() only uses the default value in place of undefined, so it was still able to return empty strings. The change here is ensuring getReportID() never returns an empty string. Per @toglen's request, and per the react-native-onyx readme, instead of "null" we're returning "0". I'm returning 0 as a string because it will need to be coerced to a string anyway, so no point in leaving that to chance and risking further bugs.

I also found that, with the unexpected full size composer issue fix, a very quick flash was occuring in it's place. I confirmed that this wasn't the same bug by ensuring through logging that the key never ends with an empty string. I pointed out at least one other legitimate unintended behavior in my alternate solutions, and one of them - fixing our treatment of an empty path as a deeplink, which triggers a double redirect and was partly responsible for the current bug - made this issue disappear completely.

The additional fix only involves returning early in our deep link handler if the route is falsy.

Fixed Issues

$ #31089
PROPOSAL: #31089 (comment)

Tests

Verify that no errors appear in the JS console

log out
log in
wait for app to load, including redirecting to a report
load app again from root domain (Eg., new.expensify.com)
wait for app to redirect to a report
observe expanded composer

To repeat without logging out and in again:
7. select a different report from the LHN, one that has not been loaded since last login
8. repeat steps 4-6

These steps work once per report. When the report initially loads and the bug is triggered, the bug won't reoccur in that report until the user logs out and back in (explanation below).

Offline tests

QA Steps

Verify that no errors appear in the JS console

log out
log in
wait for app to load, including redirecting to a report
load app again from root domain (Eg., new.expensify.com)
wait for app to redirect to a report
observe expanded composer

To repeat without logging out and in again:
7. select a different report from the LHN, one that has not been loaded since last login
8. repeat steps 4-6

These steps work once per report. When the report initially loads and the bug is triggered, the bug won't reoccur in that report until the user logs out and back in (explanation below).

PR Author Checklist

Screenshots/Videos

MacOS: Chrome / Safari

https://github.com/Expensify/App/assets/2112202/88ee8946-efbf-4f61-8221-03e85c6d9311

MacOS: Desktop

https://github.com/Expensify/App/assets/2112202/b243bcde-76be-43e3-88c5-79beff91a63f

melvin-bot · 2023-11-21T01:44:47Z

@0xmiroslav 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]

erquhart · 2023-11-21T01:45:29Z

@tgolen @0xmiroslav please note the additional fix explained above.

0xmiros · 2023-11-21T13:49:55Z

src/libs/actions/Report.js

+                if (!route) {
+                    return;
+                }


Good additional fix but I am concerned this will cause another unexpected regression we don't know.
If route is falsy, it redirects to ROUTES.HOME as fallback which is fine.
Let's just fix OP here.

It redirects after nav state hydration has already occurred here in the default report setter:

App/src/libs/Navigation/AppNavigator/ReportScreenIDSetter.js

Lines 85 to 91 in 04b5fa4

// If there is no reportID in route, try to find last accessed and use it for setParams

const reportID = getLastAccessedReportID(reports, !canUseDefaultRooms, policies, isFirstTimeNewExpensifyUser, lodashGet(route, 'params.openOnAdminRoom', false));

// It's possible that reports aren't fully loaded yet

// in that case the reportID is undefined

if (reportID) {

navigation.setParams({reportID: String(reportID)});

I'm finding that just fixing the onyx key still leaves a flash that's too fast to catch on video, but it's observable if you try to repro with this branch. It isn't the composer size, so it's technically out of scope for this issue - happy to remove if you prefer. But resetting nav state twice, which only happens on wide screens loading the root domain with no path, is causing problems, we really shouldn't be doing it. It's covered in step 4 of the root cause in my proposal.

The problem is a lot of UI conditionals hinge on whether there's a report id. When you load the root domain, the default report setter provides a report id, but then the deep link handler redirects, blowing up nav state and taking report id back to an empty string. This leaves a gap where various components are rendering when there's no report ID.

That happens earlier in the root cause before getReportID() fails to return "null", and is technically a more accurate root cause.

getReportID() handling empty report ids is just a backup to provide default values. Both fixes are accurate, and both are related. We're counting on a lot of default value handling across a lot of components to cover this, but there's no need for the double redirect in the first place.

I'm pretty confident that not only will this not cause more bugs, it will likely fix some seemingly unrelated issues.

it will likely fix some seemingly unrelated issues

I'd suggest to raise this in slack with clear repro step and video of the buggy behavior and let team make create new GH

Alright, I'll update the PR.

I appreciate you digging into this and trying to fix the problem. I agree that it would be great to handle that in a separately scoped issue and PR. That makes everything easier to review/test/revert.

erquhart · 2023-11-21T14:13:11Z

@0xmiroslav PR updated.

0xmiros · 2023-11-21T14:17:58Z

Another 2 unrelated bugs: (happening on main so out of scope)

composer style is broken
there's moment when report screen is empty, which should be skeleton loading always

0xmiros · 2023-11-21T14:19:05Z

@erquhart seems like your Screenshots/Videos is stopped on the way

0xmiros · 2023-11-21T14:36:14Z

Another unrelated bug on android chrome:
Not found page shows after refresh browser

bug.mov

0xmiros · 2023-11-21T14:38:00Z

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 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 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.mov

Android: mWeb Chrome

mchrome.mov

iOS: Native

ios.mov

iOS: mWeb Safari

msafari.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

erquhart · 2023-11-21T14:42:12Z

@0xmiroslav desktop screen recording fixed, good catch

0xmiros

LGTM!

tgolen · 2023-11-21T16:14:47Z

src/pages/home/ReportScreen.js

@@ -128,7 +128,7 @@ const defaultProps = {
 */
 function getReportID(route) {
    // // The reportID is used inside a collection key and should not be empty, as an empty reportID will result in the entire collection being returned.


Suggested change

// // The reportID is used inside a collection key and should not be empty, as an empty reportID will result in the entire collection being returned.

// The reportID is used inside a collection key and should not be empty, as an empty reportID will result in the entire collection being returned.

This has been driving me nuts for weeks 😂 mind fixing it? It's also great that the null default value completely went against the warning in the comment.

Oh, also... you could maybe update the comment to explain why the 0 is outside of lodashGet() instead of using it as the default value of lodashGet. In fact, maybe I missed that part... why isn't the code like this?

lodashGet(route, 'params.reportID', 0)

'' is not falsy and doesn't fallback.
Similar in TS: '' ?? 0 returns ''

Ah yes, that's right. Can you please add that to the comment so that others will understand that too? It's very subtle.

tgolen · 2023-11-21T16:16:29Z

src/pages/home/ReportScreen.js

@@ -128,7 +128,7 @@ const defaultProps = {
 */
 function getReportID(route) {
    // // The reportID is used inside a collection key and should not be empty, as an empty reportID will result in the entire collection being returned.


Oh, also... you could maybe update the comment to explain why the 0 is outside of lodashGet() instead of using it as the default value of lodashGet. In fact, maybe I missed that part... why isn't the code like this?

lodashGet(route, 'params.reportID', 0)

erquhart · 2023-11-21T16:52:57Z

@tgolen updated 👍

OSBotify · 2023-11-21T17:09:57Z

✋ 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 · 2023-11-22T01:04:00Z

🚀 Deployed to staging by https://github.com/tgolen in version: 1.4.2-0 🚀

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

OSBotify · 2023-11-23T16:55:32Z

🚀 Deployed to production by https://github.com/luacmartins in version: 1.4.2-3 🚀

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

fix: ensure composer not full size when onyx state missing

ac7a0c5

erquhart requested a review from a team as a code owner November 21, 2023 01:44

melvin-bot bot requested review from 0xmiros and removed request for a team November 21, 2023 01:44

0xmiros reviewed Nov 21, 2023

View reviewed changes

drop deeplink handler early return for empty routes

281a940

0xmiros approved these changes Nov 21, 2023

View reviewed changes

melvin-bot bot requested a review from cead22 November 21, 2023 14:42

tgolen requested changes Nov 21, 2023

View reviewed changes

improve getReportID() solution comment

ef75931

tgolen approved these changes Nov 21, 2023

View reviewed changes

tgolen merged commit 7f73a1f into Expensify:main Nov 21, 2023
15 checks passed

github-actions bot mentioned this pull request Nov 22, 2023

Deploy Checklist: New Expensify 2023-11-22 #31667

Closed

62 tasks

melvin-bot bot mentioned this pull request Nov 23, 2023

[HOLD for payment 2023-11-30] [$500] Composer is very large on first render #31089

Closed

6 tasks

bernhardoj mentioned this pull request Mar 29, 2024

fixes "Skeleton is displayed when navigating to a transaction thread created offline" #38955

Merged

50 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: ensure composer not full size when onyx state missing #31602

fix: ensure composer not full size when onyx state missing #31602

erquhart commented Nov 21, 2023 •

edited

Loading

melvin-bot bot commented Nov 21, 2023

erquhart commented Nov 21, 2023

0xmiros Nov 21, 2023

erquhart Nov 21, 2023

erquhart Nov 21, 2023 •

edited

Loading

0xmiros Nov 21, 2023

erquhart Nov 21, 2023

tgolen Nov 21, 2023

erquhart commented Nov 21, 2023

0xmiros commented Nov 21, 2023

0xmiros commented Nov 21, 2023

0xmiros commented Nov 21, 2023

0xmiros commented Nov 21, 2023

erquhart commented Nov 21, 2023

0xmiros left a comment

tgolen Nov 21, 2023

tgolen Nov 21, 2023

0xmiros Nov 21, 2023

tgolen Nov 21, 2023

erquhart Nov 21, 2023

tgolen Nov 21, 2023

erquhart commented Nov 21, 2023

OSBotify commented Nov 21, 2023

OSBotify commented Nov 22, 2023

OSBotify commented Nov 23, 2023

	// If there is no reportID in route, try to find last accessed and use it for setParams
	const reportID = getLastAccessedReportID(reports, !canUseDefaultRooms, policies, isFirstTimeNewExpensifyUser, lodashGet(route, 'params.openOnAdminRoom', false));

	// It's possible that reports aren't fully loaded yet
	// in that case the reportID is undefined
	if (reportID) {
	navigation.setParams({reportID: String(reportID)});

	// // The reportID is used inside a collection key and should not be empty, as an empty reportID will result in the entire collection being returned.
	// The reportID is used inside a collection key and should not be empty, as an empty reportID will result in the entire collection being returned.

fix: ensure composer not full size when onyx state missing #31602

fix: ensure composer not full size when onyx state missing #31602

Conversation

erquhart commented Nov 21, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Nov 21, 2023

erquhart commented Nov 21, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

erquhart Nov 21, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

erquhart commented Nov 21, 2023

0xmiros commented Nov 21, 2023

0xmiros commented Nov 21, 2023

0xmiros commented Nov 21, 2023

0xmiros commented Nov 21, 2023

Reviewer Checklist

Screenshots/Videos

erquhart commented Nov 21, 2023

0xmiros left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

erquhart commented Nov 21, 2023

OSBotify commented Nov 21, 2023

OSBotify commented Nov 22, 2023

OSBotify commented Nov 23, 2023

erquhart commented Nov 21, 2023 •

edited

Loading

erquhart Nov 21, 2023 •

edited

Loading