Move the cancel and save changes to inside the compose box #17633

terrysahaidak · 2023-04-18T21:04:34Z

Details

This PR moves the save button inside the edit composer box similar to how we have the send button in the composer. The cancel button now replaces the user avatar following the design we discussed here.

The proposed design

Fixed Issues

$ #15598
PROPOSAL: GH_LINK_ISSUE(COMMENT)

Tests

Click on edit comment
The edit box should contain a checkmark save button on the right and emoji button next to it following the styles of the report composer input
The cancel button should be on the left
The buttons are centered if the input is a single line and stays on the bottom when it's multiline

Verify that no errors appear in the JS console

Offline tests

QA Steps

Click on edit comment
The edit box should contain a checkmark save button on the right and emoji button next to it following the styles of the report composer input
The cancel button should be on the left
The buttons are centered if the input is a single line and stays on the bottom when it's multiline

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

2023-04-19.10.49.42.mov

2023-04-19.10.51.02.mov

Mobile Web - Chrome

expensify_android_chrome.mp4

Mobile Web - Safari

RPReplay_Final1681891977.MP4

Desktop

2023-04-19.17.54.26.mov

iOS

RPReplay_Final1681915446.mov

Android

expensify_android_native.mp4

MelvinBot · 2023-04-19T15:03:09Z

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

madmax330

LGTM just one style comment, I'm not too familiar with this part of the app though so leaving the final review to @luacmartins

src/pages/home/report/ReportActionItem.js

terrysahaidak · 2023-04-21T12:38:04Z

I've just noticed that the focus on edit box input is broken after rebasing to the latest main. Double checked it on the main branch and yes it's broken there.

luacmartins

Looking good. Left a couple comments. I haven't tested this yet though

src/pages/home/report/ReportActionItem.js

luacmartins · 2023-04-21T13:46:52Z

src/pages/home/report/ReportActionItemMessageEdit.js

