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.

Sign up for GitHub

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

Jump to bottom

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

Merged
merged 11 commits into from
Sep 30, 2024
Merged

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

merged 11 commits into from
Sep 30, 2024
+25 −9

Conversation

Skalakid
Copy link
Contributor

@Skalakid Skalakid commented Sep 16, 2024 •
edited by rafecolton
Loading

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
ios.mov
MacOS: Chrome / Safari
web.mov
MacOS: Desktop
desktop.mov

@Skalakid Skalakid marked this pull request as ready for review September 16, 2024 11:11
@Skalakid Skalakid requested review from a team as code owners September 16, 2024 11:11
@melvin-bot melvin-bot bot requested review from dubielzyk-expensify and hungvu193 and removed request for a team September 16, 2024 11:12
@melvin-bot Melvin Bot
Copy link

melvin-bot bot commented Sep 16, 2024

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

@Skalakid Skalakid mentioned this pull request Sep 16, 2024
Open
@shawnborton
Copy link
Contributor

Do we need to use [image preview]? Wouldn't just using [image] be easier?

@shawnborton
Copy link
Contributor

It seems like the height of the image jumps a bit when we load it... any ideas what's happening there? It goes from this:
CleanShot 2024-09-16 at 13 29 39@2x

To this:
CleanShot 2024-09-16 at 13 29 53@2x

@Skalakid
Copy link
Contributor Author

Do we need to use [image preview]? Wouldn't just using [image] be easier?

I used image preview only as an example; you can type whatever you want there

@Skalakid
Copy link
Contributor Author

Skalakid commented Sep 16, 2024 •
edited
Loading

It seems like the height of the image jumps a bit when we load it... any ideas what's happening there? It goes from this:

It's because I'm changing the source URL of the image, and the browser is loading it once again since it can be completely different image. While loading we are rendering the loading indicator that has 20px of height. The image loads pretty quick so loading indicator disappears instantly and that why we have a layout jump.

Also, on the screen shots that you posted I'm changing the URL variables (width and height) to get the image with different resolution, it's also the reason of the jump

@Skalakid
Copy link
Contributor Author

@mountiny, can we get an adhoc build for testing so we can all easily verify how inline images behave in action, please?

@github-actions GitHub Actions

This comment has been minimized.

Sign in to view
@shawnborton
Copy link
Contributor

Hmm I keep getting a broken image when I try this with the adhoc build, I've tried multiple URLs too:

CleanShot 2024-09-16 at 15 11 26@2x

@hungvu193
Copy link
Contributor

hungvu193 commented Sep 16, 2024 •
edited
Loading

just tried the adhoc build and I got the same issue with @shawnborton

Screenshot 2024-09-16 at 20 43 05

Here's the logs:

Screenshot 2024-09-16 at 20 44 06

@hungvu193
Copy link
Contributor

It's working with Dev, so I assume that we will need to wait for BE to deploy to make it work with Staging, just like videos, we will need to whitelist these URL right? 😄

Screenshot 2024-09-16 at 21 31 47

@hungvu193
Copy link
Contributor

@Skalakid Can we add a debounce or wait until the user ends their inputting before another preview?

Screen.Recording.2024-09-16.at.21.39.29.mov

This was referenced Sep 17, 2024
Merged
Merged
@Skalakid
Copy link
Contributor Author

Skalakid commented Sep 17, 2024 •
edited
Loading

@hungvu193 I've added a debounce for inline image previews :D

@hungvu193
Copy link
Contributor

@hungvu193 I've added a debounce for inline image previews :D

Awesome!. It's working! 🎉 .

I've found this bug, if you added multiple inline images at the same time, when you edit that message, the first image won't show up.

Screen.Recording.2024-09-17.at.17.58.04.mov

@lanitochka17
Copy link

lanitochka17 commented Sep 23, 2024 •
edited
Loading

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

Web - Compose box - Emojis entered from OS-built emojis are rendered as small emojis

Version Number: 9.0.39-0
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

Precondition:

  1. Sign in to https://49250.pr-testing.expensify.com/
  2. Navigate to a conversation
  3. While focusing on compose box, enter emojis from OS-build emojis

Expected Result:

Emojis have big size in compose box and the send button works

Actual Result:

Emojis are rendered in small size and send button is disabled

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

