overleaf/services/document-updater/test/acceptance/coffee/DeletingAProjectTests.js

/*
 * decaffeinate suggestions:
 * DS101: Remove unnecessary use of Array.from
 * DS102: Remove unnecessary code created because of implicit returns
 * DS207: Consider shorter variations of null checks
 * Full docs: https://github.com/decaffeinate/decaffeinate/blob/master/docs/suggestions.md
 */
const sinon = require("sinon");
const chai = require("chai");
chai.should();
const async = require("async");

const MockTrackChangesApi = require("./helpers/MockTrackChangesApi");
const MockProjectHistoryApi = require("./helpers/MockProjectHistoryApi");
const MockWebApi = require("./helpers/MockWebApi");
const DocUpdaterClient = require("./helpers/DocUpdaterClient");
const DocUpdaterApp = require("./helpers/DocUpdaterApp");

describe("Deleting a project", function() {
	before(function(done) {
		let doc_id0, doc_id1;
		this.project_id = DocUpdaterClient.randomId();
		this.docs = [{
			id: (doc_id0 = DocUpdaterClient.randomId()),
			lines: ["one", "two", "three"],
			update: {
				doc: doc_id0,
				op: [{
					i: "one and a half\n",
					p: 4
				}],
				v: 0
			},
			updatedLines: ["one", "one and a half", "two", "three"]
		}, {
			id: (doc_id1 = DocUpdaterClient.randomId()),
			lines: ["four", "five", "six"],
			update: {
				doc: doc_id1,
				op: [{
					i: "four and a half\n",
					p: 5
				}],
				v: 0
			},
			updatedLines: ["four", "four and a half", "five", "six"]
		}];
		for (let doc of Array.from(this.docs)) {
			MockWebApi.insertDoc(this.project_id, doc.id, {
				lines: doc.lines,
				version: doc.update.v
			});
		}

		return DocUpdaterApp.ensureRunning(done);
	});


	describe("with documents which have been updated", function() {
		before(function(done) {
			sinon.spy(MockWebApi, "setDocument");
			sinon.spy(MockTrackChangesApi, "flushDoc");
			sinon.spy(MockProjectHistoryApi, "flushProject");

			return async.series(this.docs.map(doc => {
				return callback => {
					return DocUpdaterClient.preloadDoc(this.project_id, doc.id, error => {
						if (error != null) { return callback(error); }
						return DocUpdaterClient.sendUpdate(this.project_id, doc.id, doc.update, error => {
							return callback(error);
					});
				});
				};
			}), error => {
				if (error != null) { throw error; }
				return setTimeout(() => {
					return DocUpdaterClient.deleteProject(this.project_id, (error, res, body) => {
						this.statusCode = res.statusCode;
						return done();
					});
				}
				, 200);
			});
		});

		after(function() {
			MockWebApi.setDocument.restore();
			MockTrackChangesApi.flushDoc.restore();
			return MockProjectHistoryApi.flushProject.restore();
		});

		it("should return a 204 status code", function() {
			return this.statusCode.should.equal(204);
		});

		it("should send each document to the web api", function() {
			return Array.from(this.docs).map((doc) =>
				MockWebApi.setDocument
					.calledWith(this.project_id, doc.id, doc.updatedLines)
					.should.equal(true));
		});

		it("should need to reload the docs if read again", function(done) {
			sinon.spy(MockWebApi, "getDocument");
			return async.series(this.docs.map(doc => {
				return callback => {
					MockWebApi.getDocument.calledWith(this.project_id, doc.id).should.equal(false);
					return DocUpdaterClient.getDoc(this.project_id, doc.id, (error, res, returnedDoc) => {
						MockWebApi.getDocument.calledWith(this.project_id, doc.id).should.equal(true);
						return callback();
				});
				};
			}), function() {
				MockWebApi.getDocument.restore();
				return done();
			});
		});

		it("should flush each doc in track changes", function() {
			return Array.from(this.docs).map((doc) =>
				MockTrackChangesApi.flushDoc.calledWith(doc.id).should.equal(true));
		});

		return it("should flush each doc in project history", function() {
			return MockProjectHistoryApi.flushProject.calledWith(this.project_id).should.equal(true);
		});
	});

	describe("with the background=true parameter from realtime and no request to flush the queue", function() {
		before(function(done) {
			sinon.spy(MockWebApi, "setDocument");
			sinon.spy(MockTrackChangesApi, "flushDoc");
			sinon.spy(MockProjectHistoryApi, "flushProject");

			return async.series(this.docs.map(doc => {
				return callback => {
					return DocUpdaterClient.preloadDoc(this.project_id, doc.id, callback);
				};
			}), error => {
				if (error != null) { throw error; }
				return setTimeout(() => {
					return DocUpdaterClient.deleteProjectOnShutdown(this.project_id, (error, res, body) => {
						this.statusCode = res.statusCode;
						return done();
					});
				}
				, 200);
			});
		});

		after(function() {
			MockWebApi.setDocument.restore();
			MockTrackChangesApi.flushDoc.restore();
			return MockProjectHistoryApi.flushProject.restore();
		});

		it("should return a 204 status code", function() {
			return this.statusCode.should.equal(204);
		});

		it("should not send any documents to the web api", () => MockWebApi.setDocument.called.should.equal(false));

		it("should not flush any docs in track changes", () => MockTrackChangesApi.flushDoc.called.should.equal(false));

		return it("should not flush to project history", () => MockProjectHistoryApi.flushProject.called.should.equal(false));
	});

	return describe("with the background=true parameter from realtime and a request to flush the queue", function() {
		before(function(done) {
			sinon.spy(MockWebApi, "setDocument");
			sinon.spy(MockTrackChangesApi, "flushDoc");
			sinon.spy(MockProjectHistoryApi, "flushProject");

			return async.series(this.docs.map(doc => {
				return callback => {
					return DocUpdaterClient.preloadDoc(this.project_id, doc.id, callback);
				};
			}), error => {
				if (error != null) { throw error; }
				return setTimeout(() => {
					return DocUpdaterClient.deleteProjectOnShutdown(this.project_id, (error, res, body) => {
						this.statusCode = res.statusCode;
						// after deleting the project and putting it in the queue, flush the queue
						return setTimeout(() => DocUpdaterClient.flushOldProjects(done)
						, 2000);
					});
				}
				, 200);
			});
		});

		after(function() {
			MockWebApi.setDocument.restore();
			MockTrackChangesApi.flushDoc.restore();
			return MockProjectHistoryApi.flushProject.restore();
		});

		it("should return a 204 status code", function() {
			return this.statusCode.should.equal(204);
		});

		it("should send each document to the web api", function() {
			return Array.from(this.docs).map((doc) =>
				MockWebApi.setDocument
					.calledWith(this.project_id, doc.id, doc.updatedLines)
					.should.equal(true));
		});

		it("should flush each doc in track changes", function() {
			return Array.from(this.docs).map((doc) =>
				MockTrackChangesApi.flushDoc.calledWith(doc.id).should.equal(true));
		});

		return it("should flush to project history", () => MockProjectHistoryApi.flushProject.called.should.equal(true));
	});
});