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

Fixed regression Android - Chat - Message gets displayed from right to left #33721

Conversation

samilabud
Copy link
Contributor

@samilabud samilabud commented Dec 28, 2023

Details

The root cause is that Android only converts RTL text to LTR text using Unicode controls and by default, when you start writing in a language that is written in RTL mode it converts the input text to RTL.
Here we are fixing this regression, this was caused because we did not take into consideration when the composer load for the first time and the user started writing with @, we include the @ in the regular expression list to validate if the composer can be converted to LTR.

Fixed Issues

$ #30584
PROPOSAL: #30584 (comment)

Tests

  1. Launch App
  2. Open any chat and paste an RTL text in the compose box, for example " مثال "
  3. Continue typing some content
  • Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Test 1.

  1. Launch App
  2. Open any chat and paste an RTL text in the compose box, for example " مثال "
  3. Continue typing some content

Test 2.

  1. Launch App
  2. Open any chat and type @, should show a suggestion list
  3. Continue typing some content
  4. Delete everything, the composer should show the placeholder.

Test 3.

  1. Launch App
  2. Open any chat and enter line breaks (to convert the composer into multiline)
  3. Type spaces and @, check if everything works.
  • 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 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 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 form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label 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
regression.test.-.android.-.reduced.mp4
Android: mWeb Chrome
regression.test.-.chrome.android.mov
iOS: Native
regression.test.-.iphone.mov
iOS: mWeb Safari
regression.test.-.safari.iphone.mov
MacOS: Chrome / Safari
regression.test.-.chrome.mac.-.reduced.mp4
MacOS: Desktop
regression.test.-.mac.desktop.mov

@samilabud samilabud requested a review from a team as a code owner December 28, 2023 18:33
@melvin-bot melvin-bot bot requested review from allroundexperts and removed request for a team December 28, 2023 18:33
Copy link

melvin-bot bot commented Dec 28, 2023

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

@allroundexperts
Copy link
Contributor

@samilabud Conflicts!

@samilabud
Copy link
Contributor Author

@samilabud Conflicts!

Done!, thank you for letting me know, I hadn't noticed 😅.

@allroundexperts
Copy link
Contributor

Hi @samilabud!

This is still not working as expected. Please check below.

Screen.Recording.2024-01-14.at.1.31.53.AM.mov

@samilabud
Copy link
Contributor Author

Hi @samilabud!

This is still not working as expected. Please check below.

Screen.Recording.2024-01-14.at.1.31.53.AM.mov

Thanks for testing!, I have fixed the -at/@- regex to take into consideration the mention/searching, please double check:

Testing.chat.form.right.to.left.-.mention.search.mp4

@allroundexperts
Copy link
Contributor

Reviewing again tomorrow.

@allroundexperts
Copy link
Contributor

@samilabud I am still seeing the following two errors:

Screen.Recording.2024-01-25.at.5.49.21.AM.mov
Screen.Recording.2024-01-25.at.5.49.45.AM.mov

At this point, since we have gone back and forth across this several times now, I think its not worth spending more of our time on this.

@samilabud
Copy link
Contributor Author

@allroundexperts I understand your point and I'm sorry for this back and forth, in my defense according to my tests of the first video bug can be reproduced in the Main branch, and the second is because the colon character was not in the list of allowed not to convert the input to RTL, if there are more characters like @ or : that trigger other events would be good to know to add them all to the list.

Result with the colon added:

Colon.added.mov

@allroundexperts
Copy link
Contributor

Another bug @samilabud:

Screen.Recording.2024-02-01.at.2.30.53.AM.mov

@samilabud
Copy link
Contributor Author

Another bug @samilabud:

Screen.Recording.2024-02-01.at.2.30.53.AM.mov

OMG 😣, it's fixed now.

Note: This strange behavior was happening even with @ (when tagging), because the LTR conversion was being called twice because the regular expression was only being taken into account for when to start writing in the composer.

Result:

Chat.to.LTR.test.fixed.mp4

@tgolen
Copy link
Contributor

tgolen commented Feb 26, 2024

What's the status of this PR? Are there any plans to finish it?

@allroundexperts
Copy link
Contributor

This can be closed given we've closed the issue as well.

@allroundexperts
Copy link
Contributor

Hi @samilabud!
Can you please close this PR?

@samilabud samilabud closed this Apr 28, 2024
@samilabud samilabud deleted the android_chat_displayed_right_to_left_30584_fixed branch April 29, 2024 16:33
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