Overleaf/services/web/test/unit/src/Uploads/ProjectUploadControllerTests.mjs

// TODO: This file was created by bulk-decaffeinate.
// Fix any style issues and re-enable lint.
/*
 * decaffeinate suggestions:
 * DS102: Remove unnecessary code created because of implicit returns
 * DS206: Consider reworking classes to avoid initClass
 * Full docs: https://github.com/decaffeinate/decaffeinate/blob/master/docs/suggestions.md
 */
import sinon from 'sinon'

import { expect } from 'chai'

import esmock from 'esmock'
import MockRequest from '../helpers/MockRequest.js'
import MockResponse from '../helpers/MockResponse.js'
import ArchiveErrors from '../../../../app/src/Features/Uploads/ArchiveErrors.js'

const modulePath =
  '../../../../app/src/Features/Uploads/ProjectUploadController.mjs'

describe('ProjectUploadController', function () {
  beforeEach(async function () {
    let Timer
    this.req = new MockRequest()
    this.res = new MockResponse()
    this.user_id = 'user-id-123'
    this.metrics = {
      Timer: (Timer = (function () {
        Timer = class Timer {
          static initClass() {
            this.prototype.done = sinon.stub()
          }
        }
        Timer.initClass()
        return Timer
      })()),
    }
    this.SessionManager = {
      getLoggedInUserId: sinon.stub().returns(this.user_id),
    }
    this.ProjectLocator = {
      promises: {},
    }
    this.EditorController = {
      promises: {},
    }

    return (this.ProjectUploadController = await esmock.strict(modulePath, {
      multer: sinon.stub(),
      '@overleaf/settings': { path: {} },
      '../../../../app/src/Features/Uploads/ProjectUploadManager':
        (this.ProjectUploadManager = {}),
      '../../../../app/src/Features/Uploads/FileSystemImportManager':
        (this.FileSystemImportManager = {}),
      '@overleaf/metrics': this.metrics,
      '../../../../app/src/Features/Authentication/SessionManager':
        this.SessionManager,
      '../../../../app/src/Features/Uploads/ArchiveErrors': ArchiveErrors,
      '../../../../app/src/Features/Project/ProjectLocator':
        this.ProjectLocator,
      '../../../../app/src/Features/Editor/EditorController':
        this.EditorController,
      fs: (this.fs = {}),
    }))
  })

  describe('uploadProject', function () {
    beforeEach(function () {
      this.path = '/path/to/file/on/disk.zip'
      this.name = 'filename.zip'
      this.req.file = {
        path: this.path,
      }
      this.req.body = {
        name: this.name,
      }
      this.req.session = {
        user: {
          _id: this.user_id,
        },
      }
      this.project = { _id: (this.project_id = 'project-id-123') }

      return (this.fs.unlink = sinon.stub())
    })

    describe('successfully', function () {
      beforeEach(function () {
        this.ProjectUploadManager.createProjectFromZipArchive = sinon
          .stub()
          .callsArgWith(3, null, this.project)
        return this.ProjectUploadController.uploadProject(this.req, this.res)
      })

      it('should create a project owned by the logged in user', function () {
        return this.ProjectUploadManager.createProjectFromZipArchive
          .calledWith(this.user_id)
          .should.equal(true)
      })

      it('should create a project with the same name as the zip archive', function () {
        return this.ProjectUploadManager.createProjectFromZipArchive
          .calledWith(sinon.match.any, 'filename', sinon.match.any)
          .should.equal(true)
      })

      it('should create a project from the zip archive', function () {
        return this.ProjectUploadManager.createProjectFromZipArchive
          .calledWith(sinon.match.any, sinon.match.any, this.path)
          .should.equal(true)
      })

      it('should return a successful response to the FileUploader client', function () {
        return expect(this.res.body).to.deep.equal(
          JSON.stringify({
            success: true,
            project_id: this.project_id,
          })
        )
      })

      it('should record the time taken to do the upload', function () {
        return this.metrics.Timer.prototype.done.called.should.equal(true)
      })

      it('should remove the uploaded file', function () {
        return this.fs.unlink.calledWith(this.path).should.equal(true)
      })
    })

    describe('when ProjectUploadManager.createProjectFromZipArchive fails', function () {
      beforeEach(function () {
        this.ProjectUploadManager.createProjectFromZipArchive = sinon
          .stub()
          .callsArgWith(3, new Error('Something went wrong'), this.project)
        return this.ProjectUploadController.uploadProject(this.req, this.res)
      })

      it('should return a failed response to the FileUploader client', function () {
        return expect(this.res.body).to.deep.equal(
          JSON.stringify({ success: false, error: 'upload_failed' })
        )
      })
    })

    describe('when ProjectUploadManager.createProjectFromZipArchive reports the file as invalid', function () {
      beforeEach(function () {
        this.ProjectUploadManager.createProjectFromZipArchive = sinon
          .stub()
          .callsArgWith(
            3,
            new ArchiveErrors.ZipContentsTooLargeError(),
            this.project
          )
        return this.ProjectUploadController.uploadProject(this.req, this.res)
      })

      it('should return the reported error to the FileUploader client', function () {
        expect(JSON.parse(this.res.body)).to.deep.equal({
          success: false,
          error: 'zip_contents_too_large',
        })
      })

      it("should return an 'unprocessable entity' status code", function () {
        return expect(this.res.statusCode).to.equal(422)
      })
    })
  })

  describe('uploadFile', function () {
    beforeEach(function () {
      this.project_id = 'project-id-123'
      this.folder_id = 'folder-id-123'
      this.path = '/path/to/file/on/disk.png'
      this.name = 'filename.png'
      this.req.file = {
        path: this.path,
      }
      this.req.body = {
        name: this.name,
      }
      this.req.session = {
        user: {
          _id: this.user_id,
        },
      }
      this.req.params = { Project_id: this.project_id }
      this.req.query = { folder_id: this.folder_id }
      return (this.fs.unlink = sinon.stub())
    })

    describe('successfully', function () {
      beforeEach(function () {
        this.entity = {
          _id: '1234',
          type: 'file',
        }
        this.FileSystemImportManager.addEntity = sinon
          .stub()
          .callsArgWith(6, null, this.entity)
        return this.ProjectUploadController.uploadFile(this.req, this.res)
      })

      it('should insert the file', function () {
        return this.FileSystemImportManager.addEntity
          .calledWith(
            this.user_id,
            this.project_id,
            this.folder_id,
            this.name,
            this.path
          )
          .should.equal(true)
      })

      it('should return a successful response to the FileUploader client', function () {
        return expect(this.res.body).to.deep.equal(
          JSON.stringify({
            success: true,
            entity_id: this.entity._id,
            entity_type: 'file',
          })
        )
      })

      it('should time the request', function () {
        return this.metrics.Timer.prototype.done.called.should.equal(true)
      })

      it('should remove the uploaded file', function () {
        return this.fs.unlink.calledWith(this.path).should.equal(true)
      })
    })

    describe('with folder structure', function () {
      beforeEach(function (done) {
        this.entity = {
          _id: '1234',
          type: 'file',
        }
        this.FileSystemImportManager.addEntity = sinon
          .stub()
          .callsArgWith(6, null, this.entity)
        this.ProjectLocator.promises.findElement = sinon.stub().resolves({
          path: { fileSystem: '/test' },
        })
        this.EditorController.promises.mkdirp = sinon.stub().resolves({
          lastFolder: { _id: 'folder-id' },
        })
        this.req.body.relativePath = 'foo/bar/' + this.name
        this.res.json = data => {
          expect(data.success).to.be.true
          done()
        }
        this.ProjectUploadController.uploadFile(this.req, this.res)
      })

      it('should insert the file', function () {
        this.ProjectLocator.promises.findElement.should.be.calledOnceWithExactly(
          {
            project_id: this.project_id,
            element_id: this.folder_id,
            type: 'folder',
          }
        )

        this.EditorController.promises.mkdirp.should.be.calledWith(
          this.project_id,
          '/test/foo/bar'
        )

        this.FileSystemImportManager.addEntity.should.be.calledOnceWith(
          this.user_id,
          this.project_id,
          'folder-id',
          this.name,
          this.path
        )
      })
    })

    describe('when FileSystemImportManager.addEntity returns a generic error', function () {
      beforeEach(function () {
        this.FileSystemImportManager.addEntity = sinon
          .stub()
          .callsArgWith(6, new Error('Sorry something went wrong'))
        return this.ProjectUploadController.uploadFile(this.req, this.res)
      })

      it('should return an unsuccessful response to the FileUploader client', function () {
        return expect(this.res.body).to.deep.equal(
          JSON.stringify({
            success: false,
          })
        )
      })
    })

    describe('when FileSystemImportManager.addEntity returns a too many files error', function () {
      beforeEach(function () {
        this.FileSystemImportManager.addEntity = sinon
          .stub()
          .callsArgWith(6, new Error('project_has_too_many_files'))
        return this.ProjectUploadController.uploadFile(this.req, this.res)
      })

      it('should return an unsuccessful response to the FileUploader client', function () {
        return expect(this.res.body).to.deep.equal(
          JSON.stringify({
            success: false,
            error: 'project_has_too_many_files',
          })
        )
      })
    })

    describe('with an invalid filename', function () {
      beforeEach(function () {
        this.req.body.name = ''
        return this.ProjectUploadController.uploadFile(this.req, this.res)
      })

      it('should return a a non success response', function () {
        return expect(this.res.body).to.deep.equal(
          JSON.stringify({
            success: false,
            error: 'invalid_filename',
          })
        )
      })
    })
  })
})