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

Update "submitted by harvesting" report action copy #48939

Merged
merged 20 commits into from
Sep 26, 2024

Conversation

Beamanator
Copy link
Contributor

@Beamanator Beamanator commented Sep 10, 2024

Details

This PR helps us identify report actions where "submission" happened automatically (via delayed submission) vs manually by a human

Fixed Issues

$ #35091

Tests

  1. Create policy with delayed submission (example: Daily) & simple or advanced approvals
  2. Create a report & a few expenses on that policy
  3. Let report auto-harvest
  4. Verify the "Submitted" report action now reads automatically submitted <amount> via delayed submission where the "Delayed Submission" test links out to https://help.expensify.com/articles/expensify-classic/reports/Automatically-submit-employee-reports
  • Verify that no errors appear in the JS console

Offline tests

N/A - delayed submission doesn't work offline

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

Android: Native
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari Screenshot 2024-09-10 at 3 01 18 PM
MacOS: Desktop

@Beamanator Beamanator self-assigned this Sep 10, 2024
@Beamanator Beamanator requested a review from a team as a code owner September 10, 2024 20:54
@melvin-bot melvin-bot bot requested review from mollfpr and removed request for a team September 10, 2024 20:54
Copy link

melvin-bot bot commented Sep 10, 2024

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

@Beamanator
Copy link
Contributor Author

@mollfpr are you able to test this? A.k.a. report "harvesting" / "Delayed submission" should work for you, right? Maybe you can try to just have 1 report harvest / auto-submit, then you can test these changes on that "Submitted" report action? 🙏

@mollfpr
Copy link
Contributor

mollfpr commented Sep 11, 2024

@mollfpr are you able to test this? A.k.a. report "harvesting" / "Delayed submission" should work for you, right? Maybe you can try to just have 1 report harvest / auto-submit, then you can test these changes on that "Submitted" report action? 🙏

Sure, I'm testing it right now 👍

@Beamanator
Copy link
Contributor Author

@mollfpr any update here? :D 🙏

@Beamanator
Copy link
Contributor Author

Beamanator commented Sep 13, 2024

Hmm I might have to think about how a Report Preview looks after an auto-submit report action 🤔

Actually this def prob most likely isn't necessary at all

Copy link
Contributor

@mollfpr mollfpr left a comment

Choose a reason for hiding this comment

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

Sorry for the delay Alex 🙏

The changes looks good to me! I just need to complete the recordings.

src/languages/es.ts Outdated Show resolved Hide resolved
Co-authored-by: Luthfi <luthfi.ufi14@gmail.com>
@Beamanator
Copy link
Contributor Author

Good catch! Thanks @mollfpr !

@mollfpr
Copy link
Contributor

mollfpr commented Sep 17, 2024

I'm waiting for the expense harvested!

@mollfpr
Copy link
Contributor

mollfpr commented Sep 18, 2024

@Beamanator Is there any way to triggered the harvesting manually? My expense from yesterday didn't get harvested.

@Beamanator
Copy link
Contributor Author

Shoot @mollfpr - does your test policy have Daily scheduled submit on? I think I can only manually harvest if i have a test account that you make as the approver 🤔

@mollfpr
Copy link
Contributor

mollfpr commented Sep 24, 2024

@Beamanator Yeah, that's a newly submitted expense. Some of my expense is harvested now, but I don't see the report action for harvested expenses.

Screenshot 2024-09-24 at 23 52 11

I wondering if the actionName for the submitted expense should be SUBMITTED or SUBMITTEDCLOSED? The API response seems using SUBMITTEDCLOSED and it's make the report action item for submitted action doesn't shows up.

@Beamanator
Copy link
Contributor Author

What the..... I'm seeing SUBMITTED in OldDot! I'll check NewDot

Screenshot 2024-09-24 at 8 58 29 PM

@Beamanator
Copy link
Contributor Author

Hmm in NewDot I'm seeing:

Screenshot 2024-09-24 at 9 01 31 PM

@Beamanator
Copy link
Contributor Author

Oh @mollfpr you're looking at a different report than me!

@mollfpr
Copy link
Contributor

mollfpr commented Sep 25, 2024

It's weird only this report ID 3651962364821678 has the SUBMITTED action name, the other expense has SUBMITTEDCLOSE, do you have any clue why this is happening?

Screenshot 2024-09-25 at 15 42 31

