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: IOU-Error message remains on IOU report even same error message is dismissed from 1:1 #37875

Merged
merged 15 commits into from
Mar 25, 2024

Conversation

tienifr
Copy link
Contributor

@tienifr tienifr commented Mar 7, 2024

Details

Fixed Issues

$ #34189
PROPOSAL: #34189 (comment)

Tests

Flow 1:

  1. Log in with separate accounts in the main testing device and a secondary device
  2. In the main testing device create an IOU with a user
  3. Disable the internet connection in the main testing device
  4. In the main testing device (while offline) cancel the IOU
  5. In the secondary device (online) mark the IOU as paid with the option "Settled up elsewhere"
  6. Enable the internet connection in the main testing device
  7. Verify a red dot appears on the chat in LHN
  8. Tap the X from the conversation or IOU report
  9. Go to IOU report or conversation
  10. Verify that the X error is not appear into both reports

Flow 2:

  1. On the main device, create a request
  2. On the second device, pay the above request
  3. On the main device, create another request
  4. Then we see a error in the main chat and IOU chat
  5. Dismiss error in main chat or IOU chat
  6. Verify that the X error is not appear into both reports
  • Verify that no errors appear in the JS console

Offline tests

Same as above

QA Steps

Flow 1:

  1. Log in with separate accounts in the main testing device and a secondary device
  2. In the main testing device create an IOU with a user
  3. Disable the internet connection in the main testing device
  4. In the main testing device (while offline) cancel the IOU
  5. In the secondary device (online) mark the IOU as paid with the option "Settled up elsewhere"
  6. Enable the internet connection in the main testing device
  7. Verify a red dot appears on the chat in LHN
  8. Tap the X from the conversation or IOU report
  9. Go to IOU report or conversation
  10. Verify that the X error is not appear into both reports

Flow 2:

  1. On the main device, create a request
  2. On the second device, pay the above request
  3. On the main device, create another request
  4. Then we see a error in the main chat and IOU chat
  5. Dismiss error in main chat or IOU chat
  6. Verify that the X error is not appear into both reports
  • 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 form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label 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-03-07.at.17.12.49.mov
Screen.Recording.2024-03-07.at.17.13.56.mp4
Android: mWeb Chrome
Screen.Recording.2024-03-07.at.17.08.48.mov
Screen.Recording.2024-03-07.at.17.09.50.mov
iOS: Native
Screen.Recording.2024-03-07.at.17.27.48.mov
Screen.Recording.2024-03-07.at.17.28.36.mp4
iOS: mWeb Safari
Screen.Recording.2024-03-07.at.16.59.54.mov
Screen.Recording.2024-03-07.at.17.01.32.mov
MacOS: Chrome / Safari
Screen.Recording.2024-01-22.at.18.00.00.mov
MacOS: Desktop
Screen.Recording.2024-03-07.at.16.35.25.mp4
Screen.Recording.2024-03-07.at.16.33.26.mp4

@tienifr tienifr marked this pull request as ready for review March 7, 2024 09:49
@tienifr tienifr requested a review from a team as a code owner March 7, 2024 09:49
@melvin-bot melvin-bot bot requested review from DylanDylann and removed request for a team March 7, 2024 09:49
Copy link

melvin-bot bot commented Mar 7, 2024

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

@tienifr
Copy link
Contributor Author

tienifr commented Mar 11, 2024

@DylanDylann Can you help review my PR when you have a chance? Thanks

}
}

export {clearReportActionErrors, clearAllRelatedReportActionErrors};
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
export {clearReportActionErrors, clearAllRelatedReportActionErrors};
export {clearAllRelatedReportActionErrors};

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@DylanDylann Should we remove this function? We still use it in other places such as IOUTest.js

Copy link
Contributor

Choose a reason for hiding this comment

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

whoops, Yeah let's keep it exported

Copy link
Contributor

Choose a reason for hiding this comment

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

If it's only used in a test, can we update the test to use the next function?

@DylanDylann
Copy link
Contributor

DylanDylann commented Mar 11, 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 form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label 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
Screen.Recording.2024-03-20.at.12.03.55.mov
Android: mWeb Chrome
m.mp4
iOS: Native
Screen.Recording.2024-03-20.at.11.42.30.mp4
iOS: mWeb Safari
Screen.Recording.2024-03-20.at.11.39.45.mov
MacOS: Chrome / Safari
Screen.Recording.2024-03-20.at.11.34.40.mov
Screen.Recording.2024-03-20.at.11.35.58.mov
MacOS: Desktop
Screen.Recording.2024-03-20.at.11.41.23.mov

