Subscribe transactions in report preview #32469

dukenv0307 · 2023-12-05T06:09:25Z

Details

Subscribe transactions from Onyx in report preview by using onyxSubscribe

Fixed Issues

$ #32256
PROPOSAL: #32256 (comment)

Tests

Create a scan request with an invalid receipt image
Go to the transaction thread report of this scan request
Change the amount of the request
Verify that after changing amount the error appears
Go back to the chat report which contains the report preview of this request above
Verify that the red dot appears
Click on report preview to open IOU report and click on IOU preview to go to transaction thread report
Change the merchant of the request
Click on back button to go back to the IOU report and click on the back button again to back to the chat report
Verify that the red dot in report preview disappears

Verify that no errors appear in the JS console

Offline tests

Pre-condition: Do the step 1-4 in online mode
Do the step 5 - 10 same as above

QA Steps

Create a scan request with an invalid receipt image
Go to the transaction thread report of this scan request
Change the amount of the request
Verify that after changing amount the error appears
Go back to the chat report which contains the report preview of this request above
Verify that the red dot appears
Click on report preview to open IOU report and click on IOU preview to go to transaction thread report
Change the merchant of the request
Click on back button to go back to the IOU report and click on the back button again to back to the chat report
Verify that the red dot in report preview disappears

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Screen.Recording.2023-12-05.at.13.03.38.mov

Android: mWeb Chrome

Screen.Recording.2023-12-05.at.12.40.07.mov

iOS: Native

Screen.Recording.2023-12-05.at.12.44.53.mov

iOS: mWeb Safari

Screen.Recording.2023-12-05.at.12.24.48.mov

MacOS: Chrome / Safari

Screen.Recording.2023-12-05.at.12.16.25.mov

MacOS: Desktop

Screen.Recording.2023-12-05.at.13.08.33.mov

melvin-bot · 2023-12-05T06:09:58Z

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

hoangzinh · 2023-12-05T15:56:10Z

src/components/ReportActionItem/ReportPreview.js

