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

fix RBR transaction thread is disappearing from the LHN when navigating to another chat v2 #43502

Merged
merged 14 commits into from
Jun 28, 2024

Conversation

tienifr
Copy link
Contributor

@tienifr tienifr commented Jun 11, 2024

Details

Fixed Issues

$ #36778
$ #43238
PROPOSAL: #36778 (comment)

Tests

Test case 1: Make sure this PR fix the bug #36778:

  1. Have an expense that you are the submitter on, which has violations
  2. Go to the transaction thread
  3. Notice that you see violations on the expense and that the RBR is shown in the LHN
  4. Navigate to a different chat
  5. Verify the RBR chat stays "pinned" in the LHN as long as the RBR is present

Test case 2: Make sure this PR fix the bug #43238:

  1. Open app
  2. Go to workspace chat that has no unsettled expense.
  3. Create an expense that will induce RBR (make category in expense a requirement and submit an expense without category).
  4. Click on the report with RBR on LHN.
  5. Click on the header subtitle.
  6. Verify app will return to the workspace main chat.

Test case 3: Make sure this PR fix the bug #43252:

Precondition:

  • User A and B have no chatted before.
  • Both accounts must be new.
  1. Open app
  2. [User A] Go offline
  3. [User A] Submit an expense to User B
  4. [User B] Submit an expense with the same amount to User A
  5. [User A] Go online
  6. Verify user A will not have two same transaction threads with RBR on LHN.
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

  • 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-06-12.at.00.47.01.mov
Android: mWeb Chrome
Screen.Recording.2024-06-12.at.00.48.52.mov
iOS: Native
Screen.Recording.2024-06-12.at.00.56.33.mov
iOS: mWeb Safari
Screen.Recording.2024-06-12.at.00.45.51.mov
MacOS: Chrome / Safari
output.mp4
Screen.Recording.2024-06-12.at.00.34.46.mov
MacOS: Desktop
Screen.Recording.2024-06-12.at.00.42.15.mov

@tienifr tienifr requested a review from a team as a code owner June 11, 2024 17:21
@melvin-bot melvin-bot bot removed the request for review from a team June 11, 2024 17:21
Copy link

melvin-bot bot commented Jun 11, 2024

