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 "automatically approved" report action copy #49909

Merged
merged 18 commits into from
Oct 8, 2024

Conversation

Beamanator
Copy link
Contributor

@Beamanator Beamanator commented Sep 30, 2024

Details

We want the LHN & report action copy to reflect when a report gets manually approved vs auto approved (this PR)

Fixed Issues

$ #35091

Tests

  1. Create a collect policy in NewDot
  2. In OldDot, set up auto approvals like so:
    • In workspace Members tab, set "Approval Mode" to "Submit & Approve"
    • In the Manually approve all expenses over: field, enter a number like $200.00 (something over $100)
    • In the Randomly route reports for manual approval: field, enter 0%
  3. Set the policy's "scheduled submit" to "on" and to anything other than "Instant" (a.k.a. "Daily")
  4. As the submitter, submit an expense for $101.00 (something between $100 and $200)
  5. The report should get auto-approved. Verify the LHN and report action text have been updated:
Screenshot 2024-09-29 at 10 04 06 PM

Next, do similar on a Control policy

  1. Set up Control policy on NewDot, with Advanced Approvals enabled - non instant submit
  2. Make sure the policy has at least 3 members, where at least one employee has an approval chain like this:
    • Employee A submitsTo Employee B
    • Employee B forwardsTo Employee C
  3. In OldDot as the policy admin, enable auto approvals
    • In the workspace Members page, set Manually approve all expenses over: to something like $1000
    • Set Randomly route reports for manual approval: to 0%
  4. In NewDot, have Employee A submit an expense in their workspace chat
  5. Verify the report successfully auto-forwarded so the next approver is Employee C & that the report action and LHN look like so:
Screenshot 2024-09-30 at 2 31 31 PM
  • Verify that no errors appear in the JS console

Offline tests

N/A - you need to be online for auto-approval to happen (for now)

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-29 at 10 04 06 PM
MacOS: Desktop

@Beamanator Beamanator marked this pull request as ready for review September 30, 2024 04:30
@Beamanator Beamanator requested a review from a team as a code owner September 30, 2024 04:30
@melvin-bot melvin-bot bot requested review from mollfpr and removed request for a team September 30, 2024 04:30
Copy link

melvin-bot bot commented Sep 30, 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

FYI this is ready for review BUT i might also add a case for forwarded report actions here 👍

@Beamanator
Copy link
Contributor Author

Ok nice i will update test steps then we're ready 🙏

@mollfpr
Copy link
Contributor

mollfpr commented Oct 1, 2024

The changes look good to me, I'm starting to test! @Beamanator Could you resolve the conflict? Thank you!

@Beamanator
Copy link
Contributor Author

ooh big conflicts!! will resolve soon 🙏

@mollfpr
Copy link
Contributor

mollfpr commented Oct 2, 2024

@Beamanator I'm having difficulty testing the second test case/auto-forwarding. After Employee A submitted the expense, it didn't get auto-approved on the Employee B. If Employee B manually approves the expense, it forwards the expense to Employee C.

Here's my setting.

Screenshot 2024-10-02 at 22 45 50

Also, for the first test case where it automatically approves the expense, I'm only able to make it work if the schedule submit is set to manually. Should we add a step for that?

@Beamanator
Copy link
Contributor Author

@Beamanator I'm having difficulty testing the second test case/auto-forwarding. After Employee A submitted the expense, it didn't get auto-approved on the Employee B. If Employee B manually approves the expense, it forwards the expense to Employee C.

Here's my setting.

Hmm that looks good, can you also show the auto-approval settings?

@Beamanator
Copy link
Contributor Author

Beamanator commented Oct 2, 2024

Also, for the first test case where it automatically approves the expense, I'm only able to make it work if the schedule submit is set to manually. Should we add a step for that?

Interesting, you mean it won't work if scheduled submit is set to something else like "Daily"?
^ I updated to mention turning scheduled submit on, and anything other than "Instant"

@mollfpr
Copy link
Contributor

mollfpr commented Oct 3, 2024

Here are the approval settings.

Screenshot 2024-10-03 at 10 40 32

So it should be auto-approved on Employee B?

Interesting, you mean it won't work if scheduled submit is set to something else like "Daily"?
^ I updated to mention turning scheduled submit on, and anything other than "Instant"

I might be wrong, but the auto-approve won't work for auto-submit expenses.

@mollfpr
Copy link
Contributor

mollfpr commented Oct 3, 2024

@Beamanator, I was able to make it auto-forwarding by setting and toggling off the schedule submission.

Screen.Recording.2024-10-03.at.10.57.19.mp4

It's somewhat of weird to me because toggling off the schedule submit should make the expense instantly submitted but in this case the Employee A manually submit the expense.

It's working fine with schedule submission "Manually" using the staging server.

@Beamanator
Copy link
Contributor Author

Hmm ok your approval settings look correct 👍

So it should be auto-approved on Employee B?

