Fix Edited Line Through Alignment #17781
Conversation
…b.com:pubudu-ranasinghe/App into fix-17181-offline-edited-line-through-styling
melvin-bot
bot
requested review from
NikkiWines and
sobitneupane
and removed request for
a team
|
@NikkiWines @sobitneupane 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] |
| @@ -107,11 +108,12 @@ const ReportActionItemFragment = (props) => { | |||
| // we render it as text, not as html. | |||
| // This is done to render emojis with line breaks between them as text. | |||
| const differByLineBreaksOnly = Str.replaceAll(html, '<br />', '\n') === text; | |||
| const isWeb = [CONST.PLATFORM.WEB, CONST.PLATFORM.DESKTOP].includes(getPlatform()); | |||
There was a problem hiding this comment.
@pubudu-ranasinghe Why is this necessary? We discourage the use of platform dependent code unless it is absolutely necessary.
There was a problem hiding this comment.
This issue doesn't happen on native apps. And providing inline-block to RN styles apparently throws an error. So needed to contain it only to desktop and web.
There was a problem hiding this comment.
What is the error? If it is not supported by react-native, we better look for other solutions.
There was a problem hiding this comment.
It says it should be one of the supported values flex or none. Will look into more solutions.
|
What is the update here? @pubudu-ranasinghe Please do consider the timeline mentioned in the Contributing guidelines and keep us updated. |
|
Apologies for the delay. I have been spending a lot of time and exploring several solutions but have not yet arrived at a final one. Unfortunately, this issue is proving difficult to fix in a platform-independent manner. The issue only occurs in Chrome, affecting the web, mobile Chrome, and desktop app. This is due to a bug in Chrome that affects how it handles line-through on descendant elements with varying font sizes. To demonstrate this, I have created a fiddle here, which shows the difference when opened in Chrome and Safari.
When a text decoration is applied to an element, it is propagated to descendant elements. In Chrome, if the descendant font sizes are different, as is the case with the message and edited label in Expensify, the line is not rendered properly. To fix this, we need to prevent the text decoration from propagating to descendants and apply its own line-through. We can do this by making the child element for the edited label an inline-block element as suggested here. However, React Native does not recognize inline-block as a valid property, throwing an error. Therefore, we can only apply this fix behind platform dependant condition. I have explored other options such as wrapping the edited label and message themselves with Views and playing around with flex display. However, changing the element structure affects how messages are rendered in different platforms, which is not ideal and prone to many regression bugs. Please note that the current state of the PR only shows experimental changes and not the original solution with inline-block. This commit displays the original platform dependant fix. In my opinion, setting inline-block with platform-specific code is the best solution. However, if there are better ideas in the wider community, I wouldn't mind reopening the issue and handing it over to a different proposal. |
|
No worries @pubudu-ranasinghe.
@pubudu-ranasinghe Let's go with the solution you suggested but for those styles, instead of |
|
@sobitneupane there was some change in main branch which introduced Additionally, this PR addresses the #18042 defect which I reported earlier but has increased in scope due to a recent change in main. |
|
@pubudu-ranasinghe This branch has Merge Conflict. Can you please resolve it and let me know. |
|
This merge conflict is most likely due to my PR getting reverted. Unfortunately @pubudu-ranasinghe's latest changes are relying on changes from my PR. Hopefully we can get it back on staging asap as it was a very easy-to-solve problem. |
|
@sobitneupane some of the changes that this PR relied on has been reverted back. I believe this code will be added back as the deploy blocker was not related to those changes as mentioned by @Ollyws. Once the main branch is updated we should be good to merge this. More discussion at #15194 |
|
Sounds good. Let's hold this PR till the other PR is merged. cc: @NikkiWines |
|
Just to keep this issue updated, the changes needed for this PR will be added back by #18523. After that we should be good to merge this. |
|
@pubudu-ranasinghe We should be good to proceed with this PR now. |
|
@sobitneupane great! Will update this PR soon |
|
@sobitneupane Updated |
There was a problem hiding this comment.
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 Issuessection 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
Testssection - I verified the steps for Staging and/or Production testing are in the
QA stepssection - 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 verified the steps for local testing are in the
- 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.
toggleReportand notonIconClick). - 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 Copylabel 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
- 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.
- 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 usingAvatarhave 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
thisproperly so there are no scoping issues (i.e. foronClick={this.submit}the methodthis.submitshould be bound tothisin the constructor) - Any internal methods bound to
thisare necessary to be bound (i.e. avoidthis.submit = this.submit.bind(this);ifthis.submitis never passed to a component event handler likeonClick) - 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
Avataris modified, I verified thatAvataris 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
ScrollViewcomponent to make it scrollable when more elements are added to the page. - If the
mainbranch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTeststeps. - I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.
| @@ -15,13 +15,15 @@ const propTypes = { | |||
|
|
|||
| const EditedRenderer = (props) => { | |||
| const defaultRendererProps = _.omit(props, ['TDefaultRenderer', 'style', 'tnode']); | |||
| const isPendingDelete = !!props.tnode.attributes.deleted; | |||
|
|
|||
| @@ -15,13 +15,15 @@ const propTypes = { | |||
|
|
|||
| const EditedRenderer = (props) => { | |||
| const defaultRendererProps = _.omit(props, ['TDefaultRenderer', 'style', 'tnode']); | |||
| const isPendingDelete = !!props.tnode.attributes.deleted; | |||
There was a problem hiding this comment.
I think Boolean(props.tnode.attributes.deleted); might be a little clearer. You could also do this inline on line 26 instead of making a separate variable for it.
| @@ -109,7 +109,7 @@ const ReportActionItemFragment = (props) => { | |||
| // Only render HTML if we have html in the fragment | |||
| if (!differByLineBreaksOnly) { | |||
| const isPendingDelete = props.pendingAction === CONST.RED_BRICK_ROAD_PENDING_ACTION.DELETE && props.network.isOffline; | |||
| const editedTag = props.fragment.isEdited ? '<edited></edited>' : ''; | |||
| const editedTag = props.fragment.isEdited ? `<edited ${isPendingDelete ? 'deleted="true"' : ''}></edited>` : ''; | |||
There was a problem hiding this comment.
NAB: Do we need ="true" here or can we just include deleted as boolean attribute?
There was a problem hiding this comment.
Yes, I've updated to use just the attribute key
|
✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release. |
|
🚀 Deployed to staging by https://github.com/NikkiWines in version: 1.3.20-0 🚀
|
|
🚀 Deployed to production by https://github.com/Julesssss in version: 1.3.20-5 🚀
|
Details
This PR fixes an issue where the horizontal line for the word 'edited' in web and desktop is not at the centre unlike in mobile apps
Fixed Issues
$ #17181
PROPOSAL: #17181 (comment)
Tests
Offline tests
Bug is related to offline mode itself. No extra steps needed.
QA Steps
PR Author Checklist
### Fixed Issuessection aboveTestssectionOffline stepssectionQA stepssectiontoggleReportand notonIconClick)src/languages/*files and using the translation methodWaiting for Copylabel for a copy review on the original GH to get the correct copy.STYLE.md) were followedAvatar, I verified the components usingAvatarare working as expected)/** comment above it */thisproperly so there are no scoping issues (i.e. foronClick={this.submit}the methodthis.submitshould be bound tothisin the constructor)thisare necessary to be bound (i.e. avoidthis.submit = this.submit.bind(this);ifthis.submitis never passed to a component event handler likeonClick)StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG))Avataris modified, I verified thatAvataris working as expected in all cases)ScrollViewcomponent to make it scrollable when more elements are added to the page.mainbranch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTeststeps.Screenshots/Videos
Web
Mobile Web - Chrome
Mobile Web - Safari
Desktop
iOS
Android