Update policyOwnerAmountOwedOverdue billing banner by pasyukevich · Pull Request #58910 · Expensify/App

pasyukevich · 2025-03-21T14:08:49Z

Explanation of Change

Fixed Issues

$ #58067
PROPOSAL:

Tests

mock purchase object


const mockPurchase =            {
                "amount": 0,
                "created": "2024-04-03 22:47:55",
                "currency": "USD",
                "message": {
                    "accountManagerAccountID": 0,
                    "approvedAccountantAccountIDs": [],
                    "approvedSpend": {
                        "USD": 0
                    },
                    "billableAmount": 4158,
                    "billableAmountBeforeFreeTrialDiscount": 5400,
                    "billablePolicies": [],
                    "billingType": "failed_2018",
                    "cardSpendSurchargePercent": 1,
                    "cashBackAmount": 0,
                    "cashBackPercentage": 0,
                    "chatOnlyActorList": "",
                    "corporateActorCount": 0,
                    "corporateRevenue": 5400,
                    "expensifyCardMonthlySpend": 0,
                    "expensifyCardSpend": {
                        "USD": 0
                    },
                    "freeActorCount": 0,
                    "freeTrialDays": 7,
                    "freeTrialDiscountAmount": 1242,
                    "freeTrialDiscountPercentage": 23,
                    "freebieCreditsUsed": 0,
                    "guideAccountID": 0,
                    "isApprovedAccountant": false,
                    "isApprovedAccountantClient": false,
                    "paidActorCount": 0,
                    "partnerManagerAccountID": 0,
                    "perPolicyTotalMembersCount": {
                        "5D3C0526388B7146": 1,
                        "B8777AF8C34D8D73": 8
                    },
                    "potentialCashBackAmount": 0,
                    "potentialCashBackPercentage": 0.01,
                    "subscription": {
                        "addNewUsersAutomatically": false,
                        "autoRenew": true,
                        "autoRenewLastChangedDate": "2024-01-23 20:06:38",
                        "endDate": "2025-03-01",
                        "startDate": "2024-01-01",
                        "type": "yearly2018",
                        "userCount": 3
                    },
                    "teamActorCount": 0,
                    "teamRevenue": 0,
                    "totalActorCount": 0,
                    "totalFreebieCredits": 0,
                    "totalPlatformSpend": 0,
                    "totalRevenue": 4158,
                    "totalUniqueMembersCount": 8,
                    "wasDomainBillingUsed": false,
                    "yearlyOverageSurcharge": 0,
                    "yearlySubscriptionOverageCost": 0,
                    "yearlySubscriptionSurcharge": 2700,
                    "yearlySubscriptionUserCountCost": 2700
                },
                "purchaseID": 53
    };

Edit src/pages/settings/Subscription/CardSection/CardSection.tsx

Replace purchase with mockPurchase

