mergedelta.js 9.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308
  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 Delta from '../../../../src/model/delta/delta';
  12. import MergeDelta from '../../../../src/model/delta/mergedelta';
  13. import MoveOperation from '../../../../src/model/operation/moveoperation';
  14. import RemoveOperation from '../../../../src/model/operation/removeoperation';
  15. import NoOperation from '../../../../src/model/operation/nooperation';
  16. import { getNodesAndText } from '../../../../tests/model/_utils/utils';
  17. import {
  18. applyDelta,
  19. expectDelta,
  20. getFilledDocument,
  21. getInsertDelta,
  22. getMergeDelta,
  23. getMoveDelta
  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 = { isStrong: false };
  33. } );
  34. describe( 'MergeDelta by', () => {
  35. let mergeDelta, mergePosition;
  36. beforeEach( () => {
  37. mergePosition = new Position( root, [ 3, 3, 3 ] );
  38. mergeDelta = getMergeDelta( mergePosition, 4, 12, baseVersion );
  39. } );
  40. describe( 'InsertDelta', () => {
  41. let nodeA, nodeB;
  42. beforeEach( () => {
  43. nodeA = new Element( 'a' );
  44. nodeB = new Element( 'b' );
  45. } );
  46. it( 'insert at same position as merge', () => {
  47. const insertDelta = getInsertDelta( mergePosition, [ nodeA, nodeB ], baseVersion );
  48. const transformed = transform( mergeDelta, insertDelta, context );
  49. // Expected: MergeDelta gets ignored and is not applied.
  50. baseVersion = insertDelta.operations.length;
  51. expect( transformed.length ).to.equal( 1 );
  52. expectDelta( transformed[ 0 ], {
  53. type: Delta,
  54. operations: [
  55. {
  56. type: NoOperation,
  57. baseVersion
  58. }
  59. ]
  60. } );
  61. // Test if deltas do what they should after applying transformed delta.
  62. applyDelta( insertDelta, doc );
  63. applyDelta( transformed[ 0 ], doc );
  64. const nodesAndText = getNodesAndText( Range.createFromPositionAndShift( new Position( root, [ 3, 3, 0 ] ), 6 ) );
  65. // InsertDelta is applied. Merge between X and P is discarded.
  66. expect( nodesAndText ).to.equal( 'XXXXXabcdXAABBPabcfoobarxyzP' );
  67. } );
  68. it( 'insert at same position as merge - undo mode', () => {
  69. // In undo mode, default transformation algorithm should be used.
  70. const insertDelta = getInsertDelta( mergePosition, [ nodeA, nodeB ], baseVersion );
  71. context.bWasUndone = true;
  72. const transformed = transform( mergeDelta, insertDelta, context );
  73. baseVersion = insertDelta.operations.length;
  74. expect( transformed.length ).to.equal( 1 );
  75. expectDelta( transformed[ 0 ], {
  76. type: MergeDelta,
  77. operations: [
  78. {
  79. type: MoveOperation,
  80. sourcePosition: new Position( root, [ 3, 3, 5, 0 ] ),
  81. howMany: mergeDelta.operations[ 0 ].howMany,
  82. targetPosition: mergeDelta.operations[ 0 ].targetPosition,
  83. baseVersion
  84. },
  85. {
  86. type: RemoveOperation,
  87. sourcePosition: new Position( root, [ 3, 3, 5 ] ),
  88. howMany: 1,
  89. targetPosition: mergeDelta.operations[ 1 ].targetPosition,
  90. baseVersion: baseVersion + 1
  91. }
  92. ]
  93. } );
  94. } );
  95. it( 'insert inside merged node (sticky move test)', () => {
  96. const insertDelta = getInsertDelta( new Position( root, [ 3, 3, 3, 12 ] ), [ nodeA, nodeB ], baseVersion );
  97. const transformed = transform( mergeDelta, insertDelta, context );
  98. baseVersion = insertDelta.operations.length;
  99. expect( transformed.length ).to.equal( 1 );
  100. // Expected: MoveOperation in MergeDelta has it's "range" expanded.
  101. expectDelta( transformed[ 0 ], {
  102. type: MergeDelta,
  103. operations: [
  104. {
  105. type: MoveOperation,
  106. sourcePosition: new Position( root, [ 3, 3, 3, 0 ] ),
  107. howMany: 14,
  108. targetPosition: new Position( root, [ 3, 3, 2, 4 ] ),
  109. baseVersion
  110. },
  111. {
  112. type: RemoveOperation,
  113. sourcePosition: new Position( root, [ 3, 3, 3 ] ),
  114. howMany: 1,
  115. targetPosition: new Position( gy, [ 0 ] ),
  116. baseVersion: baseVersion + 1
  117. }
  118. ]
  119. } );
  120. // Test if deltas do what they should after applying transformed delta.
  121. applyDelta( insertDelta, doc );
  122. applyDelta( transformed[ 0 ], doc );
  123. const nodesAndText = getNodesAndText( Range.createFromPositionAndShift( new Position( root, [ 3, 3, 0 ] ), 3 ) );
  124. // InsertDelta is applied. Merge between X and P is discarded.
  125. expect( nodesAndText ).to.equal( 'XXXXXabcdabcfoobarxyzAABBX' );
  126. } );
  127. } );
  128. describe( 'MoveDelta', () => {
  129. it( 'node on the right side of merge was moved', () => {
  130. const moveDelta = getMoveDelta( new Position( root, [ 3, 3, 3 ] ), 1, new Position( root, [ 3, 3, 0 ] ), baseVersion );
  131. const transformed = transform( mergeDelta, moveDelta, context );
  132. baseVersion = moveDelta.operations.length;
  133. expect( transformed.length ).to.equal( 1 );
  134. expectDelta( transformed[ 0 ], {
  135. type: Delta,
  136. operations: [
  137. {
  138. type: NoOperation,
  139. baseVersion
  140. }
  141. ]
  142. } );
  143. // Test if deltas do what they should after applying transformed delta.
  144. applyDelta( moveDelta, doc );
  145. applyDelta( transformed[ 0 ], doc );
  146. const nodesAndText = getNodesAndText( Range.createFromPositionAndShift( new Position( root, [ 3, 3 ] ), 1 ) );
  147. // MoveDelta is applied. MergeDelta is discarded.
  148. expect( nodesAndText ).to.equal( 'DIVPabcfoobarxyzPXXXXXabcdXDIV' );
  149. } );
  150. it( 'node on the left side of merge was moved', () => {
  151. const moveDelta = getMoveDelta( new Position( root, [ 3, 3, 2 ] ), 1, new Position( root, [ 3, 3, 0 ] ), baseVersion );
  152. const transformed = transform( mergeDelta, moveDelta, context );
  153. expect( transformed.length ).to.equal( 1 );
  154. baseVersion = moveDelta.operations.length;
  155. expectDelta( transformed[ 0 ], {
  156. type: MergeDelta,
  157. operations: [
  158. {
  159. type: MoveOperation,
  160. sourcePosition: new Position( root, [ 3, 3, 3, 0 ] ),
  161. howMany: 12,
  162. targetPosition: new Position( root, [ 3, 3, 0, 4 ] ),
  163. baseVersion
  164. },
  165. {
  166. type: RemoveOperation,
  167. sourcePosition: new Position( root, [ 3, 3, 3 ] ),
  168. howMany: 1,
  169. baseVersion: baseVersion + 1
  170. }
  171. ]
  172. } );
  173. // Test if deltas do what they should after applying transformed delta.
  174. applyDelta( moveDelta, doc );
  175. applyDelta( transformed[ 0 ], doc );
  176. const nodesAndText = getNodesAndText( Range.createFromPositionAndShift( new Position( root, [ 3, 3 ] ), 1 ) );
  177. // MoveDelta is applied. MergeDelta is discarded.
  178. expect( nodesAndText ).to.equal( 'DIVXabcdabcfoobarxyzXXXXXDIV' );
  179. } );
  180. } );
  181. describe( 'MergeDelta', () => {
  182. it( 'merge two consecutive elements, transformed merge is after', () => {
  183. const mergeDeltaB = getMergeDelta( new Position( root, [ 3, 3, 2 ] ), 0, 4, baseVersion );
  184. const transformed = transform( mergeDelta, mergeDeltaB, context );
  185. expect( transformed.length ).to.equal( 1 );
  186. baseVersion = mergeDelta.operations.length;
  187. expectDelta( transformed[ 0 ], {
  188. type: MergeDelta,
  189. operations: [
  190. {
  191. type: MoveOperation,
  192. sourcePosition: new Position( root, [ 3, 3, 2, 0 ] ),
  193. howMany: 12,
  194. targetPosition: new Position( root, [ 3, 3, 1, 4 ] ),
  195. baseVersion
  196. },
  197. {
  198. type: RemoveOperation,
  199. sourcePosition: new Position( root, [ 3, 3, 2 ] ),
  200. howMany: 1
  201. }
  202. ]
  203. } );
  204. // Test if deltas do what they should after applying transformed delta.
  205. applyDelta( mergeDeltaB, doc );
  206. applyDelta( transformed[ 0 ], doc );
  207. const nodesAndText = getNodesAndText( Range.createFromPositionAndShift( new Position( root, [ 3, 3, 0 ] ), 2 ) );
  208. // Both merge deltas are applied and merged nodes children are together in one node.
  209. expect( nodesAndText ).to.equal( 'XXXabcdabcfoobarxyzX' );
  210. } );
  211. it( 'merge two consecutive elements, transformed merge is before', () => {
  212. mergeDelta = getMergeDelta( new Position( root, [ 3, 3, 2 ] ), 0, 4, baseVersion );
  213. const mergeDeltaB = getMergeDelta( new Position( root, [ 3, 3, 3 ] ), 4, 12, baseVersion );
  214. const transformed = transform( mergeDelta, mergeDeltaB, context );
  215. expect( transformed.length ).to.equal( 1 );
  216. baseVersion = mergeDelta.operations.length;
  217. expectDelta( transformed[ 0 ], {
  218. type: MergeDelta,
  219. operations: [
  220. {
  221. type: MoveOperation,
  222. sourcePosition: new Position( root, [ 3, 3, 2, 0 ] ),
  223. howMany: 16,
  224. targetPosition: new Position( root, [ 3, 3, 1, 0 ] ),
  225. baseVersion
  226. },
  227. {
  228. type: RemoveOperation,
  229. sourcePosition: new Position( root, [ 3, 3, 2 ] ),
  230. howMany: 1
  231. }
  232. ]
  233. } );
  234. // Test if deltas do what they should after applying transformed delta.
  235. applyDelta( mergeDeltaB, doc );
  236. applyDelta( transformed[ 0 ], doc );
  237. const nodesAndText = getNodesAndText( Range.createFromPositionAndShift( new Position( root, [ 3, 3, 0 ] ), 2 ) );
  238. // Both merge deltas are applied and merged nodes children are together in one node.
  239. expect( nodesAndText ).to.equal( 'XXXabcdabcfoobarxyzX' );
  240. } );
  241. } );
  242. } );
  243. } );