@@ -316,26 +345,27 @@ class ReportActionItemMessageEdit extends React.Component {
                        />
                    </View>

+                    <View style={styles.alignSelfEnd}>
+                        <Tooltip text={this.props.translate('common.saveChanges')}>
+                            <TouchableOpacity


AFAIK TouchableOpacity is being deprecated. Can we use Pressable instead?

Touchable Opacity was used to match exactly the send button we have in the ReportActionComposer.js.

In my opinion, changing it to Pressable would also mean changing it in ReportActionComposer which is already out of the scope of this PR.

I still think that we should change this to a Pressable since TouchableOpacity is being deprecated. I understand if we wanna tackle ReportActionComposer in a followup so we don't add more testing scope to this issue though.

If there's going to be a follow up PR changing ReportActionComposer to use Pressable instead of TouchableOpacity then it makes more sense to me to do both at the same time.

By the way, TouchableOpacity is not deprecated. On reactnative.dev they recommend to use Pressable if you want to have more control:

If you're looking for a more extensive and future-proof way to handle touch-based input, check out the Pressable API.

Also, Pressable is not the same as TouchableOpacity since the latter implements animation out of the box, Pressable doesn't have animation.
Pressabe is designed to be a building block for custom buttons. So the ultimate approach would be to implement our own Touchable Opacity using Pressabe.

luacmartins

@terrysahaidak you'll have to sign your commits before we can merge this PR. You can do so by running the following command:

git -c core.editor=true rebase --exec 'git commit --amend --no-edit -n -S' -i $COMMIT_HASH

luacmartins · 2023-04-25T22:57:33Z

bump @terrysahaidak

terrysahaidak · 2023-04-26T04:45:43Z

thanks for the reminder @luacmartins, will do it today 🙂

luacmartins · 2023-04-28T09:33:19Z

Thanks! Let me know when we're ready for another round of review @terrysahaidak

terrysahaidak · 2023-04-28T10:48:33Z

@luacmartins, yes, would appreciate it! I just double-checked that my changes are still working fine after the rebase.

But there is still a bug on iOS so it doesn't focus the input. It's not related to my changes since I could confirm it on the main branch:

2023-04-28.13.47.45.mov

I think this should be a separate ticket.

terrysahaidak · 2023-04-28T11:25:09Z

@luacmartins any recommendation on how to force all new commits to be also signed?

luacmartins · 2023-04-28T14:04:12Z

@terrysahaidak here are the steps:

Tell Git about your key
Steps 1-4 here: https://help.github.com/articles/telling-git-about-your-gpg-key/
Enable signing of commits by default
git config --global commit.gpgsign true
Add your GPG public key to Github
Steps 10-14 https://help.github.com/articles/generating-a-new-gpg-key/

luacmartins · 2023-05-02T08:27:52Z

@terrysahaidak any luck with getting your commits signed?

terrysahaidak · 2023-05-02T09:12:16Z

@luacmartins Yes, I actually did the same thing again today but it did not sign them for some reason. Finishing another thing and getting back to this.

terrysahaidak · 2023-05-02T12:14:20Z

@luacmartins seems to be verified, let me know if everything is correct, thanks

for example, should past commits also be verified?

This doesn't help. But I should be able to just squash the commits.
git -c core.editor=true rebase --exec 'git commit --amend --no-edit -n -S' -i $COMMIT_HASH

luacmartins · 2023-05-02T13:27:47Z

Yes, all commits should be verified. Hmm can you try the one below? Ideally we don't squash the commits.

# (on feature branch) enter interactive rebase
git rebase -i --rebase-merges <commit hash that is unsigned>~

# find your unsigned commit hash, and add a line underneath that says:
exec git commit --amend -S

# save your changes and exit your editor

terrysahaidak · 2023-05-02T19:00:59Z

I'll fix it tomorrow morning, thanks @luacmartins.

Btw, I spent a few hours looking into this issue but didn't find anything specific that would cause this.
It's not related but still makes my changes harder to test.

RPReplay_Final1683010473.MP4

terrysahaidak · 2023-05-03T14:10:34Z

hey @luacmartins, I had to do it the hard way and cherry-picked all my commits into another branch since it would always go through all 250+ commits because of the merge commits, but seems to be good now. I'll test my changes again to make sure nothing is lost/broken after the rebase.

luacmartins · 2023-05-03T15:42:39Z

@terrysahaidak sorry that was so difficult 😅 commits seem good now :)

luacmartins · 2023-05-03T15:42:52Z

Let me know when this is ready for another review

terrysahaidak · 2023-05-03T17:19:52Z

@luacmartins tested it again and everything looks good.

luacmartins · 2023-05-04T07:44:56Z

Adding @fedirjh for review and testing!

fedirjh

Looks good, left some comments. I also noticed this behaviour which is different from the main composer, the ExceededCommentLength error is not displayed at the bottom of the composer

Main Composer	Edit Composer

fedirjh · 2023-05-04T08:56:57Z

src/pages/home/report/ReportActionItem.js

-                        reactions={reactions}
-                        toggleReaction={this.toggleReaction}
-                    />
+                    <View style={this.props.draftMessage ? styles.chatItemReactionsDraftRight : null}>


Suggested change

<View style={this.props.draftMessage ? styles.chatItemReactionsDraftRight : null}>

<View style={this.props.draftMessage ? styles.chatItemReactionsDraftRight : {}}>

Avoid apply null to style.

Checked the repo's code and there is the usage of: null, {}, and undefined.
I don't have a preference so I'm ok with {} in this case.

fedirjh · 2023-05-04T09:00:19Z

src/pages/home/report/ReportActionItemMessageEdit.js

+                            hitSlop={{
+                                top: 3, right: 3, bottom: 3, left: 3,
+                            }}
+                            disabled={hasExceededMaxCommentLength}


Suggested change

disabled={hasExceededMaxCommentLength}

I think we should remove this prop as this is a cancel button, and we should be able to cancel the edit regardless of hasExceededMaxCommentLength.

Good catch, thanks!

fedirjh · 2023-05-04T09:00:29Z

src/pages/home/report/ReportActionItemMessageEdit.js

