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

add failure message when create a task error #26848

Conversation

namhihi237
Copy link
Contributor

@namhihi237 namhihi237 commented Sep 6, 2023

Details

Fixed Issues

$ #22608
PROPOSAL: #22608 (comment)

Tests

  1. Login 2 accounts with 2 browsers
  2. User A create a WS and invite user B
  3. Both users go to #announce room
  4. User B force offline
  5. User A go room setting => set Admins only
  6. User B Create a task
  7. User B turns on the network
  8. User B click LHN and go to #announce room
  9. Verify that the task creation failed and show an error message
  • Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

The same test

  • 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 / Chrome
    • iOS / native
    • iOS / 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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I 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 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
    • If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
    • 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(themeColors.componentBG))
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
  • I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web
web.mov
Mobile Web - Chrome
mweb.mov
Mobile Web - Safari
safari.mov
Desktop
desktop.mov
iOS
ios.mov
Android
and.mov

@namhihi237 namhihi237 marked this pull request as ready for review September 6, 2023 08:08
@namhihi237 namhihi237 requested a review from a team as a code owner September 6, 2023 08:08
@melvin-bot melvin-bot bot requested review from parasharrajat and removed request for a team September 6, 2023 08:08
@melvin-bot
Copy link

melvin-bot bot commented Sep 6, 2023

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

@namhihi237
Copy link
Contributor Author

namhihi237 commented Sep 6, 2023

@parasharrajat @thienlnam PR already for review.

And while I reproduce the steps, it gives an error that causes the app to crash here

key: ({fullReport}) => `${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${fullReport.parentReportID}`,

The error is that the parentReportID of undefined cannot be read

I think it was introduced by PR

I think this bug is outside the scope of this issue. What should we do next? If we don't fix this bug, it won't be possible to test this issue.

Now, I don't know what the root cause is here but we can work around

  key: ({fullReport}) => `${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${lodashGet(fullReport, "parentReportID")}`,

What do you think about this?

@namhihi237
Copy link
Contributor Author

@parasharrajat I see you are also following and reviewing PR so I think you can understand more about context

@parasharrajat
Copy link
Member

parasharrajat commented Sep 6, 2023

As a crash is happening, it means that fullReport is undefined which should not be the case.

First, we should see why fullReport is getting undefined. It is getting deleted from Onyx somewhere.

  1. Is the Backend removing this in the same operation?
  2. Are we deleting it in the failure response?

If it is later, we should add an RBR error for the task report instead of deleting it. When the user clears the error on the Task thread or Task action, then this chat should be deleted.


Also, did you check that the RBR error is also shown on Task chat as well as the task action? In your web video, I can see that an error is shown in task action. Can you check the same for the task report/thread?

@namhihi237
Copy link
Contributor Author

@parasharrajat Currently after we create task after going back online. The API will call 2 APIs create task and open report (thread task), so when calling api open report backend response is like that

        {
            "onyxMethod": "set",
            "key": "report_4197555697560136",
            "value": null
        }

This mean the task report also delete

@parasharrajat
Copy link
Member

@namhihi237 Can you check what happens for the new chat scenario? Try to create a new chat with an unreachable email or phone number.

It is hard to say what used to happen a few days back as I don't have access to the backend. Is Backend deleting task reports from the start or is it a recent change?

IMO, we should show an RBR error for these reports same as the new chat case.

Let's say we don't want to change backend, then what are the alternative to fix the crash.

