Create Draft reports optimistically #32157

mountiny · 2023-11-29T00:07:42Z

Details

**NOTE: pull latest Auth main and remake

When expense report is created on paid policy, its always created in Open state right now.

Also updates the report name for draft expense reports to say owes

Fixed Issues

$ #32174

Tests

Have an employee account on Collect workspace
In the workspace chat, request money
Verify it was created in Open state so you can see the Submit button in the Report preview
Submit the report
Verify its showing as submitted
As admin on the policy, mark the report as reimbursed
As the submitter, request more money
Verify new draft report got created

Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Same as above

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

Screenshots/Videos

tested on web:
https://github.com/Expensify/App/assets/36083550/692bc2b8-8ae3-435f-a74d-bac73d7f5627

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

…tion/custom-dev-menu-component" This reverts commit f7d11ab, reversing changes made to 630b722.

…ts-migration/custom-dev-menu-component"" This reverts commit 23bfbf9.

src/libs/ReportUtils.ts

src/libs/actions/IOU.js

melvin-bot · 2023-11-29T12:08:55Z

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

src/components/MoneyReportHeader.js

rezkiy37

In general, code looks good. I still need to run and test it.

OSBotify · 2023-11-29T12:30:25Z

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖	iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/32157/index.html	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/32157/index.html

Desktop 💻	Web 🕸️
❌ FAILED ❌	https://32157.pr-testing.expensify.com
The QR code can't be generated, because the Desktop build failed

mountiny · 2023-11-29T12:34:30Z

@rezkiy37 thanks, updated

rezkiy37 · 2023-11-29T16:37:07Z

@mountiny, that's how it works on my side.

Create.Draft.reports.optimistically.mp4

mountiny · 2023-11-29T20:49:23Z

@rezkiy37 thanks! for now, lets approve and reimburse/ mark as reimbursed from OldDot, the NewDot flow is also under construction

src/CONST.ts

mountiny · 2023-11-29T20:58:13Z

src/components/MoneyReportHeader.js

+    const isFromPaidPolicy = policyType === CONST.POLICY.TYPE.TEAM || policyType === CONST.POLICY.TYPE.CORPORATE;
+    const shouldShowNextSteps = isFromPaidPolicy && nextStep && !_.isEmpty(nextStep.message);


This is to ensure we show the next steps on any Paid policy expense report in any state/status not only as draft

mountiny · 2023-11-29T20:58:37Z

src/libs/ReportUtils.ts

+        stateNum,
+        statusNum,


Adding statusNum too because Draft report is defined by having both state and status set to 0

mountiny · 2023-11-29T20:59:28Z

src/libs/ReportUtils.ts

+
+    // Definte the state and status of the report based on whether the policy is free or paid
+    const state = isFree ? CONST.REPORT.STATE.SUBMITTED : CONST.REPORT.STATE.OPENED;
+    const stateNum = isFree ? CONST.REPORT.STATE_NUM.PROCESSING : CONST.REPORT.STATE_NUM.OPEN;


Discussed elsewhere but I will make a follow up PR to clean up the naming mess of processing/ submitted states/ status, to make it all aligned

mountiny · 2023-11-29T21:00:51Z

src/libs/actions/IOU.js

+                          hasOutstandingIOU: false,
+                          hasOutstandingChildRequest: false,
+                          iouReportID: null,


The submitter does not have an outstanding child request anymore on the workspace chat even if they did not have one before.

removing the iouReportID key ensure we wont try to create new transaction on processing report

src/libs/actions/IOU.js

akinwale · 2023-11-29T21:30:41Z

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 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 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 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

32157-web.mp4

MacOS: Desktop

akinwale

LGTM.

Tests well.

melvin-bot · 2023-11-29T21:58:49Z

@amyevans 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 · 2023-11-29T22:04:08Z

@akinwale Added one small change to fix the report name of drafts

mountiny · 2023-11-29T22:04:41Z

mountiny · 2023-11-29T22:05:58Z

src/libs/ReportUtils.ts

