-
Notifications
You must be signed in to change notification settings - Fork 673
Expand file tree
/
Copy pathbillingOperationStore.ts
More file actions
562 lines (494 loc) · 17.5 KB
/
Copy pathbillingOperationStore.ts
File metadata and controls
562 lines (494 loc) · 17.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
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
import type { ToastMessageOptions } from 'primevue/toast'
import { defineStore } from 'pinia'
import { computed, ref } from 'vue'
import { useBillingContext } from '@/composables/billing/useBillingContext'
import { t } from '@/i18n'
import type { TierKey } from '@/platform/cloud/subscription/constants/tierPricing'
import type { BillingCycle } from '@/platform/cloud/subscription/utils/subscriptionTierRank'
import { useSettingsDialog } from '@/platform/settings/composables/useSettingsDialog'
import { useTelemetry } from '@/platform/telemetry'
import type {
PaymentIntentSource,
SubscriptionCheckoutTier,
SubscriptionCheckoutType
} from '@/platform/telemetry/types'
import { useToastStore } from '@/platform/updates/common/toastStore'
import { workspaceApi } from '@/platform/workspace/api/workspaceApi'
import { useTeamWorkspaceStore } from '@/platform/workspace/stores/teamWorkspaceStore'
import { useDialogStore } from '@/stores/dialogStore'
const INITIAL_INTERVAL_MS = 1000
const MAX_INTERVAL_MS = 8000
const ACTION_REQUIRED_INTERVAL_MS = 30_000
const BACKOFF_MULTIPLIER = 1.5
const TIMEOUT_MS = 120_000
const SUBSCRIPTION_ACTION_DISCOVERY_TIMEOUT_MS = 5 * 60_000
const AUTHENTICATION_TIMEOUT_MS = 23 * 60 * 60_000
// Failure reason for a checkout the user replaced by picking a different plan
// mid-flow. The operation is terminal-failed only because it never completed —
// its replacement is proceeding normally, so there is nothing to report.
const CHECKOUT_SUPERSEDED_REASON = 'checkout_superseded'
type OperationType = 'subscription' | 'topup' | 'cancel'
type OperationStatus = 'pending' | 'succeeded' | 'failed' | 'timeout'
export interface StartOperationMetadata {
tier?: SubscriptionCheckoutTier
cycle?: BillingCycle
checkoutType?: SubscriptionCheckoutType
paymentIntentSource?: PaymentIntentSource
downgradeToPersonal?: {
memberRemovalCount: number
memberRemovalFailures: number
targetTier?: TierKey
}
}
interface BillingOperation {
opId: string
type: OperationType
status: OperationStatus
errorMessage: string | null
startedAt: number
actionUrl: string | null
authenticationRequiredSeen: boolean
workspaceId: string | null
tier?: SubscriptionCheckoutTier
cycle?: BillingCycle
checkoutType?: SubscriptionCheckoutType
paymentIntentSource?: PaymentIntentSource
downgradeToPersonal?: StartOperationMetadata['downgradeToPersonal']
}
type TerminalResolver = (operation: BillingOperation) => void
export const useBillingOperationStore = defineStore('billingOperation', () => {
const workspaceStore = useTeamWorkspaceStore()
const operations = ref<Map<string, BillingOperation>>(new Map())
const timeouts = new Map<string, ReturnType<typeof setTimeout>>()
const intervals = new Map<string, number>()
const receivedToasts = new Map<string, ToastMessageOptions>()
const terminalResolvers = new Map<string, TerminalResolver>()
const terminalPromises = new Map<string, Promise<BillingOperation>>()
const hasPendingOperations = computed(() =>
[...operations.value.values()].some((op) => op.status === 'pending')
)
const isSettingUp = computed(() =>
[...operations.value.values()].some(
(op) =>
op.status === 'pending' &&
op.type === 'subscription' &&
op.workspaceId === workspaceStore.activeWorkspaceId
)
)
const isAddingCredits = computed(() =>
[...operations.value.values()].some(
(op) =>
op.status === 'pending' &&
op.type === 'topup' &&
op.workspaceId === workspaceStore.activeWorkspaceId
)
)
const subscriptionActionOperation = computed(() =>
[...operations.value.values()].find(
(op) =>
op.status === 'pending' &&
op.type === 'subscription' &&
op.workspaceId === workspaceStore.activeWorkspaceId &&
op.actionUrl !== null
)
)
const topupActionOperation = computed(() =>
[...operations.value.values()].find(
(op) =>
op.status === 'pending' &&
op.type === 'topup' &&
op.workspaceId === workspaceStore.activeWorkspaceId &&
op.actionUrl !== null
)
)
function getOperation(opId: string) {
return operations.value.get(opId)
}
// An operation parked on a bank challenge is waiting on the customer, not on
// us, so it must not keep announcing "processing" — that reads as "nothing to
// do here" next to the verification prompt the same state renders.
function showProgressToast(
opId: string,
type: Exclude<OperationType, 'cancel'>,
actionRequired: boolean
) {
const toastStore = useToastStore()
const previous = receivedToasts.get(opId)
if (previous) toastStore.remove(previous)
const messageKey =
type === 'subscription'
? actionRequired
? 'billingOperation.subscriptionActionRequired'
: 'billingOperation.subscriptionProcessing'
: actionRequired
? 'billingOperation.topupActionRequired'
: 'billingOperation.topupProcessing'
const toastMessage: ToastMessageOptions = {
// 'warn' selects the prompt icon over the spinner in GlobalToast.
severity: actionRequired ? 'warn' : 'info',
summary: t(messageKey),
group: 'billing-operation'
}
receivedToasts.set(opId, toastMessage)
toastStore.add(toastMessage)
}
function startOperation(
opId: string,
type: OperationType,
metadata?: StartOperationMetadata,
initialActionUrl?: string
): Promise<BillingOperation> {
const existing = operations.value.get(opId)
if (existing && existing.status !== 'timeout') {
return terminalPromises.get(opId) ?? Promise.resolve(existing)
}
if (existing) clearOperation(opId)
const actionUrl = validateActionUrl(initialActionUrl)
const operation: BillingOperation = {
opId,
type,
status: 'pending',
errorMessage: null,
startedAt: Date.now(),
actionUrl,
authenticationRequiredSeen: actionUrl !== null,
workspaceId: workspaceStore.activeWorkspaceId,
tier: metadata?.tier,
cycle: metadata?.cycle,
checkoutType: metadata?.checkoutType,
paymentIntentSource: metadata?.paymentIntentSource,
downgradeToPersonal: metadata?.downgradeToPersonal
}
operations.value = new Map(operations.value).set(opId, operation)
intervals.set(opId, INITIAL_INTERVAL_MS)
if (type !== 'cancel') {
showProgressToast(opId, type, operation.authenticationRequiredSeen)
}
const terminal = new Promise<BillingOperation>((resolve) => {
terminalResolvers.set(opId, resolve)
})
terminalPromises.set(opId, terminal)
void poll(opId)
return terminal
}
async function poll(opId: string) {
const operation = operations.value.get(opId)
if (!operation || operation.status !== 'pending') return
if (stopIfTimedOut(opId, operation)) return
if (operation.workspaceId !== workspaceStore.activeWorkspaceId) {
scheduleNextPoll(opId)
return
}
try {
const response = await workspaceApi.getBillingOpStatus(opId)
const currentOperation = operations.value.get(opId)
if (currentOperation !== operation) return
if (operation.workspaceId !== workspaceStore.activeWorkspaceId) {
if (stopIfTimedOut(opId, operation)) return
scheduleNextPoll(opId)
return
}
if (response.status === 'succeeded') {
await handleSuccess(opId)
return
}
if (response.status === 'failed') {
handleFailure(opId, response.error_message ?? null)
return
}
if (stopIfTimedOut(opId, operation)) return
updateOperationActionUrl(opId, validateActionUrl(response.action_url))
scheduleNextPoll(opId)
} catch {
const currentOperation = operations.value.get(opId)
if (currentOperation !== operation) return
if (stopIfTimedOut(opId, currentOperation)) return
scheduleNextPoll(opId)
}
}
function scheduleNextPoll(opId: string) {
const operation = operations.value.get(opId)
if (!operation || operation.status !== 'pending') return
const nextInterval = operation.authenticationRequiredSeen
? ACTION_REQUIRED_INTERVAL_MS
: Math.min(
(intervals.get(opId) ?? INITIAL_INTERVAL_MS) * BACKOFF_MULTIPLIER,
MAX_INTERVAL_MS
)
intervals.set(opId, nextInterval)
const timeoutId = setTimeout(() => void poll(opId), nextInterval)
timeouts.set(opId, timeoutId)
}
function validateActionUrl(value: string | undefined): string | null {
if (!value) return null
try {
const url = new URL(value)
return url.protocol === 'https:' ? value : null
} catch {
return null
}
}
function hasTimedOut(operation: BillingOperation): boolean {
const elapsed = Date.now() - operation.startedAt
if (operation.type !== 'cancel' && operation.authenticationRequiredSeen) {
return elapsed > AUTHENTICATION_TIMEOUT_MS
}
return operation.type === 'subscription'
? elapsed > SUBSCRIPTION_ACTION_DISCOVERY_TIMEOUT_MS
: elapsed > TIMEOUT_MS
}
function stopIfTimedOut(opId: string, operation: BillingOperation): boolean {
if (!hasTimedOut(operation)) return false
handleTimeout(opId)
return true
}
function updateOperationActionUrl(opId: string, actionUrl: string | null) {
const operation = operations.value.get(opId)
if (!operation || operation.status !== 'pending') return
const authenticationRequiredSeen =
operation.authenticationRequiredSeen || actionUrl !== null
operations.value = new Map(operations.value).set(opId, {
...operation,
actionUrl,
authenticationRequiredSeen
})
// Only on the first transition: the toast is otherwise stable for the life
// of the operation, and re-adding it on every poll would resurface a
// notification the customer has already dismissed.
if (
operation.type !== 'cancel' &&
authenticationRequiredSeen &&
!operation.authenticationRequiredSeen
) {
showProgressToast(opId, operation.type, true)
}
}
async function handleSuccess(opId: string) {
const operation = operations.value.get(opId)
if (!operation) return
updateOperationStatus(opId, 'succeeded', null)
cleanup(opId)
const telemetry = useTelemetry()
telemetry?.trackBillingEvent({
operation: 'operation',
stage: 'succeeded',
outcome: 'success',
billing_op_id: opId,
operation_type: operation.type,
tier: operation.tier,
cycle: operation.cycle,
checkout_type: operation.checkoutType,
payment_intent_source: operation.paymentIntentSource
})
if (operation.type === 'subscription') {
telemetry?.trackBillingEvent({
operation: 'subscription_checkout',
stage: 'succeeded',
outcome: 'success',
tier: operation.tier,
cycle: operation.cycle,
checkout_type: operation.checkoutType,
payment_intent_source: operation.paymentIntentSource,
billing_op_id: opId
})
if (operation.downgradeToPersonal) {
telemetry?.trackBillingEvent({
operation: 'downgrade_to_personal',
stage: 'succeeded',
outcome: 'success',
member_removal_count:
operation.downgradeToPersonal.memberRemovalCount,
member_removal_failures:
operation.downgradeToPersonal.memberRemovalFailures,
target_tier: operation.downgradeToPersonal.targetTier
})
}
} else if (operation.type === 'topup') {
telemetry?.trackBillingEvent({
operation: 'topup',
stage: 'succeeded',
outcome: 'success',
billing_op_id: opId
})
}
const billingContext = useBillingContext()
if (operation.type === 'subscription') {
await Promise.allSettled([billingContext.reconcileSubscriptionSuccess()])
} else {
await Promise.allSettled([
billingContext.fetchStatus(),
billingContext.fetchBalance()
])
}
if (operation.type === 'cancel') {
useTeamWorkspaceStore().updateActiveWorkspace({ isSubscribed: false })
resolveTerminal(opId)
return
}
// A subscription checkout shows its own success step in the pricing dialog,
// so leave it open. Top-ups have no such step: close and surface settings.
if (operation.type === 'topup') {
useDialogStore().closeDialog({ key: 'top-up-credits' })
useSettingsDialog().show('workspace')
}
const toastStore = useToastStore()
const messageKey =
operation.type === 'subscription'
? 'billingOperation.subscriptionSuccess'
: 'billingOperation.topupSuccess'
toastStore.add({
severity: 'success',
summary: t(messageKey),
life: 5000
})
resolveTerminal(opId)
}
function handleFailure(opId: string, errorMessage: string | null) {
const operation = operations.value.get(opId)
if (!operation) return
const superseded = errorMessage === CHECKOUT_SUPERSEDED_REASON
const failureCategory = superseded ? 'stale_operation' : 'unknown'
const defaultMessage = failureMessage(operation.type)
const detail =
operation.type === 'subscription'
? t('billingOperation.subscriptionFailedDetail')
: errorMessage
updateOperationStatus(opId, 'failed', detail ?? defaultMessage)
cleanup(opId)
const telemetry = useTelemetry()
telemetry?.trackBillingEvent({
operation: 'operation',
stage: 'failed',
outcome: 'failure',
billing_op_id: opId,
operation_type: operation.type,
tier: operation.tier,
cycle: operation.cycle,
checkout_type: operation.checkoutType,
payment_intent_source: operation.paymentIntentSource,
failure_category: failureCategory
})
if (operation.downgradeToPersonal) {
telemetry?.trackBillingEvent({
operation: 'downgrade_to_personal',
stage: 'failed',
outcome: 'failure',
member_removal_count: operation.downgradeToPersonal.memberRemovalCount,
member_removal_failures:
operation.downgradeToPersonal.memberRemovalFailures,
target_tier: operation.downgradeToPersonal.targetTier,
failure_category: failureCategory
})
}
if (operation.type !== 'cancel' && !superseded) {
useToastStore().add({
severity: 'error',
summary: defaultMessage,
detail: detail ?? undefined
})
}
resolveTerminal(opId)
}
function handleTimeout(opId: string) {
const operation = operations.value.get(opId)
if (!operation) return
const message = timeoutMessage(operation.type)
updateOperationStatus(opId, 'timeout', message)
cleanup(opId)
const telemetry = useTelemetry()
telemetry?.trackBillingEvent({
operation: 'operation',
stage: 'timeout',
outcome: 'failure',
billing_op_id: opId,
operation_type: operation.type,
tier: operation.tier,
cycle: operation.cycle,
checkout_type: operation.checkoutType,
payment_intent_source: operation.paymentIntentSource,
failure_category: 'poll_timeout'
})
if (operation.downgradeToPersonal) {
telemetry?.trackBillingEvent({
operation: 'downgrade_to_personal',
stage: 'failed',
outcome: 'failure',
member_removal_count: operation.downgradeToPersonal.memberRemovalCount,
member_removal_failures:
operation.downgradeToPersonal.memberRemovalFailures,
target_tier: operation.downgradeToPersonal.targetTier,
failure_category: 'poll_timeout'
})
}
if (operation.type !== 'cancel') {
useToastStore().add({
severity: 'error',
summary: message
})
}
resolveTerminal(opId)
}
function failureMessage(type: OperationType) {
if (type === 'subscription') return t('billingOperation.subscriptionFailed')
if (type === 'topup') return t('billingOperation.topupFailed')
return t('billingOperation.cancelFailed')
}
function timeoutMessage(type: OperationType) {
if (type === 'subscription')
return t('billingOperation.subscriptionTimeout')
if (type === 'topup') return t('billingOperation.topupTimeout')
return t('billingOperation.cancelTimeout')
}
function resolveTerminal(opId: string) {
const resolve = terminalResolvers.get(opId)
const operation = operations.value.get(opId)
if (resolve && operation) {
resolve(operation)
}
terminalResolvers.delete(opId)
terminalPromises.delete(opId)
}
function updateOperationStatus(
opId: string,
status: OperationStatus,
errorMessage: string | null
) {
const operation = operations.value.get(opId)
if (!operation) return
const updated = { ...operation, status, errorMessage, actionUrl: null }
operations.value = new Map(operations.value).set(opId, updated)
}
function cleanup(opId: string) {
const timeoutId = timeouts.get(opId)
if (timeoutId) {
clearTimeout(timeoutId)
timeouts.delete(opId)
}
intervals.delete(opId)
// Remove the "received" toast
const receivedToast = receivedToasts.get(opId)
if (receivedToast) {
useToastStore().remove(receivedToast)
receivedToasts.delete(opId)
}
}
function clearOperation(opId: string) {
cleanup(opId)
const newMap = new Map(operations.value)
newMap.delete(opId)
operations.value = newMap
terminalResolvers.delete(opId)
terminalPromises.delete(opId)
}
return {
operations,
hasPendingOperations,
isSettingUp,
isAddingCredits,
subscriptionActionOperation,
topupActionOperation,
getOperation,
startOperation,
clearOperation
}
})