Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix/21846 heading after quote is not rendering #557

Merged
merged 4 commits into from
Jul 10, 2023
Merged

Fix/21846 heading after quote is not rendering #557

merged 4 commits into from
Jul 10, 2023

Conversation

spcheema
Copy link
Contributor

@spcheema spcheema commented Jul 8, 2023

Fixed Issues

$ #21846
PROPOSAL: #21846 (comment)

Tests

Following cases are verified while performing unit test:

  • Case 1: Heading after the quote
> quote
# heading
  • Case 2: Heading before and after quote
# heading
> quote
# heading
> quote
# heading
  • Case 3: Some text after heading
> quote
# heading
> quote
# heading
Some text here *bold*
  • Also added a new unit test to cover heading replacement
Input: '# heading\n'
Output: '<h1>heading</h1>'

Input: '# heading\n\n'
Output: '<h1>heading</h1></br>'


Input: `> a\n# da\n> test`
Output: '<blockquote>a</blockquote><h1>da</h1><blockquote>test</blockquote>'


Input: `>This is a *quote* that started on a new line.\n# Heading 1 should be captured\nHere is a >quote that did not\n`
Output '<blockquote>This is a <strong>quote</strong> that started on a new line.</blockquote><h1>Heading 1 should be captured</h1>Here is a &gt;quote that did not<br />'

QA

  1. Open any chat room
  2. Send a message which contain heading after the quote text.
Example 1: Heading after the quote

> quote
# heading

Example 2: Heading before and after quote

# heading
> quote
# heading
> quote
# headind


Example 3: Some text after heading

# heading
Some text here *bold*
  1. Copy a comment and paste to verify that it's same as the initial input
  2. Edit a comment and verify that it's same as initial draft.
  • 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
Heading.after.quote.-.web.mp4
Mobile Web - Chrome
Heading.quote.-.Android.web.mp4
Mobile Web - Safari
Heading.quote.-.ios.web.mp4
Desktop
heading.after.quote.-.desktop.mp4
iOS
heading.after.quote.-.ios.app.mp4
Android
heading.after.quote.android.mp4

@github-actions
Copy link

github-actions bot commented Jul 8, 2023

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

@spcheema
Copy link
Contributor Author

spcheema commented Jul 8, 2023

I have read the CLA Document and I hereby sign the CLA

@spcheema
Copy link
Contributor Author

spcheema commented Jul 8, 2023

recheck

@spcheema spcheema marked this pull request as ready for review July 8, 2023 05:30
@spcheema spcheema requested a review from a team as a code owner July 8, 2023 05:30
@melvin-bot melvin-bot bot requested review from aldo-expensify and removed request for a team July 8, 2023 05:30
@spcheema
Copy link
Contributor Author

spcheema commented Jul 8, 2023

@s77rt Can you please have a look why CLA is still failing

@spcheema
Copy link
Contributor Author

spcheema commented Jul 8, 2023

recheck

__tests__/ExpensiMark-HTML-test.js Outdated Show resolved Hide resolved
@s77rt
Copy link
Contributor

s77rt commented Jul 8, 2023

@spcheema The CLA seems okay #557 (comment). Don't orry about the workflow, it will be triggered later

@spcheema spcheema requested a review from s77rt July 8, 2023 11:22
Copy link
Contributor

@s77rt s77rt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! 🚀

@spcheema
Copy link
Contributor Author

@aldo-expensify Can you help to merge this PR if you're also happy with the change?

@aldo-expensify
Copy link
Contributor

The changes LGTM

@cead22 do you want to have a look here before I merge? I think you may have more context.

@cead22 cead22 merged commit 0c685f8 into Expensify:main Jul 10, 2023
2 checks passed
@spcheema spcheema deleted the fix/21846-heading-after-quote-is-not-rendering branch July 10, 2023 21:56
@spcheema
Copy link
Contributor Author

Thanks @aldo-expensify

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants