Use history snapshot when doing file/project restore (#28502)
* Add getDocUpdaterCompatibleRanges utility function * use history snapshot for file/project restore * move overleaf-editor-core from devDependencies GitOrigin-RevId: 62481a5304ada9d931e018418be3c0719bccf1f3
This commit is contained in:
Domagoj Kriskovic
committed by
Copybot
Copybot
parent
a6e9a5c7e9
commit
484a01a173
@@ -46,6 +46,9 @@ const CommentList = require('./lib/file_data/comment_list')
|
||||
const LazyStringFileData = require('./lib/file_data/lazy_string_file_data')
|
||||
const StringFileData = require('./lib/file_data/string_file_data')
|
||||
const EditOperationBuilder = require('./lib/operation/edit_operation_builder')
|
||||
const {
|
||||
getDocUpdaterCompatibleRanges,
|
||||
} = require('./lib/doc_updater_compatible_ranges')
|
||||
|
||||
exports.AddCommentOperation = AddCommentOperation
|
||||
exports.Author = Author
|
||||
@@ -93,3 +96,4 @@ exports.TrackedChange = TrackedChange
|
||||
exports.Range = Range
|
||||
exports.CommentList = CommentList
|
||||
exports.TrackingProps = TrackingProps
|
||||
exports.getDocUpdaterCompatibleRanges = getDocUpdaterCompatibleRanges
|
||||
|
||||
@@ -0,0 +1,150 @@
|
||||
// @ts-check
|
||||
'use strict'
|
||||
|
||||
/**
|
||||
* @import File from "./file"
|
||||
*/
|
||||
|
||||
/**
|
||||
* Constructs tracked changes and comments in a document-updater compatible format.
|
||||
* Positions will be relative to a document where tracked deletes have been
|
||||
* removed from the string. This also means that if a tracked delete overlaps
|
||||
* a comment range, the comment range will be truncated.
|
||||
*
|
||||
* @param {File} file
|
||||
*/
|
||||
function getDocUpdaterCompatibleRanges(file) {
|
||||
if (!file.isEditable()) {
|
||||
// A binary file has no tracked changes or comments
|
||||
return {
|
||||
changes: [],
|
||||
comments: [],
|
||||
}
|
||||
}
|
||||
|
||||
const content = file.getContent()
|
||||
if (content == null) {
|
||||
throw new Error('Unable to read file contents')
|
||||
}
|
||||
|
||||
const trackedChanges = file.getTrackedChanges().asSorted()
|
||||
const comments = file.getComments().toArray()
|
||||
const docUpdaterCompatibleTrackedChanges = []
|
||||
|
||||
let trackedDeletionOffset = 0
|
||||
for (const trackedChange of trackedChanges) {
|
||||
const isTrackedDeletion = trackedChange.tracking.type === 'delete'
|
||||
const trackedChangeContent = content.slice(
|
||||
trackedChange.range.start,
|
||||
trackedChange.range.end
|
||||
)
|
||||
const tcContent = isTrackedDeletion
|
||||
? { d: trackedChangeContent }
|
||||
: { i: trackedChangeContent }
|
||||
docUpdaterCompatibleTrackedChanges.push({
|
||||
op: {
|
||||
p: trackedChange.range.start - trackedDeletionOffset,
|
||||
...tcContent,
|
||||
},
|
||||
metadata: {
|
||||
ts: trackedChange.tracking.ts.toISOString(),
|
||||
user_id: trackedChange.tracking.userId,
|
||||
},
|
||||
})
|
||||
if (isTrackedDeletion) {
|
||||
trackedDeletionOffset += trackedChange.range.length
|
||||
}
|
||||
}
|
||||
|
||||
// Comments are shifted left by the length of any previous tracked deletions.
|
||||
// If they overlap with a tracked deletion, they are truncated.
|
||||
//
|
||||
// Example:
|
||||
// { } comment
|
||||
// [ ] tracked deletion
|
||||
// the quic[k {b]rown [fox] jum[ps} ove]r the lazy dog
|
||||
// => rown jum
|
||||
// starting at position 8
|
||||
const trackedDeletions = trackedChanges.filter(
|
||||
tc => tc.tracking.type === 'delete'
|
||||
)
|
||||
const docUpdaterCompatibleComments = []
|
||||
for (const comment of comments) {
|
||||
let trackedDeletionIndex = 0
|
||||
if (comment.ranges.length === 0) {
|
||||
// Translate detached comments into zero length comments at position 0
|
||||
docUpdaterCompatibleComments.push({
|
||||
op: {
|
||||
p: 0,
|
||||
c: '',
|
||||
t: comment.id,
|
||||
resolved: comment.resolved,
|
||||
},
|
||||
})
|
||||
continue
|
||||
}
|
||||
|
||||
// Consider a multiple range comment as a single comment that joins all its
|
||||
// ranges
|
||||
const commentStart = comment.ranges[0].start
|
||||
const commentEnd = comment.ranges[comment.ranges.length - 1].end
|
||||
|
||||
let commentContent = ''
|
||||
// Docupdater position
|
||||
let position = commentStart
|
||||
while (trackedDeletions[trackedDeletionIndex]?.range.end <= commentStart) {
|
||||
// Skip over tracked deletions that are before the current comment range
|
||||
position -= trackedDeletions[trackedDeletionIndex].range.length
|
||||
trackedDeletionIndex++
|
||||
}
|
||||
|
||||
if (trackedDeletions[trackedDeletionIndex]?.range.start < commentStart) {
|
||||
// There's overlap with a tracked deletion, move the position left and
|
||||
// truncate the overlap
|
||||
position -=
|
||||
commentStart - trackedDeletions[trackedDeletionIndex].range.start
|
||||
}
|
||||
|
||||
// Cursor in the history content
|
||||
let cursor = commentStart
|
||||
while (cursor < commentEnd) {
|
||||
const trackedDeletion = trackedDeletions[trackedDeletionIndex]
|
||||
if (!trackedDeletion || trackedDeletion.range.start >= commentEnd) {
|
||||
// We've run out of relevant tracked changes
|
||||
commentContent += content.slice(cursor, commentEnd)
|
||||
break
|
||||
}
|
||||
if (trackedDeletion.range.start > cursor) {
|
||||
// There's a gap between the current cursor and the tracked deletion
|
||||
commentContent += content.slice(cursor, trackedDeletion.range.start)
|
||||
}
|
||||
|
||||
if (trackedDeletion.range.end <= commentEnd) {
|
||||
// Skip to the end of the tracked delete
|
||||
cursor = trackedDeletion.range.end
|
||||
trackedDeletionIndex++
|
||||
} else {
|
||||
// We're done with that comment
|
||||
break
|
||||
}
|
||||
}
|
||||
docUpdaterCompatibleComments.push({
|
||||
op: {
|
||||
p: position,
|
||||
c: commentContent,
|
||||
t: comment.id,
|
||||
resolved: comment.resolved,
|
||||
},
|
||||
id: comment.id,
|
||||
})
|
||||
}
|
||||
|
||||
return {
|
||||
changes: docUpdaterCompatibleTrackedChanges,
|
||||
comments: docUpdaterCompatibleComments,
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = {
|
||||
getDocUpdaterCompatibleRanges,
|
||||
}
|
||||
@@ -0,0 +1,397 @@
|
||||
'use strict'
|
||||
|
||||
const { expect } = require('chai')
|
||||
const {
|
||||
getDocUpdaterCompatibleRanges,
|
||||
} = require('../lib/doc_updater_compatible_ranges.js')
|
||||
const StringFileData = require('../lib/file_data/string_file_data.js')
|
||||
const File = require('../lib/file.js')
|
||||
|
||||
describe('getDocUpdaterCompatibleRanges', function () {
|
||||
describe('with tracked deletes', function () {
|
||||
beforeEach(function () {
|
||||
this.content = 'the quick brown fox jumps over the lazy dog'
|
||||
this.trackedChanges = [
|
||||
{
|
||||
range: { pos: 4, length: 6 }, // 'quick '
|
||||
tracking: {
|
||||
type: 'delete',
|
||||
userId: '31',
|
||||
ts: '2023-01-01T00:00:00.000Z',
|
||||
},
|
||||
},
|
||||
{
|
||||
range: { pos: 16, length: 4 }, // 'fox '
|
||||
tracking: {
|
||||
type: 'delete',
|
||||
userId: '31',
|
||||
ts: '2023-01-01T00:00:00.000Z',
|
||||
},
|
||||
},
|
||||
{
|
||||
range: { pos: 35, length: 5 }, // 'lazy '
|
||||
tracking: {
|
||||
type: 'insert',
|
||||
userId: '31',
|
||||
ts: '2023-01-01T00:00:00.000Z',
|
||||
},
|
||||
},
|
||||
{
|
||||
range: { pos: 40, length: 3 }, // 'dog'
|
||||
tracking: {
|
||||
type: 'delete',
|
||||
userId: '31',
|
||||
ts: '2023-01-01T00:00:00.000Z',
|
||||
},
|
||||
},
|
||||
]
|
||||
})
|
||||
|
||||
it("doesn't shift the tracked delete by itself", function () {
|
||||
const fileData = new StringFileData(this.content, [], this.trackedChanges)
|
||||
const file = new File(fileData)
|
||||
|
||||
const result = getDocUpdaterCompatibleRanges(file)
|
||||
|
||||
expect(result.changes[0].op.p).to.eq(4)
|
||||
})
|
||||
|
||||
it('should move subsequent tracked changes by the length of previous deletes', function () {
|
||||
const fileData = new StringFileData(this.content, [], this.trackedChanges)
|
||||
const file = new File(fileData)
|
||||
|
||||
const result = getDocUpdaterCompatibleRanges(file)
|
||||
|
||||
expect(result.changes[1].op.p).to.eq(16 - 6)
|
||||
expect(result.changes[2].op.p).to.eq(35 - 6 - 4)
|
||||
})
|
||||
|
||||
it("shouldn't move subsequent tracked changes by previous inserts", function () {
|
||||
const fileData = new StringFileData(this.content, [], this.trackedChanges)
|
||||
const file = new File(fileData)
|
||||
|
||||
const result = getDocUpdaterCompatibleRanges(file)
|
||||
|
||||
expect(result.changes[3].op.p).to.eq(40 - 6 - 4)
|
||||
})
|
||||
})
|
||||
|
||||
describe('with comments and tracked deletes', function () {
|
||||
beforeEach(function () {
|
||||
this.content = 'the quick brown fox jumps over the lazy dog'
|
||||
this.trackedChanges = [
|
||||
{
|
||||
range: { pos: 2, length: 5 }, // 'e qui'
|
||||
tracking: {
|
||||
type: 'delete',
|
||||
userId: '31',
|
||||
ts: '2023-01-01T00:00:00.000Z',
|
||||
},
|
||||
},
|
||||
{
|
||||
range: { pos: 11, length: 1 }, // 'r'
|
||||
tracking: {
|
||||
type: 'delete',
|
||||
userId: '31',
|
||||
ts: '2023-01-01T00:00:00.000Z',
|
||||
},
|
||||
},
|
||||
{
|
||||
range: { pos: 28, length: 9 }, // 'er the la'
|
||||
tracking: {
|
||||
type: 'delete',
|
||||
userId: '31',
|
||||
ts: '2023-01-01T00:00:00.000Z',
|
||||
},
|
||||
},
|
||||
]
|
||||
})
|
||||
|
||||
it('should move the comment to the start of the tracked delete and remove overlapping text', function () {
|
||||
const comments = [
|
||||
{
|
||||
id: 'comment-1',
|
||||
ranges: [
|
||||
{ pos: 4, length: 5 }, // 'quick'
|
||||
{ pos: 10, length: 5 }, // 'brown'
|
||||
{ pos: 26, length: 4 }, // 'over'
|
||||
{ pos: 35, length: 4 }, // 'lazy'
|
||||
],
|
||||
resolved: false,
|
||||
},
|
||||
]
|
||||
|
||||
const fileData = new StringFileData(
|
||||
this.content,
|
||||
comments,
|
||||
this.trackedChanges
|
||||
)
|
||||
const file = new File(fileData)
|
||||
|
||||
const result = getDocUpdaterCompatibleRanges(file)
|
||||
|
||||
expect(result.comments[0].op.p).to.eq(2)
|
||||
expect(result.comments[0].op.c).to.eq('ck bown fox jumps ovzy')
|
||||
})
|
||||
|
||||
it('should put resolved status in op', function () {
|
||||
const comments = [
|
||||
{
|
||||
id: 'comment-1',
|
||||
ranges: [
|
||||
{ pos: 4, length: 5 }, // 'quick'
|
||||
{ pos: 10, length: 5 }, // 'brown'
|
||||
{ pos: 26, length: 4 }, // 'over'
|
||||
{ pos: 35, length: 4 }, // 'lazy'
|
||||
],
|
||||
resolved: false,
|
||||
},
|
||||
{ id: 'comment-2', ranges: [], resolved: true },
|
||||
{
|
||||
id: 'comment-3',
|
||||
ranges: [{ pos: 4, length: 1 }], // 'q'
|
||||
resolved: true,
|
||||
},
|
||||
]
|
||||
|
||||
const fileData = new StringFileData(
|
||||
this.content,
|
||||
comments,
|
||||
this.trackedChanges
|
||||
)
|
||||
const file = new File(fileData)
|
||||
|
||||
const result = getDocUpdaterCompatibleRanges(file)
|
||||
|
||||
expect(result.comments[0].op.resolved).to.be.false
|
||||
expect(result.comments[1].op.resolved).to.be.true
|
||||
expect(result.comments[2].op.resolved).to.be.true
|
||||
})
|
||||
|
||||
it('should include thread id', function () {
|
||||
const comments = [
|
||||
{
|
||||
id: 'comment-1',
|
||||
ranges: [
|
||||
{ pos: 4, length: 5 }, // 'quick'
|
||||
{ pos: 10, length: 5 }, // 'brown'
|
||||
{ pos: 26, length: 4 }, // 'over'
|
||||
{ pos: 35, length: 4 }, // 'lazy'
|
||||
],
|
||||
resolved: false,
|
||||
},
|
||||
{ id: 'comment-2', ranges: [], resolved: true },
|
||||
{
|
||||
id: 'comment-3',
|
||||
ranges: [{ pos: 4, length: 1 }], // 'q'
|
||||
resolved: true,
|
||||
},
|
||||
]
|
||||
|
||||
const fileData = new StringFileData(
|
||||
this.content,
|
||||
comments,
|
||||
this.trackedChanges
|
||||
)
|
||||
const file = new File(fileData)
|
||||
|
||||
const result = getDocUpdaterCompatibleRanges(file)
|
||||
|
||||
expect(result.comments[0].op.t).to.eq('comment-1')
|
||||
expect(result.comments[1].op.t).to.eq('comment-2')
|
||||
expect(result.comments[2].op.t).to.eq('comment-3')
|
||||
})
|
||||
|
||||
it('should translate detached comment to zero length op', function () {
|
||||
const comments = [
|
||||
{
|
||||
id: 'comment-1',
|
||||
ranges: [
|
||||
{ pos: 4, length: 5 }, // 'quick'
|
||||
{ pos: 10, length: 5 }, // 'brown'
|
||||
{ pos: 26, length: 4 }, // 'over'
|
||||
{ pos: 35, length: 4 }, // 'lazy'
|
||||
],
|
||||
resolved: false,
|
||||
},
|
||||
{ id: 'comment-2', ranges: [], resolved: true }, // detached comment
|
||||
{
|
||||
id: 'comment-3',
|
||||
ranges: [{ pos: 4, length: 1 }], // 'q'
|
||||
resolved: true,
|
||||
},
|
||||
]
|
||||
|
||||
const fileData = new StringFileData(
|
||||
this.content,
|
||||
comments,
|
||||
this.trackedChanges
|
||||
)
|
||||
const file = new File(fileData)
|
||||
|
||||
const result = getDocUpdaterCompatibleRanges(file)
|
||||
|
||||
expect(result.comments[1].op.p).to.eq(0)
|
||||
expect(result.comments[1].op.c).to.eq('')
|
||||
})
|
||||
|
||||
it('should position a comment entirely in a tracked delete next to the tracked delete', function () {
|
||||
const comments = [
|
||||
{
|
||||
id: 'comment-1',
|
||||
ranges: [
|
||||
{ pos: 4, length: 5 }, // 'quick'
|
||||
{ pos: 10, length: 5 }, // 'brown'
|
||||
{ pos: 26, length: 4 }, // 'over'
|
||||
{ pos: 35, length: 4 }, // 'lazy'
|
||||
],
|
||||
resolved: false,
|
||||
},
|
||||
{ id: 'comment-2', ranges: [], resolved: true },
|
||||
{
|
||||
id: 'comment-3',
|
||||
ranges: [{ pos: 4, length: 1 }], // 'q' - entirely in tracked delete
|
||||
resolved: true,
|
||||
},
|
||||
]
|
||||
|
||||
const fileData = new StringFileData(
|
||||
this.content,
|
||||
comments,
|
||||
this.trackedChanges
|
||||
)
|
||||
const file = new File(fileData)
|
||||
|
||||
const result = getDocUpdaterCompatibleRanges(file)
|
||||
|
||||
expect(result.comments[2].op.p).to.eq(2)
|
||||
expect(result.comments[2].op.c).to.eq('')
|
||||
})
|
||||
})
|
||||
|
||||
describe('with multiple tracked changes and comments', function () {
|
||||
it('returns the ranges with content and adjusted positions to ignore tracked deletes', function () {
|
||||
const content = 'the quick brown fox jumps over the lazy dog'
|
||||
const trackedChanges = [
|
||||
{
|
||||
range: { pos: 4, length: 6 }, // 'quick '
|
||||
tracking: {
|
||||
type: 'delete',
|
||||
userId: '31',
|
||||
ts: '2023-01-01T00:00:00.000Z',
|
||||
},
|
||||
},
|
||||
{
|
||||
range: { pos: 10, length: 6 }, // 'brown '
|
||||
tracking: {
|
||||
type: 'insert',
|
||||
userId: '31',
|
||||
ts: '2024-01-01T00:00:00.000Z',
|
||||
},
|
||||
},
|
||||
{
|
||||
range: { pos: 35, length: 5 }, // 'lazy '
|
||||
tracking: {
|
||||
type: 'delete',
|
||||
userId: '31',
|
||||
ts: '2024-01-01T00:00:00.000Z',
|
||||
},
|
||||
},
|
||||
]
|
||||
|
||||
const comments = [
|
||||
{
|
||||
id: 'comment-1',
|
||||
ranges: [
|
||||
{ pos: 4, length: 5 }, // 'quick'
|
||||
{ pos: 10, length: 5 }, // 'brown'
|
||||
{ pos: 35, length: 4 }, // 'lazy'
|
||||
],
|
||||
resolved: false,
|
||||
},
|
||||
{
|
||||
id: 'comment-2',
|
||||
ranges: [
|
||||
{ pos: 0, length: 3 }, // 'the'
|
||||
{ pos: 31, length: 3 }, // 'the'
|
||||
],
|
||||
resolved: true,
|
||||
},
|
||||
]
|
||||
|
||||
const fileData = new StringFileData(content, comments, trackedChanges)
|
||||
const file = new File(fileData)
|
||||
|
||||
const result = getDocUpdaterCompatibleRanges(file)
|
||||
|
||||
expect(result).to.deep.equal({
|
||||
changes: [
|
||||
{
|
||||
metadata: {
|
||||
ts: '2023-01-01T00:00:00.000Z',
|
||||
user_id: '31',
|
||||
},
|
||||
op: {
|
||||
d: 'quick ',
|
||||
p: 4,
|
||||
},
|
||||
},
|
||||
{
|
||||
metadata: {
|
||||
ts: '2024-01-01T00:00:00.000Z',
|
||||
user_id: '31',
|
||||
},
|
||||
op: {
|
||||
i: 'brown ',
|
||||
p: 4,
|
||||
},
|
||||
},
|
||||
{
|
||||
metadata: {
|
||||
ts: '2024-01-01T00:00:00.000Z',
|
||||
user_id: '31',
|
||||
},
|
||||
op: {
|
||||
d: 'lazy ',
|
||||
p: 29,
|
||||
},
|
||||
},
|
||||
],
|
||||
comments: [
|
||||
{
|
||||
op: {
|
||||
c: 'brown fox jumps over the ',
|
||||
p: 4,
|
||||
t: 'comment-1',
|
||||
resolved: false,
|
||||
},
|
||||
id: 'comment-1',
|
||||
},
|
||||
{
|
||||
op: {
|
||||
c: 'the brown fox jumps over the',
|
||||
p: 0,
|
||||
t: 'comment-2',
|
||||
resolved: true,
|
||||
},
|
||||
id: 'comment-2',
|
||||
},
|
||||
],
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
describe('with an empty file', function () {
|
||||
it('should return empty comments and changes', function () {
|
||||
const fileData = new StringFileData('', [])
|
||||
const file = new File(fileData)
|
||||
|
||||
const result = getDocUpdaterCompatibleRanges(file)
|
||||
|
||||
expect(result).to.deep.equal({
|
||||
changes: [],
|
||||
comments: [],
|
||||
})
|
||||
})
|
||||
})
|
||||
})
|
||||
Reference in New Issue
Block a user