[NoQA] Feat: Add submit action #28947

waterim · 2023-10-05T18:44:22Z

Details

This PR is only to add a submit action

Fixed Issues

$ #28763
PROPOSAL: #28763 (comment)

Tests

N/A

Verify that no errors appear in the JS console

Offline tests

Same as tests

QA Steps

N/A

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

melvin-bot · 2023-10-06T11:38:37Z

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

burczu · 2023-10-06T11:50:12Z

@waterim As I see this change actually does nothing right now, am I right? That's the reason there is no tests steps and screenshots/videos?

waterim · 2023-10-06T11:51:51Z

@burczu Yes, this is just an action with no need in screenshots or test steps(discussed already with Vit)

burczu · 2023-10-06T11:52:27Z

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

Web

n/a

Mobile Web - Chrome

n/a

Mobile Web - Safari

n/a

Desktop

n/a

iOS

n/a

Android

n/a

burczu

LGTM

src/libs/actions/IOU.js

mountiny · 2023-10-06T13:19:02Z

src/libs/actions/IOU.js

+        },
+    ];
+
+    API.write('SubmitReport', {reportID: expenseReport.reportID, submittedReportActionID: optimisticSubmittedReportAction.reportActionID}, {optimisticData, successData, failureData});


Lets just name the param reportActionID and also add the managerEmail. Lets also included the managerID param, which is not yet supported though

Suggested change

API.write('SubmitReport', {reportID: expenseReport.reportID, submittedReportActionID: optimisticSubmittedReportAction.reportActionID}, {optimisticData, successData, failureData});

API.write('SubmitReport', {reportID: expenseReport.reportID, managerEmail: expenseReport.managerEmail, managerAccountID: expenseReport.managerID, reportActionID: optimisticSubmittedReportAction.reportActionID}, {optimisticData, successData, failureData});

I need to add a support for this in the backend though

waterim · 2023-10-08T20:02:31Z

@mountiny Updated, waiting for your comments regarding backend changes and PROCESSING/SUBMITTED

mountiny · 2023-10-09T09:54:00Z

Actions are unhappy @waterim

waterim · 2023-10-09T10:34:29Z

@mountiny Ah, there were few conflicts, now its okay

src/libs/actions/IOU.js

…port-IOU-action

mountiny

Thank you!

waterim · 2023-10-09T15:27:57Z

What is this, I didnt click anything 😅

mountiny · 2023-10-09T15:40:03Z

That happens when you push new code after my approval, nw

OSBotify · 2023-10-09T15:47:57Z

✋ 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-10-09T23:01:10Z

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

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

OSBotify · 2023-10-11T04:41:26Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.80-3 🚀

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

OSBotify · 2023-10-11T05:10:14Z

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

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

OSBotify · 2023-10-13T21:59:26Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.83-11 🚀

platform	result
🤖 android 🤖	skipped 🚫
🖥 desktop 🖥	skipped 🚫
🍎 iOS 🍎	skipped 🚫
🕸 web 🕸	skipped 🚫

OSBotify · 2023-10-13T22:11:29Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.83-11 🚀

platform	result
🤖 android 🤖	skipped 🚫
🖥 desktop 🖥	skipped 🚫
🍎 iOS 🍎	skipped 🚫
🕸 web 🕸	skipped 🚫

OSBotify · 2023-10-13T22:27:42Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.83-11 🚀

platform	result
🤖 android 🤖	skipped 🚫
🖥 desktop 🖥	skipped 🚫
🍎 iOS 🍎	skipped 🚫
🕸 web 🕸	skipped 🚫

OSBotify · 2023-10-13T23:03:07Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.83-11 🚀

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

OSBotify · 2023-10-16T21:14:47Z

🚀 Deployed to production by https://github.com/francoisl in version: 1.3.84-10 🚀

platform	result
🤖 android 🤖	skipped 🚫
🖥 desktop 🖥	skipped 🚫
🍎 iOS 🍎	skipped 🚫
🕸 web 🕸	skipped 🚫

