SubscriptionController.js 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514
  1. const SessionManager = require('../Authentication/SessionManager')
  2. const SubscriptionHandler = require('./SubscriptionHandler')
  3. const PlansLocator = require('./PlansLocator')
  4. const SubscriptionViewModelBuilder = require('./SubscriptionViewModelBuilder')
  5. const LimitationsManager = require('./LimitationsManager')
  6. const RecurlyWrapper = require('./RecurlyWrapper')
  7. const Settings = require('@overleaf/settings')
  8. const logger = require('@overleaf/logger')
  9. const GeoIpLookup = require('../../infrastructure/GeoIpLookup')
  10. const FeaturesUpdater = require('./FeaturesUpdater')
  11. const planFeatures = require('./planFeatures')
  12. const GroupPlansData = require('./GroupPlansData')
  13. const V1SubscriptionManager = require('./V1SubscriptionManager')
  14. const Errors = require('../Errors/Errors')
  15. const HttpErrorHandler = require('../Errors/HttpErrorHandler')
  16. const SubscriptionErrors = require('./Errors')
  17. const AnalyticsManager = require('../Analytics/AnalyticsManager')
  18. const RecurlyEventHandler = require('./RecurlyEventHandler')
  19. const { expressify } = require('../../util/promises')
  20. const OError = require('@overleaf/o-error')
  21. const groupPlanModalOptions = Settings.groupPlanModalOptions
  22. const validGroupPlanModalOptions = {
  23. plan_code: groupPlanModalOptions.plan_codes.map(item => item.code),
  24. currency: groupPlanModalOptions.currencies.map(item => item.code),
  25. size: groupPlanModalOptions.sizes,
  26. usage: groupPlanModalOptions.usages.map(item => item.code),
  27. }
  28. async function plansPage(req, res) {
  29. const plans = SubscriptionViewModelBuilder.buildPlansList()
  30. const { currencyCode: recommendedCurrency } =
  31. await GeoIpLookup.promises.getCurrencyCode(
  32. (req.query ? req.query.ip : undefined) || req.ip
  33. )
  34. function getDefault(param, category, defaultValue) {
  35. const v = req.query && req.query[param]
  36. if (v && validGroupPlanModalOptions[category].includes(v)) {
  37. return v
  38. }
  39. return defaultValue
  40. }
  41. let defaultGroupPlanModalCurrency = 'USD'
  42. if (validGroupPlanModalOptions.currency.includes(recommendedCurrency)) {
  43. defaultGroupPlanModalCurrency = recommendedCurrency
  44. }
  45. const groupPlanModalDefaults = {
  46. plan_code: getDefault('plan', 'plan_code', 'collaborator'),
  47. size: getDefault('number', 'size', '10'),
  48. currency: getDefault('currency', 'currency', defaultGroupPlanModalCurrency),
  49. usage: getDefault('usage', 'usage', 'enterprise'),
  50. }
  51. res.render('subscriptions/plans-marketing', {
  52. title: 'plans_and_pricing',
  53. plans,
  54. gaExperiments: Settings.gaExperiments.plansPage,
  55. gaOptimize: true,
  56. itm_content: req.query && req.query.itm_content,
  57. recomendedCurrency: recommendedCurrency,
  58. recommendedCurrency,
  59. planFeatures,
  60. groupPlans: GroupPlansData,
  61. groupPlanModalOptions,
  62. groupPlanModalDefaults,
  63. })
  64. }
  65. // get to show the recurly.js page
  66. async function paymentPage(req, res) {
  67. const user = SessionManager.getSessionUser(req.session)
  68. const plan = PlansLocator.findLocalPlanInSettings(req.query.planCode)
  69. if (!plan) {
  70. return HttpErrorHandler.unprocessableEntity(req, res, 'Plan not found')
  71. }
  72. const hasSubscription =
  73. await LimitationsManager.promises.userHasV1OrV2Subscription(user)
  74. if (hasSubscription) {
  75. res.redirect('/user/subscription?hasSubscription=true')
  76. } else {
  77. // LimitationsManager.userHasV2Subscription only checks Mongo. Double check with
  78. // Recurly as well at this point (we don't do this most places for speed).
  79. const valid =
  80. await SubscriptionHandler.promises.validateNoSubscriptionInRecurly(
  81. user._id
  82. )
  83. if (!valid) {
  84. res.redirect('/user/subscription?hasSubscription=true')
  85. } else {
  86. let currency = null
  87. if (req.query.currency) {
  88. const queryCurrency = req.query.currency.toUpperCase()
  89. if (GeoIpLookup.isValidCurrencyParam(queryCurrency)) {
  90. currency = queryCurrency
  91. }
  92. }
  93. const { currencyCode: recommendedCurrency, countryCode } =
  94. await GeoIpLookup.promises.getCurrencyCode(
  95. (req.query ? req.query.ip : undefined) || req.ip
  96. )
  97. if (recommendedCurrency && currency == null) {
  98. currency = recommendedCurrency
  99. }
  100. res.render('subscriptions/new', {
  101. title: 'subscribe',
  102. currency,
  103. countryCode,
  104. plan,
  105. showStudentPlan: req.query.ssp === 'true',
  106. recurlyConfig: JSON.stringify({
  107. currency,
  108. subdomain: Settings.apis.recurly.subdomain,
  109. }),
  110. showCouponField: !!req.query.scf,
  111. showVatField: !!req.query.svf,
  112. gaOptimize: true,
  113. })
  114. }
  115. }
  116. }
  117. async function userSubscriptionPage(req, res) {
  118. const user = SessionManager.getSessionUser(req.session)
  119. const results =
  120. await SubscriptionViewModelBuilder.promises.buildUsersSubscriptionViewModel(
  121. user
  122. )
  123. const {
  124. personalSubscription,
  125. memberGroupSubscriptions,
  126. managedGroupSubscriptions,
  127. currentInstitutionsWithLicence,
  128. managedInstitutions,
  129. managedPublishers,
  130. v1SubscriptionStatus,
  131. } = results
  132. const hasSubscription =
  133. await LimitationsManager.promises.userHasV1OrV2Subscription(user)
  134. const fromPlansPage = req.query.hasSubscription
  135. const plans = SubscriptionViewModelBuilder.buildPlansList(
  136. personalSubscription ? personalSubscription.plan : undefined
  137. )
  138. AnalyticsManager.recordEventForSession(req.session, 'subscription-page-view')
  139. const data = {
  140. title: 'your_subscription',
  141. plans,
  142. groupPlans: GroupPlansData,
  143. user,
  144. hasSubscription,
  145. fromPlansPage,
  146. personalSubscription,
  147. memberGroupSubscriptions,
  148. managedGroupSubscriptions,
  149. managedInstitutions,
  150. managedPublishers,
  151. v1SubscriptionStatus,
  152. currentInstitutionsWithLicence,
  153. groupPlanModalOptions,
  154. }
  155. res.render('subscriptions/dashboard', data)
  156. }
  157. function createSubscription(req, res, next) {
  158. const user = SessionManager.getSessionUser(req.session)
  159. const recurlyTokenIds = {
  160. billing: req.body.recurly_token_id,
  161. threeDSecureActionResult:
  162. req.body.recurly_three_d_secure_action_result_token_id,
  163. }
  164. const { subscriptionDetails } = req.body
  165. LimitationsManager.userHasV1OrV2Subscription(
  166. user,
  167. function (err, hasSubscription) {
  168. if (err) {
  169. return next(err)
  170. }
  171. if (hasSubscription) {
  172. logger.warn({ user_id: user._id }, 'user already has subscription')
  173. return res.sendStatus(409) // conflict
  174. }
  175. return SubscriptionHandler.createSubscription(
  176. user,
  177. subscriptionDetails,
  178. recurlyTokenIds,
  179. function (err) {
  180. if (!err) {
  181. return res.sendStatus(201)
  182. }
  183. if (
  184. err instanceof SubscriptionErrors.RecurlyTransactionError ||
  185. err instanceof Errors.InvalidError
  186. ) {
  187. logger.error({ err }, 'recurly transaction error, potential 422')
  188. HttpErrorHandler.unprocessableEntity(
  189. req,
  190. res,
  191. err.message,
  192. OError.getFullInfo(err).public
  193. )
  194. } else {
  195. logger.warn(
  196. { err, user_id: user._id },
  197. 'something went wrong creating subscription'
  198. )
  199. next(err)
  200. }
  201. }
  202. )
  203. }
  204. )
  205. }
  206. function successfulSubscription(req, res, next) {
  207. const user = SessionManager.getSessionUser(req.session)
  208. return SubscriptionViewModelBuilder.buildUsersSubscriptionViewModel(
  209. user,
  210. function (error, { personalSubscription } = {}) {
  211. if (error) {
  212. return next(error)
  213. }
  214. if (personalSubscription == null) {
  215. res.redirect('/user/subscription/plans')
  216. } else {
  217. res.render('subscriptions/successful_subscription', {
  218. title: 'thank_you',
  219. personalSubscription,
  220. })
  221. }
  222. }
  223. )
  224. }
  225. function cancelSubscription(req, res, next) {
  226. const user = SessionManager.getSessionUser(req.session)
  227. logger.log({ user_id: user._id }, 'canceling subscription')
  228. SubscriptionHandler.cancelSubscription(user, function (err) {
  229. if (err) {
  230. OError.tag(err, 'something went wrong canceling subscription', {
  231. user_id: user._id,
  232. })
  233. return next(err)
  234. }
  235. // Note: this redirect isn't used in the main flow as the redirection is
  236. // handled by Angular
  237. res.redirect('/user/subscription/canceled')
  238. })
  239. }
  240. function canceledSubscription(req, res, next) {
  241. return res.render('subscriptions/canceled_subscription', {
  242. title: 'subscription_canceled',
  243. })
  244. }
  245. function cancelV1Subscription(req, res, next) {
  246. const userId = SessionManager.getLoggedInUserId(req.session)
  247. logger.log({ userId }, 'canceling v1 subscription')
  248. V1SubscriptionManager.cancelV1Subscription(userId, function (err) {
  249. if (err) {
  250. OError.tag(err, 'something went wrong canceling v1 subscription', {
  251. userId,
  252. })
  253. return next(err)
  254. }
  255. res.redirect('/user/subscription')
  256. })
  257. }
  258. function updateSubscription(req, res, next) {
  259. const origin = req && req.query ? req.query.origin : null
  260. const user = SessionManager.getSessionUser(req.session)
  261. const planCode = req.body.plan_code
  262. if (planCode == null) {
  263. const err = new Error('plan_code is not defined')
  264. logger.warn(
  265. { user_id: user._id, err, planCode, origin, body: req.body },
  266. '[Subscription] error in updateSubscription form'
  267. )
  268. return next(err)
  269. }
  270. logger.log({ planCode, user_id: user._id }, 'updating subscription')
  271. SubscriptionHandler.updateSubscription(user, planCode, null, function (err) {
  272. if (err) {
  273. OError.tag(err, 'something went wrong updating subscription', {
  274. user_id: user._id,
  275. })
  276. return next(err)
  277. }
  278. res.redirect('/user/subscription')
  279. })
  280. }
  281. function cancelPendingSubscriptionChange(req, res, next) {
  282. const user = SessionManager.getSessionUser(req.session)
  283. logger.log({ user_id: user._id }, 'canceling pending subscription change')
  284. SubscriptionHandler.cancelPendingSubscriptionChange(user, function (err) {
  285. if (err) {
  286. OError.tag(
  287. err,
  288. 'something went wrong canceling pending subscription change',
  289. {
  290. user_id: user._id,
  291. }
  292. )
  293. return next(err)
  294. }
  295. res.redirect('/user/subscription')
  296. })
  297. }
  298. function updateAccountEmailAddress(req, res, next) {
  299. const user = SessionManager.getSessionUser(req.session)
  300. RecurlyWrapper.updateAccountEmailAddress(
  301. user._id,
  302. user.email,
  303. function (error) {
  304. if (error) {
  305. return next(error)
  306. }
  307. res.sendStatus(200)
  308. }
  309. )
  310. }
  311. function reactivateSubscription(req, res, next) {
  312. const user = SessionManager.getSessionUser(req.session)
  313. logger.log({ user_id: user._id }, 'reactivating subscription')
  314. SubscriptionHandler.reactivateSubscription(user, function (err) {
  315. if (err) {
  316. OError.tag(err, 'something went wrong reactivating subscription', {
  317. user_id: user._id,
  318. })
  319. return next(err)
  320. }
  321. res.redirect('/user/subscription')
  322. })
  323. }
  324. function recurlyCallback(req, res, next) {
  325. logger.log({ data: req.body }, 'received recurly callback')
  326. const event = Object.keys(req.body)[0]
  327. const eventData = req.body[event]
  328. RecurlyEventHandler.sendRecurlyAnalyticsEvent(event, eventData)
  329. if (
  330. [
  331. 'new_subscription_notification',
  332. 'updated_subscription_notification',
  333. 'expired_subscription_notification',
  334. ].includes(event)
  335. ) {
  336. const recurlySubscription = eventData.subscription
  337. SubscriptionHandler.syncSubscription(
  338. recurlySubscription,
  339. { ip: req.ip },
  340. function (err) {
  341. if (err) {
  342. return next(err)
  343. }
  344. res.sendStatus(200)
  345. }
  346. )
  347. } else if (event === 'billing_info_updated_notification') {
  348. const recurlyAccountCode = eventData.account.account_code
  349. SubscriptionHandler.attemptPaypalInvoiceCollection(
  350. recurlyAccountCode,
  351. function (err) {
  352. if (err) {
  353. return next(err)
  354. }
  355. res.sendStatus(200)
  356. }
  357. )
  358. } else {
  359. res.sendStatus(200)
  360. }
  361. }
  362. function renderUpgradeToAnnualPlanPage(req, res, next) {
  363. const user = SessionManager.getSessionUser(req.session)
  364. LimitationsManager.userHasV2Subscription(
  365. user,
  366. function (err, hasSubscription, subscription) {
  367. let planName
  368. if (err) {
  369. return next(err)
  370. }
  371. const planCode = subscription
  372. ? subscription.planCode.toLowerCase()
  373. : undefined
  374. if ((planCode ? planCode.indexOf('annual') : undefined) !== -1) {
  375. planName = 'annual'
  376. } else if ((planCode ? planCode.indexOf('student') : undefined) !== -1) {
  377. planName = 'student'
  378. } else if (
  379. (planCode ? planCode.indexOf('collaborator') : undefined) !== -1
  380. ) {
  381. planName = 'collaborator'
  382. }
  383. if (hasSubscription) {
  384. res.render('subscriptions/upgradeToAnnual', {
  385. title: 'Upgrade to annual',
  386. planName,
  387. })
  388. } else {
  389. res.redirect('/user/subscription/plans')
  390. }
  391. }
  392. )
  393. }
  394. function processUpgradeToAnnualPlan(req, res, next) {
  395. const user = SessionManager.getSessionUser(req.session)
  396. const { planName } = req.body
  397. const couponCode = Settings.coupon_codes.upgradeToAnnualPromo[planName]
  398. const annualPlanName = `${planName}-annual`
  399. logger.log(
  400. { user_id: user._id, planName: annualPlanName },
  401. 'user is upgrading to annual billing with discount'
  402. )
  403. return SubscriptionHandler.updateSubscription(
  404. user,
  405. annualPlanName,
  406. couponCode,
  407. function (err) {
  408. if (err) {
  409. OError.tag(err, 'error updating subscription', {
  410. user_id: user._id,
  411. })
  412. return next(err)
  413. }
  414. res.sendStatus(200)
  415. }
  416. )
  417. }
  418. async function extendTrial(req, res) {
  419. const user = SessionManager.getSessionUser(req.session)
  420. const { subscription } =
  421. await LimitationsManager.promises.userHasV2Subscription(user)
  422. try {
  423. await SubscriptionHandler.promises.extendTrial(subscription, 14)
  424. AnalyticsManager.recordEventForSession(
  425. req.session,
  426. 'subscription-trial-extended'
  427. )
  428. } catch (error) {
  429. return res.sendStatus(500)
  430. }
  431. res.sendStatus(200)
  432. }
  433. function recurlyNotificationParser(req, res, next) {
  434. let xml = ''
  435. req.on('data', chunk => (xml += chunk))
  436. req.on('end', () =>
  437. RecurlyWrapper._parseXml(xml, function (error, body) {
  438. if (error) {
  439. return next(error)
  440. }
  441. req.body = body
  442. next()
  443. })
  444. )
  445. }
  446. async function refreshUserFeatures(req, res) {
  447. const { user_id: userId } = req.params
  448. await FeaturesUpdater.promises.refreshFeatures(userId, 'acceptance-test')
  449. res.sendStatus(200)
  450. }
  451. async function redirectToHostedPage(req, res) {
  452. const userId = SessionManager.getLoggedInUserId(req.session)
  453. const { pageType } = req.params
  454. const url =
  455. await SubscriptionViewModelBuilder.promises.getRedirectToHostedPage(
  456. userId,
  457. pageType
  458. )
  459. logger.warn({ userId, pageType }, 'redirecting to recurly hosted page')
  460. res.redirect(url)
  461. }
  462. module.exports = {
  463. plansPage: expressify(plansPage),
  464. paymentPage: expressify(paymentPage),
  465. userSubscriptionPage: expressify(userSubscriptionPage),
  466. createSubscription,
  467. successfulSubscription,
  468. cancelSubscription,
  469. canceledSubscription,
  470. cancelV1Subscription,
  471. updateSubscription,
  472. cancelPendingSubscriptionChange,
  473. updateAccountEmailAddress,
  474. reactivateSubscription,
  475. recurlyCallback,
  476. renderUpgradeToAnnualPlanPage,
  477. processUpgradeToAnnualPlan,
  478. extendTrial: expressify(extendTrial),
  479. recurlyNotificationParser,
  480. refreshUserFeatures: expressify(refreshUserFeatures),
  481. redirectToHostedPage: expressify(redirectToHostedPage),
  482. }