Yes, basically Employee A submits, and since we have auto-approval on, Employee B should auto-approve (and forward) to Employee C.

So the end should be the Employee C needs to approve

I might be wrong, but the auto-approve won't work for auto-submit expenses.

Agreed, which is why we want auto-submit (instant submit) NOT on. Are we understanding each other here? 😅

@Beamanator
Copy link
Contributor Author

toggling off the schedule submit should make the expense instantly submitted

fyi I see that you crossed this out, but just to explain - turning off scheduled submit is actually how manual submission is set, not instant submit - for instant submit, you have to turn scheduled submit on & select "instantly" - which may not be so intuitive? 😅

Your video makes it looks like everything is working as i'd expect!! 👍 👍

@mollfpr
Copy link
Contributor

mollfpr commented Oct 3, 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
Android: mWeb Chrome
49909.mWeb-Chrome.-.Auto.approving.mp4
49909.mWeb-Chrome.-.Auto.forwarding.mp4
iOS: Native
49909.iOS.-.Auto.approving.mov
49909.iOS.-.Auto.forwarding.mp4
iOS: mWeb Safari
49909.mWeb-Safari.-.Auto.approving.mov
49909.mWeb-Safari.-.Auto.forwarding.mp4
MacOS: Chrome / Safari
49909.Web.-.Auto.approving.mp4
49909.Web.-.Auto.forwarding.mp4
MacOS: Desktop
49909.Desktop.-.Auto.approving.mp4
49909.Desktop.-.Auto.forwarding.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 🚀

Sorry, I couldn't get the android build working. Not specifically in this PR, but on the latest main. I'm trying to fix it but still no luck.

@melvin-bot melvin-bot bot requested a review from roryabraham October 3, 2024 19:27
Copy link

melvin-bot bot commented Oct 3, 2024

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

roryabraham
roryabraham previously approved these changes Oct 3, 2024
Copy link
Contributor

@roryabraham roryabraham left a comment

Choose a reason for hiding this comment

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

strongly encouraged suggestion: Write some automated tests to cover this change. It's a very good candidate for unit tests, and they'd go a long way to make this code more robust and avoid it breaking in the future.

strongly encouraged Addendum to the strongly encouraged suggestion: Don't add the tests in a follow-up. Add them now 🙂

if (originalMessage?.amount) {
formattedAmount = getFormattedAmount(reportAction);
} else {
formattedAmount = CurrencyUtils.convertToDisplayString(getMoneyRequestSpendBreakdown(expenseReport).totalDisplaySpend, expenseReport?.currency);
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggestion: log when we execute this fallback such that, some time from now, we can search up the log and remove this code if it's no longer needed. Create a monthly issue to check back in.

@@ -270,6 +270,30 @@ describe('ReportUtils', () => {
});
});
});

describe('ParentReportAction is', () => {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@roryabraham here's an example getReportName test I am planning to add more of, for the other examples in this PR - I'll probably even add more tests but can you at least let me know if this is what you're thinking for tests / any feedback on this one?

Copy link
Contributor

Choose a reason for hiding this comment

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

I was thinking more along the lines of UI tests rendering <ReportActionItem> using @testing-library/react-native. There are only limited examples in the repo today

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 in that case since there's not much to go on right now, i'd prefer taking this as a follow-up for a contributor or C+ to write up b/c it's going to take me a bit to figure out how that works & that'll keep delaying this PR from getting merged

Copy link
Contributor

Choose a reason for hiding this comment

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

it's going to take me a bit to figure out how that works & that'll keep delaying this PR from getting merged

Up to you. I'd encourage you to take the time to learn and write the tests, because I don't see this PR as so urgent that we can't wait for tests. Just my opinion though (informed by my observed experience that 90% of the time when we "follow up to add tests", that part just never happens) 🙂

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I feel confident that I can get unit tests written externally, so I created this follow-up #50351

I believe this will be more time efficient because I have more important issues to focus on this week

@Beamanator
Copy link
Contributor Author

@mollfpr ok so i created this follow-up to write unit tests: #50351

i also just pulled main, can you please do a quick re-test & then reapprove?

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 👍

@melvin-bot melvin-bot bot requested a review from bondydaa October 8, 2024 10:50
Copy link

melvin-bot bot commented Oct 8, 2024

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

@bondydaa bondydaa merged commit 5c9517e into main Oct 8, 2024
18 checks passed
@bondydaa bondydaa deleted the beaman-updateAutoApproveCopy branch October 8, 2024 15:05
@OSBotify
Copy link
Contributor

OSBotify commented Oct 8, 2024

✋ 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

github-actions bot commented Oct 9, 2024

🚀 Deployed to staging by https://github.com/bondydaa in version: 9.0.47-1 🚀

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

Copy link
Contributor

🚀 Deployed to production by https://github.com/thienlnam in version: 9.0.47-4 🚀

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