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

RTL Text gets renderd properly #29434

Conversation

HardikChoudhary24
Copy link
Contributor

@HardikChoudhary24 HardikChoudhary24 commented Oct 12, 2023

Details

Chat - Compose box - Wrong cursor position for RTL texts and inverted arrow keys functionality

Fixed Issues

$ #28149
PROPOSAL: #28149 (comment)

Tests

  1. Open any chat and paste an RTL text in the compose box, for example " مثال "
  2. Continue typing some content
  3. Verify that the content gets displayed from left to right
  4. Verify that using arrow keys proper traversal is possible.
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

  1. Open any chat and paste an RTL text in the compose box, for example " مثال "
  2. Continue typing some content.
  3. Verify that the content gets displayed from left to right.
  4. Verify that using arrow keys proper traversal is possible.
  • 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 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 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

MacOS: Chrome
chrome.mp4
MacOS: Desktop
desktop.mp4
Android: mWeb Chrome
chromeMobile.mp4
iOS: Native
ios.mp4
iOS: mWeb Safari
newMSafari.mp4
MacOS: Safari
NewSafari.mp4
Android: Native
android.mp4

@HardikChoudhary24 HardikChoudhary24 requested a review from a team as a code owner October 12, 2023 12:38
@melvin-bot melvin-bot bot requested review from burczu and removed request for a team October 12, 2023 12:38
@melvin-bot
Copy link

melvin-bot bot commented Oct 12, 2023

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

@github-actions
Copy link
Contributor

github-actions bot commented Oct 12, 2023

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

@HardikChoudhary24
Copy link
Contributor Author

I have read the CLA Document and I hereby sign the CLA

@HardikChoudhary24
Copy link
Contributor Author

HardikChoudhary24 commented Oct 12, 2023

@burczu I have made the changes as per the discussion.
When I was testing the changes on different platforms i found that the change is working as expected on :

  1. Chrome Web browser
  2. Mobile Chrome browser
  3. MacOs Desktop
  4. IOS native
  5. MacOs Safari
  6. Mobile Safari

But on android native the convertToLTR funciton does not works properly. It breaks the input box functionality.This is because Android does not properly support bidirectional text for mixed content due to missing support for writingDirection, this is what i came to know when I searched on the internet. Thats why I have added an extra check to know whether the platform is android or not

@HardikChoudhary24
Copy link
Contributor Author

@burczu I have resolved the merge conflicts and also added changes to ensure proper rendering on Safari as well.

src/libs/convertToLTR/index.ts Outdated Show resolved Hide resolved
src/libs/convertToLTR/index.ts Outdated Show resolved Hide resolved
@burczu
Copy link
Contributor

burczu commented Oct 17, 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: 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 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

Web
Screen.Recording.2023-10-17.at.10.57.04.mov
Mobile Web - Chrome
Screen.Recording.2023-10-19.at.10.00.18.mov
Mobile Web - Safari

Unable to test...

Desktop
Screen.Recording.2023-10-17.at.10.54.36.mov
iOS
Screen.Recording.2023-10-17.at.10.50.05.mov
Android
Screen.Recording.2023-10-17.at.10.48.54.mov

@burczu
Copy link
Contributor

burczu commented Oct 17, 2023

@HardikChoudhary24 I'm testing on all the devices and it looks like something is broken on iOS mWeb - please take a look below:

Screen.Recording.2023-10-17.at.11.02.43.mov

