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

upgrade react-native-live-markdown to 0.1.76 #42454

Merged
merged 2 commits into from
May 27, 2024

Conversation

fabOnReact
Copy link
Contributor

@fabOnReact fabOnReact commented May 22, 2024

Details

Bump react-native-live-markdown to 0.1.76 to add fix from PR Expensify/react-native-live-markdown#350.

The PR updates the NSBaselineOffsetAttributeName for the iOS TextInputattributedText based on the following formula:

CGFloat baseLineOffset = (maximumLineHeight - maximumFontLineHeight) / 2.0;

The text is vertically centered in the lineHeight of the TextInput (which corresponds to the height of the cursor).
The solution was already added in facebook/react-native:

Fixed Issues

$ #17767
$ #14445
$ #15640
PROPOSAL: #17767 (comment)

Tests

Text in some languages gets cut off at the bottom in composer on ios #17767

  1. Go to a report
  2. Paste this text in the composer: "समुद्री उल्लू"
  3. Verify that the bottom of the character मु is not cut off (before, after)

When moving to another line, the word and emoji are close to each other #14445

  1. Launch the app
  2. Login with any account
  3. In the compose box enter a message using tall letters like j on the first line and emoji like 💀 (skull) on the second line
  4. Verify that the text on the first line and the emojis on the second are vertically centered and not overlapping (before, after)

Cursor in the second and following lines touches the symbols of the previous line #15640

  1. Open the app
  2. Sign in with any account
  3. Go to any chat
  4. Type tall characters like j, p, q in the first line
  5. Move the cursor to the second line and verify that it does not touch the characters (j, p, q) of the first line (before, after)
  • Verify that no errors appear in the JS console

Offline tests

Not relevant.

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 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: mWeb Chrome

Screenshot_1716434309

iOS: Native

Text in some languages gets cut off at the bottom in composer on ios

Issue #17767
Original comment with screenshots Expensify/react-native-live-markdown#350

Before After

Expensify Composer (When moving to another line, the word and emoji are close to each other):

Issue #14445
Original comment with screenshots Expensify/react-native-live-markdown#350

The difference of baseline is 1.15 (barely noticeable), maximumLineHeight 20, maximumFontLineHeight 17.69

Before After
Before After

The result below is achieved after setting textInputCompose.lineHeight: 40.

  • baseLineOffset is 11.15
  • maximumLineHeight is 40
  • maximumFontLineHeight is 17.69
Before After
Before After
Before After

Chat - Cursor in the second and following lines touches the symbols of the previous line

Issue #15640
Original Comment with screenshots #15640 (comment)

Before After
iOS: mWeb Safari

Simulator Screenshot - iPhone 15 Pro - 2024-05-23 at 11 42 09

MacOS: Chrome / Safari Screenshot 2024-05-23 at 11 01 37 AM
MacOS: Desktop Screenshot 2024-05-23 at 11 46 01 AM

@fabOnReact fabOnReact marked this pull request as ready for review May 23, 2024 04:05
@fabOnReact fabOnReact requested a review from a team as a code owner May 23, 2024 04:05
@melvin-bot melvin-bot bot requested review from eVoloshchak and removed request for a team May 23, 2024 04:05
Copy link

melvin-bot bot commented May 23, 2024

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

@eVoloshchak
Copy link
Contributor

eVoloshchak commented May 24, 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 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 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

Screenshot_20240524-132543

Android: mWeb Chrome Screenshot 2024-05-24 at 13 23 34
iOS: Native

Simulator Screenshot - iPhone 15 Pro - 2024-05-24 at 11 26 32

Simulator Screenshot - iPhone 15 Pro - 2024-05-24 at 13 23 23

iOS: mWeb Safari

Simulator Screenshot - iPhone 15 Pro - 2024-05-24 at 13 24 54

MacOS: Chrome / Safari Screenshot 2024-05-24 at 13 23 55
MacOS: Desktop Screenshot 2024-05-24 at 13 24 24

Copy link
Contributor

@eVoloshchak eVoloshchak left a comment

Choose a reason for hiding this comment

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

Works well!

Tests section could be improved, all 3 scenarios lack the final step
(for the first it would look something like "3. Verify the bottom of the text isn't cut off", for the second "Verify that xext entered and emojis on the next line are not close to each other" and so on)

@fabOnReact
Copy link
Contributor Author

Tests

Text in some languages gets cut off at the bottom in composer on ios #17767

  1. Go to a report
  2. Paste this text in the composer: "समुद्री उल्लू"
  3. Verify that the bottom of the character मु is not cut off (before, after)

When moving to another line, the word and emoji are close to each other #14445

  1. Launch the app
  2. Login with any account
  3. In the compose box enter a message using tall letters like j on the first line and emoji like 💀 (skull) on the second line
  4. Verify that the text on the first line and the emojis on the second are vertically centered and not overlapping (before, after)

Cursor in the second and following lines touches the symbols of the previous line #15640

  1. Open the app
  2. Sign in with any account
  3. Go to any chat
  4. Type tall characters like j, p, q in the first line
  5. Move the cursor to the second line and verify that it does not touch the characters (j, p, q) of the first line (before, after)

@fabOnReact
Copy link
Contributor Author

iOS: Native

Text in some languages gets cut off at the bottom in composer on ios

Issue #17767
Original comment with screenshots Expensify/react-native-live-markdown#350

Before After

Expensify Composer (When moving to another line, the word and emoji are close to each other):

Issue #14445
Original comment with screenshots Expensify/react-native-live-markdown#350

The difference of baseline is 1.15 (barely noticeable), maximumLineHeight 20, maximumFontLineHeight 17.69

Before After
Before After

The result below is achieved after setting textInputCompose.lineHeight: 40.

  • baseLineOffset is 11.15
  • maximumLineHeight is 40
  • maximumFontLineHeight is 17.69
Before After
Before After
Before After

Chat - Cursor in the second and following lines touches the symbols of the previous line

Issue #15640
Original Comment with screenshots #15640 (comment)

Before After

@fabOnReact
Copy link
Contributor Author

Thanks @eVoloshchak

  • I updated the Test section as requested (more details in this comment)
  • I updated the iOS: Native section. Some of the screenshot got corrupted (more details in this comment)

Copy link
Contributor

@eVoloshchak eVoloshchak 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 marcochavezf May 27, 2024 13:16
@marcochavezf marcochavezf merged commit cabf71d into Expensify:main May 27, 2024
25 of 27 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.

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/marcochavezf in version: 1.4.77-0 🚀

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

@ishpaul777
Copy link
Contributor

Hello 👋 @fabOnReact @eVoloshchak, This PR is reverted #42843 because of a regression #42766

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/puneetlath in version: 1.4.77-11 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/puneetlath in version: 1.4.77-11 🚀

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

@mountiny
Copy link
Contributor

mountiny commented Jun 4, 2024

Also want to highlight this bug that was found in the updated version https://expensify.slack.com/archives/C049HHMV9SM/p1717078251523439

if you cannot access here is a video:

  1. in iOS native write a message with emoji in it
  2. try to select using selection drag
  3. try to select using double-tap
  4. it does not worr/ does not work well
RPReplay_Final1717078125.MP4

@fabOnReact
Copy link
Contributor Author

fabOnReact commented Jun 5, 2024

@mountiny it is not related to the changes in my PR Expensify/react-native-live-markdown#350

Thanks

Screen.Recording.2024-06-05.at.11.39.40.AM.mov

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