initialize project history on creation

This commit is contained in:
Hayden Faulds 2017-10-24 11:48:21 +01:00
parent c437eb37d5
commit 670b183c8e
4 changed files with 138 additions and 29 deletions

View file

@ -4,6 +4,29 @@ settings = require "settings-sharelatex"
AuthenticationController = require "../Authentication/AuthenticationController" AuthenticationController = require "../Authentication/AuthenticationController"
module.exports = HistoryController = module.exports = HistoryController =
initializeProject: (callback = (error, history_id) ->) ->
return callback() if !settings.apis.project_history?.enabled
request.post {
url: "#{settings.apis.project_history.url}/project"
}, (error, res, body)->
return callback(error) if error?
if res.statusCode >= 200 and res.statusCode < 300
try
project = JSON.parse(body)
catch error
return callback(error)
overleaf_id = project?.project?.id
if !overleaf_id
error = new Error("project-history did not provide an id", project)
return callback(error)
callback null, { overleaf_id }
else
error = new Error("project-history returned a non-success status code: #{res.statusCode}")
callback error
proxyToHistoryApi: (req, res, next = (error) ->) -> proxyToHistoryApi: (req, res, next = (error) ->) ->
user_id = AuthenticationController.getLoggedInUserId req user_id = AuthenticationController.getLoggedInUserId req
url = HistoryController.buildHistoryServiceUrl() + req.url url = HistoryController.buildHistoryServiceUrl() + req.url

View file

@ -2,11 +2,12 @@ logger = require('logger-sharelatex')
async = require("async") async = require("async")
metrics = require('metrics-sharelatex') metrics = require('metrics-sharelatex')
Settings = require('settings-sharelatex') Settings = require('settings-sharelatex')
ObjectId = require('mongoose').Types.ObjectId ObjectId = require('mongoose').Types.ObjectId
Project = require('../../models/Project').Project Project = require('../../models/Project').Project
Folder = require('../../models/Folder').Folder Folder = require('../../models/Folder').Folder
ProjectEntityHandler = require('./ProjectEntityHandler') ProjectEntityHandler = require('./ProjectEntityHandler')
ProjectDetailsHandler = require('./ProjectDetailsHandler') ProjectDetailsHandler = require('./ProjectDetailsHandler')
HistoryController = require('../History/HistoryController')
User = require('../../models/User').User User = require('../../models/User').User
fs = require('fs') fs = require('fs')
Path = require "path" Path = require "path"
@ -19,18 +20,22 @@ module.exports = ProjectCreationHandler =
ProjectDetailsHandler.validateProjectName projectName, (error) -> ProjectDetailsHandler.validateProjectName projectName, (error) ->
return callback(error) if error? return callback(error) if error?
logger.log owner_id:owner_id, projectName:projectName, "creating blank project" logger.log owner_id:owner_id, projectName:projectName, "creating blank project"
rootFolder = new Folder {'name':'rootFolder'} HistoryController.initializeProject (error, history) ->
project = new Project return callback(error) if error?
owner_ref : new ObjectId(owner_id) rootFolder = new Folder {'name':'rootFolder'}
name : projectName project = new Project
if Settings.currentImageName? owner_ref : new ObjectId(owner_id)
project.imageName = Settings.currentImageName name : projectName
project.rootFolder[0] = rootFolder if history?.overleaf_id?
User.findById owner_id, "ace.spellCheckLanguage", (err, user)-> project.overleaf.id = history.overleaf_id
project.spellCheckLanguage = user.ace.spellCheckLanguage if Settings.currentImageName?
project.save (err)-> project.imageName = Settings.currentImageName
return callback(err) if err? project.rootFolder[0] = rootFolder
callback err, project User.findById owner_id, "ace.spellCheckLanguage", (err, user)->
project.spellCheckLanguage = user.ace.spellCheckLanguage
project.save (err)->
return callback(err) if err?
callback err, project
createBasicProject : (owner_id, projectName, callback = (error, project) ->)-> createBasicProject : (owner_id, projectName, callback = (error, project) ->)->
self = @ self = @

View file

