Migrate ReportActionCompose to PressableWithFeedback #19602

robertKozik · 2023-05-25T11:56:09Z

Details

This PR replaces existing TouchableOpacity implementations of:

expand button
collapse button
send button

to PressableWithFeedback implementation. For every pressable accessibilityRole and label was added (using existing translations). From the send button hitSlop is removed, because GenericPressable itself applies hitSlop based on component size

Fixed Issues

$ #17019
PROPOSAL: #17019

Tests

Open chat
Write multiline text:
- verify that expand/collapse, add buttons works properly
Try to sand message and verify that send button works properly

Verify that no errors appear in the JS console

Offline tests

Same as Test steps

QA Steps

Same as Test 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 / 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
- 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 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

Desktop.-.web.mov

Mobile Web - Chrome

Android.-.web.mov

Mobile Web - Safari

iOS.-.web.mov

Desktop

Desktop.-.native.mov

iOS

iOS.-.native.mov

Android

Android.-.native.mov

melvin-bot · 2023-05-25T21:57:45Z

@allroundexperts @srikarparsi One of you needs to 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]

allroundexperts · 2023-05-25T23:14:35Z

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

Screen.Recording.2023-05-26.at.4.58.18.AM.mov

Mobile Web - Chrome

Screen.Recording.2023-05-26.at.5.05.01.AM.mov

Mobile Web - Safari

Screen.Recording.2023-05-26.at.5.03.02.AM.mov

Desktop

Screen.Recording.2023-05-26.at.4.59.37.AM.mov

iOS

Screen.Recording.2023-05-26.at.5.03.45.AM.mov

Android

Screen.Recording.2023-06-14.at.1.01.58.AM.mov

allroundexperts · 2023-05-25T23:56:03Z

@srikarparsi When the send button is in disabled state, the cursor changes to disabled after applying the changes. I guess that is fine?

allroundexperts · 2023-05-26T00:21:57Z

@robertKozik The app crashes for me on Android when:

Composer is expanded
Keyboard is open
I press collapse button

Screen.Recording.2023-05-26.at.5.13.40.AM.mov

I encountered the same behaviour without your changes as well so I guess this is a new bug. As such, I was unable to complete my Android testing. The code looks fine to me though.

Can you also verify this behaviour on your device?

robertKozik · 2023-05-26T07:14:52Z

I have just an emulator on my side too, but I can encountered it on the latest main branch as well. Moreover it looks like, even after expanding the field, composer displays only one (last) line of multiline message.

Screen.Recording.2023-05-26.at.09.09.48.mov

robertKozik · 2023-05-26T07:36:14Z

@srikarparsi When the send button is in disabled state, the cursor changes to disabled after applying the changes. I guess that is fine?

Yeah, It comes with the new Pressables - when it's disabled cursor is automatically handled as disabled too

allroundexperts · 2023-05-26T09:25:44Z

@srikarparsi Should we wait for a fix for the crash here before merging this? Asking because the required screen recording in Android includes this crash.

allroundexperts · 2023-05-26T09:37:17Z

Btw, this bug is reported here on Slack. Seems to be a regression from #18214

srikarparsi · 2023-05-26T19:07:34Z

Thanks @robertKozik and @allroundexperts! Yeah let's wait until the crash is fixed before merging this even though it's unrelated. The code looks good so I'll just test it after the regression is fixed and this should be good to merge!

chrispader · 2023-05-30T09:58:07Z

The regression got fixed here.

Once it's merged, you should be able to continue this issue! :)

allroundexperts · 2023-06-05T22:39:06Z

@robertKozik Can you please resolve conflicts here?

robertKozik · 2023-06-06T07:33:41Z

conflict resolved 👌🏼

srikarparsi · 2023-06-06T18:49:12Z

Awesome! @allroundexperts could you add the android screenshot to the reviewer checklist whenever you get a chance?

allroundexperts · 2023-06-06T18:53:17Z

Awesome! @allroundexperts could you add the android screenshot to the reviewer checklist whenever you get a chance?

@srikarparsi I tried this morning but the app was still crashing for me.

srikarparsi · 2023-06-06T19:10:39Z

ah sorry thought that the fix got merged for some reason. It looks like it will get reviewed today so hopefully we can get this out tomorrow.

Editing this message to keep track of PR: #19809

roryabraham · 2023-06-09T18:01:43Z

So should this be on HOLD for #19809 ?

srikarparsi · 2023-06-09T19:07:18Z

Yes it should, just added it in.

roryabraham · 2023-06-13T18:07:41Z

Seems like this is ready to come off HOLD

roryabraham · 2023-06-13T18:08:01Z

@robertKozik you should probably merge main here.

robertKozik · 2023-06-13T18:35:45Z

I'm on it.

robertKozik · 2023-06-13T18:50:56Z

@roryabraham main merged

allroundexperts

Looks good!

allroundexperts · 2023-06-13T20:08:01Z

I think the following is not related to this PR but still wanted to double check. Notice that the cursor disappears once you minimise the composer and you have to scroll down to see it.

Screen.Recording.2023-06-14.at.1.05.58.AM.mov

srikarparsi

looks good to me!

srikarparsi · 2023-06-13T20:31:29Z

Yeah I agree @sobitneupane, might be good to address this is another issue but it's not related to this as the same happens on production. Thanks for the changes @robertKozik!

