deprecate `ReportActionUtils.getAllReportActions()` (Issue 39091) by EzraEllette · Pull Request #40046 · Expensify/App

EzraEllette · 2024-04-10T21:39:14Z

Details

Removed ReportActionUtils.getAllReportActions() from list of exports. Using Onyx, Subscribed to report action data in all other files that require a list of ReportActions by report ID.

Fixed Issues

$ #39091
PROPOSAL: #39091 (comment)

Tests

Added test to ensure getAllReportActions is not exported
Ran test suites.

Offline tests

Ensure that no reports may be created or modified while offline.

QA Steps

Create and submit expense report.
Use another Account to pay expense report.
repeat for Web, Desktop, iOS, and Android.

PR Author Checklist

Screenshots/Videos

Android: Native

Android.1.mov

Android.2.mov

Android: mWeb Chrome

iOS: Native

Please note that the submit button failure was already present in the main branch when I started this PR.

iOS.Native.P1.mov

iOS.Native.P2.mov

iOS: mWeb Safari

iOS.Web.mov

MacOS: Chrome / Safari

Web.1.mov

Web.2.mov

MacOS: Desktop

Desktop.1.mov

Desktop.2.mov

This reverts commit 2e950e3.

…tions

github-actions · 2024-04-10T21:39:27Z

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

EzraEllette · 2024-04-10T21:41:21Z

I have read the CLA Document and I hereby sign the CLA

EzraEllette · 2024-04-10T21:41:31Z

recheck

EzraEllette · 2024-04-10T22:00:34Z

Can't get android running on my machine. Any advice? Will try again later or when I get access to the Slack.

melvin-bot · 2024-04-11T01:24:57Z

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

Ollyws · 2024-04-11T19:05:11Z

@EzraEllette if you merge main the android build issues should be fixed.

Ollyws · 2024-04-12T09:54:41Z

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

01_Android_Native.mp4

Android: mWeb Chrome

02_Android_Chrome.mp4

iOS: Native

03_iOS_Native.mp4

iOS: mWeb Safari

04_iOS_Safari.mp4

MacOS: Chrome / Safari

05_MacOS_Chrome.mp4

MacOS: Desktop

06_MacOS_Desktop.mp4

Ollyws

LGTM.

tgolen

Looks great. Thank you!

tgolen · 2024-04-12T15:02:39Z

Looks like a couple of the tests are failing. Can you see if you can get the CLA bot to recheck again? It also looks like the checklist in the PR description might be out-of-date.

EzraEllette · 2024-04-12T15:05:38Z

recheck

…tions

EzraEllette · 2024-04-12T15:13:56Z

@tgolen The branch is updated and the tests are passing. 🎉

shubham1206agra · 2024-04-12T15:55:52Z

src/libs/actions/ReportActions.ts


