alois/Verso
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Refactor to existing addUserIdToProject function

Browse Source
This commit is contained in:
Shane Kilkelly
2016-08-02 13:51:00 +01:00
parent 63f8fe453a
commit abbd059eae
2 changed files with 71 additions and 181 deletions
Download Patch File Download Diff File Expand all files Collapse all files
services/web/app/coffee/Features/Collaborators/CollaboratorsInviteHandler.coffee
+17 -53
View File
@@ -1,9 +1,8 @@
Project = require("../../models/Project").Project
ProjectInvite = require("../../models/ProjectInvite").ProjectInvite ProjectInvite = require("../../models/ProjectInvite").ProjectInvite
mimelib = require("mimelib") mimelib = require("mimelib")
logger = require('logger-sharelatex') logger = require('logger-sharelatex')
ContactManager = require "../Contacts/ContactManager"
CollaboratorsEmailHandler = require "./CollaboratorsEmailHandler" CollaboratorsEmailHandler = require "./CollaboratorsEmailHandler"
CollaboratorsHandler = require "./CollaboratorsHandler"
Async = require "async" Async = require "async"
PrivilegeLevels = require "../Authorization/PrivilegeLevels" PrivilegeLevels = require "../Authorization/PrivilegeLevels"
Errors = require "../Errors/Errors" Errors = require "../Errors/Errors"
@@ -60,59 +59,24 @@ module.exports = CollaboratorsInviteHandler =
callback(null, invite) callback(null, invite)
acceptInvite: (projectId, inviteId, tokenString, user, callback=(err)->) -> acceptInvite: (projectId, inviteId, tokenString, user, callback=(err)->) ->
# fetch the target project logger.log {projectId, inviteId, userId: user._id}, "accepting invite"
Project.findOne {_id: projectId}, (err, project) -> CollaboratorsInviteHandler.getInviteByToken projectId, tokenString, (err, invite) ->
if err? if err?
logger.err {err, projectId}, "error finding project" logger.err {err, projectId, inviteId}, "error finding invite"
return callback(err) return callback(err)
if !project if !invite
err = new Errors.NotFoundError("no project found for invite") err = new Errors.NotFoundError("no matching invite found")
logger.log {err, projectId, inviteId}, "no project found" logger.log {err, projectId, inviteId, tokenString}, "no matching invite found"
return callback(err) return callback(err)
# fetch the invite inviteId = invite._id
ProjectInvite.findOne {_id: inviteId, projectId: projectId, token: tokenString}, (err, invite) -> CollaboratorsHandler.addUserIdToProject projectId, invite.sendingUserId, user._id, invite.privileges, (err) ->
if err? if err?
logger.err {err, projectId, inviteId}, "error finding invite" logger.err {err, projectId, inviteId, userId: user._id}, "error adding user to project"
return callback(err) return callback(err)
if !invite # Remove invite
err = new Errors.NotFoundError("no matching invite found") logger.log {projectId, inviteId}, "removing invite"
logger.log {err, projectId, inviteId, tokenString}, "no matching invite found" ProjectInvite.remove {_id: inviteId}, (err) ->
return callback(err) if err?
logger.err {err, projectId, inviteId}, "error removing invite"
# check if user is already a member of this project, return callback(err)
# return early if so callback()
existing_users = (project.collaberator_refs or [])
existing_users = existing_users.concat(project.readOnly_refs or [])
existing_users = existing_users.map (u) -> u.toString()
if existing_users.indexOf(user._id.toString()) > -1
logger.log {projectId, userId: user._id}, "user already member of project, returning"
return callback null
# build an update to be applied with $addToSet, user is added to either
# `collaberator_refs` or `readOnly_refs`
privilegeLevel = invite.privileges
if privilegeLevel == PrivilegeLevels.READ_AND_WRITE
level = {"collaberator_refs": user._id}
logger.log {privileges: privilegeLevel, user_id: user._id, projectId}, "adding user with read-write access"
else if privilegeLevel == PrivilegeLevels.READ_ONLY
level = {"readOnly_refs": user._id}
logger.log {privileges: privilegeLevel, user_id: user._id, projectId}, "adding user with read-only access"
else
return callback(new Error("unknown privilegeLevel: #{privilegeLevel}"))
ContactManager.addContact invite.sendingUserId, user._id
# Update the project, adding the new member.
Project.update { _id: project._id }, { $addToSet: level }, (error) ->
return callback(error) if error?
# Flush to TPDS in background to add files to collaborator's Dropbox
ProjectEntityHandler = require("../Project/ProjectEntityHandler")
ProjectEntityHandler.flushProjectToThirdPartyDataStore project._id, (error) ->
if error?
logger.error {err: error, project_id: project._id, user_id}, "error flushing to TPDS after adding collaborator"
# Remove invite
ProjectInvite.remove {_id: inviteId}, (err) ->
if err?
logger.err {err, projectId, inviteId}, "error removing invite"
return callback(err)
callback()
services/web/test/UnitTests/coffee/Collaborators/CollaboratorsInviteHandlerTests.coffee
+54 -128
View File
@@ -20,20 +20,13 @@ describe "CollaboratorsInviteHandler", ->
@findOne: sinon.stub() @findOne: sinon.stub()
@find: sinon.stub() @find: sinon.stub()
@remove: sinon.stub() @remove: sinon.stub()
@Project = class Project
constructor: () ->
this
@findOne: sinon.stub()
@update: sinon.stub()
@Crypto = Crypto @Crypto = Crypto
@CollaboratorsInviteHandler = SandboxedModule.require modulePath, requires: @CollaboratorsInviteHandler = SandboxedModule.require modulePath, requires:
'settings-sharelatex': @settings = {} 'settings-sharelatex': @settings = {}
'logger-sharelatex': @logger = {err: sinon.stub(), error: sinon.stub(), log: sinon.stub()} 'logger-sharelatex': @logger = {err: sinon.stub(), error: sinon.stub(), log: sinon.stub()}
'./CollaboratorsEmailHandler': @CollaboratorsEmailHandler = {} './CollaboratorsEmailHandler': @CollaboratorsEmailHandler = {}
'../Contacts/ContactManager': @ContactManager = {} "./CollaboratorsHandler": @CollaboratorsHandler = {addUserIdToProject: sinon.stub()}
'../../models/Project': {Project: @Project}
'../../models/ProjectInvite': {ProjectInvite: @ProjectInvite} '../../models/ProjectInvite': {ProjectInvite: @ProjectInvite}
"../Project/ProjectEntityHandler": @ProjectEntityHandler = {}
'crypto': @Crypto 'crypto': @Crypto
@projectId = ObjectId() @projectId = ObjectId()
@@ -249,15 +242,16 @@ describe "CollaboratorsInviteHandler", ->
_id: @projectId _id: @projectId
collaberator_refs: [] collaberator_refs: []
readOnly_refs: [] readOnly_refs: []
@Project.findOne.callsArgWith(1, null, @fakeProject) @CollaboratorsHandler.addUserIdToProject.callsArgWith(4, null)
@ProjectInvite.findOne.callsArgWith(1, null, @fakeInvite) @_getInviteByToken = sinon.stub(@CollaboratorsInviteHandler, 'getInviteByToken')
@ContactManager.addContact = sinon.stub() @_getInviteByToken.callsArgWith(2, null, @fakeInvite)
@Project.update.callsArgWith(2, null)
@ProjectEntityHandler.flushProjectToThirdPartyDataStore = sinon.stub().callsArgWith(1, null)
@ProjectInvite.remove.callsArgWith(1, null) @ProjectInvite.remove.callsArgWith(1, null)
@call = (callback) => @call = (callback) =>
@CollaboratorsInviteHandler.acceptInvite @projectId, @inviteId, @token, @user, callback @CollaboratorsInviteHandler.acceptInvite @projectId, @inviteId, @token, @user, callback
afterEach ->
@_getInviteByToken.restore()
describe 'when all goes well', -> describe 'when all goes well', ->
beforeEach -> beforeEach ->
@@ -268,34 +262,16 @@ describe "CollaboratorsInviteHandler", ->
expect(err).to.be.oneOf [null, undefined] expect(err).to.be.oneOf [null, undefined]
done() done()
it 'should have called Project.findOne', (done) -> it 'should have called getInviteByToken', (done) ->
@call (err) => @call (err) =>
@Project.findOne.callCount.should.equal 1 @_getInviteByToken.callCount.should.equal 1
@Project.findOne.calledWith({_id: @projectId}).should.equal true @_getInviteByToken.calledWith(@projectId, @token).should.equal true
done() done()
it 'should have called ProjectInvite.findOne', (done) -> it 'should have called CollaboratorsHandler.addUserIdToProject', (done) ->
@call (err) => @call (err) =>
@ProjectInvite.findOne.callCount.should.equal 1 @CollaboratorsHandler.addUserIdToProject.callCount.should.equal 1
@ProjectInvite.findOne.calledWith({_id: @inviteId, projectId: @projectId, token: @token}).should.equal true @CollaboratorsHandler.addUserIdToProject.calledWith(@projectId, @sendingUserId, @userId, @fakeInvite.privileges).should.equal true
done()
it 'should have called ContactManager.addContact', (done) ->
@call (err) =>
@ContactManager.addContact.callCount.should.equal 1
@ContactManager.addContact.calledWith(@sendingUserId, @userId).should.equal true
done()
it 'should have called Project.update, adding the user to collaberator_refs', (done) ->
@call (err) =>
@Project.update.callCount.should.equal 1
@Project.update.calledWith({_id: @projectId}, {$addToSet: {"collaberator_refs": @userId}}).should.equal true
done()
it 'should have called ProjectEntityHandler.flushProjectToThirdPartyDataStore', (done) ->
@call (err) =>
@ProjectEntityHandler.flushProjectToThirdPartyDataStore.callCount.should.equal 1
@ProjectEntityHandler.flushProjectToThirdPartyDataStore.calledWith(@projectId).should.equal true
done() done()
it 'should have called ProjectInvite.remove', (done) -> it 'should have called ProjectInvite.remove', (done) ->
@@ -308,7 +284,7 @@ describe "CollaboratorsInviteHandler", ->
beforeEach -> beforeEach ->
@fakeInvite.privileges = 'readOnly' @fakeInvite.privileges = 'readOnly'
@ProjectInvite.findOne.callsArgWith(1, null, @fakeInvite) @_getInviteByToken.callsArgWith(2, null, @fakeInvite)
it 'should not produce an error', (done) -> it 'should not produce an error', (done) ->
@call (err) => @call (err) =>
@@ -316,72 +292,16 @@ describe "CollaboratorsInviteHandler", ->
expect(err).to.be.oneOf [null, undefined] expect(err).to.be.oneOf [null, undefined]
done() done()
it 'should have called Project.update, adding the user to readOnly_refs', (done) -> it 'should have called CollaboratorsHandler.addUserIdToProject', (done) ->
@call (err) => @call (err) =>
@Project.update.callCount.should.equal 1 @CollaboratorsHandler.addUserIdToProject.callCount.should.equal 1
@Project.update.calledWith({_id: @projectId}, {$addToSet: {"readOnly_refs": @userId}}).should.equal true @CollaboratorsHandler.addUserIdToProject.calledWith(@projectId, @sendingUserId, @userId, @fakeInvite.privileges).should.equal true
done() done()
describe 'when the invite is for an unknown access level', -> describe 'when getInviteByToken does not find an invite', ->
beforeEach -> beforeEach ->
@fakeInvite.privileges = 'some_crazy_permission' @_getInviteByToken.callsArgWith(2, null, null)
@ProjectInvite.findOne.callsArgWith(1, null, @fakeInvite)
it 'should produce an error', (done) ->
@call (err) =>
expect(err).to.be.instanceof Error
done()
it 'should not have called Project.update', (done) ->
@call (err) =>
@Project.update.callCount.should.equal 0
done()
it 'should not have called ProjectInvite.remove', (done) ->
@call (err) =>
@ProjectInvite.remove.callCount.should.equal 0
done()
describe 'when user is already a member of project', ->
beforeEach ->
@fakeProject.collaberator_refs = [ObjectId(), @user._id, ObjectId(), ObjectId()]
@Project.findOne.callsArgWith(1, null, @fakeProject)
it 'should not produce an error', (done) ->
@call (err) =>
expect(err).to.not.be.instanceof Error
expect(err).to.be.oneOf [null, undefined]
done()
it 'should have called Project.findOne', (done) ->
@call (err) =>
@Project.findOne.callCount.should.equal 1
@Project.findOne.calledWith({_id: @projectId}).should.equal true
done()
it 'should have called ProjectInvite.findOne', (done) ->
@call (err) =>
@ProjectInvite.findOne.callCount.should.equal 1
@ProjectInvite.findOne.calledWith({_id: @inviteId, projectId: @projectId, token: @token}).should.equal true
done()
it 'should have returned early, not have called Project.update', (done) ->
@call (err) =>
@Project.update.callCount.should.equal 0
done()
it 'should not have called ProjectInvite.remove', (done) ->
@call (err) =>
@ProjectInvite.remove.callCount.should.equal 0
done()
describe 'when ProjectInvite.findOne does not find an invite', ->
beforeEach ->
@ProjectInvite.findOne.callsArgWith(1, null, null)
it 'should produce an error', (done) -> it 'should produce an error', (done) ->
@call (err) => @call (err) =>
@@ -389,9 +309,15 @@ describe "CollaboratorsInviteHandler", ->
expect(err.name).to.equal "NotFoundError" expect(err.name).to.equal "NotFoundError"
done() done()
it 'should not have called Project.update', (done) -> it 'should have called getInviteByToken', (done) ->
@call (err) => @call (err) =>
@Project.update.callCount.should.equal 0 @_getInviteByToken.callCount.should.equal 1
@_getInviteByToken.calledWith(@projectId, @token).should.equal true
done()
it 'should not have called CollaboratorsHandler.addUserIdToProject', (done) ->
@call (err) =>
@CollaboratorsHandler.addUserIdToProject.callCount.should.equal 0
done() done()
it 'should not have called ProjectInvite.remove', (done) -> it 'should not have called ProjectInvite.remove', (done) ->
@@ -399,19 +325,25 @@ describe "CollaboratorsInviteHandler", ->
@ProjectInvite.remove.callCount.should.equal 0 @ProjectInvite.remove.callCount.should.equal 0
done() done()
describe 'when Project.findOne produces an error', -> describe 'when getInviteByToken produces an error', ->
beforeEach -> beforeEach ->
@Project.findOne.callsArgWith(1, new Error('woops')) @_getInviteByToken.callsArgWith(2, new Error('woops'))
it 'should produce an error', (done) -> it 'should produce an error', (done) ->
@call (err) => @call (err) =>
expect(err).to.be.instanceof Error expect(err).to.be.instanceof Error
done() done()
it 'should not have called Project.update', (done) -> it 'should have called getInviteByToken', (done) ->
@call (err) => @call (err) =>
@Project.update.callCount.should.equal 0 @_getInviteByToken.callCount.should.equal 1
@_getInviteByToken.calledWith(@projectId, @token).should.equal true
done()
it 'should not have called CollaboratorsHandler.addUserIdToProject', (done) ->
@call (err) =>
@CollaboratorsHandler.addUserIdToProject.callCount.should.equal 0
done() done()
it 'should not have called ProjectInvite.remove', (done) -> it 'should not have called ProjectInvite.remove', (done) ->
@@ -419,39 +351,26 @@ describe "CollaboratorsInviteHandler", ->
@ProjectInvite.remove.callCount.should.equal 0 @ProjectInvite.remove.callCount.should.equal 0
done() done()
describe 'when ProjectInvite.findOne produces an error', -> describe 'when addUserIdToProject produces an error', ->
beforeEach -> beforeEach ->
@ProjectInvite.findOne.callsArgWith(1, new Error('woops')) @CollaboratorsHandler.addUserIdToProject.callsArgWith(4, new Error('woops'))
it 'should produce an error', (done) -> it 'should produce an error', (done) ->
@call (err) => @call (err) =>
expect(err).to.be.instanceof Error expect(err).to.be.instanceof Error
done() done()
it 'should not have called Project.update', (done) -> it 'should have called getInviteByToken', (done) ->
@call (err) => @call (err) =>
@Project.update.callCount.should.equal 0 @_getInviteByToken.callCount.should.equal 1
@_getInviteByToken.calledWith(@projectId, @token).should.equal true
done() done()
it 'should not have called ProjectInvite.remove', (done) -> it 'should have called CollaboratorsHandler.addUserIdToProject', (done) ->
@call (err) => @call (err) =>
@ProjectInvite.remove.callCount.should.equal 0 @CollaboratorsHandler.addUserIdToProject.callCount.should.equal 1
done() @CollaboratorsHandler.addUserIdToProject.calledWith(@projectId, @sendingUserId, @userId, @fakeInvite.privileges).should.equal true
describe 'when Project.update produces an error', ->
beforeEach ->
@Project.update.callsArgWith(2, new Error('woops'))
it 'should produce an error', (done) ->
@call (err) =>
expect(err).to.be.instanceof Error
done()
it 'should have called Project.update', (done) ->
@call (err) =>
@Project.update.callCount.should.equal 1
done() done()
it 'should not have called ProjectInvite.remove', (done) -> it 'should not have called ProjectInvite.remove', (done) ->
@@ -469,9 +388,16 @@ describe "CollaboratorsInviteHandler", ->
expect(err).to.be.instanceof Error expect(err).to.be.instanceof Error
done() done()
it 'should have called Project.update', (done) -> it 'should have called getInviteByToken', (done) ->
@call (err) => @call (err) =>
@Project.update.callCount.should.equal 1 @_getInviteByToken.callCount.should.equal 1
@_getInviteByToken.calledWith(@projectId, @token).should.equal true
done()
it 'should have called CollaboratorsHandler.addUserIdToProject', (done) ->
@call (err) =>
@CollaboratorsHandler.addUserIdToProject.callCount.should.equal 1
@CollaboratorsHandler.addUserIdToProject.calledWith(@projectId, @sendingUserId, @userId, @fakeInvite.privileges).should.equal true
done() done()
it 'should have called ProjectInvite.remove', (done) -> it 'should have called ProjectInvite.remove', (done) ->