overleaf/services/real-time/test/unit/coffee/WebApiManagerTests.js

/*
 * decaffeinate suggestions:
 * DS102: Remove unnecessary code created because of implicit returns
 * Full docs: https://github.com/decaffeinate/decaffeinate/blob/master/docs/suggestions.md
 */
const chai = require('chai');
const should = chai.should();
const sinon = require("sinon");
const modulePath = "../../../app/js/WebApiManager.js";
const SandboxedModule = require('sandboxed-module');
const { CodedError } = require('../../../app/js/Errors');

describe('WebApiManager', function() {
	beforeEach(function() {
		this.project_id = "project-id-123";
		this.user_id = "user-id-123";
		this.user = {_id: this.user_id};
		this.callback = sinon.stub();
		return this.WebApiManager = SandboxedModule.require(modulePath, { requires: {
			"request": (this.request = {}),
			"settings-sharelatex": (this.settings = {
				apis: {
					web: {
						url: "http://web.example.com",
						user: "username",
						pass: "password"
					}
				}
			}),
			"logger-sharelatex": (this.logger = { log: sinon.stub(), error: sinon.stub() })
		}
	});});

	return describe("joinProject", function() {
		describe("successfully", function() {
			beforeEach(function() {
				this.response = {
					project: { name: "Test project" },
					privilegeLevel: "owner",
					isRestrictedUser: true
				};
				this.request.post = sinon.stub().callsArgWith(1, null, {statusCode: 200}, this.response);
				return this.WebApiManager.joinProject(this.project_id, this.user, this.callback);
			});

			it("should send a request to web to join the project", function() {
				return this.request.post
					.calledWith({
						url: `${this.settings.apis.web.url}/project/${this.project_id}/join`,
						qs: {
							user_id: this.user_id
						},
						auth: {
							user: this.settings.apis.web.user,
							pass: this.settings.apis.web.pass,
							sendImmediately: true
						},
						json: true,
						jar: false,
						headers: {}
					})
					.should.equal(true);
			});

			return it("should return the project, privilegeLevel, and restricted flag", function() {
				return this.callback
					.calledWith(null, this.response.project, this.response.privilegeLevel, this.response.isRestrictedUser)
					.should.equal(true);
			});
		});

		describe("with an error from web", function() {
			beforeEach(function() {
				this.request.post = sinon.stub().callsArgWith(1, null, {statusCode: 500}, null);
				return this.WebApiManager.joinProject(this.project_id, this.user_id, this.callback);
			});

			return it("should call the callback with an error", function() {
				return this.callback
					.calledWith(sinon.match({message: "non-success status code from web: 500"}))
					.should.equal(true);
			});
		});

		describe("with no data from web", function() {
			beforeEach(function() {
				this.request.post = sinon.stub().callsArgWith(1, null, {statusCode: 200}, null);
				return this.WebApiManager.joinProject(this.project_id, this.user_id, this.callback);
			});

			return it("should call the callback with an error", function() {
				return this.callback
					.calledWith(sinon.match({message: "no data returned from joinProject request"}))
					.should.equal(true);
			});
		});

		return describe("when the project is over its rate limit", function() {
			beforeEach(function() {
				this.request.post = sinon.stub().callsArgWith(1, null, {statusCode: 429}, null);
				return this.WebApiManager.joinProject(this.project_id, this.user_id, this.callback);
			});

			return it("should call the callback with a TooManyRequests error code", function() {
				return this.callback
					.calledWith(sinon.match({message: "rate-limit hit when joining project", code: "TooManyRequests"}))
					.should.equal(true);
			});
		});
	});
});