insertdelta.js 7.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251
  1. /**
  2. * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. import transformations from '../../../../src/model/delta/basic-transformations'; // eslint-disable-line no-unused-vars
  6. import deltaTransform from '../../../../src/model/delta/transform';
  7. const transform = deltaTransform.transform;
  8. import Element from '../../../../src/model/element';
  9. import Position from '../../../../src/model/position';
  10. import Range from '../../../../src/model/range';
  11. import InsertDelta from '../../../../src/model/delta/insertdelta';
  12. import SplitDelta from '../../../../src/model/delta/splitdelta';
  13. import InsertOperation from '../../../../src/model/operation/insertoperation';
  14. import MoveOperation from '../../../../src/model/operation/moveoperation';
  15. import ReinsertOperation from '../../../../src/model/operation/reinsertoperation';
  16. import NoOperation from '../../../../src/model/operation/nooperation';
  17. import { getNodesAndText } from '../../../../tests/model/_utils/utils';
  18. import {
  19. applyDelta,
  20. expectDelta,
  21. getFilledDocument,
  22. getInsertDelta,
  23. getMergeDelta
  24. } from '../../../../tests/model/delta/transform/_utils/utils';
  25. describe( 'transform', () => {
  26. let doc, root, gy, baseVersion, context;
  27. beforeEach( () => {
  28. doc = getFilledDocument();
  29. root = doc.getRoot();
  30. gy = doc.graveyard;
  31. baseVersion = doc.version;
  32. context = {
  33. isStrong: false
  34. };
  35. } );
  36. describe( 'InsertDelta by', () => {
  37. let insertDelta, insertPosition, nodeA, nodeB;
  38. beforeEach( () => {
  39. nodeA = new Element( 'a' );
  40. nodeB = new Element( 'b' );
  41. insertPosition = new Position( root, [ 3, 3, 3 ] );
  42. insertDelta = getInsertDelta( insertPosition, [ nodeA, nodeB ], baseVersion );
  43. } );
  44. describe( 'InsertDelta', () => {
  45. it( 'should be resolved in a same way as two insert operations', () => {
  46. const insertPositionB = new Position( root, [ 3, 1 ] );
  47. const insertDeltaB = getInsertDelta( insertPositionB, [ new Element( 'c' ), new Element( 'd' ) ], baseVersion );
  48. const transformed = transform( insertDelta, insertDeltaB, context );
  49. expect( transformed.length ).to.equal( 1 );
  50. expectDelta( transformed[ 0 ], {
  51. type: InsertDelta,
  52. operations: [
  53. {
  54. type: InsertOperation,
  55. position: new Position( root, [ 3, 5, 3 ] ),
  56. nodes: [ nodeA, nodeB ],
  57. baseVersion: baseVersion + 1
  58. }
  59. ]
  60. } );
  61. } );
  62. } );
  63. describe( 'MergeDelta', () => {
  64. it( 'merge in same position as insert', () => {
  65. const mergeDelta = getMergeDelta( insertPosition, 4, 12, baseVersion );
  66. const transformed = transform( insertDelta, mergeDelta, context );
  67. baseVersion = mergeDelta.operations.length;
  68. // Expected: MergeOperation gets reversed (by special case of SplitDelta that has ReinsertOperation
  69. // instead of InsertOperation. Then InsertDelta is applied as is.
  70. expect( transformed.length ).to.equal( 2 );
  71. expectDelta( transformed[ 0 ], {
  72. type: SplitDelta,
  73. operations: [
  74. {
  75. type: ReinsertOperation,
  76. sourcePosition: new Position( gy, [ 0 ] ),
  77. howMany: 1,
  78. targetPosition: new Position( root, [ 3, 3, 3 ] ),
  79. baseVersion
  80. },
  81. {
  82. type: MoveOperation,
  83. sourcePosition: new Position( root, [ 3, 3, 2, 4 ] ),
  84. howMany: 12,
  85. targetPosition: new Position( root, [ 3, 3, 3, 0 ] ),
  86. baseVersion: baseVersion + 1
  87. }
  88. ]
  89. } );
  90. expectDelta( transformed[ 1 ], {
  91. type: InsertDelta,
  92. operations: [
  93. {
  94. type: InsertOperation,
  95. position: Position.createFromPosition( insertPosition ),
  96. nodes: [ nodeA, nodeB ],
  97. baseVersion: baseVersion + 2
  98. }
  99. ]
  100. } );
  101. // Test if deltas do what they should after applying transformed delta.
  102. applyDelta( mergeDelta, doc );
  103. applyDelta( transformed[ 0 ], doc );
  104. applyDelta( transformed[ 1 ], doc );
  105. const nodesAndText = getNodesAndText( Range.createFromPositionAndShift( new Position( root, [ 3, 3, 0 ] ), 6 ) );
  106. // Merge between X with "abcd" and P with "abcfoobarxyz" should be reversed and AB should be inserted between X and P.
  107. expect( nodesAndText ).to.equal( 'XXXXXabcdXAABBPabcfoobarxyzP' );
  108. } );
  109. it( 'merge in same position as insert - undo mode', () => {
  110. // In undo mode, default transformation algorithm should be used.
  111. const mergeDelta = getMergeDelta( insertPosition, 4, 12, baseVersion );
  112. context.bWasUndone = true;
  113. const transformed = transform( insertDelta, mergeDelta, context );
  114. baseVersion = mergeDelta.operations.length;
  115. expect( transformed.length ).to.equal( 1 );
  116. expectDelta( transformed[ 0 ], {
  117. type: InsertDelta,
  118. operations: [
  119. {
  120. type: InsertOperation,
  121. position: Position.createFromPosition( insertPosition ),
  122. nodes: [ nodeA, nodeB ],
  123. baseVersion
  124. }
  125. ]
  126. } );
  127. } );
  128. it( 'merge in same position as insert - undo mode', () => {
  129. // If MergeDelta second operation is NoOperation, default transformation algorithm should be used.
  130. const mergeDelta = getMergeDelta( insertPosition, 4, 12, baseVersion );
  131. mergeDelta.operations[ 1 ] = new NoOperation( 1 );
  132. const transformed = transform( insertDelta, mergeDelta, context );
  133. baseVersion = mergeDelta.operations.length;
  134. expect( transformed.length ).to.equal( 1 );
  135. expectDelta( transformed[ 0 ], {
  136. type: InsertDelta,
  137. operations: [
  138. {
  139. type: InsertOperation,
  140. position: Position.createFromPosition( insertPosition ),
  141. nodes: [ nodeA, nodeB ],
  142. baseVersion
  143. }
  144. ]
  145. } );
  146. } );
  147. it( 'merge the node that is parent of insert position (sticky move test)', () => {
  148. const mergeDelta = getMergeDelta( new Position( root, [ 3, 3 ] ), 1, 4, baseVersion );
  149. const transformed = transform( insertDelta, mergeDelta, context );
  150. baseVersion = mergeDelta.operations.length;
  151. // Expected: InsertOperation in InsertDelta has it's path updated.
  152. expect( transformed.length ).to.equal( 1 );
  153. expectDelta( transformed[ 0 ], {
  154. type: InsertDelta,
  155. operations: [
  156. {
  157. type: InsertOperation,
  158. position: new Position( root, [ 3, 2, 4 ] ),
  159. nodes: [ nodeA, nodeB ],
  160. baseVersion
  161. }
  162. ]
  163. } );
  164. // Test if deltas do what they should after applying transformed delta.
  165. applyDelta( mergeDelta, doc );
  166. applyDelta( transformed[ 0 ], doc );
  167. const nodesAndText = getNodesAndText( Range.createFromPositionAndShift( new Position( root, [ 3, 2, 0 ] ), 7 ) );
  168. // Merge between X with "a" and DIV should be applied. AB should be inserted in new, correct position.
  169. expect( nodesAndText ).to.equal( 'aXXXXXabcdXAABBPabcfoobarxyzP' );
  170. } );
  171. it( 'merge at affected position but resolved by default OT', () => {
  172. const mergeDelta = getMergeDelta( new Position( root, [ 3 ] ), 1, 4, baseVersion );
  173. const transformed = transform( insertDelta, mergeDelta, context );
  174. baseVersion = mergeDelta.operations.length;
  175. // Expected: InsertOperation in InsertDelta has it's path updated.
  176. expect( transformed.length ).to.equal( 1 );
  177. expectDelta( transformed[ 0 ], {
  178. type: InsertDelta,
  179. operations: [
  180. {
  181. type: InsertOperation,
  182. position: new Position( root, [ 2, 4, 3 ] ),
  183. nodes: [ nodeA, nodeB ],
  184. baseVersion
  185. }
  186. ]
  187. } );
  188. // Test if deltas do what they should after applying transformed delta.
  189. applyDelta( mergeDelta, doc );
  190. applyDelta( transformed[ 0 ], doc );
  191. const nodesAndText = getNodesAndText( Range.createFromPositionAndShift( new Position( root, [ 2, 0 ] ), 5 ) );
  192. // Merge between X with "a" and DIV should be applied. AB should be inserted in new, correct position.
  193. expect( nodesAndText ).to.equal( 'aXXXXXaXDIVXXXXXabcdXAABBPabcfoobarxyzPDIV' );
  194. } );
  195. } );
  196. } );
  197. } );