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

feat: subscription size action #43122

Merged
merged 10 commits into from
Jun 11, 2024

Conversation

MrMuzyk
Copy link
Contributor

@MrMuzyk MrMuzyk commented Jun 5, 2024

Details

Added navigation action when pressing subscription size button

Fixed Issues

$ #38625
PROPOSAL:

Tests

  • go to subscription settings page
  • press on subscription size button
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

No QA

  • 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

n/a

Android: mWeb Chrome
subscription-updated-android.mp4
iOS: Native

n/a

iOS: mWeb Safari
subscription-updated-ios.mp4
MacOS: Chrome / Safari
subscription-updated.mp4
subscription-updated-light.mp4
MacOS: Desktop

n/a

@MrMuzyk MrMuzyk marked this pull request as ready for review June 5, 2024 13:51
@MrMuzyk MrMuzyk requested a review from a team as a code owner June 5, 2024 13:51
@melvin-bot melvin-bot bot requested review from ahmedGaber93 and removed request for a team June 5, 2024 13:51
Copy link

melvin-bot bot commented Jun 5, 2024

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

@trjExpensify trjExpensify requested review from allroundexperts and removed request for ahmedGaber93 June 5, 2024 14:05
@allroundexperts
Copy link
Contributor

allroundexperts commented Jun 5, 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

N/A

Android: mWeb Chrome
Screen.Recording.2024-06-05.at.7.31.56.PM.mov
iOS: Native

N/A

iOS: mWeb Safari
Screen.Recording.2024-06-05.at.7.29.34.PM.mov
MacOS: Chrome / Safari
Screen.Recording.2024-06-05.at.7.21.39.PM.mov
MacOS: Desktop
Screen.Recording.2024-06-05.at.7.25.48.PM.mov

@trjExpensify
Copy link
Contributor

@allroundexperts assigned you!

@allroundexperts
Copy link
Contributor

@trjExpensify Is this change for web only? On Android, I'm getting the following:

Screen.Recording.2024-06-05.at.7.44.57.PM.mov

@trjExpensify
Copy link
Contributor

trjExpensify commented Jun 5, 2024

@trjExpensify Is this change for web only? On Android, I'm getting the following:

Screen.Recording.2024-06-05.at.7.44.57.PM.mov

Yeah, due to the Google and Apple overlords we can't let you manage your subscription size on native iOS or Android. 🙄 Meaning, the subscription size page to set a subscription size is not accessible.

style={styles.mt5}
/>
) : (
// This section is only shown when the subscription is annual
Copy link
Contributor

Choose a reason for hiding this comment

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

This section is visible even if the subscription type is not annual:

Screen.Recording.2024-06-05.at.7.50.19.PM.mov

Copy link
Contributor

Choose a reason for hiding this comment

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

Ah, I guess it does not show up if the set subscription is not annual.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Condition was checking it against data coming straight from the API. Because change is only happening on FE now (API call will be implemented in the next phase) it was not working as expected. I've updated the condition to check it against the selectedOption that we store inside state of the component. It should work as expected now.

@trjExpensify
Copy link
Contributor

@trjExpensify Is this change for web only? On Android, I'm getting the following:

Screen.Recording.2024-06-05.at.7.44.57.PM.mov

On this though. If you have a subscription size set, it should be read-only and visible on native. Not sure where @MrMuzyk is at with that one, but here for illustration:

image

@allroundexperts
Copy link
Contributor

@trjExpensify Is this change for web only? On Android, I'm getting the following:
Screen.Recording.2024-06-05.at.7.44.57.PM.mov

On this though. If you have a subscription size set, it should be read-only and visible on native. Not sure where @MrMuzyk is at with that one, but here for illustration:

image

I think my subscription size is set to 0. That is why its not showing, I think.

Copy link
Contributor

@allroundexperts allroundexperts left a comment

Choose a reason for hiding this comment

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

Changes are looking good. One small comment. Also, I'm assuming that this is design approved?

@melvin-bot melvin-bot bot requested a review from amyevans June 5, 2024 15:03
@trjExpensify
Copy link
Contributor

Also, I'm assuming that this is design approved?

This PR hasn't had anyone from design on it. @Expensify/design someone want to take a quick looksie? 👀

@dannymcclain
Copy link
Contributor

Can't seem to get this running locally (it's always something 😅) but I have a few questions about the videos/screenshots. It looks like this PR is specific to the subscription size RHP, so please forgive me if any of these are being handled elsewhere!

In this one, why don't these cards have a max-width?
CleanShot 2024-06-05 at 10 41 53@2x

I believe the button on this second screen should be Save, not Next, as I think at this point you're committing your changes.
CleanShot 2024-06-05 at 10 44 05@2x

These radios do not look properly styled in light mode—this looks like the dark mode styles.
CleanShot 2024-06-05 at 10 46 44@2x

They should look like this in light mode:
image

Super tiny, but we need a : at the end of the top sentence here. It should read Confirm your new annual subscription details:
CleanShot 2024-06-05 at 10 48 37@2x

@shawnborton
Copy link
Contributor

Good catch on all of those Danny!

For the radio buttons, don't those already exist as a component and they work already across light and dark modes? I hope we aren't rewriting them!

@MrMuzyk MrMuzyk requested a review from a team as a code owner June 6, 2024 08:32
@MrMuzyk
Copy link
Contributor Author

