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

Add inline images preview to the Live Markdown Input on the web #50047

Open
wants to merge 13 commits into
base: main
Choose a base branch
from

Conversation

Skalakid
Copy link
Contributor

@Skalakid Skalakid commented Oct 2, 2024

Details

This PR bumps the version of the react-native-live-markdown to the latest and enables the inline image previews inside the input on the web

Screenshot 2024-09-16 at 11 56 32

Fixed Issues

$ #40181 (comment)
$ #48797

PROPOSAL:

Tests

Inline image preview

  1. Open any chat room / page with Live Markdown input
  2. Enter inline image markdown. For example:
*test* ![demo image](https://picsum.photos/id/1067/200/300)_test_ 
  1. Verify the behavior of the input with image preview inside
  2. Verify the loading indicator styling and layout before the image loads
  3. Verify the size and aspect ratio of the image preview
  4. Verify other cases where image can break the input

#48797

  1. Initiate a DM with any user
  2. Compose a message
  3. Place the cursor in the middle of the composed message
  4. Press the Delete button on the keyboard
  • 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: 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

web only feature

Android: mWeb Chrome
chrome.mov
iOS: Native

web only feature

iOS: mWeb Safari
safari.mov
MacOS: Chrome / Safari
web.mov
MacOS: Desktop
desktop.mov

@hungvu193
Copy link
Contributor

Taking a look 👀

@hungvu193
Copy link
Contributor

@Skalakid I still can reproduce the mentioned box issue on mWeb

Screen.Recording.2024-10-03.at.16.05.19.mov

@Skalakid Skalakid force-pushed the @Skalakid/inline-images-feature-v2 branch from 9c9c06a to 4f04d3d Compare October 3, 2024 10:29
@hungvu193
Copy link
Contributor

I still can reproduce this issue:
#49973

Screen.Recording.2024-10-03.at.17.25.15.mov

Also if we send an image with a text, we can edit it and a broken image preview will be shown. Do you think we should fix it here as well?

Screen.Recording.2024-10-03.at.17.26.56.mov

@Skalakid
Copy link
Contributor Author

Skalakid commented Oct 3, 2024

@hungvu193, can you please check if you pulled the latest changes on my branch and delete node_modules before npm i, please? If it doesn't help please give me test steps how to reproduce the first issue

@Skalakid
Copy link
Contributor Author

Skalakid commented Oct 3, 2024

@hungvu193 The second issue you reported is more complex since the image preview isn't displayed because the auth token is missing. It's pretty problematic, and we should think about how to solve this problem safely without exposing any token

@hungvu193
Copy link
Contributor

@hungvu193, can you please check if you pulled the latest changes on my branch and delete node_modules before npm i, please? If it doesn't help please give me test steps how to reproduce the first issue

I think that's caches issue, I removed the node_modules and run npm ci and this issue's gone 🤦

@hungvu193
Copy link
Contributor

All good!

@thienlnam Can you add build label and ask QA to verify this PR?

@Skalakid
Copy link
Contributor Author

Skalakid commented Oct 4, 2024

@hungvu193 I just fixed the issue with image previews that require auth token

@Skalakid Skalakid marked this pull request as ready for review October 4, 2024 08:39
@Skalakid Skalakid requested review from a team as code owners October 4, 2024 08:39
@melvin-bot melvin-bot bot requested a review from ishpaul777 October 4, 2024 08:39
Copy link

melvin-bot bot commented Oct 4, 2024

@dubielzyk-expensify @ishpaul777 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]

@melvin-bot melvin-bot bot removed the request for review from a team October 4, 2024 08:39
@hungvu193
Copy link
Contributor

Please ignore this PR @ishpaul777

@hungvu193
Copy link
Contributor

@hungvu193 I just fixed the issue with image previews that require auth token

Nice! it works 🚀

@hungvu193
Copy link
Contributor

@Skalakid I think the recent changes from selection logic breaks shortcut key, now when I press command + A to select all, the cursor will move to the first character of the line:

Screen.Recording.2024-10-04.at.16.32.29.mov

@hungvu193
Copy link
Contributor

