Overleaf/services/web/test/unit/coffee/DocumentUpdater/DocumentUpdaterHandlerTests.coffee

should = require('chai').should()
spies = require('chai-spies')
chai = require('chai').use(spies)
sinon = require("sinon")
SandboxedModule = require('sandboxed-module')
assert = require('chai').assert
path = require 'path'
_ = require 'underscore'
ObjectId = require("mongojs").ObjectId;
modulePath = path.join __dirname, '../../../../app/js/Features/DocumentUpdater/DocumentUpdaterHandler'

describe 'DocumentUpdaterHandler', ->
	beforeEach ->
		@project_id = "project-id-923"
		@projectHistoryId = "ol-project-id-1"
		@doc_id = "doc-id-394"
		@lines = ["one", "two", "three"]
		@version = 42
		@user_id = "mock-user-id-123"
		@project =
			_id: @project_id

		@request = sinon.stub()
		@projectEntityHandler = {}
		@settings =
			apis:
				documentupdater:
					url : "http://document_updater.example.com"
				project_history:
					url: "http://project_history.example.com"

		@callback = sinon.stub()
		@handler = SandboxedModule.require modulePath, requires:
			'request': defaults:=> return @request
			'settings-sharelatex':@settings
			'logger-sharelatex':{log:(->), error:(->)}
			'../Project/ProjectEntityHandler':@projectEntityHandler
			"../../models/Project": Project: @Project={}
			'../../Features/Project/ProjectLocator':{}
			"metrics-sharelatex":
				Timer:->
					done:->

	describe 'flushProjectToMongo', ->
		describe "successfully", ->
			beforeEach ->
				@request.callsArgWith(1, null, {statusCode: 204}, "")
				@handler.flushProjectToMongo @project_id, @callback

			it 'should flush the document from the document updater', ->
				@request.calledWithMatch(
					url: "#{@settings.apis.documentupdater.url}/project/#{@project_id}/flush"
					method: "POST"
				).should.equal true

			it "should call the callback with no error", ->
				@callback.calledWith(null).should.equal true

		describe "when the document updater API returns an error", ->
			beforeEach ->
				@request.callsArgWith(1, @error = new Error("something went wrong"), null, null)
				@handler.flushProjectToMongo @project_id, @callback

			it "should return an error to the callback", ->
				@callback.calledWith(@error).should.equal true

		describe "when the document updater returns a failure error code", ->
			beforeEach ->
				@request.callsArgWith(1, null, { statusCode: 500 }, "")
				@handler.flushProjectToMongo @project_id, @callback

			it "should return the callback with an error", ->
				@callback
					.calledWith(new Error("doc updater returned failure status code: 500"))
					.should.equal true

	describe 'flushProjectToMongoAndDelete', ->
		describe "successfully", ->
			beforeEach ->
				@request.callsArgWith(1, null, {statusCode: 204}, "")
				@handler.flushProjectToMongoAndDelete @project_id, @callback

			it 'should delete the project from the document updater', ->
				@request.calledWithMatch(
					url: "#{@settings.apis.documentupdater.url}/project/#{@project_id}"
					method: "DELETE"
				).should.equal true

			it "should call the callback with no error", ->
				@callback.calledWith(null).should.equal true

		describe "when the document updater API returns an error", ->
			beforeEach ->
				@request.callsArgWith(1, @error = new Error("something went wrong"), null, null)
				@handler.flushProjectToMongoAndDelete @project_id, @callback

			it "should return an error to the callback", ->
				@callback.calledWith(@error).should.equal true

		describe "when the document updater returns a failure error code", ->
			beforeEach ->
				@request.callsArgWith(1, null, { statusCode: 500 }, "")
				@handler.flushProjectToMongoAndDelete @project_id, @callback

			it "should return the callback with an error", ->
				@callback
					.calledWith(new Error("doc updater returned failure status code: 500"))
					.should.equal true

	describe 'flushDocToMongo', ->
		describe "successfully", ->
			beforeEach ->
				@request.callsArgWith(1, null, {statusCode: 204}, "")
				@handler.flushDocToMongo @project_id, @doc_id, @callback

			it 'should flush the document from the document updater', ->
				@request.calledWithMatch(
					url: "#{@settings.apis.documentupdater.url}/project/#{@project_id}/doc/#{@doc_id}/flush"
					method: "POST"
				).should.equal true

			it "should call the callback with no error", ->
				@callback.calledWith(null).should.equal true

		describe "when the document updater API returns an error", ->
			beforeEach ->
				@request.callsArgWith(1, @error = new Error("something went wrong"), null, null)
				@handler.flushDocToMongo @project_id, @doc_id, @callback

			it "should return an error to the callback", ->
				@callback.calledWith(@error).should.equal true

		describe "when the document updater returns a failure error code", ->
			beforeEach ->
				@request.callsArgWith(1, null, { statusCode: 500 }, "")
				@handler.flushDocToMongo @project_id, @doc_id, @callback

			it "should return the callback with an error", ->
				@callback
					.calledWith(new Error("doc updater returned failure status code: 500"))
					.should.equal true

	describe "deleteDoc", ->
		describe "successfully", ->
			beforeEach ->
				@request.callsArgWith(1, null, {statusCode: 204}, "")
				@handler.deleteDoc @project_id, @doc_id, @callback

			it 'should delete the document from the document updater', ->
				@request.calledWithMatch(
					url: "#{@settings.apis.documentupdater.url}/project/#{@project_id}/doc/#{@doc_id}"
					method: "DELETE"
				).should.equal true

			it "should call the callback with no error", ->
				@callback.calledWith(null).should.equal true

		describe "when the document updater API returns an error", ->
			beforeEach ->
				@request.callsArgWith(1, @error = new Error("something went wrong"), null, null)
				@handler.deleteDoc @project_id, @doc_id, @callback

			it "should return an error to the callback", ->
				@callback.calledWith(@error).should.equal true

		describe "when the document updater returns a failure error code", ->
			beforeEach ->
				@request.callsArgWith(1, null, { statusCode: 500 }, "")
				@handler.deleteDoc @project_id, @doc_id, @callback

			it "should return the callback with an error", ->
				@callback
					.calledWith(new Error("doc updater returned failure status code: 500"))
					.should.equal true

	describe "setDocument", ->
		beforeEach ->
			@source = "dropbox"

		describe "successfully", ->
			beforeEach ->
				@request.callsArgWith(1, null, {statusCode: 204}, "")
				@handler.setDocument @project_id, @doc_id, @user_id, @lines, @source, @callback

			it 'should set the document in the document updater', ->
				@request.calledWith(
					url: "#{@settings.apis.documentupdater.url}/project/#{@project_id}/doc/#{@doc_id}"
					json:
						lines: @lines
						source: @source
						user_id: @user_id
					method: "POST"
				).should.equal true

			it "should call the callback with no error", ->
				@callback.calledWith(null).should.equal true

		describe "when the document updater API returns an error", ->
			beforeEach ->
				@request.callsArgWith(1, @error = new Error("something went wrong"), null, null)
				@handler.setDocument @project_id, @doc_id, @user_id, @lines, @source, @callback

			it "should return an error to the callback", ->
				@callback.calledWith(@error).should.equal true

		describe "when the document updater returns a failure error code", ->
			beforeEach ->
				@request.callsArgWith(1, null, { statusCode: 500 }, "")
				@handler.setDocument @project_id, @doc_id, @user_id, @lines, @source, @callback

			it "should return the callback with an error", ->
				@callback
					.calledWith(new Error("doc updater returned failure status code: 500"))
					.should.equal true

	describe "getDocument", ->
		describe "successfully", ->
			beforeEach ->
				@body =
					lines: @lines
					version: @version
					ops: @ops = ["mock-op-1", "mock-op-2"]
					ranges: @ranges = {"mock":"ranges"}
				@fromVersion = 2
				@request.callsArgWith(1, null, {statusCode: 200}, @body)
				@handler.getDocument @project_id, @doc_id, @fromVersion, @callback

			it 'should get the document from the document updater', ->
				@request.calledWith(
					url: "#{@settings.apis.documentupdater.url}/project/#{@project_id}/doc/#{@doc_id}?fromVersion=#{@fromVersion}"
					method: "GET"
					json: true
				).should.equal true

			it "should call the callback with the lines and version", ->
				@callback.calledWith(null, @lines, @version, @ranges, @ops).should.equal true

		describe "when the document updater API returns an error", ->
			beforeEach ->
				@request.callsArgWith(1, @error = new Error("something went wrong"), null, null)
				@handler.getDocument @project_id, @doc_id, @fromVersion, @callback

			it "should return an error to the callback", ->
				@callback.calledWith(@error).should.equal true

		describe "when the document updater returns a failure error code", ->
			beforeEach ->
				@request.callsArgWith(1, null, { statusCode: 500 }, "")
				@handler.getDocument @project_id, @doc_id, @fromVersion, @callback

			it "should return the callback with an error", ->
				@callback
					.calledWith(new Error("doc updater returned failure status code: 500"))
					.should.equal true

	describe "getProjectDocsIfMatch", ->
		beforeEach ->
			@project_state_hash = "1234567890abcdef"

		describe "successfully", ->
			beforeEach ->
				@doc0 =
					_id: @doc_id
					lines: @lines
					v: @version
				@docs = [ @doc0, @doc0, @doc0 ]
				@body = JSON.stringify @docs
				@request.post = sinon.stub().callsArgWith(1, null, {statusCode: 200}, @body)
				@handler.getProjectDocsIfMatch @project_id, @project_state_hash, @callback

			it 'should get the documents from the document updater', ->
				url = "#{@settings.apis.documentupdater.url}/project/#{@project_id}/get_and_flush_if_old?state=#{@project_state_hash}"
				@request.post.calledWith(url).should.equal true

			it "should call the callback with the documents", ->
				@callback.calledWithExactly(null, @docs).should.equal true

		describe "when the document updater API returns an error", ->
			beforeEach ->
				@request.post = sinon.stub().callsArgWith(1, @error = new Error("something went wrong"), null, null)
				@handler.getProjectDocsIfMatch @project_id, @project_state_hash, @callback

			it "should return an error to the callback", ->
				@callback.calledWith(@error).should.equal true

		describe "when the document updater returns a conflict error code", ->
			beforeEach ->
				@request.post = sinon.stub().callsArgWith(1, null, { statusCode: 409 }, "Conflict")
				@handler.getProjectDocsIfMatch @project_id, @project_state_hash, @callback

			it "should return the callback with no documents", ->
				@callback
					.alwaysCalledWithExactly()
					.should.equal true

	describe "clearProjectState", ->
		describe "successfully", ->
			beforeEach ->
				@request.callsArgWith(1, null, {statusCode: 200})
				@handler.clearProjectState @project_id, @callback

			it 'should clear the project state from the document updater', ->
				@request.calledWithMatch(
					url: "#{@settings.apis.documentupdater.url}/project/#{@project_id}/clearState"
					method: "POST"
				).should.equal true

			it "should call the callback", ->
				@callback.calledWith(null).should.equal true

		describe "when the document updater API returns an error", ->
			beforeEach ->
				@request.callsArgWith(1, @error = new Error("something went wrong"), null, null)
				@handler.clearProjectState @project_id, @callback

			it "should return an error to the callback", ->
				@callback.calledWith(@error).should.equal true

		describe "when the document updater returns an error code", ->
			beforeEach ->
				@request.callsArgWith(1, null, { statusCode: 500 }, null)
				@handler.clearProjectState @project_id, @callback

			it "should return the callback with no documents", ->
				@callback
					.calledWith(new Error("doc updater returned failure status code: 500"))
					.should.equal true


	describe "acceptChanges", ->
		beforeEach ->
			@change_id = "mock-change-id-1"

		describe "successfully", ->
			beforeEach ->
				@request.callsArgWith(1, null, {statusCode: 200}, @body)
				@handler.acceptChanges @project_id, @doc_id, [ @change_id ], @callback

			it 'should accept the change in the document updater', ->
				@request.calledWith(
					url: "#{@settings.apis.documentupdater.url}/project/#{@project_id}/doc/#{@doc_id}/change/accept"
					json:
						change_ids: [ @change_id ]
					method: "POST"
				).should.equal true

			it "should call the callback", ->
				@callback.calledWith(null).should.equal true

		describe "when the document updater API returns an error", ->
			beforeEach ->
				@request.callsArgWith(1, @error = new Error("something went wrong"), null, null)
				@handler.acceptChanges @project_id, @doc_id, [ @change_id ], @callback

			it "should return an error to the callback", ->
				@callback.calledWith(@error).should.equal true

		describe "when the document updater returns a failure error code", ->
			beforeEach ->
				@request.callsArgWith(1, null, { statusCode: 500 }, "")
				@handler.acceptChanges @project_id, @doc_id, [ @change_id ], @callback

			it "should return the callback with an error", ->
				@callback
					.calledWith(new Error("doc updater returned failure status code: 500"))
					.should.equal true

	describe "deleteThread", ->
		beforeEach ->
			@thread_id = "mock-thread-id-1"

		describe "successfully", ->
			beforeEach ->
				@request.callsArgWith(1, null, {statusCode: 200}, @body)
				@handler.deleteThread @project_id, @doc_id, @thread_id, @callback

			it 'should delete the thread in the document updater', ->
				@request.calledWithMatch(
					url: "#{@settings.apis.documentupdater.url}/project/#{@project_id}/doc/#{@doc_id}/comment/#{@thread_id}"
					method: "DELETE"
				).should.equal true

			it "should call the callback", ->
				@callback.calledWith(null).should.equal true

		describe "when the document updater API returns an error", ->
			beforeEach ->
				@request.callsArgWith(1, @error = new Error("something went wrong"), null, null)
				@handler.deleteThread @project_id, @doc_id, @thread_id, @callback

			it "should return an error to the callback", ->
				@callback.calledWith(@error).should.equal true

		describe "when the document updater returns a failure error code", ->
			beforeEach ->
				@request.callsArgWith(1, null, { statusCode: 500 }, "")
				@handler.deleteThread @project_id, @doc_id, @thread_id, @callback

			it "should return the callback with an error", ->
				@callback
					.calledWith(new Error("doc updater returned failure status code: 500"))
					.should.equal true

	describe "updateProjectStructure ", ->
		beforeEach ->
			@user_id = 1234
			@version = 999
			@Project.findOne = sinon.stub().callsArgWith(2,null, {_id: @project_id, version:@version})

		describe "with project history disabled", ->
			beforeEach ->
				@settings.apis.project_history.sendProjectStructureOps = false
				@handler.updateProjectStructure @project_id, @projectHistoryId, @user_id, {}, @callback

			it 'does not make a web request', ->
				@request.called.should.equal false

			it 'calls the callback', ->
				@callback.called.should.equal true

		describe "with project history enabled", ->
			beforeEach ->
				@settings.apis.project_history.sendProjectStructureOps = true
				@url = "#{@settings.apis.documentupdater.url}/project/#{@project_id}"
				@request.callsArgWith(1, null, {statusCode: 204}, "")

			describe "when an entity has changed name", ->
				it 'should send the structure update to the document updater', (done) ->
					@docIdA = new ObjectId()
					@docIdB = new ObjectId()
					@changes = {
						oldDocs: [
							{ path: '/old_a', doc: _id: @docIdA }
							{ path: '/old_b', doc: _id: @docIdB }
						]
						# create new instances of the same ObjectIds so that == doesn't pass
						newDocs: [
							{ path: '/old_a', doc: _id: new ObjectId(@docIdA.toString()) }
							{ path: '/new_b', doc: _id: new ObjectId(@docIdB.toString()) }
						]
					}

					docUpdates = [
						id: @docIdB.toString(),
						pathname: "/old_b"
						newPathname: "/new_b"
					]

					@handler.updateProjectStructure @project_id, @projectHistoryId, @user_id, @changes, () =>
						@request.calledWith(
							url: @url,
							method: "POST"
							json: {docUpdates, fileUpdates: [], userId: @user_id, @version, @projectHistoryId}
						)
						.should.equal true
						done()

			describe "when a doc has been added", ->
				it 'should send the structure update to the document updater', (done) ->
					@docId = new ObjectId()
					@changes = newDocs: [
						{ path: '/foo', docLines: 'a\nb', doc: _id: @docId }
					]

					docUpdates = [
						id: @docId.toString(),
						pathname: "/foo"
						docLines: 'a\nb'
						url: undefined
					]

					@handler.updateProjectStructure @project_id, @projectHistoryId, @user_id, @changes, () =>
						@request.calledWith(
							url: @url
							method: "POST"
							json: {docUpdates, fileUpdates: [], userId: @user_id, @version, @projectHistoryId}
						).should.equal true
						done()

			describe "when a file has been added", ->
				it 'should send the structure update to the document updater', (done) ->
					@fileId = new ObjectId()
					@changes = newFiles: [
						{ path: '/bar', url: 'filestore.example.com/file', file: _id: @fileId }
					]

					fileUpdates = [
						id: @fileId.toString(),
						pathname: "/bar"
						url: 'filestore.example.com/file'
						docLines: undefined
					]

					@handler.updateProjectStructure @project_id, @projectHistoryId, @user_id, @changes, () =>
						@request.calledWith(
							url: @url
							method: "POST"
							json: {docUpdates: [], fileUpdates, userId: @user_id, @version, @projectHistoryId}
						).should.equal true
						done()

			describe "when an entity has been deleted", ->
				it 'should end the structure update to the document updater', (done) ->
					@docId = new ObjectId()
					@changes = oldDocs: [
						{ path: '/foo', docLines: 'a\nb', doc: _id: @docId }
					]

					docUpdates = [
						id: @docId.toString(),
						pathname: '/foo',
						newPathname: ''
					]

					@handler.updateProjectStructure @project_id, @projectHistoryId, @user_id, @changes, () =>
						@request.calledWith(
							url: @url
							method: "POST"
							json: {docUpdates, fileUpdates: [], userId: @user_id, @version, @projectHistoryId}
						).should.equal true
						done()