Overleaf/services/web/modules/user-activate/test/unit/src/UserActivateControllerTests.mjs

import Path from 'node:path'
import { fileURLToPath } from 'node:url'
import { strict as esmock } from 'esmock'
import sinon from 'sinon'

const __dirname = Path.dirname(fileURLToPath(import.meta.url))

const MODULE_PATH = '../../../app/src/UserActivateController.mjs'

const VIEW_PATH = Path.join(__dirname, '../../../app/views/user/activate')

describe('UserActivateController', function () {
  beforeEach(async function () {
    this.user = {
      _id: (this.user_id = 'kwjewkl'),
      features: {},
      email: 'joe@example.com',
    }

    this.UserGetter = {
      promises: {
        getUser: sinon.stub(),
      },
    }
    this.UserRegistrationHandler = { promises: {} }
    this.ErrorController = { notFound: sinon.stub() }
    this.SplitTestHandler = {
      promises: {
        getAssignment: sinon.stub().resolves({ variant: 'default' }),
      },
    }
    this.UserActivateController = await esmock(MODULE_PATH, {
      '../../../../../app/src/Features/User/UserGetter.js': this.UserGetter,
      '../../../../../app/src/Features/User/UserRegistrationHandler.js':
        this.UserRegistrationHandler,
      '../../../../../app/src/Features/Errors/ErrorController.js':
        this.ErrorController,
      '../../../../../app/src/Features/SplitTests/SplitTestHandler':
        this.SplitTestHandler,
    })
    this.req = {
      body: {},
      query: {},
      session: {
        user: this.user,
      },
    }
    this.res = {
      json: sinon.stub(),
    }
  })

  describe('activateAccountPage', function () {
    beforeEach(function () {
      this.UserGetter.promises.getUser = sinon.stub().resolves(this.user)
      this.req.query.user_id = this.user_id
      this.req.query.token = this.token = 'mock-token-123'
    })

    it('should 404 without a user_id', async function (done) {
      delete this.req.query.user_id
      this.ErrorController.notFound = () => done()
      this.UserActivateController.activateAccountPage(this.req, this.res)
    })

    it('should 404 without a token', function (done) {
      delete this.req.query.token
      this.ErrorController.notFound = () => done()
      this.UserActivateController.activateAccountPage(this.req, this.res)
    })

    it('should 404 without a valid user_id', function (done) {
      this.UserGetter.promises.getUser = sinon.stub().resolves(null)
      this.ErrorController.notFound = () => done()
      this.UserActivateController.activateAccountPage(this.req, this.res)
    })

    it('should 403 for complex user_id', function (done) {
      this.ErrorController.forbidden = () => done()
      this.req.query.user_id = { first_name: 'X' }
      this.UserActivateController.activateAccountPage(this.req, this.res)
    })

    it('should redirect activated users to login', function (done) {
      this.user.loginCount = 1
      this.res.redirect = url => {
        sinon.assert.calledWith(this.UserGetter.promises.getUser, this.user_id)
        url.should.equal('/login')
        return done()
      }
      this.UserActivateController.activateAccountPage(this.req, this.res)
    })

    it('render the activation page if the user has not logged in before', function (done) {
      this.user.loginCount = 0
      this.res.render = (page, opts) => {
        page.should.equal(VIEW_PATH)
        opts.email.should.equal(this.user.email)
        opts.token.should.equal(this.token)
        return done()
      }
      this.UserActivateController.activateAccountPage(this.req, this.res)
    })
  })

  describe('register', function () {
    beforeEach(async function () {
      this.UserRegistrationHandler.promises.registerNewUserAndSendActivationEmail =
        sinon.stub().resolves({
          user: this.user,
          setNewPasswordUrl: (this.url = 'mock/url'),
        })
      this.req.body.email = this.user.email = this.email = 'email@example.com'
      await this.UserActivateController.register(this.req, this.res)
    })

    it('should register the user and send them an email', function () {
      sinon.assert.calledWith(
        this.UserRegistrationHandler.promises
          .registerNewUserAndSendActivationEmail,
        this.email
      )
    })

    it('should return the user and activation url', function () {
      this.res.json
        .calledWith({
          email: this.email,
          setNewPasswordUrl: this.url,
        })
        .should.equal(true)
    })
  })
})