+        const unsubscribeOnyxTransaction = onyxSubscribe({
+            key: ONYXKEYS.COLLECTION.TRANSACTION,
+            waitForCollectionCallback: true,
+            callback: (transactionAgrs) => {


Why don't we just call ReportUtils.hasMissingSmartscanFields to update hasErrors state when there is a change from ONYXKEYS.COLLECTION.TRANSACTION? Therefore, each ReportPreview component doesn't need to carry all transaction data.

@hoangzinh How can we not carry all transaction data? Because ReportPreview has many transactions.

Our purpose of subscribe to Onyx change is if there is any update related to ONYXKEYS.COLLECTION.TRANSACTION we will check again ReportUtils.hasMissingSmartscanFields, won't we? So I have an idea something like this:

const [isError, setIsError] = useState(false); const hasErrors = hasReceipts && isError; useEffect(() => { onyxSubscribe({ key: ONYXKEYS.COLLECTION.TRANSACTION, .... callback: () => { setIsError(ReportUtils.hasMissingSmartscanFields(props.iouReportID)); } } })

Therefore, we don't need to load all transactions for each ReportPreview component. What do you think?

Therefore, we don't need to load all transactions for each ReportPreview component. What do you think?

I know that but I can't find a way to only subscribe the necessary transaction

we don't really need @dukenv0307. We subscribe to all keys change ONYXKEYS.COLLECTION.TRANSACTION.

@hoangzinh Actually hasOnlyDistanceRequestTransactions, areAllRequestsBeingSmartScannedand hasMissingSmartscanFields functions are getting all transactions of ReportPreview in these functions, so when we subscribe transactions in ReportPreview, we can get all transactions with iouReportID and pass this to these function. That can make sure other functions will not have the same bug and we don't need to getAllReportTransactions again in these functions if we already pass transactions param.

looks better than previous one. Btw, have you tested all the places that are using modified methods in this PR? We have some regression bugs recently because missing params or incorrect params

@hoangzinh I added default value for transactions param so other places which use this function will call getAllTransaction function to get data.

if we go this way, why don't we do something like my suggestion here? https://github.com/Expensify/App/pull/32469/files#r1417094685 (both your current implementation and this suggestion are based on the assumption that transactions in TransactionUtils.getAllReportTransactions is up-to-date

@hoangzinh Updated.

hoangzinh · 2023-12-11T15:19:43Z

src/components/ReportActionItem/ReportPreview.js

+                    return;
+                }
+
+                const allTransaction = _.filter(transactionAgrs, (transaction) => `${transaction.reportID}` === `${props.iouReportID}`);


I'm thinking that is there any way that we can use share logic with the existing function here

App/src/libs/TransactionUtils.ts

Lines 450 to 456 in a16df0d

function getAllReportTransactions(reportID?: string): Transaction[] {

// `reportID` from the `/CreateDistanceRequest` endpoint return's number instead of string for created `transaction`.

// For reference, https://github.com/Expensify/App/pull/26536#issuecomment-1703573277.

// We will update this in a follow-up Issue. According to this comment: https://github.com/Expensify/App/pull/26536#issuecomment-1703591019.

const transactions: Transaction[] = Object.values(allTransactions ?? {}).filter((transaction): transaction is Transaction => transaction !== null);

return transactions.filter((transaction) => `${transaction.reportID}` === `${reportID}`);

}

It covers the null case of transaction and centralizes the logic.

@hoangzinh Updated.

hoangzinh · 2023-12-12T13:11:48Z

src/components/ReportActionItem/ReportPreview.js

+                    return;
+                }
+
+                const allTransactions = TransactionUtils.getAllReportTransactions(props.iouReportID);


What if the transactions cached in TransactionUtils is not updated yet? I think we will get outdated transaction data.

@hoangzinh When we subscribe transactions here, the transactions in TransactionUtils will not be outdated.

Both component and util TransactionUtils are subscribed to transactions, we can't control which place is updated first or same time. How can you ensure "the transactions in TransactionUtils will not be outdated."?

@hoangzinh You can try to only subscribe transactions from Onyx in ReportPreview and do nothing. You can see that the issue is resolved.

hoangzinh · 2023-12-19T14:58:49Z

src/libs/ReportUtils.ts

@@ -938,8 +938,8 @@ function hasSingleParticipant(report: OnyxEntry<Report>): boolean {
 *
 */
 function hasOnlyDistanceRequestTransactions(iouReportID: string | undefined): boolean {
-    const transactions = TransactionUtils.getAllReportTransactions(iouReportID);
-    return transactions.every((transaction) => TransactionUtils.isDistanceRequest(transaction));
+    const allTransactionsOfPreview = TransactionUtils.getAllReportTransactions(iouReportID);


should we revert those changes @dukenv0307 ?

@hoangzinh Yes, reverted.

hoangzinh · 2023-12-20T15:51:54Z

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

Screen.Recording.2023-12-20.at.23.06.51.android.mp4

Android: mWeb Chrome

Screen.Recording.2023-12-20.at.22.56.03.android.chrome.mov

iOS: Native

Screen.Recording.2023-12-20.at.22.58.53.-.ios.mp4

iOS: mWeb Safari

Screen.Recording.2023-12-20.at.22.58.01.-.ios.safari.mov

MacOS: Chrome / Safari

Screen.Recording.2023-12-20.at.22.45.35.-.web.mov

MacOS: Desktop

Screen.Recording.2023-12-20.at.22.49.32.-.desktop.mov

jasperhuangg · 2023-12-20T22:48:21Z

src/components/ReportActionItem/ReportPreview.js

+            key: ONYXKEYS.COLLECTION.TRANSACTION,
+            waitForCollectionCallback: true,
+            callback: (transactionAgrs) => {
+                if (_.isEmpty(transactionAgrs)) {


What is transactionAgrs? Can we use a more descriptive name here?

Let's also add a comment explaining why this can be empty

What is transactionAgrs? Can we use a more descriptive name here?

Updated.

Let's also add a comment explaining why this can be empty

Not sure why but in other places which use onyxSubscribe also have this check and I tried to remove this check, it makes perf fail as the ReportScreen re-render many times

OSBotify · 2023-12-26T00:14:25Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.16-5 🚀

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

subscribe transaction in report preview

3a9e353

dukenv0307 marked this pull request as ready for review December 5, 2023 06:09

dukenv0307 requested a review from a team as a code owner December 5, 2023 06:09

melvin-bot bot requested review from hoangzinh and removed request for a team December 5, 2023 06:09

hoangzinh reviewed Dec 5, 2023

View reviewed changes

dukenv0307 added 2 commits December 8, 2023 11:29

merge main

e17fab0

rename variable

969df42

hoangzinh reviewed Dec 11, 2023

View reviewed changes

dukenv0307 added 2 commits December 12, 2023 16:44

Merge branch 'main' into fix/32256

575be36

use getAllReportTransaction function

b6e9f49

hoangzinh reviewed Dec 12, 2023

View reviewed changes

dukenv0307 added 4 commits December 13, 2023 15:30

merge main

74f802b

fix lint

ce804f4

Merge branch 'main' into fix/32256

513694f

merge main

d0eed0e

hoangzinh reviewed Dec 19, 2023

View reviewed changes

dukenv0307 added 2 commits December 20, 2023 13:26

Merge branch 'main' into fix/32256

4b74506

revert change

5dedcd5

hoangzinh approved these changes Dec 20, 2023

View reviewed changes

melvin-bot bot requested a review from jasperhuangg December 20, 2023 16:20

jasperhuangg requested changes Dec 20, 2023

View reviewed changes

dukenv0307 added 6 commits December 21, 2023 10:40

remove unuse variable

f3a1cf4

Merge branch 'main' into fix/32256

c7bc1bc

fix perf test

31a70eb

fix linnt

bf6a2af

test perf test

96b1a0b

fix perf test

f2dae80

fix linnt

b90ee2e

jasperhuangg approved these changes Dec 22, 2023

View reviewed changes

jasperhuangg merged commit 760c67c into Expensify:main Dec 22, 2023
14 of 15 checks passed

github-actions bot mentioned this pull request Dec 22, 2023

Deploy Checklist: New Expensify 2023-12-22 #33480

Closed

32 tasks

rlinoz mentioned this pull request Dec 22, 2023

[HOLD for payment 2024-01-25] [HOLD for payment 2024-01-03] Expense - Expense preview with a manual and ongoing scan does not show "x request, y scanning" #33512

Closed

6 tasks

melvin-bot bot mentioned this pull request Dec 26, 2023

[HOLD for payment 2024-01-02] [$500] mWeb - Expense - Red dot in preview does not disappear after filling in Amount and Merchant manually #32256

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Subscribe transactions in report preview #32469

Subscribe transactions in report preview #32469

dukenv0307 commented Dec 5, 2023 •

edited

Loading

melvin-bot bot commented Dec 5, 2023

hoangzinh Dec 5, 2023

dukenv0307 Dec 6, 2023

hoangzinh Dec 6, 2023

dukenv0307 Dec 7, 2023

hoangzinh Dec 7, 2023

dukenv0307 Dec 8, 2023 •

edited

Loading

hoangzinh Dec 11, 2023

dukenv0307 Dec 12, 2023

hoangzinh Dec 17, 2023

dukenv0307 Dec 19, 2023

hoangzinh Dec 11, 2023

dukenv0307 Dec 12, 2023

hoangzinh Dec 12, 2023

dukenv0307 Dec 13, 2023 •

edited

Loading

hoangzinh Dec 13, 2023

dukenv0307 Dec 15, 2023

hoangzinh Dec 19, 2023

dukenv0307 Dec 20, 2023

hoangzinh commented Dec 20, 2023 •

edited

Loading

jasperhuangg Dec 20, 2023

jasperhuangg Dec 20, 2023

dukenv0307 Dec 21, 2023

OSBotify commented Dec 26, 2023

	function getAllReportTransactions(reportID?: string): Transaction[] {
	// `reportID` from the `/CreateDistanceRequest` endpoint return's number instead of string for created `transaction`.
	// For reference, https://github.com/Expensify/App/pull/26536#issuecomment-1703573277.
	// We will update this in a follow-up Issue. According to this comment: https://github.com/Expensify/App/pull/26536#issuecomment-1703591019.
	const transactions: Transaction[] = Object.values(allTransactions ?? {}).filter((transaction): transaction is Transaction => transaction !== null);
	return transactions.filter((transaction) => `${transaction.reportID}` === `${reportID}`);
	}

Subscribe transactions in report preview #32469

Subscribe transactions in report preview #32469

Conversation

dukenv0307 commented Dec 5, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Dec 5, 2023

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

Choose a reason for hiding this comment

dukenv0307 Dec 8, 2023 • edited Loading

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

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

dukenv0307 Dec 13, 2023 • edited Loading

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

Choose a reason for hiding this comment

hoangzinh commented Dec 20, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

OSBotify commented Dec 26, 2023

dukenv0307 commented Dec 5, 2023 •

edited

Loading

dukenv0307 Dec 8, 2023 •

edited

Loading

dukenv0307 Dec 13, 2023 •

edited

Loading

hoangzinh commented Dec 20, 2023 •

edited

Loading