+/**
+ * Checks if the supplied report is in Open state and status.
+ */
+function isReportDraft(report: OnyxEntry<Report>): boolean {
+    return isExpenseReport(report) && report?.stateNum === CONST.REPORT.STATE_NUM.OPEN && report?.statusNum === CONST.REPORT.STATUS.OPEN;
+}
+


I had to move this up so I can use the method in the getMoneyRequestReportName

mountiny · 2023-11-29T22:06:31Z

src/libs/ReportUtils.ts

@@ -1688,7 +1695,8 @@ function getMoneyRequestReportName(report: OnyxEntry<Report>, policy: OnyxEntry<
        return Localize.translateLocal('iou.payerSpentAmount', {payer: payerName, amount: formattedAmount});
    }

-    if (!!report?.hasOutstandingIOU || moneyRequestTotal === 0) {
+    // The report name should show as owed also for drafts
+    if (!!report?.hasOutstandingIOU || isReportDraft(report) || moneyRequestTotal === 0) {


I feel like the !!report?.hasOutstandingIOU is a bad pattern we got here, but not in scope to fix in this PR

puneetlath

Some small feedback.

src/CONST.ts

src/libs/ReportUtils.ts

puneetlath · 2023-11-29T22:10:05Z

src/libs/ReportUtils.ts

@@ -1688,7 +1695,8 @@ function getMoneyRequestReportName(report: OnyxEntry<Report>, policy: OnyxEntry<
        return Localize.translateLocal('iou.payerSpentAmount', {payer: payerName, amount: formattedAmount});
    }

-    if (!!report?.hasOutstandingIOU || moneyRequestTotal === 0) {
+    // The report name should show as owed also for drafts


This comment is a bit weird, since it only applies to one of the conditions below.

I will remove it from there, I agree. The conditions are quite self-explanatory so we can go without it I this

src/libs/ReportUtils.ts

OSBotify · 2023-11-29T22:42:02Z

✋ 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 · 2023-12-01T12:44:59Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.6-2 🚀

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

iwiznia · 2024-03-07T16:34:10Z

src/libs/ReportUtils.ts

+/**
+ * Checks if the supplied report is an expense report in Open state and status.
+ */
+function isDraftExpenseReport(report: OnyxEntry<Report>): boolean {


Just saw this method... why, oh, why did we introduce a new term draft for what in every other place we call open? 😢

I followed the terminology used in the App so its clearer for external engineers who dont have context of the Open reports, however, I agree in the hindsight it would be better to follow the backend terminology and keep Drafts as the marketing word only 👍

mountiny added 2 commits November 28, 2023 22:59

Revert "Merge pull request #29744 from software-mansion-labs/ts-migra…

23bfbf9

…tion/custom-dev-menu-component" This reverts commit f7d11ab, reversing changes made to 630b722.

Check if the linked report is draft on paid policy

545059a

mountiny self-assigned this Nov 29, 2023

Fix style

5f2b55f

mountiny requested a review from akinwale November 29, 2023 11:38

Revert "Revert "Merge pull request #29744 from software-mansion-labs/…

c2030a2

…ts-migration/custom-dev-menu-component"" This reverts commit 23bfbf9.

rezkiy37 reviewed Nov 29, 2023

View reviewed changes

src/libs/ReportUtils.ts Outdated Show resolved Hide resolved

Merge branch 'main' into vit-createDraftReports

52f52d7

rezkiy37 reviewed Nov 29, 2023

View reviewed changes

src/libs/actions/IOU.js Outdated Show resolved Hide resolved

mountiny added the Ready To Build label Nov 29, 2023

mountiny marked this pull request as ready for review November 29, 2023 12:08

mountiny requested a review from a team as a code owner November 29, 2023 12:08

melvin-bot bot removed the request for review from a team November 29, 2023 12:08

rezkiy37 reviewed Nov 29, 2023

View reviewed changes

src/components/MoneyReportHeader.js Outdated Show resolved Hide resolved

rezkiy37 reviewed Nov 29, 2023

View reviewed changes

Clean up and address feedback

b66b1de

Merge main

6d7f9c8

mountiny commented Nov 29, 2023

View reviewed changes

src/CONST.ts Outdated Show resolved Hide resolved

mountiny commented Nov 29, 2023

View reviewed changes

akinwale reviewed Nov 29, 2023

View reviewed changes

src/libs/actions/IOU.js Outdated Show resolved Hide resolved

Access the last message test and html safely

c87ad6a

akinwale approved these changes Nov 29, 2023

View reviewed changes

melvin-bot bot requested a review from amyevans November 29, 2023 21:58

Make draft expense report name say owed instead of paid

4f18257

mountiny commented Nov 29, 2023

View reviewed changes

puneetlath requested changes Nov 29, 2023

View reviewed changes

mountiny added 2 commits November 29, 2023 22:18

Rename the isReportDraft method to more descriptive isDraftExpenseReport

a56c5cb

Address PR feedback

ffcbf2b

mountiny requested a review from puneetlath November 29, 2023 22:21

Update the state open const

b057c95

puneetlath approved these changes Nov 29, 2023

View reviewed changes

puneetlath merged commit f7124d5 into main Nov 29, 2023
15 checks passed

puneetlath deleted the vit-createDraftReports branch November 29, 2023 22:36

github-actions bot mentioned this pull request Nov 30, 2023

Deploy Checklist: New Expensify 2023-11-30 #32266

Closed

42 tasks

melvin-bot bot mentioned this pull request Dec 1, 2023

[HOLD for payment 2023-12-08] [Drafts] Allow draft creation in App #32174

Closed

bernhardoj mentioned this pull request Dec 11, 2023

[HOLD for payment 2024-01-04] [$500] [Wave 6: Workspace Chats] IOU-The request created is not displayed in the manual expense created page. #32796

Closed

6 tasks

iwiznia reviewed Mar 7, 2024

View reviewed changes

iwiznia mentioned this pull request Mar 8, 2024

[NoQA] Rename method from draft to open #37987

Merged

48 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Create Draft reports optimistically #32157

Create Draft reports optimistically #32157

mountiny commented Nov 29, 2023 •

edited

Loading

melvin-bot bot commented Nov 29, 2023

rezkiy37 left a comment

OSBotify commented Nov 29, 2023

mountiny commented Nov 29, 2023

rezkiy37 commented Nov 29, 2023

mountiny commented Nov 29, 2023

mountiny Nov 29, 2023

mountiny Nov 29, 2023

mountiny Nov 29, 2023

mountiny Nov 29, 2023

akinwale commented Nov 29, 2023 •

edited

Loading

akinwale left a comment

melvin-bot bot commented Nov 29, 2023

mountiny commented Nov 29, 2023

mountiny commented Nov 29, 2023

mountiny Nov 29, 2023

mountiny Nov 29, 2023

puneetlath left a comment

puneetlath Nov 29, 2023

mountiny Nov 29, 2023

mountiny Nov 29, 2023

OSBotify commented Nov 29, 2023

OSBotify commented Dec 1, 2023

iwiznia Mar 7, 2024

mountiny Mar 8, 2024

		const isFromPaidPolicy = policyType === CONST.POLICY.TYPE.TEAM \|\| policyType === CONST.POLICY.TYPE.CORPORATE;
		const shouldShowNextSteps = isFromPaidPolicy && nextStep && !_.isEmpty(nextStep.message);

Create Draft reports optimistically #32157

Create Draft reports optimistically #32157

Conversation

mountiny commented Nov 29, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Nov 29, 2023

rezkiy37 left a comment

Choose a reason for hiding this comment

OSBotify commented Nov 29, 2023

mountiny commented Nov 29, 2023

rezkiy37 commented Nov 29, 2023

mountiny commented Nov 29, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

akinwale commented Nov 29, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

akinwale left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Nov 29, 2023

mountiny commented Nov 29, 2023

mountiny commented Nov 29, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

puneetlath left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

OSBotify commented Nov 29, 2023

OSBotify commented Dec 1, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mountiny commented Nov 29, 2023 •

edited

Loading

akinwale commented Nov 29, 2023 •

edited

Loading