Migrate the next steps to client side

[rezkiy37]

Details

Generates an optimistic nextStep based on a current report status and other properties. Includes unit-tests that cover 100% of a main function - buildNextStep.

Fixed Issues

$ https://github.com/Expensify/App/issues/28771 PROPOSAL: N/A

Tests

Note: we migrate next step prediction as much as possible. However, the app cannot predict all violations or some other complex states. So, the backend can respond with a little bit detailed next step or even another message like an error or warning. I describe all possible cases that we calculate on the client side in "Tests". Also, since we test how optimistic data works, I recommend to enable slow Internet or offline mode.

Pre requirements:

1. Create/have 2 users at least. One of them is a member of workspaces. The 2nd one is an admin.
2. Create/have 2 paid workspaces via OD: Collect and Control. The feature does not work for a free workspace.
3. Use OD to manipulate with the workspaces.

1. Generates an optimistic nextStep once a report has been OPENED

1. Self review

1. The member: opens a workspace chat.
2. The member: requests money.
3. The member: Verify that there is a next step with a comment: "Waiting for you to submit these expenses." and label is "Next Steps".

2. Scheduled submit enabled

1. The admin: sets "Scheduled Submit" enabled via OD in the "Reports" section.
2. The admin: selects each value one by one. The label is "Next Steps" and corresponding comments:

• Daily: "These expenses are scheduled to automatically submit later today! No further action required!";
• Weekly: "These expenses are scheduled to automatically submit on Sunday! No further action required!";
• Twice a month: "These expenses are scheduled to automatically submit on the 1st and 16th of each month! No further action required!";
• Monthly: "These expenses are scheduled to automatically submit on the [Selected report submission date] of each month! No further action required!";
• Trip: "These expenses are scheduled to automatically submit at the end of your trip! No further action required!";
• Manual: "Waiting for you to submit these expenses.";

3. The member: requests money.
4. The member: Verify that there is a next step with a corresponding comment mentioned above.

3. Self submitting prevented

1. The admin: sets "Prevent Self-Approval" enabled via OD in the "Members" section > "Workflow Enforcement".
2. The admin: requests money.
3. The admin: Verify that there is a next step with a comment: "Oops! Looks like you're submitting to yourself. Approving your own reports is forbidden by your policy. Please submit this report to someone else or contact your admin to change the person you submit to." and label is "Next Steps".

2. Generates an optimistic nextStep once a report has been SUBMITTED

1. Self review

1. Do steps: 1.3.
2. The admin: clicks on a "Submit" button.
3. The admin: Verify that there is a next step with a comment: "Waiting for you* to review these expenses." and label is "Next Steps".

2. Another reviewer

1. Do steps: 1.1.
2. The member: clicks on a "Submit" button.
3. The member: Verify that there is a next step with a comment: "Waiting for [the admin's display name]* to approve these expenses." and label is "Next Steps".

3. Another owner

1. Do steps: 1.1.
2. The admin: clicks on a "Submit" button.
3. The admin: Verify that there is a next step with a comment: "[the member's login]* is waiting for you to review these expenses." and label is "Next Steps" and label is "Next Steps". However, when you are not a manager a verb review is replaced with approve.

3. Generates an optimistic nextStep once a report has been APPROVED

1. Self review

1. Do steps: 1.3 and 2.1.
2. The admin: clicks on an "Approve" button.
3. The admin: Verify that there is a next step with a comment: "Waiting for you* to review these expenses." and label is "Next Steps".

2. Another owner

1. Do steps: 1.1 and 2.3.
2. The admin: clicks on an "Approve" button.
3. The admin: Verify that there is a next step with a comment: "No further action required!" and label is "Finished!".

4. Generates an optimistic nextStep once a report has been PAID

1. Paid with wallet

1. Do steps: 1.1 and 2.3, 3.1 or 3.2.
2. The admin: clicks on a "Pay elsewhere" button.
3. The admin: Verify that there is a next step with a comment: "You have marked these expenses as paid." and label is "Finished!".

2. Paid outside of Expensify

1. Do steps: 1.1 and 2.3, 3.1 or 3.2.
2. The admin: clicks on a "Pay with Expensify" button.
3. The admin: Verify that there is a next step with a comment: "You have marked these expenses as paid outside of Expensify." and label is "Finished!".

• [x] Verify that no errors appear in the JS console

Offline tests

Same as "Tests".

QA Steps

Same as "Tests".

• [x] Verify that no errors appear in the JS console

PR Author Checklist

• [x] I linked the correct issue in the ### Fixed Issues section above
• [x] I wrote clear testing steps that cover the changes made in this PR
  • [x] I added steps for local testing in the Tests section
  • [x] I added steps for the expected offline behavior in the Offline steps section
  • [x] I added steps for Staging and/or Production testing in the QA steps section
  • [x] I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
  • [x] 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)
  • [x] 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).
• [x] I included screenshots or videos for tests on all platforms
• [x] I ran the tests on all platforms & verified they passed on:
  • [x] Android: Native
  • [x] Android: mWeb Chrome
  • [x] iOS: Native
  • [x] iOS: mWeb Safari
  • [x] MacOS: Chrome / Safari
  • [x] MacOS: Desktop
