Composer: add clear command that bypasses the event count

[hannojg]

Details

This PR fixes an issue where the composer's text input wouldn't show the value the user expects (ie. it wouldn't immediately clear). The following use case now works:

• Spam the 'a' key, typing 'aaaaaa...'
• Press send
• Spam the 'b' key, typing 'bbbbbb...'
• Expect that the composer shows first 'aaaaaa', then clears it, then it shows 'bbbbbb'

Its the second attempt after this PR:

• Composer: add clear command that bypasses the event count #45613

which got reverted due to:

• Android & iOS - Composer - Selected emoji is not shown in the composer after sending message #46024

(I added the reproduction of this bug as test case)

Solution explained

This PR fixes the problem by adding an explicit clear view command to the native text input view managers for clearing the text input.

Usually when calling testInputRef.clear() or setting the value prop to "" it internally calls a view command called setTextAndSelection("", 0, 0).
setTextAndSelection is using an event count mechanism. It drops events from JS that have an outdated event count.
The problem is that when we type text, click send, it can happen the user types more text before the setTextAndSelection("", 0, 0) event reached the native side. Once it arrives it is already outdated and is simply dropped.

Our explicit clear view command always takes the latest event count on the native side (and actually also increments it, so any further updates that might happened in between get dropped).

I recommend watching this recording with the solution in place. You can see how the JS thread is lacking behind as we rapidly send new messages:

ios-native.mov

The clearing now is guaranteed to happen immediately after pressing the enabled send button.

For sending, we don't rely on the value state which could be outdated when the JS thread catches up and is ready to process sending, but on the text parameter we receive in newly added onClear callback.
This mechanism ensures that the full typed message gets send.

Code changes explained

• Before we were clearing the composer's TextInput passing a shouldClear: boolean prop. Now the composer is just cleared using a ref method (this greatly simplified the clearing flow)
• The <TextInput /> now has an explicit view command called clear()
• The <TextInput /> now accepts a onClear prop.
  • This will be called once the native clear command has cleared the text on the UI thread.
  • Contains a text parameter, which is the value of the text that was cleared
• When pressing the send button all we do is to call .clear()
• In the onClear callback we take the text and send the message with that text
• I was able to remove the prepareCommentAndResetComposer method. Before we would imperatively call this method to signal we want to clear the composer. Now, we just call the view command clear and wait for the onClear callback to get us the comment value we need to send.

Upstream PR at facebook/react-native

I discussed this with multiple people and figured the best way is to first start a discussion on the react-native repo. I suspect that such a change can take a long while until it gets merged to react-native in some way:

• `TextInput`: Fix clearing issues w/ methods to circumvent the event count to force set a value from JS react-native-community/discussions-and-proposals#803

It might also be that meta doesn't want to do any of these changes. In this case we already discussed on slack that we might want to look into writing our own expensify text input component that extends react-native's.

There exists an issue for that in react-native:

• TextInput desynchronizes with its native counterpart facebook/react-native#37722

Fixed Issues

$ #37896
PROPOSAL:

Tests

Note: For web there is a bug on main that prevents pressing the send button. Make sure to set USE_REACT_STRICT_MODE: false in the CONFIG.ts

• Test case A: Test that the composer clears:
  • Type 12121212 fast
  • Press send but while you do continue typing 34343434
  • Press send but while you do continue typing 56565656
  • Make sure each text got send completely and nothing got stuck in the composer
  • NOTE: It can happen that the JS thread is busy, and that you click on the send button while it's grayed. It's possible that JS kept the send button disabled and your message wasn't send. This is expected as the send button is controlled on the JS thread.
• Test case B: Sending emoji after previous message works
  • Send a message
  • In the cleared composer click on the emoji icon and select an emoji
  • make sure it shows up and you are able to send the message
• Test case C: Send a text message with an attachment, make sure it works as expected

Note: This changed code around the composer. Please test every composer action you can think of (including emojis, mentions, markdown, etc.)

Offline tests

n/a

QA Steps

Same as testing

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-native.mov

Android: mWeb Chrome

mWeb-android.mov

iOS: Native

ios-native.mov

iOS: mWeb Safari

mWeb-ios.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

[hannojg]

Only got one last bug, where there is a race condition where the input gets cleared but after some time the previous input suddenly returns. I know the cause for this and just have to think for a solid fix. Should be ready by tmrw!

[melvin-bot]

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

[Ollyws]

On web when I type and select an emoji from the popup menu it appears the emoji is not sent, only the partially typed emoji code (this only seems to happen when the partially typed code is 2 characters long):

Screen.Recording.2024-07-26.at.16.07.14.mov

[hannojg]

good catch, thanks, taking a look!

[hannojg]

I had some weird code on web where I was taking the previous text value for sending (no clue why I added that). Its now taking the current value of text input which works reliable 👍 Mind checking again @Ollyws ?

[Ollyws]

I'm still able to reproduce this intermittently on Desktop while pressing the send button (not reproducible on web as the send button isn't working):

Skip to the end to see the actual issue reproduced.

Screen.Recording.2024-07-28.at.14.14.27.mov

[hannojg]

@Ollyws thanks for testing so rigorously! This should be fixed now!

Screen.Recording.2024-07-29.at.08.58.38.mov

[Ollyws]

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

01_Android_Native.mp4

Android: mWeb Chrome

02_Android_Chrome.mp4

iOS: Native

03_iOS_Native.mp4

iOS: mWeb Safari

04_iOS_Safari.mp4

MacOS: Chrome / Safari

05_MacOS_Chrome.mp4

MacOS: Desktop

06_MacOS_Desktop.mp4

[Ollyws]

LGTM.

[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/puneetlath in version: 9.0.15-0 🚀

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

[OSBotify]

🚀 Deployed to production by https://github.com/roryabraham in version: 9.0.15-9 🚀

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

[puneetlath]

FYI @hannojg this got reverted.