selectionobserver.js 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349
  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. /* globals setTimeout, document, console */
  6. import ViewRange from '../../../src/view/range';
  7. import DocumentSelection from '../../../src/view/documentselection';
  8. import ViewSelection from '../../../src/view/selection';
  9. import View from '../../../src/view/view';
  10. import SelectionObserver from '../../../src/view/observer/selectionobserver';
  11. import FocusObserver from '../../../src/view/observer/focusobserver';
  12. import createViewRoot from '../_utils/createroot';
  13. import { parse } from '../../../src/dev-utils/view';
  14. describe( 'SelectionObserver', () => {
  15. let view, viewDocument, viewRoot, selectionObserver, domRoot, domMain, domDocument;
  16. beforeEach( done => {
  17. domDocument = document;
  18. domRoot = domDocument.createElement( 'div' );
  19. domRoot.innerHTML = '<div contenteditable="true"></div><div contenteditable="true" id="additional"></div><p>X</p>';
  20. domMain = domRoot.childNodes[ 0 ];
  21. domDocument.body.appendChild( domRoot );
  22. view = new View();
  23. viewDocument = view.document;
  24. createViewRoot( viewDocument );
  25. view.attachDomRoot( domMain );
  26. selectionObserver = view.getObserver( SelectionObserver );
  27. viewRoot = viewDocument.getRoot();
  28. view.change( writer => {
  29. viewRoot._appendChild( parse(
  30. '<container:p>xxx<ui:span></ui:span></container:p>' +
  31. '<container:p>yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy</container:p>' ) );
  32. writer.setSelection( null );
  33. domDocument.getSelection().removeAllRanges();
  34. viewDocument.isFocused = true;
  35. domMain.focus();
  36. } );
  37. selectionObserver.enable();
  38. // Ensure selectionchange will not be fired.
  39. setTimeout( () => done(), 100 );
  40. } );
  41. afterEach( () => {
  42. sinon.restore();
  43. domRoot.parentElement.removeChild( domRoot );
  44. view.destroy();
  45. } );
  46. it( 'should fire selectionChange when it is the only change', done => {
  47. viewDocument.on( 'selectionChange', ( evt, data ) => {
  48. expect( data ).to.have.property( 'domSelection' ).that.equals( domDocument.getSelection() );
  49. expect( data ).to.have.property( 'oldSelection' ).that.is.instanceof( DocumentSelection );
  50. expect( data.oldSelection.rangeCount ).to.equal( 0 );
  51. expect( data ).to.have.property( 'newSelection' ).that.is.instanceof( ViewSelection );
  52. expect( data.newSelection.rangeCount ).to.equal( 1 );
  53. const newViewRange = data.newSelection.getFirstRange();
  54. const viewFoo = viewDocument.getRoot().getChild( 1 ).getChild( 0 );
  55. expect( newViewRange.start.parent ).to.equal( viewFoo );
  56. expect( newViewRange.start.offset ).to.equal( 2 );
  57. expect( newViewRange.end.parent ).to.equal( viewFoo );
  58. expect( newViewRange.end.offset ).to.equal( 2 );
  59. done();
  60. } );
  61. changeDomSelection();
  62. } );
  63. it( 'should add only one listener to one document', done => {
  64. // Add second roots to ensure that listener is added once.
  65. createViewRoot( viewDocument, 'div', 'additional' );
  66. view.attachDomRoot( domDocument.getElementById( 'additional' ), 'additional' );
  67. viewDocument.on( 'selectionChange', () => {
  68. done();
  69. } );
  70. changeDomSelection();
  71. } );
  72. it( 'should not fire selectionChange on render', done => {
  73. viewDocument.on( 'selectionChange', () => {
  74. throw 'selectionChange on render';
  75. } );
  76. setTimeout( done, 70 );
  77. const viewBar = viewDocument.getRoot().getChild( 1 ).getChild( 0 );
  78. view.change( writer => {
  79. writer.setSelection( ViewRange._createFromParentsAndOffsets( viewBar, 1, viewBar, 2 ) );
  80. } );
  81. } );
  82. it( 'should not fire if observer is disabled', done => {
  83. view.getObserver( SelectionObserver ).disable();
  84. viewDocument.on( 'selectionChange', () => {
  85. throw 'selectionChange on render';
  86. } );
  87. setTimeout( done, 70 );
  88. changeDomSelection();
  89. } );
  90. it( 'should not fire if the DOM selection was set outside editable', done => {
  91. const viewFoo = viewDocument.getRoot().getChild( 0 ).getChild( 0 );
  92. view.change( writer => {
  93. writer.setSelection( viewFoo, 0 );
  94. } );
  95. const spy = sinon.spy();
  96. viewDocument.on( 'selectionChange', spy );
  97. setTimeout( () => {
  98. expect( spy.called ).to.be.false;
  99. done();
  100. }, 70 );
  101. const domSelection = domDocument.getSelection();
  102. const domX = domRoot.childNodes[ 2 ].childNodes[ 0 ];
  103. domSelection.collapse( domX, 0 );
  104. } );
  105. it( 'should not enter infinite loop', () => {
  106. let counter = 70;
  107. const viewFoo = viewDocument.getRoot().getChild( 0 ).getChild( 0 );
  108. view.change( writer => {
  109. writer.setSelection( viewFoo, 0 );
  110. } );
  111. const selectionChangeSpy = sinon.spy();
  112. // Catches the "Selection change observer detected an infinite rendering loop." warning in the CK_DEBUG mode.
  113. sinon.stub( console, 'warn' );
  114. viewDocument.on( 'selectionChange', selectionChangeSpy );
  115. return new Promise( resolve => {
  116. viewDocument.on( 'selectionChangeDone', () => {
  117. expect( selectionChangeSpy.callCount ).to.equal( 60 );
  118. resolve();
  119. } );
  120. while ( counter > 0 ) {
  121. changeDomSelection();
  122. counter--;
  123. }
  124. } );
  125. } );
  126. it( 'should not be treated as an infinite loop if selection is changed only few times', done => {
  127. const viewFoo = viewDocument.getRoot().getChild( 0 ).getChild( 0 );
  128. viewDocument.selection._setTo( ViewRange._createFromParentsAndOffsets( viewFoo, 0, viewFoo, 0 ) );
  129. const consoleWarnSpy = sinon.spy( console, 'warn' );
  130. viewDocument.on( 'selectionChangeDone', () => {
  131. expect( consoleWarnSpy.called ).to.be.false;
  132. done();
  133. } );
  134. for ( let i = 0; i < 10; i++ ) {
  135. changeDomSelection();
  136. }
  137. } );
  138. it( 'should not be treated as an infinite loop if changes are not often', () => {
  139. const clock = sinon.useFakeTimers( {
  140. toFake: [ 'setInterval', 'clearInterval' ]
  141. } );
  142. const consoleWarnStub = sinon.stub( console, 'warn' );
  143. // We need to recreate SelectionObserver, so it will use mocked setInterval.
  144. selectionObserver.disable();
  145. selectionObserver.destroy();
  146. view._observers.delete( SelectionObserver );
  147. view.addObserver( SelectionObserver );
  148. return doChanges()
  149. .then( doChanges )
  150. .then( () => {
  151. sinon.assert.notCalled( consoleWarnStub );
  152. clock.restore();
  153. } );
  154. function doChanges() {
  155. return new Promise( resolve => {
  156. viewDocument.once( 'selectionChangeDone', () => {
  157. clock.tick( 1100 );
  158. resolve();
  159. } );
  160. for ( let i = 0; i < 50; i++ ) {
  161. changeDomSelection();
  162. }
  163. } );
  164. }
  165. } );
  166. it( 'should fire `selectionChangeDone` event after selection stop changing', done => {
  167. const spy = sinon.spy();
  168. viewDocument.on( 'selectionChangeDone', spy );
  169. // Disable focus observer to not re-render view on each focus.
  170. view.getObserver( FocusObserver ).disable();
  171. // Change selection.
  172. changeDomSelection();
  173. // Wait 100ms.
  174. setTimeout( () => {
  175. // Check if spy was called.
  176. expect( spy.notCalled ).to.true;
  177. // Change selection one more time.
  178. changeDomSelection();
  179. // Wait 210ms (debounced function should be called).
  180. setTimeout( () => {
  181. const data = spy.firstCall.args[ 1 ];
  182. expect( spy.calledOnce ).to.true;
  183. expect( data ).to.have.property( 'domSelection' ).to.equal( domDocument.getSelection() );
  184. expect( data ).to.have.property( 'oldSelection' ).to.instanceof( DocumentSelection );
  185. expect( data.oldSelection.rangeCount ).to.equal( 0 );
  186. expect( data ).to.have.property( 'newSelection' ).to.instanceof( ViewSelection );
  187. expect( data.newSelection.rangeCount ).to.equal( 1 );
  188. const newViewRange = data.newSelection.getFirstRange();
  189. const viewFoo = viewDocument.getRoot().getChild( 1 ).getChild( 0 );
  190. expect( newViewRange.start.parent ).to.equal( viewFoo );
  191. expect( newViewRange.start.offset ).to.equal( 3 );
  192. expect( newViewRange.end.parent ).to.equal( viewFoo );
  193. expect( newViewRange.end.offset ).to.equal( 3 );
  194. done();
  195. }, 210 );
  196. }, 100 );
  197. } );
  198. it( 'should not fire `selectionChangeDone` event when observer will be destroyed', done => {
  199. const spy = sinon.spy();
  200. viewDocument.on( 'selectionChangeDone', spy );
  201. // Change selection.
  202. changeDomSelection();
  203. // Wait 100ms.
  204. setTimeout( () => {
  205. // And destroy observer.
  206. selectionObserver.destroy();
  207. // Wait another 110ms.
  208. setTimeout( () => {
  209. // Check that event won't be called.
  210. expect( spy.notCalled ).to.true;
  211. done();
  212. }, 110 );
  213. }, 100 );
  214. } );
  215. it( 'should re-render view if selections are similar if DOM selection is in incorrect place', done => {
  216. const sel = domDocument.getSelection();
  217. const domParagraph = domMain.childNodes[ 0 ];
  218. const domText = domParagraph.childNodes[ 0 ];
  219. const domUI = domParagraph.childNodes[ 1 ];
  220. const viewRenderSpy = sinon.spy();
  221. // Add rendering on selectionChange event to check this feature.
  222. viewDocument.on( 'selectionChange', () => {
  223. // Manually set selection because no handlers are set for selectionChange event in this test.
  224. // Normally this is handled by view -> model -> view selection converters chain.
  225. const viewAnchor = view.domConverter.domPositionToView( sel.anchorNode, sel.anchorOffset );
  226. const viewFocus = view.domConverter.domPositionToView( sel.focusNode, sel.focusOffset );
  227. view.change( writer => {
  228. writer.setSelection( viewAnchor );
  229. writer.setSelectionFocus( viewFocus );
  230. } );
  231. } );
  232. viewDocument.once( 'selectionChange', () => {
  233. // 2. Selection change has been handled.
  234. selectionObserver.listenTo( domDocument, 'selectionchange', () => {
  235. // 4. Check if view was re-rendered.
  236. sinon.assert.calledOnce( viewRenderSpy );
  237. done();
  238. }, { priority: 'lowest' } );
  239. // 3. Now, collapse selection in similar position, but in UI element.
  240. // Current and new selection position are similar in view (but not equal!).
  241. // Also add a spy to `viewDocument#render` to see if view will be re-rendered.
  242. sel.collapse( domUI, 0 );
  243. view.on( 'render', viewRenderSpy );
  244. // Some browsers like Safari won't allow to put selection inside empty ui element.
  245. // In that situation selection should stay in correct place.
  246. if ( sel.anchorNode !== domUI ) {
  247. expect( sel.anchorNode ).to.equal( domText );
  248. expect( sel.anchorOffset ).to.equal( 3 );
  249. expect( sel.isCollapsed ).to.be.true;
  250. done();
  251. }
  252. }, { priority: 'lowest' } );
  253. // 1. Collapse in a text node, before ui element, and wait for async selectionchange to fire selection change handling.
  254. sel.collapse( domText, 3 );
  255. } );
  256. function changeDomSelection() {
  257. const domSelection = domDocument.getSelection();
  258. const domFoo = domMain.childNodes[ 1 ].childNodes[ 0 ];
  259. const offset = domSelection.anchorOffset;
  260. domSelection.collapse( domFoo, offset == 2 ? 3 : 2 );
  261. }
  262. } );