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

[Drafts] Show the GBR optimistically to the submitter when Scheduled submit is turned off #33030

Merged
merged 11 commits into from
Jan 2, 2024

Conversation

mountiny
Copy link
Contributor

@mountiny mountiny commented Dec 13, 2023

Details

When scheduled submit is turned off, then the GBR should show for the submitter in the LHN on the policy expense chat. They need to manually submit. Whether the scheduled submit is on or off is told by the isHarvestingEnabled policy property.

Secondly this change is also fixing the case where the approver force submits the report and the GBR does not show up for them optimistically. When they submit the report, they are the next person in the approval chain so they should have GBR in LHN.

In this PR, we are also updating the styles of the submit button based on the isHarvestingEnabled property. When the scheduled submit is turned on, the submit button should not show active green for the submitter as the report will autosubmit

Fixed Issues

$ #32920
$ #33443
PROPOSAL:

Tests

  1. Have a collect policy with Scheduled Submit turned on
  2. Verify the policy object has the isHarvestingEnabled property set to true
  3. As admin, change the Scheduled submit to off in OldDot
  4. Refresh the page (might have to sign out in case you do not have the latest Auth changes made locally). Verify the isHarvestingEnabled is now set to false
  5. Request money as employee from the workspace
  6. Verify the GBR shows optimistically in your LHN on the policy expense chat
  7. Verify the next steps on the expense report say you have to submit the report manually
  8. Submit the report
  9. Verify the GBR has disapeared for the employee

  1. On collect policy with employee approver set up
  2. Create a draft report as the employee
  3. As the approver, verify that you do not see GBR in your LHN, since the report has not been submitted to you yet
  4. As the approver, force submit the report
  5. Verify that the GBR has updated optimistically and its showing in LHN for you as you need to approve now

  1. On collect policy with Scheduled submit turned off, create draft request
  2. As submiter, verify the Submit button is success green
  3. As Admin the button is still greyish green
  4. Now update the settings of the Scheduled Submit to turn it on so the report will automatically submit when harvesting runs
  5. Verify that for the Submitter the button is greyish green now too. In Report Preview in workspace chat and in the expense report header too
  • Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Same as tests

  • Verify that no errors appear in the JS console

