[Payment card / Subscription] Implement changing plan actions #43029

JKobrynski · 2024-06-04T12:40:39Z

Details

To access this newly created component, paste the following link into the browser

https://dev.new.expensify.com:8082/settings/subscription

or add this effect to InitialSettingsPage.tsx

useEffect(() => {
    Navigation.navigate(ROUTES.SETTINGS_SUBSCRIPTION)
}, [])

Fixed Issues

$ #38622
PROPOSAL: N/A

Tests

Log into the app using an account that has a Collect/Control workspace
Navigate to the Subscription Settings page (see Details section above for instructions)
Verify if you can change your subscription plan in the Subscription details section from PPU to annual (changing from annual to PPU may fail without feedback at this point, that's okay)
Log out and back in to double check if the plan was changed

Verify that no errors appear in the JS console

Offline tests

Same as Tests section above, except the log out/in part

QA Steps

Same as Tests section 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

It's disabled on native Android

Android: mWeb Chrome

chrome-compressed.webm

iOS: Native

It's disabled on native iOS

iOS: mWeb Safari

safari-compressed.mp4

MacOS: Chrome / Safari

web-compressed.mov

MacOS: Desktop

desktop-compressed.mov

melvin-bot · 2024-06-05T09:10:35Z

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

mananjadhav · 2024-06-05T10:06:11Z

Does this need C+ review?

JKobrynski · 2024-06-05T11:42:38Z

@mananjadhav not sure, @amyevans can you help here? 🙏

trjExpensify · 2024-06-05T12:03:21Z

@mananjadhav why would you think it doesn't need C+?

mananjadhav · 2024-06-05T12:21:21Z

@mananjadhav why would you think it doesn't need C+?

Because it was reviewed by two folks from the agency.

JKobrynski · 2024-06-05T14:21:46Z

@mananjadhav it's the standard procedure for the vast majority of our PRs, so if that's the question then yes, it does need a C+ review 😄

trjExpensify · 2024-06-05T14:28:42Z

Yep, jump on it Manan! Your 👀 and ✅ are desired here.. 😄

mananjadhav · 2024-06-05T14:33:46Z

I reviewed the code, testing it now.

mananjadhav · 2024-06-05T14:39:56Z

@JKobrynski @amyevans We're not throwing an error if the API fails. Also I am not sure what the offline behavior is. It says same behavior as Tests.

plan-change.mov

amyevans · 2024-06-05T14:56:08Z

Offline behavior: pattern B - you should be able to switch between plan types offline optimistically but it will be greyed out at 50% opacity until back online.

We need to display a RBR if the API returns an error

mananjadhav · 2024-06-05T14:57:58Z

Thanks for confirmation @JKobrynski Can you please fix this and ping once done?

mananjadhav · 2024-06-06T10:49:29Z

@JKobrynski Based on the message from Eugene, I think the RBR will be added in #42431.

So I think we can do one final review by @Expensify/design before we can finish the checklist.

mananjadhav · 2024-06-07T13:40:55Z

The UI looks good to me, and I've one small change on the code. I'll work on the checklist anyway and pending completion based on the change.

amyevans · 2024-06-07T15:56:53Z

src/libs/API/types.ts

@@ -443,6 +444,8 @@ type WriteCommandParameters = {
 [WRITE_COMMANDS.SEND_INVOICE]: Parameters.SendInvoiceParams;
 [WRITE_COMMANDS.PAY_INVOICE]: Parameters.PayInvoiceParams;
 [WRITE_COMMANDS.MARK_AS_CASH]: Parameters.MarkAsCashParams;
+


Suggested change

amyevans · 2024-06-07T16:08:53Z

src/libs/actions/Subscription.ts

+ onyxMethod: Onyx.METHOD.MERGE,
+ key: ONYXKEYS.NVP_PRIVATE_SUBSCRIPTION,
+ value: {
+ type,


We don't want to save the wrong type if it fails, it should restore to the existing value

JKobrynski · 2024-06-10T06:22:54Z

@amyevans @mananjadhav PR updated!

mananjadhav · 2024-06-10T06:59:18Z

Thanks @JKobrynski. I’ll be able to review this in 1-2 hours

mananjadhav · 2024-06-10T17:19:22Z

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

mweb-chrome-subscription-plan-change.mov

iOS: Native

iOS: mWeb Safari

mweb-safari-subscription-plan-change.mov

MacOS: Chrome / Safari

web-subscription-plan-change.mov

MacOS: Desktop

desktop-subscription-plan-change.mov

mananjadhav · 2024-06-10T17:20:15Z

@JKobrynski One last comment if you could replace the mobile web screenshots showing the stacked view. Rest all looks good.

amyevans

1 last thing related to the failure case, otherwise good to go

amyevans · 2024-06-10T18:12:01Z

src/libs/actions/Subscription.ts

+ value: {
+ pendingAction: null,
+ },


Sorry, just to expand on what I mentioned earlier - to restore to the existing value type value upon failure, we need to set the existing value here. So you could either pass that into the function, or since there's only 2 options, do something like

type: type === CONST.SUBSCRIPTION.TYPE.ANNUAL ? CONST.SUBSCRIPTION.TYPE.PAYPERUSE : CONST.SUBSCRIPTION.TYPE.ANNUAL,

Current behavior if I force an error:

incorrect-failure-data.mov

Ohh sorry I misread too! Thanks for clarifying.

JKobrynski · 2024-06-11T06:50:33Z

@amyevans @mananjadhav PR updated 🫡

mananjadhav · 2024-06-11T07:02:22Z

src/libs/actions/Subscription.ts

+ {
+ onyxMethod: Onyx.METHOD.MERGE,
+ key: ONYXKEYS.NVP_PRIVATE_SUBSCRIPTION,
+ value: {


@amyevans Should we set errors key here?

Nope those would get populated by the API response

amyevans

Looks good, however there's a conflict to resolve @JKobrynski

JKobrynski · 2024-06-12T12:39:52Z

@amyevans conflict resolved!

amyevans · 2024-06-12T13:14:26Z

Looks like we want to wait for @dannymcclain's input in this thread so I'll hold on that before merging

dannymcclain · 2024-06-12T13:16:33Z

Just saw this—I agree with Shawn's suggested changes!

amyevans

🚀

OSBotify · 2024-06-12T16:25:26Z

✋ 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 · 2024-06-14T23:03:34Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.83-3 🚀

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

JKobrynski added 3 commits June 4, 2024 14:28

implement changing plan action, create a reusable SubscriptionType type

aa2564d

Merge branch 'main' into implementChangingPlanActions

177f2b3

remove policyID param from write command, remove useSubscriptionID hook

783689c

JKobrynski force-pushed the implementChangingPlanActions branch from f8623b5 to 783689c Compare June 4, 2024 16:22

Merge branch 'main' into implementChangingPlanActions

132ef5c

pasyukevich approved these changes Jun 5, 2024

View reviewed changes

JKobrynski marked this pull request as ready for review June 5, 2024 09:10

JKobrynski requested a review from a team as a code owner June 5, 2024 09:10

melvin-bot bot requested review from mananjadhav and removed request for a team June 5, 2024 09:10

This was referenced Jun 5, 2024

[Hold for payment 2024-06-21] [Payment card / Subscription] Implement changing plan actions #38622

Closed

[HOLD for payment 2024-06-28] [Payment card / Subscription] Integrate “Subscription settings” section with backend data #38627

Closed

fabioh8010 approved these changes Jun 5, 2024

View reviewed changes

JKobrynski mentioned this pull request Jun 5, 2024

[Payment card / Subscription] Integrate “Subscription details” section with backend data #38624

Closed

JKobrynski added 2 commits June 6, 2024 11:26

add offline B pattern to SubscriptionDetails

dd64c11

add correct background color to SelectCircle for both themes

0d1d9de

JKobrynski requested a review from a team as a code owner June 6, 2024 10:42

add errors to PrivateSubscription type

671f17c

amyevans requested changes Jun 7, 2024

View reviewed changes

apply suggested changes

772f01b

Merge branch 'main' into implementChangingPlanActions

ba689de

mananjadhav approved these changes Jun 10, 2024

View reviewed changes

melvin-bot bot requested a review from amyevans June 10, 2024 17:19

mananjadhav mentioned this pull request Jun 10, 2024

implement billing banner #43267

Merged

50 tasks

amyevans reviewed Jun 10, 2024

View reviewed changes

restore the old value on failure when updating subscription type

0289b96

mananjadhav reviewed Jun 11, 2024

View reviewed changes

JKobrynski requested a review from amyevans June 11, 2024 11:12

amyevans previously approved these changes Jun 11, 2024

View reviewed changes

Merge branch 'main' into implementChangingPlanActions

7454d5d

JKobrynski dismissed amyevans’s stale review via 7454d5d June 12, 2024 06:35

JKobrynski added 2 commits June 12, 2024 08:54

remove deprecated selectedOption reference

e36c24f

edit heads up section styles

7a03f59

amyevans mentioned this pull request Jun 12, 2024

[HOLD for payment 2024-07-22] [HOLD for payment 2024-07-17] [Payment card / Subscription] Integrate failed billing scenarios banner with backend data #42431

Closed

amyevans approved these changes Jun 12, 2024

View reviewed changes

amyevans merged commit 073ce7f into Expensify:main Jun 12, 2024
16 checks passed

github-actions bot mentioned this pull request Jun 13, 2024

Deploy Checklist: New Expensify 2024-06-13 #43655

Closed

64 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Payment card / Subscription] Implement changing plan actions #43029

[Payment card / Subscription] Implement changing plan actions #43029

JKobrynski commented Jun 4, 2024 •

edited by amyevans

Loading

melvin-bot bot commented Jun 5, 2024

mananjadhav commented Jun 5, 2024

JKobrynski commented Jun 5, 2024 •

edited

Loading

trjExpensify commented Jun 5, 2024

mananjadhav commented Jun 5, 2024

JKobrynski commented Jun 5, 2024

trjExpensify commented Jun 5, 2024

mananjadhav commented Jun 5, 2024

mananjadhav commented Jun 5, 2024

amyevans commented Jun 5, 2024

mananjadhav commented Jun 5, 2024

mananjadhav commented Jun 6, 2024

mananjadhav commented Jun 7, 2024

amyevans Jun 7, 2024

amyevans Jun 7, 2024

JKobrynski commented Jun 10, 2024

mananjadhav commented Jun 10, 2024

mananjadhav commented Jun 10, 2024

mananjadhav commented Jun 10, 2024

amyevans left a comment

amyevans Jun 10, 2024

mananjadhav Jun 10, 2024 •

edited

Loading

JKobrynski commented Jun 11, 2024

mananjadhav Jun 11, 2024

amyevans Jun 11, 2024

amyevans left a comment

JKobrynski commented Jun 12, 2024

amyevans commented Jun 12, 2024

dannymcclain commented Jun 12, 2024

amyevans left a comment

OSBotify commented Jun 12, 2024

OSBotify commented Jun 14, 2024

[Payment card / Subscription] Implement changing plan actions #43029

[Payment card / Subscription] Implement changing plan actions #43029

Conversation

JKobrynski commented Jun 4, 2024 • edited by amyevans Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jun 5, 2024

mananjadhav commented Jun 5, 2024

JKobrynski commented Jun 5, 2024 • edited Loading

trjExpensify commented Jun 5, 2024

mananjadhav commented Jun 5, 2024

JKobrynski commented Jun 5, 2024

trjExpensify commented Jun 5, 2024

mananjadhav commented Jun 5, 2024

mananjadhav commented Jun 5, 2024

amyevans commented Jun 5, 2024

mananjadhav commented Jun 5, 2024

mananjadhav commented Jun 6, 2024

mananjadhav commented Jun 7, 2024

amyevans Jun 7, 2024

Choose a reason for hiding this comment

amyevans Jun 7, 2024

Choose a reason for hiding this comment

JKobrynski commented Jun 10, 2024

mananjadhav commented Jun 10, 2024

mananjadhav commented Jun 10, 2024

Reviewer Checklist

Screenshots/Videos

mananjadhav commented Jun 10, 2024

amyevans left a comment

Choose a reason for hiding this comment

amyevans Jun 10, 2024

Choose a reason for hiding this comment

mananjadhav Jun 10, 2024 • edited Loading

Choose a reason for hiding this comment

JKobrynski commented Jun 11, 2024

mananjadhav Jun 11, 2024

Choose a reason for hiding this comment

amyevans Jun 11, 2024

Choose a reason for hiding this comment

amyevans left a comment

Choose a reason for hiding this comment

JKobrynski commented Jun 12, 2024

amyevans commented Jun 12, 2024

dannymcclain commented Jun 12, 2024

amyevans left a comment

Choose a reason for hiding this comment

OSBotify commented Jun 12, 2024

OSBotify commented Jun 14, 2024

JKobrynski commented Jun 4, 2024 •

edited by amyevans

Loading

JKobrynski commented Jun 5, 2024 •

edited

Loading

mananjadhav Jun 10, 2024 •

edited

Loading