@ -6,6 +6,7 @@ SandboxedModule = require('sandboxed-module')
describe "HistoryController", -> describe "HistoryController", ->
beforeEach -> beforeEach ->
@callback = sinon.stub()
@user_id = "user-id-123" @user_id = "user-id-123"
@AuthenticationController = @AuthenticationController =
getLoggedInUserId: sinon.stub().returns(@user_id) getLoggedInUserId: sinon.stub().returns(@user_id)
@ -14,18 +15,18 @@ describe "HistoryController", ->
"settings-sharelatex": @settings = {} "settings-sharelatex": @settings = {}
"logger-sharelatex": @logger = {log: sinon.stub(), error: sinon.stub()} "logger-sharelatex": @logger = {log: sinon.stub(), error: sinon.stub()}
"../Authentication/AuthenticationController": @AuthenticationController "../Authentication/AuthenticationController": @AuthenticationController
@settings.apis =
trackchanges:
enabled: false
url: "http://trackchanges.example.com"
project_history:
url: "http://project_history.example.com"
describe "proxyToHistoryApi", -> describe "proxyToHistoryApi", ->
beforeEach -> beforeEach ->
@req = { url: "/mock/url", method: "POST" } @req = { url: "/mock/url", method: "POST" }
@res = "mock-res" @res = "mock-res"
@next = sinon.stub() @next = sinon.stub()
@settings.apis =
trackchanges:
enabled: false
url: "http://trackchanges.example.com"
project_history:
url: "http://project_history.example.com"
@proxy = @proxy =
events: {} events: {}
pipe: sinon.stub() pipe: sinon.stub()
@ -80,3 +81,68 @@ describe "HistoryController", ->
it "should pass the error up the call chain", -> it "should pass the error up the call chain", ->
@next.calledWith(@error).should.equal true @next.calledWith(@error).should.equal true
describe "initializeProject", ->
describe "with project history enabled", ->
beforeEach ->
@settings.apis.project_history.enabled = true
describe "project history returns a successful response", ->
beforeEach ->
@overleaf_id = 1234
@res = statusCode: 200
@body = JSON.stringify(project: id: @overleaf_id)
@request.post = sinon.stub().callsArgWith(1, null, @res, @body)
@HistoryController.initializeProject @callback
it "should call the project history api", ->
@request.post.calledWith(
url: "#{@settings.apis.project_history.url}/project"
).should.equal true
it "should return the callback with the overleaf id", ->
@callback.calledWithExactly(null, { @overleaf_id }).should.equal true
describe "project history returns a response without the project id", ->
beforeEach ->
@res = statusCode: 200
@body = JSON.stringify(project: {})
@request.post = sinon.stub().callsArgWith(1, null, @res, @body)
@HistoryController.initializeProject @callback
it "should return the callback with an error", ->
@callback
.calledWith(sinon.match.has("message", "project-history did not provide an id"))
.should.equal true
describe "project history returns a unsuccessful response", ->
beforeEach ->
@res = statusCode: 404
@request.post = sinon.stub().callsArgWith(1, null, @res)
@HistoryController.initializeProject @callback
it "should return the callback with an error", ->
@callback
.calledWith(sinon.match.has("message", "project-history returned a non-success status code: 404"))
.should.equal true
describe "project history errors", ->
beforeEach ->
@error = sinon.stub()
@request.post = sinon.stub().callsArgWith(1, @error)
@HistoryController.initializeProject @callback
it "should return the callback with the error", ->
@callback.calledWithExactly(@error).should.equal true
describe "with project history disabled", ->
beforeEach ->
@settings.apis.project_history.enabled = false
@HistoryController.initializeProject @callback
it "should return the callback", ->
@callback.calledWithExactly().should.equal true

View file