PR Author Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
    • I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
    • MacOS: Desktop
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I followed proper code patterns (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
    • I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
      • If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is 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(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 form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label 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

Scheduled submit on:

scheduledSubmitOn.mp4

Scheduled submit off

scheduledSubmitOff.mp4

Optimistic GBR when scheduled submit if off

Screen.Recording.2023-12-29.at.14.53.36.mp4

Optimistic GBR when scheduled submit if on - no GBR in this case

Screen.Recording.2023-12-29.at.14.55.25.mp4
Android: Native
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari
MacOS: Desktop

@mountiny mountiny self-assigned this Dec 13, 2023
@mountiny
Copy link
Contributor Author

At the moment needs to be tested with this Web change https://github.com/Expensify/Web-Expensify/pull/40033

@mountiny
Copy link
Contributor Author

I will follow up on this tomorrow when travelling, prioritized other issues

@mountiny mountiny marked this pull request as ready for review December 29, 2023 13:26
@mountiny mountiny requested a review from a team as a code owner December 29, 2023 13:26
@melvin-bot melvin-bot bot requested review from cubuspl42 and removed request for a team December 29, 2023 13:26
Copy link

melvin-bot bot commented Dec 29, 2023

@cubuspl42 @ One of you needs to 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
Copy link
Contributor Author

@puneetlath This is ready for a review

Copy link
Contributor

@puneetlath puneetlath left a comment

Choose a reason for hiding this comment

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

Looks good to me. Just a couple minor comments. Also, didn't have a chance to test it.

src/libs/actions/IOU.js Outdated Show resolved Hide resolved
src/libs/actions/IOU.js Outdated Show resolved Hide resolved
src/libs/actions/IOU.js Outdated Show resolved Hide resolved
puneetlath
puneetlath previously approved these changes Dec 29, 2023
@shubham1206agra
Copy link
Contributor

Refresh the page (might have to sign out in case you do not have the latest Auth changes made locally). Verify the isHarvestingEnabled is now set to false

I have verified this behaviour, and is working correctly

@mountiny mountiny requested review from shubham1206agra and removed request for cubuspl42 December 29, 2023 17:35
@mountiny
Copy link
Contributor Author

Seems like the test is just running too long now

[ReportScreen] should render ReportScreen with composer interactions

    thrown: "Exceeded timeout of 240000 ms for a test.
    Use jest.setTimeout(newTimeout) to increase the timeout value, if this is a long-running test."

      154 | const runs = CONST.PERFORMANCE_TESTS.RUNS;
      155 |
    > 156 | test('[ReportScreen] should render ReportScreen with composer interactions', () => {
          | ^
      157 |     const {triggerTransitionEnd, addListener} = createAddListenerMock();
      158 |     const scenario = async () => {
      159 |         /**

      at Object.test (tests/perf-test/ReportScreen.perf-test.js:156:1)
      at asyncGeneratorStep (node_modules/@babel/runtime/helpers/asyncToGenerator.js:3:24)
      at asyncGeneratorStep (node_modules/@babel/runtime/helpers/asyncToGenerator.js:22:9)

@shubham1206agra
Copy link
Contributor

shubham1206agra commented Dec 30, 2023

Screenshot 2023-12-30 at 7 19 23 PM

I think this shouldn't happen. Do I need refresh after switching Scheduled Submit setting? Non-offline works fine without refresh

Steps
OD:

  1. Switch the Scheduled Submit setting.

ND:

  1. Go offline
  2. Make a Request to the workspace

Video:

Screen.Recording.2023-12-30.at.7.34.27.PM.mov

Admin side after coming online

Screenshot 2023-12-30 at 7 39 38 PM

Update: After sometime it fixes itself.
Update 2: The order of requests got changed 😄

@shubham1206agra
Copy link
Contributor

Screenshot 2023-12-30 at 7 23 08 PM

Shouldn't we show next steps on optimistically created request?

@mountiny
Copy link
Contributor Author

Shouldn't we show next steps on optimistically created request?

Nope that is not implemented yet

@shubham1206agra with the first issue, I think thats fine that seems to be related just to the pusher updates and maybe it was not processed in time or something, right?

@shubham1206agra
Copy link
Contributor

Screen.Recording.2023-12-31.at.5.48.28.PM.mov

I think pusher is giving updates without refresh

@mountiny
Copy link
Contributor Author

Oh you are suggesting the you want the colour of the button to change when the scheduled submit property is changed by the pusher?

@shubham1206agra
Copy link
Contributor

Oh you are suggesting the you want the colour of the button to change when the scheduled submit property is changed by the pusher?

I am responding to this

@shubham1206agra with the first issue, I think thats fine that seems to be related just to the pusher updates and maybe it was not processed in time or something, right?

It seems like offline request doesn't seem to pick up right value.

@mountiny
Copy link
Contributor Author

I have added useMemo, can you retest? I am having some issues with pusher locally, it does not wasnt to authenticate

@shubham1206agra
Copy link
Contributor

Yeah, seems fixed now. Looks like pusher was the culprit after all.

@shubham1206agra
Copy link
Contributor

shubham1206agra commented Dec 31, 2023

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(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 form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label 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

Scheduled submit on
Screen.Recording.2023-12-30.at.7.07.22.PM.mov
Scheduled submit off
Screen.Recording.2023-12-30.at.7.12.53.PM.mov
Optimistic GBR when scheduled submit if off
Screen.Recording.2023-12-30.at.7.15.26.PM.mov
Optimistic GBR when scheduled submit if off
Screen.Recording.2023-12-30.at.7.48.21.PM.mov

@melvin-bot melvin-bot bot requested a review from Julesssss December 31, 2023 15:39
Copy link

melvin-bot bot commented Dec 31, 2023

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

@puneetlath puneetlath merged commit eedab7e into main Jan 2, 2024
16 of 17 checks passed
@puneetlath puneetlath deleted the vit-harvestingPolicyKey branch January 2, 2024 17:29
@OSBotify
Copy link
Contributor

OSBotify commented Jan 2, 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.

@OSBotify
Copy link
Contributor

OSBotify commented Jan 2, 2024

🚀 Deployed to staging by https://github.com/puneetlath in version: 1.4.21-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Jan 4, 2024

🚀 Deployed to production by https://github.com/marcaaron in version: 1.4.21-4 🚀

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

1 similar comment
@OSBotify
Copy link
Contributor

OSBotify commented Jan 4, 2024

🚀 Deployed to production by https://github.com/marcaaron in version: 1.4.21-4 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Jan 4, 2024

🚀 Deployed to production by https://github.com/marcaaron in version: 1.4.21-4 🚀

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

@paultsimura
Copy link
Contributor

paultsimura commented Mar 16, 2024

Hey @mountiny, I've been going through some tests for another PR and I see the tests from this PR description don't work anymore. Looks like it was broken recently (most likely by #33774, but not 100% sure), could you please confirm it's broken for you as well?

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