mergedelta.js 8.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283
  1. /**
  2. * @license Copyright (c) 2003-2016, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. /* bender-tags: model, operation */
  6. 'use strict';
  7. import transformations from '/ckeditor5/engine/model/delta/basic-transformations.js';
  8. /*jshint unused: false*/
  9. import transform from '/ckeditor5/engine/model/delta/transform.js';
  10. import Element from '/ckeditor5/engine/model/element.js';
  11. import Position from '/ckeditor5/engine/model/position.js';
  12. import Range from '/ckeditor5/engine/model/range.js';
  13. import Delta from '/ckeditor5/engine/model/delta/delta.js';
  14. import MergeDelta from '/ckeditor5/engine/model/delta/mergedelta.js';
  15. import MoveOperation from '/ckeditor5/engine/model/operation/moveoperation.js';
  16. import RemoveOperation from '/ckeditor5/engine/model/operation/removeoperation.js';
  17. import NoOperation from '/ckeditor5/engine/model/operation/nooperation.js';
  18. import { getNodesAndText, jsonParseStringify } from '/tests/engine/model/_utils/utils.js';
  19. import {
  20. applyDelta,
  21. expectDelta,
  22. getFilledDocument,
  23. getInsertDelta,
  24. getMergeDelta,
  25. getMoveDelta
  26. } from '/tests/engine/model/delta/transform/_utils/utils.js';
  27. describe( 'transform', () => {
  28. let doc, root, gy, baseVersion;
  29. beforeEach( () => {
  30. doc = getFilledDocument();
  31. root = doc.getRoot( 'root' );
  32. gy = doc.graveyard;
  33. baseVersion = doc.version;
  34. } );
  35. describe( 'MergeDelta by', () => {
  36. let mergeDelta, mergePosition;
  37. beforeEach( () => {
  38. mergePosition = new Position( root, [ 3, 3, 3 ] );
  39. mergeDelta = getMergeDelta( mergePosition, 4, 12, baseVersion );
  40. } );
  41. describe( 'InsertDelta', () => {
  42. let nodeA, nodeB;
  43. beforeEach( () => {
  44. nodeA = new Element( 'a' );
  45. nodeB = new Element( 'b' );
  46. } );
  47. it( 'insert at same position as merge', () => {
  48. let insertDelta = getInsertDelta( mergePosition, [ nodeA, nodeB ], baseVersion );
  49. let transformed = transform( mergeDelta, insertDelta );
  50. // Expected: MergeDelta gets ignored and is not applied.
  51. baseVersion = insertDelta.operations.length;
  52. expect( transformed.length ).to.equal( 1 );
  53. expectDelta( transformed[ 0 ], {
  54. type: Delta,
  55. operations: [
  56. {
  57. type: NoOperation,
  58. baseVersion: baseVersion
  59. }
  60. ]
  61. } );
  62. // Test if deltas do what they should after applying transformed delta.
  63. applyDelta( insertDelta, doc );
  64. applyDelta( transformed[ 0 ], doc );
  65. let nodesAndText = getNodesAndText( Range.createFromPositionAndShift( new Position( root, [ 3, 3, 0 ] ), 6 ) );
  66. // InsertDelta is applied. Merge between X and P is discarded.
  67. expect( nodesAndText ).to.equal( 'XXXXXabcdXAABBPabcfoobarxyzP' );
  68. } );
  69. it( 'insert inside merged node (sticky move test)', () => {
  70. let insertDelta = getInsertDelta( new Position( root, [ 3, 3, 3, 12 ] ), [ nodeA, nodeB ], baseVersion );
  71. let transformed = transform( mergeDelta, insertDelta );
  72. baseVersion = insertDelta.operations.length;
  73. expect( transformed.length ).to.equal( 1 );
  74. // Expected: MoveOperation in MergeDelta has it's "range" expanded.
  75. expectDelta( transformed[ 0 ], {
  76. type: MergeDelta,
  77. operations: [
  78. {
  79. type: MoveOperation,
  80. sourcePosition: new Position( root, [ 3, 3, 3, 0 ] ),
  81. howMany: 14,
  82. targetPosition: new Position( root, [ 3, 3, 2, 4 ] ),
  83. baseVersion: baseVersion
  84. },
  85. {
  86. // This is `MoveOperation` instead of `RemoveOperation` because during OT,
  87. // `RemoveOperation` may get converted to `MoveOperation`. Still, this expectation is
  88. // correct because `RemoveOperation` is deriving from `MoveOperation`. So we can expect
  89. // that something that was `RemoveOperation` is a `MoveOperation`.
  90. type: MoveOperation,
  91. sourcePosition: new Position( root, [ 3, 3, 3 ] ),
  92. howMany: 1,
  93. targetPosition: new Position( gy, [ 0 ] ),
  94. baseVersion: baseVersion + 1
  95. }
  96. ]
  97. } );
  98. // Test if deltas do what they should after applying transformed delta.
  99. applyDelta( insertDelta, doc );
  100. applyDelta( transformed[ 0 ], doc );
  101. let nodesAndText = getNodesAndText( Range.createFromPositionAndShift( new Position( root, [ 3, 3, 0 ] ), 3 ) );
  102. // InsertDelta is applied. Merge between X and P is discarded.
  103. expect( nodesAndText ).to.equal( 'XXXXXabcdabcfoobarxyzAABBX' );
  104. } );
  105. } );
  106. describe( 'MoveDelta', () => {
  107. it( 'node on the right side of merge was moved', () => {
  108. let moveDelta = getMoveDelta( new Position( root, [ 3, 3, 3 ] ), 1, new Position( root, [ 3, 3, 0 ] ), baseVersion );
  109. let transformed = transform( mergeDelta, moveDelta );
  110. baseVersion = moveDelta.operations.length;
  111. expect( transformed.length ).to.equal( 1 );
  112. expectDelta( transformed[ 0 ], {
  113. type: Delta,
  114. operations: [
  115. {
  116. type: NoOperation,
  117. baseVersion: baseVersion
  118. }
  119. ]
  120. } );
  121. // Test if deltas do what they should after applying transformed delta.
  122. applyDelta( moveDelta, doc );
  123. applyDelta( transformed[ 0 ], doc );
  124. let nodesAndText = getNodesAndText( Range.createFromPositionAndShift( new Position( root, [ 3, 3 ] ), 1 ) );
  125. // MoveDelta is applied. MergeDelta is discarded.
  126. expect( nodesAndText ).to.equal( 'DIVPabcfoobarxyzPXXXXXabcdXDIV' );
  127. } );
  128. it( 'node on the left side of merge was moved', () => {
  129. let moveDelta = getMoveDelta( new Position( root, [ 3, 3, 2 ] ), 1, new Position( root, [ 3, 3, 0 ] ), baseVersion );
  130. let transformed = transform( mergeDelta, moveDelta );
  131. expect( transformed.length ).to.equal( 1 );
  132. baseVersion = moveDelta.operations.length;
  133. expectDelta( transformed[ 0 ], {
  134. type: MergeDelta,
  135. operations: [
  136. {
  137. type: MoveOperation,
  138. sourcePosition: new Position( root, [ 3, 3, 3, 0 ] ),
  139. howMany: 12,
  140. targetPosition: new Position( root, [ 3, 3, 0, 4 ] ),
  141. baseVersion: baseVersion
  142. },
  143. {
  144. type: RemoveOperation,
  145. sourcePosition: new Position( root, [ 3, 3, 3 ] ),
  146. howMany: 1,
  147. baseVersion: baseVersion + 1
  148. }
  149. ]
  150. } );
  151. // Test if deltas do what they should after applying transformed delta.
  152. applyDelta( moveDelta, doc );
  153. applyDelta( transformed[ 0 ], doc );
  154. let nodesAndText = getNodesAndText( Range.createFromPositionAndShift( new Position( root, [ 3, 3 ] ), 1 ) );
  155. // MoveDelta is applied. MergeDelta is discarded.
  156. expect( nodesAndText ).to.equal( 'DIVXabcdabcfoobarxyzXXXXXDIV' );
  157. } );
  158. } );
  159. describe( 'MergeDelta', () => {
  160. it( 'merge two consecutive elements, transformed merge is after', () => {
  161. let mergeDeltaB = getMergeDelta( new Position( root, [ 3, 3, 2 ] ), 0, 4, baseVersion );
  162. let transformed = transform( mergeDelta, mergeDeltaB );
  163. expect( transformed.length ).to.equal( 1 );
  164. baseVersion = mergeDelta.operations.length;
  165. expectDelta( transformed[ 0 ], {
  166. type: MergeDelta,
  167. operations: [
  168. {
  169. type: MoveOperation,
  170. sourcePosition: new Position( root, [ 3, 3, 2, 0 ] ),
  171. howMany: 12,
  172. targetPosition: new Position( root, [ 3, 3, 1, 4 ] ),
  173. baseVersion: baseVersion
  174. },
  175. {
  176. type: RemoveOperation,
  177. sourcePosition: new Position( root, [ 3, 3, 2 ] ),
  178. howMany: 1
  179. }
  180. ]
  181. } );
  182. // Test if deltas do what they should after applying transformed delta.
  183. applyDelta( mergeDeltaB, doc );
  184. applyDelta( transformed[ 0 ], doc );
  185. let nodesAndText = getNodesAndText( Range.createFromPositionAndShift( new Position( root, [ 3, 3, 0 ] ), 2 ) );
  186. // Both merge deltas are applied and merged nodes children are together in one node.
  187. expect( nodesAndText ).to.equal( 'XXXabcdabcfoobarxyzX' );
  188. } );
  189. it( 'merge two consecutive elements, transformed merge is before', () => {
  190. mergeDelta = getMergeDelta( new Position( root, [ 3, 3, 2 ] ), 0, 4, baseVersion );
  191. let mergeDeltaB = getMergeDelta( new Position( root, [ 3, 3, 3 ] ), 4, 12, baseVersion );
  192. let transformed = transform( mergeDelta, mergeDeltaB );
  193. expect( transformed.length ).to.equal( 1 );
  194. baseVersion = mergeDelta.operations.length;
  195. expectDelta( transformed[ 0 ], {
  196. type: MergeDelta,
  197. operations: [
  198. {
  199. type: MoveOperation,
  200. sourcePosition: new Position( root, [ 3, 3, 2, 0 ] ),
  201. howMany: 16,
  202. targetPosition: new Position( root, [ 3, 3, 1, 0 ] ),
  203. baseVersion: baseVersion
  204. },
  205. {
  206. type: RemoveOperation,
  207. sourcePosition: new Position( root, [ 3, 3, 2 ] ),
  208. howMany: 1
  209. }
  210. ]
  211. } );
  212. // Test if deltas do what they should after applying transformed delta.
  213. applyDelta( mergeDeltaB, doc );
  214. applyDelta( transformed[ 0 ], doc );
  215. let nodesAndText = getNodesAndText( Range.createFromPositionAndShift( new Position( root, [ 3, 3, 0 ] ), 2 ) );
  216. // Both merge deltas are applied and merged nodes children are together in one node.
  217. expect( nodesAndText ).to.equal( 'XXXabcdabcfoobarxyzX' );
  218. } );
  219. } );
  220. } );
  221. } );