RecurlyEventHandlerTests.js 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368
  1. const SandboxedModule = require('sandboxed-module')
  2. const sinon = require('sinon')
  3. const modulePath =
  4. '../../../../app/src/Features/Subscription/RecurlyEventHandler'
  5. describe('RecurlyEventHandler', function () {
  6. beforeEach(function () {
  7. this.userId = '123abc234bcd456cde567def'
  8. this.planCode = 'collaborator-annual'
  9. this.eventData = {
  10. account: {
  11. account_code: this.userId,
  12. },
  13. subscription: {
  14. uuid: '8435ad98c1ce45da99b07f6a6a2e780f',
  15. plan: {
  16. plan_code: 'collaborator-annual',
  17. },
  18. quantity: 1,
  19. state: 'active',
  20. trial_started_at: new Date('2021-01-01 12:34:56'),
  21. trial_ends_at: new Date('2021-01-08 12:34:56'),
  22. current_period_started_at: new Date('2021-01-01 12:34:56'),
  23. current_period_ends_at: new Date('2021-01-08 12:34:56'),
  24. },
  25. }
  26. this.RecurlyEventHandler = SandboxedModule.require(modulePath, {
  27. requires: {
  28. './SubscriptionEmailHandler': (this.SubscriptionEmailHandler = {
  29. sendTrialOnboardingEmail: sinon.stub(),
  30. }),
  31. '../Analytics/AnalyticsManager': (this.AnalyticsManager = {
  32. recordEventForUser: sinon.stub(),
  33. setUserPropertyForUser: sinon.stub(),
  34. }),
  35. },
  36. })
  37. })
  38. it('with new_subscription_notification - free trial', function () {
  39. this.RecurlyEventHandler.sendRecurlyAnalyticsEvent(
  40. 'new_subscription_notification',
  41. this.eventData
  42. )
  43. sinon.assert.calledWith(
  44. this.AnalyticsManager.recordEventForUser,
  45. this.userId,
  46. 'subscription-started',
  47. {
  48. plan_code: this.planCode,
  49. quantity: 1,
  50. is_trial: true,
  51. subscriptionId: this.eventData.subscription.uuid,
  52. }
  53. )
  54. sinon.assert.calledWith(
  55. this.AnalyticsManager.setUserPropertyForUser,
  56. this.userId,
  57. 'subscription-plan-code',
  58. this.planCode
  59. )
  60. sinon.assert.calledWith(
  61. this.AnalyticsManager.setUserPropertyForUser,
  62. this.userId,
  63. 'subscription-state',
  64. 'active'
  65. )
  66. sinon.assert.calledWith(
  67. this.AnalyticsManager.setUserPropertyForUser,
  68. this.userId,
  69. 'subscription-is-trial',
  70. true
  71. )
  72. })
  73. it('sends free trial onboarding email if user starting a trial', async function () {
  74. await this.RecurlyEventHandler.sendRecurlyAnalyticsEvent(
  75. 'new_subscription_notification',
  76. this.eventData
  77. )
  78. sinon.assert.called(this.SubscriptionEmailHandler.sendTrialOnboardingEmail)
  79. })
  80. it('with new_subscription_notification - no free trial', function () {
  81. this.eventData.subscription.current_period_started_at = new Date(
  82. '2021-02-10 12:34:56'
  83. )
  84. this.eventData.subscription.current_period_ends_at = new Date(
  85. '2021-02-17 12:34:56'
  86. )
  87. this.eventData.subscription.quantity = 3
  88. this.RecurlyEventHandler.sendRecurlyAnalyticsEvent(
  89. 'new_subscription_notification',
  90. this.eventData
  91. )
  92. sinon.assert.calledWith(
  93. this.AnalyticsManager.recordEventForUser,
  94. this.userId,
  95. 'subscription-started',
  96. {
  97. plan_code: this.planCode,
  98. quantity: 3,
  99. is_trial: false,
  100. subscriptionId: this.eventData.subscription.uuid,
  101. }
  102. )
  103. sinon.assert.calledWith(
  104. this.AnalyticsManager.setUserPropertyForUser,
  105. this.userId,
  106. 'subscription-state',
  107. 'active'
  108. )
  109. sinon.assert.calledWith(
  110. this.AnalyticsManager.setUserPropertyForUser,
  111. this.userId,
  112. 'subscription-is-trial',
  113. false
  114. )
  115. })
  116. it('with updated_subscription_notification', function () {
  117. this.planCode = 'new-plan-code'
  118. this.eventData.subscription.plan.plan_code = this.planCode
  119. this.RecurlyEventHandler.sendRecurlyAnalyticsEvent(
  120. 'updated_subscription_notification',
  121. this.eventData
  122. )
  123. sinon.assert.calledWith(
  124. this.AnalyticsManager.recordEventForUser,
  125. this.userId,
  126. 'subscription-updated',
  127. {
  128. plan_code: this.planCode,
  129. quantity: 1,
  130. is_trial: true,
  131. subscriptionId: this.eventData.subscription.uuid,
  132. }
  133. )
  134. sinon.assert.calledWith(
  135. this.AnalyticsManager.setUserPropertyForUser,
  136. this.userId,
  137. 'subscription-plan-code',
  138. this.planCode
  139. )
  140. sinon.assert.calledWith(
  141. this.AnalyticsManager.setUserPropertyForUser,
  142. this.userId,
  143. 'subscription-state',
  144. 'active'
  145. )
  146. sinon.assert.calledWith(
  147. this.AnalyticsManager.setUserPropertyForUser,
  148. this.userId,
  149. 'subscription-is-trial',
  150. true
  151. )
  152. })
  153. it('with canceled_subscription_notification', function () {
  154. this.eventData.subscription.state = 'cancelled'
  155. this.RecurlyEventHandler.sendRecurlyAnalyticsEvent(
  156. 'canceled_subscription_notification',
  157. this.eventData
  158. )
  159. sinon.assert.calledWith(
  160. this.AnalyticsManager.recordEventForUser,
  161. this.userId,
  162. 'subscription-cancelled',
  163. {
  164. plan_code: this.planCode,
  165. quantity: 1,
  166. is_trial: true,
  167. subscriptionId: this.eventData.subscription.uuid,
  168. }
  169. )
  170. sinon.assert.calledWith(
  171. this.AnalyticsManager.setUserPropertyForUser,
  172. this.userId,
  173. 'subscription-state',
  174. 'cancelled'
  175. )
  176. sinon.assert.calledWith(
  177. this.AnalyticsManager.setUserPropertyForUser,
  178. this.userId,
  179. 'subscription-is-trial',
  180. true
  181. )
  182. })
  183. it('with expired_subscription_notification', function () {
  184. this.eventData.subscription.state = 'expired'
  185. this.RecurlyEventHandler.sendRecurlyAnalyticsEvent(
  186. 'expired_subscription_notification',
  187. this.eventData
  188. )
  189. sinon.assert.calledWith(
  190. this.AnalyticsManager.recordEventForUser,
  191. this.userId,
  192. 'subscription-expired',
  193. {
  194. plan_code: this.planCode,
  195. quantity: 1,
  196. is_trial: true,
  197. subscriptionId: this.eventData.subscription.uuid,
  198. }
  199. )
  200. sinon.assert.calledWith(
  201. this.AnalyticsManager.setUserPropertyForUser,
  202. this.userId,
  203. 'subscription-plan-code',
  204. this.planCode
  205. )
  206. sinon.assert.calledWith(
  207. this.AnalyticsManager.setUserPropertyForUser,
  208. this.userId,
  209. 'subscription-state',
  210. 'expired'
  211. )
  212. sinon.assert.calledWith(
  213. this.AnalyticsManager.setUserPropertyForUser,
  214. this.userId,
  215. 'subscription-is-trial',
  216. true
  217. )
  218. })
  219. it('with renewed_subscription_notification', function () {
  220. this.RecurlyEventHandler.sendRecurlyAnalyticsEvent(
  221. 'renewed_subscription_notification',
  222. this.eventData
  223. )
  224. sinon.assert.calledWith(
  225. this.AnalyticsManager.recordEventForUser,
  226. this.userId,
  227. 'subscription-renewed',
  228. {
  229. plan_code: this.planCode,
  230. quantity: 1,
  231. is_trial: true,
  232. subscriptionId: this.eventData.subscription.uuid,
  233. }
  234. )
  235. })
  236. it('with reactivated_account_notification', function () {
  237. this.RecurlyEventHandler.sendRecurlyAnalyticsEvent(
  238. 'reactivated_account_notification',
  239. this.eventData
  240. )
  241. sinon.assert.calledWith(
  242. this.AnalyticsManager.recordEventForUser,
  243. this.userId,
  244. 'subscription-reactivated',
  245. {
  246. plan_code: this.planCode,
  247. quantity: 1,
  248. subscriptionId: this.eventData.subscription.uuid,
  249. }
  250. )
  251. })
  252. it('with paid_charge_invoice_notification', function () {
  253. const invoice = {
  254. invoice_number: 1234,
  255. currency: 'USD',
  256. state: 'paid',
  257. total_in_cents: 720,
  258. tax_in_cents: 12,
  259. address: {
  260. country: 'Liurnia',
  261. },
  262. collection_method: 'automatic',
  263. subscription_ids: ['abcd1234', 'defa3214'],
  264. }
  265. this.RecurlyEventHandler.sendRecurlyAnalyticsEvent(
  266. 'paid_charge_invoice_notification',
  267. {
  268. account: {
  269. account_code: this.userId,
  270. },
  271. invoice,
  272. }
  273. )
  274. sinon.assert.calledWith(
  275. this.AnalyticsManager.recordEventForUser,
  276. this.userId,
  277. 'subscription-invoice-collected',
  278. {
  279. invoiceNumber: invoice.invoice_number,
  280. currency: invoice.currency,
  281. totalInCents: invoice.total_in_cents,
  282. taxInCents: invoice.tax_in_cents,
  283. country: invoice.address.country,
  284. collectionMethod: invoice.collection_method,
  285. subscriptionId1: invoice.subscription_ids[0],
  286. subscriptionId2: invoice.subscription_ids[1],
  287. }
  288. )
  289. })
  290. it('with paid_charge_invoice_notification and total_in_cents 0', function () {
  291. this.RecurlyEventHandler.sendRecurlyAnalyticsEvent(
  292. 'paid_charge_invoice_notification',
  293. {
  294. account: {
  295. account_code: this.userId,
  296. },
  297. invoice: {
  298. state: 'paid',
  299. total_in_cents: 0,
  300. },
  301. }
  302. )
  303. sinon.assert.notCalled(this.AnalyticsManager.recordEventForUser)
  304. })
  305. it('with closed_invoice_notification', function () {
  306. this.RecurlyEventHandler.sendRecurlyAnalyticsEvent(
  307. 'closed_invoice_notification',
  308. {
  309. account: {
  310. account_code: this.userId,
  311. },
  312. invoice: {
  313. state: 'collected',
  314. total_in_cents: 720,
  315. },
  316. }
  317. )
  318. sinon.assert.calledWith(
  319. this.AnalyticsManager.recordEventForUser,
  320. this.userId,
  321. 'subscription-invoice-collected'
  322. )
  323. })
  324. it('with closed_invoice_notification and total_in_cents 0', function () {
  325. this.RecurlyEventHandler.sendRecurlyAnalyticsEvent(
  326. 'closed_invoice_notification',
  327. {
  328. account: {
  329. account_code: this.userId,
  330. },
  331. invoice: {
  332. state: 'collected',
  333. total_in_cents: 0,
  334. },
  335. }
  336. )
  337. sinon.assert.notCalled(this.AnalyticsManager.recordEventForUser)
  338. })
  339. it('nothing is called with invalid account code', function () {
  340. this.eventData.account.account_code = 'foo_bar'
  341. this.RecurlyEventHandler.sendRecurlyAnalyticsEvent(
  342. 'new_subscription_notification',
  343. this.eventData
  344. )
  345. sinon.assert.notCalled(this.AnalyticsManager.recordEventForUser)
  346. sinon.assert.notCalled(this.AnalyticsManager.setUserPropertyForUser)
  347. sinon.assert.notCalled(this.AnalyticsManager.setUserPropertyForUser)
  348. sinon.assert.notCalled(this.AnalyticsManager.setUserPropertyForUser)
  349. })
  350. })