[Android / iOS] Code blocks are overflowing the app border #44953

cdOut · 2024-07-08T11:04:52Z

Details

Fixing how the code block gets formatted for native devices. On main code blocks don't get wrapped properly when the text overflows the container width and cuts it off, this PR is fixing this issue for both native devices.

Fixed Issues

$ #27913
PROPOSAL:

Tests

Go into any chat report.
Type the suggested message below, it's been prepared for testing purposes:

`thissadasdasdsadsadasdadsadasdasdasdasdasdasdasdasdasdasdsadsadggggggggggggggggg` multilingual 
`https://www.google.com/search?q=google&oq=goog&gs_lcrp=EgZjaHJvbWUqEAgAEAAYgwEY4wIYsQMYgAQyEAgAEAAYgwEY4wIYsQMYgAQyEwgBEC4YgwEYxwEYsQMY0QMYgAQyDQgCEAAYgwEYsQMYgAQyBggDEEUYOzIGCAQQRRg8MgYIBRBFGDwyBggGEEUYPDIGCAcQBRhA0gEHNzM1ajBqN6gCALACAA&sourceid=chrome&ie=UTF-8`

Confirm that the message displays and wraps around properly for both IOS and Android native.

Verify that no errors appear in the JS console

Offline 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 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

iOS: Native

melvin-bot · 2024-09-10T16:19:31Z

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

parasharrajat · 2024-09-10T20:56:40Z

src/components/InlineCodeBlock/WrappedText.tsx

+    const charWidth = variables.fontSizeLabel * variables.fontSizeToWidthRatio;
+    const charsPerLine = Math.floor(windowWidth / charWidth);
+
+    const textMatrix = getTextMatrix(children).map((row) => row.flatMap((word) => splitLongWord(word, charsPerLine)));


let use memo here.

What do you suggest we memoize here, just the textMatrix or do you think the other values as well?

I think all values as they are solely used for textmarix.

parasharrajat · 2024-09-10T21:00:32Z

src/components/InlineCodeBlock/WrappedText.tsx


    if (typeof children !== 'string') {
        return null;
    }

-    const textMatrix = getTextMatrix(children);
+    const charWidth = variables.fontSizeLabel * variables.fontSizeToWidthRatio;


Should'nt we depend on the styles that are being passed down from props?

Agreed, I'll switch to using those to determine the charWidth

parasharrajat · 2024-09-10T21:04:49Z

@cdOut Can we do something to fix the irregularity of line-spacing as well for these?

11.09.2024_02.33.25_REC.mp4

cdOut · 2024-09-10T21:20:01Z

Can we do something to fix the irregularity of line-spacing as well for these?

I feel like those are just handled by the devices renderer and native code (you can see in the attached screenshots that IOS and Android look a little different, even though the styles applied to both are the same), which might be incredibly difficult. I will look into a solution for that but I'm not sure if that can be done without meddling with some native code.

parasharrajat · 2024-09-10T21:28:23Z

So currently, we use platform-dependent styling to achieve this UI. Please check the style rules and you will notice that we use different values on different platforms. You are correct that device renderer handle these styles differently thus we have to use platform specific values. I was thinking may be there is a way to apply this styling in a responsive way based on device dpi etc. So they look identical on all version of that platforms.

For example, ios styles work across all iphones and look identical. These hardcode pixel values behave differently on different device densities.

cdOut · 2024-09-10T21:35:39Z

Okay, thanks for elaborating on that point. I'll take a look at what we can do here then.

cdOut · 2024-09-13T16:58:12Z

I've memoized the values and changed to inferring the fontSize from textStyles passed to component. I'm still trying to find a way to unify the line-spacing between the two platforms.

parasharrajat · 2024-09-13T17:15:07Z

Even if we can't unify between Android and ios, unifying the line-spacing across various devices for each platform will be good.

parasharrajat · 2024-09-16T21:39:10Z

@cdOut Did you get a chance to look at it yet? Thanks.

cdOut · 2024-09-19T13:34:43Z

Hi, quick update, another urgent PR got unlocked by backend so I had to work on that one for a while, I'm back on this one and I'll push any changes later, should be ready for you by tomorrow.

parasharrajat · 2024-09-19T13:41:54Z

Thanks @cdOut

cdOut · 2024-09-20T23:42:21Z

I wasn't able to find any solutions for the line-spacing problem, however this is still being blocked by react-compiler not being able to handle the nested memoization in this part:

const textMatrix = useMemo(() => {
        const fontSize = getFontSizeFromStyles(textStyles);
        const charsPerLine = Math.floor(windowWidth / (fontSize * variables.fontSizeToWidthRatio));

        const childrenString = typeof children === 'string' ? children : '';
        return getTextMatrix(childrenString).map((row) => row.flatMap((word) => splitLongWord(word, charsPerLine)));
    }, [textStyles, children, windowWidth]);

So even though this memoization is correct, I might have to remove it from some of the values to adhere to react-compiler.

parasharrajat · 2024-09-21T10:01:23Z

Sure. That works. Let's finalize this PR and I can complete the review.

parasharrajat · 2024-09-24T13:51:10Z

Bump @cdOut

parasharrajat · 2024-10-02T18:27:06Z

Yes, I agree with you. I am referring to irregular line-gaps on Android. The inline code blocks alignment is looking incorrect compared to text when they are nested in a paragraph.

Let's adjust the values a bit on Android and see if we can improve this.

cdOut · 2024-10-02T19:01:16Z

Yes, I agree with you. I am referring to irregular line-gaps on Android. The inline code blocks alignment is looking incorrect compared to text when they are nested in a paragraph.

Thanks for clarifying, I wasn't sure what you were referring to. I'll see what can be done with the line gaps.

parasharrajat · 2024-10-08T05:24:12Z

Bump @cdOut

parasharrajat · 2024-10-10T17:14:58Z

Bump @cdOut

cdOut · 2024-10-10T17:33:57Z

Sorry for the delays, I'll push the changes later today so you can check it tomorrow.

cdOut · 2024-10-14T10:39:29Z

Again sorry for the delays, had to investigate another critical issue. Will be pushing changes today.

parasharrajat · 2024-10-15T13:31:17Z

Any update @cdOut? I will be on leave from 17th to 25th so let's get this done today. 🙇

cdOut · 2024-10-16T20:13:13Z

@parasharrajat I would leave this as-is, we can report this as an issue to fix in another issue as this seems out of scope for this PR. The problem is caused by our use of <View> inside the native implementation of InlineCodeBlock. We are required to use it since on native platforms we aren't able to create borders for <Text> elements, which is why we wrap it here with the Views.

The Views themselves aren't that easily stylable, we aren't able to modify them to move them lower due to how it gets passed into HTMLRenderer. To fix this I think we'd have to move outside of the InlineCodeBlock and into the TextDisplay with HTMLRenderer and adjust the vertical spacing with flexbox. I can look into it but I'd move it outside of this PR as it seems like possibly a lot of work that this PR wasn't supposed to fix.

parasharrajat · 2024-10-26T12:25:31Z

Screenshots

🔲 iOS / native

27.10.2024_16.39.13_REC.mp4

🔲 iOS / Safari

27.10.2024_16.43.53_REC.mp4

🔲 MacOS / Desktop

27.10.2024_17.18.24_REC.mp4

🔲 MacOS / Chrome

27.10.2024_16.43.05_REC.mp4

🔲 Android / Chrome

27.10.2024_16.44.55_REC.mp4

🔲 Android / native

27.10.2024_16.38.05_REC.mp4

parasharrajat

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 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.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

🎀 👀 🎀 C+ reviewed

parasharrajat · 2024-10-27T11:50:28Z

Approved the PR for the main linked issue. Following points have been fixed in this PR.

Wrapping of the inline code block.

puneetlath · 2024-10-27T19:11:32Z

src/components/InlineCodeBlock/WrappedText.tsx

@@ -40,15 +42,46 @@ function containsEmoji(text: string): boolean {
    return CONST.REGEX.EMOJIS.test(text);
 }

