diff --git a/src/platform/account/components/dialogs/settings/BillingTab.test.ts b/src/platform/account/components/dialogs/settings/BillingTab.test.ts index 2d6ed0e8999..8a4bc267361 100644 --- a/src/platform/account/components/dialogs/settings/BillingTab.test.ts +++ b/src/platform/account/components/dialogs/settings/BillingTab.test.ts @@ -2300,3 +2300,14 @@ describe('BillingTab banner stack parity with selectBillingBanners', () => { } ) }) + +describe('BillingTab refresh on return', () => { + it('re-reads capabilities when the user returns to the tab on local', () => { + const { refresh } = arrange() + + window.dispatchEvent(new Event('blur')) + window.dispatchEvent(new Event('focus')) + + expect(refresh).toHaveBeenCalledOnce() + }) +}) diff --git a/src/platform/account/components/dialogs/settings/BillingTab.vue b/src/platform/account/components/dialogs/settings/BillingTab.vue index 9759941f7c0..78d50cd59f7 100644 --- a/src/platform/account/components/dialogs/settings/BillingTab.vue +++ b/src/platform/account/components/dialogs/settings/BillingTab.vue @@ -219,6 +219,7 @@ import { useBillingCreditsCard } from '@/platform/billing/components/billingTab/ import { useBillingPlanRow } from '@/platform/billing/components/billingTab/useBillingPlanRow' import { useBillingAutoTopUpCard } from '@/platform/billing/composables/useBillingAutoTopUpCard' import { useBillingCapabilities } from '@/platform/billing/composables/useBillingCapabilities' +import { useRefreshBillingOnReturn } from '@/platform/billing/composables/useRefreshBillingOnReturn' import { useTopUpPlanCreditCopy } from '@/platform/billing/composables/useTopUpPlanCreditCopy' import { usePausedBanner } from '@/platform/billing/composables/usePausedBanner' import { useTopupCheckoutBanner } from '@/platform/billing/composables/useTopupCheckoutBanner' @@ -389,4 +390,6 @@ onMounted(() => { } void capabilities.initialize() }) + +useRefreshBillingOnReturn() diff --git a/src/platform/account/components/dialogs/settings/BillingTabLegacy.test.ts b/src/platform/account/components/dialogs/settings/BillingTabLegacy.test.ts index 2d2fca9fe96..8b5dcc09975 100644 --- a/src/platform/account/components/dialogs/settings/BillingTabLegacy.test.ts +++ b/src/platform/account/components/dialogs/settings/BillingTabLegacy.test.ts @@ -2083,3 +2083,14 @@ describe('BillingTab', () => { }) }) }) + +describe('BillingTab refresh on return', () => { + it('re-reads capabilities when the user returns to the tab on local', () => { + const { refresh } = arrange() + + window.dispatchEvent(new Event('blur')) + window.dispatchEvent(new Event('focus')) + + expect(refresh).toHaveBeenCalledOnce() + }) +}) diff --git a/src/platform/account/components/dialogs/settings/BillingTabLegacy.vue b/src/platform/account/components/dialogs/settings/BillingTabLegacy.vue index a36733288b1..fa3f0347b8a 100644 --- a/src/platform/account/components/dialogs/settings/BillingTabLegacy.vue +++ b/src/platform/account/components/dialogs/settings/BillingTabLegacy.vue @@ -208,6 +208,7 @@ import { useBillingCreditsCard } from '@/platform/billing/legacy160/platform/bil import { useBillingPlanRow } from '@/platform/billing/legacy160/platform/billing/components/billingTab/useBillingPlanRow' import { useBillingAutoTopUpCard } from '@/platform/billing/legacy160/platform/billing/composables/useBillingAutoTopUpCard' import { useBillingCapabilities } from '@/platform/billing/composables/useBillingCapabilities' +import { useRefreshBillingOnReturn } from '@/platform/billing/composables/useRefreshBillingOnReturn' import { useTopUpPlanCreditCopy } from '@/platform/billing/legacy160/platform/billing/composables/useTopUpPlanCreditCopy' import { usePausedBanner } from '@/platform/billing/composables/usePausedBanner' import { useTopupCheckoutBanner } from '@/platform/billing/legacy160/platform/billing/composables/useTopupCheckoutBanner' @@ -330,4 +331,6 @@ onMounted(() => { } void capabilities.initialize() }) + +useRefreshBillingOnReturn() diff --git a/src/platform/billing/composables/useRefreshBillingOnReturn.test.ts b/src/platform/billing/composables/useRefreshBillingOnReturn.test.ts new file mode 100644 index 00000000000..c5f203bf4ae --- /dev/null +++ b/src/platform/billing/composables/useRefreshBillingOnReturn.test.ts @@ -0,0 +1,137 @@ +import { describe, expect, it, onTestFinished, vi } from 'vitest' +import { effectScope } from 'vue' + +import { onBillingRefresh } from '@/platform/billing/billingRefresh' +import { useBillingCapabilities } from '@/platform/billing/composables/useBillingCapabilities' +import { useBillingContext } from '@/platform/billing/composables/useBillingContext' +import { useRefreshBillingOnReturn } from '@/platform/billing/composables/useRefreshBillingOnReturn' + +const distribution = vi.hoisted(() => ({ isCloud: false })) +vi.mock(import('@/platform/distribution/types'), () => ({ + get isCloud() { + return distribution.isCloud + } +})) +vi.mock(import('@/platform/billing/composables/useBillingContext')) +vi.mock(import('@/platform/billing/composables/useBillingCapabilities')) + +const leave = () => window.dispatchEvent(new Event('blur')) +const comeBack = () => window.dispatchEvent(new Event('focus')) + +function heldRead() { + const settles: Array<() => void> = [] + const read = vi.fn( + () => + new Promise((resolve) => { + settles.push(resolve) + }) + ) + const settle = async (index: number) => { + settles[index]() + await vi.advanceTimersByTimeAsync(0) + } + return { read, settle } +} + +function openBillingTab({ isCloud = false, isInitialized = true } = {}) { + distribution.isCloud = isCloud + onTestFinished(() => { + distribution.isCloud = false + }) + const account = heldRead() + onTestFinished(onBillingRefresh(account.read)) + const capabilities = heldRead() + const billing = useBillingContext() + billing.isInitialized.value = isInitialized + vi.mocked(useBillingContext).mockReturnValue(billing) + vi.mocked(useBillingCapabilities().refresh).mockImplementation( + capabilities.read + ) + const scope = effectScope() + scope.run(useRefreshBillingOnReturn) + onTestFinished(() => scope.stop()) + return { + readAccount: account.read, + readCapabilities: capabilities.read, + settleAccount: account.settle, + settleCapabilities: capabilities.settle, + close: () => scope.stop() + } +} + +describe('useRefreshBillingOnReturn', () => { + it('re-reads plan, balance and capabilities once when the user returns to a local tab', () => { + const { readAccount, readCapabilities } = openBillingTab() + + leave() + comeBack() + document.dispatchEvent(new Event('visibilitychange')) + + expect(readAccount).toHaveBeenCalledExactlyOnceWith('account') + expect(readCapabilities).toHaveBeenCalledOnce() + }) + + it('re-reads on every later return', async () => { + const { readAccount, settleAccount, settleCapabilities } = openBillingTab() + + leave() + comeBack() + await settleAccount(0) + await settleCapabilities(0) + leave() + comeBack() + + expect(readAccount).toHaveBeenCalledTimes(2) + }) + + it('reads nothing on Cloud', () => { + const { readAccount, readCapabilities } = openBillingTab({ isCloud: true }) + + leave() + comeBack() + + expect(readAccount).not.toHaveBeenCalled() + expect(readCapabilities).not.toHaveBeenCalled() + }) + + it('holds the read of a return that lands in flight until account and capabilities both settle', async () => { + const { readAccount, readCapabilities, settleAccount, settleCapabilities } = + openBillingTab() + + leave() + comeBack() + leave() + comeBack() + await settleAccount(0) + + expect(readAccount).toHaveBeenCalledOnce() + expect(readCapabilities).toHaveBeenCalledOnce() + + await settleCapabilities(0) + + expect(readAccount).toHaveBeenCalledTimes(2) + expect(readCapabilities).toHaveBeenCalledTimes(2) + }) + + it('leaves the first load alone while billing has not initialized', () => { + const { readAccount, readCapabilities } = openBillingTab({ + isInitialized: false + }) + + leave() + comeBack() + + expect(readAccount).not.toHaveBeenCalled() + expect(readCapabilities).not.toHaveBeenCalled() + }) + + it('stops reading once the tab is closed', () => { + const { readAccount, close } = openBillingTab() + + close() + leave() + comeBack() + + expect(readAccount).not.toHaveBeenCalled() + }) +}) diff --git a/src/platform/billing/composables/useRefreshBillingOnReturn.ts b/src/platform/billing/composables/useRefreshBillingOnReturn.ts new file mode 100644 index 00000000000..6fdb40c8726 --- /dev/null +++ b/src/platform/billing/composables/useRefreshBillingOnReturn.ts @@ -0,0 +1,23 @@ +import { onScopeDispose } from 'vue' + +import { refreshBilling } from '@/platform/billing/billingRefresh' +import { useBillingCapabilities } from '@/platform/billing/composables/useBillingCapabilities' +import { useBillingContext } from '@/platform/billing/composables/useBillingContext' +import { registerRefreshOnReturn } from '@/platform/billing/refreshOnReturn' +import { isCloud } from '@/platform/distribution/types' + +/** On local, re-reads plan, balance and capabilities on each return to this tab or window. */ +export function useRefreshBillingOnReturn(): void { + if (isCloud) return + const billing = useBillingContext() + const capabilities = useBillingCapabilities() + onScopeDispose( + registerRefreshOnReturn(async () => { + if (!billing.isInitialized.value) return + await Promise.allSettled([ + refreshBilling('account'), + capabilities.refresh() + ]) + }) + ) +} diff --git a/src/platform/billing/refreshOnReturn.test.ts b/src/platform/billing/refreshOnReturn.test.ts index b6a4fc997b3..88c314a1f8d 100644 --- a/src/platform/billing/refreshOnReturn.test.ts +++ b/src/platform/billing/refreshOnReturn.test.ts @@ -92,6 +92,19 @@ describe('registerRefreshOnReturn', () => { expect(refresh).toHaveBeenCalledTimes(2) }) + it('drops a queued trailing refresh once the returned callback runs', async () => { + const { refresh, settle } = held() + const stop = registerRefreshOnReturn(refresh) + + come() + leave() + come() + stop() + await settle(0) + + expect(refresh).toHaveBeenCalledTimes(1) + }) + it('stops listening once the returned callback runs', () => { const refresh = vi.fn(async () => {}) const stop = registerRefreshOnReturn(refresh) diff --git a/src/platform/billing/refreshOnReturn.ts b/src/platform/billing/refreshOnReturn.ts index e72b4d44f98..491752cf3a5 100644 --- a/src/platform/billing/refreshOnReturn.ts +++ b/src/platform/billing/refreshOnReturn.ts @@ -1,13 +1,6 @@ /** - * A cancellation, card change, or payment made in a hosted tab never pushes - * back to this one, so every return to this tab re-reads whatever that tab - * could have changed. A return is leaving (`blur` or hidden) and coming back - * (`focus` or visible): the focus and visibility events of one return count - * once, and a return that lands while a refresh is still in flight gets one - * trailing refresh, because that read may predate what the hosted tab just - * did. It stays armed until the returned callback runs. Shared by every - * opener of a hosted billing tab or window so they arm the same return - * signal one way. + * Runs `refresh` on each return to this tab or window; a return during a + * refresh in flight gets one trailing refresh. Returns how to disarm it. */ export function registerRefreshOnReturn( refresh: () => Promise @@ -46,6 +39,7 @@ export function registerRefreshOnReturn( window.addEventListener('focus', onReturn) window.addEventListener('blur', onLeave) return () => { + trailing = false document.removeEventListener('visibilitychange', onVisibilityChange) window.removeEventListener('focus', onReturn) window.removeEventListener('blur', onLeave)