overleaf/services/web/app/src/Features/Subscription/RecurlyEventHandler.js
Thomas 45ac55c7f0 Merge pull request #6559 from overleaf/tm-teardown-onboarding-email-split-test
Implement 'send-email' variant for trial onboarding email for all users

GitOrigin-RevId: f53b86d875a1a4e146dc57603b7a83ac098f9cdf
2022-02-16 11:36:02 +00:00

204 lines
5.8 KiB
JavaScript

const AnalyticsManager = require('../Analytics/AnalyticsManager')
const SubscriptionEmailHandler = require('./SubscriptionEmailHandler')
const { ObjectID } = require('mongodb')
async function sendRecurlyAnalyticsEvent(event, eventData) {
const userId = _getUserId(eventData)
if (!ObjectID.isValid(userId)) {
return
}
switch (event) {
case 'new_subscription_notification':
await _sendSubscriptionStartedEvent(userId, eventData)
break
case 'updated_subscription_notification':
await _sendSubscriptionUpdatedEvent(userId, eventData)
break
case 'canceled_subscription_notification':
await _sendSubscriptionCancelledEvent(userId, eventData)
break
case 'expired_subscription_notification':
await _sendSubscriptionExpiredEvent(userId, eventData)
break
case 'renewed_subscription_notification':
await _sendSubscriptionRenewedEvent(userId, eventData)
break
case 'reactivated_account_notification':
await _sendSubscriptionReactivatedEvent(userId, eventData)
break
case 'paid_charge_invoice_notification':
if (
eventData.invoice.state === 'paid' &&
eventData.invoice.total_in_cents > 0
) {
await _sendInvoicePaidEvent(userId, eventData)
}
break
case 'closed_invoice_notification':
if (
eventData.invoice.state === 'collected' &&
eventData.invoice.total_in_cents > 0
) {
await _sendInvoicePaidEvent(userId, eventData)
}
break
}
}
async function _sendSubscriptionStartedEvent(userId, eventData) {
const { planCode, quantity, state, isTrial } = _getSubscriptionData(eventData)
AnalyticsManager.recordEventForUser(userId, 'subscription-started', {
plan_code: planCode,
quantity,
is_trial: isTrial,
})
AnalyticsManager.setUserPropertyForUser(
userId,
'subscription-plan-code',
planCode
)
AnalyticsManager.setUserPropertyForUser(userId, 'subscription-state', state)
AnalyticsManager.setUserPropertyForUser(
userId,
'subscription-is-trial',
isTrial
)
if (isTrial) {
await SubscriptionEmailHandler.sendTrialOnboardingEmail(userId)
}
}
async function _sendSubscriptionUpdatedEvent(userId, eventData) {
const { planCode, quantity, state, isTrial } = _getSubscriptionData(eventData)
AnalyticsManager.recordEventForUser(userId, 'subscription-updated', {
plan_code: planCode,
quantity,
is_trial: isTrial,
})
AnalyticsManager.setUserPropertyForUser(
userId,
'subscription-plan-code',
planCode
)
AnalyticsManager.setUserPropertyForUser(userId, 'subscription-state', state)
AnalyticsManager.setUserPropertyForUser(
userId,
'subscription-is-trial',
isTrial
)
}
async function _sendSubscriptionCancelledEvent(userId, eventData) {
const { planCode, quantity, state, isTrial } = _getSubscriptionData(eventData)
AnalyticsManager.recordEventForUser(userId, 'subscription-cancelled', {
plan_code: planCode,
quantity,
is_trial: isTrial,
})
AnalyticsManager.setUserPropertyForUser(userId, 'subscription-state', state)
AnalyticsManager.setUserPropertyForUser(
userId,
'subscription-is-trial',
isTrial
)
}
async function _sendSubscriptionExpiredEvent(userId, eventData) {
const { planCode, quantity, state, isTrial } = _getSubscriptionData(eventData)
AnalyticsManager.recordEventForUser(userId, 'subscription-expired', {
plan_code: planCode,
quantity,
is_trial: isTrial,
})
AnalyticsManager.setUserPropertyForUser(
userId,
'subscription-plan-code',
planCode
)
AnalyticsManager.setUserPropertyForUser(userId, 'subscription-state', state)
AnalyticsManager.setUserPropertyForUser(
userId,
'subscription-is-trial',
isTrial
)
}
async function _sendSubscriptionRenewedEvent(userId, eventData) {
const { planCode, quantity, state, isTrial } = _getSubscriptionData(eventData)
AnalyticsManager.recordEventForUser(userId, 'subscription-renewed', {
plan_code: planCode,
quantity,
is_trial: isTrial,
})
AnalyticsManager.setUserPropertyForUser(
userId,
'subscription-plan-code',
planCode
)
AnalyticsManager.setUserPropertyForUser(userId, 'subscription-state', state)
AnalyticsManager.setUserPropertyForUser(
userId,
'subscription-is-trial',
isTrial
)
}
async function _sendSubscriptionReactivatedEvent(userId, eventData) {
const { planCode, quantity, state, isTrial } = _getSubscriptionData(eventData)
AnalyticsManager.recordEventForUser(userId, 'subscription-reactivated', {
plan_code: planCode,
quantity,
})
AnalyticsManager.setUserPropertyForUser(
userId,
'subscription-plan-code',
planCode
)
AnalyticsManager.setUserPropertyForUser(userId, 'subscription-state', state)
AnalyticsManager.setUserPropertyForUser(
userId,
'subscription-is-trial',
isTrial
)
}
async function _sendInvoicePaidEvent(userId, eventData) {
AnalyticsManager.recordEventForUser(userId, 'subscription-invoice-collected')
AnalyticsManager.setUserPropertyForUser(
userId,
'subscription-is-trial',
false
)
}
function _getUserId(eventData) {
let userId
if (eventData && eventData.account && eventData.account.account_code) {
userId = eventData.account.account_code
} else {
throw new Error(
'account.account_code missing in event data to identity user ID'
)
}
return userId
}
function _getSubscriptionData(eventData) {
const isTrial =
eventData.subscription.trial_started_at &&
eventData.subscription.current_period_started_at &&
eventData.subscription.trial_started_at.getTime() ===
eventData.subscription.current_period_started_at.getTime()
return {
planCode: eventData.subscription.plan.plan_code,
quantity: eventData.subscription.quantity,
state: eventData.subscription.state,
isTrial,
}
}
module.exports = {
sendRecurlyAnalyticsEvent,
}