-
Notifications
You must be signed in to change notification settings - Fork 673
Expand file tree
/
Copy pathSubscriptionHelper.ts
More file actions
278 lines (252 loc) · 8.5 KB
/
Copy pathSubscriptionHelper.ts
File metadata and controls
278 lines (252 loc) · 8.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
import { expect } from '@playwright/test'
import type { Page, Route } from '@playwright/test'
import { PENDING_SUBSCRIPTION_CHECKOUT_STORAGE_KEY } from '@/platform/cloud/subscription/utils/subscriptionCheckoutTracker'
import {
createBalance,
createSubscriptionStatus,
UNSUBSCRIBED,
ZERO_BALANCE
} from '@e2e/fixtures/data/subscriptionFixtures'
import type {
BalanceResponse,
SubscriptionStatusResponse
} from '@e2e/fixtures/data/subscriptionFixtures'
import { TestIds } from '@e2e/fixtures/selectors'
export interface SubscriptionConfig {
status: SubscriptionStatusResponse
balance: BalanceResponse
}
function emptyConfig(): SubscriptionConfig {
return {
status: createSubscriptionStatus(UNSUBSCRIBED),
balance: createBalance(ZERO_BALANCE)
}
}
export type SubscriptionOperator = (
config: SubscriptionConfig
) => SubscriptionConfig
function withSubscriptionStatus(
overrides: Partial<SubscriptionStatusResponse>
): SubscriptionOperator {
return (config) => ({
...config,
status: { ...config.status, ...overrides }
})
}
export function withActiveSubscription(
tier: NonNullable<SubscriptionStatusResponse['subscription_tier']> = 'CREATOR'
): SubscriptionOperator {
return withSubscriptionStatus({
is_active: true,
subscription_tier: tier,
renewal_date: '2099-12-31T00:00:00.000Z',
end_date: null
})
}
export function withFreeTier(): SubscriptionOperator {
return withSubscriptionStatus({
is_active: true,
subscription_tier: 'FREE',
end_date: null
})
}
export function withUnsubscribed(): SubscriptionOperator {
return withSubscriptionStatus({
is_active: false,
subscription_tier: 'FREE',
end_date: null,
renewal_date: null
})
}
export class SubscriptionHelper {
private statusResponse: SubscriptionStatusResponse
private balanceResponse: BalanceResponse
private routeHandlers: Array<{
pattern: string
handler: (route: Route) => Promise<void>
}> = []
constructor(
private readonly page: Page,
config: SubscriptionConfig = emptyConfig()
) {
this.statusResponse = { ...config.status }
this.balanceResponse = { ...config.balance }
}
async mock(): Promise<void> {
await this.page.addInitScript(() => {
window.__CONFIG__ = {
...window.__CONFIG__,
subscription_required: true
}
})
// The cloud build calls `/api/features` at boot via `refreshRemoteConfig`,
// which overwrites `window.__CONFIG__` wholesale. Mock it to preserve
// `subscription_required: true` after that fetch resolves.
const featuresPattern = '**/api/features'
const featuresHandler = async (route: Route) => {
await route.fulfill({ json: { subscription_required: true } })
}
this.routeHandlers.push({
pattern: featuresPattern,
handler: featuresHandler
})
await this.page.route(featuresPattern, featuresHandler)
const statusPattern = '**/customers/cloud-subscription-status'
const statusHandler = async (route: Route) => {
await route.fulfill({ json: this.statusResponse })
}
this.routeHandlers.push({ pattern: statusPattern, handler: statusHandler })
await this.page.route(statusPattern, statusHandler)
const balancePattern = '**/customers/balance'
const balanceHandler = async (route: Route) => {
await route.fulfill({ json: this.balanceResponse })
}
this.routeHandlers.push({
pattern: balancePattern,
handler: balanceHandler
})
await this.page.route(balancePattern, balanceHandler)
const checkoutPattern = '**/customers/cloud-subscription-checkout**'
const checkoutHandler = async (route: Route) => {
await route.fulfill({
json: { checkout_url: 'https://checkout.stripe.com/mock' }
})
}
this.routeHandlers.push({
pattern: checkoutPattern,
handler: checkoutHandler
})
await this.page.route(checkoutPattern, checkoutHandler)
const billingPortalPattern = '**/customers/billing'
const billingPortalHandler = async (route: Route) => {
await route.fulfill({
json: { billing_portal_url: 'https://billing.example/portal' }
})
}
this.routeHandlers.push({
pattern: billingPortalPattern,
handler: billingPortalHandler
})
await this.page.route(billingPortalPattern, billingPortalHandler)
}
configure(...operators: SubscriptionOperator[]): void {
const config = operators.reduce<SubscriptionConfig>((cfg, op) => op(cfg), {
status: { ...this.statusResponse },
balance: { ...this.balanceResponse }
})
this.statusResponse = { ...config.status }
this.balanceResponse = { ...config.balance }
}
setStatus(overrides: Partial<SubscriptionStatusResponse>): void {
this.statusResponse = { ...this.statusResponse, ...overrides }
}
setBalance(overrides: Partial<BalanceResponse>): void {
this.balanceResponse = { ...this.balanceResponse, ...overrides }
}
/**
* Seed localStorage with a pending checkout attempt so that
* `recoverPendingSubscriptionCheckout` triggers a status re-fetch on
* the next `visibilitychange` event. Must be called after navigation.
*/
async seedPendingCheckout(
tier: string = 'standard',
cycle: string = 'monthly'
): Promise<void> {
const storageKey = PENDING_SUBSCRIPTION_CHECKOUT_STORAGE_KEY
await this.page.evaluate(
([key, t, c]) => {
localStorage.setItem(
key,
JSON.stringify({
attempt_id: `test-${Date.now()}`,
started_at_ms: Date.now(),
tier: t,
cycle: c,
checkout_type: 'new'
})
)
},
[storageKey, tier, cycle] as const
)
}
/**
* Dispatch `visibilitychange` to simulate returning from Stripe checkout.
* The app re-fetches subscription status when a pending checkout attempt
* exists in localStorage (seeded via `seedPendingCheckout`).
*/
async triggerSubscriptionRefetch(): Promise<void> {
await this.page.evaluate(() => {
document.dispatchEvent(new Event('visibilitychange'))
})
}
/**
* Open the user popover and return its locator after verifying visibility.
* Uses `dispatchEvent` to bypass Playwright's actionability check — a
* subscription dialog backdrop can intercept a normal `.click()` during
* initial page load.
*/
async openUserPopover() {
await this.page
.getByTestId(TestIds.user.currentUserButton)
.dispatchEvent('click')
const popover = this.page.getByTestId(TestIds.user.currentUserPopover)
await expect(popover).toBeVisible()
return popover
}
/**
* Open the user popover and click the subscribe button.
* Uses `dispatchEvent` on the button too — the subscription dialog's
* backdrop appears mid-action, which would cause Playwright's actionability
* re-check to block a standard `.click()`.
*/
async clickPopoverSubscribe(): Promise<void> {
const popover = await this.openUserPopover()
await popover
.getByRole('button', { name: /subscribe/i })
.first()
.dispatchEvent('click')
}
/**
* Dismiss the subscription-required dialog if it appears after boot.
* The dialog opens asynchronously after the `isLoggedIn` watcher fires,
* so we poll briefly; absence is not a failure.
*/
async dismissSubscriptionDialogIfOpen(): Promise<void> {
const dialog = this.page.locator(
'[aria-labelledby="subscription-required"]'
)
// `expect().toBeVisible()` throws a Playwright AssertionError (not
// errors.TimeoutError) when the element is absent — both cases mean
// "dialog not present", which is the expected happy path here.
const appeared = await expect(dialog)
.toBeVisible({ timeout: 2000 })
.then(() => true)
.catch(() => false)
if (!appeared) return
const closeButton = dialog.getByRole('button', { name: /close/i }).first()
if (await closeButton.isVisible()) {
await closeButton.click()
} else {
await this.page.keyboard.press('Escape')
}
await expect(dialog).toBeHidden()
}
async clearMocks(): Promise<void> {
for (const { pattern, handler } of this.routeHandlers) {
await this.page.unroute(pattern, handler)
}
this.routeHandlers = []
this.statusResponse = { ...UNSUBSCRIBED }
this.balanceResponse = { ...ZERO_BALANCE }
}
}
export function createSubscriptionHelper(
page: Page,
...operators: SubscriptionOperator[]
): SubscriptionHelper {
const config = operators.reduce<SubscriptionConfig>(
(cfg, op) => op(cfg),
emptyConfig()
)
return new SubscriptionHelper(page, config)
}