Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix editing a task, navigate app to other report #51381

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

tsa321
Copy link
Contributor

@tsa321 tsa321 commented Oct 24, 2024

Details

Fixed Issues

$ #47671
PROPOSAL: #47671 (comment)

Tests

  1. Go to any chat and create a task.
  2. Open the task report.
  3. Send 10 messages.
  4. Edit the task description and save it.
  5. Verify that the app doesn't navigate to another report and that the task report doesn't automatically scroll to the bottom.
  6. Edit the task title.
  7. Verify that the app doesn't navigate to another report and that the task report doesn't automatically scroll to the bottom.
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

  1. Go to any chat and create a task.
  2. Open the task report.
  3. Send 10 messages.
  4. Edit the task description and save it.
  5. Verify that the app doesn't navigate to another report and that the task report doesn't automatically scroll to the bottom.
  6. Edit the task title.
  7. Verify that the app doesn't navigate to another report and that the task report doesn't automatically scroll to the bottom.
  • 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-native-d.mp4
Android: mWeb Chrome
android-mweb_d.mp4
iOS: Native
ios-native_d.mp4
iOS: mWeb Safari
ios-msfari_d.mp4
MacOS: Chrome / Safari
macos-web-d.mp4
MacOS: Desktop
macos-desktop_d.mp4

@tsa321 tsa321 requested a review from a team as a code owner October 24, 2024 06:29
@melvin-bot melvin-bot bot requested review from getusha and removed request for a team October 24, 2024 06:29
Copy link

melvin-bot bot commented Oct 24, 2024

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

@getusha
Copy link
Contributor

getusha commented Nov 4, 2024

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 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-11-20.at.1.09.48.in.the.afternoon.mov
Android: mWeb Chrome
Screen.Recording.2024-11-04.at.5.49.29.in.the.afternoon.mov
iOS: Native
Screen.Recording.2024-11-20.at.1.29.46.in.the.afternoon.mov
iOS: mWeb Safari
Screen.Recording.2024-11-04.at.5.32.57.in.the.afternoon.mov
MacOS: Chrome / Safari
Screen.Recording.2024-11-04.at.5.19.47.in.the.afternoon.mov
MacOS: Desktop
Screen.Recording.2024-11-20.at.1.26.01.in.the.afternoon.mov

@getusha
Copy link
Contributor

getusha commented Nov 4, 2024

@tsa321 strangely it kind of scrolls on android native after changing the description

Screen.Recording.2024-11-04.at.5.57.22.in.the.afternoon.mov

@tsa321
Copy link
Contributor Author

tsa321 commented Nov 5, 2024

@getusha, it looks like the Android issue is related to the appearance of the keyboard / the focus of the composer.

As you can see in the main, if we open the description page and then press the back button, the report scrolls:

backButtonOnMain.mp4

This issue only occurs if the composer was previously focused. If the composer is not focused beforehand, the report does not scroll:

test3.mp4

This bug is related to the keyboard appearing and also occurs in the main.
To confirm whether this issue also occurs in the main, you can test it by tapping the back button in the header of the edit description page (without editing the description). The report will scroll slightly after the keyboard appears.

@tsa321
Copy link
Contributor Author

tsa321 commented Nov 9, 2024

@getusha: So basically, the scroll bug on Android is unrelated to the issue. To confirm this, you can reproduce the bug even without editing a task.

You can test it by tapping the back button in the header of the Edit Description page (without editing the description). The report will scroll slightly after the keyboard appears:

backButtonOnMain.mp4

@getusha
Copy link
Contributor

getusha commented Nov 9, 2024

@tsa321 the expected behavior is for it not to scroll after we edit the description/title. It does seem related to me

@tsa321
Copy link
Contributor Author

tsa321 commented Nov 9, 2024

@getusha, the bug exists even without editing the task, as I mentioned here. Also, that bug is that the report scrolls a little in Android, while the bug we are trying to fix is that the report scrolls to the bottom.
If it needs to be fixed, I can create a follow-up PR, but it's unrelated to the issue that this PR is trying to address.

I believe the bug is related to this file:
https://github.com/Expensify/App/blob/main/src/components/FlatList/index.android.tsx

Also, I think @janicduplessis has more context on the bug.

cc @deetergp

@tsa321
Copy link
Contributor Author

tsa321 commented Nov 14, 2024

@deetergp Is this really a bug or the expected behavior?

keyboard-showup.mp4

When a user opens the keyboard, the text above the composer stays positioned right above it, which results in the upper portion of the report being hidden.

I believe this is expected behavior.

@tsa321
Copy link
Contributor Author

tsa321 commented Nov 14, 2024

@getusha to fix the issue, the auto focus must be disabled in android/ ios, so the keyboard doesn't push the report screen.

@deetergp
Copy link
Contributor

I don't really understand what the bug might be. @getusha could you clarify for me what you feel is the expected behavior here? From what I see in the videos posted in this PR, it looks like it is behaving the way it ought to, so I am a little confused.

@getusha
Copy link
Contributor

getusha commented Nov 20, 2024

It appears to scroll to the bottom when the composer is re-focused, seems like it has a different root cause as @tsa321 mentioned.

Screen.Recording.2024-11-20.at.1.05.34.in.the.afternoon.mov

@@ -1102,7 +1102,7 @@ function deleteTask(report: OnyxEntry<OnyxTypes.Report>) {
};

API.write(WRITE_COMMANDS.CANCEL_TASK, parameters, {optimisticData, successData, failureData});
Report.notifyNewAction(report.reportID, currentUserAccountID);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this necessary for deleteTask?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will revert this

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you forgot to push the changes

@tsa321
Copy link
Contributor Author

tsa321 commented Nov 20, 2024

It appears to scroll to the bottom when the composer is re-focused, seems like it has a different root cause @tsa321 mentioned.
Screen.Recording.2024-11-20.at.1.05.34.in.the.afternoon.mov

@getusha Could you rephrase this? I don't quite understand what you mean.

To test the bug you mentioned, you need to have a lot of text in the reports, for example, more than 50 messages, to ensure that the bug either scrolls a bit or scrolls to the bottom.

@tsa321 tsa321 requested a review from getusha November 20, 2024 13:25
@getusha
Copy link
Contributor

getusha commented Nov 20, 2024

@tsa321 we discussed this before #51381 (comment)

@tsa321

This comment was marked as resolved.

@getusha
Copy link
Contributor

getusha commented Nov 20, 2024

I believe the issue is that the scroll doesn't go all the way to the bottom; it only scrolls a bit.

Yes, @tsa321 i said it has a different root cause 😄

seems like it has a different root cause @tsa321 mentioned.

I am just answering for #51381 (comment)

@tsa321
Copy link
Contributor Author

tsa321 commented Nov 21, 2024

@getusha Oh ok, sorry I misunderstood.

Signed-off-by: Tsaqif <[email protected]>
@tsa321
Copy link
Contributor Author

tsa321 commented Nov 21, 2024

@getusha I have reverted the changes in the deleteTask

Copy link
Contributor

@getusha getusha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this one is good to go!

@melvin-bot melvin-bot bot requested a review from deetergp November 26, 2024 19:32
Copy link
Contributor

@deetergp deetergp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't really think we need the comments—let's drop them.

Signed-off-by: Tsaqif <[email protected]>
@tsa321
Copy link
Contributor Author

tsa321 commented Nov 28, 2024

@deetergp I have removed the comments.

@tsa321 tsa321 requested a review from deetergp November 28, 2024 06:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants