davrot/overleaf-cep
1
0
Fork 0
mirror of https://github.com/yu-i-i/overleaf-cep.git synced 2025-07-28 20:00:10 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

[web] Remove promises exports from Controller modules (#22242)

Browse source 
* Remove promises object from CollaboratorsInviteController.mjs

* Define functions at root

* Remove mentions of undefined `revokeInviteForUser`

* Remove unused `doLogout`

* Remove promises object from UserController.js

* Remove unused `makeChangePreview`

* Remove promises object from SubscriptionController.js (`getRecommendedCurrency` and `getLatamCountryBannerDetails`)

* Remove promises object from CollabratecController.mjs

* Remove promises object from SSOController.mjs

* Remove promises object from ReferencesApiController.mjs

* Remove promises object from MetricsEmailController.mjs

* Remove promises object from InstitutionHubsController.mjs

* Remove promises object from DocumentUpdaterController.mjs

* Remove promises object from SubscriptionAdminController.mjs

* Fixup unit tests

* Add expects that controllers don't error

* Promisify `ensureAffiliationMiddleware`

GitOrigin-RevId: 311c8afa7d5c8e4f051408d305b6b4147a020edc
This commit is contained in:
Antoine Clausse 2025-01-17 09:06:05 +01:00 • committed by Copybot
parent ae34c4b8cc
commit b9fb636f0b
9 changed files with 487 additions and 540 deletions
Download patch file Download diff file Expand all files Collapse all files

77
services/web/app/src/Features/Collaborators/CollaboratorsInviteController.mjs
View file

@ -1,4 +1,3 @@
import { callbackify } from 'node:util'
import ProjectGetter from '../Project/ProjectGetter.js' import ProjectGetter from '../Project/ProjectGetter.js'
import LimitationsManager from '../Subscription/LimitationsManager.js' import LimitationsManager from '../Subscription/LimitationsManager.js'
import UserGetter from '../User/UserGetter.js' import UserGetter from '../User/UserGetter.js'
@ -34,16 +33,15 @@ const rateLimiter = new RateLimiter('invite-to-project-by-user-id', {
duration: 60 * 30, duration: 60 * 30,
}) })
const CollaboratorsInviteController = { async function getAllInvites(req, res) {
async getAllInvites(req, res) {
const projectId = req.params.Project_id const projectId = req.params.Project_id
logger.debug({ projectId }, 'getting all active invites for project') logger.debug({ projectId }, 'getting all active invites for project')
const invites = const invites =
await CollaboratorsInviteGetter.promises.getAllInvites(projectId) await CollaboratorsInviteGetter.promises.getAllInvites(projectId)
res.json({ invites }) res.json({ invites })
}, }
async _checkShouldInviteEmail(email) { async function _checkShouldInviteEmail(email) {
if (Settings.restrictInvitesToExistingAccounts === true) { if (Settings.restrictInvitesToExistingAccounts === true) {
logger.debug({ email }, 'checking if user exists with this email') logger.debug({ email }, 'checking if user exists with this email')
const user = await UserGetter.promises.getUserByAnyEmail(email, { const user = await UserGetter.promises.getUserByAnyEmail(email, {
@ -54,9 +52,9 @@ const CollaboratorsInviteController = {
} else { } else {
return true return true
} }
}, }
async _checkRateLimit(userId) { async function _checkRateLimit(userId) {
let collabLimit = let collabLimit =
await LimitationsManager.promises.allowedNumberOfCollaboratorsForUser( await LimitationsManager.promises.allowedNumberOfCollaboratorsForUser(
userId userId
@ -81,9 +79,9 @@ const CollaboratorsInviteController = {
} }
} }
return true return true
}, }
async inviteToProject(req, res) { async function inviteToProject(req, res) {
const projectId = req.params.Project_id const projectId = req.params.Project_id
let { email, privileges } = req.body let { email, privileges } = req.body
const sendingUser = SessionManager.getSessionUser(req.session) const sendingUser = SessionManager.getSessionUser(req.session)
@ -180,14 +178,12 @@ const CollaboratorsInviteController = {
logger.debug({ projectId, email, sendingUserId }, 'invite created') logger.debug({ projectId, email, sendingUserId }, 'invite created')
EditorRealTimeController.emitToRoom( EditorRealTimeController.emitToRoom(projectId, 'project:membership:changed', {
projectId, invites: true,
'project:membership:changed', })
{ invites: true }
)
res.json({ invite }) res.json({ invite })
}, }
async revokeInvite(req, res) { async function revokeInvite(req, res) {
const projectId = req.params.Project_id const projectId = req.params.Project_id
const inviteId = req.params.invite_id const inviteId = req.params.invite_id
const user = SessionManager.getSessionUser(req.session) const user = SessionManager.getSessionUser(req.session)
@ -218,9 +214,9 @@ const CollaboratorsInviteController = {
} }
res.sendStatus(204) res.sendStatus(204)
}, }
async generateNewInvite(req, res) { async function generateNewInvite(req, res) {
const projectId = req.params.Project_id const projectId = req.params.Project_id
const inviteId = req.params.invite_id const inviteId = req.params.invite_id
const user = SessionManager.getSessionUser(req.session) const user = SessionManager.getSessionUser(req.session)
@ -240,11 +236,9 @@ const CollaboratorsInviteController = {
inviteId inviteId
) )
EditorRealTimeController.emitToRoom( EditorRealTimeController.emitToRoom(projectId, 'project:membership:changed', {
projectId, invites: true,
'project:membership:changed', })
{ invites: true }
)
if (invite != null) { if (invite != null) {
ProjectAuditLogHandler.addEntryInBackground( ProjectAuditLogHandler.addEntryInBackground(
@ -262,9 +256,9 @@ const CollaboratorsInviteController = {
} else { } else {
res.sendStatus(404) res.sendStatus(404)
} }
}, }
async viewInvite(req, res) { async function viewInvite(req, res) {
const projectId = req.params.Project_id const projectId = req.params.Project_id
const { token } = req.params const { token } = req.params
const _renderInvalidPage = function () { const _renderInvalidPage = function () {
@ -341,9 +335,9 @@ const CollaboratorsInviteController = {
owner, owner,
title: 'Project Invite', title: 'Project Invite',
}) })
}, }
async acceptInvite(req, res) { async function acceptInvite(req, res) {
const { Project_id: projectId, token } = req.params const { Project_id: projectId, token } = req.params
const currentUser = SessionManager.getSessionUser(req.session) const currentUser = SessionManager.getSessionUser(req.session)
logger.debug( logger.debug(
@ -395,24 +389,17 @@ const CollaboratorsInviteController = {
} else { } else {
res.redirect(`/project/${projectId}`) res.redirect(`/project/${projectId}`)
} }
},
} }
export default { const CollaboratorsInviteController = {
promises: CollaboratorsInviteController, getAllInvites: expressify(getAllInvites),
getAllInvites: expressify(CollaboratorsInviteController.getAllInvites), inviteToProject: expressify(inviteToProject),
inviteToProject: expressify(CollaboratorsInviteController.inviteToProject), revokeInvite: expressify(revokeInvite),
revokeInvite: expressify(CollaboratorsInviteController.revokeInvite), generateNewInvite: expressify(generateNewInvite),
revokeInviteForUser: expressify( viewInvite: expressify(viewInvite),
CollaboratorsInviteController.revokeInviteForUser acceptInvite: expressify(acceptInvite),
), _checkShouldInviteEmail,
generateNewInvite: expressify( _checkRateLimit,
CollaboratorsInviteController.generateNewInvite
),
viewInvite: expressify(CollaboratorsInviteController.viewInvite),
acceptInvite: expressify(CollaboratorsInviteController.acceptInvite),
_checkShouldInviteEmail: callbackify(
CollaboratorsInviteController._checkShouldInviteEmail
),
_checkRateLimit: callbackify(CollaboratorsInviteController._checkRateLimit),
} }
export default CollaboratorsInviteController

3
services/web/app/src/Features/DocumentUpdater/DocumentUpdaterController.mjs
View file

@ -44,7 +44,4 @@ async function getDoc(req, res) {
export default { export default {
getDoc: expressify(getDoc), getDoc: expressify(getDoc),
promises: {
getDoc,
},
} }

6
services/web/app/src/Features/Subscription/SubscriptionController.js
View file

@ -544,7 +544,7 @@ async function redirectToHostedPage(req, res) {
res.redirect(url) res.redirect(url)
} }
async function _getRecommendedCurrency(req, res) { async function getRecommendedCurrency(req, res) {
const userId = SessionManager.getLoggedInUserId(req.session) const userId = SessionManager.getLoggedInUserId(req.session)
let ip = req.ip let ip = req.ip
if ( if (
@ -683,8 +683,6 @@ module.exports = {
purchaseAddon, purchaseAddon,
removeAddon, removeAddon,
makeChangePreview, makeChangePreview,
promises: { getRecommendedCurrency,
getRecommendedCurrency: _getRecommendedCurrency,
getLatamCountryBannerDetails, getLatamCountryBannerDetails,
},
} }

12
services/web/app/src/Features/User/UserController.js
View file

@ -16,7 +16,7 @@ const HttpErrorHandler = require('../Errors/HttpErrorHandler')
const OError = require('@overleaf/o-error') const OError = require('@overleaf/o-error')
const EmailHandler = require('../Email/EmailHandler') const EmailHandler = require('../Email/EmailHandler')
const UrlHelper = require('../Helpers/UrlHelper') const UrlHelper = require('../Helpers/UrlHelper')
const { promisify, callbackify } = require('util') const { promisify } = require('util')
const { expressify } = require('@overleaf/promise-utils') const { expressify } = require('@overleaf/promise-utils')
const { const {
acceptsJson, acceptsJson,
@ -212,11 +212,7 @@ async function ensureAffiliationMiddleware(req, res, next) {
return next() return next()
} }
} }
try {
await ensureAffiliation(user) await ensureAffiliation(user)
} catch (error) {
return next(error)
}
return next() return next()
} }
@ -505,13 +501,9 @@ module.exports = {
subscribe: expressify(subscribe), subscribe: expressify(subscribe),
unsubscribe: expressify(unsubscribe), unsubscribe: expressify(unsubscribe),
updateUserSettings: expressify(updateUserSettings), updateUserSettings: expressify(updateUserSettings),
doLogout: callbackify(doLogout),
logout: expressify(logout), logout: expressify(logout),
expireDeletedUser: expressify(expireDeletedUser), expireDeletedUser: expressify(expireDeletedUser),
expireDeletedUsersAfterDuration: expressify(expireDeletedUsersAfterDuration), expireDeletedUsersAfterDuration: expressify(expireDeletedUsersAfterDuration),
promises: { ensureAffiliationMiddleware: expressify(ensureAffiliationMiddleware),
doLogout,
ensureAffiliation, ensureAffiliation,
ensureAffiliationMiddleware,
},
} }

2
services/web/app/src/router.mjs
View file

@ -314,7 +314,7 @@ async function initialize(webRouter, privateApiRouter, publicApiRouter) {
'/user/emails', '/user/emails',
AuthenticationController.requireLogin(), AuthenticationController.requireLogin(),
PermissionsController.useCapabilities(), PermissionsController.useCapabilities(),
UserController.promises.ensureAffiliationMiddleware, UserController.ensureAffiliationMiddleware,
UserEmailsController.list UserEmailsController.list
) )
webRouter.get( webRouter.get(

2
services/web/scripts/ensure_affiliations.mjs
View file

@ -15,7 +15,7 @@ const query = {
async function _handleEnsureAffiliation(user) { async function _handleEnsureAffiliation(user) {
try { try {
await UserController.promises.ensureAffiliation(user) await UserController.ensureAffiliation(user)
console.log(`✔ ${user._id}`) console.log(`✔ ${user._id}`)
success.push(user._id) success.push(user._id)
} catch (error) { } catch (error) {

256
services/web/test/unit/src/Collaborators/CollaboratorsInviteControllerTests.mjs
View file

@ -238,17 +238,17 @@ describe('CollaboratorsInviteController', function () {
}) })
describe('when all goes well', function (done) { describe('when all goes well', function (done) {
beforeEach(function (done) { beforeEach(async function () {
this.CollaboratorsInviteController.promises._checkShouldInviteEmail = this.CollaboratorsInviteController._checkShouldInviteEmail = sinon
sinon.stub().resolves(true)
this.CollaboratorsInviteController.promises._checkRateLimit = sinon
.stub() .stub()
.resolves(true) .resolves(true)
this.res.callback = () => done() this.CollaboratorsInviteController._checkRateLimit = sinon
this.CollaboratorsInviteController.inviteToProject( .stub()
.resolves(true)
await this.CollaboratorsInviteController.inviteToProject(
this.req, this.req,
this.res, this.res
done
) )
}) })
@ -269,10 +269,11 @@ describe('CollaboratorsInviteController', function () {
}) })
it('should have called _checkShouldInviteEmail', function () { it('should have called _checkShouldInviteEmail', function () {
this.CollaboratorsInviteController.promises._checkShouldInviteEmail.callCount.should.equal( this.CollaboratorsInviteController._checkShouldInviteEmail.callCount.should.equal(
1 1
) )
this.CollaboratorsInviteController.promises._checkShouldInviteEmail
this.CollaboratorsInviteController._checkShouldInviteEmail
.calledWith(this.targetEmail) .calledWith(this.targetEmail)
.should.equal(true) .should.equal(true)
}) })
@ -322,9 +323,10 @@ describe('CollaboratorsInviteController', function () {
describe('readAndWrite collaborator', function () { describe('readAndWrite collaborator', function () {
beforeEach(function (done) { beforeEach(function (done) {
this.privileges = 'readAndWrite' this.privileges = 'readAndWrite'
this.CollaboratorsInviteController.promises._checkShouldInviteEmail = this.CollaboratorsInviteController._checkShouldInviteEmail = sinon
sinon.stub().resolves(true) .stub()
this.CollaboratorsInviteController.promises._checkRateLimit = sinon .resolves(true)
this.CollaboratorsInviteController._checkRateLimit = sinon
.stub() .stub()
.resolves(true) .resolves(true)
this.res.callback = () => done() this.res.callback = () => done()
@ -343,10 +345,10 @@ describe('CollaboratorsInviteController', function () {
}) })
it('should not have called _checkShouldInviteEmail', function () { it('should not have called _checkShouldInviteEmail', function () {
this.CollaboratorsInviteController.promises._checkShouldInviteEmail.callCount.should.equal( this.CollaboratorsInviteController._checkShouldInviteEmail.callCount.should.equal(
0 0
) )
this.CollaboratorsInviteController.promises._checkShouldInviteEmail this.CollaboratorsInviteController._checkShouldInviteEmail
.calledWith(this.currentUser, this.targetEmail) .calledWith(this.currentUser, this.targetEmail)
.should.equal(false) .should.equal(false)
}) })
@ -364,9 +366,10 @@ describe('CollaboratorsInviteController', function () {
email: this.targetEmail, email: this.targetEmail,
privileges: (this.privileges = 'readOnly'), privileges: (this.privileges = 'readOnly'),
} }
this.CollaboratorsInviteController.promises._checkShouldInviteEmail = this.CollaboratorsInviteController._checkShouldInviteEmail = sinon
sinon.stub().resolves(true) .stub()
this.CollaboratorsInviteController.promises._checkRateLimit = sinon .resolves(true)
this.CollaboratorsInviteController._checkRateLimit = sinon
.stub() .stub()
.resolves(true) .resolves(true)
this.res.callback = () => done() this.res.callback = () => done()
@ -391,10 +394,10 @@ describe('CollaboratorsInviteController', function () {
}) })
it('should have called _checkShouldInviteEmail', function () { it('should have called _checkShouldInviteEmail', function () {
this.CollaboratorsInviteController.promises._checkShouldInviteEmail.callCount.should.equal( this.CollaboratorsInviteController._checkShouldInviteEmail.callCount.should.equal(
1 1
) )
this.CollaboratorsInviteController.promises._checkShouldInviteEmail this.CollaboratorsInviteController._checkShouldInviteEmail
.calledWith(this.targetEmail) .calledWith(this.targetEmail)
.should.equal(true) .should.equal(true)
}) })
@ -438,9 +441,10 @@ describe('CollaboratorsInviteController', function () {
describe('when all goes well', function (done) { describe('when all goes well', function (done) {
beforeEach(function (done) { beforeEach(function (done) {
this.CollaboratorsInviteController.promises._checkShouldInviteEmail = this.CollaboratorsInviteController._checkShouldInviteEmail = sinon
sinon.stub().resolves(true) .stub()
this.CollaboratorsInviteController.promises._checkRateLimit = sinon .resolves(true)
this.CollaboratorsInviteController._checkRateLimit = sinon
.stub() .stub()
.resolves(true) .resolves(true)
this.res.callback = () => done() this.res.callback = () => done()
@ -468,10 +472,10 @@ describe('CollaboratorsInviteController', function () {
}) })
it('should have called _checkShouldInviteEmail', function () { it('should have called _checkShouldInviteEmail', function () {
this.CollaboratorsInviteController.promises._checkShouldInviteEmail.callCount.should.equal( this.CollaboratorsInviteController._checkShouldInviteEmail.callCount.should.equal(
1 1
) )
this.CollaboratorsInviteController.promises._checkShouldInviteEmail this.CollaboratorsInviteController._checkShouldInviteEmail
.calledWith(this.targetEmail) .calledWith(this.targetEmail)
.should.equal(true) .should.equal(true)
}) })
@ -513,9 +517,10 @@ describe('CollaboratorsInviteController', function () {
describe('when the user is not allowed to add more collaborators', function () { describe('when the user is not allowed to add more collaborators', function () {
beforeEach(function (done) { beforeEach(function (done) {
this.CollaboratorsInviteController.promises._checkShouldInviteEmail = this.CollaboratorsInviteController._checkShouldInviteEmail = sinon
sinon.stub().resolves(true) .stub()
this.CollaboratorsInviteController.promises._checkRateLimit = sinon .resolves(true)
this.CollaboratorsInviteController._checkRateLimit = sinon
.stub() .stub()
.resolves(true) .resolves(true)
this.LimitationsManager.promises.canAddXCollaborators.resolves(false) this.LimitationsManager.promises.canAddXCollaborators.resolves(false)
@ -533,10 +538,10 @@ describe('CollaboratorsInviteController', function () {
}) })
it('should not have called _checkShouldInviteEmail', function () { it('should not have called _checkShouldInviteEmail', function () {
this.CollaboratorsInviteController.promises._checkShouldInviteEmail.callCount.should.equal( this.CollaboratorsInviteController._checkShouldInviteEmail.callCount.should.equal(
0 0
) )
this.CollaboratorsInviteController.promises._checkShouldInviteEmail this.CollaboratorsInviteController._checkShouldInviteEmail
.calledWith(this.currentUser, this.targetEmail) .calledWith(this.currentUser, this.targetEmail)
.should.equal(false) .should.equal(false)
}) })
@ -550,9 +555,10 @@ describe('CollaboratorsInviteController', function () {
describe('when canAddXCollaborators produces an error', function () { describe('when canAddXCollaborators produces an error', function () {
beforeEach(function (done) { beforeEach(function (done) {
this.CollaboratorsInviteController.promises._checkShouldInviteEmail = this.CollaboratorsInviteController._checkShouldInviteEmail = sinon
sinon.stub().resolves(true) .stub()
this.CollaboratorsInviteController.promises._checkRateLimit = sinon .resolves(true)
this.CollaboratorsInviteController._checkRateLimit = sinon
.stub() .stub()
.resolves(true) .resolves(true)
this.LimitationsManager.promises.canAddXCollaborators.rejects( this.LimitationsManager.promises.canAddXCollaborators.rejects(
@ -572,10 +578,10 @@ describe('CollaboratorsInviteController', function () {
}) })
it('should not have called _checkShouldInviteEmail', function () { it('should not have called _checkShouldInviteEmail', function () {
this.CollaboratorsInviteController.promises._checkShouldInviteEmail.callCount.should.equal( this.CollaboratorsInviteController._checkShouldInviteEmail.callCount.should.equal(
0 0
) )
this.CollaboratorsInviteController.promises._checkShouldInviteEmail this.CollaboratorsInviteController._checkShouldInviteEmail
.calledWith(this.currentUser, this.targetEmail) .calledWith(this.currentUser, this.targetEmail)
.should.equal(false) .should.equal(false)
}) })
@ -589,9 +595,10 @@ describe('CollaboratorsInviteController', function () {
describe('when inviteToProject produces an error', function () { describe('when inviteToProject produces an error', function () {
beforeEach(function (done) { beforeEach(function (done) {
this.CollaboratorsInviteController.promises._checkShouldInviteEmail = this.CollaboratorsInviteController._checkShouldInviteEmail = sinon
sinon.stub().resolves(true) .stub()
this.CollaboratorsInviteController.promises._checkRateLimit = sinon .resolves(true)
this.CollaboratorsInviteController._checkRateLimit = sinon
.stub() .stub()
.resolves(true) .resolves(true)
this.CollaboratorsInviteHandler.promises.inviteToProject.rejects( this.CollaboratorsInviteHandler.promises.inviteToProject.rejects(
@ -620,10 +627,10 @@ describe('CollaboratorsInviteController', function () {
}) })
it('should have called _checkShouldInviteEmail', function () { it('should have called _checkShouldInviteEmail', function () {
this.CollaboratorsInviteController.promises._checkShouldInviteEmail.callCount.should.equal( this.CollaboratorsInviteController._checkShouldInviteEmail.callCount.should.equal(
1 1
) )
this.CollaboratorsInviteController.promises._checkShouldInviteEmail this.CollaboratorsInviteController._checkShouldInviteEmail
.calledWith(this.targetEmail) .calledWith(this.targetEmail)
.should.equal(true) .should.equal(true)
}) })
@ -645,9 +652,10 @@ describe('CollaboratorsInviteController', function () {
describe('when _checkShouldInviteEmail disallows the invite', function () { describe('when _checkShouldInviteEmail disallows the invite', function () {
beforeEach(function (done) { beforeEach(function (done) {
this.CollaboratorsInviteController.promises._checkShouldInviteEmail = this.CollaboratorsInviteController._checkShouldInviteEmail = sinon
sinon.stub().resolves(false) .stub()
this.CollaboratorsInviteController.promises._checkRateLimit = sinon .resolves(false)
this.CollaboratorsInviteController._checkRateLimit = sinon
.stub() .stub()
.resolves(true) .resolves(true)
this.res.callback = () => done() this.res.callback = () => done()
@ -667,10 +675,10 @@ describe('CollaboratorsInviteController', function () {
}) })
it('should have called _checkShouldInviteEmail', function () { it('should have called _checkShouldInviteEmail', function () {
this.CollaboratorsInviteController.promises._checkShouldInviteEmail.callCount.should.equal( this.CollaboratorsInviteController._checkShouldInviteEmail.callCount.should.equal(
1 1
) )
this.CollaboratorsInviteController.promises._checkShouldInviteEmail this.CollaboratorsInviteController._checkShouldInviteEmail
.calledWith(this.targetEmail) .calledWith(this.targetEmail)
.should.equal(true) .should.equal(true)
}) })
@ -684,9 +692,10 @@ describe('CollaboratorsInviteController', function () {
describe('when _checkShouldInviteEmail produces an error', function () { describe('when _checkShouldInviteEmail produces an error', function () {
beforeEach(function (done) { beforeEach(function (done) {
this.CollaboratorsInviteController.promises._checkShouldInviteEmail = this.CollaboratorsInviteController._checkShouldInviteEmail = sinon
sinon.stub().rejects(new Error('woops')) .stub()
this.CollaboratorsInviteController.promises._checkRateLimit = sinon .rejects(new Error('woops'))
this.CollaboratorsInviteController._checkRateLimit = sinon
.stub() .stub()
.resolves(true) .resolves(true)
this.next.callsFake(() => done()) this.next.callsFake(() => done())
@ -703,10 +712,10 @@ describe('CollaboratorsInviteController', function () {
}) })
it('should have called _checkShouldInviteEmail', function () { it('should have called _checkShouldInviteEmail', function () {
this.CollaboratorsInviteController.promises._checkShouldInviteEmail.callCount.should.equal( this.CollaboratorsInviteController._checkShouldInviteEmail.callCount.should.equal(
1 1
) )
this.CollaboratorsInviteController.promises._checkShouldInviteEmail this.CollaboratorsInviteController._checkShouldInviteEmail
.calledWith(this.targetEmail) .calledWith(this.targetEmail)
.should.equal(true) .should.equal(true)
}) })
@ -721,9 +730,10 @@ describe('CollaboratorsInviteController', function () {
describe('when the user invites themselves to the project', function () { describe('when the user invites themselves to the project', function () {
beforeEach(function () { beforeEach(function () {
this.req.body.email = this.currentUser.email this.req.body.email = this.currentUser.email
this.CollaboratorsInviteController.promises._checkShouldInviteEmail = this.CollaboratorsInviteController._checkShouldInviteEmail = sinon
sinon.stub().resolves(true) .stub()
this.CollaboratorsInviteController.promises._checkRateLimit = sinon .resolves(true)
this.CollaboratorsInviteController._checkRateLimit = sinon
.stub() .stub()
.resolves(true) .resolves(true)
this.CollaboratorsInviteController.inviteToProject( this.CollaboratorsInviteController.inviteToProject(
@ -748,7 +758,7 @@ describe('CollaboratorsInviteController', function () {
}) })
it('should not have called _checkShouldInviteEmail', function () { it('should not have called _checkShouldInviteEmail', function () {
this.CollaboratorsInviteController.promises._checkShouldInviteEmail.callCount.should.equal( this.CollaboratorsInviteController._checkShouldInviteEmail.callCount.should.equal(
0 0
) )
}) })
@ -765,14 +775,14 @@ describe('CollaboratorsInviteController', function () {
}) })
describe('when _checkRateLimit returns false', function () { describe('when _checkRateLimit returns false', function () {
beforeEach(function (done) { beforeEach(async function () {
this.CollaboratorsInviteController.promises._checkShouldInviteEmail = this.CollaboratorsInviteController._checkShouldInviteEmail = sinon
sinon.stub().resolves(true) .stub()
this.CollaboratorsInviteController.promises._checkRateLimit = sinon .resolves(true)
this.CollaboratorsInviteController._checkRateLimit = sinon
.stub() .stub()
.resolves(false) .resolves(false)
this.res.callback = () => done() await this.CollaboratorsInviteController.inviteToProject(
this.CollaboratorsInviteController.inviteToProject(
this.req, this.req,
this.res, this.res,
this.next this.next
@ -1281,7 +1291,7 @@ describe('CollaboratorsInviteController', function () {
Project_id: this.projectId, Project_id: this.projectId,
invite_id: this.invite._id.toString(), invite_id: this.invite._id.toString(),
} }
this.CollaboratorsInviteController.promises._checkRateLimit = sinon this.CollaboratorsInviteController._checkRateLimit = sinon
.stub() .stub()
.resolves(true) .resolves(true)
}) })
@ -1316,7 +1326,7 @@ describe('CollaboratorsInviteController', function () {
}) })
it('should check the rate limit', function () { it('should check the rate limit', function () {
this.CollaboratorsInviteController.promises._checkRateLimit.callCount.should.equal( this.CollaboratorsInviteController._checkRateLimit.callCount.should.equal(
1 1
) )
}) })
@ -1600,12 +1610,8 @@ describe('CollaboratorsInviteController', function () {
describe('when we should be restricting to existing accounts', function () { describe('when we should be restricting to existing accounts', function () {
beforeEach(function () { beforeEach(function () {
this.settings.restrictInvitesToExistingAccounts = true this.settings.restrictInvitesToExistingAccounts = true
this.call = callback => { this.call = () =>
this.CollaboratorsInviteController._checkShouldInviteEmail( this.CollaboratorsInviteController._checkShouldInviteEmail(this.email)
this.email,
callback
)
}
}) })
describe('when user account is present', function () { describe('when user account is present', function () {
@ -1614,12 +1620,12 @@ describe('CollaboratorsInviteController', function () {
this.UserGetter.promises.getUserByAnyEmail.resolves(this.user) this.UserGetter.promises.getUserByAnyEmail.resolves(this.user)
}) })
it('should callback with `true`', function (done) { it('should callback with `true`', async function () {
this.call((err, shouldAllow) => { const shouldAllow =
expect(err).to.equal(null) await this.CollaboratorsInviteController._checkShouldInviteEmail(
this.email
)
expect(shouldAllow).to.equal(true) expect(shouldAllow).to.equal(true)
done()
})
}) })
}) })
@ -1629,25 +1635,22 @@ describe('CollaboratorsInviteController', function () {
this.UserGetter.promises.getUserByAnyEmail.resolves(this.user) this.UserGetter.promises.getUserByAnyEmail.resolves(this.user)
}) })
it('should callback with `false`', function (done) { it('should callback with `false`', async function () {
this.call((err, shouldAllow) => { const shouldAllow =
expect(err).to.equal(null) await this.CollaboratorsInviteController._checkShouldInviteEmail(
this.email
)
expect(shouldAllow).to.equal(false) expect(shouldAllow).to.equal(false)
done()
})
}) })
it('should have called getUser', function (done) { it('should have called getUser', async function () {
this.call((err, shouldAllow) => { await this.CollaboratorsInviteController._checkShouldInviteEmail(
if (err) { this.email
return done(err) )
}
this.UserGetter.promises.getUserByAnyEmail.callCount.should.equal(1) this.UserGetter.promises.getUserByAnyEmail.callCount.should.equal(1)
this.UserGetter.promises.getUserByAnyEmail this.UserGetter.promises.getUserByAnyEmail
.calledWith(this.email, { _id: 1 }) .calledWith(this.email, { _id: 1 })
.should.equal(true) .should.equal(true)
done()
})
}) })
}) })
@ -1657,13 +1660,12 @@ describe('CollaboratorsInviteController', function () {
this.UserGetter.promises.getUserByAnyEmail.rejects(new Error('woops')) this.UserGetter.promises.getUserByAnyEmail.rejects(new Error('woops'))
}) })
it('should callback with an error', function (done) { it('should callback with an error', async function () {
this.call((err, shouldAllow) => { await expect(
expect(err).to.not.equal(null) this.CollaboratorsInviteController._checkShouldInviteEmail(
expect(err).to.be.instanceof(Error) this.email
expect(shouldAllow).to.equal(undefined) )
done() ).to.be.rejected
})
}) })
}) })
}) })
@ -1678,91 +1680,61 @@ describe('CollaboratorsInviteController', function () {
.resolves(17) .resolves(17)
}) })
it('should callback with `true` when rate limit under', function (done) { it('should callback with `true` when rate limit under', async function () {
this.CollaboratorsInviteController._checkRateLimit( const result = await this.CollaboratorsInviteController._checkRateLimit(
this.currentUserId, this.currentUserId
(err, result) => { )
if (err) {
return done(err)
}
expect(this.rateLimiter.consume).to.have.been.calledWith( expect(this.rateLimiter.consume).to.have.been.calledWith(
this.currentUserId this.currentUserId
) )
result.should.equal(true) result.should.equal(true)
done()
}
)
}) })
it('should callback with `false` when rate limit hit', function (done) { it('should callback with `false` when rate limit hit', async function () {
this.rateLimiter.consume.rejects({ remainingPoints: 0 }) this.rateLimiter.consume.rejects({ remainingPoints: 0 })
this.CollaboratorsInviteController._checkRateLimit( const result = await this.CollaboratorsInviteController._checkRateLimit(
this.currentUserId, this.currentUserId
(err, result) => { )
if (err) {
return done(err)
}
expect(this.rateLimiter.consume).to.have.been.calledWith( expect(this.rateLimiter.consume).to.have.been.calledWith(
this.currentUserId this.currentUserId
) )
result.should.equal(false) result.should.equal(false)
done()
}
)
}) })
it('should allow 10x the collaborators', function (done) { it('should allow 10x the collaborators', async function () {
this.CollaboratorsInviteController._checkRateLimit( await this.CollaboratorsInviteController._checkRateLimit(
this.currentUserId, this.currentUserId
(err, result) => { )
if (err) {
return done(err)
}
expect(this.rateLimiter.consume).to.have.been.calledWith( expect(this.rateLimiter.consume).to.have.been.calledWith(
this.currentUserId, this.currentUserId,
Math.floor(40000 / 170) Math.floor(40000 / 170)
) )
done()
}
)
}) })
it('should allow 200 requests when collaborators is -1', function (done) { it('should allow 200 requests when collaborators is -1', async function () {
this.LimitationsManager.promises.allowedNumberOfCollaboratorsForUser this.LimitationsManager.promises.allowedNumberOfCollaboratorsForUser
.withArgs(this.currentUserId) .withArgs(this.currentUserId)
.resolves(-1) .resolves(-1)
this.CollaboratorsInviteController._checkRateLimit( await this.CollaboratorsInviteController._checkRateLimit(
this.currentUserId, this.currentUserId
(err, result) => { )
if (err) {
return done(err)
}
expect(this.rateLimiter.consume).to.have.been.calledWith( expect(this.rateLimiter.consume).to.have.been.calledWith(
this.currentUserId, this.currentUserId,
Math.floor(40000 / 200) Math.floor(40000 / 200)
) )
done()
}
)
}) })
it('should allow 10 requests when user has no collaborators set', function (done) { it('should allow 10 requests when user has no collaborators set', async function () {
this.LimitationsManager.promises.allowedNumberOfCollaboratorsForUser this.LimitationsManager.promises.allowedNumberOfCollaboratorsForUser
.withArgs(this.currentUserId) .withArgs(this.currentUserId)
.resolves(null) .resolves(null)
this.CollaboratorsInviteController._checkRateLimit( await this.CollaboratorsInviteController._checkRateLimit(
this.currentUserId, this.currentUserId
(err, result) => { )
if (err) {
return done(err)
}
expect(this.rateLimiter.consume).to.have.been.calledWith( expect(this.rateLimiter.consume).to.have.been.calledWith(
this.currentUserId, this.currentUserId,
Math.floor(40000 / 10) Math.floor(40000 / 10)
) )
done()
}
)
}) })
}) })
}) })

11
services/web/test/unit/src/DocumentUpdater/DocumentUpdaterControllerTests.mjs
View file

@ -38,6 +38,7 @@ describe('DocumentUpdaterController', function () {
} }
this.lines = ['test', '', 'testing'] this.lines = ['test', '', 'testing']
this.res = new MockResponse() this.res = new MockResponse()
this.next = sinon.stub()
this.doc = { name: 'myfile.tex' } this.doc = { name: 'myfile.tex' }
}) })
@ -53,8 +54,7 @@ describe('DocumentUpdaterController', function () {
}) })
it('should call the document updater handler with the project_id and doc_id', async function () { it('should call the document updater handler with the project_id and doc_id', async function () {
await this.controller.promises.getDoc(this.req, this.res) await this.controller.getDoc(this.req, this.res, this.next)
expect( expect(
this.DocumentUpdaterHandler.promises.getDocument this.DocumentUpdaterHandler.promises.getDocument
).to.have.been.calledOnceWith( ).to.have.been.calledOnceWith(
@ -65,13 +65,14 @@ describe('DocumentUpdaterController', function () {
}) })
it('should return the content', async function () { it('should return the content', async function () {
await this.controller.promises.getDoc(this.req, this.res) await this.controller.getDoc(this.req, this.res)
expect(this.next).to.not.have.been.called
expect(this.res.statusCode).to.equal(200) expect(this.res.statusCode).to.equal(200)
expect(this.res.body).to.equal('test\n\ntesting') expect(this.res.body).to.equal('test\n\ntesting')
}) })
it('should find the doc in the project', async function () { it('should find the doc in the project', async function () {
await this.controller.promises.getDoc(this.req, this.res) await this.controller.getDoc(this.req, this.res)
expect( expect(
this.ProjectLocator.promises.findElement this.ProjectLocator.promises.findElement
).to.have.been.calledOnceWith({ ).to.have.been.calledOnceWith({
@ -82,7 +83,7 @@ describe('DocumentUpdaterController', function () {
}) })
it('should set the Content-Disposition header', async function () { it('should set the Content-Disposition header', async function () {
await this.controller.promises.getDoc(this.req, this.res) await this.controller.getDoc(this.req, this.res)
expect(this.res.setContentDisposition).to.have.been.calledWith( expect(this.res.setContentDisposition).to.have.been.calledWith(
'attachment', 'attachment',
{ filename: this.doc.name } { filename: this.doc.name }

12
services/web/test/unit/src/User/UserControllerTests.js
View file

@ -916,7 +916,7 @@ describe('UserController', function () {
describe('ensureAffiliationMiddleware', function () { describe('ensureAffiliationMiddleware', function () {
describe('without affiliations feature', function () { describe('without affiliations feature', function () {
beforeEach(async function () { beforeEach(async function () {
await this.UserController.promises.ensureAffiliationMiddleware( await this.UserController.ensureAffiliationMiddleware(
this.req, this.req,
this.res, this.res,
this.next this.next
@ -938,7 +938,7 @@ describe('UserController', function () {
describe('without ensureAffiliation query parameter', function () { describe('without ensureAffiliation query parameter', function () {
beforeEach(async function () { beforeEach(async function () {
this.Features.hasFeature.withArgs('affiliations').returns(true) this.Features.hasFeature.withArgs('affiliations').returns(true)
await this.UserController.promises.ensureAffiliationMiddleware( await this.UserController.ensureAffiliationMiddleware(
this.req, this.req,
this.res, this.res,
this.next this.next
@ -968,7 +968,7 @@ describe('UserController', function () {
] ]
this.Features.hasFeature.withArgs('affiliations').returns(true) this.Features.hasFeature.withArgs('affiliations').returns(true)
this.req.query.ensureAffiliation = true this.req.query.ensureAffiliation = true
await this.UserController.promises.ensureAffiliationMiddleware( await this.UserController.ensureAffiliationMiddleware(
this.req, this.req,
this.res, this.res,
this.next this.next
@ -1005,7 +1005,7 @@ describe('UserController', function () {
this.Features.hasFeature.withArgs('affiliations').returns(true) this.Features.hasFeature.withArgs('affiliations').returns(true)
this.req.query.ensureAffiliation = true this.req.query.ensureAffiliation = true
this.req.assertPermission = sinon.stub() this.req.assertPermission = sinon.stub()
await this.UserController.promises.ensureAffiliationMiddleware( await this.UserController.ensureAffiliationMiddleware(
this.req, this.req,
this.res, this.res,
this.next this.next
@ -1047,7 +1047,7 @@ describe('UserController', function () {
this.Features.hasFeature.withArgs('affiliations').returns(true) this.Features.hasFeature.withArgs('affiliations').returns(true)
this.req.query.ensureAffiliation = true this.req.query.ensureAffiliation = true
this.req.assertPermission = sinon.stub() this.req.assertPermission = sinon.stub()
await this.UserController.promises.ensureAffiliationMiddleware( await this.UserController.ensureAffiliationMiddleware(
this.req, this.req,
this.res, this.res,
this.next this.next
@ -1089,7 +1089,7 @@ describe('UserController', function () {
this.Features.hasFeature.withArgs('affiliations').returns(true) this.Features.hasFeature.withArgs('affiliations').returns(true)
this.req.query.ensureAffiliation = true this.req.query.ensureAffiliation = true
this.req.assertPermission = sinon.stub() this.req.assertPermission = sinon.stub()
await this.UserController.promises.ensureAffiliationMiddleware( await this.UserController.ensureAffiliationMiddleware(
this.req, this.req,
this.res, this.res,
this.next this.next