mirror of
https://github.com/overleaf/overleaf.git
synced 2024-11-21 20:47:08 -05:00
add v2 history labels endpoints
This commit is contained in:
parent
1bb266c6dc
commit
04bb83f3de
4 changed files with 174 additions and 2 deletions
|
@ -21,6 +21,17 @@ module.exports = HistoryController =
|
||||||
req.useProjectHistory = false
|
req.useProjectHistory = false
|
||||||
next()
|
next()
|
||||||
|
|
||||||
|
ensureProjectHistoryEnabled: (req, res, next) ->
|
||||||
|
{project_id} = req.params
|
||||||
|
ProjectDetailsHandler.getDetails project_id, (err, project) ->
|
||||||
|
return next(err) if err?
|
||||||
|
historyEnabled = project.overleaf?.history?.id?
|
||||||
|
if historyEnabled
|
||||||
|
next()
|
||||||
|
else
|
||||||
|
logger.log {project_id}, "project history not enabled"
|
||||||
|
res.sendStatus(404)
|
||||||
|
|
||||||
proxyToHistoryApi: (req, res, next = (error) ->) ->
|
proxyToHistoryApi: (req, res, next = (error) ->) ->
|
||||||
user_id = AuthenticationController.getLoggedInUserId req
|
user_id = AuthenticationController.getLoggedInUserId req
|
||||||
url = HistoryController.buildHistoryServiceUrl(req.useProjectHistory) + req.url
|
url = HistoryController.buildHistoryServiceUrl(req.useProjectHistory) + req.url
|
||||||
|
@ -98,3 +109,48 @@ module.exports = HistoryController =
|
||||||
doc_id: doc._id
|
doc_id: doc._id
|
||||||
}
|
}
|
||||||
|
|
||||||
|
getLabels: (req, res, next) ->
|
||||||
|
{project_id} = req.params
|
||||||
|
user_id = AuthenticationController.getLoggedInUserId(req)
|
||||||
|
request.get {
|
||||||
|
url: "#{settings.apis.project_history.url}/project/#{project_id}/labels"
|
||||||
|
json: true
|
||||||
|
}, (error, response, body) ->
|
||||||
|
return next(error) if error?
|
||||||
|
if 200 <= response.statusCode < 300
|
||||||
|
res.json body
|
||||||
|
else
|
||||||
|
error = new Error("history api responded with non-success code: #{response.statusCode}")
|
||||||
|
logger.error err: error, user_id: user_id, "error getting labels from project-history"
|
||||||
|
next(error)
|
||||||
|
|
||||||
|
createLabel: (req, res, next) ->
|
||||||
|
{project_id} = req.params
|
||||||
|
{comment, version} = req.body
|
||||||
|
user_id = AuthenticationController.getLoggedInUserId(req)
|
||||||
|
request.post {
|
||||||
|
url: "#{settings.apis.project_history.url}/project/#{project_id}/user/#{user_id}/labels"
|
||||||
|
json: {comment, version}
|
||||||
|
}, (error, response, body) ->
|
||||||
|
return next(error) if error?
|
||||||
|
if 200 <= response.statusCode < 300
|
||||||
|
res.json body
|
||||||
|
else
|
||||||
|
error = new Error("history api responded with non-success code: #{response.statusCode}")
|
||||||
|
logger.error err: error, user_id: user_id, "error creating label in project-history"
|
||||||
|
next(error)
|
||||||
|
|
||||||
|
deleteLabel: (req, res, next) ->
|
||||||
|
{project_id, label_id} = req.params
|
||||||
|
user_id = AuthenticationController.getLoggedInUserId(req)
|
||||||
|
console.log "hof-debug DEL #{settings.apis.project_history.url}/project/#{project_id}/user/#{user_id}/labels/#{label_id}"
|
||||||
|
request.del {
|
||||||
|
url: "#{settings.apis.project_history.url}/project/#{project_id}/user/#{user_id}/labels/#{label_id}"
|
||||||
|
}, (error, response, body) ->
|
||||||
|
return next(error) if error?
|
||||||
|
if 200 <= response.statusCode < 300
|
||||||
|
res.sendStatus 204
|
||||||
|
else
|
||||||
|
error = new Error("history api responded with non-success code: #{response.statusCode}")
|
||||||
|
logger.error err: error, user_id: user_id, "error deleting label in project-history"
|
||||||
|
next(error)
|
||||||
|
|
|
@ -239,6 +239,10 @@ module.exports = class Router
|
||||||
webRouter.post "/project/:project_id/restore_file", AuthorizationMiddlewear.ensureUserCanWriteProjectContent, HistoryController.restoreFileFromV2
|
webRouter.post "/project/:project_id/restore_file", AuthorizationMiddlewear.ensureUserCanWriteProjectContent, HistoryController.restoreFileFromV2
|
||||||
privateApiRouter.post "/project/:Project_id/history/resync", AuthenticationController.httpAuth, HistoryController.resyncProjectHistory
|
privateApiRouter.post "/project/:Project_id/history/resync", AuthenticationController.httpAuth, HistoryController.resyncProjectHistory
|
||||||
|
|
||||||
|
webRouter.get "/project/:project_id/labels", AuthorizationMiddlewear.ensureUserCanReadProject, HistoryController.ensureProjectHistoryEnabled, HistoryController.getLabels
|
||||||
|
webRouter.post "/project/:project_id/labels", AuthorizationMiddlewear.ensureUserCanWriteProjectContent, HistoryController.ensureProjectHistoryEnabled, HistoryController.createLabel
|
||||||
|
webRouter.delete "/project/:project_id/labels/:label_id", AuthorizationMiddlewear.ensureUserCanWriteProjectContent, HistoryController.ensureProjectHistoryEnabled, HistoryController.deleteLabel
|
||||||
|
|
||||||
webRouter.post '/project/:project_id/export/:brand_variation_id', AuthorizationMiddlewear.ensureUserCanAdminProject, ExportsController.exportProject
|
webRouter.post '/project/:project_id/export/:brand_variation_id', AuthorizationMiddlewear.ensureUserCanAdminProject, ExportsController.exportProject
|
||||||
webRouter.get '/project/:project_id/export/:export_id', AuthorizationMiddlewear.ensureUserCanAdminProject, ExportsController.exportStatus
|
webRouter.get '/project/:project_id/export/:export_id', AuthorizationMiddlewear.ensureUserCanAdminProject, ExportsController.exportStatus
|
||||||
|
|
||||||
|
|
68
services/web/test/acceptance/coffee/LabelsTests.coffee
Normal file
68
services/web/test/acceptance/coffee/LabelsTests.coffee
Normal file
|
@ -0,0 +1,68 @@
|
||||||
|
_ = require 'underscore'
|
||||||
|
{expect} = require 'chai'
|
||||||
|
{ObjectId} = require 'mongojs'
|
||||||
|
request = require './helpers/request'
|
||||||
|
|
||||||
|
MockProjectHistoryApi = require './helpers/MockProjectHistoryApi'
|
||||||
|
User = require './helpers/User'
|
||||||
|
|
||||||
|
describe 'Labels', ->
|
||||||
|
beforeEach (done) ->
|
||||||
|
@owner = new User()
|
||||||
|
@owner.login (error) =>
|
||||||
|
throw error if error?
|
||||||
|
@owner.createProject 'example-project', {template: 'example'}, (error, @project_id) =>
|
||||||
|
throw error if error?
|
||||||
|
done()
|
||||||
|
|
||||||
|
afterEach ->
|
||||||
|
MockProjectHistoryApi.reset()
|
||||||
|
|
||||||
|
it 'getting labels', (done) ->
|
||||||
|
label_id = new ObjectId().toString()
|
||||||
|
comment = 'a label comment'
|
||||||
|
version = 3
|
||||||
|
MockProjectHistoryApi.addLabel @project_id, label_id, comment, version
|
||||||
|
|
||||||
|
@owner.request {
|
||||||
|
method: 'GET'
|
||||||
|
url: "/project/#{@project_id}/labels"
|
||||||
|
json: true
|
||||||
|
}, (error, response, body) =>
|
||||||
|
throw error if error?
|
||||||
|
expect(response.statusCode).to.equal 200
|
||||||
|
expect(body).to.deep.equal [{ label_id, comment, version }]
|
||||||
|
done()
|
||||||
|
|
||||||
|
it 'creating a label', (done) ->
|
||||||
|
comment = 'a label comment'
|
||||||
|
version = 3
|
||||||
|
|
||||||
|
@owner.request {
|
||||||
|
method: 'POST'
|
||||||
|
url: "/project/#{@project_id}/labels"
|
||||||
|
json: {comment, version}
|
||||||
|
}, (error, response, body) =>
|
||||||
|
throw error if error?
|
||||||
|
expect(response.statusCode).to.equal 200
|
||||||
|
{label_id} = body
|
||||||
|
expect(
|
||||||
|
MockProjectHistoryApi.getLabels(@project_id)
|
||||||
|
).to.deep.equal [{label_id, comment, version} ]
|
||||||
|
done()
|
||||||
|
|
||||||
|
it 'deleting a label', (done) ->
|
||||||
|
label_id = new ObjectId().toString()
|
||||||
|
comment = 'a label comment'
|
||||||
|
version = 3
|
||||||
|
MockProjectHistoryApi.addLabel @project_id, label_id, comment, version
|
||||||
|
|
||||||
|
@owner.request {
|
||||||
|
method: 'DELETE'
|
||||||
|
url: "/project/#{@project_id}/labels/#{label_id}"
|
||||||
|
json: true
|
||||||
|
}, (error, response, body) =>
|
||||||
|
throw error if error?
|
||||||
|
expect(response.statusCode).to.equal 204
|
||||||
|
expect(MockProjectHistoryApi.getLabels(@project_id)).to.deep.equal []
|
||||||
|
done()
|
|
@ -1,5 +1,8 @@
|
||||||
express = require("express")
|
_ = require 'lodash'
|
||||||
|
express = require 'express'
|
||||||
|
bodyParser = require "body-parser"
|
||||||
app = express()
|
app = express()
|
||||||
|
{ObjectId} = require 'mongojs'
|
||||||
|
|
||||||
module.exports = MockProjectHistoryApi =
|
module.exports = MockProjectHistoryApi =
|
||||||
docs: {}
|
docs: {}
|
||||||
|
@ -8,12 +11,30 @@ module.exports = MockProjectHistoryApi =
|
||||||
|
|
||||||
projectVersions: {}
|
projectVersions: {}
|
||||||
|
|
||||||
|
labels: {}
|
||||||
|
|
||||||
addOldFile: (project_id, version, pathname, content) ->
|
addOldFile: (project_id, version, pathname, content) ->
|
||||||
@oldFiles["#{project_id}:#{version}:#{pathname}"] = content
|
@oldFiles["#{project_id}:#{version}:#{pathname}"] = content
|
||||||
|
|
||||||
setProjectVersion: (project_id, version) ->
|
setProjectVersion: (project_id, version) ->
|
||||||
@projectVersions[project_id] = version
|
@projectVersions[project_id] = version
|
||||||
|
|
||||||
|
addLabel: (project_id, label_id, comment, version) ->
|
||||||
|
@labels[project_id] ?= {}
|
||||||
|
@labels[project_id][label_id] = {label_id,comment,version}
|
||||||
|
|
||||||
|
deleteLabel: (project_id, label_id) ->
|
||||||
|
delete @labels[project_id][label_id]
|
||||||
|
|
||||||
|
getLabels: (project_id) ->
|
||||||
|
return null unless @labels[project_id]?
|
||||||
|
_.values @labels[project_id]
|
||||||
|
|
||||||
|
reset: () ->
|
||||||
|
@oldFiles = {}
|
||||||
|
@projectVersions = {}
|
||||||
|
@labels = {}
|
||||||
|
|
||||||
run: () ->
|
run: () ->
|
||||||
app.post "/project", (req, res, next) =>
|
app.post "/project", (req, res, next) =>
|
||||||
res.json project: id: 1
|
res.json project: id: 1
|
||||||
|
@ -33,11 +54,34 @@ module.exports = MockProjectHistoryApi =
|
||||||
else
|
else
|
||||||
res.send 404
|
res.send 404
|
||||||
|
|
||||||
|
app.get "/project/:project_id/labels", (req, res, next) =>
|
||||||
|
{project_id} = req.params
|
||||||
|
labels = @getLabels project_id
|
||||||
|
if labels?
|
||||||
|
res.json labels
|
||||||
|
else
|
||||||
|
res.send 404
|
||||||
|
|
||||||
|
app.post "/project/:project_id/user/:user_id/labels", bodyParser.json(), (req, res, next) =>
|
||||||
|
{project_id} = req.params
|
||||||
|
{comment, version} = req.body
|
||||||
|
label_id = new ObjectId().toString()
|
||||||
|
@addLabel project_id, label_id, comment, version
|
||||||
|
res.json {label_id, comment, version}
|
||||||
|
|
||||||
|
app.delete "/project/:project_id/user/:user_id/labels/:label_id", (req, res, next) =>
|
||||||
|
{project_id, label_id} = req.params
|
||||||
|
label = @labels[project_id]?[label_id]
|
||||||
|
if label?
|
||||||
|
@deleteLabel project_id, label_id
|
||||||
|
res.send 204
|
||||||
|
else
|
||||||
|
res.send 404
|
||||||
|
|
||||||
app.listen 3054, (error) ->
|
app.listen 3054, (error) ->
|
||||||
throw error if error?
|
throw error if error?
|
||||||
.on "error", (error) ->
|
.on "error", (error) ->
|
||||||
console.error "error starting MockProjectHistoryApi:", error.message
|
console.error "error starting MockProjectHistoryApi:", error.message
|
||||||
process.exit(1)
|
process.exit(1)
|
||||||
|
|
||||||
|
|
||||||
MockProjectHistoryApi.run()
|
MockProjectHistoryApi.run()
|
||||||
|
|
Loading…
Reference in a new issue