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

Ensure we show upgrade flow for GL/Payroll/Tax codes for non control policy #45866

Merged
merged 10 commits into from
Jul 30, 2024

Conversation

rushatgabhane
Copy link
Member

@rushatgabhane rushatgabhane commented Jul 21, 2024

Details

Fixed Issues

$ #45643
$ #45770
PROPOSAL:

Tests

  1. Go to a non-control policy
  2. Enable tags, taxes and categories
  3. Go to categories, select a category
  4. Click GL and verify that upgrade modal is shown
  5. Click Payroll code and verify that upgrade modal is shown
  6. Go to tags and select a tag
  7. Click GL and verify that upgrade modal is shown
  8. Go to taxes and select a tax
  9. Click tax code and verify that upgrade modal is shown

Test 2

  1. Go to Workspace settings > Taxes
  2. Click on any tax
  3. Click Tax code
  4. Without modifying the existing tax code, save the tax code
  5. Verify that modal closes and no validation error is thrown
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

  • 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
Screen.Recording.2024-07-22.at.01.20.04.mov
MacOS: Desktop

@rushatgabhane rushatgabhane requested a review from a team as a code owner July 21, 2024 22:24
@melvin-bot melvin-bot bot removed the request for review from a team July 21, 2024 22:24
Copy link

melvin-bot bot commented Jul 21, 2024

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

@melvin-bot melvin-bot bot requested a review from brunovjk July 21, 2024 22:24
@rushatgabhane
Copy link
Member Author

@brunovjk heads up! this PR has a deadline. We want it on production before end of july.

@brunovjk
Copy link
Contributor

brunovjk commented Jul 21, 2024

@brunovjk heads up! this PR has a deadline. We want it on production before end of july.

Cool, of course @rushatgabhane! I'll review it first thing in the morning. If we're in a hurry, feel free to ask another C+ :D

@rushatgabhane
Copy link
Member Author

@brunovjk that would be great thank you for the urgency 😄

@brunovjk
Copy link
Contributor

brunovjk commented Jul 22, 2024

@rushatgabhane should we hide the default value for a non-control policy? Example the Tax:

Screen.Recording.2024-07-22.at.11.21.21.mov

Or is it intentional to work like this? Thanks. The rest looks good to me, nice work!
I'll post the checklist today, I'm testing it on Android now.

@rushatgabhane
Copy link
Member Author

rushatgabhane commented Jul 22, 2024

@brunovjk no, i think it does not add any value to hide it. I've asked it on slack for confirmation tho

@rushatgabhane
Copy link
Member Author

rushatgabhane commented Jul 22, 2024

@brunovjk we are going to hide the taxID for non control policy because it makes it look more like its behind a paywall. Great suggestion! 👍

@brunovjk
Copy link
Contributor

Thank you @rushatgabhane.
I'm observing some strange behavior when saving a new Tax Code for a control policy. Especially for a newly created workspace:

Screen.Recording.2024-07-22.at.14.50.32.mov

I didn't observe the same in staging.

Note: I also observe another issue, but it is reproducible in staging and reported here #45858

@rushatgabhane
Copy link
Member Author

I'm observing some strange behavior when saving a new Tax Code for a control policy

do you mean the not found page appearing briefly?

@brunovjk
Copy link
Contributor

@rushatgabhane Yes, but after refreshing the page, I no longer see the "not found", but the transition (navigate back) is not as it was before. I wasn't able to reproduce it faithfully, so I ask if you see the same thing.

@rushatgabhane
Copy link
Member Author

rushatgabhane commented Jul 22, 2024

It happens because we go back to the page containing new tax ID, but it does not exist until the Onyx transaction has been complete.

We can't really do much about it 😅

@brunovjk
Copy link
Contributor

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
45866_android_native.mov
Android: mWeb Chrome
45866_android_mweb.mov
iOS: Native
45866_ios_native.mov
iOS: mWeb Safari
45866_ios_mweb.mov
MacOS: Chrome / Safari
45866_web_chorme.mov
MacOS: Desktop
45866_desktop.mov

