fix: cursor issue starting on left of text #25528

jeet-dhandha · 2023-08-19T13:42:50Z

Details

Issue is that cursor was starting at left of text on editing. So to fix this we had to call setDraft function only for Mobile Safari and Mobile chrome as for other platforms it was creating a side effect due to which cursor is not set to the right for Android Only.

Fixed Issues

$ #24157
PROPOSAL: #24157 (comment)

Tests

Open any chat try to edit your sent text.
Verify that cursor should appear at end of the text.

Verify that no errors appear in the JS console

Offline tests

Open any chat try to edit your sent text.
Verify that cursor should appear at end of the text.

QA Steps

Open any chat try to edit your sent text.
Verify that cursor should appear at end of the text.

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

EditText-Web-min.mp4

Mobile Web - Chrome

EditText-Mobile-Chrome-min.mp4

Mobile Web - Safari

EditText-Mobile-Safari-min.mp4

Desktop

EditText-Desktop-min.mp4

iOS

EditText-iOS-min.mp4

Android

EditText-Android-min.mp4

robertKozik · 2023-08-21T07:08:05Z

src/pages/home/report/ReportActionItemMessageEdit.js

@@ -124,16 +125,18 @@ function ReportActionItemMessageEdit(props) {
    }, [isFocused]);

    useEffect(() => {
-        // For mobile Safari, updating the selection prop on an unfocused input will cause it to automatically gain focus
+        // For every platform execept Android, updating the selection prop on an unfocused input will cause it to automatically gain focus


Could you compare it with the implementation in ReportActionCompose.js?

App/src/pages/home/report/ReportActionCompose.js

Lines 231 to 234 in dd0d98f

selection: {

start: isMobileSafari && !this.shouldAutoFocus ? 0 : props.comment.length,

end: isMobileSafari && !this.shouldAutoFocus ? 0 : props.comment.length,

},

Maybe apart from the setDraft/setSelection we need to init the selection per platform too?

As i can see in ReportActionCompose.js its called directly during initialisation of the state. And what we are trying to achieve is different as we want to call this after the comment state is initialised and also handle few of the browser related issues like modal focus trap etc.

@robertKozik Waiting for your reply here.

What I was considering is the possibility of limiting the scope of the setDraft/setSelection actions to mobile Safari and Chrome, where we would initialize the selection as in the composer. This approach could look like this:

On mobile Safari: Initialize the selection as 0 and then update it using setDraft/setSelection.
On other platforms: Initialize the selection with the draft's length and avoid updating it using setDraft/setSelection.

I didn;t test it - just throwing ideas as in ReportActionCompose.js we don't have a problem with the cursor

@robertKozik Tried your solution it works as we expected.

Finishing up the PR now.

melvin-bot · 2023-08-29T08:04:41Z

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

robertKozik · 2023-08-31T15:38:03Z

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

android.-.web.mov

Mobile Web - Safari

ios.-.web.mov

Desktop

Screen.Recording.2023-09-01.at.13.16.06.mov

iOS

ios.native.mov

Android

android.-.native.mov

robertKozik

Few questions ^^ Please address them when you will be able to

robertKozik · 2023-08-31T17:09:54Z

src/pages/home/report/ReportActionItemMessageEdit.js

+    };
+
+    const getInitialSelection = () => {
+        const length = getInitialDraft().length;


Can we move this calculation after the isMobileSafari if condition? We don't need to calculate it for safari, so let's calculate it only for other platforms

Moved after the isMobileSafari check.

robertKozik · 2023-08-31T17:12:30Z

src/pages/home/report/ReportActionItemMessageEdit.js

@@ -93,17 +94,28 @@ function ReportActionItemMessageEdit(props) {
    const {translate} = useLocalize();
    const {isKeyboardShown} = useKeyboardState();
    const {isSmallScreenWidth} = useWindowDimensions();
+    const isMobileSafari = Browser.isMobileSafari();


Can we move it outside the functional component? It won't change in runtime. Simmilar approach can be seen in ComposerWithSuggestions.js file

Thanks for this insight moved it outside the component.

src/pages/home/report/ReportActionItemMessageEdit.js

robertKozik · 2023-08-31T17:17:37Z

src/pages/home/report/ReportActionItemMessageEdit.js

@@ -139,7 +153,7 @@ function ReportActionItemMessageEdit(props) {
            // to prevent the main composer stays hidden until we swtich to another chat.
            ComposerActions.setShouldShowComposeInput(true);
        };
-    }, [props.action.reportActionID]);
+    }, [props.action.reportActionID, isMobileSafari]);


isMobileSafari const won't change during the lifecycle of the component. Do we need this to make lint happy?

Yes lint 😢

jeet-dhandha · 2023-08-31T20:27:49Z

I have added the changes and also added comments. Please check.

robertKozik

Looking good

robertKozik · 2023-09-01T14:18:31Z

@cristipaval as we have ongoing merge freeze (info) what do you think about urgency of this PR? For me it can wait until the freeze will be canceled

cristipaval · 2023-09-01T15:17:00Z

yes this could definitely wait

robertKozik · 2023-09-11T07:29:40Z

@jeet-dhandha Can you please follow the instructions from slack, i.e. update the PR with the latest main and re-test it? Thanks

jeet-dhandha · 2023-09-11T19:52:54Z

@robertKozik Merged main and checked its working and no conflicts were also there.

jeet-dhandha · 2023-09-11T19:54:40Z

Android Video

DEv.mp4

robertKozik · 2023-09-11T21:24:14Z

Looks good on my end as well. @cristipaval, the floor is yours. However, I would appreciate it if we could hold off on merging until tomorrow. I've already had several PRs merged from the HOLD status, and it would be great if we could space them out a bit 🙇🏼

