Fix inconsistent margins for reacted emojis to code-block comments #28387

rezkiy37 · 2023-09-28T13:24:47Z

Details

This is an alternative fix to align spacing between messages and their reactions. The first attempt was unsuccessful, because of the complexity and many overheads.

After investigation, the problems occurs for code-blocks and their reactions, because it has an extra margin bottom.

Good to know: #22010 (comment), #22010 (comment).

Fixed Issues

$ #18681
PROPOSAL: #18681 (comment) (alternative solution)

Tests

Open any chat.
Create any type of messages like text, code-blocks, quote, attachment, etc.
Add emojis.
Verify that spacings are the same between all messages and emojis. Especially code-blocks and its reactions.

Verify that no errors appear in the JS console

Offline tests

Same as "Tests".

QA Steps

Same as "Tests".

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

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

…/18681-inconsistent-margins

melvin-bot · 2023-09-28T15:27:43Z

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

abdulrahuman5196 · 2023-09-30T06:50:28Z

@rezkiy37 If we have multiple code blocks in the same comment , the change is causing the distance between code block and normal text

With new change

Without the change

…/18681-inconsistent-margins

rezkiy37 · 2023-10-02T13:41:18Z

@abdulrahuman5196, yeah, good catch. So, I have an idea:

This problem appears in a case when we have a few content within one message.
It is because we removed a bottom margin from code-blocks.
It means we need to add a space to separate content within a message.

We need to decide when to render a bottom margin, when not. I think the best way how to do it is:

BasePreRenderer already has props:
1. renderLength - a count how much content we have, docs.
2. renderIndex - a current index of a rendered content, docs.
The app can safely lean on these properties to understand that is a particular code-block:
1. last one - the app should not render a bottom margin. We fix the root cause of the problem.
2. not last one (has content below) - the app renders both top and bottom margins. It means no changes for this current behaviour that app has, means no new UI changes.

I actually very like this idea, because we fix the root cause of the problem and do not introduces any new UI/UX changes/behaviour. Also, we don't pass any additional props. Moreover, we don't create a dependency between different messages.

Please test this commit - 677c357 - to verify that it looks good.

abdulrahuman5196 · 2023-10-02T13:47:54Z

@rezkiy37 Wasn't this your first proposal - #18681 (comment)?

But you dropped it due to some issues. Let me know if the new approach is different?

rezkiy37 · 2023-10-02T13:49:23Z

@rezkiy37 Wasn't this your first proposal - #18681 (comment)?

But you dropped it due to some issues. Let me know if the new approach is different?

No, it is different to that main proposal. It is a improved version of our alternative variant.

abdulrahuman5196 · 2023-10-02T14:53:19Z

@rezkiy37
here are related conversion on the same of renderLength and renderIndex

#18681 (comment)
#18681 (comment)
#18681 (comment)

Is this different?

If the new proposal is really different and working fine, I am fine with it.

rezkiy37 · 2023-10-02T15:04:07Z

@abdulrahuman5196, I got you now. So, it is not different what we had there. I see that you were okay with this idea previously. Are you good now?

abdulrahuman5196 · 2023-10-02T15:06:08Z

@abdulrahuman5196, I got you now. So, it is not different what we had there. I see that you were okay with this idea previously. Are you good now?

@rezkiy37 I was ok with it previously itself. But I remember you had mentioned it had some issues. Not sure, have to check back on previous conversations.

rezkiy37 · 2023-10-02T15:13:29Z

I was so long ago, let me also check 😅

rezkiy37 · 2023-10-02T15:16:45Z

Interesting, I haven't found a reason why we didn't try this solution yet. I see we were discussing it, but implemented the other solutions.

abdulrahuman5196 · 2023-10-03T08:35:19Z

@rezkiy37 I think then its your call. If the proposal and change is working, I am fine with the proposal and can do platform testing

…/18681-inconsistent-margins

rezkiy37 · 2023-10-03T11:32:15Z

@abdulrahuman5196, I've checked on different platforms with different messages, looks good to me. Let's do platform testing.

Web

iOS

Android

abdulrahuman5196 · 2023-10-03T16:49:23Z

@rezkiy37 There have been lint failures.

…/18681-inconsistent-margins

rezkiy37 · 2023-10-04T09:41:21Z

@abdulrahuman5196, fixed 👍

abdulrahuman5196 · 2023-10-05T06:58:51Z

Thank you will review today

