RecurlyEntitiesTest.js 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389
  1. // @ts-check
  2. const SandboxedModule = require('sandboxed-module')
  3. const { expect } = require('chai')
  4. const Errors = require('../../../../app/src/Features/Subscription/Errors')
  5. const {
  6. AI_ADD_ON_CODE,
  7. RecurlySubscriptionChangeRequest,
  8. RecurlySubscriptionChange,
  9. RecurlySubscription,
  10. RecurlySubscriptionAddOnUpdate,
  11. } = require('../../../../app/src/Features/Subscription/RecurlyEntities')
  12. const MODULE_PATH = '../../../../app/src/Features/Subscription/RecurlyEntities'
  13. describe('RecurlyEntities', function () {
  14. describe('RecurlySubscription', function () {
  15. beforeEach(function () {
  16. this.Settings = {
  17. plans: [
  18. { planCode: 'assistant-annual', price_in_cents: 5900 },
  19. { planCode: 'cheap-plan', price_in_cents: 500 },
  20. { planCode: 'regular-plan', price_in_cents: 1000 },
  21. { planCode: 'premium-plan', price_in_cents: 2000 },
  22. ],
  23. features: [],
  24. }
  25. this.RecurlyEntities = SandboxedModule.require(MODULE_PATH, {
  26. requires: {
  27. '@overleaf/settings': this.Settings,
  28. './Errors': Errors,
  29. },
  30. })
  31. })
  32. describe('with add-ons', function () {
  33. beforeEach(function () {
  34. const { RecurlySubscription, RecurlySubscriptionAddOn } =
  35. this.RecurlyEntities
  36. this.addOn = new RecurlySubscriptionAddOn({
  37. code: 'add-on-code',
  38. name: 'My Add-On',
  39. quantity: 1,
  40. unitPrice: 2,
  41. })
  42. this.subscription = new RecurlySubscription({
  43. id: 'subscription-id',
  44. userId: 'user-id',
  45. planCode: 'regular-plan',
  46. planName: 'My Plan',
  47. planPrice: 10,
  48. addOns: [this.addOn],
  49. subtotal: 10.99,
  50. taxRate: 0.2,
  51. taxAmount: 2.4,
  52. total: 14.4,
  53. currency: 'USD',
  54. })
  55. })
  56. describe('hasAddOn()', function () {
  57. it('returns true if the subscription has the given add-on', function () {
  58. expect(this.subscription.hasAddOn(this.addOn.code)).to.be.true
  59. })
  60. it("returns false if the subscription doesn't have the given add-on", function () {
  61. expect(this.subscription.hasAddOn('another-add-on')).to.be.false
  62. })
  63. })
  64. describe('getRequestForPlanChange()', function () {
  65. it('returns a change request for upgrades', function () {
  66. const { RecurlySubscriptionChangeRequest } = this.RecurlyEntities
  67. const changeRequest =
  68. this.subscription.getRequestForPlanChange('premium-plan')
  69. expect(changeRequest).to.deep.equal(
  70. new RecurlySubscriptionChangeRequest({
  71. subscription: this.subscription,
  72. timeframe: 'now',
  73. planCode: 'premium-plan',
  74. })
  75. )
  76. })
  77. it('returns a change request for downgrades', function () {
  78. const { RecurlySubscriptionChangeRequest } = this.RecurlyEntities
  79. const changeRequest =
  80. this.subscription.getRequestForPlanChange('cheap-plan')
  81. expect(changeRequest).to.deep.equal(
  82. new RecurlySubscriptionChangeRequest({
  83. subscription: this.subscription,
  84. timeframe: 'term_end',
  85. planCode: 'cheap-plan',
  86. })
  87. )
  88. })
  89. it('preserves the AI add-on on upgrades', function () {
  90. const { RecurlySubscriptionChangeRequest } = this.RecurlyEntities
  91. this.addOn.code = AI_ADD_ON_CODE
  92. const changeRequest =
  93. this.subscription.getRequestForPlanChange('premium-plan')
  94. expect(changeRequest).to.deep.equal(
  95. new RecurlySubscriptionChangeRequest({
  96. subscription: this.subscription,
  97. timeframe: 'now',
  98. planCode: 'premium-plan',
  99. addOnUpdates: [
  100. new RecurlySubscriptionAddOnUpdate({
  101. code: AI_ADD_ON_CODE,
  102. quantity: 1,
  103. }),
  104. ],
  105. })
  106. )
  107. })
  108. it('preserves the AI add-on on downgrades', function () {
  109. const { RecurlySubscriptionChangeRequest } = this.RecurlyEntities
  110. this.addOn.code = AI_ADD_ON_CODE
  111. const changeRequest =
  112. this.subscription.getRequestForPlanChange('cheap-plan')
  113. expect(changeRequest).to.deep.equal(
  114. new RecurlySubscriptionChangeRequest({
  115. subscription: this.subscription,
  116. timeframe: 'term_end',
  117. planCode: 'cheap-plan',
  118. addOnUpdates: [
  119. new RecurlySubscriptionAddOnUpdate({
  120. code: AI_ADD_ON_CODE,
  121. quantity: 1,
  122. }),
  123. ],
  124. })
  125. )
  126. })
  127. it('preserves the AI add-on on upgrades from the standalone AI plan', function () {
  128. const { RecurlySubscriptionChangeRequest } = this.RecurlyEntities
  129. this.subscription.planCode = 'assistant-annual'
  130. this.subscription.addOns = []
  131. const changeRequest =
  132. this.subscription.getRequestForPlanChange('cheap-plan')
  133. expect(changeRequest).to.deep.equal(
  134. new RecurlySubscriptionChangeRequest({
  135. subscription: this.subscription,
  136. timeframe: 'term_end',
  137. planCode: 'cheap-plan',
  138. addOnUpdates: [
  139. new RecurlySubscriptionAddOnUpdate({
  140. code: AI_ADD_ON_CODE,
  141. quantity: 1,
  142. }),
  143. ],
  144. })
  145. )
  146. })
  147. })
  148. describe('getRequestForAddOnPurchase()', function () {
  149. it('returns a change request', function () {
  150. const {
  151. RecurlySubscriptionChangeRequest,
  152. RecurlySubscriptionAddOnUpdate,
  153. } = this.RecurlyEntities
  154. const changeRequest =
  155. this.subscription.getRequestForAddOnPurchase('another-add-on')
  156. expect(changeRequest).to.deep.equal(
  157. new RecurlySubscriptionChangeRequest({
  158. subscription: this.subscription,
  159. timeframe: 'now',
  160. addOnUpdates: [
  161. new RecurlySubscriptionAddOnUpdate({
  162. code: this.addOn.code,
  163. quantity: this.addOn.quantity,
  164. unitPrice: this.addOn.unitPrice,
  165. }),
  166. new RecurlySubscriptionAddOnUpdate({
  167. code: 'another-add-on',
  168. quantity: 1,
  169. }),
  170. ],
  171. })
  172. )
  173. })
  174. it('returns a change request with quantity and unit price specified', function () {
  175. const {
  176. RecurlySubscriptionChangeRequest,
  177. RecurlySubscriptionAddOnUpdate,
  178. } = this.RecurlyEntities
  179. const quantity = 5
  180. const unitPrice = 10
  181. const changeRequest = this.subscription.getRequestForAddOnPurchase(
  182. 'another-add-on',
  183. quantity,
  184. unitPrice
  185. )
  186. expect(changeRequest).to.deep.equal(
  187. new RecurlySubscriptionChangeRequest({
  188. subscription: this.subscription,
  189. timeframe: 'now',
  190. addOnUpdates: [
  191. new RecurlySubscriptionAddOnUpdate({
  192. code: this.addOn.code,
  193. quantity: this.addOn.quantity,
  194. unitPrice: this.addOn.unitPrice,
  195. }),
  196. new RecurlySubscriptionAddOnUpdate({
  197. code: 'another-add-on',
  198. quantity,
  199. unitPrice,
  200. }),
  201. ],
  202. })
  203. )
  204. })
  205. it('throws a DuplicateAddOnError if the subscription already has the add-on', function () {
  206. expect(() =>
  207. this.subscription.getRequestForAddOnPurchase(this.addOn.code)
  208. ).to.throw(Errors.DuplicateAddOnError)
  209. })
  210. })
  211. describe('getRequestForAddOnUpdate()', function () {
  212. it('returns a change request', function () {
  213. const {
  214. RecurlySubscriptionChangeRequest,
  215. RecurlySubscriptionAddOnUpdate,
  216. } = this.RecurlyEntities
  217. const newQuantity = 2
  218. const changeRequest = this.subscription.getRequestForAddOnUpdate(
  219. 'add-on-code',
  220. newQuantity
  221. )
  222. expect(changeRequest).to.deep.equal(
  223. new RecurlySubscriptionChangeRequest({
  224. subscription: this.subscription,
  225. timeframe: 'now',
  226. addOnUpdates: [
  227. new RecurlySubscriptionAddOnUpdate({
  228. code: this.addOn.code,
  229. quantity: newQuantity,
  230. unitPrice: this.addOn.unitPrice,
  231. }),
  232. ],
  233. })
  234. )
  235. })
  236. it("throws a AddOnNotPresentError if the subscription doesn't have the add-on", function () {
  237. expect(() =>
  238. this.subscription.getRequestForAddOnUpdate('another-add-on', 2)
  239. ).to.throw(Errors.AddOnNotPresentError)
  240. })
  241. })
  242. describe('getRequestForAddOnRemoval()', function () {
  243. it('returns a change request', function () {
  244. const changeRequest = this.subscription.getRequestForAddOnRemoval(
  245. this.addOn.code
  246. )
  247. expect(changeRequest).to.deep.equal(
  248. new RecurlySubscriptionChangeRequest({
  249. subscription: this.subscription,
  250. timeframe: 'term_end',
  251. addOnUpdates: [],
  252. })
  253. )
  254. })
  255. it("throws an AddOnNotPresentError if the subscription doesn't have the add-on", function () {
  256. expect(() =>
  257. this.subscription.getRequestForAddOnRemoval('another-add-on')
  258. ).to.throw(Errors.AddOnNotPresentError)
  259. })
  260. })
  261. describe('getRequestForGroupPlanUpgrade()', function () {
  262. it('returns a correct change request', function () {
  263. const changeRequest =
  264. this.subscription.getRequestForGroupPlanUpgrade('test_plan_code')
  265. const addOns = [
  266. new RecurlySubscriptionAddOnUpdate({
  267. code: 'add-on-code',
  268. quantity: 1,
  269. }),
  270. ]
  271. expect(changeRequest).to.deep.equal(
  272. new RecurlySubscriptionChangeRequest({
  273. subscription: this.subscription,
  274. timeframe: 'now',
  275. addOnUpdates: addOns,
  276. planCode: 'test_plan_code',
  277. })
  278. )
  279. })
  280. })
  281. describe('without add-ons', function () {
  282. beforeEach(function () {
  283. const { RecurlySubscription } = this.RecurlyEntities
  284. this.subscription = new RecurlySubscription({
  285. id: 'subscription-id',
  286. userId: 'user-id',
  287. planCode: 'regular-plan',
  288. planName: 'My Plan',
  289. planPrice: 10,
  290. subtotal: 10.99,
  291. taxRate: 0.2,
  292. taxAmount: 2.4,
  293. total: 14.4,
  294. currency: 'USD',
  295. })
  296. })
  297. describe('hasAddOn()', function () {
  298. it('returns false for any add-on', function () {
  299. expect(this.subscription.hasAddOn('some-add-on')).to.be.false
  300. })
  301. })
  302. describe('getRequestForAddOnPurchase()', function () {
  303. it('returns a change request', function () {
  304. const {
  305. RecurlySubscriptionChangeRequest,
  306. RecurlySubscriptionAddOnUpdate,
  307. } = this.RecurlyEntities
  308. const changeRequest =
  309. this.subscription.getRequestForAddOnPurchase('some-add-on')
  310. expect(changeRequest).to.deep.equal(
  311. new RecurlySubscriptionChangeRequest({
  312. subscription: this.subscription,
  313. timeframe: 'now',
  314. addOnUpdates: [
  315. new RecurlySubscriptionAddOnUpdate({
  316. code: 'some-add-on',
  317. quantity: 1,
  318. }),
  319. ],
  320. })
  321. )
  322. })
  323. })
  324. describe('getRequestForAddOnRemoval()', function () {
  325. it('throws an AddOnNotPresentError', function () {
  326. expect(() =>
  327. this.subscription.getRequestForAddOnRemoval('some-add-on')
  328. ).to.throw(Errors.AddOnNotPresentError)
  329. })
  330. })
  331. })
  332. })
  333. })
  334. describe('RecurlySubscriptionChange', function () {
  335. describe('constructor', function () {
  336. it('rounds the amounts when calculating the taxes', function () {
  337. const subscription = new RecurlySubscription({
  338. id: 'subscription-id',
  339. userId: 'user-id',
  340. planCode: 'premium-plan',
  341. planName: 'Premium plan',
  342. planPrice: 10,
  343. subtotal: 10,
  344. taxRate: 0.15,
  345. taxAmount: 1.5,
  346. currency: 'USD',
  347. total: 11.5,
  348. periodStart: new Date(),
  349. periodEnd: new Date(),
  350. collectionMethod: 'automatic',
  351. })
  352. const change = new RecurlySubscriptionChange({
  353. subscription,
  354. nextPlanCode: 'promotional-plan',
  355. nextPlanName: 'Promotial plan',
  356. nextPlanPrice: 8.99,
  357. nextAddOns: [],
  358. })
  359. expect(change.tax).to.equal(1.35)
  360. expect(change.total).to.equal(10.34)
  361. })
  362. })
  363. })
  364. })