cristipaval · 2023-09-11T21:26:31Z

Ok, I'll merge it tomorrow then.

OSBotify · 2023-09-12T21:42:48Z

✋ 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 · 2023-09-13T09:13:32Z

🚀 Deployed to staging by https://github.com/cristipaval in version: 1.3.69-0 🚀

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

OSBotify · 2023-09-14T10:27:46Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.69-2 🚀

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

OSBotify · 2023-09-14T10:54:40Z

🚀 Deployed to staging by https://github.com/cristipaval in version: 1.3.70-0 🚀

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

OSBotify · 2023-09-18T10:12:39Z

🚀 Deployed to production by https://github.com/thienlnam in version: 1.3.70-8 🚀

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

jeet-dhandha added 4 commits August 19, 2023 18:30

fix: cursor issue starting on left of text

e7e2b2f

fix: don't run for android

ff21ba6

remove browser lib import

37566c7

remove platform import

f23c859

robertKozik reviewed Aug 21, 2023

View reviewed changes

Merge branch 'main' into fix-issue-24157

7a02fde

jeet-dhandha mentioned this pull request Aug 23, 2023

[HOLD for payment 2023-09-21] [$1000] Compose box - Cursor at left instead of right side while editing the comment #24157

Closed

6 tasks

jeet-dhandha added 4 commits August 26, 2023 18:10

Merge branch 'main' into fix-issue-24157

b61ff82

Merge branch 'main' into fix-issue-24157

83efc2b

fixed report edit issue

e7ba653

fix: lint issue

e2636cf

jeet-dhandha marked this pull request as ready for review August 29, 2023 08:04

jeet-dhandha requested a review from a team as a code owner August 29, 2023 08:04

melvin-bot bot requested review from robertKozik and removed request for a team August 29, 2023 08:04

Merge branch 'main' into fix-issue-24157

c5db51f

robertKozik suggested changes Aug 31, 2023

View reviewed changes

jeet-dhandha added 2 commits September 1, 2023 01:47

Merge branch 'main' into fix-issue-24157

287b9a9

calculate only when its not isMobileSafari

8e49331

removed as not needed in dependency anymore

fa5727b

robertKozik approved these changes Sep 1, 2023

View reviewed changes

melvin-bot bot requested a review from cristipaval September 1, 2023 14:14

cristipaval approved these changes Sep 1, 2023

View reviewed changes

Merge branch 'main' into fix-issue-24157

f497a54

Merge branch 'main' into fix-issue-24157

56dd1be

cristipaval merged commit 73627ae into Expensify:main Sep 12, 2023
12 checks passed

OSBotify mentioned this pull request Sep 13, 2023

Deploy Checklist: New Expensify 2023-09-13 #27313

Closed

72 tasks

OSBotify mentioned this pull request Sep 14, 2023

Deploy Checklist: New Expensify 2023-09-14 #27425

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: cursor issue starting on left of text #25528

fix: cursor issue starting on left of text #25528

jeet-dhandha commented Aug 19, 2023 •

edited

Loading

robertKozik Aug 21, 2023

jeet-dhandha Aug 22, 2023

jeet-dhandha Aug 23, 2023

robertKozik Aug 23, 2023

jeet-dhandha Aug 29, 2023

jeet-dhandha Aug 29, 2023

melvin-bot bot commented Aug 29, 2023

robertKozik commented Aug 31, 2023 •

edited

Loading

robertKozik left a comment

robertKozik Aug 31, 2023

jeet-dhandha Aug 31, 2023

robertKozik Aug 31, 2023

jeet-dhandha Aug 31, 2023

robertKozik Aug 31, 2023

jeet-dhandha Aug 31, 2023

jeet-dhandha commented Aug 31, 2023

robertKozik left a comment

robertKozik commented Sep 1, 2023

cristipaval commented Sep 1, 2023

robertKozik commented Sep 11, 2023

jeet-dhandha commented Sep 11, 2023

jeet-dhandha commented Sep 11, 2023 •

edited

Loading

robertKozik commented Sep 11, 2023

cristipaval commented Sep 11, 2023

OSBotify commented Sep 12, 2023

OSBotify commented Sep 13, 2023

OSBotify commented Sep 14, 2023

OSBotify commented Sep 14, 2023

OSBotify commented Sep 18, 2023

	selection: {
	start: isMobileSafari && !this.shouldAutoFocus ? 0 : props.comment.length,
	end: isMobileSafari && !this.shouldAutoFocus ? 0 : props.comment.length,
	},

fix: cursor issue starting on left of text #25528

fix: cursor issue starting on left of text #25528

Conversation

jeet-dhandha commented Aug 19, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

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

Choose a reason for hiding this comment

melvin-bot bot commented Aug 29, 2023

robertKozik commented Aug 31, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

robertKozik left a 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jeet-dhandha commented Aug 31, 2023

robertKozik left a comment

Choose a reason for hiding this comment

robertKozik commented Sep 1, 2023

cristipaval commented Sep 1, 2023

robertKozik commented Sep 11, 2023

jeet-dhandha commented Sep 11, 2023

jeet-dhandha commented Sep 11, 2023 • edited Loading

Android Video

robertKozik commented Sep 11, 2023

cristipaval commented Sep 11, 2023

OSBotify commented Sep 12, 2023

OSBotify commented Sep 13, 2023

OSBotify commented Sep 14, 2023

OSBotify commented Sep 14, 2023

OSBotify commented Sep 18, 2023

jeet-dhandha commented Aug 19, 2023 •

edited

Loading

robertKozik commented Aug 31, 2023 •

edited

Loading

jeet-dhandha commented Sep 11, 2023 •

edited

Loading