abdulrahuman5196 · 2023-10-05T15:19:17Z

Taking a look now.

abdulrahuman5196 · 2023-10-05T15:44:49Z

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

Screen.Recording.2023-10-05.at.8.59.35.PM.mp4

Mobile Web - Chrome

Screen.Recording.2023-10-05.at.9.03.03.PM.mp4

Mobile Web - Safari

Screen.Recording.2023-10-05.at.9.01.13.PM.mp4

Desktop

Screen.Recording.2023-10-05.at.9.07.47.PM.mp4

iOS

Screen.Recording.2023-10-05.at.9.04.07.PM.mp4

Android

Screen.Recording.2023-10-05.at.9.05.49.PM.mp4

abdulrahuman5196

Changes looks good and works well. Reviewers checklist is also complete.

All yours. @Beamanator

🎀 👀 🎀
C+ Reviewed

Beamanator

LGTM! Nice work both of you!!

OSBotify · 2023-10-06T10:45:37Z

✋ 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-10-09T23:02:46Z

🚀 Deployed to staging by https://github.com/Beamanator in version: 1.3.80-0 🚀

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

OSBotify · 2023-10-11T04:43:02Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.80-3 🚀

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

OSBotify · 2023-10-11T05:11:56Z

🚀 Deployed to staging by https://github.com/Beamanator in version: 1.3.81-0 🚀

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

OSBotify · 2023-10-13T22:01:02Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.83-11 🚀

platform	result
🤖 android 🤖	skipped 🚫
🖥 desktop 🖥	skipped 🚫
🍎 iOS 🍎	skipped 🚫
🕸 web 🕸	skipped 🚫

OSBotify · 2023-10-13T22:13:05Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.83-11 🚀

platform	result
🤖 android 🤖	skipped 🚫
🖥 desktop 🖥	skipped 🚫
🍎 iOS 🍎	skipped 🚫
🕸 web 🕸	skipped 🚫

OSBotify · 2023-10-13T22:29:18Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.83-11 🚀

platform	result
🤖 android 🤖	skipped 🚫
🖥 desktop 🖥	skipped 🚫
🍎 iOS 🍎	skipped 🚫
🕸 web 🕸	skipped 🚫

OSBotify · 2023-10-13T23:04:43Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.83-11 🚀

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

OSBotify · 2023-10-16T21:16:23Z

🚀 Deployed to production by https://github.com/francoisl in version: 1.3.84-10 🚀

platform	result
🤖 android 🤖	skipped 🚫
🖥 desktop 🖥	skipped 🚫
🍎 iOS 🍎	skipped 🚫
🕸 web 🕸	skipped 🚫

OSBotify · 2023-10-16T21:52:43Z

🚀 Deployed to production by https://github.com/francoisl in version: 1.3.84-10 🚀

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

rezkiy37 added 6 commits June 23, 2023 16:54

Use top instead of vertical margins

9bc2d2e

Merge branch 'main' of https://github.com/rezkiy37/Expensify into fix…

28beb01

…/18681-inconsistent-margins

Merge branch 'main' of https://github.com/rezkiy37/Expensify into fix…

bc0db17

…/18681-inconsistent-margins

Merge branch 'main' of https://github.com/rezkiy37/Expensify into fix…

9b4f133

…/18681-inconsistent-margins

Merge branch 'main' of https://github.com/rezkiy37/Expensify into fix…

a02cf47

…/18681-inconsistent-margins

Merge branch 'main' of https://github.com/rezkiy37/Expensify into fix…

8f771a6

…/18681-inconsistent-margins

rezkiy37 marked this pull request as ready for review September 28, 2023 15:27

rezkiy37 requested a review from a team as a code owner September 28, 2023 15:27

melvin-bot bot removed the request for review from a team September 28, 2023 15:27

melvin-bot bot requested a review from abdulrahuman5196 September 28, 2023 15:27

rezkiy37 added 2 commits October 2, 2023 14:54

Merge branch 'main' of https://github.com/rezkiy37/Expensify into fix…

13e0a0a

…/18681-inconsistent-margins

add conditional margin bottom

677c357

Merge branch 'main' of https://github.com/rezkiy37/Expensify into fix…

ebec05b

…/18681-inconsistent-margins

rezkiy37 added 2 commits October 4, 2023 11:29

Merge branch 'main' of https://github.com/rezkiy37/Expensify into fix…

3f3193e

…/18681-inconsistent-margins

