Fix submit and close next steps for optimistically created policy #39563

mountiny · 2024-04-03T22:05:31Z

Details

We were missing default values for delayed submission and for the approval mode when the policy is created optimistically in newdot. By default, the policy is made as Submit and close, so when we create a policy offline and then proceed to create a request and submit it, the report should end up getting closed.

Added a unit test to cover this case

Fixed Issues

$ #39337

Tests

Go to staging.new.expensify.com
Create a new workspace on ND (Collect).
Go offline.
Request money from the workspace chat.
Click on expense preview.
Click Submit.
Verify the Next steps banned says: Finished No further action required!

Verify that no errors appear in the JS console

Offline tests

Same as tests

QA Steps

Same as tests

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

Logic changes so only adding web and ios native:

Screen.Recording.2024-04-03.at.23.02.14.mp4

Screen.Recording.2024-04-03.at.23.03.58.mp4

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

si

…l mode defaults

…and close approval flow

…mitting

… approval mode the policy has

melvin-bot · 2024-04-03T22:05:35Z

@rushatgabhane 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 · 2024-04-03T22:13:35Z

src/types/onyx/Policy.ts

@@ -316,9 +316,6 @@ type Policy = OnyxCommon.OnyxValueWithOfflineFeedback<
            enabled: boolean;
        };

-        /** @deprecated Whether the scheduled submit is enabled */
-        isPreventSelfApprovalEnabled?: boolean;


This is no longer being sent from backend so we can remove it

mountiny · 2024-04-03T22:14:31Z

tests/unit/NextStepUtilsTest.ts

-
-        describe('it generates a nullable optimistic nextStep', () => {
-            test('closed status', () => {
-                const result = NextStepUtils.buildNextStep(report, CONST.REPORT.STATUS_NUM.CLOSED);
-
-                expect(result).toBeNull();
-            });
-        });


I believe this usecase is only in the Cancel payment flow and even in that one I think its fair so show the Finished no further action required message. So its safe to remove

mountiny · 2024-04-04T22:15:58Z

@rushatgabhane will you be able to address this one?

rushatgabhane · 2024-04-06T06:17:20Z

@mountiny yes today

rushatgabhane · 2024-04-08T06:56:31Z

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
I checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
- I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design so the design team can review the changes.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

Screen.Recording.2024-04-08.at.13.06.37.mov

MacOS: Desktop

Same as web

melvin-bot · 2024-04-08T07:53:33Z

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

OSBotify · 2024-04-08T10:35:09Z

✋ 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 · 2024-04-08T11:09:56Z

🚀 Deployed to staging by https://github.com/MariaHCD in version: 1.4.61-0 🚀

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

OSBotify · 2024-04-08T13:06:34Z

🚀 Deployed to staging by https://github.com/MariaHCD in version: 1.4.61-0 🚀

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

OSBotify · 2024-04-10T17:24:11Z

🚀 Deployed to production by https://github.com/Julesssss in version: 1.4.61-8 🚀

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

mountiny added 8 commits April 3, 2024 18:16

Add some default policy values

f07344b

Make sure we create the workspace with correct harvesting and approva…

0860477

…l mode defaults

Remove deprecated isPreventSelfApprovalEnabled policy property

3131c5d

Merge main

652b2f3

Create correct next steps when the report is submitted in the submit …

ebf0eaa

…and close approval flow

Add unit test for the submit and close next steps

26e41dc

Make sure the next steps are included in the optimistic data when sub…

bcb3110

…mitting

Include the next steps in failure data when submitting no matter what…

36c91d2

… approval mode the policy has

mountiny self-assigned this Apr 3, 2024

mountiny requested a review from a team as a code owner April 3, 2024 22:05

melvin-bot bot removed the request for review from a team April 3, 2024 22:05

melvin-bot bot requested a review from rushatgabhane April 3, 2024 22:05

mountiny added 3 commits April 3, 2024 23:11

Update the unit tests

67c18ce

Fix style

fc36c7c

Revert podfile lock changes

356bbd0

mountiny commented Apr 3, 2024

View reviewed changes

mountiny added 3 commits April 3, 2024 23:34

Update IOU tests

eb24a0a

Add comment to explain test

737788b

Merge branch 'main' into vit-39337

2d9027e

rushatgabhane approved these changes Apr 8, 2024

View reviewed changes

melvin-bot bot requested a review from MariaHCD April 8, 2024 07:53

MariaHCD approved these changes Apr 8, 2024

View reviewed changes

MariaHCD merged commit ef41626 into main Apr 8, 2024
16 checks passed

MariaHCD deleted the vit-39337 branch April 8, 2024 10:28

github-actions bot mentioned this pull request Apr 8, 2024

Deploy Checklist: New Expensify 2024-04-08 #39807

Closed

This was referenced Apr 12, 2024

Deploy Checklist: New Expensify 2024-04-08 #39807 Derevyaa/Expensify-App#1

Closed

Deploy Checklist: New Expensify 2024-04-09 #39808 Derevyaa/Expensify-App#2

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix submit and close next steps for optimistically created policy #39563

Fix submit and close next steps for optimistically created policy #39563

mountiny commented Apr 3, 2024

melvin-bot bot commented Apr 3, 2024

mountiny Apr 3, 2024

mountiny Apr 3, 2024

mountiny commented Apr 4, 2024

rushatgabhane commented Apr 6, 2024 •

edited

Loading

rushatgabhane commented Apr 8, 2024 •

edited

Loading

melvin-bot bot commented Apr 8, 2024

OSBotify commented Apr 8, 2024

OSBotify commented Apr 8, 2024

OSBotify commented Apr 8, 2024

OSBotify commented Apr 10, 2024

Fix submit and close next steps for optimistically created policy #39563

Fix submit and close next steps for optimistically created policy #39563

Conversation

mountiny commented Apr 3, 2024

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Apr 3, 2024

mountiny Apr 3, 2024

Choose a reason for hiding this comment

mountiny Apr 3, 2024

Choose a reason for hiding this comment

mountiny commented Apr 4, 2024

rushatgabhane commented Apr 6, 2024 • edited Loading

rushatgabhane commented Apr 8, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

melvin-bot bot commented Apr 8, 2024

OSBotify commented Apr 8, 2024

OSBotify commented Apr 8, 2024

OSBotify commented Apr 8, 2024

OSBotify commented Apr 10, 2024

rushatgabhane commented Apr 6, 2024 •

edited

Loading

rushatgabhane commented Apr 8, 2024 •

edited

Loading