OSBotify · 2023-06-13T20:35:23Z

✋ 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-06-14T21:26:11Z

🚀 Deployed to staging by https://github.com/srikarparsi in version: 1.3.28-0 🚀

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

OSBotify · 2023-06-16T18:41:37Z

🚀 Deployed to production by https://github.com/AndrewGable in version: 1.3.28-5 🚀

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

migrate ReportActionCompose to PressableWithFeedback

2222337

robertKozik force-pushed the 17019-migrate-ReportActionCompose branch from 7daf1c9 to 2222337 Compare May 25, 2023 12:06

robertKozik marked this pull request as ready for review May 25, 2023 21:57

robertKozik requested a review from a team as a code owner May 25, 2023 21:57

melvin-bot bot requested review from allroundexperts and srikarparsi and removed request for a team May 25, 2023 21:57

Merge branch 'main' into 17019-migrate-ReportActionCompose

2a5e2d3

srikarparsi changed the title ~~17019 — migrate ReportActionCompose to PressableWithFeedback~~ [HOLD #19809]17019 — migrate ReportActionCompose to PressableWithFeedback Jun 9, 2023

srikarparsi changed the title ~~[HOLD #19809]17019 — migrate ReportActionCompose to PressableWithFeedback~~ [HOLD #19809] Migrate ReportActionCompose to PressableWithFeedback Jun 9, 2023

roryabraham changed the title ~~[HOLD #19809] Migrate ReportActionCompose to PressableWithFeedback~~ Migrate ReportActionCompose to PressableWithFeedback Jun 13, 2023

Merge branch 'Expensify:main' into 17019-migrate-ReportActionCompose

0cce232

allroundexperts approved these changes Jun 13, 2023

View reviewed changes

srikarparsi approved these changes Jun 13, 2023

View reviewed changes

srikarparsi merged commit 14335e2 into Expensify:main Jun 13, 2023

roryabraham mentioned this pull request Jun 14, 2023

[$3500] Upgrade to react-native-web v0.19.6 or greater #16660

Closed

OSBotify mentioned this pull request Jun 14, 2023

Deploy Checklist: New Expensify 2023-06-14 #20782

Closed

melvin-bot bot mentioned this pull request Jun 16, 2023

[$250] [HOLD for payment 2023-06-23] [Group 2][Accessible Pressable] Migrate ReportActionCompose #17019

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Migrate ReportActionCompose to PressableWithFeedback #19602

Migrate ReportActionCompose to PressableWithFeedback #19602

robertKozik commented May 25, 2023

melvin-bot bot commented May 25, 2023

allroundexperts commented May 25, 2023 •

edited

Loading

allroundexperts commented May 25, 2023

allroundexperts commented May 26, 2023

robertKozik commented May 26, 2023

robertKozik commented May 26, 2023

allroundexperts commented May 26, 2023

allroundexperts commented May 26, 2023

srikarparsi commented May 26, 2023

chrispader commented May 30, 2023

allroundexperts commented Jun 5, 2023

robertKozik commented Jun 6, 2023

srikarparsi commented Jun 6, 2023

allroundexperts commented Jun 6, 2023

srikarparsi commented Jun 6, 2023 •

edited

Loading

roryabraham commented Jun 9, 2023

srikarparsi commented Jun 9, 2023

roryabraham commented Jun 13, 2023

roryabraham commented Jun 13, 2023

robertKozik commented Jun 13, 2023

robertKozik commented Jun 13, 2023

allroundexperts left a comment

allroundexperts commented Jun 13, 2023

srikarparsi left a comment

srikarparsi commented Jun 13, 2023

OSBotify commented Jun 13, 2023

OSBotify commented Jun 14, 2023

OSBotify commented Jun 16, 2023

Migrate ReportActionCompose to PressableWithFeedback #19602

Migrate ReportActionCompose to PressableWithFeedback #19602

Conversation

robertKozik commented May 25, 2023

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented May 25, 2023

allroundexperts commented May 25, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

allroundexperts commented May 25, 2023

allroundexperts commented May 26, 2023

robertKozik commented May 26, 2023

robertKozik commented May 26, 2023

allroundexperts commented May 26, 2023

allroundexperts commented May 26, 2023

srikarparsi commented May 26, 2023

chrispader commented May 30, 2023

allroundexperts commented Jun 5, 2023

robertKozik commented Jun 6, 2023

srikarparsi commented Jun 6, 2023

allroundexperts commented Jun 6, 2023

srikarparsi commented Jun 6, 2023 • edited Loading

roryabraham commented Jun 9, 2023

srikarparsi commented Jun 9, 2023

roryabraham commented Jun 13, 2023

roryabraham commented Jun 13, 2023

robertKozik commented Jun 13, 2023

robertKozik commented Jun 13, 2023

allroundexperts left a comment

Choose a reason for hiding this comment

allroundexperts commented Jun 13, 2023

srikarparsi left a comment

Choose a reason for hiding this comment

srikarparsi commented Jun 13, 2023

OSBotify commented Jun 13, 2023

OSBotify commented Jun 14, 2023

OSBotify commented Jun 16, 2023

allroundexperts commented May 25, 2023 •

edited

Loading

srikarparsi commented Jun 6, 2023 •

edited

Loading