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: delete money request if failed to create chat #44142

Merged

Conversation

dominictb
Copy link
Contributor

@dominictb dominictb commented Jun 21, 2024

Details

Fixed Issues

$ #42950
PROPOSAL: #42950 (comment)

Tests

  1. Log into NewDot
  2. Create a workspace if needed
  3. Go offline in the Network tab of dev tools, or using the force offline switch
  4. Create a money request (distance type) on that workspace
  5. Log into the same account, but in another device
  6. Go to your group workspaces (in the other device)
  7. Delete the workspace (in the other device)
  8. Go back to NewDot in the first device
  9. Verify the request fails to create
  10. Click on the request
  11. Verify there is an error message that says "Unexpected error submitting this expense. Please try again later...."
  12. Click the X to dismiss the error

Expected result

The failed request should disappear completely after the error is dismissed. The transaction report should be deleted and the request should be removed from the workspace chat. Everything needs to be cleaned up. The user can get navigated back the the archived workspace chat

  • Verify that no errors appear in the JS console

Offline tests

QA Steps

  1. Log into NewDot
  2. Create a workspace if needed
  3. Go offline in the Network tab of dev tools, or using the force offline switch
  4. Create a money request (distance type) on that workspace
  5. Log into the same account, but in another device
  6. Go to your group workspaces (in the other device)
  7. Delete the workspace (in the other device)
  8. Go back to NewDot in the first device
  9. Verify the request fails to create
  10. Click on the request
  11. Verify there is an error message that says "Unexpected error submitting this expense. Please try again later...."
  12. Click the X to dismiss the error

Expected result

The failed request should disappear completely after the error is dismissed. The transaction report should be deleted and the request should be removed from the workspace chat. Everything needs to be cleaned up. The user can get navigated back the the archived workspace chat

Expected result

The failed request should disappear completely after the error is dismissed. The transaction report should be deleted and the request should be removed from the workspace chat. Everything needs to be cleaned up. The user can get navigated back the the archived workspace chat

  • 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
compressed_android.webm.mp4
Android: mWeb Chrome
compressed_aweb.webm.mp4
iOS: Native
compressed_ios.mp4.mp4
iOS: mWeb Safari
compressed_iosweb.mp4.mp4
MacOS: Chrome / Safari
compressed_web.mov.mp4
MacOS: Desktop
compressed_web.mov.mp4

@dominictb dominictb marked this pull request as ready for review June 24, 2024 09:37
@dominictb dominictb requested a review from a team as a code owner June 24, 2024 09:37
@melvin-bot melvin-bot bot requested review from sobitneupane and removed request for a team June 24, 2024 09:37
Copy link

melvin-bot bot commented Jun 24, 2024

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