• [x] 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)
• [x] I followed proper code patterns (see Reviewing the code)
  • [x] 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)
  • [x] I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
  • [x] I verified that comments were added to code that is not self explanatory
  • [x] 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.
  • [x] I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
    • [x] 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:
  • [x] I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
  • [x] 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.
  • [x] 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.
  • [x] I verified the JSDocs style guidelines (in STYLE.md) were followed
• [x] If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
• [x] I followed the guidelines as stated in the Review Guidelines
• [x] 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)
• [x] I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
• [x] 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
• [x] I verified that if a function's arguments changed that all usages have also been updated correctly
• [x] If any new file was added I verified that:
  • [x] 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
• [x] If a new CSS style is added I verified that:
  • [x] A similar style doesn't already exist
  • [x] The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
• [x] 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.
• [x] 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)
• [x] 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.
• [x] 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.
• [x] If the PR modifies the form input styles:
  • [x] I verified that all the inputs inside a form are aligned with each other.
  • [x] I added Design label so the design team can review the changes.
• [x] 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.
• [x] 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

https://github.com/Expensify/App/assets/57314631/1945b973-0007-47c7-81d5-502a649cf80d

https://github.com/Expensify/App/assets/57314631/e423165f-bff2-479f-a737-c8e00f08a573

https://github.com/Expensify/App/assets/57314631/7eb9c53e-e94e-432d-8038-507b577288ab

Android: mWeb Chrome

https://github.com/Expensify/App/assets/57314631/0b7992cc-5e34-4d50-b76c-0bc95dcc8c8e

https://github.com/Expensify/App/assets/57314631/3d4504f1-e22f-409f-a6af-2d8516b60b30

https://github.com/Expensify/App/assets/57314631/f3b6c28f-1eaa-4567-9dd8-59e35c308666

iOS: Native

https://github.com/Expensify/App/assets/57314631/b114ec30-234f-4636-b1a8-1a7a8128c916

https://github.com/Expensify/App/assets/57314631/6bdde792-9ca5-4c5b-a69e-5500f687b0e6

https://github.com/Expensify/App/assets/57314631/313e8f78-da51-48df-8823-9b598eec940c

iOS: mWeb Safari

https://github.com/Expensify/App/assets/57314631/24ef32a1-9e13-4eda-8799-9c183ad205c5

https://github.com/Expensify/App/assets/57314631/76ea9cf2-e054-4bca-a6e7-152d463713bc

https://github.com/Expensify/App/assets/57314631/9f853cbc-2d67-4d73-8d16-3ac55fe55e03

MacOS: Chrome / Safari

https://github.com/Expensify/App/assets/57314631/c4e22ef2-0f53-40bc-80a9-a8d57ae86bdd

https://github.com/Expensify/App/assets/57314631/078eff22-06e9-44fb-9726-c9f2302c5884

https://github.com/Expensify/App/assets/57314631/9f9a3962-fcfb-4559-b28a-87273bd79182

https://github.com/Expensify/App/assets/57314631/a1b9406d-12ee-4b22-bc11-7a878f2bd387

https://github.com/Expensify/App/assets/57314631/44ed7c64-1807-41e0-b858-48364e2ce665

https://github.com/Expensify/App/assets/57314631/b20e88d8-e065-43ff-9174-6514cada280a

https://github.com/Expensify/App/assets/57314631/e04d3548-df96-4975-a0d3-4e5aea9807b0

MacOS: Desktop

https://github.com/Expensify/App/assets/57314631/27002620-9396-4345-bc4f-d96c286253d5

https://github.com/Expensify/App/assets/57314631/b1dbf28f-5033-4a9e-bf69-359f91160ccb

https://github.com/Expensify/App/assets/57314631/ecc88376-f57e-462b-ae71-003fcea4f4ce

[melvin-bot[bot]]

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

[mountiny]

@alitoshmatov Hey! do you have the Collect policy set up for this?

[alitoshmatov]

Yes I have, reviewing

[rezkiy37]

@alitoshmatov, I've updated a value usage because of https://github.com/Expensify/App/issues/35398.

[mountiny]

@rezkiy37 thanks for adding the harvesting changes here, I probably was not clear haha, wanted to handle those by myself, nevertheless went ahead and separated them from your PR into its own https://github.com/Expensify/App/pull/35432

Its better to keep it that way to ensure separation of concerns

[alitoshmatov]

My apologies, I am having a hard time following test cases especially because it is related to OD. Can we reassign this to other C+ who could do better job than me.

cc: @mountiny @rezkiy37

[rezkiy37]

@rezkiy37 thanks for adding the harvesting changes here, I probably was not clear haha, wanted to handle those by myself, nevertheless went ahead and separated them from your PR into its own #35432

Its better to keep it that way to ensure separation of concerns

Oh, okay. I will revert the changes in this PR.

[mountiny]

Hah you could have just waited to sync with main.

[mountiny]

Asking for another c+

[allroundexperts]

