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 #49250

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

Conversation

Skalakid
Copy link
Contributor

@Skalakid Skalakid commented Sep 16, 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
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
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]

@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

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?

This comment has been minimized.

@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

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

@Skalakid
Copy link
Contributor Author

Skalakid commented Sep 17, 2024

@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

@hungvu193
Copy link
Contributor

Thanks for your quick work 🚀 let me test it

@Skalakid
Copy link
Contributor Author

Skalakid commented Sep 20, 2024

Another issue, I think that it will need advice from @Expensify/design team.
If we send an invalid inline image (the URL is broken), an empty placeholder will appear, if we click on it, a loading spinner will show infinitely. I think we should display a placeholder for broken image instead. Any thoughts?

I think that we should fix this issue in a separate PR, since it's more connected to E/App itself and how attachments are being displayed in the chat and the attachment modal

@hungvu193
Copy link
Contributor

@Skalakid It worked 🚀 . I've wondered if we should add a loading spinner when we're back online? What's your thought?

Screen.Recording.2024-09-20.at.21.54.49.mov

@Skalakid
Copy link
Contributor Author

@hungvu193 Hmm, I'm not sure. I think it's a tiny detail for now, and we can add it in other PR that will bump the library

@hungvu193
Copy link
Contributor

@hungvu193 Hmm, I'm not sure. I think it's a tiny detail for now, and we can add it in other PR that will bump the library

Agreed 😄 This LGTM, I'll complete the checklist

@hungvu193
Copy link
Contributor

hungvu193 commented Sep 20, 2024

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-09-20.at.22.34.58.mov
iOS: Native
iOS: mWeb Safari
Screen.Recording.2024-09-20.at.22.25.19.mov
MacOS: Chrome / Safari
Chrome.mov
MacOS: Desktop
Screen.Recording.2024-09-20.at.22.23.07.mov

@hungvu193
Copy link
Contributor

hungvu193 commented Sep 20, 2024

Note

For the QA: We will handle this one (#49250 (comment)) and #49250 (comment) in a separate PR.

@rafecolton
Copy link
Member

Requesting a review from Jack too since he is working on the markdown preview feature. I will do a review for both that and the forward delete issue.

@thienlnam
Copy link
Contributor

Woo! Nice work getting it here - changes look good but since this is a big bump this might be good to have tested by QA as well

@thienlnam
Copy link
Contributor

Just generated a new build of the latest, and will have applause run through some tests for the composer

Copy link
Contributor

@lanitochka17
Copy link

lanitochka17 commented Sep 23, 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!


Mark down - Image preview in the composer loads infinitely when opened in thread

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

  1. Go to https://49250.pr-testing.expensify.com/
  2. Go to DM
  3. Type anything in the composer
  4. Click + > Add attachment
  5. Select a photo and send it
  6. Right click on the message > Reply in thread
  7. Right click on the message in thread > Edit message

Expected Result:

The image preview in the composer will not load infiniftely

Actual Result:

The image preview in the composer loads infinitely when opened in thread

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

Bug6612778_1727109930897.20240924_004024.mp4
Upwork Automation - Do Not Edit

    @lanitochka17
    Copy link

    lanitochka17 commented Sep 23, 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!


    mWeb - Task - Description entered is not shown in task preview

    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

    1. Go to https://49250.pr-testing.expensify.com/home
    2. Tap on a chat
    3. Tap plus icon -- assign task
    4. Enter title and description
    5. Tap next

    Expected Result:

    Description entered must be shown in task preview

    Actual Result:

    Description entered is not shown in task preview

    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

    Bug6612781_1727110034749.Screenrecorder-2024-09-23-22-12-44-97_compress_1.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!


      mWeb - Room - The text saved in private notes section is not shown

      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

      1. Go to https://49250.pr-testing.expensify.com/home
      2. Open a group chat
      3. Tap private notes
      4. Enter a text and save it
      5. Tap private notes section again

      Expected Result:

      The text saved in private notes section must be shown

      Actual Result:

      The text saved in private notes section is not shown

      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

      Bug6612840_1727113107966.az_recorder_20240923_223645_compress_1.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!


        mWeb - Composer - Text cursor appears behind the first letter after tapping keyboard spacebar

        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:

        • Keyboard is Samsung keyboard
        1. Go to https://49250.pr-testing.expensify.com/

        2. Go to DM

        3. Type a word and do not select any word from the suggestion (make sure the typed word still has underline)

        4. Tap keyboard spacebar

        Expected Result:

        The text cursor will be at the end of the word

        Actual Result:

        The text cursor appears behind the first letter after tapping keyboard spacebar

        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

        Bug6612846_1727113339788.1727111451020_Screen_Recording_20240924_010925_Chrome__1_.mp4
        Upwork Automation - Do Not Edit

          @lanitochka17
          Copy link

          lanitochka17 commented Sep 23, 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!


          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

            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

            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

            @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

            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.

            9 participants