[CP Staging] Fix viewing attachments by youssef-lr · Pull Request #30481 · Expensify/App

youssef-lr · 2023-10-27T07:50:49Z

Details

I'm not really sure why this started breaking out of a sudden, but applying the solution form this SO worked.

Fixed Issues

$ #30490
https://expensify.slack.com/archives/C049HHMV9SM/p1698361711073589

Tests

Verify that no errors appear in the JS console

Upload an image to the chat
Open the preview and make sure it appears properly.
Repeat with a PDF.

Offline tests

N/A

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 / Chrome
- iOS / native
- iOS / 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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- 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 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(themeColors.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 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

Screen.Recording.2023-10-27.at.12.26.19.mov

MacOS: Desktop

melvin-bot · 2023-10-27T08:30:08Z

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

situchan · 2023-10-27T09:32:10Z

I had commented on offending PR - #29643 (comment)
I can help review and testing if needed

cristipaval · 2023-10-27T09:49:19Z

It seems that this change a base class, so I think it makes sense to assign a C+ for rigorous testing. Please also test all the use cases affected by this change, @situchan

situchan

@youssef-lr I think you applied fix in wrong component.
The crash happens on AttachmentCarousel, not on BaseOptionsList

Screen.Recording.2023-10-27.at.3.55.18.PM.mov

Reverting this change should fix the bug but also open for alternative solution while keep using useCallback

situchan · 2023-10-27T10:06:14Z

Let's apply this change:

App/src/components/Attachments/AttachmentCarousel/index.js

Line 98 in eef8347

[onNavigate],

-       [onNavigate],
+       // eslint-disable-next-line react-hooks/exhaustive-deps
+       [],

sebryu · 2023-10-27T12:54:58Z

I'm the author of PR which introduced this bug. The best solution IMHO is doing the following:

+++ b/src/pages/home/report/ReportAttachments.js
@@ -1,4 +1,4 @@
-import React from 'react';
+import React, { useCallback } from 'react';
 import _ from 'underscore';
 import PropTypes from 'prop-types';
 import AttachmentModal from '../../../components/AttachmentModal';
@@ -23,6 +23,10 @@ function ReportAttachments(props) {
     const reportID = _.get(props, ['route', 'params', 'reportID']);
     const report = ReportUtils.getReport(reportID);
     const source = decodeURI(_.get(props, ['route', 'params', 'source']));
+    const onCarouselAttachmentChange = useCallback((attachment) => {
+        const route = ROUTES.REPORT_ATTACHMENTS.getRoute(reportID, attachment.source);
+        Navigation.navigate(route);
+    }, [reportID]);

     return (
         <AttachmentModal
@@ -31,10 +35,7 @@ function ReportAttachments(props) {
             report={report}
             source={source}
             onModalHide={() => Navigation.dismissModal()}
-            onCarouselAttachmentChange={(attachment) => {
-                const route = ROUTES.REPORT_ATTACHMENTS.getRoute(reportID, attachment.source);
-                Navigation.navigate(route);
-            }}
+            onCarouselAttachmentChange={onCarouselAttachmentChange}
         />
     );
 }

AttachmentCarousel depends on onNavigate props, which is passed from AttachmentModal (onCarouselAttachmentChange prop), which is only passed from ReportAttachments component - but it's poorly implemented and it's sending new function on each render. Memoizing onCarouselAttachmentChange in ReportAttachments solves the problem

situchan · 2023-10-27T13:17:08Z

Agree with @sebryu

youssef-lr · 2023-10-27T14:27:54Z

@sebryu would you like to create the PR instead?

situchan · 2023-10-27T15:37:08Z

I think we can continue fix here if @sebryu is already off for the weekend

youssef-lr · 2023-10-27T15:41:11Z

Sounds good. Going to update the PR shortly.

youssef-lr · 2023-10-27T16:03:12Z

Updated.

situchan · 2023-10-27T16:19:04Z

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 / Chrome
- iOS / native
- iOS / 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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- 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(themeColors.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 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

Web

web.mov

Mobile Web - Chrome

mchrome.mov

Mobile Web - Safari

msafari.mov

Desktop

desktop.mov

iOS

ios.mov

Android

android.mov

situchan

melvin-bot · 2023-10-27T16:20:35Z

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

tgolen

While the fix looks fine (and even conforming better to our best practices), it would be great to know what broke this. Perhaps using git bisect would identify the commit which introduced the error.

tgolen · 2023-10-27T16:40:26Z

I'm going to go ahead and merge this since it's to fix a deploy blocker.

youssef-lr · 2023-10-27T16:41:51Z

Offending PR has been identified here @tgolen #29643 (comment)

[CP Staging] Fix viewing attachments (cherry picked from commit 853d489)

OSBotify · 2023-10-27T16:47:24Z

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

OSBotify · 2023-10-27T17:15:00Z

🚀 Cherry-picked to staging by https://github.com/tgolen in version: 1.3.92-2 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

OSBotify · 2023-10-30T07:41:47Z

🚀 Deployed to production by https://github.com/Beamanator in version: 1.3.92-4 🚀

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

OSBotify · 2023-10-31T22:01:59Z

🚀 Deployed to staging by https://github.com/tgolen in version: 1.3.94-0 🚀

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

OSBotify · 2023-11-01T08:53:57Z

🚀 Deployed to staging by https://github.com/tgolen in version: 1.3.94-0 🚀

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

OSBotify · 2023-11-02T10:17:19Z

🚀 Deployed to production by https://github.com/Beamanator in version: 1.3.94-2 🚀

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

youssef-lr added 3 commits October 27, 2023 11:50

Fix viewing attachments

e0e51ed

Add dependencies to useCallback

d2844c9

Remove unneeded ref

1c8903f

youssef-lr self-assigned this Oct 27, 2023

youssef-lr marked this pull request as ready for review October 27, 2023 08:29

youssef-lr requested a review from a team as a code owner October 27, 2023 08:29

melvin-bot bot requested review from cristipaval and removed request for a team October 27, 2023 08:30

youssef-lr changed the title ~~Fix viewing attachments~~ [CP Staging]Fix viewing attachments Oct 27, 2023

youssef-lr changed the title ~~[CP Staging]Fix viewing attachments~~ [CP Staging] Fix viewing attachments Oct 27, 2023

cristipaval requested a review from situchan October 27, 2023 09:49

situchan suggested changes Oct 27, 2023

View reviewed changes

situchan mentioned this pull request Oct 27, 2023

[$500] Distance-App crashes tapping on download receipt in android& on tapping receipt in mweb&web #30489

Closed

6 tasks

MariaHCD mentioned this pull request Oct 27, 2023

[HOLD for payment 2023-11-07] [HOLD for payment 2023-11-06] [$500] Attachment - Page crashes when open downloaded Attachments #30490

Closed

6 tasks

Apply fix in AttachmentModal instead of BaseOptionsList

8531566

situchan approved these changes Oct 27, 2023

View reviewed changes

melvin-bot bot requested a review from danieldoglas October 27, 2023 16:20

tgolen approved these changes Oct 27, 2023

View reviewed changes

tgolen merged commit 853d489 into main Oct 27, 2023

tgolen deleted the youssef_fix_attachments branch October 27, 2023 16:40

OSBotify pushed a commit that referenced this pull request Oct 27, 2023

Merge pull request #30481 from Expensify/youssef_fix_attachments

d58a615

[CP Staging] Fix viewing attachments (cherry picked from commit 853d489)

OSBotify mentioned this pull request Oct 27, 2023

Deploy Checklist: New Expensify 2023-10-26 #30469

Closed

64 tasks

OSBotify mentioned this pull request Oct 31, 2023

Deploy Checklist: New Expensify 2023-10-31 #30662

Closed

97 tasks

Conversation

youssef-lr commented Oct 27, 2023 • edited by nkuoch Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Oct 27, 2023

Uh oh!

situchan commented Oct 27, 2023

Uh oh!

cristipaval commented Oct 27, 2023

Uh oh!

situchan left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

situchan commented Oct 27, 2023

Uh oh!

sebryu commented Oct 27, 2023

Uh oh!

situchan commented Oct 27, 2023

Uh oh!

youssef-lr commented Oct 27, 2023

Uh oh!

situchan commented Oct 27, 2023

Uh oh!

youssef-lr commented Oct 27, 2023

Uh oh!

youssef-lr commented Oct 27, 2023

Uh oh!

situchan commented Oct 27, 2023

Reviewer Checklist

Screenshots/Videos

Uh oh!

situchan left a comment

Choose a reason for hiding this comment

Uh oh!

melvin-bot bot commented Oct 27, 2023

Uh oh!

tgolen left a comment

Choose a reason for hiding this comment

Uh oh!

tgolen commented Oct 27, 2023

Uh oh!

youssef-lr commented Oct 27, 2023

Uh oh!

OSBotify commented Oct 27, 2023

Uh oh!

OSBotify commented Oct 27, 2023

Uh oh!

OSBotify commented Oct 30, 2023

Uh oh!

OSBotify commented Oct 31, 2023

Uh oh!

OSBotify commented Nov 1, 2023

Uh oh!

OSBotify commented Nov 2, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

youssef-lr commented Oct 27, 2023 •

edited by nkuoch

Loading

situchan left a comment •

edited

Loading