Works well on other devices (except native Android, but you've explained why). Can you confirm?

@HardikChoudhary24
Copy link
Contributor Author

@HardikChoudhary24 I'm testing on all the devices and it looks like something is broken on iOS mWeb - please take a look below:

Screen.Recording.2023-10-17.at.11.02.43.mov
Works well on other devices (except native Android, but you've explained why). Can you confirm?

I think you are using laptop keyboard can you try with the inbuilt ios keyboard

Screen.Recording.2023-10-17.at.2.45.13.PM.mov

Its working as expected on my device

@burczu
Copy link
Contributor

burczu commented Oct 17, 2023

@HardikChoudhary24 I've just tested with native keyboard and the same effect. To be sure I have nothing cached etc, I've also used private tab in Safari...

@HardikChoudhary24
Copy link
Contributor Author

@burczu I have tested and checked all possibilities but I am not able to reproduce it. I have also tried on a private tab, but I am getting the expected result. Is there anything you would like to suggest?

@HardikChoudhary24
Copy link
Contributor Author

Hey @burczu is the above issue resolved which you were facing during testing or is there anything that I can do on my end as I am not able to reproduce it?

@burczu
Copy link
Contributor

burczu commented Oct 18, 2023

@HardikChoudhary24 I'm sorry, I didn't have time yet to get back to it... I'll do my best to do it soon.

@burczu
Copy link
Contributor

burczu commented Oct 18, 2023

@HardikChoudhary24 Checked one more time, but first erased all the content and settings on my iPhone simulator and restarted it. Unfortunately with no luck, it just not working for iOS mWeb... Are you sure you have no uncommitted changes or smth?

P.S. You have now merge conflicts.

@HardikChoudhary24
Copy link
Contributor Author

@HardikChoudhary24 Checked one more time, but first erased all the content and settings on my iPhone simulator and restarted it. Unfortunately with no luck, it just not working for iOS mWeb... Are you sure you have no uncommitted changes or smth?

P.S. You have now merge conflicts.

I will just resolve the merge conflicts and push the code one more time. After that please check once

@HardikChoudhary24
Copy link
Contributor Author

@burczu after deleting and erasing all the content on my current simulator I have checked it again but its still showing me the expected result.
So can you please verify once that all my changes are applied on your local machine and if the issue still persists then can it be moved forward so that the internal engineer can review it once on their local. Or is there anything else that you want to suggest.

Screen.Recording.2023-10-18.at.5.13.00.PM.mov

@HardikChoudhary24
Copy link
Contributor Author

Hey @burczu I asked one of my friends to pull the changes and try this once on his physical ios device and he is also getting the expected result.

WhatsApp.Video.2023-10-18.at.6.32.43.PM.mp4

Copy link
Contributor

@burczu burczu left a comment

Choose a reason for hiding this comment

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

LGTM, but it must be tested on iOS mWeb, because it didn't work for me.

@burczu
Copy link
Contributor

burczu commented Oct 19, 2023

@neil-marcellini Please check if it works for you on iOS mWeb, because it doesn't for me, but it does for @HardikChoudhary24. Thank you.

Copy link
Contributor

@neil-marcellini neil-marcellini left a comment

Choose a reason for hiding this comment

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

Looking pretty good but I have some questions. I can test on iOS Safari next time

@@ -226,7 +227,7 @@ function ComposerWithSuggestions({
}
emojisPresentBefore.current = emojis;
setIsCommentEmpty(!!newComment.match(/^(\s)*$/));
setValue(newComment);
setValue(Platform.OS === 'android' ? newComment : convertToLTR(newComment));
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't get this. Before we only converted on android, now we are not. Why? Should the logic be flipped?

Also we prefer platform specific files vs using Platform.OS.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Previously we used this only for android to get the desired result for components that are using convertToLTR function but previously we were not using the function for input box. Now we are doing it for those components as well as for the input box also. But in case of android we don't want the text inside input box to get converted by the converToLTR function because it breaks the input box functionality. This is because Android does not properly support bidirectional text for mixed content due to missing support for writingDirection. So now we want to use convertToLTR function for all platforms including android but we don't want it in case of input box of android. So just for the input box of android we need a check to see whether the platform is android or not.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

If we make specific file for android in which we return plane text in that case it will apply to all components of android as well for the input box of android also. But we require the function to return plane text just in case of input box of android, we want it to work normally when its used inside other components of android. So to do this I think we can just check the platform when using it inside the input box.

Copy link
Contributor

Choose a reason for hiding this comment

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

Great thank you for the explanation. I think I understand now. However, we are really strict about not using Platform.OS. You said "now we want to use convertToLTR function for all platforms including android but we don't want it in case of input box of android". So let's just use a custom convertToLTR function in an android specific file for ComposerWithSuggestions. Or we could create a separate module convertToLTRForComposer which has an android specific implementation. That's probably best. Also please include a comment about why we need to do this.

src/components/Composer/index.js Outdated Show resolved Hide resolved
Copy link
Contributor

@neil-marcellini neil-marcellini left a comment

Choose a reason for hiding this comment

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

Ok, thanks for the updates. Looking good to me! @burczu would you please test again before merging?

src/libs/convertToLTRForComposer/types.ts Show resolved Hide resolved
@burczu
Copy link
Contributor

burczu commented Oct 25, 2023

@neil-marcellini Re-tested and it still does not work as expected on iOS mWeb - could you please check on your side, because it may be just something with my environment.

@HardikChoudhary24
Copy link
Contributor Author

Hey @neil-marcellini are you getting the expected result on iOS mWeb or is there anything that I can do on my end because its working as expected on my local.

@neil-marcellini
Copy link
Contributor

Oh right, I'll test today

Copy link
Contributor

@neil-marcellini neil-marcellini left a comment

Choose a reason for hiding this comment

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

It works well for me on iOS Safari

Simulator.Screen.Recording.-.iPhone.15.-.2023-10-26.at.12.52.06.mp4
Simulator.Screen.Recording.-.iPhone.15.-.2023-10-26.at.12.50.23.mp4

@HardikChoudhary24
Copy link
Contributor Author

@neil-marcellini Thanks for your feedback. Is there anything else that needs to be addressed at my end?

@neil-marcellini neil-marcellini merged commit eef8347 into Expensify:main Oct 27, 2023
16 checks passed
@neil-marcellini
Copy link
Contributor

I wish github had a button for "auto merge if all check pass".

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

@situchan
Copy link
Contributor

This PR caused regression. Emoji/Mention suggestions not showing at all

Screen.Recording.2023-10-27.at.7.08.07.PM.mov

@HardikChoudhary24
Copy link
Contributor Author

@situchan , I've identified the root cause of this regression and fixed it. This was happening because of '\u2066' being added at the beginning of the string, which was not triggering the suggestion. Should I raise a new PR for this?

@situchan
Copy link
Contributor

@HardikChoudhary24 yes please. I can help review if needed.

@HardikChoudhary24
Copy link
Contributor Author

HardikChoudhary24 commented Oct 27, 2023

Thanks @situchan. I will raise the PR with the fix.

@HardikChoudhary24
Copy link
Contributor Author

@situchan I have raised the PR with the fix. Please review it.

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/neil-marcellini in version: 1.3.93-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/Beamanator in version: 1.3.93-1 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/neil-marcellini in version: 1.3.94-0 🚀

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

1 similar comment
@OSBotify
Copy link
Contributor

OSBotify commented Nov 1, 2023

🚀 Deployed to staging by https://github.com/neil-marcellini in version: 1.3.94-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Nov 2, 2023

🚀 Deployed to production by https://github.com/Beamanator in version: 1.3.94-2 🚀

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

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.

5 participants