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: unify word breaking in ContextMenuItem for Android mweb and Android native #31116

Merged
merged 8 commits into from
Dec 8, 2023

Conversation

artus9033
Copy link
Contributor

@artus9033 artus9033 commented Nov 9, 2023

Details

Sliding context menu used for copying email address from chat to clipboard on Android native and Android mobile web inconsistently breaks words when breaking lines in case the email width exceeds screen width.

Fixed Issues

$ #30985

PROPOSAL:
#30985 (comment)

Tests

  • Open a chat
  • Send a message to the chat, containing a long email: testtesttesttesttesttesttesttesttesttest@company.company.company.company.company.com
  • Long-press the message to open copy email context menu
  • Ensure that the email is broken between lines in a consistent manner
  • Repeat for Android Native & Android mWeb

Offline tests

Same as Tests

QA Steps

  • 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(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.

Screenshots/Videos

Android: Native image
Android: mWeb Chrome image
iOS: Native image
iOS: mWeb Safari image
MacOS: Chrome / Safari image image
MacOS: Desktop image

Copy link
Contributor

github-actions bot commented Nov 9, 2023

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

@artus9033
Copy link
Contributor Author

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

@mananjadhav
Copy link
Collaborator

@artus9033 Can you confirm once this ready for review?

Also I would recommend posting videos for all the platform, despite only Android being added as the problematic platforms.

…tunities to separate functions in src/pages/home/report/ContextMenu/ContextMenuActions.js
@artus9033 artus9033 marked this pull request as ready for review November 29, 2023 09:19
@artus9033 artus9033 requested a review from a team as a code owner November 29, 2023 09:19
@melvin-bot melvin-bot bot requested review from mananjadhav and removed request for a team November 29, 2023 09:19
Copy link

melvin-bot bot commented Nov 29, 2023

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

@artus9033
Copy link
Contributor Author

artus9033 commented Nov 29, 2023

@mananjadhav the PR is ready for review. I also updated the screenshots section to cover all platforms.

@mananjadhav
Copy link
Collaborator

@artus9033 When I am testing this at my end, I can see the email is getting truncated. Can you please check this?

image

@artus9033
Copy link
Contributor Author

@artus9033 When I am testing this at my end, I can see the email is getting truncated. Can you please check this?

Indeed, I am getting the same ellipsization behaviour on my side from the beginning, however I assumed this is desired behaviour since it is also present in staging and the original issue only mentioned inconsistent breaking of text as an issue, but did not say about ellipsization. Are you certain that we want to change the current behaviour @mananjadhav ? If so, I will add the appropriate changes.

@mananjadhav
Copy link
Collaborator

@artus9033 I checked on staging and your PR author checklist. Both have different behavior ( and not ellipses).

PR authchecklist
image

Staging
Screenshot 2023-12-03 at 10 00 59 PM

@artus9033
Copy link
Contributor Author

artus9033 commented Dec 6, 2023

@mananjadhav, as I see it, this is current behaviour since this probably depends on the DPI of device's screen / modal dialog size. If you use a longer email in such cae, you will see that it ellipsizes as well. The screenshots for desktop may be a bit confusing here, since they were taken with the window resized so they were displaying as full-width pop-ups, but if they are resized to be wider, then the pop-up shows as floating and the text should be ellipsized if the screen cannot fit the mail:
image

@mananjadhav
Copy link
Collaborator

@artus9033 I understand the screensize/DPI can have an impact, but the screencast that I shared (and sharing again here) is on the same display, browser, account, chat just two tabs.

Screen.Recording.2023-12-07.at.11.55.04.AM.mov

@artus9033
Copy link
Contributor Author

artus9033 commented Dec 7, 2023

I see, that is true, however the cause here will be rather expectable and coming from the old behaviour. The old behaviour present in staging is that any sufficiently long text will be ellipisized and why this ellipisization happens with the fix applied is because the text is carried to a new line earlier than before ("wasting" some space in the first line) and happens to be overlong in the second line.

If we are certain that this is something that we want to change, I can think of one solution - to unlock the limit of lines in that text view and disable ellipsization. Do you think we can go with this approach?

@mananjadhav
Copy link
Collaborator

I think it would be better to confirm with @Julesssss about this.

@Julesssss
Copy link
Contributor

The old behaviour present in staging is that any sufficiently long text will be ellipisized and why this ellipisization happens with the fix applied is because the text is carried to a new line earlier than before

I agree with @artus9033 here that this is fine -- assuming that the full email is actually pasted to the clipboard 😄

@artus9033
Copy link
Contributor Author

Great, thanks! There is one more thing I saw on @mananjadhav's recording now - that is probably out-of-scope of this issue - however when hovering an email on desktop, there is a tooltip being shown with the mail that can also be split between lines. This popup is for non-mobile devices only, however the manner in which it is split is old-behaviour alike, that is, it can happen anywhere inside words. I'm not sure if we also want to fix this with the same approach as we just did for the context menu here (since we extracted that to a separate function for such cases), or is this a case for a separate issue @Julesssss?
image

@Julesssss
Copy link
Contributor

I'm not sure if we also want to fix this with the same approach as we just did for the context menu here (since we extracted that to a separate function for such cases), or is this a case for a separate issue @Julesssss?

Lets leave that as a separate issue 👍

@artus9033
Copy link
Contributor Author

Sure thing, then now the PR should be ready for review
CC: @mananjadhav

@mananjadhav
Copy link
Collaborator

Thanks I'll have it reviewed today/tomorrow.

@mananjadhav
Copy link
Collaborator

@artus9033 Can you please fix the conflicts?

@mananjadhav
Copy link
Collaborator

mananjadhav commented Dec 7, 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(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 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
android-copy-email.mov
Android: mWeb Chrome
mweb-chrome-copy-email.mov
iOS: Native
ios-copy-email.mov
iOS: mWeb Safari
mweb-safari-copy-email.mov
MacOS: Chrome / Safari
web-copy-email.mov
MacOS: Desktop
desktop-copy-email.mov

@artus9033
Copy link
Contributor Author

artus9033 commented Dec 7, 2023

Sure thing @mananjadhav. The recent conflicts have been resolved

@Julesssss Julesssss merged commit 6129c67 into Expensify:main Dec 8, 2023
14 of 15 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Dec 8, 2023

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

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/Julesssss in version: 1.4.11-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/Julesssss in version: 1.4.11-25 🚀

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

return email.replace(
/([.@])/g,
// below: zero-width space (U+200B) character
'​$1',
Copy link
Contributor

Choose a reason for hiding this comment

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

Adding a zero-width space to email caused it issue when email is copied by user and pasted in other places, especially login page - #34437

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.

6 participants