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: show main composer when there is no focused draft #23618

Merged
merged 12 commits into from
Jul 28, 2023

Conversation

s-alves10
Copy link
Contributor

@s-alves10 s-alves10 commented Jul 26, 2023

Details

Case 1

  • Switch to edit mode in message A
  • Switch to edit mode in message B
  • Hide keyboard(Press back button)
  • Main Composer is shown but it shouldn't because focus is still on message B

Case 2

  • Switch to edit mode in message A
  • Switch to edit mode in message B
  • Click the cancel button of message A
  • Main Composer is shown but it shouldn't because focus is still on message B

Both issues happen on mobile platforms

Fixed Issues

$ #17531
PROPOSAL: #17531 (comment)

Tests

All tests should be done only on mWeb and native platforms

  1. Login with any account and go to any chat
  2. Send two messages(message A and B)
  3. Switch message A to edit mode
  4. Verify that the main composer is hidden
  5. Switch message B to edit mode
  6. Hide the keyboard(back button)
  7. Verify that the main composer is hidden
  8. Close or Save message A
  9. Verify that the main composer is hidden
  10. Close message B
  11. Verify that the main composer is shown
  • Verify that no errors appear in the JS console

Offline tests

All tests should be done only on mWeb and native platforms

  1. Login with any account and go to any chat
  2. Send two messages(message A and B)
  3. Switch message A to edit mode
  4. Verify that the main composer is hidden
  5. Switch message B to edit mode
  6. Hide the keyboard(back button)
  7. Verify that the main composer is hidden
  8. Close or Save message A
  9. Verify that the main composer is hidden
  10. Close message B
  11. Verify that the main composer is shown

QA Steps

All tests should be done only on mWeb and native platforms

  1. Login with any account and go to any chat
  2. Send two messages(message A and B)
  3. Switch message A to edit mode
  4. Verify that the main composer is hidden
  5. Switch message B to edit mode
  6. Hide the keyboard(back button)
  7. Verify that the main composer is hidden
  8. Close or Save message A
  9. Verify that the main composer is hidden
  10. Close message B
  11. Verify that the main composer is shown
  • 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
    • If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
    • 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
17531_mac_chrome.mp4
Mobile Web - Chrome
17531_android_chrome.mp4
Mobile Web - Safari
17531_ios_safari.mp4
Desktop
17531_mac_desktop.mp4
iOS
17531_ios_native.mp4
Android
17531_android_native.mp4

@s-alves10 s-alves10 marked this pull request as ready for review July 26, 2023 06:36
@s-alves10 s-alves10 requested a review from a team as a code owner July 26, 2023 06:36
@melvin-bot melvin-bot bot requested review from s77rt and removed request for a team July 26, 2023 06:36
@melvin-bot
Copy link

melvin-bot bot commented Jul 26, 2023

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

@techievivek
Copy link
Contributor

CC @HezekielT in case you wanna help with the reviews.

@HezekielT
Copy link
Contributor

@s-alves10 In Details section of the PR you said, Main composer should be shown because message B has still focus but doesn't work. I think it should be changed to Main composer should not be shown because message B has still focus but doesn't work in both cases. just a little correction.
`

@s-alves10
Copy link
Contributor Author

@s-alves10 In Details section of the PR you said, Main composer should be shown because message B has still focus but doesn't work. I think it should be changed to Main composer should not be shown because message B has still focus but doesn't work in both cases. just a little correction. `

Updated

@s-alves10
Copy link
Contributor Author

@s77rt

Will you take a look again?

@s-alves10
Copy link
Contributor Author

@s77rt

Please take a look again. Thank you

@s77rt
Copy link
Contributor

s77rt commented Jul 26, 2023

@s-alves10 Thanks! Overall code looks good. Will test this asap. In the time being please update the details section to use the cases from here #17531 (comment). Saying "Edit message A" indicates that the user has to actually edit the message and save it but it's not the case here.

@s-alves10
Copy link
Contributor Author

@s77rt

Details section updated based on #17531 (comment)

@s77rt
Copy link
Contributor

s77rt commented Jul 26, 2023

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

web