Copy link

melvin-bot bot commented Jul 24, 2024

We did not find an internal engineer to review this PR, trying to assign a random engineer to #45643 as well as to this PR... Please reach out for help on Slack if no one gets assigned!

@brunovjk
Copy link
Contributor

brunovjk commented Jul 24, 2024

We did not find an internal engineer to review this PR, trying to assign a random engineer to #45643 as well as to this PR... Please reach out for help on Slack if no one gets assigned!

@madmax330 before merge in please check this comment. Thank you :D

@situchan
Copy link
Contributor

@brunovjk please approve PR once more to request review from engineer (@madmax330 was just assigned in linked issue)

@melvin-bot melvin-bot bot requested a review from madmax330 July 24, 2024 21:17
@brunovjk
Copy link
Contributor

thank you @situchan

@rushatgabhane
Copy link
Member Author

@dangrous ready for review

@dangrous dangrous self-requested a review July 25, 2024 17:59
dangrous
dangrous previously approved these changes Jul 25, 2024
Copy link
Contributor

@dangrous dangrous left a comment

Choose a reason for hiding this comment

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

LGTM!

@dangrous dangrous removed the request for review from madmax330 July 25, 2024 18:32
@dangrous
Copy link
Contributor

Before merging....

Re the weird behavior, can we delay navigating back to the page until after the onyx has been updated with the optimistic value?

@dangrous
Copy link
Contributor

Bumping the above question ^

Also, conflicts now, sorry!

@rushatgabhane
Copy link
Member Author

rushatgabhane commented Jul 29, 2024

Re the weird behavior, can we delay navigating back to the page until after the onyx has been updated with the optimistic value?

using setTimeout? yes we can but should we? it would be a workaround

@rushatgabhane
Copy link
Member Author

@brunovjk it'd be great if you could re-review web just to make sure things are working. the merge conflict was a big one

@brunovjk
Copy link
Contributor

Sure :D I will review it today. @rushatgabhane can you fix the type/lint errors? Thank you.

@dangrous
Copy link
Contributor

Yeah I guess we can see how annoying it is in production, I agree we shouldn't just add a timeout, probably. Is it worth bringing up in Slack to see if anyone has good ideas to minimize the flashing?

(And happy to approve this once the lint/typescript issues are fixed!)

@rushatgabhane
Copy link
Member Author

rushatgabhane commented Jul 30, 2024

We can convert the edit tax code command to API_WITH_SIDE_EFFECTS. This will allow us to navigate only after the promise is complete

Let me try it out

@rushatgabhane
Copy link
Member Author

rushatgabhane commented Jul 30, 2024

Looks like someone already fixed it on main.

They modified the taxID in url whenever tax code changed. PR: https://github.com/Expensify/App/pull/45983/files

Screen.Recording.2024-07-30.at.19.13.23.mov

@rushatgabhane
Copy link
Member Author

@brunovjk ready for a quick re-test

@brunovjk
Copy link
Contributor

Nice!! Sure, give me a moment, I'll re-test after lunch. Thanks.

@rushatgabhane
Copy link
Member Author

nice nice its dinner time in bahrain : )

Copy link
Contributor

@brunovjk brunovjk left a comment

Choose a reason for hiding this comment

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

I re-tested it and now it all looks good to me.

Copy link
Contributor

@dangrous dangrous left a comment

Choose a reason for hiding this comment

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

great! LGTM

@dangrous dangrous merged commit 49f0958 into Expensify:main Jul 30, 2024
16 checks passed
@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.

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/dangrous in version: 9.0.15-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Aug 2, 2024

🚀 Deployed to production by https://github.com/roryabraham in version: 9.0.15-9 🚀

platform result
🤖 android 🤖 failure ❌
🖥 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