overleaf/services/docstore/test/unit/js/RangeManagerTests.js

256 lines
7 KiB
JavaScript
Raw Normal View History

/* eslint-disable
camelcase,
no-return-assign,
no-unused-vars,
*/
// 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
* Full docs: https://github.com/decaffeinate/decaffeinate/blob/master/docs/suggestions.md
*/
const SandboxedModule = require('sandboxed-module')
const sinon = require('sinon')
const { assert, expect } = require('chai')
const modulePath = require('path').join(
__dirname,
'../../../app/js/RangeManager'
)
const { ObjectId } = require('mongodb')
const _ = require('underscore')
2016-12-05 10:38:38 -05:00
2020-05-28 09:20:54 -04:00
describe('RangeManager', function () {
beforeEach(function () {
return (this.RangeManager = SandboxedModule.require(modulePath, {
requires: {
'./mongodb': {
2021-07-13 07:04:48 -04:00
ObjectId,
},
},
}))
})
2016-12-05 10:38:38 -05:00
2020-05-28 09:20:54 -04:00
describe('jsonRangesToMongo', function () {
it('should convert ObjectIds and dates to proper objects', function () {
const change_id = ObjectId().toString()
const comment_id = ObjectId().toString()
const user_id = ObjectId().toString()
const thread_id = ObjectId().toString()
const ts = new Date().toJSON()
return this.RangeManager.jsonRangesToMongo({
changes: [
{
id: change_id,
op: { i: 'foo', p: 3 },
metadata: {
user_id,
2021-07-13 07:04:48 -04:00
ts,
},
},
],
comments: [
{
id: comment_id,
2021-07-13 07:04:48 -04:00
op: { c: 'foo', p: 3, t: thread_id },
},
],
}).should.deep.equal({
changes: [
{
id: ObjectId(change_id),
op: { i: 'foo', p: 3 },
metadata: {
user_id: ObjectId(user_id),
2021-07-13 07:04:48 -04:00
ts: new Date(ts),
},
},
],
comments: [
{
id: ObjectId(comment_id),
2021-07-13 07:04:48 -04:00
op: { c: 'foo', p: 3, t: ObjectId(thread_id) },
},
],
})
})
2016-12-05 10:38:38 -05:00
2020-05-28 09:20:54 -04:00
it('should leave malformed ObjectIds as they are', function () {
const change_id = 'foo'
const comment_id = 'bar'
const user_id = 'baz'
return this.RangeManager.jsonRangesToMongo({
changes: [
{
id: change_id,
metadata: {
2021-07-13 07:04:48 -04:00
user_id,
},
},
],
comments: [
{
2021-07-13 07:04:48 -04:00
id: comment_id,
},
],
}).should.deep.equal({
changes: [
{
id: change_id,
metadata: {
2021-07-13 07:04:48 -04:00
user_id,
},
},
],
comments: [
{
2021-07-13 07:04:48 -04:00
id: comment_id,
},
],
})
})
2016-12-05 10:38:38 -05:00
2020-05-28 09:20:54 -04:00
return it('should be consistent when transformed through json -> mongo -> json', function () {
const change_id = ObjectId().toString()
const comment_id = ObjectId().toString()
const user_id = ObjectId().toString()
const thread_id = ObjectId().toString()
const ts = new Date().toJSON()
const ranges1 = {
changes: [
{
id: change_id,
op: { i: 'foo', p: 3 },
metadata: {
user_id,
2021-07-13 07:04:48 -04:00
ts,
},
},
],
comments: [
{
id: comment_id,
2021-07-13 07:04:48 -04:00
op: { c: 'foo', p: 3, t: thread_id },
},
],
}
const ranges1_copy = JSON.parse(JSON.stringify(ranges1)) // jsonRangesToMongo modifies in place
const ranges2 = JSON.parse(
JSON.stringify(this.RangeManager.jsonRangesToMongo(ranges1_copy))
)
return ranges1.should.deep.equal(ranges2)
})
})
2016-12-05 10:38:38 -05:00
2020-05-28 09:20:54 -04:00
return describe('shouldUpdateRanges', function () {
beforeEach(function () {
this.ranges = {
changes: [
{
id: ObjectId(),
op: { i: 'foo', p: 3 },
metadata: {
user_id: ObjectId(),
2021-07-13 07:04:48 -04:00
ts: new Date(),
},
},
],
comments: [
{
id: ObjectId(),
2021-07-13 07:04:48 -04:00
op: { c: 'foo', p: 3, t: ObjectId() },
},
],
}
return (this.ranges_copy = this.RangeManager.jsonRangesToMongo(
JSON.parse(JSON.stringify(this.ranges))
))
})
2016-12-05 10:38:38 -05:00
2020-05-28 09:20:54 -04:00
describe('with a blank new range', function () {
return it('should throw an error', function () {
return expect(() => {
return this.RangeManager.shouldUpdateRanges(this.ranges, null)
}).to.throw(Error)
})
})
2016-12-05 10:38:38 -05:00
2020-05-28 09:20:54 -04:00
describe('with a blank old range', function () {
return it('should treat it like {}', function () {
this.RangeManager.shouldUpdateRanges(null, {}).should.equal(false)
return this.RangeManager.shouldUpdateRanges(
null,
this.ranges
).should.equal(true)
})
})
2016-12-05 10:38:38 -05:00
2020-05-28 09:20:54 -04:00
describe('with no changes', function () {
return it('should return false', function () {
return this.RangeManager.shouldUpdateRanges(
this.ranges,
this.ranges_copy
).should.equal(false)
})
})
2016-12-05 10:38:38 -05:00
2020-05-28 09:20:54 -04:00
return describe('with changes', function () {
it('should return true when the change id changes', function () {
this.ranges_copy.changes[0].id = ObjectId()
return this.RangeManager.shouldUpdateRanges(
this.ranges,
this.ranges_copy
).should.equal(true)
})
2020-05-28 09:20:54 -04:00
it('should return true when the change user id changes', function () {
this.ranges_copy.changes[0].metadata.user_id = ObjectId()
return this.RangeManager.shouldUpdateRanges(
this.ranges,
this.ranges_copy
).should.equal(true)
})
2020-05-28 09:20:54 -04:00
it('should return true when the change ts changes', function () {
this.ranges_copy.changes[0].metadata.ts = new Date(Date.now() + 1000)
return this.RangeManager.shouldUpdateRanges(
this.ranges,
this.ranges_copy
).should.equal(true)
})
2020-05-28 09:20:54 -04:00
it('should return true when the change op changes', function () {
this.ranges_copy.changes[0].op.i = 'bar'
return this.RangeManager.shouldUpdateRanges(
this.ranges,
this.ranges_copy
).should.equal(true)
})
2020-05-28 09:20:54 -04:00
it('should return true when the comment id changes', function () {
this.ranges_copy.comments[0].id = ObjectId()
return this.RangeManager.shouldUpdateRanges(
this.ranges,
this.ranges_copy
).should.equal(true)
})
2020-05-28 09:20:54 -04:00
it('should return true when the comment offset changes', function () {
this.ranges_copy.comments[0].op.p = 17
return this.RangeManager.shouldUpdateRanges(
this.ranges,
this.ranges_copy
).should.equal(true)
})
2020-05-28 09:20:54 -04:00
return it('should return true when the comment content changes', function () {
this.ranges_copy.comments[0].op.c = 'bar'
return this.RangeManager.shouldUpdateRanges(
this.ranges,
this.ranges_copy
).should.equal(true)
})
})
})
})