Merge pull request #605 from sharelatex/afc-update-user-references

Add method to update user references
This commit is contained in:
Alberto Fernández-Capel
2018-06-08 11:29:25 +01:00
committed by GitHub
2 changed files with 65 additions and 14 deletions
@@ -3,6 +3,7 @@ _ = require("underscore")
SubscriptionUpdater = require("./SubscriptionUpdater") SubscriptionUpdater = require("./SubscriptionUpdater")
SubscriptionLocator = require("./SubscriptionLocator") SubscriptionLocator = require("./SubscriptionLocator")
UserGetter = require("../User/UserGetter") UserGetter = require("../User/UserGetter")
Subscription = require("../../models/Subscription").Subscription
LimitationsManager = require("./LimitationsManager") LimitationsManager = require("./LimitationsManager")
logger = require("logger-sharelatex") logger = require("logger-sharelatex")
OneTimeTokenHandler = require("../Security/OneTimeTokenHandler") OneTimeTokenHandler = require("../Security/OneTimeTokenHandler")
@@ -39,12 +40,27 @@ module.exports = SubscriptionGroupHandler =
removeUserFromGroup: (adminUser_id, userToRemove_id, callback)-> removeUserFromGroup: (adminUser_id, userToRemove_id, callback)->
SubscriptionUpdater.removeUserFromGroup adminUser_id, userToRemove_id, callback SubscriptionUpdater.removeUserFromGroup adminUser_id, userToRemove_id, callback
removeEmailInviteFromGroup: (adminUser_id, email, callback) -> removeEmailInviteFromGroup: (adminUser_id, email, callback) ->
SubscriptionUpdater.removeEmailInviteFromGroup adminUser_id, email, callback SubscriptionUpdater.removeEmailInviteFromGroup adminUser_id, email, callback
replaceUserReferencesInGroups: (oldId, newId, callback) ->
Subscription.update {admin_id: oldId}, {admin_id: newId}, (error) ->
callback(error) if error?
# Mongo won't let us pull and addToSet in the same query, so do it in
# two. Note we need to add first, since the query is based on the old user.
query = { member_ids: oldId }
addNewUserUpdate = $addToSet: { member_ids: newId }
removeOldUserUpdate = $pull: { member_ids: oldId }
Subscription.update query, addNewUserUpdate, { multi: true }, (error) ->
return callback(error) if error?
Subscription.update query, removeOldUserUpdate, { multi: true }, callback
getPopulatedListOfMembers: (adminUser_id, callback)-> getPopulatedListOfMembers: (adminUser_id, callback)->
SubscriptionLocator.getUsersSubscription adminUser_id, (err, subscription)-> SubscriptionLocator.getUsersSubscription adminUser_id, (err, subscription)->
users = [] users = []
for email in subscription.invited_emails or [] for email in subscription.invited_emails or []
users.push buildEmailInviteViewModel(email) users.push buildEmailInviteViewModel(email)
@@ -111,7 +127,7 @@ module.exports = SubscriptionGroupHandler =
async.series jobs, callback async.series jobs, callback
buildUserViewModel = (user)-> buildUserViewModel = (user)->
u = u =
email: user.email email: user.email
first_name: user.first_name first_name: user.first_name
last_name: user.last_name last_name: user.last_name
@@ -123,4 +139,4 @@ buildEmailInviteViewModel = (email) ->
return { return {
email: email email: email
holdingAccount: true holdingAccount: true
} }
@@ -19,11 +19,14 @@ describe "SubscriptionGroupHandler", ->
admin_id:@adminUser_id admin_id:@adminUser_id
_id:@subscription_id _id:@subscription_id
@SubscriptionLocator = @SubscriptionLocator =
getUsersSubscription: sinon.stub() getUsersSubscription: sinon.stub()
getSubscriptionByMemberIdAndId: sinon.stub() getSubscriptionByMemberIdAndId: sinon.stub()
getSubscription: sinon.stub() getSubscription: sinon.stub()
@UserCreator =
getUserOrCreateHoldingAccount: sinon.stub().callsArgWith(1, null, @user)
@SubscriptionUpdater = @SubscriptionUpdater =
addUserToGroup: sinon.stub().callsArgWith(2) addUserToGroup: sinon.stub().callsArgWith(2)
removeUserFromGroup: sinon.stub().callsArgWith(2) removeUserFromGroup: sinon.stub().callsArgWith(2)
@@ -44,7 +47,10 @@ describe "SubscriptionGroupHandler", ->
@EmailHandler = @EmailHandler =
sendEmail:sinon.stub() sendEmail:sinon.stub()
@settings = @Subscription =
update: sinon.stub().yields()
@settings =
siteUrl:"http://www.sharelatex.com" siteUrl:"http://www.sharelatex.com"
@readStub = sinon.stub() @readStub = sinon.stub()
@@ -56,13 +62,14 @@ describe "SubscriptionGroupHandler", ->
"../User/UserCreator": @UserCreator "../User/UserCreator": @UserCreator
"./SubscriptionUpdater": @SubscriptionUpdater "./SubscriptionUpdater": @SubscriptionUpdater
"./SubscriptionLocator": @SubscriptionLocator "./SubscriptionLocator": @SubscriptionLocator
"../../models/Subscription": Subscription: @Subscription
"../User/UserGetter": @UserGetter "../User/UserGetter": @UserGetter
"./LimitationsManager": @LimitationsManager "./LimitationsManager": @LimitationsManager
"../Security/OneTimeTokenHandler":@OneTimeTokenHandler "../Security/OneTimeTokenHandler":@OneTimeTokenHandler
"../Email/EmailHandler":@EmailHandler "../Email/EmailHandler":@EmailHandler
"settings-sharelatex":@settings "settings-sharelatex":@settings
"../Notifications/NotificationsBuilder": @NotificationsBuilder "../Notifications/NotificationsBuilder": @NotificationsBuilder
"logger-sharelatex": "logger-sharelatex":
err:-> err:->
log:-> log:->
warn:-> warn:->
@@ -72,7 +79,7 @@ describe "SubscriptionGroupHandler", ->
beforeEach -> beforeEach ->
@LimitationsManager.hasGroupMembersLimitReached.callsArgWith(1, null, false, @subscription) @LimitationsManager.hasGroupMembersLimitReached.callsArgWith(1, null, false, @subscription)
@UserGetter.getUserByMainEmail.callsArgWith(1, null, @user) @UserGetter.getUserByMainEmail.callsArgWith(1, null, @user)
it "should find the user", (done)-> it "should find the user", (done)->
@Handler.addUserToGroup @adminUser_id, @newEmail, (err)=> @Handler.addUserToGroup @adminUser_id, @newEmail, (err)=>
@UserGetter.getUserByMainEmail.calledWith(@newEmail).should.equal true @UserGetter.getUserByMainEmail.calledWith(@newEmail).should.equal true
@@ -82,7 +89,7 @@ describe "SubscriptionGroupHandler", ->
@Handler.addUserToGroup @adminUser_id, @newEmail, (err)=> @Handler.addUserToGroup @adminUser_id, @newEmail, (err)=>
@SubscriptionUpdater.addUserToGroup.calledWith(@adminUser_id, @user._id).should.equal true @SubscriptionUpdater.addUserToGroup.calledWith(@adminUser_id, @user._id).should.equal true
done() done()
it "should not add the user to the group if the limit has been reached", (done)-> it "should not add the user to the group if the limit has been reached", (done)->
@LimitationsManager.hasGroupMembersLimitReached.callsArgWith(1, null, true, @subscription) @LimitationsManager.hasGroupMembersLimitReached.callsArgWith(1, null, true, @subscription)
@Handler.addUserToGroup @adminUser_id, @newEmail, (err)=> @Handler.addUserToGroup @adminUser_id, @newEmail, (err)=>
@@ -100,7 +107,7 @@ describe "SubscriptionGroupHandler", ->
@NotificationsBuilder.groupPlan.calledWith(@user, {subscription_id:@subscription._id}).should.equal true @NotificationsBuilder.groupPlan.calledWith(@user, {subscription_id:@subscription._id}).should.equal true
@readStub.called.should.equal true @readStub.called.should.equal true
done() done()
it "should add an email invite if no user is found", (done) -> it "should add an email invite if no user is found", (done) ->
@UserGetter.getUserByMainEmail.callsArgWith(1, null, null) @UserGetter.getUserByMainEmail.callsArgWith(1, null, null)
@Handler.addUserToGroup @adminUser_id, @newEmail, (err)=> @Handler.addUserToGroup @adminUser_id, @newEmail, (err)=>
@@ -114,6 +121,35 @@ describe "SubscriptionGroupHandler", ->
@SubscriptionUpdater.removeUserFromGroup.calledWith(@adminUser_id, @user._id).should.equal true @SubscriptionUpdater.removeUserFromGroup.calledWith(@adminUser_id, @user._id).should.equal true
done() done()
describe "replaceUserReferencesInGroups", ->
beforeEach ->
@oldId = "ba5eba11"
@newId = "5ca1ab1e"
it "replaces the admin_id", (done) ->
@Handler.replaceUserReferencesInGroups @oldId, @newId, (err) =>
@Subscription.update.calledWith(
{ admin_id: @oldId },
{ admin_id: @newId }
).should.equal true
done()
it "replaces the member ids", (done) ->
@Handler.replaceUserReferencesInGroups @oldId, @newId, (err) =>
@Subscription.update.calledWith(
{ member_ids: @oldId },
{ $addToSet: { member_ids: @newId } }
).should.equal true
@Subscription.update.calledWith(
{ member_ids: @oldId },
{ $pull: { member_ids: @oldId } }
).should.equal true
done()
describe "getPopulatedListOfMembers", -> describe "getPopulatedListOfMembers", ->
beforeEach -> beforeEach ->
@@ -145,7 +181,7 @@ describe "SubscriptionGroupHandler", ->
assert.deepEqual users[1], {_id:@subscription.member_ids[1]} assert.deepEqual users[1], {_id:@subscription.member_ids[1]}
assert.deepEqual users[2], {_id:@subscription.member_ids[2]} assert.deepEqual users[2], {_id:@subscription.member_ids[2]}
done() done()
it "should return any invited users", (done) -> it "should return any invited users", (done) ->
@subscription.invited_emails = ["jo@example.com", "charlie@example.com"] @subscription.invited_emails = ["jo@example.com", "charlie@example.com"]
@Handler.getPopulatedListOfMembers @adminUser_id, (err, users)=> @Handler.getPopulatedListOfMembers @adminUser_id, (err, users)=>
@@ -216,7 +252,7 @@ describe "SubscriptionGroupHandler", ->
@Handler.convertEmailInvitesToMemberships @email, @user_id, (err) => @Handler.convertEmailInvitesToMemberships @email, @user_id, (err) =>
@SubscriptionLocator.getGroupsWithEmailInvite.calledWith(@email).should.equal true @SubscriptionLocator.getGroupsWithEmailInvite.calledWith(@email).should.equal true
done() done()
it "should remove the email from each group", (done) -> it "should remove the email from each group", (done) ->
@Handler.convertEmailInvitesToMemberships @email, @user_id, (err) => @Handler.convertEmailInvitesToMemberships @email, @user_id, (err) =>
for group in @groups for group in @groups
@@ -224,7 +260,7 @@ describe "SubscriptionGroupHandler", ->
.calledWith(group.admin_id, @email) .calledWith(group.admin_id, @email)
.should.equal true .should.equal true
done() done()
it "should add the user to each group", (done) -> it "should add the user to each group", (done) ->
@Handler.convertEmailInvitesToMemberships @email, @user_id, (err) => @Handler.convertEmailInvitesToMemberships @email, @user_id, (err) =>
for group in @groups for group in @groups
@@ -232,4 +268,3 @@ describe "SubscriptionGroupHandler", ->
.calledWith(group.admin_id, @user_id) .calledWith(group.admin_id, @user_id)
.should.equal true .should.equal true
done() done()