Reviewer Checklist

• [x] I have verified the author checklist is complete (all boxes are checked off).
• [x] I verified the correct issue is linked in the ### Fixed Issues section above
• [x] I verified testing steps are clear and they cover the changes made in this PR
  • [x] I verified the steps for local testing are in the Tests section
  • [x] I verified the steps for Staging and/or Production testing are in the QA steps section
  • [x] 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)
  • [x] 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)
• [x] I checked that screenshots or videos are included for tests on all platforms
• [x] I included screenshots or videos for tests on all platforms
• [x] I verified tests pass on all platforms & I tested again on:
  • [x] Android: Native
  • [x] Android: mWeb Chrome
  • [x] iOS: Native
  • [x] iOS: mWeb Safari
  • [x] MacOS: Chrome / Safari
  • [x] MacOS: Desktop
• [x] 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
• [x] I verified proper code patterns were followed (see Reviewing the code)
  • [x] 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).
  • [x] I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
  • [x] I verified that comments were added to code that is not self explanatory
  • [x] 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.
  • [x] I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
  • [x] I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
  • [x] 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.
  • [x] 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.
  • [x] I verified the JSDocs style guidelines (in STYLE.md) were followed
• [x] If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
• [x] I verified that this PR follows the guidelines as stated in the Review Guidelines
• [x] 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)
• [x] I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
• [x] 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
• [x] If a new component is created I verified that:
  • [x] A similar component doesn't exist in the codebase
  • [x] All props are defined accurately and each prop has a /** comment above it */
  • [x] The file is named correctly
  • [x] The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
  • [x] The only data being stored in the state is data necessary for rendering and nothing else
  • [x] 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)
  • [x] 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)
  • [x] All JSX used for rendering exists in the render method
  • [x] 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
• [x] If any new file was added I verified that:
  • [x] 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
• [x] If a new CSS style is added I verified that:
  • [x] A similar style doesn't already exist
  • [x] The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
• [x] 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.
• [x] 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)
• [x] 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.
• [x] 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.
• [x] If the PR modifies the form input styles:
  • [x] I verified that all the inputs inside a form are aligned with each other.
  • [x] I added Design label so the design team can review the changes.
• [x] 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.
• [x] 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.
• [x] I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

https://github.com/Expensify/App/assets/30054992/95990456-b5fe-4fc2-8cb2-e57510692e6c

https://github.com/Expensify/App/assets/30054992/50b44a17-5261-45bb-a3ea-1d43dfdc8945

Android: mWeb Chrome

https://github.com/Expensify/App/assets/30054992/8cfcf144-fd28-45aa-9ae4-8b9d4e95ac6c

https://github.com/Expensify/App/assets/30054992/94317f55-2cb5-4b60-bfc4-9a4c8223739c

iOS: Native

https://github.com/Expensify/App/assets/30054992/271098a9-8f20-4046-a941-1bcf47786711

https://github.com/Expensify/App/assets/30054992/e78ccb1c-a6fd-449d-a7f4-ccdcaf881cf6

iOS: mWeb Safari

https://github.com/Expensify/App/assets/30054992/a837e8dd-1561-4c0a-905b-4f842fad1d35

https://github.com/Expensify/App/assets/30054992/26c3dc4f-036b-4dea-b6ae-d926d13c5227

MacOS: Chrome / Safari

https://github.com/Expensify/App/assets/30054992/9a9d7de5-8be5-42a4-a718-7e5e01d66f4c

https://github.com/Expensify/App/assets/30054992/93b2a03f-a888-472b-aac4-65cbeb06d733

https://github.com/Expensify/App/assets/30054992/ebad3ba9-97e0-4310-a361-08e09905146e

https://github.com/Expensify/App/assets/30054992/93c4f0dc-010d-48db-b8f8-ce4b82d65f60

MacOS: Desktop

https://github.com/Expensify/App/assets/30054992/06c5333e-9447-46d5-a5e7-2f5798cc81dd

https://github.com/Expensify/App/assets/30054992/6703dfa4-3513-46ac-8632-b79fccba07d1

[rezkiy37]

Why are we missing translations here? Is that expected?

Yes, it is expected for now. Even backend messages are not translated yet. So, it is like a future task for this flow. Am I right, @mountiny?

[mountiny]

Yeah no translations here

[allroundexperts]

Looking solid. The only thing I noticed was that the approver name sent from the backend included last name as well. Other than this, it seems to work well. Can you please resolve the conflicts? I'll run a final pass and approve.

[rezkiy37]

The only thing I noticed was that the approver name sent from the backend included last name as well.

So, I used a short form of ReportUtils.getDisplayNameForParticipant(), I've changed to use long form.

Also, resolved conflicts.

[rezkiy37]

cc @allroundexperts

[rezkiy37]

@mountiny, please take a look. I've applied the suggestions.

[mountiny]

@allroundexperts was this a comment for wrong PR? 😄

[OSBotify]

:hand: 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]

🚀 Deployed to staging by https://github.com/mountiny in version: 1.4.40-0 🚀

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

[OSBotify]

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.40-5 🚀

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