SubscriptionController.js 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836
  1. // @ts-check
  2. const SessionManager = require('../Authentication/SessionManager')
  3. const SubscriptionHandler = require('./SubscriptionHandler')
  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 GroupPlansData = require('./GroupPlansData')
  12. const V1SubscriptionManager = require('./V1SubscriptionManager')
  13. const AnalyticsManager = require('../Analytics/AnalyticsManager')
  14. const RecurlyEventHandler = require('./RecurlyEventHandler')
  15. const { expressify } = require('@overleaf/promise-utils')
  16. const OError = require('@overleaf/o-error')
  17. const { DuplicateAddOnError, AddOnNotPresentError } = require('./Errors')
  18. const SplitTestHandler = require('../SplitTests/SplitTestHandler')
  19. const AuthorizationManager = require('../Authorization/AuthorizationManager')
  20. const Modules = require('../../infrastructure/Modules')
  21. const async = require('async')
  22. const HttpErrorHandler = require('../Errors/HttpErrorHandler')
  23. const RecurlyClient = require('./RecurlyClient')
  24. const { AI_ADD_ON_CODE } = require('./PaymentProviderEntities')
  25. const PlansLocator = require('./PlansLocator')
  26. const PaymentProviderEntities = require('./PaymentProviderEntities')
  27. const { User } = require('../../models/User')
  28. const UserGetter = require('../User/UserGetter')
  29. /**
  30. * @import { SubscriptionChangeDescription } from '../../../../types/subscription/subscription-change-preview'
  31. * @import { SubscriptionChangePreview } from '../../../../types/subscription/subscription-change-preview'
  32. * @import { PaymentProviderSubscriptionChange } from './PaymentProviderEntities'
  33. * @import { PaymentMethod } from './types'
  34. */
  35. const groupPlanModalOptions = Settings.groupPlanModalOptions
  36. function formatGroupPlansDataForDash() {
  37. return {
  38. plans: [...groupPlanModalOptions.plan_codes],
  39. sizes: [...groupPlanModalOptions.sizes],
  40. usages: [...groupPlanModalOptions.usages],
  41. priceByUsageTypeAndSize: JSON.parse(JSON.stringify(GroupPlansData)),
  42. }
  43. }
  44. async function userSubscriptionPage(req, res) {
  45. const user = SessionManager.getSessionUser(req.session)
  46. await SplitTestHandler.promises.getAssignment(req, res, 'pause-subscription')
  47. const groupPricingDiscount = await SplitTestHandler.promises.getAssignment(
  48. req,
  49. res,
  50. 'group-discount-10'
  51. )
  52. const showGroupDiscount = groupPricingDiscount.variant === 'enabled'
  53. const results =
  54. await SubscriptionViewModelBuilder.promises.buildUsersSubscriptionViewModel(
  55. user,
  56. req.i18n.language
  57. )
  58. const {
  59. personalSubscription,
  60. memberGroupSubscriptions,
  61. managedGroupSubscriptions,
  62. currentInstitutionsWithLicence,
  63. managedInstitutions,
  64. managedPublishers,
  65. } = results
  66. const { hasSubscription } =
  67. await LimitationsManager.promises.userHasSubscription(user)
  68. const userCanExtendTrial = (
  69. await Modules.promises.hooks.fire('userCanExtendTrial', user)
  70. )?.[0]
  71. const fromPlansPage = req.query.hasSubscription
  72. const plansData =
  73. SubscriptionViewModelBuilder.buildPlansListForSubscriptionDash(
  74. personalSubscription?.plan
  75. )
  76. AnalyticsManager.recordEventForSession(req.session, 'subscription-page-view')
  77. const groupPlansDataForDash = formatGroupPlansDataForDash()
  78. // display the Group settings button only to admins of group subscriptions with either/or the Managed Users or Group SSO feature available
  79. let groupSettingsEnabledFor
  80. try {
  81. const managedGroups = await async.filter(
  82. managedGroupSubscriptions || [],
  83. async subscription => {
  84. const managedUsersResults = await Modules.promises.hooks.fire(
  85. 'hasManagedUsersFeature',
  86. subscription
  87. )
  88. const groupSSOResults = await Modules.promises.hooks.fire(
  89. 'hasGroupSSOFeature',
  90. subscription
  91. )
  92. const isGroupAdmin =
  93. (subscription.admin_id._id || subscription.admin_id).toString() ===
  94. user._id.toString()
  95. return (
  96. (managedUsersResults?.[0] === true ||
  97. groupSSOResults?.[0] === true) &&
  98. isGroupAdmin
  99. )
  100. }
  101. )
  102. groupSettingsEnabledFor = managedGroups.map(subscription =>
  103. subscription._id.toString()
  104. )
  105. } catch (error) {
  106. logger.error(
  107. { err: error },
  108. 'Failed to list groups with group settings enabled'
  109. )
  110. }
  111. let groupSettingsAdvertisedFor
  112. try {
  113. const managedGroups = await async.filter(
  114. managedGroupSubscriptions || [],
  115. async subscription => {
  116. const managedUsersResults = await Modules.promises.hooks.fire(
  117. 'hasManagedUsersFeatureOnNonProfessionalPlan',
  118. subscription
  119. )
  120. const groupSSOResults = await Modules.promises.hooks.fire(
  121. 'hasGroupSSOFeatureOnNonProfessionalPlan',
  122. subscription
  123. )
  124. const isGroupAdmin =
  125. (subscription.admin_id._id || subscription.admin_id).toString() ===
  126. user._id.toString()
  127. const plan = PlansLocator.findLocalPlanInSettings(subscription.planCode)
  128. return (
  129. (managedUsersResults?.[0] === true ||
  130. groupSSOResults?.[0] === true) &&
  131. isGroupAdmin &&
  132. plan?.canUseFlexibleLicensing
  133. )
  134. }
  135. )
  136. groupSettingsAdvertisedFor = managedGroups.map(subscription =>
  137. subscription._id.toString()
  138. )
  139. } catch (error) {
  140. logger.error(
  141. { err: error },
  142. 'Failed to list groups with group settings enabled for advertising'
  143. )
  144. }
  145. const {
  146. isPremium: hasAiAssistViaWritefull,
  147. premiumSource: aiAssistViaWritefullSource,
  148. } = await UserGetter.promises.getWritefullData(user._id)
  149. const data = {
  150. title: 'your_subscription',
  151. plans: plansData?.plans,
  152. planCodesChangingAtTermEnd: plansData?.planCodesChangingAtTermEnd,
  153. user,
  154. hasSubscription,
  155. fromPlansPage,
  156. personalSubscription,
  157. userCanExtendTrial,
  158. memberGroupSubscriptions,
  159. managedGroupSubscriptions,
  160. managedInstitutions,
  161. managedPublishers,
  162. showGroupDiscount,
  163. currentInstitutionsWithLicence,
  164. canUseFlexibleLicensing:
  165. personalSubscription?.plan?.canUseFlexibleLicensing,
  166. groupPlans: groupPlansDataForDash,
  167. groupSettingsAdvertisedFor,
  168. groupSettingsEnabledFor,
  169. isManagedAccount: !!req.managedBy,
  170. userRestrictions: Array.from(req.userRestrictions || []),
  171. hasAiAssistViaWritefull,
  172. aiAssistViaWritefullSource,
  173. }
  174. res.render('subscriptions/dashboard-react', data)
  175. }
  176. async function successfulSubscription(req, res) {
  177. const user = SessionManager.getSessionUser(req.session)
  178. if (!user) {
  179. throw new Error('User is not logged in')
  180. }
  181. const { personalSubscription } =
  182. await SubscriptionViewModelBuilder.promises.buildUsersSubscriptionViewModel(
  183. user,
  184. req.i18n.language
  185. )
  186. const postCheckoutRedirect = req.session?.postCheckoutRedirect
  187. if (!personalSubscription) {
  188. res.redirect('/user/subscription/plans')
  189. } else {
  190. const userInDb = await User.findById(user._id, {
  191. _id: 1,
  192. features: 1,
  193. })
  194. if (!userInDb) {
  195. throw new Error('User not found')
  196. }
  197. res.render('subscriptions/successful-subscription-react', {
  198. title: 'thank_you',
  199. personalSubscription,
  200. postCheckoutRedirect,
  201. user: {
  202. _id: user._id,
  203. features: userInDb.features,
  204. },
  205. })
  206. }
  207. }
  208. async function pauseSubscription(req, res, next) {
  209. const user = SessionManager.getSessionUser(req.session)
  210. const pauseCycles = req.params.pauseCycles
  211. if (!('pauseCycles' in req.params)) {
  212. return HttpErrorHandler.badRequest(
  213. req,
  214. res,
  215. `Pausing subscription requires a 'pauseCycles' argument with number of billing cycles to pause for`
  216. )
  217. }
  218. if (pauseCycles < 0) {
  219. return HttpErrorHandler.badRequest(
  220. req,
  221. res,
  222. `'pauseCycles' should be a number of billing cycles to pause for, or 0 to cancel a pending pause`
  223. )
  224. }
  225. logger.debug(
  226. { userId: user._id },
  227. `pausing subscription for ${pauseCycles} billing cycles`
  228. )
  229. try {
  230. await SubscriptionHandler.promises.pauseSubscription(user, pauseCycles)
  231. const { subscription } =
  232. await LimitationsManager.promises.userHasSubscription(user)
  233. AnalyticsManager.recordEventForUserInBackground(
  234. user._id,
  235. 'subscription-pause-scheduled',
  236. {
  237. pause_length: pauseCycles,
  238. plan_code: subscription?.planCode,
  239. subscriptionId: subscription?.recurlySubscription_id,
  240. }
  241. )
  242. return res.sendStatus(200)
  243. } catch (err) {
  244. if (err instanceof Error) {
  245. OError.tag(err, 'something went wrong pausing subscription', {
  246. user_id: user._id,
  247. })
  248. }
  249. return next(err)
  250. }
  251. }
  252. async function resumeSubscription(req, res, next) {
  253. const user = SessionManager.getSessionUser(req.session)
  254. logger.debug({ userId: user._id }, `resuming subscription`)
  255. try {
  256. await SubscriptionHandler.promises.resumeSubscription(user)
  257. return res.sendStatus(200)
  258. } catch (err) {
  259. if (err instanceof Error) {
  260. OError.tag(err, 'something went wrong resuming subscription', {
  261. user_id: user._id,
  262. })
  263. }
  264. return next(err)
  265. }
  266. }
  267. function cancelSubscription(req, res, next) {
  268. const user = SessionManager.getSessionUser(req.session)
  269. logger.debug({ userId: user._id }, 'canceling subscription')
  270. SubscriptionHandler.cancelSubscription(user, function (err) {
  271. if (err) {
  272. OError.tag(err, 'something went wrong canceling subscription', {
  273. user_id: user._id,
  274. })
  275. return next(err)
  276. }
  277. // Note: this redirect isn't used in the main flow as the redirection is
  278. // handled by Angular
  279. res.redirect('/user/subscription/canceled')
  280. })
  281. }
  282. /**
  283. * @returns {Promise<void>}
  284. */
  285. async function canceledSubscription(req, res, next) {
  286. return res.render('subscriptions/canceled-subscription-react', {
  287. title: 'subscription_canceled',
  288. user: SessionManager.getSessionUser(req.session),
  289. })
  290. }
  291. function cancelV1Subscription(req, res, next) {
  292. const userId = SessionManager.getLoggedInUserId(req.session)
  293. logger.debug({ userId }, 'canceling v1 subscription')
  294. V1SubscriptionManager.cancelV1Subscription(userId, function (err) {
  295. if (err) {
  296. OError.tag(err, 'something went wrong canceling v1 subscription', {
  297. userId,
  298. })
  299. return next(err)
  300. }
  301. res.redirect('/user/subscription')
  302. })
  303. }
  304. async function previewAddonPurchase(req, res) {
  305. const userId = SessionManager.getLoggedInUserId(req.session)
  306. const addOnCode = req.params.addOnCode
  307. const purchaseReferrer = req.query.purchaseReferrer
  308. if (addOnCode !== AI_ADD_ON_CODE) {
  309. return HttpErrorHandler.notFound(req, res, `Unknown add-on: ${addOnCode}`)
  310. }
  311. /** @type {PaymentMethod[]} */
  312. const paymentMethod = await Modules.promises.hooks.fire(
  313. 'getPaymentMethod',
  314. userId
  315. )
  316. let subscriptionChange
  317. try {
  318. subscriptionChange =
  319. await SubscriptionHandler.promises.previewAddonPurchase(userId, addOnCode)
  320. const { isPremium: hasAiAssistViaWritefull } =
  321. await UserGetter.promises.getWritefullData(userId)
  322. const isAiUpgrade =
  323. PaymentProviderEntities.subscriptionChangeIsAiAssistUpgrade(
  324. subscriptionChange
  325. )
  326. if (hasAiAssistViaWritefull && isAiUpgrade) {
  327. return res.redirect(
  328. '/user/subscription?redirect-reason=writefull-entitled'
  329. )
  330. }
  331. } catch (err) {
  332. if (err instanceof DuplicateAddOnError) {
  333. return res.redirect('/user/subscription?redirect-reason=double-buy')
  334. }
  335. throw err
  336. }
  337. const subscription = subscriptionChange.subscription
  338. const addOn = await RecurlyClient.promises.getAddOn(
  339. subscription.planCode,
  340. addOnCode
  341. )
  342. /** @type {SubscriptionChangePreview} */
  343. const changePreview = makeChangePreview(
  344. {
  345. type: 'add-on-purchase',
  346. addOn: {
  347. code: addOn.code,
  348. name: addOn.name,
  349. },
  350. },
  351. subscriptionChange,
  352. paymentMethod[0]
  353. )
  354. await SplitTestHandler.promises.getAssignment(
  355. req,
  356. res,
  357. 'overleaf-assist-bundle'
  358. )
  359. res.render('subscriptions/preview-change', {
  360. changePreview,
  361. purchaseReferrer,
  362. })
  363. }
  364. async function purchaseAddon(req, res, next) {
  365. const user = SessionManager.getSessionUser(req.session)
  366. const addOnCode = req.params.addOnCode
  367. // currently we only support having a quantity of 1
  368. const quantity = 1
  369. // currently we only support one add-on, the Ai add-on
  370. if (addOnCode !== AI_ADD_ON_CODE) {
  371. return res.sendStatus(404)
  372. }
  373. logger.debug({ userId: user._id, addOnCode }, 'purchasing add-ons')
  374. try {
  375. await SubscriptionHandler.promises.purchaseAddon(
  376. user._id,
  377. addOnCode,
  378. quantity
  379. )
  380. } catch (err) {
  381. if (err instanceof DuplicateAddOnError) {
  382. HttpErrorHandler.badRequest(
  383. req,
  384. res,
  385. 'Your subscription already includes this add-on',
  386. { addon: addOnCode }
  387. )
  388. } else {
  389. if (err instanceof Error) {
  390. OError.tag(err, 'something went wrong purchasing add-ons', {
  391. user_id: user._id,
  392. addOnCode,
  393. })
  394. }
  395. return next(err)
  396. }
  397. }
  398. try {
  399. await FeaturesUpdater.promises.refreshFeatures(user._id, 'add-on-purchase')
  400. } catch (err) {
  401. logger.error({ err }, 'Failed to refresh features after add-on purchase')
  402. }
  403. return res.sendStatus(200)
  404. }
  405. async function removeAddon(req, res, next) {
  406. const user = SessionManager.getSessionUser(req.session)
  407. const addOnCode = req.params.addOnCode
  408. if (addOnCode !== AI_ADD_ON_CODE) {
  409. return res.sendStatus(404)
  410. }
  411. logger.debug({ userId: user._id, addOnCode }, 'removing add-ons')
  412. try {
  413. await SubscriptionHandler.promises.removeAddon(user._id, addOnCode)
  414. res.sendStatus(200)
  415. } catch (err) {
  416. if (err instanceof AddOnNotPresentError) {
  417. HttpErrorHandler.badRequest(
  418. req,
  419. res,
  420. 'Your subscription does not contain the requested add-on',
  421. { addon: addOnCode }
  422. )
  423. } else {
  424. if (err instanceof Error) {
  425. OError.tag(err, 'something went wrong removing add-ons', {
  426. user_id: user._id,
  427. addOnCode,
  428. })
  429. }
  430. return next(err)
  431. }
  432. }
  433. }
  434. async function previewSubscription(req, res, next) {
  435. const planCode = req.query.planCode
  436. if (!planCode) {
  437. return HttpErrorHandler.notFound(req, res, 'Missing plan code')
  438. }
  439. // TODO: use PaymentService to fetch plan information
  440. const plan = await RecurlyClient.promises.getPlan(planCode)
  441. const userId = SessionManager.getLoggedInUserId(req.session)
  442. const subscriptionChange =
  443. await SubscriptionHandler.promises.previewSubscriptionChange(
  444. userId,
  445. planCode
  446. )
  447. /** @type {PaymentMethod[]} */
  448. const paymentMethod = await Modules.promises.hooks.fire(
  449. 'getPaymentMethod',
  450. userId
  451. )
  452. const changePreview = makeChangePreview(
  453. {
  454. type: 'premium-subscription',
  455. plan: { code: plan.code, name: plan.name },
  456. },
  457. subscriptionChange,
  458. paymentMethod[0]
  459. )
  460. res.render('subscriptions/preview-change', { changePreview })
  461. }
  462. function cancelPendingSubscriptionChange(req, res, next) {
  463. const user = SessionManager.getSessionUser(req.session)
  464. logger.debug({ userId: user._id }, 'canceling pending subscription change')
  465. SubscriptionHandler.cancelPendingSubscriptionChange(user, function (err) {
  466. if (err) {
  467. OError.tag(
  468. err,
  469. 'something went wrong canceling pending subscription change',
  470. {
  471. user_id: user._id,
  472. }
  473. )
  474. return next(err)
  475. }
  476. res.redirect('/user/subscription')
  477. })
  478. }
  479. function updateAccountEmailAddress(req, res, next) {
  480. const user = SessionManager.getSessionUser(req.session)
  481. RecurlyWrapper.updateAccountEmailAddress(
  482. user._id,
  483. user.email,
  484. function (error) {
  485. if (error) {
  486. return next(error)
  487. }
  488. res.sendStatus(200)
  489. }
  490. )
  491. }
  492. function reactivateSubscription(req, res, next) {
  493. const user = SessionManager.getSessionUser(req.session)
  494. logger.debug({ userId: user._id }, 'reactivating subscription')
  495. try {
  496. if (req.isManagedGroupAdmin) {
  497. // allow admins to reactivate subscriptions
  498. } else {
  499. // otherwise require the user to have the reactivate-subscription permission
  500. req.assertPermission('reactivate-subscription')
  501. }
  502. } catch (error) {
  503. return next(error)
  504. }
  505. SubscriptionHandler.reactivateSubscription(user, function (err) {
  506. if (err) {
  507. OError.tag(err, 'something went wrong reactivating subscription', {
  508. user_id: user._id,
  509. })
  510. return next(err)
  511. }
  512. res.redirect('/user/subscription')
  513. })
  514. }
  515. function recurlyCallback(req, res, next) {
  516. logger.debug({ data: req.body }, 'received recurly callback')
  517. const event = Object.keys(req.body)[0]
  518. const eventData = req.body[event]
  519. RecurlyEventHandler.sendRecurlyAnalyticsEvent(event, eventData).catch(error =>
  520. logger.error(
  521. { err: error },
  522. 'Failed to process analytics event on Recurly webhook'
  523. )
  524. )
  525. if (
  526. [
  527. 'new_subscription_notification',
  528. 'updated_subscription_notification',
  529. 'expired_subscription_notification',
  530. 'subscription_paused_notification',
  531. 'subscription_resumed_notification',
  532. ].includes(event)
  533. ) {
  534. const recurlySubscription = eventData.subscription
  535. SubscriptionHandler.syncSubscription(
  536. recurlySubscription,
  537. { ip: req.ip },
  538. function (err) {
  539. if (err) {
  540. return next(err)
  541. }
  542. res.sendStatus(200)
  543. }
  544. )
  545. } else if (event === 'billing_info_updated_notification') {
  546. const recurlyAccountCode = eventData.account.account_code
  547. SubscriptionHandler.attemptPaypalInvoiceCollection(
  548. recurlyAccountCode,
  549. function (err) {
  550. if (err) {
  551. return next(err)
  552. }
  553. res.sendStatus(200)
  554. }
  555. )
  556. } else {
  557. res.sendStatus(200)
  558. }
  559. }
  560. async function extendTrial(req, res) {
  561. const user = SessionManager.getSessionUser(req.session)
  562. const { subscription } =
  563. await LimitationsManager.promises.userHasSubscription(user)
  564. const allowed = (
  565. await Modules.promises.hooks.fire('userCanExtendTrial', user)
  566. )?.[0]
  567. if (!allowed) {
  568. logger.warn({ userId: user._id }, 'user can not extend trial')
  569. return res.sendStatus(403)
  570. }
  571. try {
  572. await SubscriptionHandler.promises.extendTrial(subscription, 14)
  573. AnalyticsManager.recordEventForSession(
  574. req.session,
  575. 'subscription-trial-extended'
  576. )
  577. } catch (error) {
  578. return res.sendStatus(500)
  579. }
  580. res.sendStatus(200)
  581. }
  582. function recurlyNotificationParser(req, res, next) {
  583. let xml = ''
  584. req.on('data', chunk => (xml += chunk))
  585. req.on('end', () =>
  586. RecurlyWrapper._parseXml(xml, function (error, body) {
  587. if (error) {
  588. return next(error)
  589. }
  590. req.body = body
  591. next()
  592. })
  593. )
  594. }
  595. async function refreshUserFeatures(req, res) {
  596. const { user_id: userId } = req.params
  597. await FeaturesUpdater.promises.refreshFeatures(userId, 'acceptance-test')
  598. res.sendStatus(200)
  599. }
  600. async function getRecommendedCurrency(req, res) {
  601. const userId = SessionManager.getLoggedInUserId(req.session)
  602. let ip = req.ip
  603. if (
  604. req.query?.ip &&
  605. (await AuthorizationManager.promises.isUserSiteAdmin(userId))
  606. ) {
  607. ip = req.query.ip
  608. }
  609. const currencyLookup = await GeoIpLookup.promises.getCurrencyCode(ip)
  610. let countryCode = currencyLookup.countryCode
  611. const recommendedCurrency = currencyLookup.currencyCode
  612. let currency = null
  613. const queryCurrency = req.query.currency?.toUpperCase()
  614. if (queryCurrency && GeoIpLookup.isValidCurrencyParam(queryCurrency)) {
  615. currency = queryCurrency
  616. } else if (recommendedCurrency) {
  617. currency = recommendedCurrency
  618. }
  619. const queryCountryCode = req.query.countryCode?.toUpperCase()
  620. // only enable countryCode testing flag on staging or dev environments
  621. if (queryCountryCode && process.env.NODE_ENV !== 'production') {
  622. countryCode = queryCountryCode
  623. }
  624. return {
  625. currency,
  626. recommendedCurrency,
  627. countryCode,
  628. }
  629. }
  630. async function getLatamCountryBannerDetails(req, res) {
  631. const userId = SessionManager.getLoggedInUserId(req.session)
  632. let ip = req.ip
  633. if (
  634. req.query?.ip &&
  635. (await AuthorizationManager.promises.isUserSiteAdmin(userId))
  636. ) {
  637. ip = req.query.ip
  638. }
  639. const currencyLookup = await GeoIpLookup.promises.getCurrencyCode(ip)
  640. const countryCode = currencyLookup.countryCode
  641. const latamCountryBannerDetails = {}
  642. switch (countryCode) {
  643. case `MX`:
  644. latamCountryBannerDetails.latamCountryFlag = '🇲🇽'
  645. latamCountryBannerDetails.country = 'Mexico'
  646. latamCountryBannerDetails.discount = '25%'
  647. latamCountryBannerDetails.currency = 'Mexican Pesos'
  648. break
  649. case `CO`:
  650. latamCountryBannerDetails.latamCountryFlag = '🇨🇴'
  651. latamCountryBannerDetails.country = 'Colombia'
  652. latamCountryBannerDetails.discount = '60%'
  653. latamCountryBannerDetails.currency = 'Colombian Pesos'
  654. break
  655. case `CL`:
  656. latamCountryBannerDetails.latamCountryFlag = '🇨🇱'
  657. latamCountryBannerDetails.country = 'Chile'
  658. latamCountryBannerDetails.discount = '30%'
  659. latamCountryBannerDetails.currency = 'Chilean Pesos'
  660. break
  661. case `PE`:
  662. latamCountryBannerDetails.latamCountryFlag = '🇵🇪'
  663. latamCountryBannerDetails.country = 'Peru'
  664. latamCountryBannerDetails.currency = 'Peruvian Soles'
  665. latamCountryBannerDetails.discount = '40%'
  666. break
  667. }
  668. return latamCountryBannerDetails
  669. }
  670. /**
  671. * There are two sets of group plans: legacy plans and consolidated plans,
  672. * and their naming conventions differ.
  673. * This helper method computes the name of legacy group plans to ensure
  674. * consistency with the naming of consolidated group plans.
  675. *
  676. * @param {string} planName
  677. * @param {string} planCode
  678. * @return {string}
  679. */
  680. function getPlanNameForDisplay(planName, planCode) {
  681. const match = planCode.match(
  682. /^group_(collaborator|professional)_\d+_(enterprise|educational)$/
  683. )
  684. if (!match) return planName
  685. const [, type, category] = match
  686. const prefix = type === 'collaborator' ? 'Standard' : 'Professional'
  687. const suffix = category === 'educational' ? ' Educational' : ''
  688. return `Overleaf ${prefix} Group${suffix}`
  689. }
  690. /**
  691. * Build a subscription change preview for display purposes
  692. *
  693. * @param {SubscriptionChangeDescription} subscriptionChangeDescription A description of the change for the frontend
  694. * @param {PaymentProviderSubscriptionChange} subscriptionChange The subscription change object coming from Recurly
  695. * @param {PaymentMethod} [paymentMethod] The payment method associated to the user
  696. * @return {SubscriptionChangePreview}
  697. */
  698. function makeChangePreview(
  699. subscriptionChangeDescription,
  700. subscriptionChange,
  701. paymentMethod
  702. ) {
  703. const subscription = subscriptionChange.subscription
  704. const nextPlan = PlansLocator.findLocalPlanInSettings(
  705. subscriptionChange.nextPlanCode
  706. )
  707. return {
  708. change: subscriptionChangeDescription,
  709. currency: subscription.currency,
  710. immediateCharge: { ...subscriptionChange.immediateCharge },
  711. paymentMethod: paymentMethod?.toString(),
  712. netTerms: subscription.netTerms,
  713. nextPlan: {
  714. annual: nextPlan.annual ?? false,
  715. },
  716. nextInvoice: {
  717. date: subscription.periodEnd.toISOString(),
  718. plan: {
  719. name: getPlanNameForDisplay(
  720. subscriptionChange.nextPlanName,
  721. subscriptionChange.nextPlanCode
  722. ),
  723. amount: subscriptionChange.nextPlanPrice,
  724. },
  725. addOns: subscriptionChange.nextAddOns.map(addOn => ({
  726. code: addOn.code,
  727. name: addOn.name,
  728. quantity: addOn.quantity,
  729. unitAmount: addOn.unitPrice,
  730. amount: addOn.preTaxTotal,
  731. })),
  732. subtotal: subscriptionChange.subtotal,
  733. tax: {
  734. rate: subscription.taxRate,
  735. amount: subscriptionChange.tax,
  736. },
  737. total: subscriptionChange.total,
  738. },
  739. }
  740. }
  741. module.exports = {
  742. userSubscriptionPage: expressify(userSubscriptionPage),
  743. successfulSubscription: expressify(successfulSubscription),
  744. cancelSubscription,
  745. pauseSubscription,
  746. resumeSubscription,
  747. canceledSubscription: expressify(canceledSubscription),
  748. cancelV1Subscription,
  749. previewSubscription: expressify(previewSubscription),
  750. cancelPendingSubscriptionChange,
  751. updateAccountEmailAddress,
  752. reactivateSubscription,
  753. recurlyCallback,
  754. extendTrial: expressify(extendTrial),
  755. recurlyNotificationParser,
  756. refreshUserFeatures: expressify(refreshUserFeatures),
  757. previewAddonPurchase: expressify(previewAddonPurchase),
  758. purchaseAddon,
  759. removeAddon,
  760. makeChangePreview,
  761. getRecommendedCurrency,
  762. getLatamCountryBannerDetails,
  763. getPlanNameForDisplay,
  764. }