Remove sideloading of Onyx data for attachment modal #30866

tgolen · 2023-11-03T17:59:27Z

Details

This PR removes some deprecated methods that were loading data into the components without using Onyx properly.

Fixed Issues

Part of #27262

Tests

Create a money request using the "scan" method
After creating the request you will be on the chat report with a preview of the request
Click on the request preview to go to the report details
Click on the request again to go to the request details
Click on the image of the request
Verify that a modal opens and displays the image properly

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 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
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
  - 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

Android: mWeb Chrome

Note: My emulator is not able to load the site in chrome due to URLs not loading and HOSTs setup needing to be fixed

iOS: Native

Note: our local emulators do not show receipts due to our WARP client that we have installed.

iOS: mWeb Safari

![image](https://github.com/Expensify/App/assets/1228807/839e889a-441b-49a3-b715-1235ce44c3e5)

MacOS: Chrome / Safari

MacOS: Desktop

melvin-bot · 2023-11-03T18:00:32Z

@dangrous 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-11-03T18:12:25Z

I can help if requires C+ review

tgolen · 2023-11-03T19:12:30Z

@situchan That would be helpful, yes please!

tgolen · 2023-11-06T16:17:21Z

@situchan would you be able to review this, please? Also bumping @dangrous for review.

situchan

Code looks good to me

situchan · 2023-11-06T16:21:18Z

src/components/Attachments/AttachmentCarousel/index.js

+            key: ({report}) => `${ONYXKEYS.COLLECTION.REPORT}${report ? report.parentReportID : '0'}`,
+        },
+        parentReportActions: {
+            key: ({report}) => `${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${report ? report.parentReportID : '0'}`,
+            canEvict: false,
+        },
+    }),
+
+    // eslint-disable-next-line rulesdir/no-multiple-onyx-in-file
+    withOnyx({
+        transaction: {
+            key: ({report, parentReportActions}) => {
+                const parentReportAction = lodashGet(parentReportActions, [report.parentReportActionID]);
+                return `${ONYXKEYS.COLLECTION.TRANSACTION}${lodashGet(parentReportAction, 'originalMessage.IOUTransactionID', 0)}`;
+            },


Regarding these changes, can you confirm that parentReportID, originalMessage.IOUTransactionID can never be empty string? Because if empty string, it will return all reportActions, transactions

I would never be able to guarantee that they could never be empty strings, but the chances of them being an empty string is very very very unlikely. This is how all key functions load data from params, so I don't think there is anything special that needs to be done here. The most important part is that lodashGet() needs to provide a default value (which it does).

situchan · 2023-11-06T17:13:51Z

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

    withOnyx({
        reportActions: {
            key: ({report}) => `${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${report.reportID}`,
            canEvict: false,
        },
+        parentReport: {
+            key: ({report}) => `${ONYXKEYS.COLLECTION.REPORT}${report ? report.parentReportID : '0'}`,
+        },
+        parentReportActions: {
+            key: ({report}) => `${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${report ? report.parentReportID : '0'}`,
+            canEvict: false,
+        },
+    }),
+
+    // eslint-disable-next-line rulesdir/no-multiple-onyx-in-file
+    withOnyx({
+        transaction: {
+            key: ({report, parentReportActions}) => {
+                const parentReportAction = lodashGet(parentReportActions, [report.parentReportActionID]);
+                return `${ONYXKEYS.COLLECTION.TRANSACTION}${lodashGet(parentReportAction, 'originalMessage.IOUTransactionID', 0)}`;
+            },
+        },


I see that #28866 is completely removing multiple withOnyx.

dangrous

Couple of questions, following the questions @situchan asked as well.

src/components/Attachments/AttachmentCarousel/index.js

dangrous · 2023-11-07T04:50:28Z

src/components/Attachments/AttachmentCarousel/attachmentCarouselPropTypes.js

+    /** The parent of `report` */
+    parentReport: reportPropTypes,
+
+    /** The specific action that links to the parent report */


Suggested change

/** The specific action that links to the parent report */

/** The specific actions that link to the parent report */

Unless I'm misunderstanding this. If we're only sending one action, can we send the action itself instead of this container?

It's not possible to get the single action via withOnyx() so the component must receive all the parent report actions and then lookup the specific report action with const parentReportAction = parentReportActions[report.parentReportActionID];

I'll update the comment for this prop

tgolen · 2023-11-07T15:34:40Z

OK, I have updated this PR to remove the nested withOnyx() calls and to update a comment to be more accurate. This is ready for review again.

dangrous

So I'm getting a 404 error when following the testing steps but it's requesting a specific png so I think it's an unrelated issue I'll figure out separately. If @situchan can test successfully, that works for me! Code updates look good.

situchan · 2023-11-07T19:57:05Z

src/components/Attachments/AttachmentCarousel/attachmentCarouselPropTypes.js

+    parentReport: reportPropTypes,
+
+    /** The report actions of the parent report */
+    parentReportActions: PropTypes.shape(reportActionPropTypes),


This kind of mistake is easy to miss

Suggested change

parentReportActions: PropTypes.shape(reportActionPropTypes),

parentReportActions: PropTypes.objectOf(PropTypes.shape(reportActionPropTypes)),

Yes, thank you. I went back and forth on parentReportAction and parentReportActions and forgot to update this.

situchan · 2023-11-07T20:01:17Z

src/components/Attachments/AttachmentCarousel/extractAttachmentsFromReport.js

@@ -10,11 +10,13 @@ import CONST from '@src/CONST';
 /**
 * Constructs the initial component state from report actions
 * @param {Object} report
+ * @param {Object} parentReportAction
 * @param {Array} reportActions


I am not sure why this is array

src/components/Attachments/AttachmentCarousel/index.js

tgolen · 2023-11-08T18:14:09Z

@situchan I have addressed your comments. I found another proptype that needed updated and I also found an unused param report that could be cleaned up.

tgolen · 2023-11-09T15:58:57Z

@situchan bump for review please

situchan · 2023-11-09T19:38:55Z

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

Android: Native

android.mov

Android: mWeb Chrome

mchrome.mov

iOS: Native

ios.mov

iOS: mWeb Safari

msafari.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

situchan · 2023-11-09T19:40:27Z

@tgolen regression: attachment modal header title briefly shows "Attachment"

mchrome.mov

tgolen · 2023-11-09T21:31:02Z

@situchan Thanks for reporting that. I was largely unable to reproduce the issue. On my emulator, I guess the transition happens so fast that I cannot see it. I made an improvement to the code to hopefully improve the header title so that It does not default to either attachment or receipt until it absolutely knows which one it is.

situchan · 2023-11-09T21:33:24Z

@situchan Thanks for reporting that. I was largely unable to reproduce the issue. On my emulator, I guess the transition happens so fast that I cannot see it. I made an improvement to the code to hopefully improve the header title so that It does not default to either attachment or receipt until it absolutely knows which one it is.

It's known that native app is super slow in android emulator. So if you test on that device, you will clearly notice. Also noticeable on android emulator chrome

situchan · 2023-11-09T21:38:30Z

One more: download icon changes to three dot

Screen.Recording.2023-11-10.at.3.37.23.AM.mov

tgolen · 2023-11-09T22:13:41Z

OK, I've pushed a fix for that too. I'm a bit stuck. My android build keeps failing (of course, right at the last step), so I've been trying to get it built and tested on Android but haven't had much luck. The third time is the charm, right?

situchan · 2023-11-09T22:36:39Z

Now found more serious regression:
Not found page briefly shows while scanning request

Screen.Recording.2023-11-10.at.4.35.04.AM.mov

situchan · 2023-11-13T14:41:32Z

@tgolen single withOnyx PR was reverted. I think we should go back to multiple withOnyx in this PR for now.

tgolen · 2023-11-13T15:57:06Z

OK, I agree. I'll switch this to use multiple withOnyx() for now. This is a bit lower on my list of priorities, so I might not get to it until later this week.

tgolen · 2023-11-13T17:59:26Z

OK, I've updated this to use multiple withOnyx, so it looks like it behaves a little more expectantly now. Can you please take another look at it @situchan ?

situchan · 2023-11-13T19:51:08Z

Looks good now

Screen.Recording.2023-11-14.at.1.49.54.AM.mov

situchan

@dangrous all yours

melvin-bot · 2023-11-13T19:52:19Z

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

melvin-bot · 2023-11-13T19:52:23Z

🎯 @situchan, thanks for reviewing and testing this PR! 🎉

An E/App issue has been created to issue payment here: #31273.

dangrous

Cool, I think this makes sense!

dangrous · 2023-11-13T20:50:12Z

I'm going to go ahead and merge, not sure why Melvin tagged @lakchote

OSBotify · 2023-11-13T20:55:33Z

✋ 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-11-14T22:09:42Z

🚀 Deployed to staging by https://github.com/dangrous in version: 1.3.99-0 🚀

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

OSBotify · 2023-11-15T20:52:58Z

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.99-0 🚀

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

OSBotify · 2023-11-15T21:08:24Z

🚀 Deployed to staging by https://github.com/dangrous in version: 1.4.0-0 🚀

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

Remove sideloading of Onyx data for attachment modal

34e3fa2

tgolen self-assigned this Nov 3, 2023

tgolen requested a review from a team as a code owner November 3, 2023 17:59

tgolen mentioned this pull request Nov 3, 2023

Remove ReportActionsUtils.getParentReportAction(), ReportUtils.getParentReport(), TransactionUtils.getLinkedTransaction(), ReportUtils.getPolicy(), and TransactionUtils.getTransaction() #27262

Closed

25 tasks

melvin-bot bot removed the request for review from a team November 3, 2023 18:00

melvin-bot bot requested a review from dangrous November 3, 2023 18:00

situchan reviewed Nov 6, 2023

View reviewed changes

dangrous requested changes Nov 7, 2023

View reviewed changes

situchan mentioned this pull request Nov 7, 2023

Remove duplicate withOnyx calls #28866

Merged

61 tasks

tgolen added 3 commits November 7, 2023 08:27

Merge branch 'main' into tgolen-improve-proploading

6df3088

Remove nested withOnyx

d0b5968

Update comment to be accurate

00d73e2

tgolen requested review from dangrous and situchan November 7, 2023 15:34

dangrous previously approved these changes Nov 7, 2023

View reviewed changes

situchan reviewed Nov 7, 2023

View reviewed changes

Fix proptypes, remove unused parameter

efcfe07

tgolen dismissed dangrous’s stale review via efcfe07 November 8, 2023 18:13

tgolen requested a review from situchan November 8, 2023 18:14

Don't show the buttons until the file type is known

2e403d0

Merge branch 'main' into tgolen-improve-proploading

6dfa2c9

Merge branch 'main' into tgolen-improve-proploading

603c396

tgolen added 3 commits November 13, 2023 08:58

Use multiple withOnyx

e5edd85

Merge branch 'main' into tgolen-improve-proploading

a5495e0

disable eslint for multiple onyx

00879f5

situchan approved these changes Nov 13, 2023

View reviewed changes

melvin-bot bot requested a review from lakchote November 13, 2023 19:52

melvin-bot bot mentioned this pull request Nov 13, 2023

Payment issue for E/App PR#30866 #31273

Closed

dangrous approved these changes Nov 13, 2023

View reviewed changes

dangrous merged commit cd35dfa into main Nov 13, 2023
15 checks passed

dangrous deleted the tgolen-improve-proploading branch November 13, 2023 20:50

OSBotify mentioned this pull request Nov 14, 2023

Deploy Checklist: New Expensify 2023-11-14 #31324

Closed

OSBotify mentioned this pull request Nov 15, 2023

Deploy Checklist: New Expensify 2023-11-15 #31404

Closed

37 tasks

	/** The specific action that links to the parent report */
	/** The specific actions that link to the parent report */

	parentReportActions: PropTypes.shape(reportActionPropTypes),
	parentReportActions: PropTypes.objectOf(PropTypes.shape(reportActionPropTypes)),

Remove sideloading of Onyx data for attachment modal #30866

Remove sideloading of Onyx data for attachment modal #30866

Conversation

tgolen commented Nov 3, 2023 • edited by github-actions bot Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Nov 3, 2023

situchan commented Nov 3, 2023

tgolen commented Nov 3, 2023

tgolen commented Nov 6, 2023

situchan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dangrous left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tgolen commented Nov 7, 2023

dangrous left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tgolen commented Nov 8, 2023

tgolen commented Nov 9, 2023

situchan commented Nov 9, 2023

Reviewer Checklist

Screenshots/Videos

situchan commented Nov 9, 2023

tgolen commented Nov 9, 2023

situchan commented Nov 9, 2023 • edited Loading

situchan commented Nov 9, 2023

tgolen commented Nov 9, 2023

situchan commented Nov 9, 2023

situchan commented Nov 13, 2023

tgolen commented Nov 13, 2023

tgolen commented Nov 13, 2023

situchan commented Nov 13, 2023

situchan left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Nov 13, 2023

melvin-bot bot commented Nov 13, 2023

dangrous left a comment

Choose a reason for hiding this comment

dangrous commented Nov 13, 2023

OSBotify commented Nov 13, 2023

OSBotify commented Nov 14, 2023

OSBotify commented Nov 15, 2023

OSBotify commented Nov 15, 2023

tgolen commented Nov 3, 2023 •

edited by github-actions bot

Loading

situchan commented Nov 9, 2023 •

edited

Loading