MrMuzyk commented Jun 6, 2024

In this one, why don't these cards have a max-width?

We must've missed that, adding it now.
It is already being fixed here

image

I believe the button on this second screen should be Save, not Next, as I think at this point you're committing your changes

Super tiny, but we need a : at the end of the top sentence here. It should read Confirm your new annual subscription details:

I've assumed its a mistake and did set it to Save. Also added that :

image

These radios do not look properly styled in light mode—this looks like the dark mode styles.

For the radio buttons, don't those already exist as a component and they work already across light and dark modes? I hope we aren't rewriting them!

Fixed them, we had one unnecessary style added to them. Should look fine now

image

@shawnborton
Copy link
Contributor

Can we get some updated screenshots/videos to review? Thanks!

isChecked={isSelected}
selectCircleStyles={styles.sectionSelectCircle}
/>
<SelectCircle isChecked={isSelected} />
Copy link
Contributor

Choose a reason for hiding this comment

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

Have you checked if it looks like it should on both themes? E.g like this for dark theme

Screenshot 2024-06-06 at 14 45 57

I haven't ran your code but I made that change on my branch and the background is too dark

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 wasn't aware that it's too dark now. I've reverted it to default state that should work for both platforms. Changing it again so its fine on both themes

@MrMuzyk MrMuzyk requested a review from JKobrynski June 6, 2024 13:51
@MrMuzyk
Copy link
Contributor Author

MrMuzyk commented Jun 6, 2024

@shawnborton I've updated PR description with a few videos. I didn't include native as this button to change subscription size is not visible on these platforms

@dannymcclain
Copy link
Contributor

Ok, I think I understand... But I think there's a difference between unset and set to 0. So we need to figure out how this push input should be displayed:

image

In my mind, unset means that subscription size has NO value—the value is essentially null/undefined/non-existent. Set to 0 means the subscription size has a value and that value is 0. Have I just made this worse/more confusing?

@trjExpensify
Copy link
Contributor

In my mind, unset means that subscription size has NO value—the value is essentially null/undefined/non-existent

I think a user will think this way as well, personally. Especially as you can't opt-in for a subscription size of 0.

Copy link
Contributor

github-actions bot commented Jun 6, 2024

@MrMuzyk
Copy link
Contributor Author

MrMuzyk commented Jun 7, 2024

I agree that there is a difference between unset value and 0. At the moment it was set to 0. I can change it to an empty string so it is displayed different. Does it look better?

default.value.mov

@trjExpensify
Copy link
Contributor

I think that looks better to me! @shawnborton @dannymcclain?

@flodnv
Copy link
Contributor

flodnv commented Jun 7, 2024

You can only set a subscription of 1 or higher and you can't change it to 0. That said, I think since this PR, the subscription size can exist "unset" at 0 if it's before they've taken a billable action. In which case, it would appear as 0 until they set a subscription size, or take a billable action and we set it to 1 (minimally, could be more if there are multiple actors). @flodnv as the PR author can perhaps double confirm.

IIRC it's possible that the existing value is 0 (or unset, which is the same as 0), however a user cannot set it to 0.

@dannymcclain
Copy link
Contributor

I think that looks better to me!

That looks better to me too. The user can open the RHP and decide they don't want to mess with anything and just close it without issue. I think it's good now.

I am ignoring Flo's comment about unset being the same as being set to 0 😂. I think for this purpose, because a user cannot set the value to 0, we can treat it as unset (like what's shown in the updated video) if no specific value from the user has been given.

@allroundexperts
Copy link
Contributor

Looking fine to me:

Screen.Recording.2024-06-07.at.9.02.58.PM.mov
Screen.Recording.2024-06-07.at.9.04.15.PM.mov

@allroundexperts
Copy link
Contributor

@dannymcclain can confirm though from design perspective.

@shawnborton
Copy link
Contributor

Hmm @allroundexperts in your videos, given that a subscription size exists once you open the RHP, I would think the push row would show the subscription size no?

@dannymcclain
Copy link
Contributor

Looking pretty good except in your first video, when you open the subscription size RHP it shows that it has a value of 10. Which means the push input should look like this:
CleanShot 2024-06-07 at 11 08 40@2x

But it's showing as empty instead. Also I think that input should be auto-focused when the RHP opens, right?

Your second video looks good, except the radio options should be stacked for that viewport width, though I'm almost positive that is being handled elsewhere already.

@allroundexperts
Copy link
Contributor

Hmm @allroundexperts in your videos, given that a subscription size exists once you open the RHP, I would think the push row would show the subscription size no?

I think that's not the case. As far as I've understood, those are draft values of the form. Draft values don't show up in the push row.

@MrMuzyk
Copy link
Contributor Author

MrMuzyk commented Jun 10, 2024

Hmm @allroundexperts in your videos, given that a subscription size exists once you open the RHP, I would think the push row would show the subscription size no?

These are draft values being displayed there.

Also I think that input should be auto-focused when the RHP opens, right?

Changing it

@MrMuzyk
Copy link
Contributor Author

MrMuzyk commented Jun 11, 2024

@amyevans Can you review this so we can merge it?

Copy link
Contributor

@amyevans amyevans 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! I'm going to remove the QA steps though since this isn't a fully functional feature at this point

@amyevans amyevans merged commit 1470f6e into Expensify:main Jun 11, 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/amyevans in version: 1.4.82-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.82-4 🚀

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants