mergedelta.js 8.4 KB

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