changebuffer.js 6.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287
  1. /**
  2. * @license Copyright (c) 2003-2020, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  4. */
  5. import ChangeBuffer from '../../src/utils/changebuffer';
  6. import Model from '@ckeditor/ckeditor5-engine/src/model/model';
  7. import Batch from '@ckeditor/ckeditor5-engine/src/model/batch';
  8. describe( 'ChangeBuffer', () => {
  9. const CHANGE_LIMIT = 3;
  10. let model, doc, buffer, root;
  11. beforeEach( () => {
  12. model = new Model();
  13. doc = model.document;
  14. root = doc.createRoot();
  15. buffer = new ChangeBuffer( model, CHANGE_LIMIT );
  16. } );
  17. describe( 'constructor()', () => {
  18. it( 'sets all properties', () => {
  19. expect( buffer ).to.have.property( 'model', model );
  20. expect( buffer ).to.have.property( 'limit', CHANGE_LIMIT );
  21. expect( buffer ).to.have.property( 'size', 0 );
  22. expect( buffer ).to.have.property( 'isLocked', false );
  23. } );
  24. it( 'sets limit property according to default value', () => {
  25. buffer = new ChangeBuffer( model );
  26. expect( buffer ).to.have.property( 'limit', 20 );
  27. } );
  28. } );
  29. describe( 'locking', () => {
  30. it( 'is unlocked by default', () => {
  31. expect( buffer.isLocked ).to.be.false;
  32. } );
  33. it( 'is locked by lock method', () => {
  34. buffer.lock();
  35. expect( buffer.isLocked ).to.be.true;
  36. } );
  37. it( 'is unlocked by unlock method', () => {
  38. buffer.isLocked = true;
  39. buffer.unlock();
  40. expect( buffer.isLocked ).to.be.false;
  41. } );
  42. } );
  43. describe( 'batch', () => {
  44. it( 'it is set initially', () => {
  45. expect( buffer ).to.have.property( 'batch' );
  46. expect( buffer.batch ).to.be.instanceof( Batch );
  47. } );
  48. it( 'is reset once changes reaches the limit', () => {
  49. const batch1 = buffer.batch;
  50. buffer.input( CHANGE_LIMIT - 1 );
  51. expect( buffer.batch ).to.equal( batch1 );
  52. buffer.input( 1 );
  53. const batch2 = buffer.batch;
  54. expect( batch2 ).to.be.instanceof( Batch );
  55. expect( batch2 ).to.not.equal( batch1 );
  56. expect( buffer.size ).to.equal( 0 );
  57. } );
  58. it( 'is reset once changes exceedes the limit', () => {
  59. const batch1 = buffer.batch;
  60. // Exceed the limit with one big jump to ensure that >= operator was used.
  61. buffer.input( CHANGE_LIMIT + 1 );
  62. expect( buffer.batch ).to.not.equal( batch1 );
  63. expect( buffer.size ).to.equal( 0 );
  64. } );
  65. it( 'is reset once a new batch appears in the document', () => {
  66. const batch1 = buffer.batch;
  67. // Ensure that size is reset too.
  68. buffer.input( 1 );
  69. model.change( writer => {
  70. writer.insertText( 'a', root );
  71. } );
  72. expect( buffer.batch ).to.not.equal( batch1 );
  73. expect( buffer.size ).to.equal( 0 );
  74. } );
  75. it( 'is not reset when changes are added to the buffer\'s batch', () => {
  76. const batch1 = buffer.batch;
  77. model.enqueueChange( buffer.batch, writer => {
  78. writer.insert( 'a', root );
  79. } );
  80. expect( buffer.batch ).to.equal( batch1 );
  81. model.enqueueChange( buffer.batch, writer => {
  82. writer.insert( 'b', root );
  83. } );
  84. expect( buffer.batch ).to.equal( batch1 );
  85. } );
  86. it( 'is not reset when changes are added to batch which existed previously', () => {
  87. const externalBatch = model.createBatch();
  88. model.change( writer => {
  89. writer.insertText( 'a', root );
  90. } );
  91. model.enqueueChange( externalBatch, writer => {
  92. writer.insertText( 'a', root );
  93. } );
  94. const bufferBatch = buffer.batch;
  95. model.enqueueChange( bufferBatch, writer => {
  96. writer.insertText( 'b', root );
  97. } );
  98. expect( buffer.batch ).to.equal( bufferBatch );
  99. model.change( writer => {
  100. writer.insertText( 'c', root );
  101. } );
  102. expect( buffer.batch ).to.not.equal( bufferBatch );
  103. } );
  104. it( 'is not reset when changes are applied in transparent batch', () => {
  105. const bufferBatch = buffer.batch;
  106. model.enqueueChange( 'transparent', writer => {
  107. writer.insert( 'a', root );
  108. } );
  109. expect( buffer.batch ).to.equal( bufferBatch );
  110. } );
  111. it( 'is not reset while locked', () => {
  112. const initialBatch = buffer.batch;
  113. buffer.lock();
  114. buffer.input( 1 );
  115. buffer._reset();
  116. buffer.unlock();
  117. expect( buffer.batch ).to.equal( initialBatch );
  118. expect( buffer.size ).to.equal( 1 );
  119. } );
  120. it( 'is reset while locked with ignoreLock used', () => {
  121. const initialBatch = buffer.batch;
  122. buffer.lock();
  123. buffer.input( 1 );
  124. buffer._reset( true );
  125. buffer.unlock();
  126. expect( buffer.batch ).to.not.equal( initialBatch );
  127. expect( buffer.size ).to.equal( 0 );
  128. } );
  129. it( 'is reset while locked and limit exceeded', () => {
  130. const initialBatch = buffer.batch;
  131. buffer.lock();
  132. buffer.input( CHANGE_LIMIT + 1 );
  133. buffer.unlock();
  134. expect( buffer.batch ).to.not.equal( initialBatch );
  135. expect( buffer.size ).to.equal( 0 );
  136. } );
  137. it( 'is reset while locked and new batch is applied', () => {
  138. const initialBatch = buffer.batch;
  139. buffer.lock();
  140. model.change( writer => {
  141. writer.insertText( 'a', root );
  142. } );
  143. buffer.unlock();
  144. expect( buffer.batch ).to.not.equal( initialBatch );
  145. expect( buffer.size ).to.equal( 0 );
  146. } );
  147. it( 'is reset on selection change:range', () => {
  148. const initialBatch = buffer.batch;
  149. doc.selection.fire( 'change:range' );
  150. expect( buffer.batch ).to.not.equal( initialBatch );
  151. expect( buffer.size ).to.equal( 0 );
  152. } );
  153. it( 'is reset on selection change:attribute', () => {
  154. const initialBatch = buffer.batch;
  155. doc.selection.fire( 'change:attribute' );
  156. expect( buffer.batch ).to.not.equal( initialBatch );
  157. expect( buffer.size ).to.equal( 0 );
  158. } );
  159. it( 'is not reset on selection change:range while locked', () => {
  160. const initialBatch = buffer.batch;
  161. buffer.size = 1;
  162. buffer.lock();
  163. doc.selection.fire( 'change:range' );
  164. buffer.unlock();
  165. expect( buffer.batch ).to.equal( initialBatch );
  166. expect( buffer.size ).to.equal( 1 );
  167. } );
  168. it( 'is not reset on selection change:attribute while locked', () => {
  169. const initialBatch = buffer.batch;
  170. buffer.size = 1;
  171. buffer.lock();
  172. doc.selection.fire( 'change:attribute' );
  173. buffer.unlock();
  174. expect( buffer.batch ).to.equal( initialBatch );
  175. expect( buffer.size ).to.equal( 1 );
  176. } );
  177. } );
  178. describe( 'destroy()', () => {
  179. it( 'offs the buffer from the document', () => {
  180. const batch1 = buffer.batch;
  181. buffer.destroy();
  182. model.change( writer => {
  183. writer.insertText( 'a', root );
  184. } );
  185. expect( buffer.batch ).to.equal( batch1 );
  186. } );
  187. it( 'offs the buffer from the selection change:range', () => {
  188. const batch1 = buffer.batch;
  189. buffer.destroy();
  190. doc.selection.fire( 'change:attribute' );
  191. expect( buffer.batch ).to.equal( batch1 );
  192. } );
  193. it( 'offs the buffer from the selection change:attribute', () => {
  194. const batch1 = buffer.batch;
  195. buffer.destroy();
  196. doc.selection.fire( 'change:range' );
  197. expect( buffer.batch ).to.equal( batch1 );
  198. } );
  199. } );
  200. } );