SubscriptionController.js 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852
  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 plansConfig = require('./plansConfig')
  13. const interstitialPaymentConfig = require('./interstitialPaymentConfig')
  14. const GroupPlansData = require('./GroupPlansData')
  15. const V1SubscriptionManager = require('./V1SubscriptionManager')
  16. const Errors = require('../Errors/Errors')
  17. const HttpErrorHandler = require('../Errors/HttpErrorHandler')
  18. const SubscriptionErrors = require('./Errors')
  19. const AnalyticsManager = require('../Analytics/AnalyticsManager')
  20. const RecurlyEventHandler = require('./RecurlyEventHandler')
  21. const { expressify } = require('../../util/promises')
  22. const OError = require('@overleaf/o-error')
  23. const SplitTestHandler = require('../SplitTests/SplitTestHandler')
  24. const SubscriptionHelper = require('./SubscriptionHelper')
  25. const Features = require('../../infrastructure/Features')
  26. const UserGetter = require('../User/UserGetter')
  27. const groupPlanModalOptions = Settings.groupPlanModalOptions
  28. const validGroupPlanModalOptions = {
  29. plan_code: groupPlanModalOptions.plan_codes.map(item => item.code),
  30. currency: groupPlanModalOptions.currencies.map(item => item.code),
  31. size: groupPlanModalOptions.sizes,
  32. usage: groupPlanModalOptions.usages.map(item => item.code),
  33. }
  34. async function plansPage(req, res) {
  35. const plans = SubscriptionViewModelBuilder.buildPlansList()
  36. let currency = null
  37. const queryCurrency = req.query.currency?.toUpperCase()
  38. if (GeoIpLookup.isValidCurrencyParam(queryCurrency)) {
  39. currency = queryCurrency
  40. }
  41. const {
  42. recommendedCurrency,
  43. countryCode,
  44. geoPricingINRTestVariant,
  45. geoPricingLATAMTestVariant,
  46. } = await _getRecommendedCurrency(req, res)
  47. if (recommendedCurrency && currency == null) {
  48. currency = recommendedCurrency
  49. }
  50. function getDefault(param, category, defaultValue) {
  51. const v = req.query && req.query[param]
  52. if (v && validGroupPlanModalOptions[category].includes(v)) {
  53. return v
  54. }
  55. return defaultValue
  56. }
  57. const currentView = 'annual'
  58. let defaultGroupPlanModalCurrency = 'USD'
  59. if (validGroupPlanModalOptions.currency.includes(currency)) {
  60. defaultGroupPlanModalCurrency = currency
  61. }
  62. const groupPlanModalDefaults = {
  63. plan_code: getDefault('plan', 'plan_code', 'collaborator'),
  64. size: getDefault('number', 'size', '2'),
  65. currency: getDefault('currency', 'currency', defaultGroupPlanModalCurrency),
  66. usage: getDefault('usage', 'usage', 'enterprise'),
  67. }
  68. let showInrGeoBanner, inrGeoBannerSplitTestName
  69. let inrGeoBannerVariant = 'default'
  70. if (countryCode === 'IN') {
  71. inrGeoBannerSplitTestName =
  72. geoPricingINRTestVariant === 'inr'
  73. ? 'geo-banners-inr-2'
  74. : 'geo-banners-inr-1'
  75. try {
  76. const geoBannerAssignment = await SplitTestHandler.promises.getAssignment(
  77. req,
  78. res,
  79. inrGeoBannerSplitTestName
  80. )
  81. inrGeoBannerVariant = geoBannerAssignment.variant
  82. if (inrGeoBannerVariant !== 'default') {
  83. showInrGeoBanner = true
  84. }
  85. } catch (error) {
  86. logger.error(
  87. { err: error },
  88. `Failed to get INR geo banner lookup or assignment (${inrGeoBannerSplitTestName})`
  89. )
  90. }
  91. }
  92. // annual plans with the free trial option split test - nudge variant
  93. let annualTrialsAssignment = { variant: 'default' }
  94. try {
  95. annualTrialsAssignment = await SplitTestHandler.promises.getAssignment(
  96. req,
  97. res,
  98. 'annual-trials'
  99. )
  100. } catch (error) {
  101. logger.error(
  102. { err: error },
  103. 'failed to get "annualTrialsAssignment" split test assignment'
  104. )
  105. }
  106. const plansPageViewSegmentation = {
  107. currency: recommendedCurrency,
  108. countryCode,
  109. 'geo-pricing-inr-group': geoPricingINRTestVariant,
  110. 'geo-pricing-inr-page': currency === 'INR' ? 'inr' : 'default',
  111. 'geo-pricing-latam-group': geoPricingLATAMTestVariant,
  112. 'geo-pricing-latam-page': ['BRL', 'MXN', 'COP', 'CLP', 'PEN'].includes(
  113. currency
  114. )
  115. ? 'latam'
  116. : 'default',
  117. 'annual-trials': annualTrialsAssignment.variant,
  118. }
  119. if (inrGeoBannerSplitTestName) {
  120. plansPageViewSegmentation[inrGeoBannerSplitTestName] = inrGeoBannerVariant
  121. }
  122. let showBackToSchoolBanner
  123. const userId = SessionManager.getLoggedInUserId(req.session)
  124. if (userId) {
  125. const usersBestSubscription =
  126. await SubscriptionViewModelBuilder.promises.getBestSubscription({
  127. _id: userId,
  128. })
  129. showBackToSchoolBanner = usersBestSubscription?.type === 'free'
  130. }
  131. AnalyticsManager.recordEventForSession(
  132. req.session,
  133. 'plans-page-view',
  134. plansPageViewSegmentation
  135. )
  136. res.render('subscriptions/plans', {
  137. title: 'plans_and_pricing',
  138. currentView,
  139. plans,
  140. itm_content: req.query?.itm_content,
  141. itm_referrer: req.query?.itm_referrer,
  142. itm_campaign: 'plans',
  143. recommendedCurrency: currency,
  144. planFeatures,
  145. plansConfig,
  146. groupPlans: GroupPlansData,
  147. groupPlanModalOptions,
  148. groupPlanModalDefaults,
  149. initialLocalizedGroupPrice:
  150. SubscriptionHelper.generateInitialLocalizedGroupPrice(currency),
  151. showInrGeoBanner,
  152. showBackToSchoolBanner,
  153. annualTrialsAssignment: annualTrialsAssignment?.variant,
  154. })
  155. }
  156. /**
  157. * @param {import('express').Request} req
  158. * @param {import('express').Response} res
  159. * @returns {Promise<void>}
  160. */
  161. async function paymentPage(req, res) {
  162. const user = SessionManager.getSessionUser(req.session)
  163. const plan = PlansLocator.findLocalPlanInSettings(req.query.planCode)
  164. if (!plan) {
  165. return HttpErrorHandler.unprocessableEntity(req, res, 'Plan not found')
  166. }
  167. const hasSubscription =
  168. await LimitationsManager.promises.userHasV1OrV2Subscription(user)
  169. if (hasSubscription) {
  170. res.redirect('/user/subscription?hasSubscription=true')
  171. } else {
  172. // LimitationsManager.userHasV2Subscription only checks Mongo. Double check with
  173. // Recurly as well at this point (we don't do this most places for speed).
  174. const valid =
  175. await SubscriptionHandler.promises.validateNoSubscriptionInRecurly(
  176. user._id
  177. )
  178. if (!valid) {
  179. res.redirect('/user/subscription?hasSubscription=true')
  180. } else {
  181. let currency = null
  182. if (req.query.currency) {
  183. const queryCurrency = req.query.currency.toUpperCase()
  184. if (GeoIpLookup.isValidCurrencyParam(queryCurrency)) {
  185. currency = queryCurrency
  186. }
  187. }
  188. const { recommendedCurrency, countryCode } =
  189. await _getRecommendedCurrency(req, res)
  190. if (recommendedCurrency && currency == null) {
  191. currency = recommendedCurrency
  192. }
  193. // Prevent checkout for users without a confirmed primary email address
  194. const userData = await UserGetter.promises.getUser(user._id, {
  195. email: 1,
  196. emails: 1,
  197. })
  198. const userPrimaryEmail = userData.emails.find(
  199. emailEntry => emailEntry.email === userData.email
  200. )
  201. if (userPrimaryEmail?.confirmedAt == null) {
  202. return res.render('subscriptions/unconfirmed-primary-email', {
  203. title: 'confirm_email',
  204. email: userData.email,
  205. })
  206. }
  207. // Block web sales to restricted countries
  208. if (['CU', 'IR', 'KP', 'RU', 'SY', 'VE'].includes(countryCode)) {
  209. return res.render('subscriptions/restricted-country', {
  210. title: 'restricted',
  211. })
  212. }
  213. res.render('subscriptions/new-react', {
  214. title: 'subscribe',
  215. currency,
  216. countryCode,
  217. plan,
  218. planCode: req.query.planCode,
  219. couponCode: req.query.cc,
  220. showCouponField: !!req.query.scf,
  221. itm_campaign: req.query.itm_campaign,
  222. itm_content: req.query.itm_content,
  223. itm_referrer: req.query.itm_referrer,
  224. })
  225. }
  226. }
  227. }
  228. function formatGroupPlansDataForDash() {
  229. return {
  230. plans: [...groupPlanModalOptions.plan_codes],
  231. sizes: [...groupPlanModalOptions.sizes],
  232. usages: [...groupPlanModalOptions.usages],
  233. priceByUsageTypeAndSize: JSON.parse(JSON.stringify(GroupPlansData)),
  234. }
  235. }
  236. /**
  237. * @param {import('express').Request} req
  238. * @param {import('express').Response} res
  239. * @returns {Promise<void>}
  240. */
  241. async function userSubscriptionPage(req, res) {
  242. const user = SessionManager.getSessionUser(req.session)
  243. const results =
  244. await SubscriptionViewModelBuilder.promises.buildUsersSubscriptionViewModel(
  245. user
  246. )
  247. const {
  248. personalSubscription,
  249. memberGroupSubscriptions,
  250. managedGroupSubscriptions,
  251. currentInstitutionsWithLicence,
  252. managedInstitutions,
  253. managedPublishers,
  254. } = results
  255. const hasSubscription =
  256. await LimitationsManager.promises.userHasV1OrV2Subscription(user)
  257. const fromPlansPage = req.query.hasSubscription
  258. const plansData =
  259. SubscriptionViewModelBuilder.buildPlansListForSubscriptionDash(
  260. personalSubscription?.plan
  261. )
  262. AnalyticsManager.recordEventForSession(req.session, 'subscription-page-view')
  263. const cancelButtonAssignment = await SplitTestHandler.promises.getAssignment(
  264. req,
  265. res,
  266. 'subscription-cancel-button'
  267. )
  268. const cancelButtonNewCopy = cancelButtonAssignment?.variant === 'new-copy'
  269. const groupPlansDataForDash = formatGroupPlansDataForDash()
  270. // display the Group Settings button only to admins of group subscriptions with the Managed Users feature available
  271. const groupSettingsEnabledFor = (managedGroupSubscriptions || [])
  272. .filter(
  273. subscription =>
  274. Features.hasFeature('saas') &&
  275. subscription?.features?.managedUsers &&
  276. (subscription.admin_id._id || subscription.admin_id).toString() ===
  277. user._id.toString()
  278. )
  279. .map(subscription => subscription._id.toString())
  280. const data = {
  281. title: 'your_subscription',
  282. plans: plansData?.plans,
  283. planCodesChangingAtTermEnd: plansData?.planCodesChangingAtTermEnd,
  284. user,
  285. hasSubscription,
  286. fromPlansPage,
  287. personalSubscription,
  288. memberGroupSubscriptions,
  289. managedGroupSubscriptions,
  290. managedInstitutions,
  291. managedPublishers,
  292. currentInstitutionsWithLicence,
  293. cancelButtonNewCopy,
  294. groupPlans: groupPlansDataForDash,
  295. groupSettingsEnabledFor,
  296. isManagedAccount: !!req.managedBy,
  297. userRestrictions: Array.from(req.userRestrictions || []),
  298. }
  299. res.render('subscriptions/dashboard-react', data)
  300. }
  301. async function interstitialPaymentPage(req, res) {
  302. const user = SessionManager.getSessionUser(req.session)
  303. const {
  304. recommendedCurrency,
  305. countryCode,
  306. geoPricingINRTestVariant,
  307. geoPricingLATAMTestVariant,
  308. } = await _getRecommendedCurrency(req, res)
  309. const hasSubscription =
  310. await LimitationsManager.promises.userHasV1OrV2Subscription(user)
  311. const showSkipLink = req.query?.skipLink === 'true'
  312. if (hasSubscription) {
  313. res.redirect('/user/subscription?hasSubscription=true')
  314. } else {
  315. let showInrGeoBanner, inrGeoBannerSplitTestName
  316. let inrGeoBannerVariant = 'default'
  317. if (countryCode === 'IN') {
  318. inrGeoBannerSplitTestName =
  319. geoPricingINRTestVariant === 'inr'
  320. ? 'geo-banners-inr-2'
  321. : 'geo-banners-inr-1'
  322. try {
  323. const geoBannerAssignment =
  324. await SplitTestHandler.promises.getAssignment(
  325. req,
  326. res,
  327. inrGeoBannerSplitTestName
  328. )
  329. inrGeoBannerVariant = geoBannerAssignment.variant
  330. if (inrGeoBannerVariant !== 'default') {
  331. showInrGeoBanner = true
  332. }
  333. } catch (error) {
  334. logger.error(
  335. { err: error },
  336. `Failed to get INR geo banner lookup or assignment (${inrGeoBannerSplitTestName})`
  337. )
  338. }
  339. }
  340. // annual plans with the free trial option split test - nudge variant
  341. let annualTrialsAssignment = { variant: 'default' }
  342. try {
  343. annualTrialsAssignment = await SplitTestHandler.promises.getAssignment(
  344. req,
  345. res,
  346. 'annual-trials'
  347. )
  348. } catch (error) {
  349. logger.error(
  350. { err: error },
  351. 'failed to get "annualTrialsAssignment" split test assignment'
  352. )
  353. }
  354. const paywallPlansPageViewSegmentation = {
  355. currency: recommendedCurrency,
  356. countryCode,
  357. 'geo-pricing-inr-group': geoPricingINRTestVariant,
  358. 'geo-pricing-inr-page': recommendedCurrency === 'INR' ? 'inr' : 'default',
  359. 'geo-pricing-latam-group': geoPricingLATAMTestVariant,
  360. 'geo-pricing-latam-page': ['BRL', 'MXN', 'COP', 'CLP', 'PEN'].includes(
  361. recommendedCurrency
  362. )
  363. ? 'latam'
  364. : 'default',
  365. 'annual-trials': annualTrialsAssignment.variant,
  366. }
  367. if (inrGeoBannerSplitTestName) {
  368. paywallPlansPageViewSegmentation[inrGeoBannerSplitTestName] =
  369. inrGeoBannerVariant
  370. }
  371. AnalyticsManager.recordEventForSession(
  372. req.session,
  373. 'paywall-plans-page-view',
  374. paywallPlansPageViewSegmentation
  375. )
  376. let templatePath
  377. switch (annualTrialsAssignment?.variant) {
  378. case 'nudge':
  379. templatePath = 'subscriptions/interstitial-payment_nudge_annual'
  380. break
  381. case 'no-nudge':
  382. templatePath = 'subscriptions/interstitial-payment_no_nudge_monthly'
  383. break
  384. default:
  385. templatePath = 'subscriptions/interstitial-payment'
  386. }
  387. res.render(templatePath, {
  388. title: 'subscribe',
  389. itm_content: req.query?.itm_content,
  390. itm_campaign: req.query?.itm_campaign,
  391. itm_referrer: req.query?.itm_referrer,
  392. recommendedCurrency,
  393. interstitialPaymentConfig,
  394. showSkipLink,
  395. showInrGeoBanner,
  396. })
  397. }
  398. }
  399. async function createSubscription(req, res) {
  400. const user = SessionManager.getSessionUser(req.session)
  401. const recurlyTokenIds = {
  402. billing: req.body.recurly_token_id,
  403. threeDSecureActionResult:
  404. req.body.recurly_three_d_secure_action_result_token_id,
  405. }
  406. const { subscriptionDetails } = req.body
  407. const hasSubscription =
  408. await LimitationsManager.promises.userHasV1OrV2Subscription(user)
  409. if (hasSubscription) {
  410. logger.warn({ userId: user._id }, 'user already has subscription')
  411. return res.sendStatus(409) // conflict
  412. }
  413. try {
  414. await SubscriptionHandler.promises.createSubscription(
  415. user,
  416. subscriptionDetails,
  417. recurlyTokenIds
  418. )
  419. res.sendStatus(201)
  420. } catch (err) {
  421. if (
  422. err instanceof SubscriptionErrors.RecurlyTransactionError ||
  423. err instanceof Errors.InvalidError
  424. ) {
  425. logger.error({ err }, 'recurly transaction error, potential 422')
  426. HttpErrorHandler.unprocessableEntity(
  427. req,
  428. res,
  429. err.message,
  430. OError.getFullInfo(err).public
  431. )
  432. } else {
  433. logger.warn(
  434. { err, userId: user._id },
  435. 'something went wrong creating subscription'
  436. )
  437. throw err
  438. }
  439. }
  440. }
  441. /**
  442. * @param {import('express').Request} req
  443. * @param {import('express').Response} res
  444. * @returns {Promise<void>}
  445. */
  446. async function successfulSubscription(req, res) {
  447. const user = SessionManager.getSessionUser(req.session)
  448. const { personalSubscription } =
  449. await SubscriptionViewModelBuilder.promises.buildUsersSubscriptionViewModel(
  450. user
  451. )
  452. const postCheckoutRedirect = req.session?.postCheckoutRedirect
  453. if (!personalSubscription) {
  454. res.redirect('/user/subscription/plans')
  455. } else {
  456. res.render('subscriptions/successful-subscription-react', {
  457. title: 'thank_you',
  458. personalSubscription,
  459. postCheckoutRedirect,
  460. })
  461. }
  462. }
  463. function cancelSubscription(req, res, next) {
  464. const user = SessionManager.getSessionUser(req.session)
  465. logger.debug({ userId: user._id }, 'canceling subscription')
  466. SubscriptionHandler.cancelSubscription(user, function (err) {
  467. if (err) {
  468. OError.tag(err, 'something went wrong canceling subscription', {
  469. user_id: user._id,
  470. })
  471. return next(err)
  472. }
  473. // Note: this redirect isn't used in the main flow as the redirection is
  474. // handled by Angular
  475. res.redirect('/user/subscription/canceled')
  476. })
  477. }
  478. /**
  479. * @param {import('express').Request} req
  480. * @param {import('express').Response} res
  481. * @param {import('express').NextFunction} next
  482. * @returns {Promise<void>}
  483. */
  484. function canceledSubscription(req, res, next) {
  485. return res.render('subscriptions/canceled-subscription-react', {
  486. title: 'subscription_canceled',
  487. })
  488. }
  489. function cancelV1Subscription(req, res, next) {
  490. const userId = SessionManager.getLoggedInUserId(req.session)
  491. logger.debug({ userId }, 'canceling v1 subscription')
  492. V1SubscriptionManager.cancelV1Subscription(userId, function (err) {
  493. if (err) {
  494. OError.tag(err, 'something went wrong canceling v1 subscription', {
  495. userId,
  496. })
  497. return next(err)
  498. }
  499. res.redirect('/user/subscription')
  500. })
  501. }
  502. function updateSubscription(req, res, next) {
  503. const origin = req && req.query ? req.query.origin : null
  504. const user = SessionManager.getSessionUser(req.session)
  505. const planCode = req.body.plan_code
  506. if (planCode == null) {
  507. const err = new Error('plan_code is not defined')
  508. logger.warn(
  509. { userId: user._id, err, planCode, origin, body: req.body },
  510. '[Subscription] error in updateSubscription form'
  511. )
  512. return next(err)
  513. }
  514. logger.debug({ planCode, userId: user._id }, 'updating subscription')
  515. SubscriptionHandler.updateSubscription(user, planCode, null, function (err) {
  516. if (err) {
  517. OError.tag(err, 'something went wrong updating subscription', {
  518. user_id: user._id,
  519. })
  520. return next(err)
  521. }
  522. res.redirect('/user/subscription')
  523. })
  524. }
  525. function cancelPendingSubscriptionChange(req, res, next) {
  526. const user = SessionManager.getSessionUser(req.session)
  527. logger.debug({ userId: user._id }, 'canceling pending subscription change')
  528. SubscriptionHandler.cancelPendingSubscriptionChange(user, function (err) {
  529. if (err) {
  530. OError.tag(
  531. err,
  532. 'something went wrong canceling pending subscription change',
  533. {
  534. user_id: user._id,
  535. }
  536. )
  537. return next(err)
  538. }
  539. res.redirect('/user/subscription')
  540. })
  541. }
  542. function updateAccountEmailAddress(req, res, next) {
  543. const user = SessionManager.getSessionUser(req.session)
  544. RecurlyWrapper.updateAccountEmailAddress(
  545. user._id,
  546. user.email,
  547. function (error) {
  548. if (error) {
  549. return next(error)
  550. }
  551. res.sendStatus(200)
  552. }
  553. )
  554. }
  555. function reactivateSubscription(req, res, next) {
  556. const user = SessionManager.getSessionUser(req.session)
  557. logger.debug({ userId: user._id }, 'reactivating subscription')
  558. try {
  559. if (req.isManagedGroupAdmin) {
  560. // allow admins to reactivate subscriptions
  561. } else {
  562. // otherwise require the user to have the reactivate-subscription permission
  563. req.assertPermission('reactivate-subscription')
  564. }
  565. } catch (error) {
  566. return next(error)
  567. }
  568. SubscriptionHandler.reactivateSubscription(user, function (err) {
  569. if (err) {
  570. OError.tag(err, 'something went wrong reactivating subscription', {
  571. user_id: user._id,
  572. })
  573. return next(err)
  574. }
  575. res.redirect('/user/subscription')
  576. })
  577. }
  578. function recurlyCallback(req, res, next) {
  579. logger.debug({ data: req.body }, 'received recurly callback')
  580. const event = Object.keys(req.body)[0]
  581. const eventData = req.body[event]
  582. RecurlyEventHandler.sendRecurlyAnalyticsEvent(event, eventData).catch(error =>
  583. logger.error(
  584. { err: error },
  585. 'Failed to process analytics event on Recurly webhook'
  586. )
  587. )
  588. if (
  589. [
  590. 'new_subscription_notification',
  591. 'updated_subscription_notification',
  592. 'expired_subscription_notification',
  593. ].includes(event)
  594. ) {
  595. const recurlySubscription = eventData.subscription
  596. SubscriptionHandler.syncSubscription(
  597. recurlySubscription,
  598. { ip: req.ip },
  599. function (err) {
  600. if (err) {
  601. return next(err)
  602. }
  603. res.sendStatus(200)
  604. }
  605. )
  606. } else if (event === 'billing_info_updated_notification') {
  607. const recurlyAccountCode = eventData.account.account_code
  608. SubscriptionHandler.attemptPaypalInvoiceCollection(
  609. recurlyAccountCode,
  610. function (err) {
  611. if (err) {
  612. return next(err)
  613. }
  614. res.sendStatus(200)
  615. }
  616. )
  617. } else {
  618. res.sendStatus(200)
  619. }
  620. }
  621. function renderUpgradeToAnnualPlanPage(req, res, next) {
  622. const user = SessionManager.getSessionUser(req.session)
  623. LimitationsManager.userHasV2Subscription(
  624. user,
  625. function (err, hasSubscription, subscription) {
  626. let planName
  627. if (err) {
  628. return next(err)
  629. }
  630. const planCode = subscription
  631. ? subscription.planCode.toLowerCase()
  632. : undefined
  633. if ((planCode ? planCode.indexOf('annual') : undefined) !== -1) {
  634. planName = 'annual'
  635. } else if ((planCode ? planCode.indexOf('student') : undefined) !== -1) {
  636. planName = 'student'
  637. } else if (
  638. (planCode ? planCode.indexOf('collaborator') : undefined) !== -1
  639. ) {
  640. planName = 'collaborator'
  641. }
  642. if (hasSubscription) {
  643. res.render('subscriptions/upgradeToAnnual', {
  644. title: 'Upgrade to annual',
  645. planName,
  646. })
  647. } else {
  648. res.redirect('/user/subscription/plans')
  649. }
  650. }
  651. )
  652. }
  653. function processUpgradeToAnnualPlan(req, res, next) {
  654. const user = SessionManager.getSessionUser(req.session)
  655. const { planName } = req.body
  656. const couponCode = Settings.coupon_codes.upgradeToAnnualPromo[planName]
  657. const annualPlanName = `${planName}-annual`
  658. logger.debug(
  659. { userId: user._id, planName: annualPlanName },
  660. 'user is upgrading to annual billing with discount'
  661. )
  662. return SubscriptionHandler.updateSubscription(
  663. user,
  664. annualPlanName,
  665. couponCode,
  666. function (err) {
  667. if (err) {
  668. OError.tag(err, 'error updating subscription', {
  669. user_id: user._id,
  670. })
  671. return next(err)
  672. }
  673. res.sendStatus(200)
  674. }
  675. )
  676. }
  677. async function extendTrial(req, res) {
  678. const user = SessionManager.getSessionUser(req.session)
  679. const { subscription } =
  680. await LimitationsManager.promises.userHasV2Subscription(user)
  681. try {
  682. await SubscriptionHandler.promises.extendTrial(subscription, 14)
  683. AnalyticsManager.recordEventForSession(
  684. req.session,
  685. 'subscription-trial-extended'
  686. )
  687. } catch (error) {
  688. return res.sendStatus(500)
  689. }
  690. res.sendStatus(200)
  691. }
  692. function recurlyNotificationParser(req, res, next) {
  693. let xml = ''
  694. req.on('data', chunk => (xml += chunk))
  695. req.on('end', () =>
  696. RecurlyWrapper._parseXml(xml, function (error, body) {
  697. if (error) {
  698. return next(error)
  699. }
  700. req.body = body
  701. next()
  702. })
  703. )
  704. }
  705. async function refreshUserFeatures(req, res) {
  706. const { user_id: userId } = req.params
  707. await FeaturesUpdater.promises.refreshFeatures(userId, 'acceptance-test')
  708. res.sendStatus(200)
  709. }
  710. async function redirectToHostedPage(req, res) {
  711. const userId = SessionManager.getLoggedInUserId(req.session)
  712. const { pageType } = req.params
  713. const url =
  714. await SubscriptionViewModelBuilder.promises.getRedirectToHostedPage(
  715. userId,
  716. pageType
  717. )
  718. logger.warn({ userId, pageType }, 'redirecting to recurly hosted page')
  719. res.redirect(url)
  720. }
  721. async function _getRecommendedCurrency(req, res) {
  722. const currencyLookup = await GeoIpLookup.promises.getCurrencyCode(
  723. req.query?.ip || req.ip
  724. )
  725. const countryCode = currencyLookup.countryCode
  726. let assignmentINR, assignmentLATAM
  727. let recommendedCurrency = currencyLookup.currencyCode
  728. // for #12703
  729. try {
  730. // Split test is kept active, but all users geolocated in India can
  731. // now use the INR currency (See #13507)
  732. assignmentINR = await SplitTestHandler.promises.getAssignment(
  733. req,
  734. res,
  735. 'geo-pricing-inr'
  736. )
  737. } catch (error) {
  738. logger.error(
  739. { err: error },
  740. 'Failed to get assignment for geo-pricing-inr test'
  741. )
  742. }
  743. // for #13559
  744. try {
  745. assignmentLATAM = await SplitTestHandler.promises.getAssignment(
  746. req,
  747. res,
  748. 'geo-pricing-latam'
  749. )
  750. } catch (error) {
  751. logger.error(
  752. { err: error },
  753. 'Failed to get assignment for geo-pricing-latam test'
  754. )
  755. }
  756. if (
  757. ['BRL', 'MXN', 'COP', 'CLP', 'PEN'].includes(recommendedCurrency) &&
  758. assignmentLATAM?.variant !== 'latam'
  759. ) {
  760. recommendedCurrency = GeoIpLookup.DEFAULT_CURRENCY_CODE
  761. }
  762. return {
  763. recommendedCurrency,
  764. countryCode,
  765. geoPricingINRTestVariant: assignmentINR?.variant,
  766. geoPricingLATAMTestVariant: assignmentLATAM?.variant,
  767. }
  768. }
  769. module.exports = {
  770. plansPage: expressify(plansPage),
  771. paymentPage: expressify(paymentPage),
  772. userSubscriptionPage: expressify(userSubscriptionPage),
  773. interstitialPaymentPage: expressify(interstitialPaymentPage),
  774. createSubscription: expressify(createSubscription),
  775. successfulSubscription: expressify(successfulSubscription),
  776. cancelSubscription,
  777. canceledSubscription,
  778. cancelV1Subscription,
  779. updateSubscription,
  780. cancelPendingSubscriptionChange,
  781. updateAccountEmailAddress,
  782. reactivateSubscription,
  783. recurlyCallback,
  784. renderUpgradeToAnnualPlanPage,
  785. processUpgradeToAnnualPlan,
  786. extendTrial: expressify(extendTrial),
  787. recurlyNotificationParser,
  788. refreshUserFeatures: expressify(refreshUserFeatures),
  789. redirectToHostedPage: expressify(redirectToHostedPage),
  790. }