Overleaf/services/web/test/unit/src/Docstore/DocstoreManagerTests.js

const sinon = require('sinon')
const modulePath = '../../../../app/src/Features/Docstore/DocstoreManager'
const SandboxedModule = require('sandboxed-module')
const Errors = require('../../../../app/src/Features/Errors/Errors')
const tk = require('timekeeper')

describe('DocstoreManager', function () {
  beforeEach(function () {
    this.requestDefaults = sinon.stub().returns((this.request = sinon.stub()))
    this.DocstoreManager = SandboxedModule.require(modulePath, {
      requires: {
        request: {
          defaults: this.requestDefaults,
        },
        '@overleaf/settings': (this.settings = {
          apis: {
            docstore: {
              url: 'docstore.overleaf.com',
            },
          },
        }),
      },
    })

    this.requestDefaults.calledWith({ jar: false }).should.equal(true)

    this.project_id = 'project-id-123'
    this.doc_id = 'doc-id-123'
    this.callback = sinon.stub()
  })

  describe('deleteDoc', function () {
    describe('with a successful response code', function () {
      // for assertions on the deletedAt timestamp, we need to freeze the clock.
      before(function () {
        tk.freeze(Date.now())
      })
      after(function () {
        tk.reset()
      })

      beforeEach(function () {
        this.request.patch = sinon
          .stub()
          .callsArgWith(1, null, { statusCode: 204 }, '')
        this.DocstoreManager.deleteDoc(
          this.project_id,
          this.doc_id,
          'wombat.tex',
          new Date(),
          this.callback
        )
      })

      it('should delete the doc in the docstore api', function () {
        this.request.patch
          .calledWith({
            url: `${this.settings.apis.docstore.url}/project/${this.project_id}/doc/${this.doc_id}`,
            json: { deleted: true, deletedAt: new Date(), name: 'wombat.tex' },
            timeout: 30 * 1000,
          })
          .should.equal(true)
      })

      it('should call the callback without an error', function () {
        this.callback.calledWith(null).should.equal(true)
      })
    })

    describe('with a failed response code', function () {
      beforeEach(function () {
        this.request.patch = sinon
          .stub()
          .callsArgWith(1, null, { statusCode: 500 }, '')
        this.DocstoreManager.deleteDoc(
          this.project_id,
          this.doc_id,
          'main.tex',
          new Date(),
          this.callback
        )
      })

      it('should call the callback with an error', function () {
        this.callback
          .calledWith(
            sinon.match
              .instanceOf(Error)
              .and(
                sinon.match.has(
                  'message',
                  'docstore api responded with non-success code: 500'
                )
              )
          )
          .should.equal(true)
      })
    })

    describe('with a missing (404) response code', function () {
      beforeEach(function () {
        this.request.patch = sinon
          .stub()
          .callsArgWith(1, null, { statusCode: 404 }, '')
        this.DocstoreManager.deleteDoc(
          this.project_id,
          this.doc_id,
          'main.tex',
          new Date(),
          this.callback
        )
      })

      it('should call the callback with an error', function () {
        this.callback
          .calledWith(
            sinon.match
              .instanceOf(Errors.NotFoundError)
              .and(
                sinon.match.has(
                  'message',
                  'tried to delete doc not in docstore'
                )
              )
          )
          .should.equal(true)
      })
    })
  })

  describe('updateDoc', function () {
    beforeEach(function () {
      this.lines = ['mock', 'doc', 'lines']
      this.rev = 5
      this.version = 42
      this.ranges = { mock: 'ranges' }
      this.modified = true
    })

    describe('with a successful response code', function () {
      beforeEach(function () {
        this.request.post = sinon
          .stub()
          .callsArgWith(
            1,
            null,
            { statusCode: 204 },
            { modified: this.modified, rev: this.rev }
          )
        this.DocstoreManager.updateDoc(
          this.project_id,
          this.doc_id,
          this.lines,
          this.version,
          this.ranges,
          this.callback
        )
      })

      it('should update the doc in the docstore api', function () {
        this.request.post
          .calledWith({
            url: `${this.settings.apis.docstore.url}/project/${this.project_id}/doc/${this.doc_id}`,
            timeout: 30 * 1000,
            json: {
              lines: this.lines,
              version: this.version,
              ranges: this.ranges,
            },
          })
          .should.equal(true)
      })

      it('should call the callback with the modified status and revision', function () {
        this.callback
          .calledWith(null, this.modified, this.rev)
          .should.equal(true)
      })
    })

    describe('with a failed response code', function () {
      beforeEach(function () {
        this.request.post = sinon
          .stub()
          .callsArgWith(1, null, { statusCode: 500 }, '')
        this.DocstoreManager.updateDoc(
          this.project_id,
          this.doc_id,
          this.lines,
          this.version,
          this.ranges,
          this.callback
        )
      })

      it('should call the callback with an error', function () {
        this.callback
          .calledWith(
            sinon.match
              .instanceOf(Error)
              .and(
                sinon.match.has(
                  'message',
                  'docstore api responded with non-success code: 500'
                )
              )
          )
          .should.equal(true)
      })
    })
  })

  describe('getDoc', function () {
    beforeEach(function () {
      this.doc = {
        lines: (this.lines = ['mock', 'doc', 'lines']),
        rev: (this.rev = 5),
        version: (this.version = 42),
        ranges: (this.ranges = { mock: 'ranges' }),
      }
    })

    describe('with a successful response code', function () {
      beforeEach(function () {
        this.request.get = sinon
          .stub()
          .callsArgWith(1, null, { statusCode: 204 }, this.doc)
        this.DocstoreManager.getDoc(this.project_id, this.doc_id, this.callback)
      })

      it('should get the doc from the docstore api', function () {
        this.request.get.should.have.been.calledWith({
          url: `${this.settings.apis.docstore.url}/project/${this.project_id}/doc/${this.doc_id}`,
          timeout: 30 * 1000,
          json: true,
        })
      })

      it('should call the callback with the lines, version and rev', function () {
        this.callback
          .calledWith(null, this.lines, this.rev, this.version, this.ranges)
          .should.equal(true)
      })
    })

    describe('with a failed response code', function () {
      beforeEach(function () {
        this.request.get = sinon
          .stub()
          .callsArgWith(1, null, { statusCode: 500 }, '')
        this.DocstoreManager.getDoc(this.project_id, this.doc_id, this.callback)
      })

      it('should call the callback with an error', function () {
        this.callback
          .calledWith(
            sinon.match
              .instanceOf(Error)
              .and(
                sinon.match.has(
                  'message',
                  'docstore api responded with non-success code: 500'
                )
              )
          )
          .should.equal(true)
      })
    })

    describe('with include_deleted=true', function () {
      beforeEach(function () {
        this.request.get = sinon
          .stub()
          .callsArgWith(1, null, { statusCode: 204 }, this.doc)
        this.DocstoreManager.getDoc(
          this.project_id,
          this.doc_id,
          { include_deleted: true },
          this.callback
        )
      })

      it('should get the doc from the docstore api (including deleted)', function () {
        this.request.get.should.have.been.calledWith({
          url: `${this.settings.apis.docstore.url}/project/${this.project_id}/doc/${this.doc_id}`,
          qs: { include_deleted: 'true' },
          timeout: 30 * 1000,
          json: true,
        })
      })

      it('should call the callback with the lines, version and rev', function () {
        this.callback
          .calledWith(null, this.lines, this.rev, this.version, this.ranges)
          .should.equal(true)
      })
    })

    describe('with peek=true', function () {
      beforeEach(function () {
        this.request.get = sinon
          .stub()
          .callsArgWith(1, null, { statusCode: 204 }, this.doc)
        this.DocstoreManager.getDoc(
          this.project_id,
          this.doc_id,
          { peek: true },
          this.callback
        )
      })

      it('should call the docstore peek url', function () {
        this.request.get.should.have.been.calledWith({
          url: `${this.settings.apis.docstore.url}/project/${this.project_id}/doc/${this.doc_id}/peek`,
          timeout: 30 * 1000,
          json: true,
        })
      })
    })

    describe('with a missing (404) response code', function () {
      beforeEach(function () {
        this.request.get = sinon
          .stub()
          .callsArgWith(1, null, { statusCode: 404 }, '')
        this.DocstoreManager.getDoc(this.project_id, this.doc_id, this.callback)
      })

      it('should call the callback with an error', function () {
        this.callback
          .calledWith(
            sinon.match
              .instanceOf(Errors.NotFoundError)
              .and(sinon.match.has('message', 'doc not found in docstore'))
          )
          .should.equal(true)
      })
    })
  })

  describe('getAllDocs', function () {
    describe('with a successful response code', function () {
      beforeEach(function () {
        this.request.get = sinon
          .stub()
          .callsArgWith(
            1,
            null,
            { statusCode: 204 },
            (this.docs = [{ _id: 'mock-doc-id' }])
          )
        this.DocstoreManager.getAllDocs(this.project_id, this.callback)
      })

      it('should get all the project docs in the docstore api', function () {
        this.request.get
          .calledWith({
            url: `${this.settings.apis.docstore.url}/project/${this.project_id}/doc`,
            timeout: 30 * 1000,
            json: true,
          })
          .should.equal(true)
      })

      it('should call the callback with the docs', function () {
        this.callback.calledWith(null, this.docs).should.equal(true)
      })
    })

    describe('with a failed response code', function () {
      beforeEach(function () {
        this.request.get = sinon
          .stub()
          .callsArgWith(1, null, { statusCode: 500 }, '')
        this.DocstoreManager.getAllDocs(this.project_id, this.callback)
      })

      it('should call the callback with an error', function () {
        this.callback
          .calledWith(
            sinon.match
              .instanceOf(Error)
              .and(
                sinon.match.has(
                  'message',
                  'docstore api responded with non-success code: 500'
                )
              )
          )
          .should.equal(true)
      })
    })
  })

  describe('getAllDeletedDocs', function () {
    describe('with a successful response code', function () {
      beforeEach(function (done) {
        this.callback.callsFake(done)
        this.docs = [{ _id: 'mock-doc-id', name: 'foo.tex' }]
        this.request.get = sinon
          .stub()
          .callsArgWith(1, null, { statusCode: 200 }, this.docs)
        this.DocstoreManager.getAllDeletedDocs(this.project_id, this.callback)
      })

      it('should get all the project docs in the docstore api', function () {
        this.request.get.should.have.been.calledWith({
          url: `${this.settings.apis.docstore.url}/project/${this.project_id}/doc-deleted`,
          timeout: 30 * 1000,
          json: true,
        })
      })

      it('should call the callback with the docs', function () {
        this.callback.should.have.been.calledWith(null, this.docs)
      })
    })

    describe('with an error', function () {
      beforeEach(function (done) {
        this.callback.callsFake(() => done())
        this.request.get = sinon
          .stub()
          .callsArgWith(1, new Error('connect failed'))
        this.DocstoreManager.getAllDocs(this.project_id, this.callback)
      })

      it('should call the callback with an error', function () {
        this.callback.should.have.been.calledWith(
          sinon.match
            .instanceOf(Error)
            .and(sinon.match.has('message', 'connect failed'))
        )
      })
    })

    describe('with a failed response code', function () {
      beforeEach(function (done) {
        this.callback.callsFake(() => done())
        this.request.get = sinon
          .stub()
          .callsArgWith(1, null, { statusCode: 500 })
        this.DocstoreManager.getAllDocs(this.project_id, this.callback)
      })

      it('should call the callback with an error', function () {
        this.callback.should.have.been.calledWith(
          sinon.match
            .instanceOf(Error)
            .and(
              sinon.match.has(
                'message',
                'docstore api responded with non-success code: 500'
              )
            )
        )
      })
    })
  })

  describe('getAllRanges', function () {
    describe('with a successful response code', function () {
      beforeEach(function () {
        this.request.get = sinon
          .stub()
          .callsArgWith(
            1,
            null,
            { statusCode: 204 },
            (this.docs = [{ _id: 'mock-doc-id', ranges: 'mock-ranges' }])
          )
        this.DocstoreManager.getAllRanges(this.project_id, this.callback)
      })

      it('should get all the project doc ranges in the docstore api', function () {
        this.request.get
          .calledWith({
            url: `${this.settings.apis.docstore.url}/project/${this.project_id}/ranges`,
            timeout: 30 * 1000,
            json: true,
          })
          .should.equal(true)
      })

      it('should call the callback with the docs', function () {
        this.callback.calledWith(null, this.docs).should.equal(true)
      })
    })

    describe('with a failed response code', function () {
      beforeEach(function () {
        this.request.get = sinon
          .stub()
          .callsArgWith(1, null, { statusCode: 500 }, '')
        this.DocstoreManager.getAllRanges(this.project_id, this.callback)
      })

      it('should call the callback with an error', function () {
        this.callback
          .calledWith(
            sinon.match
              .instanceOf(Error)
              .and(
                sinon.match.has(
                  'message',
                  'docstore api responded with non-success code: 500'
                )
              )
          )
          .should.equal(true)
      })
    })
  })

  describe('archiveProject', function () {
    describe('with a successful response code', function () {
      beforeEach(function () {
        this.request.post = sinon
          .stub()
          .callsArgWith(1, null, { statusCode: 204 })
        this.DocstoreManager.archiveProject(this.project_id, this.callback)
      })

      it('should call the callback', function () {
        this.callback.called.should.equal(true)
      })
    })

    describe('with a failed response code', function () {
      beforeEach(function () {
        this.request.post = sinon
          .stub()
          .callsArgWith(1, null, { statusCode: 500 })
        this.DocstoreManager.archiveProject(this.project_id, this.callback)
      })

      it('should call the callback with an error', function () {
        this.callback
          .calledWith(
            sinon.match
              .instanceOf(Error)
              .and(
                sinon.match.has(
                  'message',
                  'docstore api responded with non-success code: 500'
                )
              )
          )
          .should.equal(true)
      })
    })
  })

  describe('unarchiveProject', function () {
    describe('with a successful response code', function () {
      beforeEach(function () {
        this.request.post = sinon
          .stub()
          .callsArgWith(1, null, { statusCode: 204 })
        this.DocstoreManager.unarchiveProject(this.project_id, this.callback)
      })

      it('should call the callback', function () {
        this.callback.called.should.equal(true)
      })
    })

    describe('with a failed response code', function () {
      beforeEach(function () {
        this.request.post = sinon
          .stub()
          .callsArgWith(1, null, { statusCode: 500 })
        this.DocstoreManager.unarchiveProject(this.project_id, this.callback)
      })

      it('should call the callback with an error', function () {
        this.callback
          .calledWith(
            sinon.match
              .instanceOf(Error)
              .and(
                sinon.match.has(
                  'message',
                  'docstore api responded with non-success code: 500'
                )
              )
          )
          .should.equal(true)
      })
    })
  })

  describe('destroyProject', function () {
    describe('with a successful response code', function () {
      beforeEach(function () {
        this.request.post = sinon
          .stub()
          .callsArgWith(1, null, { statusCode: 204 })
        this.DocstoreManager.destroyProject(this.project_id, this.callback)
      })

      it('should call the callback', function () {
        this.callback.called.should.equal(true)
      })
    })

    describe('with a failed response code', function () {
      beforeEach(function () {
        this.request.post = sinon
          .stub()
          .callsArgWith(1, null, { statusCode: 500 })
        this.DocstoreManager.destroyProject(this.project_id, this.callback)
      })

      it('should call the callback with an error', function () {
        this.callback
          .calledWith(
            sinon.match
              .instanceOf(Error)
              .and(
                sinon.match.has(
                  'message',
                  'docstore api responded with non-success code: 500'
                )
              )
          )
          .should.equal(true)
      })
    })
  })
})