fix: Task description is covered by the keyboard pop up by nkdengineer · Pull Request #50544 · Expensify/App

nkdengineer · 2024-10-10T08:39:53Z

Details

Fixed Issues

$ #50346
PROPOSAL: #50346 (comment)

Tests

Signed up for a new account
Selected Get paid by my employer
Tap into the Concierge DM
Tap into the first task
Verify that: Keyboard should not pop up by default

Verify that no errors appear in the JS console

Offline tests

QA Steps

Signed up for a new account
Selected Get paid by my employer
Tap into the Concierge DM
Tap into the first task
Verify that: Keyboard should not pop up by default

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

android.mov

Android: mWeb Chrome

android-mweb.mov

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

melvin-bot · 2024-10-16T17:37:40Z

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

nkdengineer · 2024-10-16T17:38:01Z

I am a little stuck on the iOS builds, will add later

rojiphil

@nkdengineer I have left some comments. Please have a look. Thanks.

src/pages/home/report/ReportActionCompose/ComposerWithSuggestions/ComposerWithSuggestions.tsx

rojiphil · 2024-10-17T11:49:06Z

src/pages/home/report/ReportActionCompose/ComposerWithSuggestions/ComposerWithSuggestions.tsx

-        const isComposerCoveredUp = !isFocused || EmojiPickerActions.isEmojiPickerVisible() || isMenuVisible || !!modal?.isVisible || modal?.willAlertModalBecomeVisible;
+        const isComposerCoveredUp = !isFocused || EmojiPickerActions.isEmojiPickerVisible() || isMenuVisible || !!isVisibleRef.current || willAlertModalBecomeVisibleRef.current;
        return !isComposerCoveredUp;
-    }, [isMenuVisible, modal, isFocused]);


Wouldn't removal of modal from dependencies fail to trigger update of checkComposerVisibility when isVisible or willAlertModalBecomeVisible change? I think we should keep it simple by reusing modal itself.

rojiphil · 2024-10-17T12:15:41Z

src/pages/home/report/ReportActionCompose/ComposerWithSuggestions/ComposerWithSuggestions.tsx

+                    return;
+                }
+                isVisibleRef.current = !!modalArg.isVisible;
+                willAlertModalBecomeVisibleRef.current = !!modalArg.willAlertModalBecomeVisible;


Why don't we use the pattern of useState as used here? Using useRef would not help in re-render which we may want to do with the change in modal.

@rojiphil I checked this pattern but not sure why the perf-test still fails when I use this.

I checked this pattern but not sure why the perf-test still fails when I use this.

@nkdengineer Can you please merge main again and check? A recent PR was merged about 6 hours ago to update the npm and node version which could be causing this.

A recent PR was merged about 6 hours ago to update the npm and node version which could be causing this.

@rojiphil It happened when we started the PR.

I merged the latest main.

It happened when we started the PR.

@nkdengineer Yeah. That's right. Looks like the rendering is happening quite often and we need to avoid unnecessary renders.

Do you think the following can help here?

Using the loading status in useOnyx as referenced here to avoid unnecessary rendering until data is fetched?

Selectively using isVisible and willAlertModalBecomeVisible as per the pattern here in modal to avoid other unnecessary properties?

Ideally, we would want the fix for the performance issue. But if we want to merge, we may not want to merge with the performance issue. Instead, it may be better to revert the migration changes of withOnyx to useOnyx. I think this will help resolve the performance issue although this will bring up the lint issue. But this may be acceptable as we would have fixed the issue impacting the CRITICAL flow as mentioned here.
I will let @lakchote weigh in here and advice on the way ahead.

We for sure want to fix the performance issue.

Instead, it may be better to revert the migration changes of withOnyx to useOnyx.

Let's do that if that fixes the issue. But it doesn't look like it does (ebb488e).

When you merged main (a1803bc) tests did pass @nkdengineer.

