Merge pull request #989 from sharelatex/bg-clean-up-broken-project-on-error

clean up broken project on error in ProjectDuplicator
This commit is contained in:
Brian Gough
2018-10-03 10:04:30 +01:00
committed by GitHub
2 changed files with 130 additions and 76 deletions
@@ -17,7 +17,7 @@ describe 'ProjectDuplicator', ->
_id:"level1folderId"
docs:[@doc1 = {_id: "doc1_id", name:"level1folderDocName"}]
folders:[@level2folder]
fileRefs:[{name:"file1", _id:"file1"}, null]
fileRefs:[{name:"file1", _id:"file1"}, null] # the null is intentional to test null docs/files
@rootFolder =
name:"rootFolder"
_id:"rootFolderId"
@@ -62,13 +62,17 @@ describe 'ProjectDuplicator', ->
findRootDoc : sinon.stub().callsArgWith(1, null, @foundRootDoc, {})
@projectOptionsHandler =
setCompiler : sinon.stub()
setCompiler : sinon.stub().callsArg(2)
@ProjectEntityUpdateHandler =
addDoc: sinon.stub().callsArgWith(5, null, {name:"somDoc"})
copyFileFromExistingProjectWithProject: sinon.stub().callsArgWith(5)
copyFileFromExistingProjectWithProject: sinon.stub()
setRootDoc: sinon.stub()
addFolder: sinon.stub().callsArgWith(3, null, @newFolder)
@ProjectEntityUpdateHandler.copyFileFromExistingProjectWithProject.withArgs(sinon.match.any, sinon.match.any, sinon.match.any, "BROKEN-FILE", sinon.match.any, sinon.match.any).callsArgWith(5, new Error("failed"))
@ProjectEntityUpdateHandler.copyFileFromExistingProjectWithProject.withArgs(sinon.match.any, sinon.match.any, sinon.match.any, sinon.match.object, sinon.match.any).callsArg(5)
@ProjectEntityUpdateHandler.copyFileFromExistingProjectWithProject.withArgs(sinon.match.any, sinon.match.any, sinon.match.any, null, sinon.match.any).callsArg(5)
@DocumentUpdaterHandler =
flushProjectToMongo: sinon.stub().callsArg(1)
@@ -81,84 +85,116 @@ describe 'ProjectDuplicator', ->
@ProjectGetter.getProject.withArgs(@old_project_id, sinon.match.any).callsArgWith(2, null, @project)
@ProjectGetter.getProject.withArgs(@new_project_id, sinon.match.any).callsArgWith(2, null, @stubbedNewProject)
@ProjectDeleter =
deleteProject: sinon.stub().callsArgWith(1,null)
@duplicator = SandboxedModule.require modulePath, requires:
'../../models/Project':{Project:@Project}
"../DocumentUpdater/DocumentUpdaterHandler": @DocumentUpdaterHandler
'./ProjectCreationHandler': @creationHandler
'./ProjectEntityUpdateHandler': @ProjectEntityUpdateHandler
'./ProjectLocator': @locator
'./ProjectDeleter': @ProjectDeleter
'./ProjectOptionsHandler': @projectOptionsHandler
"../Docstore/DocstoreManager": @DocstoreManager
"./ProjectGetter":@ProjectGetter
'logger-sharelatex':{log:->}
'logger-sharelatex':{
log:->
err:->
}
it "should look up the original project", (done) ->
newProjectName = "someProj"
@duplicator.duplicate @owner, @old_project_id, newProjectName, (err, newProject)=>
@ProjectGetter.getProject.calledWith(@old_project_id).should.equal true
done()
describe "when the copy succeeds", ->
it "should flush the original project to mongo", (done) ->
newProjectName = "someProj"
@duplicator.duplicate @owner, @old_project_id, newProjectName, (err, newProject)=>
@DocumentUpdaterHandler.flushProjectToMongo.calledWith(@old_project_id).should.equal true
done()
it "should look up the original project", (done) ->
newProjectName = "someProj"
@duplicator.duplicate @owner, @old_project_id, newProjectName, (err, newProject)=>
@ProjectGetter.getProject.calledWith(@old_project_id).should.equal true
done()
it 'should create a blank project', (done)->
newProjectName = "someProj"
@duplicator.duplicate @owner, @old_project_id, newProjectName, (err, newProject)=>
newProject._id.should.equal @stubbedNewProject._id
@creationHandler.createBlankProject.calledWith(@owner._id, newProjectName).should.equal true
done()
it "should flush the original project to mongo", (done) ->
newProjectName = "someProj"
@duplicator.duplicate @owner, @old_project_id, newProjectName, (err, newProject)=>
@DocumentUpdaterHandler.flushProjectToMongo.calledWith(@old_project_id).should.equal true
done()
it 'should use the same compiler', (done)->
@ProjectEntityUpdateHandler.addDoc.callsArgWith(5, null, @rootFolder.docs[0], @owner._id)
@duplicator.duplicate @owner, @old_project_id, "", (err, newProject)=>
@projectOptionsHandler.setCompiler.calledWith(@stubbedNewProject._id, @project.compiler).should.equal true
done()
it 'should use the same root doc', (done)->
@ProjectEntityUpdateHandler.addDoc.callsArgWith(5, null, @rootFolder.docs[0], @owner._id)
@duplicator.duplicate @owner, @old_project_id, "", (err, newProject)=>
@ProjectEntityUpdateHandler.setRootDoc.calledWith(@stubbedNewProject._id, @rootFolder.docs[0]._id).should.equal true
done()
it 'should create a blank project', (done)->
newProjectName = "someProj"
@duplicator.duplicate @owner, @old_project_id, newProjectName, (err, newProject)=>
newProject._id.should.equal @stubbedNewProject._id
@creationHandler.createBlankProject.calledWith(@owner._id, newProjectName).should.equal true
done()
it 'should not copy the collaberators or read only refs', (done)->
@duplicator.duplicate @owner, @old_project_id, "", (err, newProject)=>
newProject.collaberator_refs.length.should.equal 0
newProject.readOnly_refs.length.should.equal 0
done()
it 'should use the same compiler', (done)->
@ProjectEntityUpdateHandler.addDoc.callsArgWith(5, null, @rootFolder.docs[0], @owner._id)
@duplicator.duplicate @owner, @old_project_id, "", (err, newProject)=>
@projectOptionsHandler.setCompiler.calledWith(@stubbedNewProject._id, @project.compiler).should.equal true
done()
it 'should use the same root doc', (done)->
@ProjectEntityUpdateHandler.addDoc.callsArgWith(5, null, @rootFolder.docs[0], @owner._id)
@duplicator.duplicate @owner, @old_project_id, "", (err, newProject)=>
@ProjectEntityUpdateHandler.setRootDoc.calledWith(@stubbedNewProject._id, @rootFolder.docs[0]._id).should.equal true
done()
it 'should copy all the folders', (done)->
@duplicator.duplicate @owner, @old_project_id, "", (err, newProject)=>
@ProjectEntityUpdateHandler.addFolder.calledWith(@new_project_id, @stubbedNewProject.rootFolder[0]._id, @level1folder.name).should.equal true
@ProjectEntityUpdateHandler.addFolder.calledWith(@new_project_id, @newFolder._id, @level2folder.name).should.equal true
@ProjectEntityUpdateHandler.addFolder.callCount.should.equal 2
done()
it 'should not copy the collaberators or read only refs', (done)->
@duplicator.duplicate @owner, @old_project_id, "", (err, newProject)=>
newProject.collaberator_refs.length.should.equal 0
newProject.readOnly_refs.length.should.equal 0
done()
it 'should copy all the docs', (done)->
@duplicator.duplicate @owner, @old_project_id, "", (err, newProject)=>
@DocstoreManager.getAllDocs.calledWith(@old_project_id).should.equal true
@ProjectEntityUpdateHandler.addDoc
.calledWith(@new_project_id, @stubbedNewProject.rootFolder[0]._id, @doc0.name, @doc0_lines, @owner._id)
.should.equal true
@ProjectEntityUpdateHandler.addDoc
.calledWith(@new_project_id, @newFolder._id, @doc1.name, @doc1_lines, @owner._id)
.should.equal true
@ProjectEntityUpdateHandler.addDoc
.calledWith(@new_project_id, @newFolder._id, @doc2.name, @doc2_lines, @owner._id)
.should.equal true
done()
it 'should copy all the folders', (done)->
@duplicator.duplicate @owner, @old_project_id, "", (err, newProject)=>
@ProjectEntityUpdateHandler.addFolder.calledWith(@new_project_id, @stubbedNewProject.rootFolder[0]._id, @level1folder.name).should.equal true
@ProjectEntityUpdateHandler.addFolder.calledWith(@new_project_id, @newFolder._id, @level2folder.name).should.equal true
@ProjectEntityUpdateHandler.addFolder.callCount.should.equal 2
done()
it 'should copy all the files', (done)->
@duplicator.duplicate @owner, @old_project_id, "", (err, newProject)=>
@ProjectEntityUpdateHandler.copyFileFromExistingProjectWithProject
.calledWith(@stubbedNewProject, @stubbedNewProject.rootFolder[0]._id, @project._id, @rootFolder.fileRefs[0], @owner._id)
.should.equal true
@ProjectEntityUpdateHandler.copyFileFromExistingProjectWithProject
.calledWith(@stubbedNewProject, @newFolder._id, @project._id, @level1folder.fileRefs[0], @owner._id)
.should.equal true
@ProjectEntityUpdateHandler.copyFileFromExistingProjectWithProject
.calledWith(@stubbedNewProject, @newFolder._id, @project._id, @level2folder.fileRefs[0], @owner._id)
.should.equal true
done()
it 'should copy all the docs', (done)->
@duplicator.duplicate @owner, @old_project_id, "", (err, newProject)=>
@DocstoreManager.getAllDocs.calledWith(@old_project_id).should.equal true
@ProjectEntityUpdateHandler.addDoc
.calledWith(@new_project_id, @stubbedNewProject.rootFolder[0]._id, @doc0.name, @doc0_lines, @owner._id)
.should.equal true
@ProjectEntityUpdateHandler.addDoc
.calledWith(@new_project_id, @newFolder._id, @doc1.name, @doc1_lines, @owner._id)
.should.equal true
@ProjectEntityUpdateHandler.addDoc
.calledWith(@new_project_id, @newFolder._id, @doc2.name, @doc2_lines, @owner._id)
.should.equal true
done()
it 'should copy all the files', (done)->
@duplicator.duplicate @owner, @old_project_id, "", (err, newProject)=>
@ProjectEntityUpdateHandler.copyFileFromExistingProjectWithProject
.calledWith(@stubbedNewProject, @stubbedNewProject.rootFolder[0]._id, @project._id, @rootFolder.fileRefs[0], @owner._id)
.should.equal true
@ProjectEntityUpdateHandler.copyFileFromExistingProjectWithProject
.calledWith(@stubbedNewProject, @newFolder._id, @project._id, @level1folder.fileRefs[0], @owner._id)
.should.equal true
@ProjectEntityUpdateHandler.copyFileFromExistingProjectWithProject
.calledWith(@stubbedNewProject, @newFolder._id, @project._id, @level2folder.fileRefs[0], @owner._id)
.should.equal true
done()
describe 'when there is an error', ->
beforeEach ->
@rootFolder.fileRefs = [{name:"file0", _id:"file0"}, "BROKEN-FILE"]
it 'should delete the broken cloned project', (done) ->
@duplicator.duplicate @owner, @old_project_id, "", (err, newProject)=>
@ProjectDeleter.deleteProject
.calledWith(@stubbedNewProject._id)
.should.equal true
done()
it 'should not delete the original project', (done) ->
@duplicator.duplicate @owner, @old_project_id, "", (err, newProject)=>
@ProjectDeleter.deleteProject
.calledWith(@old_project_id)
.should.equal false
done()
it 'should return an error', (done) ->
@duplicator.duplicate @owner, @old_project_id, "", (err, newProject)=>
err.should.not.equal null
done()