+                        <Tooltip text={this.props.translate('common.saveChanges')}>
+                            <TouchableOpacity
+                                style={[styles.chatItemSubmitButton,
+                                    (this.state.isCommentEmpty || hasExceededMaxCommentLength) ? undefined : styles.buttonSuccess,


Suggested change

(this.state.isCommentEmpty || hasExceededMaxCommentLength) ? undefined : styles.buttonSuccess,

hasExceededMaxCommentLength ? {} : styles.buttonSuccess,

Saving empty message should delete it. I tested that and it's working.

this.state.isCommentEmpty is not defined, it should be removed.

Thanks, I miss TypeScript.

src/pages/home/report/ReportActionItemMessageEdit.js

fedirjh · 2023-05-04T09:02:05Z

src/styles/styles.js

+        display: 'flex',
+        flexDirection: 'row',


Suggested change

display: 'flex',

flexDirection: 'row',

...flex.dFlex,

...flex.flexRow,

I only see a single ...flex.flerRow usage and lots of fledDirection: 'row' and it feels like anti patters. Can you link to the style guide for this? Spreading a single value doesn't give anything here, but it's even harder to type.

Hard-coding the same style in multiple places is an anti-pattern as it violates the DRY principle. We have a checklist item for that :

I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)

I feel that it's more about the usage of styles.flex1 instead of defining your own myStyle where you have only { flex: 1 }, but not about building a style object out of other objects completely.

terrysahaidak · 2023-05-04T10:25:42Z

Thanks for the review, @fedirjh.

Fixed the ExceededCommentLength, and tested if on every platform, looks the same. But I don't like the look in this case though, but it's a different story:

fedirjh

Code looks good to me

fedirjh · 2023-05-04T11:10:23Z

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-04.at.11.48.24.AM.mov

Screen.Recording.2023-05-04.at.11.49.01.AM.mov

Mobile Web - Chrome

Screen.Recording.2023-05-04.at.11.59.49.AM.mov

Mobile Web - Safari

Screen.Recording.2023-05-04.at.11.57.51.AM.mov

Desktop

Screen.Recording.2023-05-04.at.11.52.29.AM.mov

Screen.Recording.2023-05-04.at.11.53.37.AM.mov

iOS

Screen.Recording.2023-05-04.at.11.54.47.AM.mov

Android

Screen.Recording.2023-05-04.at.12.08.47.PM.mov

fedirjh · 2023-05-04T11:18:45Z

@terrysahaidak I noticed that you incorrectly linked an issue in the PR description. This could cause issues with automation after the PR is merged. To fix this, please update the "Fixed Issues" section as follows:

### Fixed Issues
$ https://github.com/Expensify/App/issues/15598

fedirjh

Looks good and tests well 🚀 🚀

cc @luacmartins all yours.

terrysahaidak · 2023-05-04T11:28:33Z

@terrysahaidak I noticed that you incorrectly linked an issue in the PR description. This could cause issues with automation after the PR is merged. To fix this, please update the "Fixed Issues" section as follows:
### Fixed Issues
$ https://github.com/Expensify/App/issues/15598

Thanks, will do better next time :)

OSBotify · 2023-05-04T11:50:01Z

✋ 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-05-04T16:42:07Z

🚀 Deployed to staging by https://github.com/luacmartins in version: 1.3.10-0 🚀

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

OSBotify · 2023-05-09T04:05:43Z

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.12-0 🚀

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

terrysahaidak marked this pull request as ready for review April 19, 2023 15:02

terrysahaidak requested a review from a team as a code owner April 19, 2023 15:02

melvin-bot bot requested review from madmax330 and removed request for a team April 19, 2023 15:03

madmax330 requested a review from luacmartins April 20, 2023 16:05

madmax330 reviewed Apr 20, 2023

View reviewed changes

src/pages/home/report/ReportActionItem.js Outdated Show resolved Hide resolved

luacmartins reviewed Apr 21, 2023

View reviewed changes

luacmartins reviewed Apr 24, 2023

View reviewed changes

