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

hannojg · 2024-07-17T14:47:52Z

Details

This PR is an alternative implementation to the approach taken in this PR:

fix: composer not cleared when sending message #44285

the problem with that PR is that the web implementation become quite complex, and I had to rewrite large parts of the composer. I was working on a PR here for react-native-live-markdown, but realised there were many edge cases that needed to be considered:

fix(web): handle text input metrics correctly on history undo events react-native-live-markdown#434

Solution explained

This PR fixes the problem by:

adding an explicit 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 its outdated and 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)

We already tried to call setNativeProps(animatedRef, {text: ''}), however this is also limited by the event count.

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

Check that the original bug is fixed, reproduction:

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'

Offline tests

Same as tests

QA Steps

Same as tests

PR Author Checklist

Screenshots/Videos

Android: Native

android-native.mov

Android: mWeb Chrome

Screen.Recording.2024-07-17.at.17.18.33.mov

iOS: Native

ios-native.mov

iOS: mWeb Safari

ios-mweb.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

Screen.Recording.2024-07-17.at.17.20.42.mov

melvin-bot · 2024-07-17T15:42:37Z

@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 · 2024-07-18T19:05:34Z

I'm able to get the message to remain in the text input after sending by spamming the send button while typing:

Screen.Recording.2024-07-18.at.21.02.12.mov

…-clearing-force-clear-event

hannojg · 2024-07-19T12:42:07Z

Was that in a release or debug build?

Ollyws · 2024-07-19T12:48:50Z

In the debug build

hannojg · 2024-07-19T13:47:41Z

can you confirm that the patch got applied (react native patch 18)? I can't reproduce this behaviour on any of my sims / devices

perunt · 2024-07-19T14:48:55Z

I tested it on debug and release build and wasn't able to reproduce it

Simulator.Screen.Recording.-.14.Pro.-.2024-07-19.at.16.46.58.mp4

Ollyws · 2024-07-19T17:29:01Z

Yeah the patch is getting applied fine, but if neither of you can reproduce then maybe it's something particular to my emulators so we could move forward anyway.

hannojg · 2024-07-22T05:46:16Z

@Ollyws Okay, then let's move forward with the PR? If we see in production that its still broken we can revert this PR, and try again (or in the worst case come back to the approach in this PR)

Ollyws · 2024-07-22T10:54:59Z

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 · 2024-07-23T06:56:25Z

✋ 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 · 2024-07-23T08:36:26Z

🚀 Deployed to staging by https://github.com/MariaHCD in version: 9.0.11-0 🚀

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

OSBotify · 2024-07-24T00:16:44Z

🚀 Cherry-picked to staging by https://github.com/francoisl in version: 9.0.11-2 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

OSBotify · 2024-07-25T03:16:15Z

🚀 Deployed to production by https://github.com/francoisl in version: 9.0.11-5 🚀

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

OSBotify · 2024-07-26T05:14:22Z

🚀 Deployed to production by https://github.com/francoisl in version: 9.0.12-0 🚀

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

hannojg added 4 commits July 17, 2024 16:34

react native patch: add clear command that bypasses the event count

884d4cf

dispatch command on the UI thread

697d4ca

add web/native impl

469cb3e

prettier

41d67c9

hannojg changed the title ~~react native patch: add clear command that bypasses the event count~~ add clear command that bypasses the event count Jul 17, 2024

hannojg changed the title ~~add clear command that bypasses the event count~~ Composer: add clear command that bypasses the event count Jul 17, 2024

hannojg marked this pull request as ready for review July 17, 2024 15:42

hannojg requested a review from a team as a code owner July 17, 2024 15:42

melvin-bot bot requested review from Ollyws and removed request for a team July 17, 2024 15:42

hannojg mentioned this pull request Jul 17, 2024

fix: composer not cleared when sending message #44285

Closed

61 tasks

Merge branch 'main' of github.com:Expensify/App into fix/composer-not…

acae30c

…-clearing-force-clear-event

Ollyws approved these changes Jul 22, 2024

View reviewed changes

melvin-bot bot requested a review from MariaHCD July 22, 2024 10:55

MariaHCD approved these changes Jul 23, 2024

View reviewed changes

MariaHCD merged commit ea09013 into Expensify:main Jul 23, 2024
16 checks passed

github-actions bot mentioned this pull request Jul 23, 2024

Deploy Checklist: New Expensify 2024-07-23 #45991

Closed

95 tasks

This was referenced Jul 23, 2024

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

Closed

[CP Staging] Revert "Composer: add clear command that bypasses the event count" #46056

Merged

melvin-bot bot mentioned this pull request Jul 25, 2024

[HOLD for payment 2024-08-09] [HOLD for payment 2024-08-01] [$250] CRITICAL: Native - Message stays in the Composer after being sent #37896

Closed

6 tasks

hannojg mentioned this pull request Jul 26, 2024

Composer: add clear command that bypasses the event count #46091

Merged

51 tasks

hannojg mentioned this pull request Aug 5, 2024

Composer: add clear command that bypasses the event count #46796

Merged

52 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

hannojg commented Jul 17, 2024 •

edited

Loading

melvin-bot bot commented Jul 17, 2024

Ollyws commented Jul 18, 2024

hannojg commented Jul 19, 2024

Ollyws commented Jul 19, 2024

hannojg commented Jul 19, 2024

perunt commented Jul 19, 2024

Ollyws commented Jul 19, 2024

hannojg commented Jul 22, 2024

Ollyws commented Jul 22, 2024

Ollyws left a comment

OSBotify commented Jul 23, 2024

OSBotify commented Jul 23, 2024

OSBotify commented Jul 24, 2024

OSBotify commented Jul 25, 2024

OSBotify commented Jul 26, 2024

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

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

Conversation

hannojg commented Jul 17, 2024 • edited Loading

Details

Solution explained

Upstream PR at facebook/react-native

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jul 17, 2024

Ollyws commented Jul 18, 2024

hannojg commented Jul 19, 2024

Ollyws commented Jul 19, 2024

hannojg commented Jul 19, 2024

perunt commented Jul 19, 2024

Ollyws commented Jul 19, 2024

hannojg commented Jul 22, 2024

Ollyws commented Jul 22, 2024

Reviewer Checklist

Screenshots/Videos

Ollyws left a comment

Choose a reason for hiding this comment

OSBotify commented Jul 23, 2024

OSBotify commented Jul 23, 2024

OSBotify commented Jul 24, 2024

OSBotify commented Jul 25, 2024

OSBotify commented Jul 26, 2024

hannojg commented Jul 17, 2024 •

edited

Loading

Upstream PR at `facebook/react-native`