overleaf/services/docstore/test/acceptance/js/UpdatingDocsTests.js

import mongodb from 'mongodb-legacy'
import DocstoreApp from './helpers/DocstoreApp.js'
import DocstoreClient from './helpers/DocstoreClient.js'

const { ObjectId } = mongodb

describe('Applying updates to a doc', function () {
  beforeEach(async function () {
    this.project_id = new ObjectId()
    this.doc_id = new ObjectId()
    this.originalLines = ['original', 'lines', '$1.00', '$foo']
    this.newLines = ['new', 'lines', '$2.00', '$bar']
    this.originalRanges = {
      changes: [
        {
          id: new ObjectId().toString(),
          op: { i: '$foo', p: 3 },
          meta: {
            user_id: new ObjectId().toString(),
            ts: new Date().toString(),
          },
        },
      ],
    }
    this.newRanges = {
      changes: [
        {
          id: new ObjectId().toString(),
          op: { i: '$bar', p: 6 },
          meta: {
            user_id: new ObjectId().toString(),
            ts: new Date().toString(),
          },
        },
      ],
    }

    this.version = 42
    await DocstoreApp.ensureRunning()
    await DocstoreClient.createDoc(
      this.project_id,
      this.doc_id,
      this.originalLines,
      this.version,
      this.originalRanges
    )
  })

  describe('when nothing has been updated', function () {
    beforeEach(async function () {
      this.body = await DocstoreClient.updateDoc(
        this.project_id,
        this.doc_id,
        this.originalLines,
        this.version,
        this.originalRanges
      )
    })

    it('should return modified = false', function () {
      this.body.modified.should.equal(false)
    })

    it('should not update the doc in the API', async function () {
      const doc = await DocstoreClient.getDoc(this.project_id, this.doc_id)
      doc.lines.should.deep.equal(this.originalLines)
      doc.version.should.equal(this.version)
      doc.ranges.should.deep.equal(this.originalRanges)
    })
  })

  describe('when the lines have changed', function () {
    beforeEach(async function () {
      this.body = await DocstoreClient.updateDoc(
        this.project_id,
        this.doc_id,
        this.newLines,
        this.version,
        this.originalRanges
      )
    })

    it('should return modified = true', function () {
      this.body.modified.should.equal(true)
    })

    it('should return the rev', function () {
      this.body.rev.should.equal(2)
    })

    it('should update the doc in the API', async function () {
      const doc = await DocstoreClient.getDoc(this.project_id, this.doc_id)
      doc.lines.should.deep.equal(this.newLines)
      doc.version.should.equal(this.version)
      doc.ranges.should.deep.equal(this.originalRanges)
    })
  })

  describe('when the version has changed', function () {
    beforeEach(async function () {
      this.body = await DocstoreClient.updateDoc(
        this.project_id,
        this.doc_id,
        this.originalLines,
        this.version + 1,
        this.originalRanges
      )
    })

    it('should return modified = true', function () {
      this.body.modified.should.equal(true)
    })

    it('should return the rev', function () {
      this.body.rev.should.equal(1)
    })

    it('should update the doc in the API', async function () {
      const doc = await DocstoreClient.getDoc(this.project_id, this.doc_id)
      doc.lines.should.deep.equal(this.originalLines)
      doc.version.should.equal(this.version + 1)
      doc.ranges.should.deep.equal(this.originalRanges)
    })
  })

  describe('when the version was decremented', function () {
    let statusCode
    beforeEach(async function () {
      try {
        this.body = await DocstoreClient.updateDoc(
          this.project_id,
          this.doc_id,
          this.newLines,
          this.version - 1,
          this.newRanges
        )
      } catch (error) {
        statusCode = error.info.status
      }
    })

    it('should return 409', function () {
      statusCode.should.equal(409)
    })

    it('should not update the doc in the API', async function () {
      const doc = await DocstoreClient.getDoc(this.project_id, this.doc_id)
      doc.lines.should.deep.equal(this.originalLines)
      doc.version.should.equal(this.version)
      doc.ranges.should.deep.equal(this.originalRanges)
    })
  })

  describe('when the ranges have changed', function () {
    beforeEach(async function () {
      this.body = await DocstoreClient.updateDoc(
        this.project_id,
        this.doc_id,
        this.originalLines,
        this.version,
        this.newRanges
      )
    })

    it('should return modified = true', function () {
      this.body.modified.should.equal(true)
    })

    it('should return the rev', function () {
      this.body.rev.should.equal(2)
    })

    it('should update the doc in the API', async function () {
      const doc = await DocstoreClient.getDoc(this.project_id, this.doc_id)
      doc.lines.should.deep.equal(this.originalLines)
      doc.version.should.equal(this.version)
      doc.ranges.should.deep.equal(this.newRanges)
    })
  })

  describe('when the doc does not exist', function () {
    beforeEach(async function () {
      this.missing_doc_id = new ObjectId()
      this.body = await DocstoreClient.updateDoc(
        this.project_id,
        this.missing_doc_id,
        this.originalLines,
        0,
        this.originalRanges
      )
    })

    it('should create the doc', function () {
      this.body.rev.should.equal(1)
    })

    it('should be retreivable', async function () {
      const doc = await DocstoreClient.getDoc(
        this.project_id,
        this.missing_doc_id
      )
      doc.lines.should.deep.equal(this.originalLines)
      doc.version.should.equal(0)
      doc.ranges.should.deep.equal(this.originalRanges)
    })
  })

  describe('when malformed doc lines are provided', function () {
    describe('when the lines are not an array', function () {
      let statusCode
      beforeEach(async function () {
        try {
          this.body = await DocstoreClient.updateDoc(
            this.project_id,
            this.doc_id,
            { foo: 'bar' },
            this.version,
            this.originalRanges
          )
        } catch (error) {
          statusCode = error.info.status
        }
      })

      it('should return 400', function () {
        statusCode.should.equal(400)
      })

      it('should not update the doc in the API', async function () {
        const doc = await DocstoreClient.getDoc(this.project_id, this.doc_id)
        doc.lines.should.deep.equal(this.originalLines)
      })
    })

    describe('when the lines are not present', function () {
      let statusCode
      beforeEach(async function () {
        try {
          this.body = await DocstoreClient.updateDoc(
            this.project_id,
            this.doc_id,
            null,
            this.version,
            this.originalRanges
          )
        } catch (error) {
          statusCode = error.info.status
        }
      })

      it('should return 400', function () {
        statusCode.should.equal(400)
      })

      it('should not update the doc in the API', async function () {
        const doc = await DocstoreClient.getDoc(this.project_id, this.doc_id)
        doc.lines.should.deep.equal(this.originalLines)
      })
    })
  })

  describe('when no version is provided', function () {
    let statusCode
    beforeEach(async function () {
      try {
        this.body = await DocstoreClient.updateDoc(
          this.project_id,
          this.doc_id,
          this.originalLines,
          null,
          this.originalRanges
        )
      } catch (error) {
        statusCode = error.info.status
      }
    })

    it('should return 400', function () {
      statusCode.should.equal(400)
    })

    it('should not update the doc in the API', async function () {
      const doc = await DocstoreClient.getDoc(this.project_id, this.doc_id)
      doc.lines.should.deep.equal(this.originalLines)
      doc.version.should.equal(this.version)
    })
  })

  describe('when the content is large', function () {
    beforeEach(async function () {
      const line = new Array(1025).join('x') // 1kb
      this.largeLines = Array.apply(null, Array(1024)).map(() => line) // 1mb
      this.body = await DocstoreClient.updateDoc(
        this.project_id,
        this.doc_id,
        this.largeLines,
        this.version,
        this.originalRanges
      )
    })

    it('should return modified = true', function () {
      this.body.modified.should.equal(true)
    })

    it('should update the doc in the API', async function () {
      const doc = await DocstoreClient.getDoc(this.project_id, this.doc_id)
      doc.lines.should.deep.equal(this.largeLines)
    })
  })

  describe('when there is a large json payload', function () {
    beforeEach(async function () {
      const line = new Array(1025).join('x') // 1kb
      this.largeLines = Array.apply(null, Array(1024)).map(() => line) // 1kb
      this.originalRanges.padding = Array.apply(null, Array(2049)).map(
        () => line
      ) // 2mb + 1kb
      this.body = await DocstoreClient.updateDoc(
        this.project_id,
        this.doc_id,
        this.largeLines,
        this.version,
        this.originalRanges
      )
    })

    it('should return modified = true', function () {
      this.body.modified.should.equal(true)
    })

    it('should update the doc in the API', async function () {
      const doc = await DocstoreClient.getDoc(this.project_id, this.doc_id)
      doc.lines.should.deep.equal(this.largeLines)
    })
  })

  describe('when the document body is too large', function () {
    let statusCode, body
    beforeEach(async function () {
      const line = new Array(1025).join('x') // 1kb
      this.largeLines = Array.apply(null, Array(2049)).map(() => line) // 2mb + 1kb
      try {
        this.body = await DocstoreClient.updateDoc(
          this.project_id,
          this.doc_id,
          this.largeLines,
          this.version,
          this.originalRanges
        )
      } catch (error) {
        statusCode = error.info.status
        body = error.body
      }
    })

    it('should return 413', function () {
      statusCode.should.equal(413)
    })

    it('should report body too large', function () {
      body.should.equal('document body too large')
    })

    it('should not update the doc in the API', async function () {
      const doc = await DocstoreClient.getDoc(this.project_id, this.doc_id)
      doc.lines.should.deep.equal(this.originalLines)
    })
  })

  describe('when the json payload is too large', function () {
    beforeEach(async function () {
      const line = new Array(1024).join('x') // 1 KB
      this.largeLines = new Array(8192).fill(line) // 8 MB
      this.originalRanges.padding = new Array(6144).fill(line) // 6 MB

      try {
        this.body = await DocstoreClient.updateDoc(
          this.project_id,
          this.doc_id,
          this.largeLines,
          this.version,
          this.originalRanges
        )
      } catch (error) {
        // ignore error response
      }
    })

    it('should not update the doc in the API', async function () {
      const doc = await DocstoreClient.getDoc(this.project_id, this.doc_id)
      doc.lines.should.deep.equal(this.originalLines)
    })
  })
})