@@ -750,6 +750,7 @@ export default {
atLeastTwoDifferentWaypoints: 'Por favor, introduce al menos dos direcciones diferentes.',
splitExpenseMultipleParticipantsErrorMessage: 'Solo puedes dividir un gasto entre un único espacio de trabajo o con usuarios individuales. Por favor, actualiza tu selección.',
invalidMerchant: 'Por favor, introduce un comerciante correcto.',
workspaceNotAccessible: 'El espacio de trabajo ya no está accesible. Por favor, intente de nuevo en un espacio de trabajo diferente.',
Copy link
Contributor

@sobitneupane sobitneupane Jun 26, 2024

Choose a reason for hiding this comment

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

@dominictb We need to verify the Spanish translation of the error message.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

sent a message on Slack

src/languages/en.ts Outdated Show resolved Hide resolved
@dominictb
Copy link
Contributor Author

Copy link
Contributor

@sobitneupane sobitneupane left a comment

Choose a reason for hiding this comment

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

@dominictb Can you please retest to see if you are getting the expected output because I am not getting the expected output following the reproduction steps in the PR description.

Screenshot 2024-06-27 at 15 14 16

src/libs/Localize/index.ts Outdated Show resolved Hide resolved
src/libs/actions/IOU.ts Outdated Show resolved Hide resolved
@dominictb
Copy link
Contributor Author

#44142 (review)

@sobitneupane I have updated the test step (in order to reproduce the exact error message, you have to create distance request). However, the behavior alone can be reproduced with any types of money request, just that the error messages returned by the BE is different.

@sobitneupane
Copy link
Contributor

@dominictb Can you please test the case where there is already an existing request in the workspace. When we close the error message, we can still see the transaction with error in the transaction thread.

Screenshot 2024-07-03 at 14 23 45

@dominictb
Copy link
Contributor Author

@sobitneupane I'll get back to you about this shortly.

dominictb added 2 commits July 4, 2024 10:55
when deleting report action of IOU report in cleanUpMoneyRequest function

Signed-off-by: dominictb <[email protected]>
@dominictb
Copy link
Contributor Author

@sobitneupane fixed. Onyx filter out all undefined in merge data for updatedReportActions. Change it to null works as it will clean up the errors

@dominictb
Copy link
Contributor Author

Still waiting for review.

@sobitneupane
Copy link
Contributor

sobitneupane commented Jul 10, 2024

Sorry for the delay @dominictb

Some checks are still failing. Can you please handle that.

Copy link
Contributor

@sobitneupane sobitneupane left a comment

Choose a reason for hiding this comment

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

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.

@melvin-bot melvin-bot bot requested a review from neil-marcellini July 11, 2024 08:55
Copy link
Contributor

@neil-marcellini neil-marcellini left a comment

Choose a reason for hiding this comment

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

Great work on this! It's a tough one. I left a lot of small recommendations, and there's something I want to check on before we send this out. I'll post a link to that conversation soon.

src/components/ReportActionItem/MoneyRequestView.tsx Outdated Show resolved Hide resolved
src/libs/actions/IOU.ts Outdated Show resolved Hide resolved
src/libs/actions/IOU.ts Outdated Show resolved Hide resolved
src/libs/actions/IOU.ts Outdated Show resolved Hide resolved
src/libs/actions/IOU.ts Outdated Show resolved Hide resolved
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we put these in CONST.ts instead, and use constants for the keys and values? I think we wouldn't have to eslint disable then and it would fit with our existing code patterns a little better.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sure, but I'll wait for the team to decide on the swapForTranslation pattern before fixing this

src/libs/Localize/index.ts Outdated Show resolved Hide resolved
src/libs/Localize/index.ts Outdated Show resolved Hide resolved
Comment on lines 357 to 362
return Object.fromEntries(
Object.entries(combinedErrors).map(([key, value]) =>
// swap for translation for each error message
[key, swapForTranslation(value as string)],
),
);
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 kind of a new pattern, so I want to check with the team first to see if everyone is cool with it, as recommended by our checklist.

I don't really like that we're doing the swapping within the component. Ideally the swapping would be done when saving an Onyx update from the network or pusher. Let's pause this work until we hear what the team thinks. Sorry for the delay, but if we build this right it will be useful in the future instead of a headache.

Copy link
Contributor

Choose a reason for hiding this comment

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

The approval conversation is 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.

Sorry, do you mean we should pause this PR or I should revert all the swapForTranslation change in this PR (in case the team is indecisive for a long 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.

Ideally the swapping would be done when saving an Onyx update from the network or pusher

It's not easy to do that since usually the error message returned from the BE is in the BE onyxData, which we don't have much control.

Copy link
Contributor

Choose a reason for hiding this comment

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

@dominictb yeah, please revert the swapForTranslation changes. I think we'll just deal with the slightly strange non-translated error message.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

on it 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.

@neil-marcellini reverted

Copy link
Contributor

@neil-marcellini neil-marcellini left a comment

Choose a reason for hiding this comment

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

Looks good, thank you! You'll need to fix conflicts before we can merge and lets have @sobitneupane run through the tests once more to make sure it's still working well.

src/languages/en.ts Outdated Show resolved Hide resolved
src/languages/es.ts Outdated Show resolved Hide resolved
@sobitneupane
Copy link
Contributor

Changes look good and test well.

dominictb and others added 2 commits July 17, 2024 18:47
@dominictb
Copy link
Contributor Author

done!

@melvin-bot melvin-bot bot requested a review from neil-marcellini July 17, 2024 14:19
Copy link
Contributor

@neil-marcellini neil-marcellini left a comment

Choose a reason for hiding this comment

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

Thanks for catching the translations that we forgot to remove. Good to go!

@neil-marcellini neil-marcellini merged commit 0c8e2cc into Expensify:main Jul 17, 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.

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/neil-marcellini in version: 9.0.9-1 🚀

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

@OSBotify
Copy link
Contributor

🚀 Cherry-picked to staging by https://github.com/mountiny in version: 9.0.9-2 🚀

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/mountiny in version: 9.0.9-5 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/mountiny in version: 9.0.10-7 🚀

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

@@ -410,6 +410,14 @@ function MoneyRequestView({
if (!transaction?.transactionID) {
return;
}

const isCreateChatErrored = !!report?.errorFields?.createChat;
Copy link
Contributor

Choose a reason for hiding this comment

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

This caused a regression here, more details: #46662 (comment)

Comment on lines +416 to +417
const urlToNavigateBack = IOU.cleanUpMoneyRequest(transaction.transactionID, parentReportAction, true);
Navigation.goBack(urlToNavigateBack);
Copy link
Contributor

Choose a reason for hiding this comment

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

FYI, this caused the following issue: #50022
Details can be found in this proposal: #50022 (comment)
PR: #51940

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