Skip to content

Fix attachment modal for broken images #61459

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

Conversation

JakubKorytko
Copy link
Contributor

@JakubKorytko JakubKorytko commented May 6, 2025

Explanation of Change

The linked issue is caused by the fact that if the attachment is not loaded correctly because it is missing, it does not give any update to the modal, so it does not update things that depend on the success of loading, such as the download button.
I've created a hook to store the status of errors indexed by serialized image sources and attached it to both the native & normal versions of the modal and its children. It is called when there is a problem with loading image and hides download button.
As for swiping left/right on broken attachments in Native and failing ESLint check, see the first comment in this PR thread.

Fixed Issues

$ #60554
PROPOSAL: N/A

Tests

Do steps below for mweb & mobile Expensify app:

  1. Open a chat
  2. Send a broken image by pasting this:
![AltText](https://invalid-url/image.jpg)
  1. Open the broken image
  2. Verify that there is no download button

Offline tests

Same as test

QA Steps

Same as test

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 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 used JaimeGPT to get English > Spanish translation. I then posted it 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.ts 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.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
  • 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
Compare.mp4
Android: mWeb Chrome

Video for both m-web & native in Android: Native

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

@JakubKorytko JakubKorytko changed the title Fix attachment modal for broken images [WIP] Fix attachment modal for broken images May 6, 2025
@JakubKorytko JakubKorytko force-pushed the korytko/broken-video-attachment-fix branch 3 times, most recently from 1de62f0 to 9a1634e Compare May 7, 2025 09:10
@JakubKorytko JakubKorytko force-pushed the korytko/broken-video-attachment-fix branch from b3599a2 to a4f9ae0 Compare May 7, 2025 10:36
@JakubKorytko
Copy link
Contributor Author

NativeViewGestureHandlerProps' is deprecated. NativeViewGestureHandler will be removed in the future version of Gesture Handler. Use Gesture.Native() instead deprecation/deprecation

This eslint check error is unrelated to the linked issue, I think there should be (if there is not already) a separate issue and PR for it as I think it can break some things if done incorrectly.

The download button is fixed, but I am not sure if I should remove the ability to "move" the image if the attachment is broken. We can do that when we have a single attachment chat on Native (but not on m-web, web etc.), so to keep consistency I didn't touch that, see below:

Compare.mp4

I also found another bug which is reproducible on main and is important to know that this PR didn't cause it.
Download button disappears on missing attachment correctly, however when we open missing attachment on native (not a case for web, m-web etc.), the fallback info is only displayed on the first attachment in chat, other attachments do not render anything, do not call onError method at all, so download button stays there. Pretty sure this is somehow related to the Lightbox rendering in ImageView/index.native.tsx. See below:

NewProblem.mp4

Please, confirm expectations, so I can adjust the code/open for a review.

@JakubKorytko JakubKorytko changed the title [WIP] Fix attachment modal for broken images Fix attachment modal for broken images May 7, 2025
@JakubKorytko JakubKorytko requested a review from blazejkustra May 8, 2025 10:33
@JakubKorytko JakubKorytko force-pushed the korytko/broken-video-attachment-fix branch from a0ebae3 to 1c360aa Compare May 8, 2025 10:52
@JakubKorytko JakubKorytko marked this pull request as ready for review May 8, 2025 11:13
@JakubKorytko JakubKorytko requested a review from a team as a code owner May 8, 2025 11:13
@melvin-bot melvin-bot bot requested review from hungvu193 and removed request for a team May 8, 2025 11:13
Copy link

melvin-bot bot commented May 8, 2025

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

@hungvu193
Copy link
Contributor

On it 👀

@hungvu193
Copy link
Contributor

@JakubKorytko From my understanding, you will hide the download button if attachment is error, that's also a solution but I'm curious that we didn't resolve the RCA here. In fact, we still see the error modal if we click the download button but it took 2,3 minutes, so I think we should fix this from the library (react-native-blob-util) 🤔 . Wdyt?

@JakubKorytko
Copy link
Contributor Author

JakubKorytko commented May 9, 2025

I don't think that's enough. See my comment above. There are other problems with firing attachments in native:

  • For some reason onError is not called at all except for the first attachment in the chat, and we don't see the "attachment not found" fallback.
  • NativeViewGestureHandlerProps is deprecated, so ESLint fails.

I'm pretty sure the native version of this logic is deprecated and needs to be thoroughly investigated, but that's a separate topic. I would suggest fixing this by hiding the button for now, and raising a "bigger" issue for fixing the native version - maybe even a solid refractor, we have a lot of states in the attachment modal that don't make much sense.

For example isAttachmentInvalid, attachmentInvalidReason, attachmentInvalidReasonTitle - for some reason these don't equal true on missing attachment.

Another thing is that we have 3 context values for AttachmentCarouselPagerContext, each overwriting the previous one, in:

  • AttachmentModal
  • AttachmentCarousel
  • AttachmentCarouselPager

Doesn't seem like a good use of context to me.

I think another simple fix for this is okay for now, but at this point this component (AttachmentModal) and its sub-components are just messy. If someone from Expensify agrees, I can try to take care of this - but in a separate issue, as this is no longer a "download button" issue.

@hungvu193
Copy link
Contributor

Discussing in Slack

Copy link
Contributor

@chrispader chrispader left a comment

Choose a reason for hiding this comment

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

Looks good to me!

@hungvu193
Copy link
Contributor

The first attachment never seems to load for me; it always renders empty content:

Screen.Recording.2025-05-12.at.14.54.21.mov

@hungvu193
Copy link
Contributor

I also found an console error while testing but not sure how to reproduce.

fixed.PR.mov

@JakubKorytko
Copy link
Contributor Author

JakubKorytko commented May 12, 2025

I'm aware of the missing attachment not found text - mentioned here - but this PR fixes the download button not appearing when attachment is invalid, your recording can be reproduced on the main and that, I believe, is one of the reasons @chrispader is refractoring this component logic in his PR. See discussion in the original issue for full context.

@hungvu193
Copy link
Contributor

I'm aware of the missing attachment not found text - mentioned here - but this PR fixes the download button not appearing when attachment is invalid, your recording can be reproduced on the main and that,

Cool. That was pretty weird that I couldn't reproduce it on main but I can reproduce it now 😅.

The last thing is, can you take a look at the console error I found here?

@JakubKorytko
Copy link
Contributor Author

That's interesting. Let me look into this and I'll get back to you.

@JakubKorytko
Copy link
Contributor Author

All these conditional statements make it easy to forget to wrap the state updates with useEffect hook. The error should be gone now.

@hungvu193
Copy link
Contributor

hungvu193 commented May 12, 2025

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 that the composer does not automatically focus or open the keyboard on mobile unless explicitly intended. This includes checking that returning the app from the background does not unexpectedly open the keyboard.
  • I verified tests pass on all platforms & I tested again on:
    • Android: HybridApp
    • Android: mWeb Chrome
    • iOS: HybridApp
    • 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 there are no new alerts related to the canBeMissing param for useOnyx
  • 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 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.ts 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.
  • For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
  • 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: HybridApp
Android.mov
Android: mWeb Chrome
AndroidChrome.mov
iOS: HybridApp
Screen.Recording.2025-05-13.at.09.37.53.mov
iOS: mWeb Safari
safariz.mov
safari.mov
MacOS: Chrome / Safari
Chrome.mov
MacOS: Desktop
Desk.mov

@mountiny
Copy link
Contributor

nice, lets try to wrap this one up

@melvin-bot melvin-bot bot requested a review from mountiny May 13, 2025 02:38
@hungvu193
Copy link
Contributor

Note for QAs:
This PR hides the download button with broken image. The issue with empty attachment when open it in attachment modal is not a regression from this PR. Please see: #61459 (comment)

Copy link
Contributor

@mountiny mountiny left a comment

Choose a reason for hiding this comment

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

Thanks

@mountiny mountiny merged commit 7a881dc into Expensify:main May 14, 2025
15 of 16 checks passed
@melvin-bot melvin-bot bot added the Emergency label May 14, 2025
Copy link

melvin-bot bot commented May 14, 2025

@mountiny looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

@mountiny
Copy link
Contributor

The eslint issue on this file should be handled in a separate issue to avoid regressions

@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.

Copy link
Contributor

🚀 Deployed to production by https://github.com/mountiny in version: 9.1.46-12 🚀

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

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.

6 participants