[No QA][Free trial] Implement all Free Trials utility functions #43844

fabioh8010 · 2024-06-17T15:12:49Z

Details

NOTE 1: ReportUtils.findPolicyExpenseChatByPolicyID() won't be implemented in this PR/issue. It makes more sense to be implemented on #43673

NOTE 2: I had to make some TS fixes (commit) because as we are adding new Onyx keys, OnyxUpdate typings is starting to show problems in some situations, more details here.

Fixed Issues

$ #43668
PROPOSAL:

Tests

Run the unit tests with npm test, all tests should pass.

Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

N/A

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

MacOS: Desktop

…nctions

…nyx-keys-and-utility-functions

…e trial logic

…nyx-keys-and-utility-functions

melvin-bot · 2024-06-17T15:18:09Z

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

fabioh8010 · 2024-06-17T15:21:54Z

cc @rojiphil @hoangzinh

src/libs/actions/Policy/Policy.ts

tests/unit/ReportUtilsTest.ts

rojiphil · 2024-06-17T19:32:33Z

src/libs/SubscriptionUtils.ts

+    }
+
+    const currentDate = new Date();
+    const difference = differenceInCalendarDays(parseDate(lastDayFreeTrial, CONST.DATE.FNS_DATE_TIME_FORMAT_STRING, currentDate), currentDate);


Would not difference become 0 when the currentDate is lastDayFreeTrial and be considered as trial ended even when it has not really ended?

Adjusted the logic to calculate with second precision cc @chiragsalian

rojiphil · 2024-06-17T19:34:33Z

src/libs/SubscriptionUtils.ts