Mobile Web - Chrome
mweb-chrome.mp4
Mobile Web - Safari
mweb-safari.mp4
Desktop

desktop

iOS
ios.mp4
Android
android.mp4

@s77rt
Copy link
Contributor

s77rt commented Jul 27, 2023

Sorry I missed the commit. I think we have a race condition problem:

  1. Open chat in 2 devices
  2. In device A, switch message A to edit mode and open emoji picker
  3. In device B, delete message A
  4. In device A
    • We will first call EmojiPickerAction.hideEmojiPicker from ReportActionItem and this will set report action to empty object.
    • Now in ReportActionItemMessageEdit EmojiPickerAction.isActiveReportAction will return false and the Main Composer will not be shown and there will be no other input to type in

@s-alves10
Copy link
Contributor Author

@s77rt

Is that what you tested? I'm afraid you're over-engineering. Also, I think there is no such case you mentioned #23618 (comment)

If EmojiPicker is hidden, EmojiPickerAction.isActiveReportAction would return false, If the message A was focused, it'll show the composer on unmount, and if the message A wasn't focused, the composer wasn't hidden.

@s77rt
Copy link
Contributor

s77rt commented Jul 27, 2023

@s-alves10

if the message A wasn't focused, the composer wasn't hidden

This is not true. If the message A wasn't focused then we have nothing to say, we can't deduct the status of the composer. There is a case where message A wasn't focused and the composer was hidden which is the emoji picker case.

  1. Message A is focused
  2. Main composer is hidden
  3. Open EmojiPicker
  4. Message A is blurred but Main Composer is still hidden
  5. Now if we delete message A, we will say message A wasn't focused and the composer was hidden <- basically the scenario described above

@s-alves10
Copy link
Contributor Author

@s77rt

I've tested the above scenario, but I didn't see the situation. Did you test on your side?

@s77rt
Copy link
Contributor

s77rt commented Jul 27, 2023

@s-alves10 It's a race condition. The only reason the bug is not reproducible because setReportAction is async. If we call EmojiPickerAction.hideEmojiPicker and EmojiPickerAction.isActiveReportAction too quickly then the second function will return true although we unset the report action in the first function call.

@s-alves10
Copy link
Contributor Author

@s77rt

This is a general operation. If this is the case, we are not able to rely on useState hook because its returned setter is async. Moreover, that would beyond the scope of this issue.

@s-alves10
Copy link
Contributor Author

@HezekielT

Please share your idea regarding #23618 (comment) and #23618 (comment)

cc @s77rt

@s-alves10 s-alves10 requested a review from s77rt July 28, 2023 16:54
@s77rt
Copy link
Contributor

s77rt commented Jul 28, 2023

@s-alves10 After discussion, we want to handle the emoji picker case separately, can you please revert the last commit?

@s-alves10
Copy link
Contributor Author

@s77rt

Reverted

@s77rt
Copy link
Contributor

s77rt commented Jul 28, 2023

@s-alves10 Thank you

Copy link
Contributor

@s77rt s77rt left a comment

Choose a reason for hiding this comment

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

LGTM! 🚀

@melvin-bot melvin-bot bot requested a review from techievivek July 28, 2023 17:11
Copy link
Contributor

@techievivek techievivek left a comment

Choose a reason for hiding this comment

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

Looks good, just a quick question. Thanks for the quick work. 🎉

@techievivek techievivek merged commit 7d88540 into Expensify:main Jul 28, 2023
18 checks passed
@OSBotify
Copy link
Contributor

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

@techievivek
Copy link
Contributor

@s-alves10 @HezekielT Created an issue for the bug highlighted here, feel free to share proposals on the issue if you are interested, thanks.

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/techievivek in version: 1.3.48-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Aug 1, 2023

🚀 Deployed to production by https://github.com/puneetlath in version: 1.3.48-5 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Aug 2, 2023

🚀 Deployed to staging by https://github.com/techievivek in version: 1.3.49-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Aug 3, 2023

🚀 Deployed to production by https://github.com/Beamanator in version: 1.3.49-3 🚀

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

@s-alves10 s-alves10 deleted the fix/issue-17531 branch November 22, 2023 16:44
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.

None yet

6 participants