@jjcoffee 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 melvin-bot bot requested a review from jjcoffee June 11, 2024 17:21
@@ -1422,7 +1422,7 @@ function isOneTransactionReport(reportID: string): boolean {
function isOneTransactionThread(reportID: string, parentReportID: string): boolean {
const parentReportActions = allReportActions?.[`${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${parentReportID}`] ?? ([] as ReportAction[]);
const transactionThreadReportID = ReportActionsUtils.getOneTransactionThreadReportID(parentReportID, parentReportActions);
return reportID === transactionThreadReportID;
return reportID?.toString() === transactionThreadReportID?.toString();
Copy link
Contributor

Choose a reason for hiding this comment

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

Shouldn't both of these already be strings?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I checked and found out that one is a number, and the other one is a string. This bug is mentioned here

Copy link
Contributor

Choose a reason for hiding this comment

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

Hmm I've asked for clarification here on what's best to do. Ideally this would be fixed in the BE first, but of course that can take some time.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@jjcoffee So should we revert this fix return reportID?.toString() === transactionThreadReportID?.toString() from FE, then wait until BE fixes it?

Copy link
Contributor

Choose a reason for hiding this comment

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

@tienifr Could you respond to this comment?

Copy link
Contributor

Choose a reason for hiding this comment

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

I put up a PR to fix the type on the BE. We should be able to remove the cast to string once that's merged/deployed

@jjcoffee
Copy link
Contributor

jjcoffee commented Jun 12, 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
android-app-2024-06-24_12.34.51.mp4
Android: mWeb Chrome
android-chrome-2024-06-24_11.52.36.mp4
iOS: Native
ios-app-2024-06-24_13.32.17.mp4
iOS: mWeb Safari
ios-safari-2024-06-24_13.20.52.mp4
MacOS: Chrome / Safari
desktop-chrome-2024-06-12_12.29.07.mp4
MacOS: Desktop
desktop-app-2024-06-24_11.14.38.mp4
desktop-app-2024-06-24_11.17.07.mp4

@jjcoffee

This comment was marked as resolved.

@tienifr
Copy link
Contributor Author

tienifr commented Jun 17, 2024

@jjcoffee

  • I just merged main.

If there's only one expense on a report that has a violation (i.e. if we fulfil the criteria Go to workspace chat that has no unsettled expense.), I'm not seeing it in the LHN, only when there's an additional expense.

  • In one transaction expense, we do not display the transaction based on this comment, so I think the video you mentioned above is expected.

@jjcoffee
Copy link
Contributor

In one transaction expense, we do not display the transaction based on this comment, so I think the video you mentioned above is expected.

Hmm I would expect there to be some RBR in the LHN (just not multiple). Are you saying that there's no way to resolve this without reintroducing the issue with the header not linking straight to the workspace?

@tienifr
Copy link
Contributor Author

tienifr commented Jun 19, 2024

I am working on it. Will update in a few hours.

Copy link
Contributor

@luacmartins luacmartins left a comment

Choose a reason for hiding this comment

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

Thanks @tienifr. Please let us know once the PR is ready for review again.

@tienifr
Copy link
Contributor Author

tienifr commented Jun 19, 2024

@jjcoffee PR is ready to review again. Now, we display RBR in the LHN in case of oneTransactionReport:

image

result.brickRoadIndicator = hasErrors || hasViolations ? CONST.BRICK_ROAD_INDICATOR_STATUS.ERROR : '';
const oneTransactionThreadReportID = ReportActionsUtils.getOneTransactionThreadReportID(report.reportID, reportActions);
Copy link
Contributor

Choose a reason for hiding this comment

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

I think we could do with an explanatory comment here.

Copy link
Contributor

Choose a reason for hiding this comment

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

+1

const shouldDisplayViolations = canUseViolations && ReportUtils.shouldDisplayTransactionThreadViolations(fullReport, transactionViolations, parentReportAction);

let shouldDisplayViolations = canUseViolations && ReportUtils.shouldDisplayTransactionThreadViolations(fullReport, transactionViolations, parentReportAction);
const oneTransactionThreadReportID = ReportActionsUtils.getOneTransactionThreadReportID(reportID, reportActions);
Copy link
Contributor

Choose a reason for hiding this comment

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

A comment here would be nice!

Copy link
Contributor

Choose a reason for hiding this comment

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

@tienifr Bump on this 🙏

@jjcoffee
Copy link
Contributor

Looks like there are BE issues so I don't think I'll be able to test this today, will try again tomorrow!

@luacmartins
Copy link
Contributor

Looks like there are BE issues so I don't think I'll be able to test this today, will try again tomorrow!

What issues did you have?

@jjcoffee
Copy link
Contributor

What issues did you have?

@luacmartins I couldn't login, the error referred to some database connectivity issues. Seems fine now!

@jjcoffee
Copy link
Contributor

@luacmartins I'm starting to wonder if we should fix the problem with one transaction reports in a separate issue, as the current behaviour on staging is that an RBR doesn't even show in the LHN for a one transaction report that has a violation.

image

@luacmartins
Copy link
Contributor

@jjcoffee Currently, we are hiding the expense report because it has notificationPreference: "hidden". Should we not hide the expense report in case of one transaction report, @luacmartins?

We have a backend PR to fix this when requesting money. So this should be solved soon.

@luacmartins
Copy link
Contributor

@luacmartins I'm starting to wonder if we should fix the problem with one transaction reports in a separate issue, as the current behaviour on staging is that an RBR doesn't even show in the LHN for a one transaction report that has a violation.

hmm this seems like a bug to me. We should show the GBR/RBR in the LHN if the user has to take an action, which from your screenshot it seems like they need to approve the report.

@tienifr
Copy link
Contributor Author

tienifr commented Jun 25, 2024

@luacmartins

We have a backend PR to fix this when requesting money. So this should be solved soon.

  • Should we hold the current PR until the backend is fixed?

I'm starting to wonder if we should fix the problem with one transaction reports in a separate issue

  • More about the @jjcoffee 's concern, with one transaction report:
  1. In staging: We do not display the RBR and always hide the one transaction report from the LHN
  2. In this PR: We plan to display the RBR in this decision and display the one transaction report in LHN based on this decision. But based on this comment, should we continue to make these changes in this PR?

@luacmartins
Copy link
Contributor

Should we hold the current PR until the backend is fixed?

Yea, maybe we should hold on the API PR and check the state of this bug after.

@luacmartins luacmartins changed the title fix RBR transaction thread is disappearing from the LHN when navigating to another chat v2 [HOLD Auth #11324] fix RBR transaction thread is disappearing from the LHN when navigating to another chat v2 Jun 25, 2024
@luacmartins
Copy link
Contributor

@tienifr @jjcoffee the API PR was deployed to prod. Could you please retest this?

@jjcoffee
Copy link
Contributor

jjcoffee commented Jun 27, 2024

@luacmartins Sure! I've retested and it looks like there's no RBR in the case of a violation on an expense report with a single transaction. In this case the expense report disappears from the LHN once you tap away from it. This is expected behaviour for the app's current state IMO (the same happens on staging) and would be out of scope for this PR to fix.

It works normally if there's an RBR displaying in the LHN, e.g. from a BE error in response to approving the expense.

desktop-chrome-2024-06-27_13.33.33.mp4

@luacmartins
Copy link
Contributor

@jjcoffee I agree that the behavior shown in your video is expected. In that case, is there anything left to do here? Or should we close this PR?

@tienifr
Copy link
Contributor Author

tienifr commented Jun 27, 2024

@luacmartins

I agree that the behavior shown in your video is expected. In that case, is there anything left to do here? Or should we close this PR?

  • I agree that this is the expected behavior. But we still need to fix the case it is not one transaction report.

@tienifr
Copy link
Contributor Author

tienifr commented Jun 27, 2024

  • So my plan is to revert this commit which was implemented to match this comment, then resolve conflict, and then PR can be reviewed again.

@luacmartins
Copy link
Contributor

Ah you're right. Plan sounds good to me, let's do it!

@tienifr
Copy link
Contributor Author

tienifr commented Jun 27, 2024

@jjcoffee I updated PR. Tested and it works properly

@tienifr
Copy link
Contributor Author

tienifr commented Jun 27, 2024

@luacmartins Should we remove "HOLD Auth #11324" in PR's title?

@luacmartins luacmartins changed the title [HOLD Auth #11324] fix RBR transaction thread is disappearing from the LHN when navigating to another chat v2 fix RBR transaction thread is disappearing from the LHN when navigating to another chat v2 Jun 27, 2024
@luacmartins
Copy link
Contributor

Removed the hold. Ready for review!

Copy link
Contributor

@jjcoffee jjcoffee left a comment

Choose a reason for hiding this comment

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

Retested and it works well!

@luacmartins luacmartins merged commit defc4c9 into Expensify:main Jun 28, 2024
16 checks passed
@OSBotify
Copy link
Contributor

✋ 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
Copy link
Contributor

OSBotify commented Jul 3, 2024

🚀 Deployed to staging by https://github.com/luacmartins in version: 9.0.4-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Jul 4, 2024

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

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
Copy link
Contributor

🚀 Deployed to production by https://github.com/Julesssss in version: 9.0.5-13 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/thienlnam in version: 9.0.6-8 🚀

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.

4 participants