Overleaf/services/document-updater/test/unit/coffee/PersistenceManager/getDocFromWebTests.coffee

sinon = require('sinon')
chai = require('chai')
should = chai.should()
modulePath = "../../../../app/js/PersistenceManager.js"
SandboxedModule = require('sandboxed-module')
Errors = require "../../../../app/js/Errors"

describe "PersistenceManager.getDocFromWeb", ->
	beforeEach ->
		@PersistenceManager = SandboxedModule.require modulePath, requires:
			"request": @request = sinon.stub()
			"settings-sharelatex": @Settings = {}
			"./Metrics": @Metrics =
				Timer: class Timer
					done: sinon.stub()
			"logger-sharelatex": @logger = {log: sinon.stub(), err: sinon.stub()}
		@project_id = "project-id-123"
		@doc_id = "doc-id-123"
		@lines = ["one", "two", "three"]
		@callback = sinon.stub()
		@Settings.apis =
			web:
				url: @url = "www.example.com"
				user: @user = "sharelatex"
				pass: @pass = "password"

	describe "with a successful response from the web api", ->
		beforeEach ->
			@request.callsArgWith(1, null, {statusCode: 200}, JSON.stringify(lines: @lines))
			@PersistenceManager.getDocFromWeb(@project_id, @doc_id, @callback)

		it "should call the web api", ->
			@request
				.calledWith({
					url: "#{@url}/project/#{@project_id}/doc/#{@doc_id}"
					method: "GET"
					headers:
						"accept": "application/json"
					auth:
						user: @user
						pass: @pass
						sendImmediately: true
					jar: false
					timeout: 5000
				})
				.should.equal true

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

		it "should time the execution", ->
			@Metrics.Timer::done.called.should.equal true

	describe "when request returns an error", ->
		beforeEach ->
			@request.callsArgWith(1, @error = new Error("oops"), null, null)
			@PersistenceManager.getDocFromWeb(@project_id, @doc_id, @callback)

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

		it "should time the execution", ->
			@Metrics.Timer::done.called.should.equal true

	describe "when the request returns 404", ->
		beforeEach ->
			@request.callsArgWith(1, null, {statusCode: 404}, "")
			@PersistenceManager.getDocFromWeb(@project_id, @doc_id, @callback)
			
		it "should return a NotFoundError", ->
			@callback.calledWith(new Errors.NotFoundError("not found")).should.equal true

		it "should time the execution", ->
			@Metrics.Timer::done.called.should.equal true

	describe "when the request returns an error status code", ->
		beforeEach ->
			@request.callsArgWith(1, null, {statusCode: 500}, "")
			@PersistenceManager.getDocFromWeb(@project_id, @doc_id, @callback)
			
		it "should return an error", ->
			@callback.calledWith(new Error("web api error")).should.equal true

		it "should time the execution", ->
			@Metrics.Timer::done.called.should.equal true