@ -22,6 +22,7 @@ describe 'ProjectCreationHandler', ->
@._id = project_id @._id = project_id
@owner_ref = options.owner_ref @owner_ref = options.owner_ref
@name = options.name @name = options.name
@overleaf = {}
save: sinon.stub().callsArg(0) save: sinon.stub().callsArg(0)
rootFolder:[{ rootFolder:[{
_id: rootFolderId _id: rootFolderId
@ -36,11 +37,13 @@ describe 'ProjectCreationHandler', ->
setRootDoc: sinon.stub().callsArg(2) setRootDoc: sinon.stub().callsArg(2)
@ProjectDetailsHandler = @ProjectDetailsHandler =
validateProjectName: sinon.stub().yields() validateProjectName: sinon.stub().yields()
@HistoryController =
initializeProject: sinon.stub().callsArg(0)
@user = @user =
first_name:"first name here" first_name:"first name here"
last_name:"last name here" last_name:"last name here"
ace: ace:
spellCheckLanguage:"de" spellCheckLanguage:"de"
@User = findById:sinon.stub().callsArgWith(2, null, @user) @User = findById:sinon.stub().callsArgWith(2, null, @user)
@ -49,6 +52,7 @@ describe 'ProjectCreationHandler', ->
'../../models/User': User:@User '../../models/User': User:@User
'../../models/Project':{Project:@ProjectModel} '../../models/Project':{Project:@ProjectModel}
'../../models/Folder':{Folder:@FolderModel} '../../models/Folder':{Folder:@FolderModel}
'../History/HistoryController': @HistoryController
'./ProjectEntityHandler':@ProjectEntityHandler './ProjectEntityHandler':@ProjectEntityHandler
"./ProjectDetailsHandler":@ProjectDetailsHandler "./ProjectDetailsHandler":@ProjectDetailsHandler
"settings-sharelatex": @Settings = {} "settings-sharelatex": @Settings = {}
@ -68,24 +72,35 @@ describe 'ProjectCreationHandler', ->
@handler.createBlankProject ownerId, projectName, => @handler.createBlankProject ownerId, projectName, =>
@ProjectModel::save.called.should.equal true @ProjectModel::save.called.should.equal true
done() done()
it "should return the project in the callback", (done)-> it "should return the project in the callback", (done)->
@handler.createBlankProject ownerId, projectName, (err, project)-> @handler.createBlankProject ownerId, projectName, (err, project)->
project.name.should.equal projectName project.name.should.equal projectName
(project.owner_ref + "").should.equal ownerId (project.owner_ref + "").should.equal ownerId
done() done()
it "should initialize the project history", (done)->
@handler.createBlankProject ownerId, projectName, done
@HistoryController.initializeProject.calledWith().should.equal true
it "should set the overleaf id", (done)->
overleaf_id = 1234
@HistoryController.initializeProject = sinon.stub().callsArgWith(0, null, { overleaf_id })
@handler.createBlankProject ownerId, projectName, (err, project)->
project.overleaf.id.should.equal overleaf_id
done()
it "should set the language from the user", (done)-> it "should set the language from the user", (done)->
@handler.createBlankProject ownerId, projectName, (err, project)-> @handler.createBlankProject ownerId, projectName, (err, project)->
project.spellCheckLanguage.should.equal "de" project.spellCheckLanguage.should.equal "de"
done() done()
it "should set the imageName to currentImageName if set", (done) -> it "should set the imageName to currentImageName if set", (done) ->
@Settings.currentImageName = "mock-image-name" @Settings.currentImageName = "mock-image-name"
@handler.createBlankProject ownerId, projectName, (err, project)=> @handler.createBlankProject ownerId, projectName, (err, project)=>
project.imageName.should.equal @Settings.currentImageName project.imageName.should.equal @Settings.currentImageName
done() done()
it "should not set the imageName if no currentImageName", (done) -> it "should not set the imageName if no currentImageName", (done) ->
@Settings.currentImageName = null @Settings.currentImageName = null
@handler.createBlankProject ownerId, projectName, (err, project)=> @handler.createBlankProject ownerId, projectName, (err, project)=>
@ -96,21 +111,21 @@ describe 'ProjectCreationHandler', ->
beforeEach -> beforeEach ->
@ProjectModel::save = sinon.stub().callsArgWith(0, new Error("something went wrong")) @ProjectModel::save = sinon.stub().callsArgWith(0, new Error("something went wrong"))
@handler.createBlankProject ownerId, projectName, @callback @handler.createBlankProject ownerId, projectName, @callback
it 'should return the error to the callback', -> it 'should return the error to the callback', ->
should.exist @callback.args[0][0] should.exist @callback.args[0][0]
describe "with an invalid name", -> describe "with an invalid name", ->
beforeEach -> beforeEach ->
@ProjectDetailsHandler.validateProjectName = sinon.stub().yields(new Error("bad name")) @ProjectDetailsHandler.validateProjectName = sinon.stub().yields(new Error("bad name"))
@handler.createBlankProject ownerId, projectName, @callback @handler.createBlankProject ownerId, projectName, @callback
it 'should return the error to the callback', -> it 'should return the error to the callback', ->
should.exist @callback.args[0][0] should.exist @callback.args[0][0]
it 'should not try to create the project', -> it 'should not try to create the project', ->
@ProjectModel::save.called.should.equal false @ProjectModel::save.called.should.equal false
describe 'Creating a basic project', -> describe 'Creating a basic project', ->
beforeEach -> beforeEach ->