Merge pull request #750 from sharelatex/hof-labels

add v2 history labels endpoints

services/web/app/coffee/Features/History/HistoryController.coffee

@@ -21,6 +21,13 @@ module.exports = HistoryController =
 				req.useProjectHistory = false
 			next()
 
+	ensureProjectHistoryEnabled: (req, res, next = (error) ->) ->
+		if req.useProjectHistory?
+			next()
+		else
+			logger.log {project_id}, "project history not enabled"
+			res.sendStatus(404)
+
 	proxyToHistoryApi: (req, res, next = (error) ->) ->
 		user_id = AuthenticationController.getLoggedInUserId req
 		url = HistoryController.buildHistoryServiceUrl(req.useProjectHistory) + req.url
@@ -41,22 +48,17 @@ module.exports = HistoryController =
 		user_id = AuthenticationController.getLoggedInUserId req
 		url = HistoryController.buildHistoryServiceUrl(req.useProjectHistory) + req.url
 		logger.log url: url, "proxying to history api"
-		request {
+		HistoryController._makeRequest {
 			url: url
 			method: req.method
 			json: true
 			headers:
 				"X-User-Id": user_id
-		}, (error, response, body) ->
+		}, (error, body) ->
 			return next(error) if error?
-			if 200 <= response.statusCode < 300
-				HistoryManager.injectUserDetails body, (error, data) ->
-					return next(error) if error?
-					res.json data
-			else
-				error = new Error("history api responded with non-success code: #{response.statusCode}")
-				logger.error err: error, user_id: user_id, "error proxying request to history api"
-				next(error)
+			HistoryManager.injectUserDetails body, (error, data) ->
+				return next(error) if error?
+				res.json data
 
 	buildHistoryServiceUrl: (useProjectHistory) ->
 		# choose a history service, either document-level (trackchanges)
@@ -98,3 +100,46 @@ module.exports = HistoryController =
 				doc_id: doc._id
 			}
 
+	getLabels: (req, res, next) ->
+		project_id = req.params.Project_id
+		user_id = AuthenticationController.getLoggedInUserId(req)
+		HistoryController._makeRequest {
+			method: "GET"
+			url: "#{settings.apis.project_history.url}/project/#{project_id}/labels"
+			json: true
+		}, (error, labels) ->
+			return next(error) if error?
+			res.json labels
+
+	createLabel: (req, res, next) ->
+		project_id = req.params.Project_id
+		{comment, version} = req.body
+		user_id = AuthenticationController.getLoggedInUserId(req)
+		HistoryController._makeRequest {
+			method: "POST"
+			url: "#{settings.apis.project_history.url}/project/#{project_id}/user/#{user_id}/labels"
+			json: {comment, version}
+		}, (error, label) ->
+			return next(error) if error?
+			res.json label
+
+	deleteLabel: (req, res, next) ->
+		project_id = req.params.Project_id
+		label_id = req.params.label_id
+		user_id = AuthenticationController.getLoggedInUserId(req)
+		HistoryController._makeRequest {
+			method: "DELETE"
+			url: "#{settings.apis.project_history.url}/project/#{project_id}/user/#{user_id}/labels/#{label_id}"
+		}, (error) ->
+			return next(error) if error?
+			res.sendStatus 204
+
+	_makeRequest: (options, callback) ->
+		request options, (error, response, body) ->
+			return callback(error) if error?
+			if 200 <= response.statusCode < 300
+				callback(null, body)
+			else
+				error = new Error("history api responded with non-success code: #{response.statusCode}")
+				logger.error err: error, "project-history api responded with non-success code: #{response.statusCode}"
+				callback(error)

services/web/app/coffee/router.coffee

@@ -239,6 +239,10 @@ module.exports = class Router
 		webRouter.post "/project/:project_id/restore_file", AuthorizationMiddlewear.ensureUserCanWriteProjectContent, HistoryController.restoreFileFromV2
 		privateApiRouter.post "/project/:Project_id/history/resync", AuthenticationController.httpAuth, HistoryController.resyncProjectHistory
 
+		webRouter.get "/project/:Project_id/labels", AuthorizationMiddlewear.ensureUserCanReadProject, HistoryController.selectHistoryApi, HistoryController.ensureProjectHistoryEnabled, HistoryController.getLabels
+		webRouter.post "/project/:Project_id/labels", AuthorizationMiddlewear.ensureUserCanWriteProjectContent, HistoryController.selectHistoryApi, HistoryController.ensureProjectHistoryEnabled, HistoryController.createLabel
+		webRouter.delete "/project/:Project_id/labels/:label_id", AuthorizationMiddlewear.ensureUserCanWriteProjectContent, HistoryController.selectHistoryApi, HistoryController.ensureProjectHistoryEnabled, HistoryController.deleteLabel
+
 		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
 

services/web/test/acceptance/coffee/LabelsTests.coffee

@@ -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()

services/web/test/acceptance/coffee/helpers/MockProjectHistoryApi.coffee

@@ -1,5 +1,8 @@
-express = require("express")
+_ = require 'lodash'
+express = require 'express'
+bodyParser = require "body-parser"
 app = express()
+{ObjectId} = require 'mongojs'
 
 module.exports = MockProjectHistoryApi =
 	docs: {}
@@ -8,12 +11,30 @@ module.exports = MockProjectHistoryApi =
 
 	projectVersions: {}
 
+	labels: {}
+
 	addOldFile: (project_id, version, pathname, content) ->
 		@oldFiles["#{project_id}:#{version}:#{pathname}"] = content
 
 	setProjectVersion: (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: () ->
 		app.post "/project", (req, res, next) =>
 			res.json project: id: 1
@@ -33,11 +54,34 @@ module.exports = MockProjectHistoryApi =
 			else
 				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) ->
 			throw error if error?
 		.on "error", (error) ->
 			console.error "error starting MockProjectHistoryApi:", error.message
 			process.exit(1)
 
-
 MockProjectHistoryApi.run()