overleaf/services/web/test/UnitTests/coffee/Subscription/LimitationsManagerTests.coffee
Shane Kilkelly 069f49d5a6 Change getCollaboratorCount to getInvitedCollaboratorCount.
And update the one call-site in LimitationsManager. This function
is used to limit invites, so it makes sense to explicitely limit
this to Invited members of the project.
2017-09-20 10:29:47 +01:00

282 lines
11 KiB
CoffeeScript

SandboxedModule = require('sandboxed-module')
sinon = require('sinon')
require('chai').should()
modulePath = require('path').join __dirname, '../../../../app/js/Features/Subscription/LimitationsManager'
Settings = require("settings-sharelatex")
describe "LimitationsManager", ->
beforeEach ->
@project = { _id: @project_id = "project-id" }
@user = { _id: @user_id = "user-id", features:{} }
@Project =
findById: (project_id, fields, callback) =>
if project_id == @project_id
callback null, @project
else
callback null, null
@UserGetter =
getUser: (user_id, filter, callback) =>
if user_id == @user_id
callback null, @user
else
callback null, null
@SubscriptionLocator =
getUsersSubscription: sinon.stub()
@LimitationsManager = SandboxedModule.require modulePath, requires:
'../../models/Project' : Project: @Project
'../User/UserGetter' : @UserGetter
'./SubscriptionLocator':@SubscriptionLocator
'settings-sharelatex' : @Settings = {}
"../Collaborators/CollaboratorsHandler": @CollaboratorsHandler = {}
"../Collaborators/CollaboratorsInviteHandler": @CollaboratorsInviteHandler = {}
'logger-sharelatex':log:->
describe "allowedNumberOfCollaboratorsInProject", ->
describe "when the project is owned by a user without a subscription", ->
beforeEach ->
@Settings.defaultPlanCode = collaborators: 23
@project.owner_ref = @user_id
delete @user.features
@callback = sinon.stub()
@LimitationsManager.allowedNumberOfCollaboratorsInProject(@project_id, @callback)
it "should return the default number", ->
@callback.calledWith(null, @Settings.defaultPlanCode.collaborators).should.equal true
describe "when the project is owned by a user with a subscription", ->
beforeEach ->
@project.owner_ref = @user_id
@user.features =
collaborators: 21
@callback = sinon.stub()
@LimitationsManager.allowedNumberOfCollaboratorsInProject(@project_id, @callback)
it "should return the number of collaborators the user is allowed", ->
@callback.calledWith(null, @user.features.collaborators).should.equal true
describe "allowedNumberOfCollaboratorsForUser", ->
describe "when the user has no features", ->
beforeEach ->
@Settings.defaultPlanCode = collaborators: 23
delete @user.features
@callback = sinon.stub()
@LimitationsManager.allowedNumberOfCollaboratorsForUser(@user_id, @callback)
it "should return the default number", ->
@callback.calledWith(null, @Settings.defaultPlanCode.collaborators).should.equal true
describe "when the user has features", ->
beforeEach ->
@user.features =
collaborators: 21
@callback = sinon.stub()
@LimitationsManager.allowedNumberOfCollaboratorsForUser(@user_id, @callback)
it "should return the number of collaborators the user is allowed", ->
@callback.calledWith(null, @user.features.collaborators).should.equal true
describe "canAddXCollaborators", ->
beforeEach ->
@CollaboratorsHandler.getInvitedCollaboratorCount = (project_id, callback) => callback(null, @current_number)
@CollaboratorsInviteHandler.getInviteCount = (project_id, callback) => callback(null, @invite_count)
sinon.stub @LimitationsManager,
"allowedNumberOfCollaboratorsInProject",
(project_id, callback) => callback(null, @allowed_number)
@callback = sinon.stub()
describe "when the project has fewer collaborators than allowed", ->
beforeEach ->
@current_number = 1
@allowed_number = 2
@invite_count = 0
@LimitationsManager.canAddXCollaborators(@project_id, 1, @callback)
it "should return true", ->
@callback.calledWith(null, true).should.equal true
describe "when the project has fewer collaborators and invites than allowed", ->
beforeEach ->
@current_number = 1
@allowed_number = 4
@invite_count = 1
@LimitationsManager.canAddXCollaborators(@project_id, 1, @callback)
it "should return true", ->
@callback.calledWith(null, true).should.equal true
describe "when the project has fewer collaborators than allowed but I want to add more than allowed", ->
beforeEach ->
@current_number = 1
@allowed_number = 2
@invite_count = 0
@LimitationsManager.canAddXCollaborators(@project_id, 2, @callback)
it "should return false", ->
@callback.calledWith(null, false).should.equal true
describe "when the project has more collaborators than allowed", ->
beforeEach ->
@current_number = 3
@allowed_number = 2
@invite_count = 0
@LimitationsManager.canAddXCollaborators(@project_id, 1, @callback)
it "should return false", ->
@callback.calledWith(null, false).should.equal true
describe "when the project has infinite collaborators", ->
beforeEach ->
@current_number = 100
@allowed_number = -1
@invite_count = 0
@LimitationsManager.canAddXCollaborators(@project_id, 1, @callback)
it "should return true", ->
@callback.calledWith(null, true).should.equal true
describe 'when the project has more invites than allowed', ->
beforeEach ->
@current_number = 0
@allowed_number = 2
@invite_count = 2
@LimitationsManager.canAddXCollaborators(@project_id, 1, @callback)
it "should return false", ->
@callback.calledWith(null, false).should.equal true
describe 'when the project has more invites and collaborators than allowed', ->
beforeEach ->
@current_number = 1
@allowed_number = 2
@invite_count = 1
@LimitationsManager.canAddXCollaborators(@project_id, 1, @callback)
it "should return false", ->
@callback.calledWith(null, false).should.equal true
describe "userHasSubscription", ->
beforeEach ->
@SubscriptionLocator.getUsersSubscription = sinon.stub()
it "should return true if the recurly token is set", (done)->
@SubscriptionLocator.getUsersSubscription.callsArgWith(1, null, recurlySubscription_id : "1234")
@LimitationsManager.userHasSubscription @user, (err, hasSubscription)->
hasSubscription.should.equal true
done()
it "should return false if the recurly token is not set", (done)->
@SubscriptionLocator.getUsersSubscription.callsArgWith(1, null, {})
@subscription = {}
@LimitationsManager.userHasSubscription @user, (err, hasSubscription)->
hasSubscription.should.equal false
done()
it "should return false if the subscription is undefined", (done)->
@SubscriptionLocator.getUsersSubscription.callsArgWith(1)
@LimitationsManager.userHasSubscription @user, (err, hasSubscription)->
hasSubscription.should.equal false
done()
it "should return the subscription", (done)->
stubbedSubscription = {freeTrial:{}, token:""}
@SubscriptionLocator.getUsersSubscription.callsArgWith(1, null, stubbedSubscription)
@LimitationsManager.userHasSubscription @user, (err, hasSubOrIsGroupMember, subscription)->
subscription.should.deep.equal stubbedSubscription
done()
describe "when user has a custom account", ->
beforeEach ->
@fakeSubscription = {customAccount: true}
@SubscriptionLocator.getUsersSubscription.callsArgWith(1, null, @fakeSubscription)
it 'should return true', (done) ->
@LimitationsManager.userHasSubscription @user, (err, hasSubscription, subscription)->
hasSubscription.should.equal true
done()
it 'should return the subscription', (done) ->
@LimitationsManager.userHasSubscription @user, (err, hasSubscription, subscription)=>
subscription.should.deep.equal @fakeSubscription
done()
describe "userIsMemberOfGroupSubscription", ->
beforeEach ->
@SubscriptionLocator.getMemberSubscriptions = sinon.stub()
it "should return false if there are no groups subcriptions", (done)->
@SubscriptionLocator.getMemberSubscriptions.callsArgWith(1, null, [])
@LimitationsManager.userIsMemberOfGroupSubscription @user, (err, isMember)->
isMember.should.equal false
done()
it "should return true if there are no groups subcriptions", (done)->
@SubscriptionLocator.getMemberSubscriptions.callsArgWith(1, null, subscriptions = ["mock-subscription"])
@LimitationsManager.userIsMemberOfGroupSubscription @user, (err, isMember, retSubscriptions)->
isMember.should.equal true
retSubscriptions.should.equal subscriptions
done()
describe "userHasSubscriptionOrIsGroupMember", ->
beforeEach ->
@LimitationsManager.userIsMemberOfGroupSubscription = sinon.stub()
@LimitationsManager.userHasSubscription = sinon.stub()
it "should return true if both are true", (done)->
@LimitationsManager.userIsMemberOfGroupSubscription.callsArgWith(1, null, true)
@LimitationsManager.userHasSubscription.callsArgWith(1, null, true)
@LimitationsManager.userHasSubscriptionOrIsGroupMember @user, (err, hasSubOrIsGroupMember)->
hasSubOrIsGroupMember.should.equal true
done()
it "should return true if one is true", (done)->
@LimitationsManager.userIsMemberOfGroupSubscription.callsArgWith(1, null, true)
@LimitationsManager.userHasSubscription.callsArgWith(1, null, false)
@LimitationsManager.userHasSubscriptionOrIsGroupMember @user, (err, hasSubOrIsGroupMember)->
hasSubOrIsGroupMember.should.equal true
done()
it "should return true if other is true", (done)->
@LimitationsManager.userIsMemberOfGroupSubscription.callsArgWith(1, null, false)
@LimitationsManager.userHasSubscription.callsArgWith(1, null, true)
@LimitationsManager.userHasSubscriptionOrIsGroupMember @user, (err, hasSubOrIsGroupMember)->
hasSubOrIsGroupMember.should.equal true
done()
it "should return false if both are false", (done)->
@LimitationsManager.userIsMemberOfGroupSubscription.callsArgWith(1, null, false)
@LimitationsManager.userHasSubscription.callsArgWith(1, null, false)
@LimitationsManager.userHasSubscriptionOrIsGroupMember @user, (err, hasSubOrIsGroupMember)->
hasSubOrIsGroupMember.should.equal false
done()
describe "hasGroupMembersLimitReached", ->
beforeEach ->
@user_id = "12312"
@subscription =
membersLimit: 3
member_ids: ["", ""]
invited_emails: ["bob@example.com"]
it "should return true if the limit is hit (including members and invites)", (done)->
@SubscriptionLocator.getUsersSubscription.callsArgWith(1, null, @subscription)
@LimitationsManager.hasGroupMembersLimitReached @user_id, (err, limitReached)->
limitReached.should.equal true
done()
it "should return false if the limit is not hit (including members and invites)", (done)->
@subscription.membersLimit = 4
@SubscriptionLocator.getUsersSubscription.callsArgWith(1, null, @subscription)
@LimitationsManager.hasGroupMembersLimitReached @user_id, (err, limitReached)->
limitReached.should.equal false
done()
it "should return true if the limit has been exceded (including members and invites)", (done)->
@subscription.membersLimit = 2
@SubscriptionLocator.getUsersSubscription.callsArgWith(1, null, @subscription)
@LimitationsManager.hasGroupMembersLimitReached @user_id, (err, limitReached)->
limitReached.should.equal true
done()