OSBotify · 2023-10-16T21:51:07Z

🚀 Deployed to production by https://github.com/francoisl in version: 1.3.84-10 🚀

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

src/libs/actions/IOU.js

rushatgabhane · 2023-12-18T22:28:19Z

src/libs/actions/IOU.js

+            onyxMethod: Onyx.METHOD.MERGE,
+            key: `${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${expenseReport.reportID}`,
+            value: {
+                [expenseReport.reportActionID]: {


Hi @waterim @Beamanator @burczu @mountiny, should the reportId for failureData should have been the optimistic id optimisticSubmittedReportAction.reportActionID?

Ah yes correct this should have been optimisticSubmittedReportAction.reportActionID

shubham1206agra · 2023-12-19T09:50:06Z

You have forgot to check the copy mechanism for whisper message, that created #32285 bug.

hungvu193 · 2024-05-02T01:41:54Z

src/libs/ReportUtils.js

@@ -2202,6 +2202,9 @@ function getIOUReportActionMessage(iouReportID, type, total, comment, currency,
        case CONST.REPORT.ACTIONS.TYPE.APPROVED:
            iouMessage = `approved ${amount}`;
            break;
+        case CONST.REPORT.ACTIONS.TYPE.SUBMITTED:
+            iouMessage = `submitted ${amount}`;


This line introduced bug here: #38579
where the optimistic data from the client differs from what is returned by the backend.

waterim added 2 commits October 5, 2023 20:41

add submit action

da7d340

lint fix

9ca8e1e

rezkiy37 mentioned this pull request Oct 6, 2023

[HOLD for payment 2023-10-18] [Wave 6: Drafts] Add the autoreporting and submitted state as const to the App #28759

Closed

waterim marked this pull request as ready for review October 6, 2023 11:38

waterim requested a review from a team as a code owner October 6, 2023 11:38

melvin-bot bot requested review from burczu and removed request for a team October 6, 2023 11:38

burczu approved these changes Oct 6, 2023

View reviewed changes

melvin-bot bot requested a review from puneetlath October 6, 2023 11:55

mountiny assigned waterim Oct 6, 2023

mountiny changed the title ~~Feat: Add submit action~~ [NoQA] Feat: Add submit action Oct 6, 2023

mountiny reviewed Oct 6, 2023

View reviewed changes

adjustments

96fd57b

merge main, resolve conflicts

5d3df48

mountiny reviewed Oct 9, 2023

View reviewed changes

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

mountiny requested changes Oct 9, 2023

View reviewed changes

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

waterim added 2 commits October 9, 2023 17:16

adjustments

f0b9557

Merge remote-tracking branch 'upstream/main' into feat/28763-submitRe…

fa2c697

…port-IOU-action

mountiny previously approved these changes Oct 9, 2023

View reviewed changes

fixes

60013c0

waterim dismissed mountiny’s stale review via 60013c0 October 9, 2023 15:25

mountiny approved these changes Oct 9, 2023

View reviewed changes

mountiny merged commit 93338e3 into Expensify:main Oct 9, 2023
14 checks passed

OSBotify mentioned this pull request Oct 9, 2023

Deploy Checklist: New Expensify 2023-10-09 #29131

Closed

64 tasks

melvin-bot bot mentioned this pull request Oct 11, 2023

[HOLD for payment 2023-10-18] [Wave 6: Drafts] Add the submitReport IOU action/ method to call the command to the App #28763

Closed

OSBotify mentioned this pull request Oct 11, 2023

Deploy Checklist: New Expensify 2023-10-11 #29252

Closed

Beamanator reviewed Oct 23, 2023

View reviewed changes

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

rushatgabhane reviewed Dec 18, 2023

View reviewed changes

rushatgabhane mentioned this pull request Dec 18, 2023

[HOLD for payment 2024-01-18] [$500] Expense-No error message when submitting ongoing Scan request and report can be submitted many times #32374

Closed

6 tasks

shubham1206agra mentioned this pull request Dec 19, 2023

[HOLD for payment 2023-12-20] [$500] Expense - System message for report submission is not copied when copied to clipboard #32285

Closed

6 tasks

hungvu193 reviewed May 2, 2024

View reviewed changes

hungvu193 mentioned this pull request May 2, 2024

[HOLD for payment 2024-05-01] [$500] Workspace – “Submitted $amount” system message appears for a moment when Employee submit IOU #38579

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[NoQA] Feat: Add submit action #28947

[NoQA] Feat: Add submit action #28947

waterim commented Oct 5, 2023 •

edited

Loading

melvin-bot bot commented Oct 6, 2023

burczu commented Oct 6, 2023

waterim commented Oct 6, 2023

burczu commented Oct 6, 2023 •

edited

Loading

burczu left a comment

mountiny Oct 6, 2023 •

edited

Loading

mountiny Oct 6, 2023

waterim commented Oct 8, 2023

mountiny commented Oct 9, 2023

waterim commented Oct 9, 2023

mountiny left a comment

waterim commented Oct 9, 2023

mountiny commented Oct 9, 2023

OSBotify commented Oct 9, 2023

OSBotify commented Oct 9, 2023

OSBotify commented Oct 11, 2023

OSBotify commented Oct 11, 2023

OSBotify commented Oct 13, 2023

OSBotify commented Oct 13, 2023

OSBotify commented Oct 13, 2023

OSBotify commented Oct 13, 2023

OSBotify commented Oct 16, 2023

OSBotify commented Oct 16, 2023

rushatgabhane Dec 18, 2023

mountiny Dec 26, 2023

shubham1206agra commented Dec 19, 2023

hungvu193 May 2, 2024

	API.write('SubmitReport', {reportID: expenseReport.reportID, submittedReportActionID: optimisticSubmittedReportAction.reportActionID}, {optimisticData, successData, failureData});
	API.write('SubmitReport', {reportID: expenseReport.reportID, managerEmail: expenseReport.managerEmail, managerAccountID: expenseReport.managerID, reportActionID: optimisticSubmittedReportAction.reportActionID}, {optimisticData, successData, failureData});

[NoQA] Feat: Add submit action #28947

[NoQA] Feat: Add submit action #28947

Conversation

waterim commented Oct 5, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

melvin-bot bot commented Oct 6, 2023

burczu commented Oct 6, 2023

waterim commented Oct 6, 2023

burczu commented Oct 6, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

burczu left a comment

Choose a reason for hiding this comment

mountiny Oct 6, 2023 • edited Loading

Choose a reason for hiding this comment

mountiny Oct 6, 2023

Choose a reason for hiding this comment

waterim commented Oct 8, 2023

mountiny commented Oct 9, 2023

waterim commented Oct 9, 2023

mountiny left a comment

Choose a reason for hiding this comment

waterim commented Oct 9, 2023

mountiny commented Oct 9, 2023

OSBotify commented Oct 9, 2023

OSBotify commented Oct 9, 2023

OSBotify commented Oct 11, 2023

OSBotify commented Oct 11, 2023

OSBotify commented Oct 13, 2023

OSBotify commented Oct 13, 2023

OSBotify commented Oct 13, 2023

OSBotify commented Oct 13, 2023

OSBotify commented Oct 16, 2023

OSBotify commented Oct 16, 2023

rushatgabhane Dec 18, 2023

Choose a reason for hiding this comment

mountiny Dec 26, 2023

Choose a reason for hiding this comment

shubham1206agra commented Dec 19, 2023

hungvu193 May 2, 2024

Choose a reason for hiding this comment

waterim commented Oct 5, 2023 •

edited

Loading

burczu commented Oct 6, 2023 •

edited

Loading

mountiny Oct 6, 2023 •

edited

Loading