Skip to content
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

Get correct transaction data in ReportActionItem #39940

Merged
merged 8 commits into from
Apr 22, 2024

Conversation

nkdengineer
Copy link
Contributor

Details

Get correct transaction data in ReportActionItem

Fixed Issues

$ #39824
PROPOSAL: #39824 (comment)

Tests

  1. Go to a DM that doesn't have unsettled IOU
  2. Create a money request
  3. Open the combine report
  4. Verify that only fields of transaction thread appears at the top of the page
  • Verify that no errors appear in the JS console

Offline tests

Same as above

QA Steps

  1. Go to a DM that doesn't have unsettled IOU
  2. Create a money request
  3. Open the combine report
  4. Verify that only fields of transaction thread appears at the top of the page
  • 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 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.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 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.

Screenshots/Videos

Android: Native
Screen.Recording.2024-04-09.at.20.41.18.mov
Android: mWeb Chrome
Screen.Recording.2024-04-09.at.20.39.54.mov
iOS: Native
Screen.Recording.2024-04-09.at.20.42.04.mov
iOS: mWeb Safari
Screen.Recording.2024-04-09.at.20.39.01.mov
MacOS: Chrome / Safari
Screen.Recording.2024-04-09.at.20.36.51.mov
MacOS: Desktop
Screen.Recording.2024-04-09.at.20.43.10.mov

@nkdengineer nkdengineer marked this pull request as ready for review April 9, 2024 13:48
@nkdengineer nkdengineer requested a review from a team as a code owner April 9, 2024 13:48
@melvin-bot melvin-bot bot requested review from ishpaul777 and removed request for a team April 9, 2024 13:48
Copy link

melvin-bot bot commented Apr 9, 2024

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

Comment on lines +947 to +950
key: ({parentReportActionForTransactionThread}) => {
const transactionID = (parentReportActionForTransactionThread as OnyxTypes.OriginalMessageIOU)?.originalMessage.IOUTransactionID
? (parentReportActionForTransactionThread as OnyxTypes.OriginalMessageIOU).originalMessage.IOUTransactionID
: 0;
Copy link
Contributor

Choose a reason for hiding this comment

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

have you tried this i found that parentReportActionForTransactionThread may or may not have the originalMessage.IOUTransactionID so thats not reliable working solution

key: ({transactionThreadReport, report}) => {
            const allReportActions = ReportActionsUtils.getAllReportActions(report.reportID);
            const parentReportActionID = isEmptyObject(transactionThreadReport) ? '0' : transactionThreadReport.parentReportActionID;
            const action = allReportActions[parentReportActionID ?? '0'];
            const transactionID = (action as OnyxTypes.OriginalMessageIOU)?.originalMessage.IOUTransactionID ? (action as OnyxTypes.OriginalMessageIOU).originalMessage.IOUTransactionID : 0;
            return `${ONYXKEYS.COLLECTION.TRANSACTION}${transactionID}`;
        },

@ishpaul777
Copy link
Contributor

@nkdengineer gentle bump ⬆️

@Julesssss
Copy link
Contributor

Hi @nkdengineer, please take a look at @ishpaul777's comment when you have a moment

@nkdengineer
Copy link
Contributor Author

checking this now.

const moneyRequestAction = allReportActions.find((action) => {
const actionType = (action as OnyxTypes.OriginalMessageIOU).originalMessage?.type ?? '';
return actionType === CONST.IOU.REPORT_ACTION_TYPE.CREATE || actionType === CONST.IOU.REPORT_ACTION_TYPE.TRACK || ReportActionsUtils.isSentMoneyReportAction(action);
});
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@ishpaul777 The reason because the filter here was wrong. Before it was !ReportActionsUtils.isSentMoneyReportAction(action);. Update this condition correctly, please help to check again.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@ishpaul777 For combine report, the only moneyRequestAction is the parentAction of transaction thread report. The check return actionType === CONST.IOU.REPORT_ACTION_TYPE.CREATE || actionType === CONST.IOU.REPORT_ACTION_TYPE.TRACK || ReportActionsUtils.isSentMoneyReportAction(action); is used to find that.

It this the negation of the check that we used to filter out this action type below. We also can use the filter action.reportActionID === transsactionThreadReport.parentReportActionID here the result is the same.

I don't like the solution to use ReportActionsUtils.getAllReportActions(report.reportID) because we don't subscribe allReportActions from Onyx in ReportActionItem.

Copy link
Contributor

Choose a reason for hiding this comment

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

The check return actionType === CONST.IOU.REPORT_ACTION_TYPE.CREATE || actionType === CONST.IOU.REPORT_ACTION_TYPE.TRACK || ReportActionsUtils.isSentMoneyReportAction(action); is used to find that.

this doesn't seem true, as you see in video reportActionID is different than passed as prop, also the issue is still reproducible

Screen.Recording.2024-04-10.at.12.40.09.AM-1.mov

we don't subscribe allReportActions from Onyx in ReportActionItem.

this is a valid concern In this case we should subscribe the reportactions in ReportActionItem using the same pattern we follow in https://github.com/Expensify/App/blob/59ebbc8956cb78a22d7b745b9791ee46c7bf2965/src/components/ReportActionItem/MoneyRequestView.tsx

withOnyx<MoneyRequestViewProps, MoneyRequestViewTransactionOnyxProps>({
transaction: {
key: ({report, parentReportActions}) => {
const parentReportAction = parentReportActions?.[report.parentReportActionID ?? ''];
const originalMessage = parentReportAction?.actionName === CONST.REPORT.ACTIONS.TYPE.IOU ? parentReportAction.originalMessage : undefined;
const transactionID = originalMessage?.IOUTransactionID ?? 0;
return `${ONYXKEYS.COLLECTION.TRANSACTION}${transactionID}`;
},

Here's a Branch for reference code

main...ishpaul777:App:fix/pull/39940

We also can use the filter action.reportActionID === transsactionThreadReport.parentReportActionID

This can also work but i prefer we avoid drilling prop when we can

Copy link
Contributor Author

Choose a reason for hiding this comment

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

this doesn't seem true, as you see in video reportActionID is different than passed as prop, also the issue is still reproducible

@ishpaul777 Can you share the full step for this case? I can't reproduce it in this PR now.

This can also work but i prefer we avoid drilling prop when we can

we already have allReportActions in ReportActionsView so I think we should get on this and because we can have many ReportActionItem, subscribing again allReportActions in each ReportActionItem isn't good for perf.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@ishpaul777 Any update here.

Copy link
Contributor

@ishpaul777 ishpaul777 Apr 11, 2024

Choose a reason for hiding this comment

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

i think the changes here are stale right now becuase issue is no longer reproducable, though the reproduction steps was same as in the PR description

Copy link
Contributor

Choose a reason for hiding this comment

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

okay i gave this a thought lets move with passing the reportaction filtered with action.reportActionID === transsactionThreadReport.parentReportActionID as prop but can you please first share a screen recording of the bug that exists now

Copy link
Contributor Author

Choose a reason for hiding this comment

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

can you please first share a screen recording of the bug that exists now

As we can see in this condition, we will show the total in combine report if the transactionCurrency is different from the currency of the workspace.

{transactionCurrency !== report.currency && (

But on staging, we can see in both case the total always appears. The problem is what I mentioned in my proposal, transaction is always undefined in ReportActionItem.

cc @pecanoro

Screenshot 2024-04-16 at 17 25 52 Screenshot 2024-04-16 at 17 24 41

okay i gave this a thought lets move with passing the reportaction filtered with action.reportActionID === transsactionThreadReport.parentReportActionID

I updated it.

@nkdengineer
Copy link
Contributor Author

@ishpaul777 Please help to check again.

@ishpaul777
Copy link
Contributor

ishpaul777 commented Apr 9, 2024

i am still not covinced and neither this works for me even now, i have provided a working solution with minimal changes. I think we both can agree the RC here is reportActions passed as prop does not include transactionThreadReport.parentReportActionID, in this case we just use the allReportActions for that report and pick the transactionThreadReport.parentReportActionID from that.

key: ({transactionThreadReport, report}) => {
            const allReportActions = ReportActionsUtils.getAllReportActions(report.reportID);
            const parentReportActionID = isEmptyObject(transactionThreadReport) ? '0' : transactionThreadReport.parentReportActionID;
            const action = allReportActions[parentReportActionID ?? '0'];
            const transactionID = (action as OnyxTypes.OriginalMessageIOU)?.originalMessage.IOUTransactionID ? (action as OnyxTypes.OriginalMessageIOU).originalMessage.IOUTransactionID : 0;
            return `${ONYXKEYS.COLLECTION.TRANSACTION}${transactionID}`;
        },

@nkdengineer

@pecanoro
Copy link
Contributor

pecanoro commented Apr 9, 2024

I am going to revert the original PR and we can work on this slowly to find the best solution

@mountiny
Copy link
Contributor

mountiny commented Apr 9, 2024

I am going to revert the original PR and we can work on this slowly to find the best solution

I agree, this solution does not seem like something we would like to CP

@mountiny
Copy link
Contributor

I think this PR can be closed now

@pecanoro
Copy link
Contributor

@mountiny We still a bug with combined reports and the pending action, the total disappears as soon as the action stops being pending (I think)

@ishpaul777
Copy link
Contributor

I believe this PR was to solve the view for transaction thread right which is solved with the revert, was there any other issue 🤔

@nkdengineer
Copy link
Contributor Author

@ishpaul777 The other issue is transaction in ReportActionItem is always undefined so this condition is always false and then the total will display even the transaction has the same currency with the IOU report.

{transactionCurrency !== report.currency && (

@pecanoro
Copy link
Contributor

Yeah, I originally posted here to fix both. It is probably due to some optimistic data because after a bit, it gets updated when it gets the info from the back-end.

image

@ishpaul777
Copy link
Contributor

Reviewing this, @nkdengineer Can you please merge main

@ishpaul777
Copy link
Contributor

ishpaul777 commented Apr 19, 2024

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
WhatsApp.Video.2024-04-20.at.3.27.24.AM.mp4
Android: mWeb Chrome
VIDEO-2024-04-20-03-34-43.mp4
iOS: Native Screenshot 2024-04-20 at 3 18 35 AM
iOS: mWeb Safari
Screen.Recording.2024-04-20.at.3.22.20.AM.mov
MacOS: Chrome / Safari
Screen.Recording.2024-04-20.at.3.21.23.AM.mov
MacOS: Desktop
Screen.Recording.2024-04-20.at.3.49.19.AM.mov

Copy link
Contributor

@ishpaul777 ishpaul777 left a comment

Choose a reason for hiding this comment

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

LGTM!

@melvin-bot melvin-bot bot requested a review from pecanoro April 19, 2024 22:22
@nkdengineer
Copy link
Contributor Author

@pecanoro Please help to review the PR when you have a chance.

@pecanoro
Copy link
Contributor

It seems to be working! Though I tested it during a back-end deploy, so not sure if it affected anything since it made everything slower 😄

@pecanoro pecanoro merged commit 0cf0e9b into Expensify:main Apr 22, 2024
15 checks passed
@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.64-6 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 web 🕸 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