Bug6613010_1727122626916.bandicam_2024-09-23_20-59-04-879.mp4
Upwork Automation - Do Not Edit

    @dubielzyk-expensify
    Copy link
    Contributor

    Tested this locally with the branch and it's looking awesome! At least the inline image side of it. I'll leave the rest to testing, but from a visual perspective this is good to go 👍

    @hungvu193
    Copy link
    Contributor

    hungvu193 commented Sep 24, 2024 •
    edited
    Loading

    This bug from QA is interesting.
    I assume that we won't let user edit their message if they attach image right? AFAIR, if we send a message along with an image, we're only able to edit the text of that message.

    @hungvu193
    Copy link
    Contributor

    This bug is being handled here

    @mvtglobally
    Copy link

    QA regression has been completed

    @Skalakid
    Copy link
    Contributor Author

    Skalakid commented Sep 25, 2024 •
    edited
    Loading

    Hello, thanks for the QA regression tests, I'm back at the office and I'm starting to investigate them

    @Skalakid
    Copy link
    Contributor Author

    Skalakid commented Sep 25, 2024 •
    edited
    Loading

    @lanitochka17 I wasn't able to reproduce the following issues, can you check it again, but with the latest main merged?

    new.task.mov
    private.notes.mov

    @Skalakid
    Copy link
    Contributor Author

    @lanitochka17 Oh, okay, everything happens on Samsung devices.. I will continue the investigation tomorrow

    @Skalakid Skalakid mentioned this pull request Sep 27, 2024
    Merged
    @Skalakid
    Copy link
    Contributor Author

    Hello, here I created the PR with the fixes for the issues reported above

    @Skalakid
    Copy link
    Contributor Author

    @hungvu193 @lanitochka17 The PR has been merged, so all reported bugs have been fixed :D Please verify it, and let's merge this feature into E/App

    @hungvu193
    Copy link
    Contributor

    Thanks @Skalakid, I can verify that all the bugs above are fixed!

    Just found a small bug, but I think we can address it in a follow-up PR. If we add the room description as an inline image, while clicking the image the RHP won't show up.

    Screen.Recording.2024-09-30.at.18.10.28.mov

    All yours @thienlnam

    thienlnam
    thienlnam approved these changes Sep 30, 2024
    View reviewed changes
    Copy link
    Contributor

    @thienlnam thienlnam left a comment

    Choose a reason for hiding this comment

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

    Thanks for sticking with this! Let's send it 🚀

    @thienlnam thienlnam merged commit 1d0fa64 into Expensify:main Sep 30, 2024
    19 checks passed
    @OSBotify
    Copy link
    Contributor

    ✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

    @github-actions github-actions bot mentioned this pull request Sep 30, 2024
    Closed
    49 tasks
    @github-actions GitHub Actions
    Copy link
    Contributor

    🚀 Deployed to staging by https://github.com/thienlnam in version: 9.0.42-0 🚀

    platform result
    🤖 android 🤖 success ✅
    🖥 desktop 🖥 success ✅
    🍎 iOS 🍎 success ✅
    🕸 web 🕸 success ✅

    @hungvu193
    Copy link
    Contributor

    @thienlnam can you create an issue for these issues?
    #49250 (comment) and #49250 (comment)

    @Skalakid Skalakid mentioned this pull request Oct 1, 2024
    Open
    6 tasks
    This was referenced Oct 1, 2024
    Closed
    Closed
    @lanitochka17 lanitochka17 mentioned this pull request Oct 1, 2024
    Open
    6 tasks
    @jasperhuangg jasperhuangg mentioned this pull request Oct 1, 2024
    Merged
    48 tasks
    @thienlnam
    Copy link
    Contributor

    We ended up reverting this PR to fix some other blockers - unfortunately, I think it will be tough to get this through without causing any issues. Let's see what we can address from the latest batch of reported issues and make sure we address any critical issues. Anything smaller that comes up we can probably address later and I'll denote that to the App deployer next time we merge this

    @rafecolton
    Copy link
    Member

    Given that, can we merge a separate update that only updates the markdown library, so we can deploy the fix to #48797?

    @github-actions GitHub Actions
    Copy link
    Contributor

    github-actions bot commented Oct 2, 2024

    🚀 Deployed to production by https://github.com/jasperhuangg in version: 9.0.42-3 🚀

    platform result
    🤖 android 🤖 success ✅
    🖥 desktop 🖥 success ✅
    🍎 iOS 🍎 success ✅
    🕸 web 🕸 success ✅

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @hungvu193 hungvu193 hungvu193 approved these changes

    @thienlnam thienlnam thienlnam approved these changes

    @dubielzyk-expensify dubielzyk-expensify dubielzyk-expensify left review comments

    @rafecolton rafecolton Awaiting requested review from rafecolton

    Assignees

    @Skalakid Skalakid

    Labels
    Ready To Build
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.
    10 participants
    @Skalakid @shawnborton @hungvu193 @rafecolton @thienlnam @lanitochka17 @dubielzyk-expensify @mvtglobally @OSBotify @mountiny