terrysahaidak force-pushed the feature/move-edit-message-buttons branch from b6955eb to cec66af Compare May 2, 2023 12:11

terrysahaidak added 5 commits May 3, 2023 16:56

Move buttons into edit composer

1cece21

Follow same spacing on android as ReportActionComposer

a9ae3f2

clean-up

14e773c

Better formatting

be5ab37

Improve comments

e87637b

terrysahaidak force-pushed the feature/move-edit-message-buttons branch from cec66af to e87637b Compare May 3, 2023 14:07

luacmartins requested a review from fedirjh May 4, 2023 07:44

luacmartins previously approved these changes May 4, 2023

View reviewed changes

fedirjh suggested changes May 4, 2023

View reviewed changes

Fix ExceededCommentLength and address review feedback

3dc4557

terrysahaidak dismissed luacmartins’s stale review via 3dc4557 May 4, 2023 10:30

fedirjh approved these changes May 4, 2023

View reviewed changes

luacmartins approved these changes May 4, 2023

View reviewed changes

luacmartins merged commit b6eb637 into Expensify:main May 4, 2023

OSBotify mentioned this pull request May 4, 2023

Deploy Checklist: New Expensify 2023-05-04 #18411

Closed

32 tasks

melvin-bot bot mentioned this pull request May 9, 2023

[HOLD for payment 2023-05-16] [$1000] Feature Request: Move the cancel and save changes to inside the compose box in the lower right #15598

Closed

	<View style={this.props.draftMessage ? styles.chatItemReactionsDraftRight : null}>
	<View style={this.props.draftMessage ? styles.chatItemReactionsDraftRight : {}}>

	(this.state.isCommentEmpty \|\| hasExceededMaxCommentLength) ? undefined : styles.buttonSuccess,
	hasExceededMaxCommentLength ? {} : styles.buttonSuccess,

Move the cancel and save changes to inside the compose box #17633

Move the cancel and save changes to inside the compose box #17633

Conversation

terrysahaidak commented Apr 18, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

MelvinBot commented Apr 19, 2023

madmax330 left a comment

Choose a reason for hiding this comment

terrysahaidak commented Apr 21, 2023

luacmartins 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

terrysahaidak Apr 27, 2023 • edited Loading

Choose a reason for hiding this comment

luacmartins left a comment

Choose a reason for hiding this comment

luacmartins commented Apr 25, 2023

terrysahaidak commented Apr 26, 2023

luacmartins commented Apr 28, 2023

terrysahaidak commented Apr 28, 2023 • edited Loading

terrysahaidak commented Apr 28, 2023

luacmartins commented Apr 28, 2023 • edited Loading

luacmartins commented May 2, 2023

terrysahaidak commented May 2, 2023

terrysahaidak commented May 2, 2023 • edited Loading

luacmartins commented May 2, 2023

terrysahaidak commented May 2, 2023

terrysahaidak commented May 3, 2023

luacmartins commented May 3, 2023

luacmartins commented May 3, 2023

terrysahaidak commented May 3, 2023

luacmartins commented May 4, 2023

fedirjh 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

terrysahaidak May 4, 2023 • edited Loading

Choose a reason for hiding this comment

terrysahaidak commented May 4, 2023 • edited Loading

fedirjh left a comment

Choose a reason for hiding this comment

fedirjh commented May 4, 2023

Reviewer Checklist

Screenshots/Videos

fedirjh commented May 4, 2023

fedirjh left a comment

Choose a reason for hiding this comment

terrysahaidak commented May 4, 2023

OSBotify commented May 4, 2023

OSBotify commented May 4, 2023

OSBotify commented May 9, 2023

terrysahaidak commented Apr 18, 2023 •

edited

Loading

terrysahaidak Apr 27, 2023 •

edited

Loading

terrysahaidak commented Apr 28, 2023 •

edited

Loading

luacmartins commented Apr 28, 2023 •

edited

Loading

terrysahaidak commented May 2, 2023 •

edited

Loading

terrysahaidak May 4, 2023 •

edited

Loading

terrysahaidak commented May 4, 2023 •

edited

Loading