Fix: portion of text shown when changing IOU value

[neg-0]

Details

The change made from issue #8158 added an additional width of 2 pixels to the Text component used to autoGrow the RNTextInput in BaseTextInput. The value of RNTextInput is changed prior to the Text component resizing, which shows a partial number. The proposed change is to remove the extra 2 pixels applied to the Text component that's being used to implement autoGrow in the BaseInputText component. The original intent of this padding was to fix issue #8158 but it seems that the root cause has been resolved and the extra padding is no longer necessary.

Fixed Issues

$ #26628
PROPOSAL: #26628 (comment)

Tests

1. Click the FAB and select Request Money
2. Select Manual
3. Type any amount
4. Notice that as the amount changes, there is no rendering error near the final number

• Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

1. Click the FAB and select Request Money
2. Select Manual
3. Type any amount
4. Notice that as the amount changes, there is no rendering error near the final number

• 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 / Chrome
  • iOS / native
  • iOS / 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

Web

Web.mp4

Mobile Web - Chrome

Fix.Web.mp4

Mobile Web - Safari

iOS.Mobile.Web.mp4

Desktop

Desktop.App.mov

iOS

iOS.mp4

Android

Android.webm

[melvin-bot]

Hey! I see that you made changes to our Form component. Make sure to update the docs in FORMS.md accordingly. Cheers!

[melvin-bot]

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

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

[neg-0]

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

[neg-0]

@ArekChr I accidentally included a merge with this PR. If that's going to cause any issues please let me know and I will resubmit. I apologize for that!

[ArekChr]

@neg-0 I found regression during testing. Some wider numbers are truncated, e.g. 4 or 8, 9. Could you fix that? Thanks!

[neg-0]

@ArekChr Good catch. It seems like the mWeb and Native versions are handling the text sizes differently. This was in fact what #8158 aimed to fix. I'm looking into a solution now.

[neg-0]

@ArekChr Still investigating a good fix for this. I believe the problem is related to how different browsers and the react-native renderer handle the width of the text edit cursor. It seems to impact the apps differently. The fix from the previously mentioned PR adds the 2-pixel width to textInputWidth in order to counteract the added width of the cursor, effectively giving the cursor room to wiggle around without impacting the text position.

Here's the issue on iOS Safari, note the text is cut off at the beginning and will move as you move the cursor around.

iOS.Safari.Text.Bug.mp4

And on macOS Safari the beginning of the text is cut off, but will fix itself if you move the cursor all the way to the left.

macOS.Safari.Text.Bug.mov

Chrome is the least noticeable but the text will move left or right depending on the cursor position.

macOS.Chrome.mov

And finally, Native iOS works fine:

iOS.Native.mp4

I'm trying to implement a solution that can handle these differences in rendering between platforms. It's tricky because the size of the cursor is not the same across platforms. If I add more space to the Text component used for the autoGrow it will fix the text being cut off like you described, but it brings back the issue of a portion of text being displayed by the RNTextInput component until the width can be properly updated.

Another item of note:
The e.nativeEvent.layout.width property returns an integer that rounds off the element's width. This makes the issue more or less noticeable depending on the rounding direction. Using e.nativeEvent.target.getBoundingClientRect(); returns an exact pixel size of the rendered element. This doesn't fix the bug 100% but it does allow finer tuning of the component's width and has helped me get closer to a solution.
getBoundingClientRect() is only applicable to the DOM and cannot be run on react-native. Dead end.

More to come. I apologize for the delay in getting this resolved!

[neg-0]

@ArekChr Ok, I got a working solution!

The reason why portions of numbers are being cut off is due to the layout width of the Text component not accounting for a cursor or any potential changes in the value. It only outputs the width of the current text value. The previous change added 2 pixels to prevent cutting off numbers due to the cursor. However, it does not give enough room for an additional number in the event that the value changes. This "squeeze" is what causes the text to shift to the left upon adding a new number because the value tries to justify itself to always show the cursor (which is typically on the right side of the screen).

First change: I reimplemented the change that I removed in BaseTextInput.js, except I actually changed the pixel count from 2 to 32. This gives all text changes adequate room to breathe.