+/**
+ * Splits long words into multiple strings


Can we add more to the comment here, explaining why it is that we have to do this.

Of course, I've added a more elaborate explanation for it.

puneetlath · 2024-10-27T19:12:33Z

src/components/InlineCodeBlock/WrappedText.tsx

+/**
+ * Splits long words into multiple strings
+ */
+function splitLongWord(word: string, maxLength: number): string[] {


Can we add a unit test for this function? With a handful of different sized strings. To make sure it always returns the array we expect.

Added unit test for this function 👍

cdOut · 2024-10-30T23:33:04Z

@puneetlath Added the review suggestions, ready for a re-review.

OSBotify · 2024-10-31T00:11:47Z

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

github-actions · 2024-10-31T11:40:03Z

🚀 Deployed to staging by https://github.com/puneetlath in version: 9.0.56-0 🚀

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

github-actions · 2024-11-04T14:12:47Z

🚀 Deployed to production by https://github.com/Julesssss in version: 9.0.56-9 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅
🤖🔄 android HybridApp 🤖🔄	skipped 🚫
🍎🔄 iOS HybridApp 🍎🔄	skipped 🚫

cdOut added 7 commits July 8, 2024 12:59

add handling for wrapped code text for native devices

92d3147

fix lint issues

ebeed08

correct imports and prettier

e8441ef

Merge branch 'main' into @cdOut/code-report-fixed

6f2325b

split long singular words into mulltiple strings

5764928

fix prettier and lint errors

e74c97e

Merge branch 'main' into @cdOut/code-report-fixed

39a022f

cdOut marked this pull request as ready for review September 10, 2024 16:19

cdOut requested review from a team as code owners September 10, 2024 16:19

melvin-bot bot requested review from parasharrajat and removed request for a team September 10, 2024 16:19

parasharrajat suggested changes Sep 10, 2024

View reviewed changes

cdOut added 3 commits September 11, 2024 15:01

memoize fontSize and infer it from textStyles

44d0d7d

fix lint errors and refactor code

f0aa075

Merge branch 'main' into @cdOut/code-report-fixed

dae171d

Merge branch 'main' into @cdOut/code-report-fixed

1a0e31b

Merge branch 'main' into @cdOut/code-report-fixed

a7b0e02

parasharrajat approved these changes Oct 27, 2024

View reviewed changes

melvin-bot bot requested a review from puneetlath October 27, 2024 11:49

puneetlath requested changes Oct 27, 2024

View reviewed changes

cdOut added 8 commits October 28, 2024 18:01

Merge branch 'main' into @cdOut/code-report-fixed

30a4176

Merge branch 'main' into @cdOut/code-report-fixed

89dc570

add longer explaination comment

23e436b

add unit test for splitLongWord

66d9dc5

fix prettier

e9c459b

fix jsdoc lint errors

5c66624

fix unit test expected results

32ea3fc

remove unexpected output substring from test

8b76cc9

puneetlath approved these changes Oct 30, 2024

View reviewed changes

puneetlath merged commit 26e9523 into Expensify:main Oct 31, 2024
16 checks passed

github-actions bot mentioned this pull request Oct 31, 2024

Deploy Checklist: New Expensify 2024-10-31 #51778

Closed

melvin-bot bot mentioned this pull request Nov 4, 2024

[HOLD for payment 2024-11-11] [$500] Android/iOS - Code blocks are overflowing the app border #27913

Closed

[Android / iOS] Code blocks are overflowing the app border #44953

[Android / iOS] Code blocks are overflowing the app border #44953

Conversation

cdOut commented Jul 8, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Sep 10, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

parasharrajat commented Sep 10, 2024 • edited Loading

cdOut commented Sep 10, 2024

parasharrajat commented Sep 10, 2024 • edited Loading

cdOut commented Sep 10, 2024

cdOut commented Sep 13, 2024

parasharrajat commented Sep 13, 2024

parasharrajat commented Sep 16, 2024

cdOut commented Sep 19, 2024

parasharrajat commented Sep 19, 2024

cdOut commented Sep 20, 2024

parasharrajat commented Sep 21, 2024 • edited Loading

parasharrajat commented Sep 24, 2024

parasharrajat commented Oct 2, 2024 • edited Loading

cdOut commented Oct 2, 2024

parasharrajat commented Oct 8, 2024

parasharrajat commented Oct 10, 2024

cdOut commented Oct 10, 2024

cdOut commented Oct 14, 2024

parasharrajat commented Oct 15, 2024

cdOut commented Oct 16, 2024

parasharrajat commented Oct 26, 2024 • edited Loading

Screenshots

🔲 iOS / native

🔲 iOS / Safari

🔲 MacOS / Desktop

🔲 MacOS / Chrome

🔲 Android / Chrome

🔲 Android / native

parasharrajat left a comment • edited Loading

Choose a reason for hiding this comment

Reviewer Checklist

parasharrajat commented Oct 27, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cdOut commented Oct 30, 2024

OSBotify commented Oct 31, 2024

github-actions bot commented Oct 31, 2024

github-actions bot commented Nov 4, 2024

cdOut commented Jul 8, 2024 •

edited

Loading

parasharrajat commented Sep 10, 2024 •

edited

Loading

parasharrajat commented Sep 10, 2024 •

edited

Loading

parasharrajat commented Sep 21, 2024 •

edited

Loading

parasharrajat commented Oct 2, 2024 •

edited

Loading

parasharrajat commented Oct 26, 2024 •

edited

Loading

parasharrajat left a comment •

edited

Loading