@@ -1534,6 +1534,7 @@ export default {
markAsDone: 'Marcar como completada',
markAsIncomplete: 'Marcar como incompleta',
assigneeError: 'Hubo un error al asignar esta tarea, inténtalo con otro usuario.',
genericCreateTaskFailureMessage: 'Error inesperado al crear la tarea, por favor, inténtalo más tarde.',
Copy link
Member

Choose a reason for hiding this comment

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

Was this confirmed?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Not yet, still waiting for copywiter.

@namhihi237
Copy link
Contributor Author

Updated based on comment

src/libs/actions/Task.js Show resolved Hide resolved
src/libs/actions/ReportActions.ts Outdated Show resolved Hide resolved
src/libs/actions/Task.js Show resolved Hide resolved
src/components/ReportActionItem/TaskView.js Show resolved Hide resolved
@namhihi237
Copy link
Contributor Author

@parasharrajat I updated

Video test

Screen.Recording.2023-10-26.at.17.08.25.mov

@@ -24,6 +24,10 @@ function clearReportActionErrors(reportID: string, reportAction: ReportAction) {
Onyx.set(`${ONYXKEYS.COLLECTION.TRANSACTION}${linkedTransactionID}`, null);
}

// Delete the failed task report too
Copy link
Member

Choose a reason for hiding this comment

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

This is a generic function so I am trying to test it with other report actions. This might be applicable to money requests. But I am not sure how to get a failed money request error on action.

Any idea?

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 think you can flow steps:

  1. Click fab button
  2. Start chat with new user and send any message
  3. Click fab button
  4. Request money then select manual
  5. Input amount and next
  6. Input new account above and select
  7. Request

value: null,
value: {
errorFields: {
createChat: ErrorUtils.getMicroSecondOnyxError('task.genericCreateTaskFailureMessage'),
Copy link
Member

Choose a reason for hiding this comment

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

So I checked the backend returns error with CreateTask but I am not sure which flag should we use here. @thienlnam Can you help us with this? Should this be createChat or createTask?

Copy link
Member

Choose a reason for hiding this comment

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

Also, Can you please tell me how do we determine which key should be used here? It will help me understand this concept better.

Copy link
Contributor

Choose a reason for hiding this comment

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

Let's just use a new createTask key.

Can you please tell me how do we determine which key should be used here

We mostly just use the action that failed and key it as such. So in this scenario since there was an error creating the task we add the error key on createTask

Copy link
Member

Choose a reason for hiding this comment

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

@namhihi237 let's get that done please. This is the last change.

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 updated

@parasharrajat
Copy link
Member

Please merge main.

@parasharrajat
Copy link
Member

@namhihi237 Can you please update this #26848 (comment)?

@parasharrajat
Copy link
Member

parasharrajat commented Nov 1, 2023

@thienlnam Can you please confirm this https://github.com/Expensify/App/pull/26848/files#r1377234885 as well?

@namhihi237
Copy link
Contributor Author

@parasharrajat i updated yesterday please help to review

@parasharrajat
Copy link
Member

Bump @thienlnam

@parasharrajat
Copy link
Member

parasharrajat commented Nov 2, 2023

Screenshots

🔲 iOS / native

Screen.Recording.2023-11-02.at.4.13.52.PM.mov

🔲 iOS / Safari

Screen.Recording.2023-10-31.at.2.29.12.PM.mov

🔲 MacOS / Desktop

Screen.Recording.2023-10-31.at.2.20.15.PM.mov

🔲 MacOS / Chrome

Screen.Recording.2023-10-31.at.2.03.50.PM.mov

🔲 Android / Chrome

Screen.Recording.2023-10-31.at.2.46.15.PM.mov

🔲 Android / native

Copy link
Member

@parasharrajat parasharrajat 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 / Chrome
    • iOS / native
    • iOS / Safari
    • MacOS / Chrome / Safari
    • MacOS / Desktop
  • If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
  • I verified proper code patterns were followed (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
    • I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I verified that this PR follows the guidelines as stated in the Review Guidelines
  • I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
  • If a new component is created I verified that:
    • A similar component doesn't exist in the codebase
    • All props are defined accurately and each prop has a /** comment above it */
    • The file is named correctly
    • The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
    • The only data being stored in the state is data necessary for rendering and nothing else
    • For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
    • Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
    • All JSX used for rendering exists in the render method
    • The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.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 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.

🎀 👀 🎀 C+ reviewed

@melvin-bot melvin-bot bot requested a review from thienlnam November 2, 2023 10:47
Copy link
Contributor

@thienlnam thienlnam left a comment

Choose a reason for hiding this comment

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

Just one comment, thanks both for sticking with this

Comment on lines 29 to 31
if (reportAction.childReportID) {
Report.deleteReport(reportAction.childReportID);
}
Copy link
Contributor

Choose a reason for hiding this comment

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

Is the task listed under as the childReportID / it should be listed as the taskReportID the message as well. Can we use that so this doesn't create some unintended use cases for other future flows?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@thienlnam I updated

@namhihi237
Copy link
Contributor Author

Yeah thanks i am vacation i will back and update next Monday

Copy link
Member

@parasharrajat parasharrajat 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 thienlnam November 6, 2023 18:27
Copy link
Contributor

@thienlnam thienlnam left a comment

Choose a reason for hiding this comment

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

Awesome, thank you!

@thienlnam thienlnam merged commit 5df95a1 into Expensify:main Nov 7, 2023
15 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Nov 7, 2023

✋ 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 Nov 8, 2023

🚀 Deployed to staging by https://github.com/thienlnam in version: 1.3.96-6 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Nov 9, 2023

🚀 Deployed to production by https://github.com/puneetlath in version: 1.3.96-15 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/thienlnam in version: 1.3.98-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.98-5 🚀

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