With this change in place, the text will now overflow to the right upon change instead of shifting everything to the left. I believe this is much more appealing.

Screen.Recording.2023-09-19.at.12.17.30.AM.mov

Simulator.Screen.Recording.-.iPhone.14.Pro.-.2023-09-19.at.00.20.24.mp4

Now, this extra width shifts everything to the left because the centering style tries to center the entire component hierarchy. To counteract this, in the styles.js file I added a 32px margin to the left side of the currency icon. This adds the proper amount of spacing and properly centers the components.

This results in proper centering of the currency symbol and amount.

Simulator.Screen.Recording.-.iPhone.14.Pro.-.2023-09-19.at.00.30.23.mp4

With the changes, I don't see any rendering issues in other parts of the app that use BaseInputText.js and I've pushed this new commit. Please review and let me know if you see any further issues. Thank you

[ArekChr]

@neg-0 These extra shifts happen on the web, iOS, and Android when typing numbers.
on iOS, it looks like it happens randomly
on Android, it occurs like on every text change
The web is more performant, but this is still noticeable. Looks like any number makes this shift.

Nagranie.z.ekranu.2023-09-19.o.12.35.42.mov

[neg-0]

@ArekChr Yes, this is due to the nature of resizing the width of RNTextInput using the onLayout of another component. This is the issue of synchronization between the two elements that I mentioned in the initial posting. This delay was previously masked by the smaller width of the RNTextInput driven by the onLayout function of Text. However, this is what introduced the issues in #26628. React-native does not support automatic sizing of TextInput components so this additional Text component was created to render the text off-screen and get its width accordingly. There's a slight delay with this process which results in the popping you see there.

I'm looking into additional refactoring of the BaseInputText.js component to mitigate this, but without substantial changes that delay will always be present. Please advise how you'd like to move forward.

Thank you!

[neg-0]

I'm currently working on a refactor for the BaseTextInput component that should resolve this issue completely.

[neg-0]

@ArekChr I was not able to refactor BaseTextInput in a way that fixed the synchronization issue.

I propose that we only add the additional 2-pixel width to Safari browsers. This will properly account for the cursor width issue we saw before that cuts off the left side of text on Safari browsers. It will also prevent the portion of text showing when repeatedly typing the same number, fixing issue #26628

Here is the modified code:

Result on MacOS Chrome (with 0 additional width):

Screen.Recording.2023-09-20.at.11.16.59.PM.mov

Result on MacOS Safari (with 2 additional width):

Screen.Recording.2023-09-20.at.11.18.54.PM.mov

Result on iOS Safari (with 2 additional width):

Screen.Recording.2023-09-20.at.11.30.30.PM.mov

Result on Desktop (with 0 additional width):

Screen.Recording.2023-09-20.at.11.32.38.PM.mov

Result on iOS Native (with 0 additional width):

Screen.Recording.2023-09-20.at.11.28.14.PM.mov

Result on Android Native (with 0 additional width):

Screen.Recording.2023-09-20.at.11.24.29.PM.mov

[ArekChr]

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 / Chrome
  • iOS / native
  • iOS / 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

web.mov

Mobile Web - Chrome

mweb.chrome.mov

Mobile Web - Safari

mweb.safari.mov

Desktop

desktop.mov

iOS

ios.mov

Android

android.mov

[ArekChr]

@neg-0 It works for me, I think in future, we should consider refactoring, and simplifying this input by removing width and height logic in onLayout event.

[neg-0]

@ArekChr Thanks for the review. Agreed. It's too bad react-native doesn't support this out of the box. I tried several methods of refactoring to make this look cleaner but all had unwanted side effects.

[mountiny]

Not great to see the browser specific code but I agree this is a good UX improvement to pursue so going ahead

[mountiny]

Lint is failing @neg-0

[neg-0]

@mountiny Sorry about that. Ran Prettier and committed the code diff.

[neg-0]

@ArekChr @mountiny can we please rerun the pipeline? Thank you.

[mountiny]

[OSBotify]

✋ 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]

🚀 Deployed to staging by https://github.com/mountiny in version: 1.3.74-0 🚀

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

[OSBotify]

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.3.74-3 🚀

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