mergedelta.js 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365
  1. /**
  2. * @license Copyright (c) 2003-2018, 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.undoMode = 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 at same position as merge - merge second operation is NoOperation', () => {
  96. // If MergeDelta second operation is NoOperation, default transformation algorithm should be used.
  97. mergeDelta.operations[ 1 ] = new NoOperation( 1 );
  98. const insertDelta = getInsertDelta( mergePosition, [ nodeA, nodeB ], baseVersion );
  99. const transformed = transform( mergeDelta, insertDelta, context );
  100. baseVersion = insertDelta.operations.length;
  101. expect( transformed.length ).to.equal( 1 );
  102. expectDelta( transformed[ 0 ], {
  103. type: MergeDelta,
  104. operations: [
  105. {
  106. type: MoveOperation,
  107. sourcePosition: new Position( root, [ 3, 3, 5, 0 ] ),
  108. howMany: mergeDelta.operations[ 0 ].howMany,
  109. targetPosition: mergeDelta.operations[ 0 ].targetPosition,
  110. baseVersion
  111. },
  112. {
  113. type: NoOperation,
  114. baseVersion: baseVersion + 1
  115. }
  116. ]
  117. } );
  118. } );
  119. it( 'insert inside merged node (sticky move test)', () => {
  120. const insertDelta = getInsertDelta( new Position( root, [ 3, 3, 3, 12 ] ), [ nodeA, nodeB ], baseVersion );
  121. const transformed = transform( mergeDelta, insertDelta, context );
  122. baseVersion = insertDelta.operations.length;
  123. expect( transformed.length ).to.equal( 1 );
  124. // Expected: MoveOperation in MergeDelta has it's "range" expanded.
  125. expectDelta( transformed[ 0 ], {
  126. type: MergeDelta,
  127. operations: [
  128. {
  129. type: MoveOperation,
  130. sourcePosition: new Position( root, [ 3, 3, 3, 0 ] ),
  131. howMany: 14,
  132. targetPosition: new Position( root, [ 3, 3, 2, 4 ] ),
  133. baseVersion
  134. },
  135. {
  136. type: RemoveOperation,
  137. sourcePosition: new Position( root, [ 3, 3, 3 ] ),
  138. howMany: 1,
  139. targetPosition: new Position( gy, [ 0 ] ),
  140. baseVersion: baseVersion + 1
  141. }
  142. ]
  143. } );
  144. // Test if deltas do what they should after applying transformed delta.
  145. applyDelta( insertDelta, doc );
  146. applyDelta( transformed[ 0 ], doc );
  147. const nodesAndText = getNodesAndText( Range.createFromPositionAndShift( new Position( root, [ 3, 3, 0 ] ), 3 ) );
  148. // InsertDelta is applied. Merge between X and P is discarded.
  149. expect( nodesAndText ).to.equal( 'XXXXXabcdabcfoobarxyzAABBX' );
  150. } );
  151. } );
  152. describe( 'MoveDelta', () => {
  153. it( 'node on the right side of merge was moved', () => {
  154. const moveDelta = getMoveDelta( new Position( root, [ 3, 3, 3 ] ), 1, new Position( root, [ 3, 3, 0 ] ), baseVersion );
  155. const transformed = transform( mergeDelta, moveDelta, context );
  156. baseVersion = moveDelta.operations.length;
  157. expect( transformed.length ).to.equal( 1 );
  158. expectDelta( transformed[ 0 ], {
  159. type: Delta,
  160. operations: [
  161. {
  162. type: NoOperation,
  163. baseVersion
  164. }
  165. ]
  166. } );
  167. // Test if deltas do what they should after applying transformed delta.
  168. applyDelta( moveDelta, doc );
  169. applyDelta( transformed[ 0 ], doc );
  170. const nodesAndText = getNodesAndText( Range.createFromPositionAndShift( new Position( root, [ 3, 3 ] ), 1 ) );
  171. // MoveDelta is applied. MergeDelta is discarded.
  172. expect( nodesAndText ).to.equal( 'DIVPabcfoobarxyzPXXXXXabcdXDIV' );
  173. } );
  174. it( 'node on the left side of merge was moved', () => {
  175. const moveDelta = getMoveDelta( new Position( root, [ 3, 3, 2 ] ), 1, new Position( root, [ 3, 3, 0 ] ), baseVersion );
  176. const transformed = transform( mergeDelta, moveDelta, context );
  177. expect( transformed.length ).to.equal( 1 );
  178. baseVersion = moveDelta.operations.length;
  179. expectDelta( transformed[ 0 ], {
  180. type: MergeDelta,
  181. operations: [
  182. {
  183. type: MoveOperation,
  184. sourcePosition: new Position( root, [ 3, 3, 3, 0 ] ),
  185. howMany: 12,
  186. targetPosition: new Position( root, [ 3, 3, 0, 4 ] ),
  187. baseVersion
  188. },
  189. {
  190. type: RemoveOperation,
  191. sourcePosition: new Position( root, [ 3, 3, 3 ] ),
  192. howMany: 1,
  193. baseVersion: baseVersion + 1
  194. }
  195. ]
  196. } );
  197. // Test if deltas do what they should after applying transformed delta.
  198. applyDelta( moveDelta, doc );
  199. applyDelta( transformed[ 0 ], doc );
  200. const nodesAndText = getNodesAndText( Range.createFromPositionAndShift( new Position( root, [ 3, 3 ] ), 1 ) );
  201. // MoveDelta is applied. MergeDelta is discarded.
  202. expect( nodesAndText ).to.equal( 'DIVXabcdabcfoobarxyzXXXXXDIV' );
  203. } );
  204. it( 'node on the left side of merge was moved - second merge operation is NoOperation', () => {
  205. // If second MergeDelta operation is NoOperation default algorithm should be used.
  206. mergeDelta.operations[ 1 ] = new NoOperation( 1 );
  207. const moveDelta = getMoveDelta( new Position( root, [ 3, 3, 2 ] ), 1, new Position( root, [ 3, 3, 0 ] ), baseVersion );
  208. const transformed = transform( mergeDelta, moveDelta, context );
  209. expect( transformed.length ).to.equal( 1 );
  210. baseVersion = moveDelta.operations.length;
  211. expectDelta( transformed[ 0 ], {
  212. type: MergeDelta,
  213. operations: [
  214. {
  215. type: MoveOperation,
  216. sourcePosition: new Position( root, [ 3, 3, 3, 0 ] ),
  217. howMany: 12,
  218. targetPosition: new Position( root, [ 3, 3, 0, 4 ] ),
  219. baseVersion
  220. },
  221. {
  222. type: NoOperation,
  223. baseVersion: baseVersion + 1
  224. }
  225. ]
  226. } );
  227. } );
  228. } );
  229. describe( 'MergeDelta', () => {
  230. it( 'merge two consecutive elements, transformed merge is after', () => {
  231. const mergeDeltaB = getMergeDelta( new Position( root, [ 3, 3, 2 ] ), 0, 4, baseVersion );
  232. const transformed = transform( mergeDelta, mergeDeltaB, context );
  233. expect( transformed.length ).to.equal( 1 );
  234. baseVersion = mergeDelta.operations.length;
  235. expectDelta( transformed[ 0 ], {
  236. type: MergeDelta,
  237. operations: [
  238. {
  239. type: MoveOperation,
  240. sourcePosition: new Position( root, [ 3, 3, 2, 0 ] ),
  241. howMany: 12,
  242. targetPosition: new Position( root, [ 3, 3, 1, 4 ] ),
  243. baseVersion
  244. },
  245. {
  246. type: RemoveOperation,
  247. sourcePosition: new Position( root, [ 3, 3, 2 ] ),
  248. howMany: 1
  249. }
  250. ]
  251. } );
  252. // Test if deltas do what they should after applying transformed delta.
  253. applyDelta( mergeDeltaB, doc );
  254. applyDelta( transformed[ 0 ], doc );
  255. const nodesAndText = getNodesAndText( Range.createFromPositionAndShift( new Position( root, [ 3, 3, 0 ] ), 2 ) );
  256. // Both merge deltas are applied and merged nodes children are together in one node.
  257. expect( nodesAndText ).to.equal( 'XXXabcdabcfoobarxyzX' );
  258. } );
  259. it( 'merge two consecutive elements, transformed merge is before', () => {
  260. mergeDelta = getMergeDelta( new Position( root, [ 3, 3, 2 ] ), 0, 4, baseVersion );
  261. const mergeDeltaB = getMergeDelta( new Position( root, [ 3, 3, 3 ] ), 4, 12, baseVersion );
  262. const transformed = transform( mergeDelta, mergeDeltaB, context );
  263. expect( transformed.length ).to.equal( 1 );
  264. baseVersion = mergeDelta.operations.length;
  265. expectDelta( transformed[ 0 ], {
  266. type: MergeDelta,
  267. operations: [
  268. {
  269. type: MoveOperation,
  270. sourcePosition: new Position( root, [ 3, 3, 2, 0 ] ),
  271. howMany: 16,
  272. targetPosition: new Position( root, [ 3, 3, 1, 0 ] ),
  273. baseVersion
  274. },
  275. {
  276. type: RemoveOperation,
  277. sourcePosition: new Position( root, [ 3, 3, 2 ] ),
  278. howMany: 1
  279. }
  280. ]
  281. } );
  282. // Test if deltas do what they should after applying transformed delta.
  283. applyDelta( mergeDeltaB, doc );
  284. applyDelta( transformed[ 0 ], doc );
  285. const nodesAndText = getNodesAndText( Range.createFromPositionAndShift( new Position( root, [ 3, 3, 0 ] ), 2 ) );
  286. // Both merge deltas are applied and merged nodes children are together in one node.
  287. expect( nodesAndText ).to.equal( 'XXXabcdabcfoobarxyzX' );
  288. } );
  289. } );
  290. } );
  291. } );