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

Feature: Short-hand image Markdown syntax #39759

Closed

Conversation

kidroca
Copy link
Contributor

@kidroca kidroca commented Apr 5, 2024

Details

  • Introduced shorthand syntax for images without alternative text: !(https://www.example.com/image.jpg)
  • Enhanced the cleanup of HTML attributes to address specific edge cases and issues identified with HTML embedded within tag attributes, as detailed in the associated PR on expensify-common.
  • PR in expensify-common: 🔧 ExpensiMark: Markdown image shorthand syntax expensify-common#676

Fixed Issues

$ #38952
PROPOSAL: N/A (New Feature)

Tests

Conduct the following tests within a chat environment:

  1. Utilize the new shorthand image syntax !(https://url). Verify that a thumbnail of the image displays correctly in the comment.
  2. Edit a comment with the shorthand syntax to confirm that the original text is restored. Note that there is a known backend behavior where the file name may appear as a description for the image (https://expensify.slack.com/archives/C01GTK53T8Q/p1712162973438509).
  3. Test the existing Markdown syntax for images: ![image description](https://url). Ensure that a thumbnail is correctly generated.
  4. Edit a comment containing the Markdown syntax to check that the original markup is accurately restored.
  5. Execute multiple image tests interspersed with text to assess handling and display.
  6. Test interaction with image thumbnails to ensure they open a larger preview as expected.
  7. Examine edge cases involving formatting within the image description, such as bold, italic, or code text, to ensure they do not affect thumbnail generation or comment restoration.
  8. Confirm that no errors are present in the JavaScript console during these tests.

Offline tests

  • Test image display in various network conditions, including offline. Images previously viewed should remain accessible, whereas new images may not load and display an offline indicator. This behavior is consistent with current functionality and is not modified by this PR, but its verification remains pertinent to image handling.

QA Steps

Same as the Tests section above

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: mWeb Chrome
    • iOS: Native
    • iOS: mWeb 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 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 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 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.

Screenshots/Videos

Android: Native
Android: mWeb Chrome
Android.Emulator.-.Pixel_7_API_33_5554.2024-04-12.13-43-06.mp4
iOS: Native
Screen.Recording.2024-04-12.at.17.11.39.mov
iOS: mWeb Safari Screenshot 2024-04-12 at 16 44 54
MacOS: Chrome / Safari

image

MacOS: Desktop
Screen.Recording.2024-04-12.at.16.57.24.mov

@kidroca kidroca force-pushed the kidroca/feat/md-image-short-syntax-2 branch from 78c8d77 to 1c913cd Compare April 12, 2024 06:43
@kidroca kidroca changed the title Kidroca/feat/md image short syntax 2 Feature: Short-hand image Markdown syntax Apr 12, 2024
@kidroca kidroca marked this pull request as ready for review April 12, 2024 14:18
@kidroca kidroca requested a review from a team as a code owner April 12, 2024 14:18
@melvin-bot melvin-bot bot requested review from DylanDylann and removed request for a team April 12, 2024 14:18
Copy link

melvin-bot bot commented Apr 12, 2024

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

@kidroca
Copy link
Contributor Author

kidroca commented Apr 12, 2024

I have a bit of a problem building and running the latest Android app, I'll try again later, other than that the PR is ready for review

Once the PR is approved we can merge expensify-common and update the PR to use the latest version

@kidroca
Copy link
Contributor Author

kidroca commented Apr 15, 2024

PR in expensify-common got resynced with main (Expensify/expensify-common#676), did the same here

@kidroca kidroca closed this Apr 18, 2024
@kidroca kidroca force-pushed the kidroca/feat/md-image-short-syntax-2 branch from ba10e2d to 26c9eba Compare April 18, 2024 18:09
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.

1 participant