+const reportActionsByReport: OnyxCollection<ReportActions> = {};
+Onyx.connect({
+    key: ONYXKEYS.COLLECTION.REPORT_ACTIONS,


@tgolen Is there a reason why waitForCollectionCallback is not being used here?

None that I know of 😅

Thanks for catching that. It probably should be using waitForCollectionCallback since that will have a slight performance improvement.

@EzraEllette Could you do a follow-up PR to modify that?

EzraEllette · 2024-04-12T17:06:44Z

Sure thing

…

On Fri, Apr 12, 2024 at 11:57 AM Tim Golen ***@***.***> wrote: ***@***.**** commented on this pull request. ------------------------------ In src/libs/actions/ReportActions.ts <#40046 (comment)>: > @@ -56,6 +59,19 @@ function clearReportActionErrors(reportID: string, reportAction: ReportAction, k }); } +const reportActionsByReport: OnyxCollection<ReportActions> = {}; +Onyx.connect({ + key: ONYXKEYS.COLLECTION.REPORT_ACTIONS, None that I know of 😅 Thanks for catching that. It probably should be using waitForCollectionCallback since that will have a slight performance improvement. @EzraEllette <https://github.com/EzraEllette> Could you do a follow-up PR to modify that? — Reply to this email directly, view it on GitHub <#40046 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AL7TPLNPZ27HCFGURW6W77DY5AHAJAVCNFSM6AAAAABGBF35L2VHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMYTSOJXHE2TMMRRGU> . You are receiving this because you were mentioned.Message ID: ***@***.***>

OSBotify · 2024-04-18T04:58:53Z

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

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

OSBotify · 2024-04-22T14:59:52Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.63-21 🚀

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

EzraEllette and others added 12 commits April 9, 2024 09:29

remove getAllReportActions export

305c976

remove getAllReportActions from SidebarUtils

e15bf62

remove getAllReportActions from ReportUtils

03c50ac

remove getAllReportActions from WorkspacesSettingsUtils

0834005

remove getAllReportActions from IOU

2e950e3

remove getAllReportActions from ReportActions

b4068ec

Revert "remove getAllReportActions from IOU"

8cf101a

This reverts commit 2e950e3.

decided to keep formatting changes

48c752e

Merge branch 'Expensify:main' into iss-27262-deprecate-getAllReportAc…

6669280

…tions

fixes

291b099

Merge branch 'Expensify:main' into iss-27262-deprecate-getAllReportAc…

0fcf2a7

…tions

Merge branch 'Expensify:main' into iss-27262-deprecate-getAllReportAc…

bd5c75a

…tions

EzraEllette mentioned this pull request Apr 10, 2024

[PAY 29/04] [$250] Remove deprecated ReportActionUtils.getAllReportActions() method #39091

Closed

EzraEllette marked this pull request as ready for review April 11, 2024 01:24

EzraEllette requested a review from a team as a code owner April 11, 2024 01:24

melvin-bot bot requested review from Ollyws and removed request for a team April 11, 2024 01:24

Ollyws approved these changes Apr 12, 2024

View reviewed changes

melvin-bot bot requested a review from tgolen April 12, 2024 09:55

tgolen approved these changes Apr 12, 2024

View reviewed changes

Merge branch 'Expensify:main' into iss-39091-deprecate-getAllReportAc…

ad4697c

…tions

tgolen merged commit 617f9e9 into Expensify:main Apr 12, 2024

shubham1206agra reviewed Apr 12, 2024

View reviewed changes

github-actions bot mentioned this pull request Apr 18, 2024

Deploy Checklist: New Expensify 2024-04-18 #40392

Closed

Conversation

EzraEllette commented Apr 10, 2024 • edited 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!

github-actions bot commented Apr 10, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

EzraEllette commented Apr 10, 2024

Uh oh!

EzraEllette commented Apr 10, 2024

Uh oh!

EzraEllette commented Apr 10, 2024

Uh oh!

melvin-bot bot commented Apr 11, 2024

Uh oh!

Ollyws commented Apr 11, 2024

Uh oh!

Ollyws commented Apr 12, 2024

Reviewer Checklist

Screenshots/Videos

Uh oh!

Ollyws left a comment

Choose a reason for hiding this comment

Uh oh!

tgolen left a comment

Choose a reason for hiding this comment

Uh oh!

tgolen commented Apr 12, 2024

Uh oh!

EzraEllette commented Apr 12, 2024

Uh oh!

EzraEllette commented Apr 12, 2024

Uh oh!

shubham1206agra Apr 12, 2024

Choose a reason for hiding this comment

Uh oh!

tgolen Apr 12, 2024

Choose a reason for hiding this comment

Uh oh!

EzraEllette commented Apr 12, 2024 via email

Uh oh!

OSBotify commented Apr 18, 2024

Uh oh!

OSBotify commented Apr 22, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

EzraEllette commented Apr 10, 2024 •

edited

Loading

github-actions bot commented Apr 10, 2024 •

edited

Loading