clarify props of BasePreRenderer

e95b07c

abdulrahuman5196 approved these changes Oct 5, 2023

View reviewed changes

melvin-bot bot requested a review from Beamanator October 5, 2023 15:46

Beamanator approved these changes Oct 6, 2023

View reviewed changes

Beamanator merged commit d56c66c into Expensify:main Oct 6, 2023
12 checks passed

OSBotify mentioned this pull request Oct 9, 2023

Deploy Checklist: New Expensify 2023-10-09 #29131

Closed

64 tasks

melvin-bot bot mentioned this pull request Oct 11, 2023

[NEED CHECKLIST] [$2000] Inconsistent margin for reacted emojis to different sort of comments #18681

Closed

6 tasks

OSBotify mentioned this pull request Oct 11, 2023

Deploy Checklist: New Expensify 2023-10-11 #29252

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix inconsistent margins for reacted emojis to code-block comments #28387

Fix inconsistent margins for reacted emojis to code-block comments #28387

rezkiy37 commented Sep 28, 2023 •

edited

Loading

melvin-bot bot commented Sep 28, 2023

abdulrahuman5196 commented Sep 30, 2023

rezkiy37 commented Oct 2, 2023

abdulrahuman5196 commented Oct 2, 2023

rezkiy37 commented Oct 2, 2023

abdulrahuman5196 commented Oct 2, 2023 •

edited

Loading

rezkiy37 commented Oct 2, 2023

abdulrahuman5196 commented Oct 2, 2023

rezkiy37 commented Oct 2, 2023

rezkiy37 commented Oct 2, 2023

abdulrahuman5196 commented Oct 3, 2023

rezkiy37 commented Oct 3, 2023 •

edited

Loading

abdulrahuman5196 commented Oct 3, 2023

rezkiy37 commented Oct 4, 2023

abdulrahuman5196 commented Oct 5, 2023

abdulrahuman5196 commented Oct 5, 2023

abdulrahuman5196 commented Oct 5, 2023 •

edited

Loading

abdulrahuman5196 left a comment

Beamanator left a comment

OSBotify commented Oct 6, 2023

OSBotify commented Oct 9, 2023

OSBotify commented Oct 11, 2023

OSBotify commented Oct 11, 2023

OSBotify commented Oct 13, 2023

OSBotify commented Oct 13, 2023

OSBotify commented Oct 13, 2023

OSBotify commented Oct 13, 2023

OSBotify commented Oct 16, 2023

OSBotify commented Oct 16, 2023

Fix inconsistent margins for reacted emojis to code-block comments #28387

Fix inconsistent margins for reacted emojis to code-block comments #28387

Conversation

rezkiy37 commented Sep 28, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Sep 28, 2023

abdulrahuman5196 commented Sep 30, 2023

rezkiy37 commented Oct 2, 2023

abdulrahuman5196 commented Oct 2, 2023

rezkiy37 commented Oct 2, 2023

abdulrahuman5196 commented Oct 2, 2023 • edited Loading

rezkiy37 commented Oct 2, 2023

abdulrahuman5196 commented Oct 2, 2023

rezkiy37 commented Oct 2, 2023

rezkiy37 commented Oct 2, 2023

abdulrahuman5196 commented Oct 3, 2023

rezkiy37 commented Oct 3, 2023 • edited Loading

abdulrahuman5196 commented Oct 3, 2023

rezkiy37 commented Oct 4, 2023

abdulrahuman5196 commented Oct 5, 2023

abdulrahuman5196 commented Oct 5, 2023

abdulrahuman5196 commented Oct 5, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

abdulrahuman5196 left a comment

Choose a reason for hiding this comment

Beamanator left a comment

Choose a reason for hiding this comment

OSBotify commented Oct 6, 2023

OSBotify commented Oct 9, 2023

OSBotify commented Oct 11, 2023

OSBotify commented Oct 11, 2023

OSBotify commented Oct 13, 2023

OSBotify commented Oct 13, 2023

OSBotify commented Oct 13, 2023

OSBotify commented Oct 13, 2023

OSBotify commented Oct 16, 2023

OSBotify commented Oct 16, 2023

rezkiy37 commented Sep 28, 2023 •

edited

Loading

abdulrahuman5196 commented Oct 2, 2023 •

edited

Loading

rezkiy37 commented Oct 3, 2023 •

edited

Loading

abdulrahuman5196 commented Oct 5, 2023 •

edited

Loading