Add Tax Exempt to Subscription

[narefyev91]

Details

Add Tax Exempt request flow to NewDot

Current PR is not covering middle stage - when Concierge is approving pdf. To check that flag is setting correctly in onyx
just add
Onyx.merge(ONYXKEYS.NVP_PRIVATE_TAX_EXEMPT, true);
here (for testing purpose)

Fixed Issues

$ #45317
PROPOSAL:

Tests

1. Open new.expensify.com/settings/subscriptions
2. Click "Request tax exempt status" button
3. Land in Concierge DM & Receive "I have received your request to set your account as tax exempt. Please attach a PDF of either your 501(c) or ST-119 here. Once that has been received and accepted, I'll get back to you here." message
4. Provide 501(c) or ST-119 proof, send to Concierge
5. Concierge marks account as tax exempt in Supportal
6. Verify that a tax exempt badge in new.expensify.com/settings/subscriptions

• Verify that no errors appear in the JS console

Offline tests

1. Open new.expensify.com/settings/subscriptions
2. Click "Request tax exempt status" button
3. Land in Concierge DM

QA Steps

1. Open new.expensify.com/settings/subscriptions
2. Click "Request tax exempt status" button
3. Land in Concierge DM & Receive "I have received your request to set your account as tax exempt. Please attach a PDF of either your 501(c) or ST-119 here. Once that has been received and accepted, I'll get back to you here." message
4. Provide 501(c) or ST-119 proof, send to Concierge
5. Concierge marks account as tax exempt in Supportal
6. Verify that a tax exempt badge in new.expensify.com/settings/subscriptions

• 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
  • [x 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

android-web.mov

iOS: Native

iOS: mWeb Safari

ios-web.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

[melvin-bot]

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

[narefyev91]

@Expensify/design can i get a review for UI please. More like for Settings details row (header)

[shawnborton]

I think that looks pretty good to me. Does the overflow icon stay "highlighted" once the popover is active, like this example in Wallet > Bank accounts?

And I assume the badge will only show up once we get the flag from the BE that the account is tax-exempt?

[narefyev91]

I think that looks pretty good to me. Does the overflow icon stay "highlighted" once the popover is active, like this example in Wallet > Bank accounts?

And I assume the badge will only show up once we get the flag from the BE that the account is tax-exempt?

yeah - using standard component which we already have

[shawnborton]

Yeah sorry, my question is that in some places of the app, when you press the overflow icon, it stays green while the menu is open (see my screenshot). But maybe we don't do that everywhere. Any ideas?

[dannymcclain]

Looking good to me too. I agree with Shawn about the three-dot icon being highlighted when the menu is open. Not critically necessary, but if we can make it match that Wallet example I think that'd be nice. But yeah, as Shawn pointed out, I'm not sure that behavior is totally consistent throughout the app (it doesn't happen in the workspace list for example).

Also, should we remove the three-dot menu once they have tax-exempt status? Or do we need to leave it and change the menu item? (No idea what it would be if they've already requested tax-exemption.)

[shawnborton]

That's a great point... @trjExpensify any thoughts there? When the tax exempt status is in place, do we just get rid of the overflow or change the option to be something like "Remove tax exempt status"? No idea if anyone would ever want/need to do that though.

[narefyev91]

Looking good to me too. I agree with Shawn about the three-dot icon being highlighted when the menu is open. Not critically necessary, but if we can make it match that Wallet example I think that'd be nice. But yeah, as Shawn pointed out, I'm not sure that behavior is totally consistent throughout the app (it doesn't happen in the workspace list for example).

Also, should we remove the three-dot menu once they have tax-exempt status? Or do we need to leave it and change the menu item? (No idea what it would be if they've already requested tax-exemption.)

Yeah when tax-exempt exists we will not shown 3 dots - it's just screenshot to see all UI elements at once :-)

[narefyev91]

@shawnborton @dannymcclain do we want to make 3 dots being highlighted globally? Just to make it the same for all pages?
If we already have some inconsistency between pages - does it make sense to unified?

[shawnborton]

I think we should unify the behavior globally, yes. Do you know why it's currently inconsistent though?

[narefyev91]

I think we should unify the behavior globally, yes. Do you know why it's currently inconsistent though?

Probably we do not implement logic to switch color - and as i see for Wallet page - it's a custom component not global . I can just add logic for changing color of icon if popover is open in one place - and all pages will reflect that

[dannymcclain]

Awesome. I think that'd be great.

[narefyev91]

Awesome. I think that'd be great.

Cool - will add as a first thing tomorrow - and will add screenshots

[narefyev91]

@shawnborton @dannymcclain here we go:

[shawnborton]

Looks good to me!

[dannymcclain]

Looks good to me!

Same! 🚀

[hoangzinh]

Bug 1: "Subscription details" title text is not bold

[hoangzinh]

Bug 2: The menu "Request tax exempt status" in Spanish is not full

[narefyev91]

@hoangzinh fixed both bugs above!

[shawnborton]

Can you share an updated screenshot please? Thanks!

[narefyev91]

Can you share an updated screenshot please? Thanks!

[shawnborton]

Nice, that looks good to me.

[marcaaron]

Looking great so far. Had a small nit, but don't see any major blockers. 🚀

[hoangzinh]

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

Screen.Recording.2024-07-30.at.16.47.19.android.chrome.mov

iOS: Native

iOS: mWeb Safari

Screen.Recording.2024-07-30.at.16.53.12.ios.safari.mov

MacOS: Chrome / Safari

Screen.Recording.2024-07-30.at.16.41.30.web.mov

MacOS: Desktop

Screen.Recording.2024-07-30.at.16.44.00.desktop.mov

[hoangzinh]

@narefyev91 can you add screenshots for native android/ios as well? Just to ensure we don't break existing UI on those native platforms. Also, can you check again "Offline tests"? There are some steps that we can't do when offline.

[narefyev91]

@narefyev91 can you add screenshots for native android/ios as well? Just to ensure we don't break existing UI on those native platforms. Also, can you check again "Offline tests"? There are some steps that we can't do when offline.

Probably for offline - we just can only lands on concierge chat and waiting until user gets online. (updated)
Added IOS screenshot, waiting for android to be build

[hoangzinh]

LGTM

[marcaaron]

LGTM 🎉

[OSBotify]

🚀 Deployed to staging by https://github.com/marcaaron in version: 9.0.15-4 🚀

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

[kavimuru]

@marcaaron @hoangzinh How should we run the following?

Land in Concierge DM & Receive "I have received your request to set your account as tax exempt. Please attach a PDF of either your 501(c) or ST-119 here. Once that has been received and accepted, I'll get back to you here." message
Provide 501(c) or ST-119 proof, send to Concierge
Concierge marks account as tax exempt in Supportal

[hoangzinh]

5. Concierge marks account as tax exempt in Supportal

To do this step, as described in the PR description, I think we can open Chrome dev tools and paste this code

window.Onyx.merge('nvp_private_taxExempt', true);

[kavimuru]

@hoangzinh what about step 4 Provide 501(c) or ST-119 proof, send to Concierge

[marcaaron]

This requires supportal access - but I just tested it on staging and we can check it off.

[OSBotify]

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

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