overleaf/services/web/app/src/Features/Subscription/SubscriptionViewModelBuilder.js

const Settings = require('settings-sharelatex')
const RecurlyWrapper = require('./RecurlyWrapper')
const PlansLocator = require('./PlansLocator')
const SubscriptionFormatters = require('./SubscriptionFormatters')
const SubscriptionLocator = require('./SubscriptionLocator')
const V1SubscriptionManager = require('./V1SubscriptionManager')
const InstitutionsGetter = require('../Institutions/InstitutionsGetter')
const PublishersGetter = require('../Publishers/PublishersGetter')
const sanitizeHtml = require('sanitize-html')
const _ = require('underscore')
const async = require('async')

function buildHostedLink(recurlySubscription, type) {
  const recurlySubdomain = Settings.apis.recurly.subdomain
  const hostedLoginToken = recurlySubscription.account.hosted_login_token
  let path = ''
  if (type === 'billingDetails') {
    path = 'billing_info/edit?ht='
  }
  if (hostedLoginToken && recurlySubdomain) {
    return [
      'https://',
      recurlySubdomain,
      '.recurly.com/account/',
      path,
      hostedLoginToken,
    ].join('')
  }
}

module.exports = {
  buildUsersSubscriptionViewModel(user, callback) {
    async.auto(
      {
        personalSubscription(cb) {
          SubscriptionLocator.getUsersSubscription(user, cb)
        },
        recurlySubscription: [
          'personalSubscription',
          (cb, { personalSubscription }) => {
            if (
              personalSubscription == null ||
              personalSubscription.recurlySubscription_id == null ||
              personalSubscription.recurlySubscription_id === ''
            ) {
              return cb(null, null)
            }
            RecurlyWrapper.getSubscription(
              personalSubscription.recurlySubscription_id,
              { includeAccount: true },
              cb
            )
          },
        ],
        recurlyCoupons: [
          'recurlySubscription',
          (cb, { recurlySubscription }) => {
            if (!recurlySubscription) {
              return cb(null, null)
            }
            const accountId = recurlySubscription.account.account_code
            RecurlyWrapper.getAccountActiveCoupons(accountId, cb)
          },
        ],
        plan: [
          'personalSubscription',
          (cb, { personalSubscription }) => {
            if (personalSubscription == null) {
              return cb()
            }
            const plan = PlansLocator.findLocalPlanInSettings(
              personalSubscription.planCode
            )
            if (plan == null) {
              return cb(
                new Error(
                  `No plan found for planCode '${personalSubscription.planCode}'`
                )
              )
            }
            cb(null, plan)
          },
        ],
        memberGroupSubscriptions(cb) {
          SubscriptionLocator.getMemberSubscriptions(user, cb)
        },
        managedGroupSubscriptions(cb) {
          SubscriptionLocator.getManagedGroupSubscriptions(user, cb)
        },
        confirmedMemberAffiliations(cb) {
          InstitutionsGetter.getConfirmedAffiliations(user._id, cb)
        },
        managedInstitutions(cb) {
          InstitutionsGetter.getManagedInstitutions(user._id, cb)
        },
        managedPublishers(cb) {
          PublishersGetter.getManagedPublishers(user._id, cb)
        },
        v1SubscriptionStatus(cb) {
          V1SubscriptionManager.getSubscriptionStatusFromV1(
            user._id,
            (error, status, v1Id) => {
              if (error) {
                return cb(error)
              }
              cb(null, status)
            }
          )
        },
      },
      (err, results) => {
        if (err) {
          return callback(err)
        }
        let {
          personalSubscription,
          memberGroupSubscriptions,
          managedGroupSubscriptions,
          confirmedMemberAffiliations,
          managedInstitutions,
          managedPublishers,
          v1SubscriptionStatus,
          recurlySubscription,
          recurlyCoupons,
          plan,
        } = results
        if (memberGroupSubscriptions == null) {
          memberGroupSubscriptions = []
        }
        if (managedGroupSubscriptions == null) {
          managedGroupSubscriptions = []
        }
        if (confirmedMemberAffiliations == null) {
          confirmedMemberAffiliations = []
        }
        if (managedInstitutions == null) {
          managedInstitutions = []
        }
        if (v1SubscriptionStatus == null) {
          v1SubscriptionStatus = {}
        }
        if (recurlyCoupons == null) {
          recurlyCoupons = []
        }

        if (
          personalSubscription &&
          typeof personalSubscription.toObject === 'function'
        ) {
          // Downgrade from Mongoose object, so we can add a recurly and plan attribute
          personalSubscription = personalSubscription.toObject()
        }

        if (plan != null) {
          personalSubscription.plan = plan
        }

        if (personalSubscription && recurlySubscription) {
          const tax = recurlySubscription.tax_in_cents || 0
          // Some plans allow adding more seats than the base plan provides.
          // This is recorded as a subscription add on.
          // Note: tax_in_cents already includes the tax for any addon.
          let addOnPrice = 0
          let additionalLicenses = 0
          if (
            plan.membersLimitAddOn &&
            Array.isArray(recurlySubscription.subscription_add_ons)
          ) {
            recurlySubscription.subscription_add_ons.forEach(addOn => {
              if (addOn.add_on_code === plan.membersLimitAddOn) {
                addOnPrice += addOn.quantity * addOn.unit_amount_in_cents
                additionalLicenses += addOn.quantity
              }
            })
          }
          const totalLicenses = (plan.membersLimit || 0) + additionalLicenses
          personalSubscription.recurly = {
            tax,
            taxRate: parseFloat(
              recurlySubscription.tax_rate && recurlySubscription.tax_rate._
            ),
            billingDetailsLink: buildHostedLink(
              recurlySubscription,
              'billingDetails'
            ),
            accountManagementLink: buildHostedLink(recurlySubscription),
            price: SubscriptionFormatters.formatPrice(
              recurlySubscription.unit_amount_in_cents + addOnPrice + tax,
              recurlySubscription.currency
            ),
            additionalLicenses,
            totalLicenses,
            nextPaymentDueAt: SubscriptionFormatters.formatDate(
              recurlySubscription.current_period_ends_at
            ),
            currency: recurlySubscription.currency,
            state: recurlySubscription.state,
            trialEndsAtFormatted: SubscriptionFormatters.formatDate(
              recurlySubscription.trial_ends_at
            ),
            trial_ends_at: recurlySubscription.trial_ends_at,
            activeCoupons: recurlyCoupons,
            account: recurlySubscription.account,
          }
        }

        for (const memberGroupSubscription of memberGroupSubscriptions) {
          if (memberGroupSubscription.teamNotice) {
            memberGroupSubscription.teamNotice = sanitizeHtml(
              memberGroupSubscription.teamNotice
            )
          }
        }

        callback(null, {
          personalSubscription,
          managedGroupSubscriptions,
          memberGroupSubscriptions,
          confirmedMemberAffiliations,
          managedInstitutions,
          managedPublishers,
          v1SubscriptionStatus,
        })
      }
    )
  },

  buildPlansList() {
    const { plans } = Settings

    const allPlans = {}
    plans.forEach(plan => (allPlans[plan.planCode] = plan))

    const result = { allPlans }

    result.studentAccounts = _.filter(
      plans,
      plan => plan.planCode.indexOf('student') !== -1
    )

    result.groupMonthlyPlans = _.filter(
      plans,
      plan => plan.groupPlan && !plan.annual
    )

    result.groupAnnualPlans = _.filter(
      plans,
      plan => plan.groupPlan && plan.annual
    )

    result.individualMonthlyPlans = _.filter(
      plans,
      plan =>
        !plan.groupPlan &&
        !plan.annual &&
        plan.planCode !== 'personal' && // Prevent the personal plan from appearing on the change-plans page
        plan.planCode.indexOf('student') === -1
    )

    result.individualAnnualPlans = _.filter(
      plans,
      plan =>
        !plan.groupPlan &&
        plan.annual &&
        plan.planCode.indexOf('student') === -1
    )

    return result
  },
}