@DylanDylann
Copy link
Contributor

Still testing

@DylanDylann
Copy link
Contributor

@tienifr Your change looks good. Please help to merge the main then I can make a final testing

@@ -33,14 +35,55 @@ function clearReportActionErrors(reportID: string, reportAction: ReportAction) {
return;
}

if (keys) {
Copy link
Contributor

Choose a reason for hiding this comment

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

This is to handle cases with multiple errors in the same report action, right?

It may be a good improvement but It is not mentioned in the issue. Why do you think It is our expectation? Do you confirm with the design team or any internal engineer about that?

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 is to handle cases with multiple errors in the same report action, right?

Yes

Why do you think It is our expectation?

When users click x button, we'll clear all errors of that action, so the related action can share some same errors and we need to clear all of them. I believe it's the expectation in the OP

Copy link
Contributor

Choose a reason for hiding this comment

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

I agree that's the expectation

const parentReportAction = ReportActionUtils.getReportAction(report.parentReportID, report.parentReportActionID);
const parentErrorKeys = Object.keys(parentReportAction?.errors ?? {}).filter((err) => errorKeys.includes(err));

clearAllRelatedReportActionErrors(report.parentReportID, parentReportAction, 'child', parentErrorKeys);
Copy link
Contributor

Choose a reason for hiding this comment

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

Please point out 1 case where we need to call clearAllRelatedReportActionErrors instead of clearReportActionErrors.
The current logic is fine but I am not sure if we need it or not

Copy link
Contributor Author

Choose a reason for hiding this comment

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

const childActions = ReportActionUtils.getAllReportActions(reportAction.childReportID);
Object.values(childActions).forEach((action) => {
const childErrorKeys = Object.keys(action.errors ?? {}).filter((err) => errorKeys.includes(err));
clearAllRelatedReportActionErrors(reportAction.childReportID ?? '', action, 'parent', childErrorKeys);
Copy link
Contributor

@DylanDylann DylanDylann Mar 18, 2024

Choose a reason for hiding this comment

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

Please point out 1 case where we need to call clearAllRelatedReportActionErrors instead of clearReportActionErrors.
The current logic is fine but I am not sure if we need it or not

@tienifr For this point, I mean that in here

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Well, we need to use clearAllRelatedReportActionError here since we need to clear the errors of the grandchildren/grandparent report actions. Currently we do not have any such cases but in the future there may be. clearAllRelatedReportActionErrors is more general than clearReportActionErrors so I believe it's better

Copy link
Contributor

@DylanDylann DylanDylann 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 amyevans March 20, 2024 04:52
Copy link
Contributor

@amyevans amyevans left a comment

Choose a reason for hiding this comment

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

There's a conflict to fix as well!

src/libs/actions/ReportActions.ts Outdated Show resolved Hide resolved
}
}

export {clearReportActionErrors, clearAllRelatedReportActionErrors};
Copy link
Contributor

Choose a reason for hiding this comment

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

If it's only used in a test, can we update the test to use the next function?

@@ -33,14 +35,55 @@ function clearReportActionErrors(reportID: string, reportAction: ReportAction) {
return;
}

if (keys) {
Copy link
Contributor

Choose a reason for hiding this comment

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

I agree that's the expectation

@DylanDylann
Copy link
Contributor

@tienifr Should we add more tests for the new function?

cc @amyevans

@amyevans
Copy link
Contributor

Yes, anytime we can reasonably write a test we should.

Also the Reassure performance tests are failing, although merging main should clear that up I believe.

@tienifr
Copy link
Contributor Author

tienifr commented Mar 22, 2024

@DylanDylann Added tests

@tienifr
Copy link
Contributor Author

tienifr commented Mar 25, 2024

@DylanDylann Added tests

@DylanDylann
Copy link
Contributor

Looks good. @amyevans All yours

Copy link
Contributor

@amyevans amyevans left a comment

Choose a reason for hiding this comment

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

Thanks!

@amyevans amyevans merged commit b3baa68 into Expensify:main Mar 25, 2024
15 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.

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