Update: I might know what is happening. I submitted the 2 previous expenses before changing the policy to approval mode. So it's got harvested and ready to pay instead of for waiting approval. The third expense, it's created after the approval mode and has the action name SUBMITTED.

Screenshot 2024-09-25 at 15 45 08

I think we missing a step in making the policy in approval mode.

@Beamanator
Copy link
Contributor Author

oOooOoohhh submitted closed is an interesting one to think about!! For now ya let's move forward mentioning that the policy needs to be on advanced approvals, not submit & close 😬

@Beamanator
Copy link
Contributor Author

I updated the test steps & will bring up "Submitted & Closed" in the issue!

@mollfpr
Copy link
Contributor

mollfpr commented Sep 26, 2024

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
48939.Android.mp4
Android: mWeb Chrome
48939.mWeb-Chrome.mp4
iOS: Native
48939.iOS.mov
iOS: mWeb Safari
48939.mWeb-Safari.mov
MacOS: Chrome / Safari
48939.Web.mp4
MacOS: Desktop
48939.Desktop.mp4

Copy link
Contributor

@mollfpr mollfpr left a comment

Choose a reason for hiding this comment

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

LGTM 🚀

Copy link

melvin-bot bot commented Sep 26, 2024

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

Copy link
Contributor

@neil-marcellini neil-marcellini left a comment

Choose a reason for hiding this comment

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

Looks great and seems to test well. Thanks.

@neil-marcellini neil-marcellini merged commit 18fac73 into main Sep 26, 2024
18 checks passed
@neil-marcellini neil-marcellini deleted the beaman-updateSubmittedByHarvestingCopy branch September 26, 2024 18:41
@OSBotify
Copy link
Contributor

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

Copy link
Contributor

🚀 Deployed to staging by https://github.com/neil-marcellini in version: 9.0.41-0 🚀

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

@kavimuru
Copy link

@Beamanator, what does "Let report auto-harvest" mean? Is this auto submission?

@mollfpr
Copy link
Contributor

mollfpr commented Sep 29, 2024

@kavimuru Yes! It should be submitted automatically after setting the delayed submission.

@kavimuru
Copy link

@mollfpr Then should we wait for 24 hours if it is set to "Daily"?

@Beamanator
Copy link
Contributor Author

@kavimuru yes, correct!! Thanks!

@@ -439,7 +439,7 @@ const ContextMenuActions: ContextMenuAction[] = [
setClipboardMessage(CONST.ACTIONABLE_TRACK_EXPENSE_WHISPER_MESSAGE);
} else if (ReportActionsUtils.isRenamedAction(reportAction)) {
setClipboardMessage(ReportActionsUtils.getRenamedAction(reportAction));
} else if (reportAction?.actionName === CONST.REPORT.ACTIONS.TYPE.SUBMITTED) {
} else if (ReportActionsUtils.isActionOfType(reportAction, CONST.REPORT.ACTIONS.TYPE.SUBMITTED)) {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hmm I might need to update this to copy the "automatically..." text, not just "submitted..." 🙃

Copy link
Contributor Author

Choose a reason for hiding this comment

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

fixing in #49909

@@ -3713,7 +3713,7 @@ function getReportName(
}
const parentReportActionMessage = ReportActionsUtils.getReportActionMessage(parentReportAction);

if (parentReportAction?.actionName === CONST.REPORT.ACTIONS.TYPE.SUBMITTED) {
if (ReportActionsUtils.isActionOfType(parentReportAction, CONST.REPORT.ACTIONS.TYPE.SUBMITTED)) {
return getIOUSubmittedMessage(parentReportAction);
Copy link
Contributor Author

Choose a reason for hiding this comment

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

hmm same here??

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yep - create a thread off of this auto-submitted action, you'll see the report name is the old text

Copy link
Contributor Author

Choose a reason for hiding this comment

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

fixing in #49909

@kavimuru
Copy link

@Beamanator Tester has to wait for 24 hours, is there anyway this could be verified without waiting?

@kavimuru
Copy link

@Beamanator @mollfpr could this be verified internally?

@Beamanator
Copy link
Contributor Author

Yes @kavimuru i can verify internally!

@Beamanator
Copy link
Contributor Author

Ya looking good on staging 👍

Screenshot 2024-09-30 at 2 34 46 PM

Copy link
Contributor

🚀 Deployed to production by https://github.com/jasperhuangg in version: 9.0.41-10 🚀

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.

5 participants