RecurlyEventHandler.js 6.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215
  1. const AnalyticsManager = require('../Analytics/AnalyticsManager')
  2. const SplitTestV2Handler = require('../SplitTests/SplitTestV2Handler')
  3. const SubscriptionEmailHandler = require('./SubscriptionEmailHandler')
  4. function sendRecurlyAnalyticsEvent(event, eventData) {
  5. switch (event) {
  6. case 'new_subscription_notification':
  7. sendSubscriptionStartedEvent(eventData)
  8. break
  9. case 'updated_subscription_notification':
  10. _sendSubscriptionUpdatedEvent(eventData)
  11. break
  12. case 'canceled_subscription_notification':
  13. _sendSubscriptionCancelledEvent(eventData)
  14. break
  15. case 'expired_subscription_notification':
  16. _sendSubscriptionExpiredEvent(eventData)
  17. break
  18. case 'renewed_subscription_notification':
  19. _sendSubscriptionRenewedEvent(eventData)
  20. break
  21. case 'reactivated_account_notification':
  22. _sendSubscriptionReactivatedEvent(eventData)
  23. break
  24. case 'paid_charge_invoice_notification':
  25. if (
  26. eventData.invoice.state === 'paid' &&
  27. eventData.invoice.total_in_cents > 0
  28. ) {
  29. _sendInvoicePaidEvent(eventData)
  30. }
  31. break
  32. case 'closed_invoice_notification':
  33. if (
  34. eventData.invoice.state === 'collected' &&
  35. eventData.invoice.total_in_cents > 0
  36. ) {
  37. _sendInvoicePaidEvent(eventData)
  38. }
  39. break
  40. }
  41. }
  42. async function sendSubscriptionStartedEvent(eventData) {
  43. const userId = _getUserId(eventData)
  44. const { planCode, quantity, state, isTrial } = _getSubscriptionData(eventData)
  45. AnalyticsManager.recordEventForUser(userId, 'subscription-started', {
  46. plan_code: planCode,
  47. quantity,
  48. is_trial: isTrial,
  49. })
  50. AnalyticsManager.setUserPropertyForUser(
  51. userId,
  52. 'subscription-plan-code',
  53. planCode
  54. )
  55. AnalyticsManager.setUserPropertyForUser(userId, 'subscription-state', state)
  56. AnalyticsManager.setUserPropertyForUser(
  57. userId,
  58. 'subscription-is-trial',
  59. isTrial
  60. )
  61. // send the trial onboarding email
  62. if (isTrial) {
  63. const assignment = await SplitTestV2Handler.promises.getAssignment(
  64. userId,
  65. 'trial-onboarding-email'
  66. )
  67. if (assignment.variant === 'send-email') {
  68. SubscriptionEmailHandler.sendTrialOnboardingEmail(userId)
  69. }
  70. }
  71. }
  72. async function _sendSubscriptionUpdatedEvent(eventData) {
  73. const userId = _getUserId(eventData)
  74. const { planCode, quantity, state, isTrial } = _getSubscriptionData(eventData)
  75. AnalyticsManager.recordEventForUser(userId, 'subscription-updated', {
  76. plan_code: planCode,
  77. quantity,
  78. is_trial: isTrial,
  79. })
  80. AnalyticsManager.setUserPropertyForUser(
  81. userId,
  82. 'subscription-plan-code',
  83. planCode
  84. )
  85. AnalyticsManager.setUserPropertyForUser(userId, 'subscription-state', state)
  86. AnalyticsManager.setUserPropertyForUser(
  87. userId,
  88. 'subscription-is-trial',
  89. isTrial
  90. )
  91. }
  92. async function _sendSubscriptionCancelledEvent(eventData) {
  93. const userId = _getUserId(eventData)
  94. const { planCode, quantity, state, isTrial } = _getSubscriptionData(eventData)
  95. AnalyticsManager.recordEventForUser(userId, 'subscription-cancelled', {
  96. plan_code: planCode,
  97. quantity,
  98. is_trial: isTrial,
  99. })
  100. AnalyticsManager.setUserPropertyForUser(userId, 'subscription-state', state)
  101. AnalyticsManager.setUserPropertyForUser(
  102. userId,
  103. 'subscription-is-trial',
  104. isTrial
  105. )
  106. }
  107. async function _sendSubscriptionExpiredEvent(eventData) {
  108. const userId = _getUserId(eventData)
  109. const { planCode, quantity, state, isTrial } = _getSubscriptionData(eventData)
  110. AnalyticsManager.recordEventForUser(userId, 'subscription-expired', {
  111. plan_code: planCode,
  112. quantity,
  113. is_trial: isTrial,
  114. })
  115. AnalyticsManager.setUserPropertyForUser(
  116. userId,
  117. 'subscription-plan-code',
  118. planCode
  119. )
  120. AnalyticsManager.setUserPropertyForUser(userId, 'subscription-state', state)
  121. AnalyticsManager.setUserPropertyForUser(
  122. userId,
  123. 'subscription-is-trial',
  124. isTrial
  125. )
  126. }
  127. async function _sendSubscriptionRenewedEvent(eventData) {
  128. const userId = _getUserId(eventData)
  129. const { planCode, quantity, state, isTrial } = _getSubscriptionData(eventData)
  130. AnalyticsManager.recordEventForUser(userId, 'subscription-renewed', {
  131. plan_code: planCode,
  132. quantity,
  133. is_trial: isTrial,
  134. })
  135. AnalyticsManager.setUserPropertyForUser(
  136. userId,
  137. 'subscription-plan-code',
  138. planCode
  139. )
  140. AnalyticsManager.setUserPropertyForUser(userId, 'subscription-state', state)
  141. AnalyticsManager.setUserPropertyForUser(
  142. userId,
  143. 'subscription-is-trial',
  144. isTrial
  145. )
  146. }
  147. async function _sendSubscriptionReactivatedEvent(eventData) {
  148. const userId = _getUserId(eventData)
  149. const { planCode, quantity, state, isTrial } = _getSubscriptionData(eventData)
  150. AnalyticsManager.recordEventForUser(userId, 'subscription-reactivated', {
  151. plan_code: planCode,
  152. quantity,
  153. })
  154. AnalyticsManager.setUserPropertyForUser(
  155. userId,
  156. 'subscription-plan-code',
  157. planCode
  158. )
  159. AnalyticsManager.setUserPropertyForUser(userId, 'subscription-state', state)
  160. AnalyticsManager.setUserPropertyForUser(
  161. userId,
  162. 'subscription-is-trial',
  163. isTrial
  164. )
  165. }
  166. async function _sendInvoicePaidEvent(eventData) {
  167. const userId = _getUserId(eventData)
  168. AnalyticsManager.recordEventForUser(userId, 'subscription-invoice-collected')
  169. AnalyticsManager.setUserPropertyForUser(
  170. userId,
  171. 'subscription-is-trial',
  172. false
  173. )
  174. }
  175. function _getUserId(eventData) {
  176. let userId
  177. if (eventData && eventData.account && eventData.account.account_code) {
  178. userId = eventData.account.account_code
  179. } else {
  180. throw new Error(
  181. 'account.account_code missing in event data to identity user ID'
  182. )
  183. }
  184. return userId
  185. }
  186. function _getSubscriptionData(eventData) {
  187. const isTrial =
  188. eventData.subscription.trial_started_at &&
  189. eventData.subscription.current_period_started_at &&
  190. eventData.subscription.trial_started_at.getTime() ===
  191. eventData.subscription.current_period_started_at.getTime()
  192. return {
  193. planCode: eventData.subscription.plan.plan_code,
  194. quantity: eventData.subscription.quantity,
  195. state: eventData.subscription.state,
  196. isTrial,
  197. }
  198. }
  199. module.exports = {
  200. sendRecurlyAnalyticsEvent,
  201. sendSubscriptionStartedEvent,
  202. }