overleaf-cep/services/web/test/unit/src/Subscription/SubscriptionControllerTests.js

const SandboxedModule = require('sandboxed-module')
const sinon = require('sinon')
const { assert, expect } = require('chai')
const MockRequest = require('../helpers/MockRequest')
const MockResponse = require('../helpers/MockResponse')
const modulePath =
  '../../../../app/src/Features/Subscription/SubscriptionController'
const SubscriptionErrors = require('../../../../app/src/Features/Subscription/Errors')
const SubscriptionHelper = require('../../../../app/src/Features/Subscription/SubscriptionHelper')
const {
  AI_ADD_ON_CODE,
} = require('../../../../app/src/Features/Subscription/AiHelper')

const mockSubscriptions = {
  'subscription-123-active': {
    uuid: 'subscription-123-active',
    plan: {
      name: 'Gold',
      plan_code: 'gold',
    },
    current_period_ends_at: new Date(),
    state: 'active',
    unit_amount_in_cents: 999,
    account: {
      account_code: 'user-123',
    },
  },
}

describe('SubscriptionController', function () {
  beforeEach(function () {
    this.user = {
      email: 'tom@yahoo.com',
      _id: 'one',
      signUpDate: new Date('2000-10-01'),
      emails: [{ email: 'tom@yahoo.com', confirmedAt: new Date('2000-10-02') }],
    }
    this.activeRecurlySubscription =
      mockSubscriptions['subscription-123-active']

    this.SessionManager = {
      getLoggedInUser: sinon.stub().callsArgWith(1, null, this.user),
      getLoggedInUserId: sinon.stub().returns(this.user._id),
      getSessionUser: sinon.stub().returns(this.user),
      isUserLoggedIn: sinon.stub().returns(true),
    }
    this.SubscriptionHandler = {
      createSubscription: sinon.stub().callsArgWith(3),
      updateSubscription: sinon.stub().callsArgWith(3),
      reactivateSubscription: sinon.stub().callsArgWith(1),
      cancelSubscription: sinon.stub().callsArgWith(1),
      syncSubscription: sinon.stub().yields(),
      attemptPaypalInvoiceCollection: sinon.stub().yields(),
      startFreeTrial: sinon.stub(),
      promises: {
        createSubscription: sinon.stub().resolves(),
        updateSubscription: sinon.stub().resolves(),
        reactivateSubscription: sinon.stub().resolves(),
        cancelSubscription: sinon.stub().resolves(),
        pauseSubscription: sinon.stub().resolves(),
        resumeSubscription: sinon.stub().resolves(),
        syncSubscription: sinon.stub().resolves(),
        attemptPaypalInvoiceCollection: sinon.stub().resolves(),
        startFreeTrial: sinon.stub().resolves(),
        purchaseAddon: sinon.stub().resolves(),
        previewAddonPurchase: sinon.stub().resolves({
          subscription: {
            currency: 'USD',
            netTerms: 0,
            periodEnd: new Date(),
            taxRate: 0,
          },
          immediateCharge: { amount: 0 },
          nextPlanCode: 'professional',
          nextPlanName: 'Professional',
          nextPlanPrice: 2000,
          nextAddOns: [],
          subtotal: 2000,
          tax: 0,
          total: 2000,
        }),
      },
    }

    this.LimitationsManager = {
      hasPaidSubscription: sinon.stub(),
      userHasSubscription: sinon
        .stub()
        .yields(null, { hasSubscription: false }),
      promises: {
        hasPaidSubscription: sinon.stub().resolves(),
        userHasSubscription: sinon.stub().resolves({ hasSubscription: false }),
      },
    }

    this.SubscriptionViewModelBuilder = {
      buildUsersSubscriptionViewModel: sinon.stub().callsArgWith(1, null, {}),
      buildPlansList: sinon.stub(),
      promises: {
        buildUsersSubscriptionViewModel: sinon.stub().resolves({}),
      },
      buildPlansListForSubscriptionDash: sinon
        .stub()
        .returns({ plans: [], planCodesChangingAtTermEnd: [] }),
    }
    this.settings = {
      coupon_codes: {
        upgradeToAnnualPromo: {
          student: 'STUDENTCODEHERE',
          collaborator: 'COLLABORATORCODEHERE',
        },
      },
      groupPlanModalOptions: {
        plan_codes: [],
        currencies: [
          {
            display: 'GBP (£)',
            code: 'GBP',
          },
        ],
        sizes: ['42'],
        usages: [{ code: 'foo', display: 'Foo' }],
      },
      apis: {
        recurly: {
          subdomain: 'sl',
        },
      },
      siteUrl: 'http://de.overleaf.dev:3000',
    }
    this.AuthorizationManager = {
      promises: {
        isUserSiteAdmin: sinon.stub().resolves(false),
      },
    }
    this.GeoIpLookup = {
      isValidCurrencyParam: sinon.stub().returns(true),
      getCurrencyCode: sinon.stub().yields('USD', 'US'),
      promises: {
        getCurrencyCode: sinon.stub().resolves({
          countryCode: 'US',
          currencyCode: 'USD',
        }),
      },
    }
    this.UserGetter = {
      getUser: sinon.stub().callsArgWith(2, null, this.user),
      promises: {
        getUser: sinon.stub().resolves(this.user),
        getWritefullData: sinon
          .stub()
          .resolves({ isPremium: false, premiumSource: null }),
      },
    }
    this.SplitTestV2Hander = {
      promises: {
        getAssignment: sinon.stub().resolves({ variant: 'default' }),
      },
    }
    this.Features = {
      hasFeature: sinon.stub().returns(false),
    }
    this.SubscriptionController = SandboxedModule.require(modulePath, {
      requires: {
        '../Authorization/AuthorizationManager': this.AuthorizationManager,
        '../SplitTests/SplitTestHandler': this.SplitTestV2Hander,
        '../Authentication/SessionManager': this.SessionManager,
        './SubscriptionHandler': this.SubscriptionHandler,
        './SubscriptionHelper': SubscriptionHelper,
        './SubscriptionViewModelBuilder': this.SubscriptionViewModelBuilder,
        './LimitationsManager': this.LimitationsManager,
        '../../infrastructure/GeoIpLookup': this.GeoIpLookup,
        '@overleaf/settings': this.settings,
        '../User/UserGetter': this.UserGetter,
        './RecurlyWrapper': (this.RecurlyWrapper = {
          promises: {
            updateAccountEmailAddress: sinon.stub().resolves(),
            getSubscription: sinon.stub().resolves({}),
          },
        }),
        './RecurlyEventHandler': {
          sendRecurlyAnalyticsEvent: sinon.stub().resolves(),
        },
        './FeaturesUpdater': (this.FeaturesUpdater = {
          promises: {
            refreshFeatures: sinon.stub().resolves({ features: {} }),
          },
        }),
        './GroupPlansData': (this.GroupPlansData = {}),
        './V1SubscriptionManager': (this.V1SubscriptionManager = {}),
        '../Errors/HttpErrorHandler': (this.HttpErrorHandler = {
          unprocessableEntity: sinon.stub().callsFake((req, res, message) => {
            res.status(422)
            res.json({ message })
          }),
          badRequest: sinon.stub().callsFake((req, res, message) => {
            res.status(400)
            res.json({ message })
          }),
        }),
        './Errors': SubscriptionErrors,
        '../Analytics/AnalyticsManager': (this.AnalyticsManager = {
          recordEventForUser: sinon.stub(),
          recordEventForUserInBackground: sinon.stub(),
          recordEventForSession: sinon.stub(),
          setUserPropertyForUser: sinon.stub(),
        }),
        '../../infrastructure/Modules': (this.Modules = {
          promises: { hooks: { fire: sinon.stub().resolves() } },
        }),
        '../../infrastructure/Features': this.Features,
        '../../util/currency': (this.currency = {
          formatCurrency: sinon.stub(),
        }),
        '../../models/User': {
          User: {
            findById: sinon.stub().resolves(this.user),
          },
        },
        './SubscriptionLocator': (this.SubscriptionLocator = {
          promises: {
            getUsersSubscription: sinon.stub().resolves(null),
          },
        }),
        '../Authorization/PermissionsManager': (this.PermissionsManager = {
          promises: {
            checkUserPermissions: sinon.stub().resolves(true),
          },
        }),
        './RecurlyClient': (this.RecurlyClient = {
          promises: {
            getAddOn: sinon.stub().resolves({
              code: 'ai-assistant',
              name: 'AI Assistant',
            }),
          },
        }),
        './PlansLocator': (this.PlansLocator = {
          findLocalPlanInSettings: sinon.stub().returns({
            annual: false,
          }),
        }),
      },
    })

    this.res = new MockResponse()
    this.req = new MockRequest()
    this.req.body = {}
    this.req.query = { planCode: '123123' }

    this.stubbedCurrencyCode = 'GBP'
  })

  describe('successfulSubscription', function () {
    it('without a personal subscription', function (done) {
      this.SubscriptionViewModelBuilder.promises.buildUsersSubscriptionViewModel.resolves(
        {}
      )
      this.res.redirect = url => {
        url.should.equal('/user/subscription/plans')
        done()
      }
      this.SubscriptionController.successfulSubscription(this.req, this.res)
    })

    it('with a personal subscription', function (done) {
      this.SubscriptionViewModelBuilder.promises.buildUsersSubscriptionViewModel.resolves(
        {
          personalSubscription: 'foo',
        }
      )
      this.res.render = (url, variables) => {
        url.should.equal('subscriptions/successful-subscription-react')
        assert.deepEqual(variables, {
          title: 'thank_you',
          personalSubscription: 'foo',
          postCheckoutRedirect: undefined,
          user: {
            _id: this.user._id,
            features: this.user.features,
          },
        })
        done()
      }
      this.SubscriptionController.successfulSubscription(this.req, this.res)
    })

    it('with an error', function (done) {
      this.SubscriptionViewModelBuilder.promises.buildUsersSubscriptionViewModel.resolves(
        undefined
      )
      this.SubscriptionController.successfulSubscription(
        this.req,
        this.res,
        error => {
          assert.isNotNull(error)
          done()
        }
      )
    })
  })

  describe('userSubscriptionPage', function () {
    beforeEach(function (done) {
      this.SubscriptionViewModelBuilder.promises.buildUsersSubscriptionViewModel.resolves(
        {
          personalSubscription: (this.personalSubscription = {
            'personal-subscription': 'mock',
          }),
          memberGroupSubscriptions: (this.memberGroupSubscriptions = {
            'group-subscriptions': 'mock',
          }),
        }
      )
      this.SubscriptionViewModelBuilder.buildPlansList.returns(
        (this.plans = { plans: 'mock' })
      )
      this.SubscriptionViewModelBuilder.buildPlansListForSubscriptionDash.returns(
        {
          plans: this.plans,
          planCodesChangingAtTermEnd: [],
        }
      )
      this.LimitationsManager.promises.userHasSubscription.resolves({
        hasSubscription: false,
      })
      this.res.render = (view, data) => {
        this.data = data
        expect(view).to.equal('subscriptions/dashboard-react')
        done()
      }
      this.SubscriptionController.userSubscriptionPage(this.req, this.res, done)
    })

    it('should load the personal, groups and v1 subscriptions', function () {
      expect(this.data.personalSubscription).to.deep.equal(
        this.personalSubscription
      )
      expect(this.data.memberGroupSubscriptions).to.deep.equal(
        this.memberGroupSubscriptions
      )
    })

    it('should load the user', function () {
      expect(this.data.user).to.deep.equal(this.user)
    })

    it('should load the plans', function () {
      expect(this.data.plans).to.deep.equal(this.plans)
    })

    it('should load an empty list of groups with settings available', function () {
      expect(this.data.groupSettingsEnabledFor).to.deep.equal([])
    })
  })

  describe('updateAccountEmailAddress via put', function () {
    beforeEach(function () {
      this.req.body = {
        account_email: 'current_account_email@overleaf.com',
      }
    })

    it('should send the user and subscriptionId to "updateAccountEmailAddress" hooks', async function () {
      this.res.sendStatus = sinon.spy()

      await this.SubscriptionController.updateAccountEmailAddress(
        this.req,
        this.res
      )

      expect(this.Modules.promises.hooks.fire).to.have.been.calledWith(
        'updateAccountEmailAddress',
        this.user._id,
        this.user.email
      )
    })

    it('should respond with 200', async function () {
      this.res.sendStatus = sinon.spy()
      await this.SubscriptionController.updateAccountEmailAddress(
        this.req,
        this.res
      )
      this.res.sendStatus.calledWith(200).should.equal(true)
    })

    it('should send the error to the next handler when updating recurly account email fails', async function () {
      this.Modules.promises.hooks.fire
        .withArgs('updateAccountEmailAddress', this.user._id, this.user.email)
        .rejects(new Error())

      this.next = sinon.spy(error => {
        expect(error).to.be.instanceOf(Error)
      })
      await this.SubscriptionController.updateAccountEmailAddress(
        this.req,
        this.res,
        this.next
      )
      expect(this.next.calledOnce).to.be.true
    })
  })

  describe('reactivateSubscription', function () {
    describe('when the user has permission', function () {
      beforeEach(function (done) {
        this.res = {
          redirect() {
            done()
          },
        }
        this.req.assertPermission = sinon.stub()
        this.next = sinon.stub().callsFake(error => {
          done(error)
        })
        sinon.spy(this.res, 'redirect')
        this.SubscriptionController.reactivateSubscription(
          this.req,
          this.res,
          this.next
        )
      })

      it('should assert the user has permission to reactivate their subscription', function (done) {
        this.req.assertPermission
          .calledWith('reactivate-subscription')
          .should.equal(true)
        done()
      })

      it('should tell the handler to reactivate this user', function (done) {
        this.SubscriptionHandler.reactivateSubscription
          .calledWith(this.user)
          .should.equal(true)
        done()
      })

      it('should redurect to the subscription page', function (done) {
        this.res.redirect.calledWith('/user/subscription').should.equal(true)
        done()
      })
    })

    describe('when the user does not have permission', function () {
      beforeEach(function (done) {
        this.res = {
          redirect() {
            done()
          },
        }
        this.req.assertPermission = sinon.stub().throws()
        this.next = sinon.stub().callsFake(() => {
          done()
        })
        sinon.spy(this.res, 'redirect')
        this.SubscriptionController.reactivateSubscription(
          this.req,
          this.res,
          this.next
        )
      })

      it('should not reactivate the user', function (done) {
        this.req.assertPermission = sinon.stub().throws()
        this.SubscriptionHandler.reactivateSubscription.called.should.equal(
          false
        )
        done()
      })

      it('should call next with an error', function (done) {
        this.next.calledWith(sinon.match.instanceOf(Error)).should.equal(true)
        done()
      })
    })
  })

  describe('pauseSubscription', function () {
    it('should throw an error if no pause length is provided', async function () {
      this.res = new MockResponse()
      this.req = new MockRequest()
      this.next = sinon.stub()
      await this.SubscriptionController.pauseSubscription(
        this.req,
        this.res,
        this.next
      )
      expect(this.res.statusCode).to.equal(400)
    })

    it('should throw an error if an invalid pause length is provided', async function () {
      this.res = new MockResponse()
      this.req = new MockRequest()
      this.req.params = { pauseCycles: -10 }
      this.next = sinon.stub()
      await this.SubscriptionController.pauseSubscription(
        this.req,
        this.res,
        this.next
      )
      expect(this.res.statusCode).to.equal(400)
    })

    it('should return a 200 when requesting a pause', async function () {
      this.res = new MockResponse()
      this.req = new MockRequest()
      this.req.params = { pauseCycles: 3 }
      this.next = sinon.stub()
      await this.SubscriptionController.pauseSubscription(
        this.req,
        this.res,
        this.next
      )
      expect(this.res.statusCode).to.equal(200)
    })
  })

  describe('resumeSubscription', function () {
    it('should return a 200 when resuming a subscription', async function () {
      this.res = new MockResponse()
      this.req = new MockRequest()
      this.next = sinon.stub()
      await this.SubscriptionController.resumeSubscription(
        this.req,
        this.res,
        this.next
      )
      expect(this.res.statusCode).to.equal(200)
    })
  })

  describe('cancelSubscription', function () {
    it('should tell the handler to cancel this user', async function () {
      this.next = sinon.stub()
      await this.SubscriptionController.cancelSubscription(
        this.req,
        this.res,
        this.next
      )
      this.SubscriptionHandler.promises.cancelSubscription
        .calledWith(this.user)
        .should.equal(true)
    })

    it('should return a 200 on success', async function () {
      this.next = sinon.stub()
      await this.SubscriptionController.cancelSubscription(
        this.req,
        this.res,
        this.next
      )
      expect(this.res.statusCode).to.equal(200)
    })

    it('should call next with error', async function () {
      this.SubscriptionHandler.promises.cancelSubscription.rejects(
        new Error('cancel error')
      )
      this.next = sinon.stub()
      await this.SubscriptionController.cancelSubscription(
        this.req,
        this.res,
        this.next
      )
      this.next.calledWith(sinon.match.instanceOf(Error)).should.equal(true)
    })
  })

  describe('recurly callback', function () {
    describe('with a sync subscription request', function () {
      beforeEach(function (done) {
        this.req = {
          body: {
            expired_subscription_notification: {
              account: {
                account_code: this.user._id,
              },
              subscription: {
                uuid: this.activeRecurlySubscription.uuid,
                plan: {
                  plan_code: 'collaborator',
                  state: 'active',
                },
              },
            },
          },
        }
        this.res = {
          sendStatus() {
            done()
          },
        }
        sinon.spy(this.res, 'sendStatus')
        this.SubscriptionController.recurlyCallback(this.req, this.res)
      })

      it('should tell the SubscriptionHandler to process the recurly callback', function (done) {
        this.SubscriptionHandler.syncSubscription.called.should.equal(true)
        done()
      })

      it('should send a 200', function (done) {
        this.res.sendStatus.calledWith(200)
        done()
      })
    })

    describe('with a billing info updated request', function () {
      beforeEach(function (done) {
        this.req = {
          body: {
            billing_info_updated_notification: {
              account: {
                account_code: 'mock-account-code',
              },
            },
          },
        }
        this.res = {
          sendStatus() {
            done()
          },
        }
        sinon.spy(this.res, 'sendStatus')
        this.SubscriptionController.recurlyCallback(this.req, this.res)
      })

      it('should call attemptPaypalInvoiceCollection', function (done) {
        this.SubscriptionHandler.attemptPaypalInvoiceCollection
          .calledWith('mock-account-code')
          .should.equal(true)
        done()
      })

      it('should send a 200', function (done) {
        this.res.sendStatus.calledWith(200)
        done()
      })
    })

    describe('with a non-actionable request', function () {
      beforeEach(function (done) {
        this.user.id = this.activeRecurlySubscription.account.account_code
        this.req = {
          body: {
            renewed_subscription_notification: {
              account: {
                account_code: this.user._id,
              },
              subscription: {
                uuid: this.activeRecurlySubscription.uuid,
                plan: {
                  plan_code: 'collaborator',
                  state: 'active',
                },
              },
            },
          },
        }
        this.res = {
          sendStatus() {
            done()
          },
        }
        sinon.spy(this.res, 'sendStatus')
        this.SubscriptionController.recurlyCallback(this.req, this.res)
      })

      it('should not call the subscriptionshandler', function () {
        this.SubscriptionHandler.syncSubscription.called.should.equal(false)
        this.SubscriptionHandler.attemptPaypalInvoiceCollection.called.should.equal(
          false
        )
      })

      it('should respond with a 200 status', function () {
        this.res.sendStatus.calledWith(200)
      })
    })
  })

  describe('purchaseAddon', function () {
    beforeEach(function () {
      this.SessionManager.getSessionUser.returns(this.user) // Make sure getSessionUser returns the user
      this.next = sinon.stub()
      this.req.params = { addOnCode: AI_ADD_ON_CODE } // Mock add-on code
    })

    it('should return 200 on successful purchase of AI add-on', async function () {
      await this.SubscriptionController.purchaseAddon(
        this.req,
        this.res,
        this.next
      )
      this.res.sendStatus = sinon.spy()

      await this.SubscriptionController.purchaseAddon(
        this.req,
        this.res,
        this.next
      )

      expect(this.SubscriptionHandler.promises.purchaseAddon).to.have.been
        .called
      expect(
        this.SubscriptionHandler.promises.purchaseAddon
      ).to.have.been.calledWith(this.user._id, AI_ADD_ON_CODE, 1)
      expect(
        this.FeaturesUpdater.promises.refreshFeatures
      ).to.have.been.calledWith(this.user._id, 'add-on-purchase')
      expect(this.res.sendStatus).to.have.been.calledWith(200)
      expect(this.logger.debug).to.have.been.calledWith(
        { userId: this.user._id, addOnCode: AI_ADD_ON_CODE },
        'purchasing add-ons'
      )
    })

    it('should return 404 if the add-on code is not AI_ADD_ON_CODE', async function () {
      this.req.params = { addOnCode: 'some-other-addon' }
      this.res.sendStatus = sinon.spy()

      await this.SubscriptionController.purchaseAddon(
        this.req,
        this.res,
        this.next
      )

      expect(this.SubscriptionHandler.promises.purchaseAddon).to.not.have.been
        .called
      expect(this.FeaturesUpdater.promises.refreshFeatures).to.not.have.been
        .called
      expect(this.res.sendStatus).to.have.been.calledWith(404)
    })

    it('should handle DuplicateAddOnError and send badRequest while sending 200', async function () {
      this.req.params.addOnCode = AI_ADD_ON_CODE
      this.SubscriptionHandler.promises.purchaseAddon.rejects(
        new SubscriptionErrors.DuplicateAddOnError()
      )

      await this.SubscriptionController.purchaseAddon(
        this.req,
        this.res,
        this.next
      )

      expect(this.HttpErrorHandler.badRequest).to.have.been.calledWith(
        this.req,
        this.res,
        'Your subscription already includes this add-on',
        { addon: AI_ADD_ON_CODE }
      )
      expect(
        this.FeaturesUpdater.promises.refreshFeatures
      ).to.have.been.calledWith(this.user._id, 'add-on-purchase')
      expect(this.res.sendStatus).to.have.been.calledWith(200)
    })

    it('should handle PaymentActionRequiredError and return 402 with details', async function () {
      this.req.params.addOnCode = AI_ADD_ON_CODE
      const paymentError = new SubscriptionErrors.PaymentActionRequiredError({
        clientSecret: 'secret123',
        publicKey: 'pubkey456',
      })
      this.SubscriptionHandler.promises.purchaseAddon.rejects(paymentError)

      await this.SubscriptionController.purchaseAddon(
        this.req,
        this.res,
        this.next
      )

      this.res.status.calledWith(402).should.equal(true)
      this.res.json
        .calledWith({
          message: 'Payment action required',
          clientSecret: 'secret123',
          publicKey: 'pubkey456',
        })
        .should.equal(true)

      expect(this.FeaturesUpdater.promises.refreshFeatures).to.not.have.been
        .called
    })
  })

  describe('checkSubscriptionPauseStatus', function () {
    beforeEach(function () {
      this.user = {
        _id: 'user-id-123',
        email: 'test@example.com',
      }
    })

    it('should return isPaused: false when user has no subscription', async function () {
      this.LimitationsManager.promises.userHasSubscription.resolves({
        subscription: null,
      })

      const result =
        await this.SubscriptionController.checkSubscriptionPauseStatus(
          this.user
        )

      expect(result).to.deep.equal({ isPaused: false })
    })

    it('should return isPaused: false when subscription has no paymentProvider', async function () {
      const subscription = {
        planCode: 'professional',
      }
      this.LimitationsManager.promises.userHasSubscription.resolves({
        subscription,
      })

      const result =
        await this.SubscriptionController.checkSubscriptionPauseStatus(
          this.user
        )

      expect(result).to.deep.equal({ isPaused: false })
    })

    it('should return isPaused: false when subscription has no subscriptionId', async function () {
      const subscription = {
        paymentProvider: {
          service: 'stripe',
          subscriptionId: null,
        },
      }
      this.LimitationsManager.promises.userHasSubscription.resolves({
        subscription,
      })

      const result =
        await this.SubscriptionController.checkSubscriptionPauseStatus(
          this.user
        )

      expect(result).to.deep.equal({ isPaused: false })
    })

    it('should return isPaused: false when Stripe subscription has no remaining pause cycles', async function () {
      const subscription = {
        paymentProvider: {
          service: 'stripe',
          subscriptionId: 'sub-123',
        },
      }
      this.LimitationsManager.promises.userHasSubscription.resolves({
        subscription,
      })

      const paymentRecord = {
        subscription: {
          remainingPauseCycles: 0,
        },
      }
      this.Modules.promises.hooks.fire
        .withArgs('getPaymentFromRecord', subscription)
        .resolves([paymentRecord])

      const result =
        await this.SubscriptionController.checkSubscriptionPauseStatus(
          this.user
        )

      expect(result).to.deep.equal({ isPaused: false })
    })

    it('should return isPaused: false when Stripe subscription has no remainingPauseCycles property', async function () {
      const subscription = {
        paymentProvider: {
          service: 'stripe',
          subscriptionId: 'sub-123',
        },
      }
      this.LimitationsManager.promises.userHasSubscription.resolves({
        subscription,
      })

      const paymentRecord = {
        subscription: {},
      }
      this.Modules.promises.hooks.fire
        .withArgs('getPaymentFromRecord', subscription)
        .resolves([paymentRecord])

      const result =
        await this.SubscriptionController.checkSubscriptionPauseStatus(
          this.user
        )

      expect(result).to.deep.equal({ isPaused: false })
    })

    it('should return isPaused: true with redirect path when Stripe subscription has remaining pause cycles', async function () {
      const subscription = {
        paymentProvider: {
          service: 'stripe',
          subscriptionId: 'sub-123',
        },
      }
      this.LimitationsManager.promises.userHasSubscription.resolves({
        subscription,
      })

      const paymentRecord = {
        subscription: {
          remainingPauseCycles: 2,
        },
      }
      this.Modules.promises.hooks.fire
        .withArgs('getPaymentFromRecord', subscription)
        .resolves([paymentRecord])

      const result =
        await this.SubscriptionController.checkSubscriptionPauseStatus(
          this.user
        )

      expect(result).to.deep.equal({
        isPaused: true,
        redirectPath: '/user/subscription?redirect-reason=subscription-paused',
      })
    })

    it('should return isPaused: true when remainingPauseCycles is exactly 1', async function () {
      const subscription = {
        paymentProvider: {
          service: 'stripe',
          subscriptionId: 'sub-123',
        },
      }
      this.LimitationsManager.promises.userHasSubscription.resolves({
        subscription,
      })

      const paymentRecord = {
        subscription: {
          remainingPauseCycles: 1,
        },
      }
      this.Modules.promises.hooks.fire
        .withArgs('getPaymentFromRecord', subscription)
        .resolves([paymentRecord])

      const result =
        await this.SubscriptionController.checkSubscriptionPauseStatus(
          this.user
        )

      expect(result).to.deep.equal({
        isPaused: true,
        redirectPath: '/user/subscription?redirect-reason=subscription-paused',
      })
    })

    it('should return isPaused: false when userHasSubscription throws error', async function () {
      const error = new Error('Something bad happened')
      this.LimitationsManager.promises.userHasSubscription.rejects(error)

      const result =
        await this.SubscriptionController.checkSubscriptionPauseStatus(
          this.user
        )

      expect(result).to.deep.equal({ isPaused: false })
    })

    it('should return isPaused: false when getPaymentFromRecord throws error', async function () {
      const subscription = {
        paymentProvider: {
          service: 'stripe',
          subscriptionId: 'sub-123',
        },
      }
      this.LimitationsManager.promises.userHasSubscription.resolves({
        subscription,
      })

      const error = new Error('Something bad happened')
      this.Modules.promises.hooks.fire
        .withArgs('getPaymentFromRecord', subscription)
        .rejects(error)

      const result =
        await this.SubscriptionController.checkSubscriptionPauseStatus(
          this.user
        )

      expect(result).to.deep.equal({ isPaused: false })
    })

    it('should return isPaused: false when Recurly subscription is not paused', async function () {
      const subscription = {
        recurlySubscription_id: 'uuid-123',
        recurlyStatus: {
          state: 'active',
        },
      }
      this.LimitationsManager.promises.userHasSubscription.resolves({
        subscription,
      })

      const result =
        await this.SubscriptionController.checkSubscriptionPauseStatus(
          this.user
        )

      expect(result).to.deep.equal({ isPaused: false })
    })

    it('should return isPaused: true when Recurly subscription is paused', async function () {
      const subscription = {
        recurlySubscription_id: 'uuid-123',
        recurlyStatus: {
          state: 'paused',
        },
      }
      this.LimitationsManager.promises.userHasSubscription.resolves({
        subscription,
      })

      const result =
        await this.SubscriptionController.checkSubscriptionPauseStatus(
          this.user
        )

      expect(result).to.deep.equal({
        isPaused: true,
        redirectPath: '/user/subscription?redirect-reason=subscription-paused',
      })
    })

    it('should return isPaused: true when Recurly subscription has pending pause cycles', async function () {
      const subscription = {
        recurlySubscription_id: 'uuid-123',
        recurlyStatus: {
          state: 'active',
        },
      }
      this.LimitationsManager.promises.userHasSubscription.resolves({
        subscription,
      })

      const recurlySubscriptionData = {
        remaining_pause_cycles: 2,
      }
      this.RecurlyWrapper.promises.getSubscription.resolves(
        recurlySubscriptionData
      )

      const result =
        await this.SubscriptionController.checkSubscriptionPauseStatus(
          this.user
        )

      expect(result).to.deep.equal({
        isPaused: true,
        redirectPath: '/user/subscription?redirect-reason=subscription-paused',
      })
      expect(
        this.RecurlyWrapper.promises.getSubscription
      ).to.have.been.calledWith('uuid-123')
    })

    it('should return isPaused: false when Recurly subscription has no remaining pause cycles', async function () {
      const subscription = {
        recurlySubscription_id: 'uuid-123',
        recurlyStatus: {
          state: 'active',
        },
      }
      this.LimitationsManager.promises.userHasSubscription.resolves({
        subscription,
      })

      const recurlySubscriptionData = {
        remaining_pause_cycles: 0,
      }
      this.RecurlyWrapper.promises.getSubscription.resolves(
        recurlySubscriptionData
      )

      const result =
        await this.SubscriptionController.checkSubscriptionPauseStatus(
          this.user
        )

      expect(result).to.deep.equal({ isPaused: false })
    })

    it('should return isPaused: false when Recurly subscription has no remaining_pause_cycles property', async function () {
      const subscription = {
        recurlySubscription_id: 'uuid-123',
        recurlyStatus: {
          state: 'active',
        },
      }
      this.LimitationsManager.promises.userHasSubscription.resolves({
        subscription,
      })

      const recurlySubscriptionData = {}
      this.RecurlyWrapper.promises.getSubscription.resolves(
        recurlySubscriptionData
      )

      const result =
        await this.SubscriptionController.checkSubscriptionPauseStatus(
          this.user
        )

      expect(result).to.deep.equal({ isPaused: false })
    })

    it('should return isPaused: false when Recurly API call fails', async function () {
      const subscription = {
        recurlySubscription_id: 'uuid-123',
        recurlyStatus: {
          state: 'active',
        },
      }
      this.LimitationsManager.promises.userHasSubscription.resolves({
        subscription,
      })

      const error = new Error('Recurly API failed')
      this.RecurlyWrapper.promises.getSubscription.rejects(error)

      const result =
        await this.SubscriptionController.checkSubscriptionPauseStatus(
          this.user
        )

      expect(result).to.deep.equal({ isPaused: false })
    })
  })

  describe('previewAddonPurchase', function () {
    beforeEach(function () {
      this.req = new MockRequest()
      this.req.params = { addOnCode: 'assistant' }
      this.req.query = { purchaseReferrer: 'fake-referrer' }
      this.res = new MockResponse()

      this.Modules.promises.hooks.fire
        .withArgs('getPaymentMethod')
        .resolves(['fake-method'])
      this.SubscriptionLocator.promises.getUsersSubscription.resolves(null)
    })

    describe('when user has manual or custom subscription', function () {
      it('should redirect with ai-assist-unavailable when subscription has customAccount = true', async function () {
        const customSubscription = {
          _id: 'sub-123',
          customAccount: true,
          collectionMethod: 'automatic',
        }
        this.SubscriptionLocator.promises.getUsersSubscription.resolves(
          customSubscription
        )

        this.res.redirect = sinon.stub()

        await this.SubscriptionController.previewAddonPurchase(
          this.req,
          this.res
        )

        expect(this.res.redirect).to.have.been.calledWith(
          '/user/subscription?redirect-reason=ai-assist-unavailable'
        )
      })

      it('should redirect with ai-assist-unavailable when subscription has collectionMethod = manual', async function () {
        const manualSubscription = {
          _id: 'sub-123',
          customAccount: false,
          collectionMethod: 'manual',
        }
        this.SubscriptionLocator.promises.getUsersSubscription.resolves(
          manualSubscription
        )

        this.res.redirect = sinon.stub()

        await this.SubscriptionController.previewAddonPurchase(
          this.req,
          this.res
        )

        expect(this.res.redirect).to.have.been.calledWith(
          '/user/subscription?redirect-reason=ai-assist-unavailable'
        )
      })

      it('should redirect with ai-assist-unavailable when subscription has both customAccount and manual collection', async function () {
        const customManualSubscription = {
          _id: 'sub-123',
          customAccount: true,
          collectionMethod: 'manual',
        }
        this.SubscriptionLocator.promises.getUsersSubscription.resolves(
          customManualSubscription
        )

        this.res.redirect = sinon.stub()

        await this.SubscriptionController.previewAddonPurchase(
          this.req,
          this.res
        )

        expect(this.res.redirect).to.have.been.calledWith(
          '/user/subscription?redirect-reason=ai-assist-unavailable'
        )
      })
    })

    describe('when user has normal subscription', function () {
      it('should proceed with preview when subscription is not manual or custom', async function () {
        const normalSubscription = {
          _id: 'sub-123',
          customAccount: false,
          collectionMethod: 'automatic',
        }
        this.SubscriptionLocator.promises.getUsersSubscription.resolves(
          normalSubscription
        )

        this.res.render = sinon.stub()

        await this.SubscriptionController.previewAddonPurchase(
          this.req,
          this.res
        )

        expect(this.res.render).to.have.been.calledWith(
          'subscriptions/preview-change'
        )
        expect(
          this.SubscriptionHandler.promises.previewAddonPurchase
        ).to.have.been.calledWith(this.user._id, 'assistant')
      })

      it('should proceed with preview when customAccount is undefined and collectionMethod is automatic', async function () {
        const normalSubscription = {
          _id: 'sub-123',
          // customAccount: undefined (not set)
          collectionMethod: 'automatic',
        }
        this.SubscriptionLocator.promises.getUsersSubscription.resolves(
          normalSubscription
        )

        this.res.render = sinon.stub()

        await this.SubscriptionController.previewAddonPurchase(
          this.req,
          this.res
        )

        expect(this.res.render).to.have.been.calledWith(
          'subscriptions/preview-change'
        )
        expect(
          this.SubscriptionHandler.promises.previewAddonPurchase
        ).to.have.been.calledWith(this.user._id, 'assistant')
      })
    })
  })
})