+
+    // If it reached here it means that the user is actually the workspace's owner.
+    // We should restrict the workspace's owner actions if it's past its grace period end date and it's owing some amount.
+    if (ownerBillingGraceEndPeriod && amountOwed !== undefined && isAfter(currentDate, fromUnixTime(ownerBillingGraceEndPeriod))) {


Can amountOwed have a value of 0? In that case, it will be considered that the workspace owner owes some amount (as we only have undefined check) thereby restricting user billable actions. This does not seem correct.

Makes sense, I've adjusted but could you confirm @chiragsalian ?

its cool that you accounted for this but no amountOwed cannot be a value of 0. We just delete this entry from the database if its value is 0.

tests/unit/ReportUtilsTest.ts

hoangzinh · 2024-06-18T00:23:57Z

src/libs/SubscriptionUtils.ts

+    if (!firstDayFreeTrial || !lastDayFreeTrial) {
+        return true;
+    }


I think it's an incorrect value when either of those values hasn't been set/loaded yet or user hasn't started the free trial yet.

You are right, adjusted! cc @chiragsalian

tests/unit/SubscriptionUtilsTest.ts

rojiphil

NAB but just found one more minor issue related to description. I have added a suggestion for the same. Please have a look.
Otherwise, I think the code looks super good once we address the above. Thanks.

rojiphil · 2024-06-18T05:11:48Z

src/ONYXKEYS.ts

@@ -376,6 +391,10 @@ const ONYXKEYS = {

        // Search Page related
        SNAPSHOT: 'snapshot_',
+
+        // Shared NVPs
+        /** Collection of objects where each objects represents a workspace’s owner which is past due billing AND the user is a member of. */


Would this sound better?

Suggested change

/** Collection of objects where each objects represents a workspace’s owner which is past due billing AND the user is a member of. */

/** Collection of objects where each object represents a workspace’s non-owner(normal users and admins) who is member of a workspace where the owner is past due billing. */

@rojiphil That is not true, each object represents the workspace owner where the user is member of. I've changed to Collection of objects where each object represents the owner of the workspace that is past due billing AND the user is a member of. Wdyt?

Ah! You are right. It makes sense too.

…nyx-keys-and-utility-functions

rojiphil · 2024-06-18T18:08:05Z

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

Run Test

20240618_233413.mp4

MacOS: Chrome / Safari

NA

MacOS: Desktop

NA

Android: Native

NA

Android: mWeb Chrome

NA

iOS: Native

NA

iOS: mWeb Safari

NA

rojiphil

Changes LGTM. Also unit tests run well. Thanks @fabioh8010

melvin-bot · 2024-06-18T18:12:14Z

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

rojiphil · 2024-06-18T19:08:53Z

@aldo-expensify Are you the internal engineer here? The comment here seems to suggest so.

aldo-expensify · 2024-06-18T19:14:02Z

@aldo-expensify Are you the internal engineer here? The comment here seems to suggest so.

I believe so, unless this is supposed to be handled by someone more familiar with the project

hoangzinh

LGTM

melvin-bot · 2024-06-18T20:26:06Z

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

trjExpensify · 2024-06-19T00:21:21Z

@chiragsalian can you review this?

chiragsalian

Nice, the code LGTM

chiragsalian · 2024-06-19T17:48:46Z

src/libs/ReportUtils.ts

+/**
+ * Whether the report is a system chat or concierge chat, depending on the user's account ID.
+ */
+function isChatUsedForOnboarding(report: OnyxEntry<Report>): boolean {


NAB: we should add some context that these are used for A/B testing because it could be rather confusing for anyone reading this that we're doing different logic depending on whether accountID is odd or even.

chiragsalian · 2024-06-19T17:55:35Z

Cool looks like all the comments are handled. My NAB can be addressed in a follow-up, merging.

OSBotify · 2024-06-19T18:05:44Z

✋ 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-19T21:53:16Z

🚀 Deployed to staging by https://github.com/chiragsalian in version: 1.4.86-0 🚀

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

OSBotify · 2024-06-19T22:17:58Z

🚀 Deployed to staging by https://github.com/chiragsalian in version: 1.4.86-0 🚀

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

OSBotify · 2024-06-19T22:51:57Z

🚀 Deployed to staging by https://github.com/chiragsalian in version: 1.4.86-0 🚀

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

OSBotify · 2024-06-21T21:22:35Z

🚀 Deployed to production by https://github.com/AndrewGable in version: 9.0.0-9 🚀

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

fabioh8010 added 22 commits June 13, 2024 16:57

Add NVP_FIRST_DAY_FREE_TRIAL Onyx key

127d350

Add NVP_LAST_DAY_FREE_TRIAL Onyx key

3aaaac1

Add NVP_BILLING_FUND_ID Onyx key

12fa116

Add NVP_PRIVATE_AMOUNT_OWNED Onyx key

91affbd

Add NVP_PRIVATE_OWNER_BILLING_GRACE_PERIOD_END Onyx key

a8f194f

Add SHARED_NVP_PRIVATE_USER_BILLING_GRACE_PERIOD_END Onyx key

9f41e9b

Implement isChatUsedForOnboarding() and getChatUsedForOnboarding() fu…

3127c9d

…nctions

Add descriptive comment to isSystemChat() function

4eb8d41

Implement SubscriptionUtils.calculateRemainingFreeTrialDays() function

92ba0c8

Improve ReportUtilsTest tests

ce591a3

Implement SubscriptionUtils.isUserOnFreeTrial() function

ac22ed8

Implement SubscriptionUtils.hasUserFreeTrialEnded() function

c012ed3

Implement SubscriptionUtils.doesUserHavePaymentCardAdded() function

ccd5758

Implement SubscriptionUtils.shouldRestrictUserBillableActions() function

5fa1f17

Improve shouldRestrictUserBillableActions() logic

8e27a71

Fix TS errors

52074be

Merge remote-tracking branch 'origin/main' into feature/free-trials/o…

dbec623

…nyx-keys-and-utility-functions

Prettier

0cf96d7

Changes ReportUtils.requiresAttentionFromCurrentUser() to include fre…

35e9bba

…e trial logic

Merge remote-tracking branch 'origin/main' into feature/free-trials/o…

a3e1c4a

…nyx-keys-and-utility-functions

Add another test for ReportUtils.requiresAttentionFromCurrentUser()

7eb5a07

Merge remote-tracking branch 'origin/main' into feature/free-trials/o…

cfd25ee

…nyx-keys-and-utility-functions

fabioh8010 marked this pull request as ready for review June 17, 2024 15:18

fabioh8010 requested a review from a team as a code owner June 17, 2024 15:18

melvin-bot bot requested review from hoangzinh and removed request for a team June 17, 2024 15:18

fabioh8010 mentioned this pull request Jun 17, 2024

[HOLD for payment 2024-06-28] [Free trial] Implement all Free Trials utility functions #43668

Closed

Prettier fix

7b5456d

pac-guerreiro reviewed Jun 17, 2024

View reviewed changes

src/libs/actions/Policy/Policy.ts Show resolved Hide resolved

pac-guerreiro reviewed Jun 17, 2024

View reviewed changes

tests/unit/ReportUtilsTest.ts Show resolved Hide resolved

pac-guerreiro approved these changes Jun 17, 2024

View reviewed changes

rojiphil reviewed Jun 17, 2024

View reviewed changes

hoangzinh reviewed Jun 18, 2024

View reviewed changes

rojiphil reviewed Jun 18, 2024

View reviewed changes

fabioh8010 added 2 commits June 18, 2024 16:35

Merge remote-tracking branch 'origin/main' into feature/free-trials/o…

903a6c6

…nyx-keys-and-utility-functions

Address review comments

9954f49

fabioh8010 requested review from rojiphil and hoangzinh June 18, 2024 16:51

rojiphil approved these changes Jun 18, 2024

View reviewed changes

hoangzinh approved these changes Jun 18, 2024

View reviewed changes

chiragsalian self-requested a review June 19, 2024 17:16

chiragsalian approved these changes Jun 19, 2024

View reviewed changes

chiragsalian merged commit 765127b into Expensify:main Jun 19, 2024
19 of 26 checks passed

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

Deploy Checklist: New Expensify 2024-06-19 #44047

Closed

59 tasks

rojiphil mentioned this pull request Jun 20, 2024

[Free trial] Implement and show Pre-Trial banner in the App during Pre-Trial #43982

Merged

50 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[No QA][Free trial] Implement all Free Trials utility functions #43844

[No QA][Free trial] Implement all Free Trials utility functions #43844

fabioh8010 commented Jun 17, 2024

melvin-bot bot commented Jun 17, 2024

fabioh8010 commented Jun 17, 2024

rojiphil Jun 17, 2024

fabioh8010 Jun 18, 2024

rojiphil Jun 17, 2024

fabioh8010 Jun 18, 2024

chiragsalian Jun 19, 2024

hoangzinh Jun 18, 2024

fabioh8010 Jun 18, 2024

rojiphil left a comment

rojiphil Jun 18, 2024

fabioh8010 Jun 18, 2024

rojiphil Jun 18, 2024

rojiphil commented Jun 18, 2024

rojiphil left a comment

melvin-bot bot commented Jun 18, 2024

rojiphil commented Jun 18, 2024

aldo-expensify commented Jun 18, 2024

hoangzinh left a comment

melvin-bot bot commented Jun 18, 2024

trjExpensify commented Jun 19, 2024

chiragsalian left a comment

chiragsalian Jun 19, 2024

chiragsalian commented Jun 19, 2024

OSBotify commented Jun 19, 2024

OSBotify commented Jun 19, 2024

OSBotify commented Jun 19, 2024

OSBotify commented Jun 19, 2024

OSBotify commented Jun 21, 2024

	/** Collection of objects where each objects represents a workspace’s owner which is past due billing AND the user is a member of. */
	/** Collection of objects where each object represents a workspace’s non-owner(normal users and admins) who is member of a workspace where the owner is past due billing. */

[No QA][Free trial] Implement all Free Trials utility functions #43844

[No QA][Free trial] Implement all Free Trials utility functions #43844

Conversation

fabioh8010 commented Jun 17, 2024

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jun 17, 2024

fabioh8010 commented Jun 17, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rojiphil left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rojiphil commented Jun 18, 2024

Reviewer Checklist

Screenshots/Videos

rojiphil left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Jun 18, 2024

rojiphil commented Jun 18, 2024

aldo-expensify commented Jun 18, 2024

hoangzinh left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Jun 18, 2024

trjExpensify commented Jun 19, 2024

chiragsalian left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chiragsalian commented Jun 19, 2024

OSBotify commented Jun 19, 2024

OSBotify commented Jun 19, 2024

OSBotify commented Jun 19, 2024

OSBotify commented Jun 19, 2024

OSBotify commented Jun 21, 2024