But it doesn't look like it does (ebb488e).

This commit has changes related to migration from withOnyx to useOnyx. That's why it gives a problem.

When you merged main (a1803bc) tests did pass @nkdengineer.

That's correct but that commit still has issues as mentioned in #50544 (comment) and is incomplete with respect to migration.

Instead, it may be better to revert the migration changes of withOnyx to useOnyx.

Let's do that if that fixes the issue.

@lakchote Sure. Let's do this.
@nkdengineer Let us include only the fix required for this issue and revert the changes to bring back the original withOnyx implementation. Would this not work?

Thanks for the details @rojiphil. I misinterpreted what you were saying about revert the migration changes of withOnyx to useOnyx..

Let's do it! @nkdengineer if you could do it in a timely manner, it'd be greatly appreciated.

I misinterpreted what you were saying about revert the migration changes of withOnyx to useOnyx..

Oh! Got it. Wrong sentence formation. My bad

rojiphil · 2024-10-25T17:00:25Z

Ah! Nice. Thanks @nkdengineer for the changes.
As expected the lint error came up, but why are the unit tests failing?

nkdengineer · 2024-10-25T17:40:50Z

@rojiphil The test is fixed. Sometimes it's out of the limited time of the test.

rojiphil · 2024-10-25T19:16:04Z

@nkdengineer The keyboard shows up for android native platform. Here is a test video demonstrating this.
Why did we not use ReportUtils.isTaskReport(report) as per your proposal? Instead, we have used parentReportAction which would cause a problem if it is undefined.

50346-android-issue.mp4

rojiphil · 2024-10-25T19:26:29Z

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

iOS: mWeb Safari

50346-mweb-safari-001.mp4

Android: Native

50346-android-native-002.mp4

Android: mWeb Chrome

50346-mweb-chrome-001.mp4

iOS: Native

50346-ios-native-001.mp4

MacOS: Chrome / Safari

50346-web-safari-001.mp4

MacOS: Desktop

50346-desktop-001.mp4

nkdengineer · 2024-10-25T19:36:21Z

Why did we not use ReportUtils.isTaskReport(report) as per your proposal? Instead, we have used parentReportAction which would cause a problem if it is undefined.

@rojiphil Because we can reuse this variable and don't need to add another Onyx data.

nkdengineer · 2024-10-25T20:01:57Z

@rojiphil I updated.

rojiphil

@nkdengineer Thanks for the changes. But I have few NAB observations as below:

a. Please update the following test steps as that would help QA understand better:

Note: The tests are applicable only for mWeb and native platforms.

Sign up with a new account
Complete onboarding step using Track and budget expenses
Navigate to Concierge DM if needed
Tap on Track an expense task to navigate to the task report
Verify that the keyboard is not displayed

b. The test videos for iOS native and mWeb platforms are missing. Please include them.

@lakchote The changes LGTM and tests well too. This will fix the issue at hand.
Over to you for review. Thanks.

The lint issue would remain as mentioned before due to the migration issue of withOnyx. Maybe we can create another issue and invite proposals to address this.

lakchote · 2024-10-28T12:32:05Z

Thanks @rojiphil for your thorough testing and details.

I'm going to merge it with the lint issue, however I've created another issue (#51562) to handle the useOnyx() migration.

melvin-bot · 2024-10-28T12:32:24Z

@lakchote looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

lakchote · 2024-10-28T12:33:55Z

Not an emergency, there is a lint test failing because we're not using useOnyx() as it makes performance tests fail.

Given the critical impact of the issue, we need to get this fix merged.

I've created another issue (#51562) so that we can use useOnyx() as soon as we can.

OSBotify · 2024-10-28T12:42:36Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

github-actions · 2024-10-29T09:44:13Z

🚀 Deployed to staging by https://github.com/lakchote in version: 9.0.55-0 🚀

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

github-actions · 2024-10-31T11:17:25Z

🚀 Deployed to production by https://github.com/Beamanator in version: 9.0.55-10 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	failure ❌
🕸 web 🕸	success ✅
🤖🔄 android HybridApp 🤖🔄	skipped 🚫
🍎🔄 iOS HybridApp 🍎🔄	skipped 🚫

nkdengineer added 2 commits October 10, 2024 15:39

fix: Task description is covered by the keyboard pop up

f9e5258

Merge branch 'main' into fix/50346

3fa8008

nkdengineer mentioned this pull request Oct 10, 2024

[HOLD for payment 2024-11-07] [$250] Task description is covered by the keyboard pop up #50346

Closed

6 tasks

nkdengineer added 6 commits October 15, 2024 15:21

Merge branch 'main' into fix/50346

c63f60f

fix test

1e4e275

fix test

e381a1a

Merge branch 'main' into fix/50346

31ead13

fix perf-test

8bdd1cf

use ref for modal daat

cccef9b

nkdengineer marked this pull request as ready for review October 16, 2024 17:37

nkdengineer requested a review from a team as a code owner October 16, 2024 17:37

melvin-bot bot requested a review from rojiphil October 16, 2024 17:37

melvin-bot bot removed the request for review from a team October 16, 2024 17:37

rojiphil reviewed Oct 17, 2024

View reviewed changes

nkdengineer added 4 commits October 22, 2024 16:48

Merge branch 'main' into fix/50346

a1803bc

use useOnyx

ebb488e

Merge branch 'main' into fix/50346

6c6a7cb

revert useOnyx

fbc69b2

nkdengineer added 2 commits October 26, 2024 00:36

fix test

9c5d4cb

fix lint

d8086ab

nkdengineer added 2 commits October 26, 2024 02:59

Merge branch 'main' into fix/50346

bc4aca8

use isTaskReport function

9a36cac

rojiphil approved these changes Oct 26, 2024

View reviewed changes

melvin-bot bot requested a review from lakchote October 26, 2024 09:34

lakchote approved these changes Oct 28, 2024

View reviewed changes

lakchote mentioned this pull request Oct 28, 2024

[$250] [HOLD for payment 2024-11-13] Fix performance tests failing when migrating to useOnyx() #51562

Closed

lakchote merged commit 75d9877 into Expensify:main Oct 28, 2024

melvin-bot bot added the Emergency label Oct 28, 2024

lakchote removed the Emergency label Oct 28, 2024

github-actions bot mentioned this pull request Oct 29, 2024

Deploy Checklist: New Expensify 2024-10-29 #51635

Closed

65 tasks

mollfpr mentioned this pull request Nov 1, 2024

[$250] keyboard hides unexpectedly when adding a new task on the report screen #50442

Closed

6 tasks

Conversation

nkdengineer commented Oct 10, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Oct 16, 2024

Uh oh!

nkdengineer commented Oct 16, 2024

Uh oh!

rojiphil left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lakchote Oct 25, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rojiphil commented Oct 25, 2024

Uh oh!

nkdengineer commented Oct 25, 2024

Uh oh!

rojiphil commented Oct 25, 2024

Uh oh!

rojiphil commented Oct 25, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

nkdengineer commented Oct 25, 2024

Uh oh!

nkdengineer commented Oct 25, 2024

Uh oh!

rojiphil left a comment

Choose a reason for hiding this comment

Uh oh!

lakchote commented Oct 28, 2024

Uh oh!

melvin-bot bot commented Oct 28, 2024

Uh oh!

lakchote commented Oct 28, 2024

Uh oh!

OSBotify commented Oct 28, 2024

Uh oh!

github-actions bot commented Oct 29, 2024

Uh oh!

github-actions bot commented Oct 31, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

nkdengineer commented Oct 10, 2024 •

edited

Loading

lakchote Oct 25, 2024 •

edited

Loading

rojiphil commented Oct 25, 2024 •

edited

Loading