| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503 |
- /**
- * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md.
- */
- import transformations from '../../../../src/model/delta/basic-transformations'; // eslint-disable-line no-unused-vars
- import deltaTransform from '../../../../src/model/delta/transform';
- const transformDeltaSets = deltaTransform.transformDeltaSets;
- import Document from '../../../../src/model/document';
- import Element from '../../../../src/model/element';
- import Text from '../../../../src/model/text';
- import Position from '../../../../src/model/position';
- import Delta from '../../../../src/model/delta/delta';
- import InsertDelta from '../../../../src/model/delta/insertdelta';
- import RemoveDelta from '../../../../src/model/delta/removedelta';
- import MoveDelta from '../../../../src/model/delta/movedelta';
- import SplitDelta from '../../../../src/model/delta/splitdelta';
- import NoOperation from '../../../../src/model/operation/nooperation';
- import MoveOperation from '../../../../src/model/operation/moveoperation';
- import RemoveOperation from '../../../../src/model/operation/removeoperation';
- import ReinsertOperation from '../../../../src/model/operation/reinsertoperation';
- import InsertOperation from '../../../../src/model/operation/insertoperation';
- import {
- expectDelta,
- getInsertDelta,
- getSplitDelta,
- getRemoveDelta,
- getMoveDelta,
- getMergeDelta
- } from '../../../../tests/model/delta/transform/_utils/utils';
- describe( 'transform', () => {
- let doc, root, baseVersion;
- beforeEach( () => {
- doc = new Document();
- root = doc.createRoot();
- root.appendChildren( new Element( 'p', null, new Text( 'foobar' ) ) );
- baseVersion = doc.version;
- } );
- describe( 'transformDeltaSets', () => {
- it( 'should use deltaTransform.transform', () => {
- sinon.spy( deltaTransform, 'transform' );
- const insertDelta = getInsertDelta( new Position( root, [ 0, 4 ] ), new Text( 'xxx' ), baseVersion );
- const removeDelta = getRemoveDelta( new Position( root, [ 0, 0 ] ), 2, baseVersion );
- transformDeltaSets( [ insertDelta ], [ removeDelta ] );
- expect( deltaTransform.transform.called ).to.be.true;
- deltaTransform.transform.restore();
- } );
- it( 'should transform two arrays of deltas', () => {
- const splitDelta = getSplitDelta( new Position( root, [ 0, 3 ] ), new Element( 'p' ), 3, baseVersion );
- const insertDeltaX = getInsertDelta( new Position( root, [ 0, 3 ] ), new Text( 'xxx' ), baseVersion + 2 );
- const removeDelta = getRemoveDelta( new Position( root, [ 0, 2 ] ), 2, baseVersion );
- const insertDeltaY = getInsertDelta( new Position( root, [ 0, 4 ] ), new Text( 'yyy' ), baseVersion + 1 );
- const { deltasA, deltasB } = transformDeltaSets( [ splitDelta, insertDeltaX ], [ removeDelta, insertDeltaY ] );
- expect( deltasA.length ).to.equal( 3 );
- expect( deltasB.length ).to.equal( 3 );
- expectDelta( deltasA[ 0 ], {
- type: SplitDelta,
- operations: [
- {
- type: InsertOperation,
- position: new Position( root, [ 1 ] ),
- baseVersion: 2
- },
- {
- type: MoveOperation,
- sourcePosition: new Position( root, [ 0, 2 ] ),
- howMany: 5,
- targetPosition: new Position( root, [ 1, 0 ] ),
- baseVersion: 3
- }
- ]
- } );
- expectDelta( deltasA[ 1 ], {
- type: InsertDelta,
- operations: [
- {
- type: InsertOperation,
- position: new Position( root, [ 0, 2 ] ),
- baseVersion: 4
- }
- ]
- } );
- expectDelta( deltasA[ 2 ], {
- type: Delta,
- operations: [
- {
- type: NoOperation,
- baseVersion: 5
- }
- ]
- } );
- expectDelta( deltasB[ 0 ], {
- type: RemoveDelta,
- operations: [
- {
- type: RemoveOperation,
- sourcePosition: new Position( root, [ 0, 2 ] ),
- howMany: 1,
- baseVersion: 3
- }
- ]
- } );
- expectDelta( deltasB[ 1 ], {
- type: RemoveDelta,
- operations: [
- {
- type: RemoveOperation,
- sourcePosition: new Position( root, [ 1, 0 ] ),
- howMany: 1,
- baseVersion: 4
- }
- ]
- } );
- expectDelta( deltasB[ 2 ], {
- type: InsertDelta,
- operations: [
- {
- type: InsertOperation,
- position: new Position( root, [ 1, 2 ] ),
- baseVersion: 5
- }
- ]
- } );
- } );
- it( 'should transform two arrays of deltas - reverse', () => {
- const splitDelta = getSplitDelta( new Position( root, [ 0, 3 ] ), new Element( 'p' ), 3, baseVersion );
- const insertDeltaX = getInsertDelta( new Position( root, [ 0, 3 ] ), new Text( 'xxx' ), baseVersion + 2 );
- const removeDelta = getRemoveDelta( new Position( root, [ 0, 2 ] ), 2, baseVersion );
- const insertDeltaY = getInsertDelta( new Position( root, [ 0, 4 ] ), new Text( 'yyy' ), baseVersion + 1 );
- const { deltasA, deltasB } = transformDeltaSets( [ removeDelta, insertDeltaY ], [ splitDelta, insertDeltaX ] );
- expect( deltasA.length ).to.equal( 3 );
- expect( deltasB.length ).to.equal( 3 );
- expectDelta( deltasA[ 0 ], {
- type: RemoveDelta,
- operations: [
- {
- type: RemoveOperation,
- sourcePosition: new Position( root, [ 0, 2 ] ),
- howMany: 1,
- baseVersion: 3
- }
- ]
- } );
- expectDelta( deltasA[ 1 ], {
- type: RemoveDelta,
- operations: [
- {
- type: RemoveOperation,
- sourcePosition: new Position( root, [ 1, 0 ] ),
- howMany: 1,
- baseVersion: 4
- }
- ]
- } );
- expectDelta( deltasA[ 2 ], {
- type: InsertDelta,
- operations: [
- {
- type: InsertOperation,
- position: new Position( root, [ 1, 2 ] ),
- baseVersion: 5
- }
- ]
- } );
- expectDelta( deltasB[ 0 ], {
- type: SplitDelta,
- operations: [
- {
- type: InsertOperation,
- position: new Position( root, [ 1 ] ),
- baseVersion: 2
- },
- {
- type: MoveOperation,
- sourcePosition: new Position( root, [ 0, 2 ] ),
- howMany: 5,
- targetPosition: new Position( root, [ 1, 0 ] ),
- baseVersion: 3
- }
- ]
- } );
- expectDelta( deltasB[ 1 ], {
- type: InsertDelta,
- operations: [
- {
- type: InsertOperation,
- position: new Position( root, [ 0, 2 ] ),
- baseVersion: 4
- }
- ]
- } );
- expectDelta( deltasB[ 2 ], {
- type: Delta,
- operations: [
- {
- type: NoOperation,
- baseVersion: 5
- }
- ]
- } );
- } );
- it( 'should not modify original deltas or arrays', () => {
- const insertDeltaA = getInsertDelta( new Position( root, [ 0, 0 ] ), new Text( 'x' ), baseVersion );
- const insertDeltaB = getInsertDelta( new Position( root, [ 1, 0 ] ), new Text( 'y' ), baseVersion );
- const originalDeltasA = [ insertDeltaA ];
- const originalDeltasB = [ insertDeltaB ];
- const { deltasA, deltasB } = transformDeltaSets( originalDeltasA, originalDeltasB );
- expect( deltasA ).to.not.equal( originalDeltasA );
- expect( deltasB ).to.not.equal( originalDeltasB );
- expect( deltasA[ 0 ] ).to.not.equal( originalDeltasA[ 0 ] );
- expect( deltasB[ 0 ] ).to.not.equal( originalDeltasB[ 0 ] );
- } );
- describe( 'context', () => {
- it( 'first set is important', () => {
- const insertDeltaA = getInsertDelta( new Position( root, [ 0, 4 ] ), new Text( 'xxx' ), baseVersion );
- const insertDeltaB = getInsertDelta( new Position( root, [ 0, 4 ] ), new Text( 'yyy' ), baseVersion );
- const { deltasA, deltasB } = transformDeltaSets( [ insertDeltaA ], [ insertDeltaB ] );
- expectDelta( deltasA[ 0 ], {
- type: InsertDelta,
- operations: [
- {
- type: InsertOperation,
- position: new Position( root, [ 0, 4 ] ),
- baseVersion: 1
- }
- ]
- } );
- expectDelta( deltasB[ 0 ], {
- type: InsertDelta,
- operations: [
- {
- type: InsertOperation,
- position: new Position( root, [ 0, 7 ] ),
- baseVersion: 1
- }
- ]
- } );
- } );
- it( 'remove delta is more important if additional context is not used', () => {
- const moveDelta = getMoveDelta( new Position( root, [ 0, 4 ] ), 3, new Position( root, [ 1, 0 ] ), baseVersion );
- const removeDelta = getRemoveDelta( new Position( root, [ 0, 4 ] ), 3, baseVersion );
- const { deltasA, deltasB } = transformDeltaSets( [ moveDelta ], [ removeDelta ] );
- expectDelta( deltasA[ 0 ], {
- type: Delta,
- operations: [
- {
- type: NoOperation,
- baseVersion: 1
- }
- ]
- } );
- expectDelta( deltasB[ 0 ], {
- type: RemoveDelta,
- operations: [
- {
- type: RemoveOperation,
- sourcePosition: new Position( root, [ 1, 0 ] ),
- howMany: 3,
- targetPosition: new Position( doc.graveyard, [ 0 ] ),
- baseVersion: 1
- }
- ]
- } );
- } );
- it( 'remove delta may be less important if additional context is used and the delta was undone', () => {
- const moveDelta = getMoveDelta( new Position( root, [ 0, 4 ] ), 3, new Position( root, [ 1, 0 ] ), baseVersion );
- const removeDelta = getRemoveDelta( new Position( root, [ 0, 4 ] ), 3, baseVersion );
- // "Fake" delta undoing.
- doc.history.setDeltaAsUndone( removeDelta, new Delta() );
- const { deltasA, deltasB } = transformDeltaSets( [ moveDelta ], [ removeDelta ], doc );
- expectDelta( deltasA[ 0 ], {
- type: MoveDelta,
- operations: [
- {
- type: MoveOperation,
- sourcePosition: new Position( doc.graveyard, [ 0 ] ),
- howMany: 3,
- targetPosition: new Position( root, [ 1, 0 ] ),
- baseVersion: 1
- }
- ]
- } );
- expectDelta( deltasB[ 0 ], {
- type: Delta,
- operations: [
- {
- type: NoOperation,
- baseVersion: 1
- }
- ]
- } );
- } );
- it( 'should keep correct order of nodes if additional context is used (insert before)', () => {
- // Assume document state: 'a^bcd'. User presses 'delete' key twice.
- const removeDelta1 = getRemoveDelta( new Position( root, [ 1 ] ), 1, baseVersion ); // 'acd'.
- const removeDelta2 = getRemoveDelta( new Position( root, [ 1 ] ), 1, baseVersion + 1 ); // 'ad'.
- const reinsertDelta2 = removeDelta2.getReversed(); // 'acd'.
- doc.history.addDelta( removeDelta1 );
- doc.history.addDelta( removeDelta2 );
- doc.history.addDelta( reinsertDelta2 );
- doc.history.setDeltaAsUndone( removeDelta2, reinsertDelta2 );
- // This should insert 'b' at offset 1.
- // However this delta will be transformed by `reinsertDelta2` which also inserts a node at offset 1.
- // This leads to a conflict and history needs to be check how deltas relate to each other.
- // Compare this scenario to the scenario below.
- const reinsertDelta1 = removeDelta1.getReversed();
- const { deltasA } = transformDeltaSets( [ reinsertDelta1 ], [ removeDelta2, reinsertDelta2 ], doc );
- expectDelta( deltasA[ 0 ], {
- type: MoveDelta,
- operations: [
- {
- type: ReinsertOperation,
- targetPosition: new Position( root, [ 1 ] ),
- howMany: 1,
- baseVersion: 3
- }
- ]
- } );
- } );
- it( 'should keep correct order of nodes if additional context is used (insert after)', () => {
- // Assume document state: 'abc^d'. User presses 'backspace' key twice.
- const removeDelta1 = getRemoveDelta( new Position( root, [ 2 ] ), 1, baseVersion ); // 'abd'.
- const removeDelta2 = getRemoveDelta( new Position( root, [ 1 ] ), 1, baseVersion + 1 ); // 'ad'.
- const reinsertDelta2 = removeDelta2.getReversed(); // 'abd'.
- doc.history.addDelta( removeDelta1 );
- doc.history.addDelta( removeDelta2 );
- doc.history.addDelta( reinsertDelta2 );
- doc.history.setDeltaAsUndone( removeDelta2, reinsertDelta2 );
- // This should insert 'c' at offset 2.
- // However this delta will be first transformed by `removeDelta2`. After that transformation
- // the delta will try to insert 'c' at offset 1. Then, it will be transformed by `reinsertDelta2`,
- // which also tries to insert node at offset 1.
- // This leads to a conflict and history needs to be check how deltas relate to each other.
- // Compare this scenario to the scenario below.
- // In both cases transformed delta was inserting something at the same position. However, in
- // both cases the expected outcome is different.
- const reinsertDelta1 = removeDelta1.getReversed();
- const { deltasA } = transformDeltaSets( [ reinsertDelta1 ], [ removeDelta2, reinsertDelta2 ], doc );
- expectDelta( deltasA[ 0 ], {
- type: MoveDelta,
- operations: [
- {
- type: ReinsertOperation,
- targetPosition: new Position( root, [ 2 ] ),
- howMany: 1,
- baseVersion: 3
- }
- ]
- } );
- } );
- it( 'should not throw if delta transformed by undoing delta was not transformed by undone delta', () => {
- // This scenario may happen when deltas are undone in different order than usual LIFO order.
- const removeDelta1 = getRemoveDelta( new Position( root, [ 0 ] ), 1, baseVersion );
- const removeDelta2 = getRemoveDelta( new Position( root, [ 2 ] ), 1, baseVersion + 1 );
- const reinsertDelta1 = removeDelta1.getReversed();
- reinsertDelta1.baseVersion = 2;
- doc.history.addDelta( removeDelta1 );
- doc.history.addDelta( removeDelta2 );
- doc.history.addDelta( reinsertDelta1 );
- doc.history.setDeltaAsUndone( removeDelta1, reinsertDelta1 );
- const reinsertDelta2 = removeDelta2.getReversed();
- const { deltasA } = transformDeltaSets( [ reinsertDelta2 ], [ reinsertDelta1 ], doc );
- expectDelta( deltasA[ 0 ], {
- type: MoveDelta,
- operations: [
- {
- type: MoveOperation,
- sourcePosition: new Position( root, [ 0 ] ),
- targetPosition: new Position( root, [ 3 ] ),
- howMany: 1,
- baseVersion: 3
- }
- ]
- } );
- } );
- it( 'should use stickiness if additional context is not used', () => {
- const moveDeltaA = getMoveDelta( new Position( root, [ 0, 0 ] ), 1, new Position( root, [ 1, 0 ] ), baseVersion );
- const moveDeltaB = getMoveDelta( new Position( root, [ 1, 0 ] ), 3, new Position( root, [ 2, 2 ] ), baseVersion );
- moveDeltaB.operations[ 0 ].isSticky = true;
- const { deltasA } = transformDeltaSets( [ moveDeltaA ], [ moveDeltaB ], doc );
- expectDelta( deltasA[ 0 ], {
- type: MoveDelta,
- operations: [
- {
- type: MoveOperation,
- targetPosition: new Position( root, [ 2, 2 ] ),
- howMany: 1,
- baseVersion: 1
- }
- ]
- } );
- } );
- it( 'should discard stickiness if additional context is used and delta with sticky move operation has been undone', () => {
- // Assume following data model: <paragraph>ab</paragraph><paragraph>cd</paragraph>
- // Then we remove 'b': <paragraph>a</paragraph><paragraph>cd</paragraph>
- const removeDelta = getRemoveDelta( new Position( root, [ 0, 1 ] ), 1, baseVersion );
- // Then we merge paragraphs: <paragraph>acd</paragraph>
- // Keep in mind that merging has sticky move operation ('cd' is sticky-moved to the first paragraph).
- const mergeDelta = getMergeDelta( new Position( root, [ 1 ] ), 2, 1, baseVersion + 1 );
- // Then we reverse merging: <paragraph>a</paragraph><paragraph>cd</paragraph>
- // Keep in mind that now we have two deltas with sticky moves in a history.
- const splitDelta = mergeDelta.getReversed();
- doc.history.addDelta( removeDelta );
- doc.history.addDelta( mergeDelta );
- doc.history.addDelta( splitDelta );
- doc.history.setDeltaAsUndone( mergeDelta, splitDelta );
- // This delta should insert 'b' at position [ 0, 1 ].
- // However, without context data, after transforming `reinsertDelta` by `splitDelta`,
- // 'b' would "go away" together with 'cd'.
- const reinsertDelta = removeDelta.getReversed();
- const { deltasA } = transformDeltaSets( [ reinsertDelta ], [ mergeDelta, splitDelta ], doc );
- expectDelta( deltasA[ 0 ], {
- type: MoveDelta,
- operations: [
- {
- type: ReinsertOperation,
- targetPosition: new Position( root, [ 0, 1 ] ),
- howMany: 1,
- baseVersion: 5
- }
- ]
- } );
- } );
- } );
- } );
- } );
|