setBillingStatus(
           CardSectionUtils.getBillingStatus({

Update billingBanner with custom

  if (billingStatus) {
        BillingBanner = (
            <SubscriptionBillingBanner
                title={billingStatus.title}
                subtitle={billingStatus.subtitle}
                isError={billingStatus.isError}
                icon={billingStatus.icon}
                rightIcon={billingStatus.rightIcon}
                onRightIconPress={handleBillingBannerClose}
                rightIconAccessibilityLabel={translate('common.close')}
            />
        );
     }

Patch getSubscriptionStatus with early return:

return {
                    isError: true,
                    status: PAYMENT_STATUS.POLICY_OWNER_WITH_AMOUNT_OWED_OVERDUE,
                };

Open the settings page
Navigate to the subscription page
Observe that the banner updated

Verify that no errors appear in the JS console

Offline tests

QA Steps

// TODO: These must be filled out, or the issue title must include "[No QA]."

Assign to @amyevans for Internal QA

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

![android-web](https://github.com/user-attachments/assets/ee5409df-5008-4cfe-85db-0123524fd414)

iOS: Native

![ios-native](https://github.com/user-attachments/assets/78f64412-2ec4-43d8-b0ea-5057b3d6ed16)

iOS: mWeb Safari

![ios-web ](https://github.com/user-attachments/assets/07891e8b-1855-4d72-aa23-e2f5a32c0df0)

MacOS: Chrome / Safari

MacOS: Desktop

…mountOwed in English and Spanish translations

melvin-bot · 2025-03-26T20:33:05Z

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

s77rt · 2025-03-26T21:57:58Z

+            CardSectionUtils.getBillingStatus({
+                translate,
+                accountData: defaultCard?.accountData ?? {},
+                purchase: purchaseList?.[0],
+            }),


Is there a reason we pass just the first purchase?

Yes, accroding to #58067 (comment) we need only the first item for now

s77rt · 2025-03-26T21:58:27Z

    }, []);

-    const [billingStatus, setBillingStatus] = useState<BillingStatusResult | undefined>(() => CardSectionUtils.getBillingStatus(translate, defaultCard?.accountData ?? {}));
+    const [billingStatus, setBillingStatus] = useState<BillingStatusResult | undefined>(() => CardSectionUtils.getBillingStatus({translate, accountData: defaultCard?.accountData ?? {}}));


Shouldn't we pass the purchase here too?

s77rt · 2025-03-26T22:16:15Z

+                generalSubtitle: 'Please add a payment card to clear the amount owed.',
+                subtitle: ({date, purchaseAmountOwed}: BillingBannerOwnerAmountOwedOverdueParams) =>
+                    `Your ${date} charge of ${purchaseAmountOwed} could not be processed. Please add a payment card to clear the amount owed.`,


Can we remove the generalSubtitle variant and just make the props optional?

…rdSection

…emove getPurchaseDetails function

…rameters

…de date and amount owed

s77rt · 2025-03-28T17:09:54Z

+    it('should return POLICY_OWNER_WITH_AMOUNT_OWED_OVERDUE variant with generalSubtitle', () => {
+        mockGetSubscriptionStatus.mockReturnValue({
+            status: PAYMENT_STATUS.POLICY_OWNER_WITH_AMOUNT_OWED_OVERDUE,
+        });
+
+        expect(CardSectionUtils.getBillingStatus({translate: translateMock, accountData: ACCOUNT_DATA, purchase: undefined})).toEqual({
+            title: 'subscription.billingBanner.policyOwnerAmountOwedOverdue.title',
+            subtitle: 'subscription.billingBanner.policyOwnerAmountOwedOverdue.generalSubtitle',
+            isError: true,
+            isRetryAvailable: true,
+        });
+    });


Remove this test (no longer valid)

s77rt · 2025-03-28T17:34:22Z

Many fields are optional, here is sample

{ "amount": 0, "created": "2025-03-01 03:32:13", "currency": "USD", "message": { "accountManagerAccountID": 0, "approvedAccountantAccountIDs": [], "approvedSpend": { "USD": 0 }, "billableAmount": 2700, "billablePolicies": { "0680EF3C70411F57": { "actorList": "admin+testc@abdelhafidh.com", "approvedSpend": { "USD": 0 }, "corporate": true, "expensifyCardSpend": { "USD": 0 }, "type": "corporate" }, "8970B100A18A2CD6": { "actorList": "admin+testc@abdelhafidh.com", "approvedSpend": { "USD": 0 }, "corporate": true, "expensifyCardSpend": { "USD": 0 }, "type": "corporate" }, "8ECD8C2EBB39933F": { "actorList": "admin+testc@abdelhafidh.com", "approvedSpend": { "USD": 0 }, "corporate": true, "expensifyCardSpend": { "USD": 0 }, "type": "corporate" }, "978C2546B3751E81": { "actorList": "admin+testc@abdelhafidh.com", "approvedSpend": { "USD": 0 }, "corporate": false, "expensifyCardSpend": { "USD": 0 }, "type": "team" }, "CDD878B939EB631E": { "actorList": "admin+testc@abdelhafidh.com", "approvedSpend": { "USD": 0 }, "corporate": true, "expensifyCardSpend": { "USD": 0 }, "type": "corporate" }, "E666A63199B43042": { "actorList": "admin+testc@abdelhafidh.com", "approvedSpend": { "USD": 0 }, "corporate": true, "expensifyCardSpend": { "USD": 0 }, "type": "corporate" } }, "billingType": "failed_2018", "cardSpendSurchargePercent": 1, "cashBackAmount": 0, "cashBackPercentage": 0, "chatOnlyActorList": "", "corporateActorCount": 1, "corporateRevenue": 3600, "expensifyCardMonthlySpend": 0, "expensifyCardSpend": { "USD": 0 }, "freeToTeamMigrationDiscountAmount": 900, "freeToTeamMigrationDiscountPercent": 25, "freebieCreditsUsed": 0, "guideAccountID": 12003194, "isApprovedAccountant": false, "isApprovedAccountantClient": false, "monthlyCorpSubscriptionCost": 1800, "monthlyTeamSubscriptionCost": 0, "paidActorCount": 1, "partnerManagerAccountID": 0, "perPolicyTotalMembersCount": { "05E4A0124E314E2D": 1, "23B249B9FA2A78A3": 2, "2499B1B92C375F8B": 1, "4656350AB2539E7A": 1, "5F5EB0E523187199": 1, "6AEBBB88BBAF7048": 1, "762A250743827663": 1, "978C2546B3751E81": 3, "C22CACBB604EED41": 1, "CFD83323ED0FC6A9": 1, "D15117903706B9B0": 4, "E5405AABB0C65377": 2, "FED1806CF392498F": 1 }, "potentialCashBackAmount": 1755, "potentialCashBackPercentage": 0.01, "subscription": { "type": "monthly2018" }, "teamActorCount": 0, "teamRevenue": 0, "totalActorCount": 1, "totalFreebieCredits": 0, "totalPlatformSpend": 175500, "totalRevenue": 2700, "totalUniqueMembersCount": 6, "wasDomainBillingUsed": false }, "purchaseID": 71976932 }

cc @amyevans to confirm which fields are required or we can assume all are optional to avoid accessing a non existing field which may lead to a crash

The top level fields are required (amount, created, currency, message, purchaseID). Anything within message we should assume is optional and code defensively to avoid crashes - message is just a JSON string in our database, so the existence of fields is not enforced/guaranteed.

…ing type

… CardSectionUtils

…oved clarity and data management

s77rt · 2025-03-28T17:43:16Z

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 that the composer does not automatically focus or open the keyboard on mobile unless explicitly intended. This includes checking that returning the app from the background does not unexpectedly open the keyboard.
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 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.ts 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.
For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
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

iOS: Native

JS bundle issue. NAB

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

…cture for improved clarity and maintainability

… on billing failure

pasyukevich · 2025-03-31T10:49:57Z

PR updated

s77rt · 2025-03-31T19:57:27Z

@pasyukevich can you please address #58910 (comment)

…ility

amyevans

Looking good! Mostly just nit picks on the documentation of types

amyevans · 2025-04-02T15:33:23Z

+
+/** Type for a billable policy */
+type BillablePolicy = {
+    /** List of actors in the policy */


Suggested change

/** List of actors in the policy */

/** Comma separated list of emails for members in the policy */

…arity

pasyukevich · 2025-04-04T13:04:06Z

PR updated

amyevans

Looks great! Thanks! 🚀

OSBotify · 2025-04-06T20:21:31Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

github-actions · 2025-04-07T23:08:13Z

🚀 Deployed to staging by https://github.com/amyevans in version: 9.1.24-2 🚀

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

amyevans · 2025-04-08T00:29:06Z

    OFFLINE_INDICATOR_HEIGHT: 25,
+
+    BILLING: {
+        TYPE_FAILED_2018: 'typeFailed2018',


While QAing this on staging I realized this got changed at the last minute to be typeFailed2018, when the correct value is failed_2018. I'll open a PR to fix it

github-actions · 2025-04-09T02:13:29Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 9.1.24-10 🚀

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

github-actions · 2025-04-09T04:31:50Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 9.1.24-10 🚀

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

pasyukevich added 5 commits March 19, 2025 14:16

Update policyOwnerAmountOwedOverdue banner text

1bc977b

Add PurchaseList type and related keys to ONYXKEYS

196cf70

Update payment processing messages in English and Spanish translations

8252fec

Update billing banner subtitle parameter from amountOwed to purchaseA…

dbaebec

…mountOwed in English and Spanish translations

Add purchaseList to CardSection and update billing status logic

6511817

pasyukevich changed the title ~~Task/policy owner amount owed overdue~~ Update policyOwnerAmountOwedOverdue billing banner Mar 21, 2025

pasyukevich added 8 commits March 24, 2025 12:50

Merge branch 'main' into task/policyOwnerAmountOwedOverdue

730424f

Refactor getBillingStatus tests to use a single object parameter

243fe04

Add mockPurchase object to getBillingStatus test for improved coverage

2005b3b

Refactor currency utility imports in Subscription CardSection

1675fdb

Fix prettier

4d04b10

Merge branch 'main' into task/policyOwnerAmountOwedOverdue

406ecf1

Merge branch 'main' into task/policyOwnerAmountOwedOverdue

5f498fc

Merge branch 'main' into task/policyOwnerAmountOwedOverdue

658dca8

pasyukevich marked this pull request as ready for review March 26, 2025 20:32

pasyukevich requested a review from a team as a code owner March 26, 2025 20:33

melvin-bot Bot requested review from s77rt and removed request for a team March 26, 2025 20:33

s77rt suggested changes Mar 26, 2025

View reviewed changes

amyevans added the InternalQA This pull request required internal QA label Mar 27, 2025

pasyukevich added 5 commits March 28, 2025 15:21

Merge branch 'main' into task/policyOwnerAmountOwedOverdue

09c2601

Update billing status handling and refactor currency formatting in Ca…

6544c0e

…rdSection

Refactor getBillingStatus to inline purchase details extraction and r…

669c151

…emove getPurchaseDetails function

Update billing banner subtitles to handle optional date and amount pa…

c7071a9

…rameters

Update Spanish translations for billing banner to conditionally inclu…

e65ad3f

…de date and amount owed

s77rt suggested changes Mar 28, 2025

View reviewed changes

pasyukevich added 2 commits March 28, 2025 18:38

Update billing date formatting to conditionally display based on bill…

196a5d0

…ing type

Remove test case for POLICY_OWNER_WITH_AMOUNT_OWED_OVERDUE variant in…

2e7dc76

… CardSectionUtils

Refactor billablePolicies to use a detailed record structure for impr…

fd6043b

…oved clarity and data management

s77rt suggested changes Mar 28, 2025

View reviewed changes

Comment thread src/pages/settings/Subscription/CardSection/utils.ts Outdated

Comment thread src/types/onyx/PurchaseList.ts Outdated

pasyukevich added 3 commits March 31, 2025 12:34

Refactor billablePolicies type to use a dedicated BillablePolicy stru…

c07617a

…cture for improved clarity and maintainability

Update billing status handling to conditionally format subtitle based…

5bc1914

… on billing failure

Fix prettier

e28cd6d

Make subscription and message properties optional for improved flexib…

fa1e98a

…ility

s77rt approved these changes Apr 1, 2025

View reviewed changes

melvin-bot Bot requested a review from amyevans April 1, 2025 11:55

amyevans requested changes Apr 2, 2025

View reviewed changes

pasyukevich added 2 commits April 4, 2025 13:42

Add billing type constant and refactor purchase types for improved cl…

c34e176

…arity

Merge branch 'main' into task/policyOwnerAmountOwedOverdue

7670805

amyevans approved these changes Apr 6, 2025

View reviewed changes

amyevans merged commit 2f56671 into Expensify:main Apr 6, 2025

github-actions Bot mentioned this pull request Apr 7, 2025

Deploy Checklist: New Expensify 2025-04-07 #59756

Closed

amyevans reviewed Apr 8, 2025

View reviewed changes

melvin-bot Bot mentioned this pull request Apr 9, 2025

[Due for payment 2025-04-17] [Due for payment 2025-04-16] Update policyOwnerAmountOwedOverdue billing banner #58067

Closed

	/** List of actors in the policy */
	/** Comma separated list of emails for members in the policy */

Conversation

pasyukevich commented Mar 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot Bot commented Mar 26, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

s77rt commented Mar 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

Uh oh!

Uh oh!

pasyukevich commented Mar 31, 2025

Uh oh!

s77rt commented Mar 31, 2025

Uh oh!

amyevans left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pasyukevich commented Apr 4, 2025

Uh oh!

amyevans left a comment

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Apr 6, 2025

Uh oh!

github-actions Bot commented Apr 7, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented Apr 9, 2025

Uh oh!

github-actions Bot commented Apr 9, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

pasyukevich commented Mar 21, 2025 •

edited

Loading

s77rt commented Mar 28, 2025 •

edited

Loading