another way to reproduce it, type a letter and double click to select it, you can notice that you can select that letter.

@Skalakid
Copy link
Contributor Author

Skalakid commented Oct 4, 2024

@hungvu193 fixed!

@hungvu193
Copy link
Contributor

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

Android: Native
Android: mWeb Chrome
Screen.Recording.2024-10-04.at.22.32.30.mov
Screen.Recording.2024-09-20.at.22.34.58.mov
iOS: Native
iOS: mWeb Safari
Screen.Recording.2024-09-20.at.22.25.19.mov
Screen.Recording.2024-10-04.at.22.34.29.mov
MacOS: Chrome / Safari
Chrome.mov
MacOS: Desktop
Screen.Recording.2024-09-20.at.22.23.07.mov

@melvin-bot melvin-bot bot requested a review from rafecolton October 4, 2024 15:35
@hungvu193
Copy link
Contributor

hungvu193 commented Oct 4, 2024

Please add build label and ask QA team to verify this PR. Ty 🙇

Copy link
Contributor

github-actions bot commented Oct 4, 2024

@thienlnam thienlnam self-requested a review October 4, 2024 17:25
Copy link
Member

@rafecolton rafecolton left a comment

Choose a reason for hiding this comment

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

Confirmed forward delete works as expected in this branch. Somehow it's even worse in main - it now jumps the cursor to the end of the line 🙈

So if we can't get this merged soon or it gets reverted again, please let's do a small PR to just fix forward delete so we don't delay that further 🙏

@ishpaul777
Copy link
Contributor

please remove my review request, i have also verified #48797 is fixed with this PR

@thienlnam
Copy link
Contributor

Okay thanks, will request one more QA review so we can try to get ahead of any blockers

@thienlnam
Copy link
Contributor

Timing works out great since I'm also the deployer this week 😄

@lanitochka17
Copy link

lanitochka17 commented Oct 7, 2024

If you haven’t already, check out our contributing guidelines for onboarding and email contributors@expensify.com to request to join our Slack channel!


Task –Task description content with exceeded character limit flashes if tap on fix the errors

Version Number: 9.0.44-8
Reproducible in staging?: N
Reproducible in production?: N
If this was caught during regression testing, add the test name, ID and link from TestRail: N/A
Issue reported by: Applause - Internal Team

Action Performed:

Go to https://50047.pr-testing.expensify.com/home
2. Log in
3. Open any chat
4. Tap on +/ Assign task
5. Enter task title
6. Enter description longer than 1000 characters and tap Next
7. When focus is gone tap on fix the errors link

Expected Result:

Task description content not flashes

Actual Result:

Task description content flashes

Workaround:

Unknown

Platforms:

Which of our officially supported platforms is this issue occurring on?

  • Android: Native
  • Android: mWeb Chrome
  • iOS: Native
  • iOS: mWeb Safari
  • MacOS: Chrome / Safari
  • MacOS: Desktop

Screenshots/Videos

Bug6627475_1728329676357.TD.mp4
Upwork Automation - Do Not Edit

    @lanitochka17
    Copy link

    If you haven’t already, check out our contributing guidelines for onboarding and email contributors@expensify.com to request to join our Slack channel!


    Task - & is displayed as & in task conversation created

    Version Number: 9.0.44-8
    Reproducible in staging?: N
    Reproducible in production?: N
    If this was caught during regression testing, add the test name, ID and link from TestRail: N/A
    Issue reported by: Applause - Internal Team

    Action Performed:

    1. Go to https://50047.pr-testing.expensify.com/home
    2. Open self DM
    3. Enter [] @jaihanumanblog@gmail.com
      &
    4. Send the message

    Expected Result:

    & must not be displayed as & in task conversation created

    Actual Result:

    & is displayed as & in task conversation created

    Workaround:

    Unknown

    Platforms:

    Which of our officially supported platforms is this issue occurring on?

    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
    • MacOS: Desktop

    Screenshots/Videos

    Bug6627535_1728332337594.Screenrecorder-2024-10-08-01-42-57-963_compress_1.mp4
    Upwork Automation - Do Not Edit

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

      Successfully merging this pull request may close these issues.

      7 participants