selectionobserver.js 11 KB

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