overleaf/services/document-updater/test/acceptance/js/RangesTests.js

const sinon = require('sinon')
const { expect } = require('chai')
const async = require('async')

const { db, ObjectId } = require('../../../app/js/mongodb')
const MockWebApi = require('./helpers/MockWebApi')
const DocUpdaterClient = require('./helpers/DocUpdaterClient')
const DocUpdaterApp = require('./helpers/DocUpdaterApp')
const RangesManager = require('../../../app/js/RangesManager')

const sandbox = sinon.createSandbox()

describe('Ranges', function () {
  before(function (done) {
    DocUpdaterApp.ensureRunning(done)
  })

  describe('tracking changes from ops', function () {
    before(function (done) {
      this.project_id = DocUpdaterClient.randomId()
      this.user_id = DocUpdaterClient.randomId()
      this.id_seed = '587357bd35e64f6157'
      this.doc = {
        id: DocUpdaterClient.randomId(),
        lines: ['aaa'],
      }
      this.updates = [
        {
          doc: this.doc.id,
          op: [{ i: '123', p: 1 }],
          v: 0,
          meta: { user_id: this.user_id },
        },
        {
          doc: this.doc.id,
          op: [{ i: '456', p: 5 }],
          v: 1,
          meta: { user_id: this.user_id, tc: this.id_seed },
        },
        {
          doc: this.doc.id,
          op: [{ d: '12', p: 1 }],
          v: 2,
          meta: { user_id: this.user_id },
        },
      ]
      MockWebApi.insertDoc(this.project_id, this.doc.id, {
        lines: this.doc.lines,
        version: 0,
      })
      const jobs = []
      for (const update of this.updates) {
        jobs.push(callback =>
          DocUpdaterClient.sendUpdate(
            this.project_id,
            this.doc.id,
            update,
            callback
          )
        )
      }

      DocUpdaterApp.ensureRunning(error => {
        if (error != null) {
          throw error
        }
        DocUpdaterClient.preloadDoc(this.project_id, this.doc.id, error => {
          if (error != null) {
            throw error
          }
          async.series(jobs, error => {
            if (error != null) {
              throw error
            }
            done()
          })
        })
      })
    })

    it('should update the ranges', function (done) {
      DocUpdaterClient.getDoc(
        this.project_id,
        this.doc.id,
        (error, res, data) => {
          if (error != null) {
            throw error
          }
          const { ranges } = data
          const change = ranges.changes[0]
          change.op.should.deep.equal({ i: '456', p: 3 })
          change.id.should.equal(this.id_seed + '000001')
          change.metadata.user_id.should.equal(this.user_id)
          done()
        }
      )
    })

    describe('Adding comments', function () {
      describe('standalone', function () {
        before(function (done) {
          this.project_id = DocUpdaterClient.randomId()
          this.user_id = DocUpdaterClient.randomId()
          this.doc = {
            id: DocUpdaterClient.randomId(),
            lines: ['foo bar baz'],
          }
          this.updates = [
            {
              doc: this.doc.id,
              op: [
                { c: 'bar', p: 4, t: (this.tid = DocUpdaterClient.randomId()) },
              ],
              v: 0,
            },
          ]
          MockWebApi.insertDoc(this.project_id, this.doc.id, {
            lines: this.doc.lines,
            version: 0,
          })
          const jobs = []
          for (const update of this.updates) {
            jobs.push(callback =>
              DocUpdaterClient.sendUpdate(
                this.project_id,
                this.doc.id,
                update,
                callback
              )
            )
          }
          DocUpdaterClient.preloadDoc(this.project_id, this.doc.id, error => {
            if (error != null) {
              throw error
            }
            async.series(jobs, error => {
              if (error != null) {
                throw error
              }
              setTimeout(done, 200)
            })
          })
        })

        it('should update the ranges', function (done) {
          DocUpdaterClient.getDoc(
            this.project_id,
            this.doc.id,
            (error, res, data) => {
              if (error != null) {
                throw error
              }
              const { ranges } = data
              const comment = ranges.comments[0]
              comment.op.should.deep.equal({ c: 'bar', p: 4, t: this.tid })
              comment.id.should.equal(this.tid)
              done()
            }
          )
        })
      })

      describe('with conflicting ops needing OT', function () {
        before(function (done) {
          this.project_id = DocUpdaterClient.randomId()
          this.user_id = DocUpdaterClient.randomId()
          this.doc = {
            id: DocUpdaterClient.randomId(),
            lines: ['foo bar baz'],
          }
          this.updates = [
            {
              doc: this.doc.id,
              op: [{ i: 'ABC', p: 3 }],
              v: 0,
              meta: { user_id: this.user_id },
            },
            {
              doc: this.doc.id,
              op: [
                { c: 'bar', p: 4, t: (this.tid = DocUpdaterClient.randomId()) },
              ],
              v: 0,
            },
          ]
          MockWebApi.insertDoc(this.project_id, this.doc.id, {
            lines: this.doc.lines,
            version: 0,
          })
          const jobs = []
          for (const update of this.updates) {
            jobs.push(callback =>
              DocUpdaterClient.sendUpdate(
                this.project_id,
                this.doc.id,
                update,
                callback
              )
            )
          }
          DocUpdaterClient.preloadDoc(this.project_id, this.doc.id, error => {
            if (error != null) {
              throw error
            }
            async.series(jobs, error => {
              if (error != null) {
                throw error
              }
              setTimeout(done, 200)
            })
          })
        })

        it('should update the comments with the OT shifted comment', function (done) {
          DocUpdaterClient.getDoc(
            this.project_id,
            this.doc.id,
            (error, res, data) => {
              if (error != null) {
                throw error
              }
              const { ranges } = data
              const comment = ranges.comments[0]
              comment.op.should.deep.equal({ c: 'bar', p: 7, t: this.tid })
              done()
            }
          )
        })
      })
    })
  })

  describe('Loading ranges from persistence layer', function () {
    before(function (done) {
      this.project_id = DocUpdaterClient.randomId()
      this.user_id = DocUpdaterClient.randomId()
      this.id_seed = '587357bd35e64f6157'
      this.doc = {
        id: DocUpdaterClient.randomId(),
        lines: ['a123aa'],
      }
      this.update = {
        doc: this.doc.id,
        op: [{ i: '456', p: 5 }],
        v: 0,
        meta: { user_id: this.user_id, tc: this.id_seed },
      }
      MockWebApi.insertDoc(this.project_id, this.doc.id, {
        lines: this.doc.lines,
        version: 0,
        ranges: {
          changes: [
            {
              op: { i: '123', p: 1 },
              metadata: {
                user_id: this.user_id,
                ts: new Date(),
              },
            },
          ],
        },
      })
      DocUpdaterClient.preloadDoc(this.project_id, this.doc.id, error => {
        if (error != null) {
          throw error
        }
        DocUpdaterClient.sendUpdate(
          this.project_id,
          this.doc.id,
          this.update,
          error => {
            if (error != null) {
              throw error
            }
            setTimeout(done, 200)
          }
        )
      })
    })

    it('should have preloaded the existing ranges', function (done) {
      DocUpdaterClient.getDoc(
        this.project_id,
        this.doc.id,
        (error, res, data) => {
          if (error != null) {
            throw error
          }
          const { changes } = data.ranges
          changes[0].op.should.deep.equal({ i: '123', p: 1 })
          changes[1].op.should.deep.equal({ i: '456', p: 5 })
          done()
        }
      )
    })

    it('should flush the ranges to the persistence layer again', function (done) {
      DocUpdaterClient.flushDoc(this.project_id, this.doc.id, error => {
        if (error != null) {
          throw error
        }
        MockWebApi.getDocument(this.project_id, this.doc.id, (error, doc) => {
          if (error) return done(error)
          const { changes } = doc.ranges
          changes[0].op.should.deep.equal({ i: '123', p: 1 })
          changes[1].op.should.deep.equal({ i: '456', p: 5 })
          done()
        })
      })
    })
  })

  describe('accepting a change', function () {
    beforeEach(function (done) {
      sandbox.spy(MockWebApi, 'setDocument')
      this.project_id = DocUpdaterClient.randomId()
      this.user_id = DocUpdaterClient.randomId()
      this.id_seed = '587357bd35e64f6157'
      this.doc = {
        id: DocUpdaterClient.randomId(),
        lines: ['aaa'],
      }
      this.update = {
        doc: this.doc.id,
        op: [{ i: '456', p: 1 }],
        v: 0,
        meta: { user_id: this.user_id, tc: this.id_seed },
      }
      MockWebApi.insertDoc(this.project_id, this.doc.id, {
        lines: this.doc.lines,
        version: 0,
      })
      DocUpdaterClient.preloadDoc(this.project_id, this.doc.id, error => {
        if (error != null) {
          throw error
        }
        DocUpdaterClient.sendUpdate(
          this.project_id,
          this.doc.id,
          this.update,
          error => {
            if (error != null) {
              throw error
            }
            setTimeout(() => {
              DocUpdaterClient.getDoc(
                this.project_id,
                this.doc.id,
                (error, res, data) => {
                  if (error != null) {
                    throw error
                  }
                  const { ranges } = data
                  const change = ranges.changes[0]
                  change.op.should.deep.equal({ i: '456', p: 1 })
                  change.id.should.equal(this.id_seed + '000001')
                  change.metadata.user_id.should.equal(this.user_id)
                  done()
                }
              )
            }, 200)
          }
        )
      })
    })
    afterEach(function () {
      sandbox.restore()
    })

    it('should remove the change after accepting', function (done) {
      DocUpdaterClient.acceptChange(
        this.project_id,
        this.doc.id,
        this.id_seed + '000001',
        error => {
          if (error != null) {
            throw error
          }
          DocUpdaterClient.getDoc(
            this.project_id,
            this.doc.id,
            (error, res, data) => {
              if (error != null) {
                throw error
              }
              expect(data.ranges.changes).to.be.undefined
              done()
            }
          )
        }
      )
    })

    it('should persist the ranges after accepting', function (done) {
      DocUpdaterClient.flushDoc(this.project_id, this.doc.id, err => {
        if (err) return done(err)
        DocUpdaterClient.acceptChange(
          this.project_id,
          this.doc.id,
          this.id_seed + '000001',
          error => {
            if (error != null) {
              throw error
            }

            DocUpdaterClient.flushDoc(this.project_id, this.doc.id, err => {
              if (err) return done(err)
              DocUpdaterClient.getDoc(
                this.project_id,
                this.doc.id,
                (error, res, data) => {
                  if (error != null) {
                    throw error
                  }
                  expect(data.ranges.changes).to.be.undefined

                  MockWebApi.setDocument
                    .calledWith(this.project_id, this.doc.id, ['a456aa'], 1, {})
                    .should.equal(true)
                  done()
                }
              )
            })
          }
        )
      })
    })
  })

  describe('accepting multiple changes', function () {
    beforeEach(function (done) {
      this.getHistoryUpdatesSpy = sandbox.spy(
        RangesManager,
        'getHistoryUpdatesForAcceptedChanges'
      )

      this.project_id = DocUpdaterClient.randomId()
      this.user_id = DocUpdaterClient.randomId()
      this.doc = {
        id: DocUpdaterClient.randomId(),
        lines: ['aaa', 'bbb', 'ccc', 'ddd', 'eee'],
      }

      DocUpdaterClient.enableHistoryRangesSupport(this.doc.id, (error, res) => {
        if (error) {
          throw error
        }
        MockWebApi.insertDoc(this.project_id, this.doc.id, {
          lines: this.doc.lines,
          version: 0,
        })

        DocUpdaterClient.preloadDoc(this.project_id, this.doc.id, error => {
          if (error != null) {
            throw error
          }

          this.id_seed_1 = 'tc_1'
          this.id_seed_2 = 'tc_2'
          this.id_seed_3 = 'tc_3'

          this.updates = [
            {
              doc: this.doc.id,
              op: [{ d: 'bbb', p: 4 }],
              v: 0,
              meta: {
                user_id: this.user_id,
                tc: this.id_seed_1,
              },
            },
            {
              doc: this.doc.id,
              op: [{ d: 'ccc', p: 5 }],
              v: 1,
              meta: {
                user_id: this.user_id,
                tc: this.id_seed_2,
              },
            },
            {
              doc: this.doc.id,
              op: [{ d: 'ddd', p: 6 }],
              v: 2,
              meta: {
                user_id: this.user_id,
                tc: this.id_seed_3,
              },
            },
          ]

          DocUpdaterClient.sendUpdates(
            this.project_id,
            this.doc.id,
            this.updates,
            error => {
              if (error != null) {
                throw error
              }
              setTimeout(() => {
                DocUpdaterClient.getDoc(
                  this.project_id,
                  this.doc.id,
                  (error, res, data) => {
                    if (error != null) {
                      throw error
                    }
                    const { ranges } = data
                    const changeOps = ranges.changes
                      .map(change => change.op)
                      .flat()
                    changeOps.should.deep.equal([
                      { d: 'bbb', p: 4 },
                      { d: 'ccc', p: 5 },
                      { d: 'ddd', p: 6 },
                    ])
                    done()
                  }
                )
              }, 200)
            }
          )
        })
      })
    })
    afterEach(function () {
      sandbox.restore()
    })

    it('accepting changes in order', function (done) {
      DocUpdaterClient.acceptChanges(
        this.project_id,
        this.doc.id,
        [
          this.id_seed_1 + '000001',
          this.id_seed_2 + '000001',
          this.id_seed_3 + '000001',
        ],
        error => {
          if (error != null) {
            throw error
          }

          const historyUpdates = this.getHistoryUpdatesSpy.returnValues[0]
          expect(historyUpdates[0]).to.deep.equal({
            doc: this.doc.id,
            meta: {
              pathname: '/a/b/c.tex',
              doc_length: 10,
              history_doc_length: 19,
              ts: historyUpdates[0].meta.ts,
              user_id: this.user_id,
            },
            op: [{ p: 4, d: 'bbb' }],
          })

          expect(historyUpdates[1]).to.deep.equal({
            doc: this.doc.id,
            meta: {
              pathname: '/a/b/c.tex',
              doc_length: 10,
              history_doc_length: 16,
              ts: historyUpdates[1].meta.ts,
              user_id: this.user_id,
            },
            op: [{ p: 5, d: 'ccc' }],
          })

          expect(historyUpdates[2]).to.deep.equal({
            doc: this.doc.id,
            meta: {
              pathname: '/a/b/c.tex',
              doc_length: 10,
              history_doc_length: 13,
              ts: historyUpdates[2].meta.ts,
              user_id: this.user_id,
            },
            op: [{ p: 6, d: 'ddd' }],
          })

          done()
        }
      )
    })

    it('accepting changes in reverse order', function (done) {
      DocUpdaterClient.acceptChanges(
        this.project_id,
        this.doc.id,
        [
          this.id_seed_3 + '000001',
          this.id_seed_2 + '000001',
          this.id_seed_1 + '000001',
        ],
        error => {
          if (error != null) {
            throw error
          }

          const historyUpdates = this.getHistoryUpdatesSpy.returnValues[0]
          expect(historyUpdates[0]).to.deep.equal({
            doc: this.doc.id,
            meta: {
              pathname: '/a/b/c.tex',
              doc_length: 10,
              history_doc_length: 19,
              ts: historyUpdates[0].meta.ts,
              user_id: this.user_id,
            },
            op: [{ p: 4, d: 'bbb' }],
          })

          expect(historyUpdates[1]).to.deep.equal({
            doc: this.doc.id,
            meta: {
              pathname: '/a/b/c.tex',
              doc_length: 10,
              history_doc_length: 16,
              ts: historyUpdates[1].meta.ts,
              user_id: this.user_id,
            },
            op: [{ p: 5, d: 'ccc' }],
          })

          expect(historyUpdates[2]).to.deep.equal({
            doc: this.doc.id,
            meta: {
              pathname: '/a/b/c.tex',
              doc_length: 10,
              history_doc_length: 13,
              ts: historyUpdates[2].meta.ts,
              user_id: this.user_id,
            },
            op: [{ p: 6, d: 'ddd' }],
          })

          done()
        }
      )
    })
  })

  describe('deleting a comment range', function () {
    before(function (done) {
      this.project_id = DocUpdaterClient.randomId()
      this.user_id = DocUpdaterClient.randomId()
      this.doc = {
        id: DocUpdaterClient.randomId(),
        lines: ['foo bar'],
      }
      this.update = {
        doc: this.doc.id,
        op: [{ c: 'bar', p: 4, t: (this.tid = DocUpdaterClient.randomId()) }],
        v: 0,
      }
      MockWebApi.insertDoc(this.project_id, this.doc.id, {
        lines: this.doc.lines,
        version: 0,
      })
      DocUpdaterClient.preloadDoc(this.project_id, this.doc.id, error => {
        if (error != null) {
          throw error
        }
        DocUpdaterClient.sendUpdate(
          this.project_id,
          this.doc.id,
          this.update,
          error => {
            if (error != null) {
              throw error
            }
            setTimeout(() => {
              DocUpdaterClient.getDoc(
                this.project_id,
                this.doc.id,
                (error, res, data) => {
                  if (error != null) {
                    throw error
                  }
                  const { ranges } = data
                  const change = ranges.comments[0]
                  change.op.should.deep.equal({ c: 'bar', p: 4, t: this.tid })
                  change.id.should.equal(this.tid)
                  done()
                }
              )
            }, 200)
          }
        )
      })
    })

    it('should remove the comment range', function (done) {
      DocUpdaterClient.removeComment(
        this.project_id,
        this.doc.id,
        this.tid,
        (error, res) => {
          if (error != null) {
            throw error
          }
          expect(res.statusCode).to.equal(204)
          DocUpdaterClient.getDoc(
            this.project_id,
            this.doc.id,
            (error, res, data) => {
              if (error != null) {
                throw error
              }
              expect(data.ranges.comments).to.be.undefined
              done()
            }
          )
        }
      )
    })
  })

  describe('tripping range size limit', function () {
    before(function (done) {
      this.project_id = DocUpdaterClient.randomId()
      this.user_id = DocUpdaterClient.randomId()
      this.id_seed = DocUpdaterClient.randomId()
      this.doc = {
        id: DocUpdaterClient.randomId(),
        lines: ['aaa'],
      }
      this.i = new Array(3 * 1024 * 1024).join('a')
      this.updates = [
        {
          doc: this.doc.id,
          op: [{ i: this.i, p: 1 }],
          v: 0,
          meta: { user_id: this.user_id, tc: this.id_seed },
        },
      ]
      MockWebApi.insertDoc(this.project_id, this.doc.id, {
        lines: this.doc.lines,
        version: 0,
      })
      const jobs = []
      for (const update of this.updates) {
        jobs.push(callback =>
          DocUpdaterClient.sendUpdate(
            this.project_id,
            this.doc.id,
            update,
            callback
          )
        )
      }
      DocUpdaterClient.preloadDoc(this.project_id, this.doc.id, error => {
        if (error != null) {
          throw error
        }
        async.series(jobs, error => {
          if (error != null) {
            throw error
          }
          setTimeout(done, 200)
        })
      })
    })

    it('should not update the ranges', function (done) {
      DocUpdaterClient.getDoc(
        this.project_id,
        this.doc.id,
        (error, res, data) => {
          if (error != null) {
            throw error
          }
          const { ranges } = data
          expect(ranges.changes).to.be.undefined
          done()
        }
      )
    })
  })

  describe('deleting text surrounding a comment', function () {
    before(function (done) {
      this.project_id = DocUpdaterClient.randomId()
      this.user_id = DocUpdaterClient.randomId()
      this.doc_id = DocUpdaterClient.randomId()
      MockWebApi.insertDoc(this.project_id, this.doc_id, {
        lines: ['foo bar baz'],
        version: 0,
        ranges: {
          comments: [
            {
              op: {
                c: 'a',
                p: 5,
                tid: (this.tid = DocUpdaterClient.randomId()),
              },
              metadata: {
                user_id: this.user_id,
                ts: new Date(),
              },
            },
          ],
        },
      })
      this.updates = [
        {
          doc: this.doc_id,
          op: [{ d: 'foo ', p: 0 }],
          v: 0,
          meta: { user_id: this.user_id },
        },
        {
          doc: this.doc_id,
          op: [{ d: 'bar ', p: 0 }],
          v: 1,
          meta: { user_id: this.user_id },
        },
      ]
      const jobs = []
      for (const update of this.updates) {
        jobs.push(callback =>
          DocUpdaterClient.sendUpdate(
            this.project_id,
            this.doc_id,
            update,
            callback
          )
        )
      }
      DocUpdaterClient.preloadDoc(this.project_id, this.doc_id, error => {
        if (error != null) {
          throw error
        }
        async.series(jobs, function (error) {
          if (error != null) {
            throw error
          }
          setTimeout(() => {
            DocUpdaterClient.getDoc(
              this.project_id,
              this.doc_id,
              (error, res, data) => {
                if (error != null) {
                  throw error
                }
                done()
              }
            )
          }, 200)
        })
      })
    })

    it('should write a snapshot from before the destructive change', function (done) {
      DocUpdaterClient.getDoc(
        this.project_id,
        this.doc_id,
        (error, res, data) => {
          if (error != null) {
            return done(error)
          }
          db.docSnapshots
            .find({
              project_id: new ObjectId(this.project_id),
              doc_id: new ObjectId(this.doc_id),
            })
            .toArray((error, docSnapshots) => {
              if (error != null) {
                return done(error)
              }
              expect(docSnapshots.length).to.equal(1)
              expect(docSnapshots[0].version).to.equal(1)
              expect(docSnapshots[0].lines).to.deep.equal(['bar baz'])
              expect(docSnapshots[0].ranges.comments[0].op).to.deep.equal({
                c: 'a',
                p: 1,
                tid: this.tid,
              })
              done()
            })
        }
      )
    })
  })
})