fix: no trimming for link name #773

dominictb · 2024-08-05T05:49:35Z

Fixed Issues

$ Expensify/App#45623

Tests

What unit/integration tests cover your change? What autoQA tests cover your change?

Already in the PR

What tests did you perform that validates your changed worked?

Will covered in react-native-live-markdown PR

QA

What does QA need to do to validate your changes?

Will covered in the app PR

What areas to they need to test for regressions?

Live markdown.

Linked PRs

Expensify/react-native-live-markdown#449 (Evidence is here)

dominictb · 2024-08-05T06:08:26Z

@DylanDylann for review

dominictb · 2024-08-05T09:55:52Z

@DylanDylann this is ready for review.

DylanDylann · 2024-08-05T10:03:43Z

@dominictb Did you test this change?

dominictb · 2024-08-05T10:05:11Z

Tested in the react-native-live-markdown

DylanDylann · 2024-08-05T10:10:04Z

lib/ExpensiMark.ts

@@ -298,7 +298,7 @@ export default class ExpensiMark {
            {
                name: 'reportMentions',

-                regex: /(?<![^ \n*~_])(#[\p{Ll}0-9-]{1,80})(?![^<]*(?:<\/pre>|<\/code>))/gimu,
+                regex: /(?<![^ \n*~_])(#[\p{Ll}0-9-]{1,80})(?![^<]*(?:<\/pre>|<\/code>|<\/a>))/gimu,


@dominictb Could you explain why we need to change this regex?

expensify-common/__tests__/ExpensiMark-HTML-test.js

Line 2271 in 4f2e0bc

test('room mention with space inside link should not be rendered', () => {

if we don't change the regexp, this test will fail.

@dominictb In this case, shouldKeepRawInput is false, right?

So I don't think this test relate to our change

If we keep the old regex, then in markdown input we'll see:

Based on what I saw in the unit test here, the report mention markdown syntax should not be applied if it is inside a link. So this is not expected right?

I'm under the assumption that before this change, the #room text shouldn't have the report-mention markdown if it is inside a link markdown syntax (see the image above)

However, after my change, the #room text will now have the report-mention markdown style (check the image below), but I believe this only happens in the markdown input, not when we save/send the message as we have already trim the extra space at that point, hence the #room text won't have the report-mention markdown style. So, the question is: is this acceptable to show the report-mention markdown style in the markdown input in this case or not? It might be confusing for the user because what they saw when typing and when viewing the sent message is 2 different thing.

@dominictb Yeah, agree that the report-mention markdown style shouldn't be rendered. But my curious why we have different behaviors when trimming spaces. Could you refer to a code link for this point?

but I believe this only happens in the markdown input

But my curious why we have different behaviors when trimming spaces

that is because we're trying to match and apply report-mention rule to the link name, and since the original regex of the report-mention doesn't account for the case where link name can have spaces on both end -> hence the mentioned problem

The solution is to update the regex, making sure that if the mention-report is between <a/> tag, we won't render the markdown style. We have the same logic to prevent applying mention-report markdown style in pre and code block, so it should be straightforward

but I believe this only happens in the markdown input

We only keep the space in when shouldKeepRawInput = true, and this particular problem only happens when the link name have redundant spaces on either end. So, it only happens in the markdown input (shouldKeepRawInput = true), but not when we display the sent message in the app (``shouldKeepRawInput = false`)

Yeah, I understand your problem and solution. But the RCA isn't clear to me

But my curious why we have different behaviors when trimming spaces. Could you refer to a code link for this point?

For this question, I am curious why the old mention-report regex works well when we trim spaces but It fails when we keep trailing spaces

Ahhh, see. It dues to the negative lookbehind. Sorry for my confusion

DylanDylann · 2024-08-05T10:10:41Z

Tested in the react-native-live-markdown

Please include a video as evidence.

DylanDylann · 2024-08-05T10:23:28Z

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

This change only be applied to react-native-live-markdown (We only use parser.replace function with shouldKeepRawInput: true on react-native-live-markdown repo), then I will make a full test on this PR

DylanDylann · 2024-08-05T12:41:09Z

Pending this comment

Gonals · 2024-08-05T14:39:34Z

Pending this comment

Waiting on this

DylanDylann

@Gonals Let's move forward

github-actions · 2024-08-09T09:37:34Z

🚀Published to npm in v2.0.72

fix: no trimming for link name

265d496

dominictb requested a review from a team as a code owner August 5, 2024 05:49

melvin-bot bot requested review from MariaHCD and removed request for a team August 5, 2024 05:50

fix: prettier

303cd94

dominictb mentioned this pull request Aug 5, 2024

fix: remove console.error to fix crash on iOS Expensify/react-native-live-markdown#449

Merged

fix: only keep spaces if shouldKeepRawInput=true

ec546ab

fix: add extra line

a6109cb

DylanDylann reviewed Aug 5, 2024

View reviewed changes

DylanDylann approved these changes Aug 5, 2024

View reviewed changes

DylanDylann mentioned this pull request Aug 5, 2024

[Hold for payment 2024-08-26] [$250] iOS - Chat - App crashes when adding a space at the end of hyperlink text while editing Expensify/App#45623

Closed

6 tasks

MariaHCD requested review from Gonals and removed request for MariaHCD August 5, 2024 13:01

Gonals approved these changes Aug 5, 2024

View reviewed changes

Gonals self-requested a review August 5, 2024 14:39

DylanDylann approved these changes Aug 6, 2024

View reviewed changes

Gonals approved these changes Aug 9, 2024

View reviewed changes

Gonals merged commit 1c71c4e into Expensify:main Aug 9, 2024
6 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: no trimming for link name #773

fix: no trimming for link name #773

dominictb commented Aug 5, 2024 •

edited

Loading

dominictb commented Aug 5, 2024

dominictb commented Aug 5, 2024

DylanDylann commented Aug 5, 2024

dominictb commented Aug 5, 2024

DylanDylann Aug 5, 2024

dominictb Aug 5, 2024

DylanDylann Aug 5, 2024

DylanDylann Aug 5, 2024

dominictb Aug 6, 2024 •

edited

Loading

dominictb Aug 6, 2024

DylanDylann Aug 6, 2024 •

edited

Loading

dominictb Aug 6, 2024

DylanDylann Aug 6, 2024 •

edited

Loading

DylanDylann Aug 6, 2024

DylanDylann commented Aug 5, 2024

DylanDylann commented Aug 5, 2024 •

edited

Loading

DylanDylann commented Aug 5, 2024

Gonals commented Aug 5, 2024

DylanDylann left a comment

github-actions bot commented Aug 9, 2024

fix: no trimming for link name #773

fix: no trimming for link name #773

Conversation

dominictb commented Aug 5, 2024 • edited Loading

Fixed Issues

Tests

QA

Linked PRs

dominictb commented Aug 5, 2024

dominictb commented Aug 5, 2024

DylanDylann commented Aug 5, 2024

dominictb commented Aug 5, 2024

DylanDylann Aug 5, 2024

Choose a reason for hiding this comment

dominictb Aug 5, 2024

Choose a reason for hiding this comment

DylanDylann Aug 5, 2024

Choose a reason for hiding this comment

DylanDylann Aug 5, 2024

Choose a reason for hiding this comment

dominictb Aug 6, 2024 • edited Loading

Choose a reason for hiding this comment

dominictb Aug 6, 2024

Choose a reason for hiding this comment

DylanDylann Aug 6, 2024 • edited Loading

Choose a reason for hiding this comment

dominictb Aug 6, 2024

Choose a reason for hiding this comment

DylanDylann Aug 6, 2024 • edited Loading

Choose a reason for hiding this comment

DylanDylann Aug 6, 2024

Choose a reason for hiding this comment

DylanDylann commented Aug 5, 2024

DylanDylann commented Aug 5, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

DylanDylann commented Aug 5, 2024

Gonals commented Aug 5, 2024

DylanDylann left a comment

Choose a reason for hiding this comment

github-actions bot commented Aug 9, 2024

dominictb commented Aug 5, 2024 •

edited

Loading

dominictb Aug 6, 2024 •

edited

Loading

DylanDylann Aug 6, 2024 •

edited

Loading

DylanDylann Aug 6, 2024 •

edited

Loading

DylanDylann commented Aug 5, 2024 •

edited

Loading