view.js 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600
  1. /* globals document */
  2. import View from '../../../src/view/view';
  3. import MutationObserver from '../../../src/view/observer/mutationobserver';
  4. import count from '@ckeditor/ckeditor5-utils/src/count';
  5. import KeyObserver from '../../../src/view/observer/keyobserver';
  6. import FakeSelectionObserver from '../../../src/view/observer/fakeselectionobserver';
  7. import SelectionObserver from '../../../src/view/observer/selectionobserver';
  8. import FocusObserver from '../../../src/view/observer/focusobserver';
  9. import CompositionObserver from '../../../src/view/observer/compositionobserver';
  10. import createViewRoot from '../_utils/createroot';
  11. import Observer from '../../../src/view/observer/observer';
  12. import log from '@ckeditor/ckeditor5-utils/src/log';
  13. import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils';
  14. import global from '@ckeditor/ckeditor5-utils/src/dom/global';
  15. import ViewRange from '../../../src/view/range';
  16. import RootEditableElement from '../../../src/view/rooteditableelement';
  17. import ViewElement from '../../../src/view/element';
  18. import ViewPosition from '../../../src/view/position';
  19. import { isBlockFiller, BR_FILLER } from '../../../src/view/filler';
  20. import createElement from '@ckeditor/ckeditor5-utils/src/dom/createelement';
  21. import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror';
  22. describe( 'view', () => {
  23. const DEFAULT_OBSERVERS_COUNT = 6;
  24. let domRoot, view, viewDocument, ObserverMock, instantiated, enabled, ObserverMockGlobalCount;
  25. testUtils.createSinonSandbox();
  26. beforeEach( () => {
  27. domRoot = createElement( document, 'div', {
  28. id: 'editor',
  29. contenteditable: 'true'
  30. } );
  31. document.body.appendChild( domRoot );
  32. view = new View();
  33. viewDocument = view.document;
  34. ObserverMock = class extends Observer {
  35. constructor( view ) {
  36. super( view );
  37. this.enable = sinon.spy();
  38. this.disable = sinon.spy();
  39. this.observe = sinon.spy();
  40. }
  41. };
  42. instantiated = 0;
  43. enabled = 0;
  44. ObserverMockGlobalCount = class extends Observer {
  45. constructor( view ) {
  46. super( view );
  47. instantiated++;
  48. this.observe = sinon.spy();
  49. }
  50. enable() {
  51. enabled++;
  52. }
  53. };
  54. } );
  55. afterEach( () => {
  56. domRoot.remove();
  57. view.destroy();
  58. } );
  59. it( 'should add default observers', () => {
  60. expect( count( view._observers ) ).to.equal( DEFAULT_OBSERVERS_COUNT );
  61. expect( view.getObserver( MutationObserver ) ).to.be.instanceof( MutationObserver );
  62. expect( view.getObserver( SelectionObserver ) ).to.be.instanceof( SelectionObserver );
  63. expect( view.getObserver( FocusObserver ) ).to.be.instanceof( FocusObserver );
  64. expect( view.getObserver( KeyObserver ) ).to.be.instanceof( KeyObserver );
  65. expect( view.getObserver( FakeSelectionObserver ) ).to.be.instanceof( FakeSelectionObserver );
  66. expect( view.getObserver( CompositionObserver ) ).to.be.instanceof( CompositionObserver );
  67. } );
  68. describe( 'attachDomRoot()', () => {
  69. it( 'should attach DOM element to main view element', () => {
  70. const domDiv = document.createElement( 'div' );
  71. const viewRoot = createViewRoot( viewDocument, 'div', 'main' );
  72. expect( count( view.domRoots ) ).to.equal( 0 );
  73. view.attachDomRoot( domDiv );
  74. expect( count( view.domRoots ) ).to.equal( 1 );
  75. expect( view.getDomRoot() ).to.equal( domDiv );
  76. expect( view.domConverter.mapViewToDom( viewRoot ) ).to.equal( domDiv );
  77. expect( view._renderer.markedChildren.has( viewRoot ) ).to.be.true;
  78. domDiv.remove();
  79. } );
  80. it( 'should attach DOM element to custom view element', () => {
  81. const domH1 = document.createElement( 'h1' );
  82. const viewH1 = createViewRoot( viewDocument, 'h1', 'header' );
  83. expect( count( view.domRoots ) ).to.equal( 0 );
  84. view.attachDomRoot( domH1, 'header' );
  85. expect( count( view.domRoots ) ).to.equal( 1 );
  86. expect( view.getDomRoot( 'header' ) ).to.equal( domH1 );
  87. expect( view.domConverter.mapViewToDom( viewH1 ) ).to.equal( domH1 );
  88. expect( view._renderer.markedChildren.has( viewH1 ) ).to.be.true;
  89. } );
  90. it( 'should call observe on each observer', () => {
  91. // The variable will be overwritten.
  92. view.destroy();
  93. view = new View();
  94. viewDocument = view.document;
  95. view._renderer.render = sinon.spy();
  96. const domDiv1 = document.createElement( 'div' );
  97. domDiv1.setAttribute( 'id', 'editor' );
  98. const domDiv2 = document.createElement( 'div' );
  99. domDiv2.setAttribute( 'id', 'editor' );
  100. const observerMock = view.addObserver( ObserverMock );
  101. const observerMockGlobalCount = view.addObserver( ObserverMockGlobalCount );
  102. createViewRoot( viewDocument, 'div', 'root1' );
  103. view.attachDomRoot( document.createElement( 'div' ), 'root1' );
  104. sinon.assert.calledOnce( observerMock.observe );
  105. sinon.assert.calledOnce( observerMockGlobalCount.observe );
  106. } );
  107. } );
  108. describe( 'addObserver()', () => {
  109. beforeEach( () => {
  110. // The variable will be overwritten.
  111. view.destroy();
  112. view = new View();
  113. viewDocument = view.document;
  114. view._renderer.render = sinon.spy();
  115. } );
  116. afterEach( () => {
  117. view.destroy();
  118. } );
  119. it( 'should be instantiated and enabled on adding', () => {
  120. const observerMock = view.addObserver( ObserverMock );
  121. expect( view._observers.size ).to.equal( DEFAULT_OBSERVERS_COUNT + 1 );
  122. expect( observerMock ).to.have.property( 'document', viewDocument );
  123. sinon.assert.calledOnce( observerMock.enable );
  124. } );
  125. it( 'should return observer instance each time addObserver is called', () => {
  126. const observerMock1 = view.addObserver( ObserverMock );
  127. const observerMock2 = view.addObserver( ObserverMock );
  128. expect( observerMock1 ).to.be.instanceof( ObserverMock );
  129. expect( observerMock2 ).to.be.instanceof( ObserverMock );
  130. expect( observerMock1 ).to.equals( observerMock2 );
  131. } );
  132. it( 'should instantiate one observer only once', () => {
  133. view.addObserver( ObserverMockGlobalCount );
  134. view.addObserver( ObserverMockGlobalCount );
  135. expect( view._observers.size ).to.equal( DEFAULT_OBSERVERS_COUNT + 1 );
  136. expect( instantiated ).to.equal( 1 );
  137. expect( enabled ).to.equal( 1 );
  138. view.addObserver( ObserverMock );
  139. expect( view._observers.size ).to.equal( DEFAULT_OBSERVERS_COUNT + 2 );
  140. } );
  141. it( 'should instantiate child class of already registered observer', () => {
  142. class ObserverMock extends Observer {
  143. enable() {}
  144. }
  145. class ChildObserverMock extends ObserverMock {
  146. enable() {}
  147. }
  148. view.addObserver( ObserverMock );
  149. view.addObserver( ChildObserverMock );
  150. expect( view._observers.size ).to.equal( DEFAULT_OBSERVERS_COUNT + 2 );
  151. } );
  152. it( 'should be disabled and re-enabled on render', () => {
  153. const observerMock = view.addObserver( ObserverMock );
  154. view.render();
  155. sinon.assert.calledOnce( observerMock.disable );
  156. sinon.assert.calledOnce( view._renderer.render );
  157. sinon.assert.calledTwice( observerMock.enable );
  158. } );
  159. it( 'should call observe on each root', () => {
  160. createViewRoot( viewDocument, 'div', 'roo1' );
  161. createViewRoot( viewDocument, 'div', 'roo2' );
  162. view.attachDomRoot( document.createElement( 'div' ), 'roo1' );
  163. view.attachDomRoot( document.createElement( 'div' ), 'roo2' );
  164. const observerMock = view.addObserver( ObserverMock );
  165. sinon.assert.calledTwice( observerMock.observe );
  166. } );
  167. } );
  168. describe( 'getObserver()', () => {
  169. it( 'should return observer it it is added', () => {
  170. const addedObserverMock = view.addObserver( ObserverMock );
  171. const getObserverMock = view.getObserver( ObserverMock );
  172. expect( getObserverMock ).to.be.instanceof( ObserverMock );
  173. expect( getObserverMock ).to.equal( addedObserverMock );
  174. } );
  175. it( 'should return undefined if observer is not added', () => {
  176. const getObserverMock = view.getObserver( ObserverMock );
  177. expect( getObserverMock ).to.be.undefined;
  178. } );
  179. } );
  180. describe( 'scrollToTheSelection()', () => {
  181. beforeEach( () => {
  182. // Silence the Rect warnings.
  183. testUtils.sinon.stub( log, 'warn' );
  184. } );
  185. it( 'does nothing when there are no ranges in the selection', () => {
  186. const stub = testUtils.sinon.stub( global.window, 'scrollTo' );
  187. view.scrollToTheSelection();
  188. sinon.assert.notCalled( stub );
  189. } );
  190. it( 'scrolls to the first range in selection with an offset', () => {
  191. const root = createViewRoot( viewDocument, 'div', 'main' );
  192. const stub = testUtils.sinon.stub( global.window, 'scrollTo' );
  193. const range = ViewRange.createIn( root );
  194. view.attachDomRoot( domRoot );
  195. // Make sure the window will have to scroll to the domRoot.
  196. Object.assign( domRoot.style, {
  197. position: 'absolute',
  198. top: '-1000px',
  199. left: '-1000px'
  200. } );
  201. view.change( writer => {
  202. writer.setSelection( range );
  203. } );
  204. view.scrollToTheSelection();
  205. sinon.assert.calledWithMatch( stub, sinon.match.number, sinon.match.number );
  206. } );
  207. } );
  208. describe( 'disableObservers()', () => {
  209. it( 'should disable observers', () => {
  210. const addedObserverMock = view.addObserver( ObserverMock );
  211. expect( addedObserverMock.enable.calledOnce ).to.be.true;
  212. expect( addedObserverMock.disable.called ).to.be.false;
  213. view.disableObservers();
  214. expect( addedObserverMock.enable.calledOnce ).to.be.true;
  215. expect( addedObserverMock.disable.calledOnce ).to.be.true;
  216. } );
  217. } );
  218. describe( 'enableObservers()', () => {
  219. it( 'should enable observers', () => {
  220. const addedObserverMock = view.addObserver( ObserverMock );
  221. view.disableObservers();
  222. expect( addedObserverMock.enable.calledOnce ).to.be.true;
  223. expect( addedObserverMock.disable.calledOnce ).to.be.true;
  224. view.enableObservers();
  225. expect( addedObserverMock.enable.calledTwice ).to.be.true;
  226. expect( addedObserverMock.disable.calledOnce ).to.be.true;
  227. } );
  228. } );
  229. describe( 'focus()', () => {
  230. let domEditable, viewEditable;
  231. beforeEach( () => {
  232. domEditable = document.createElement( 'div' );
  233. domEditable.setAttribute( 'contenteditable', 'true' );
  234. document.body.appendChild( domEditable );
  235. viewEditable = createViewRoot( viewDocument, 'div', 'main' );
  236. view.attachDomRoot( domEditable );
  237. view.change( writer => {
  238. writer.setSelection( viewEditable, 0 );
  239. } );
  240. } );
  241. afterEach( () => {
  242. document.body.removeChild( domEditable );
  243. } );
  244. it( 'should focus editable with selection', () => {
  245. const converterFocusSpy = testUtils.sinon.spy( view.domConverter, 'focus' );
  246. const renderSpy = testUtils.sinon.spy( view, 'render' );
  247. view.focus();
  248. expect( converterFocusSpy.called ).to.be.true;
  249. expect( renderSpy.calledOnce ).to.be.true;
  250. expect( document.activeElement ).to.equal( domEditable );
  251. const domSelection = document.getSelection();
  252. expect( domSelection.rangeCount ).to.equal( 1 );
  253. const domRange = domSelection.getRangeAt( 0 );
  254. expect( domRange.startContainer ).to.equal( domEditable );
  255. expect( domRange.startOffset ).to.equal( 0 );
  256. expect( domRange.collapsed ).to.be.true;
  257. } );
  258. it( 'should not focus if document is already focused', () => {
  259. const converterFocusSpy = testUtils.sinon.spy( view.domConverter, 'focus' );
  260. const renderSpy = testUtils.sinon.spy( view, 'render' );
  261. viewDocument.isFocused = true;
  262. view.focus();
  263. expect( converterFocusSpy.called ).to.be.false;
  264. expect( renderSpy.called ).to.be.false;
  265. } );
  266. it( 'should log warning when no selection', () => {
  267. const logSpy = testUtils.sinon.stub( log, 'warn' );
  268. view.change( writer => {
  269. writer.setSelection( null );
  270. } );
  271. view.focus();
  272. expect( logSpy.calledOnce ).to.be.true;
  273. expect( logSpy.args[ 0 ][ 0 ] ).to.match( /^view-focus-no-selection/ );
  274. } );
  275. } );
  276. describe( 'isFocused', () => {
  277. it( 'should change renderer.isFocused too', () => {
  278. expect( viewDocument.isFocused ).to.equal( false );
  279. expect( view._renderer.isFocused ).to.equal( false );
  280. viewDocument.isFocused = true;
  281. expect( viewDocument.isFocused ).to.equal( true );
  282. expect( view._renderer.isFocused ).to.equal( true );
  283. } );
  284. } );
  285. describe( 'render()', () => {
  286. it( 'disable observers, renders and enable observers', () => {
  287. const observerMock = view.addObserver( ObserverMock );
  288. const renderStub = sinon.stub( view._renderer, 'render' );
  289. view.render();
  290. sinon.assert.callOrder( observerMock.disable, renderStub, observerMock.enable );
  291. } );
  292. } );
  293. describe( 'view and DOM integration', () => {
  294. it( 'should remove content of the DOM', () => {
  295. const domDiv = createElement( document, 'div', { id: 'editor' }, [
  296. createElement( document, 'p' ),
  297. createElement( document, 'p' )
  298. ] );
  299. const view = new View();
  300. const viewDocument = view.document;
  301. createRoot( 'div', 'main', viewDocument );
  302. view.attachDomRoot( domDiv );
  303. view.render();
  304. expect( domDiv.childNodes.length ).to.equal( 1 );
  305. expect( isBlockFiller( domDiv.childNodes[ 0 ], BR_FILLER ) ).to.be.true;
  306. view.destroy();
  307. domDiv.remove();
  308. } );
  309. it( 'should render changes in the Document', () => {
  310. const domDiv = document.createElement( 'div' );
  311. const view = new View();
  312. const viewDocument = view.document;
  313. createRoot( 'div', 'main', viewDocument );
  314. view.attachDomRoot( domDiv );
  315. viewDocument.getRoot().appendChildren( new ViewElement( 'p' ) );
  316. view.render();
  317. expect( domDiv.childNodes.length ).to.equal( 1 );
  318. expect( domDiv.childNodes[ 0 ].tagName ).to.equal( 'P' );
  319. view.destroy();
  320. } );
  321. it( 'should render attribute changes', () => {
  322. const domRoot = document.createElement( 'div' );
  323. const view = new View();
  324. const viewDocument = view.document;
  325. const viewRoot = createRoot( 'div', 'main', viewDocument );
  326. view.attachDomRoot( domRoot );
  327. const viewP = new ViewElement( 'p', { class: 'foo' } );
  328. viewRoot.appendChildren( viewP );
  329. view.render();
  330. expect( domRoot.childNodes.length ).to.equal( 1 );
  331. expect( domRoot.childNodes[ 0 ].getAttribute( 'class' ) ).to.equal( 'foo' );
  332. viewP._setAttribute( 'class', 'bar' );
  333. view.render();
  334. expect( domRoot.childNodes.length ).to.equal( 1 );
  335. expect( domRoot.childNodes[ 0 ].getAttribute( 'class' ) ).to.equal( 'bar' );
  336. view.destroy();
  337. domRoot.remove();
  338. } );
  339. } );
  340. describe( 'change()', () => {
  341. it( 'should throw when someone tries to change view during rendering', () => {
  342. const domDiv = document.createElement( 'div' );
  343. const viewRoot = createViewRoot( viewDocument, 'div', 'main' );
  344. let renderingCalled = false;
  345. view.attachDomRoot( domDiv );
  346. view.change( writer => {
  347. const p = writer.createContainerElement( 'p' );
  348. const ui = writer.createUIElement( 'span', null, function( domDocument ) {
  349. const element = this.toDomElement( domDocument );
  350. expect( () => view.change( () => {} ) ).to.throw( CKEditorError, /^cannot-change-view-tree/ );
  351. renderingCalled = true;
  352. return element;
  353. } );
  354. writer.insert( ViewPosition.createAt( p ), ui );
  355. writer.insert( ViewPosition.createAt( viewRoot ), p );
  356. } );
  357. expect( renderingCalled ).to.be.true;
  358. domDiv.remove();
  359. } );
  360. it( 'should throw when someone tries to use change() method in post fixer', () => {
  361. const domDiv = document.createElement( 'div' );
  362. createViewRoot( viewDocument, 'div', 'main' );
  363. view.attachDomRoot( domDiv );
  364. viewDocument.registerPostFixer( () => {
  365. expect( () => {
  366. view.change( () => {} );
  367. } ).to.throw( CKEditorError, /^cannot-change-view-tree/ );
  368. } );
  369. view.render();
  370. domDiv.remove();
  371. } );
  372. it( 'should fire render event and it should trigger rendering before listeners on normal priority', () => {
  373. const renderSpy = sinon.spy( view._renderer, 'render' );
  374. const eventSpy = sinon.spy();
  375. view.on( 'render', eventSpy );
  376. view.change( () => {} );
  377. sinon.assert.callOrder( renderSpy, eventSpy );
  378. } );
  379. it( 'should fire render event once for nested change blocks', () => {
  380. const renderSpy = sinon.spy( view._renderer, 'render' );
  381. const eventSpy = sinon.spy();
  382. view.on( 'render', eventSpy );
  383. view.change( () => {
  384. view.change( () => {} );
  385. view.change( () => {
  386. view.change( () => {} );
  387. view.change( () => {} );
  388. } );
  389. view.change( () => {} );
  390. } );
  391. sinon.assert.calledOnce( renderSpy );
  392. sinon.assert.calledOnce( eventSpy );
  393. sinon.assert.callOrder( renderSpy, eventSpy );
  394. } );
  395. it( 'should fire render event once even if render is called during the change', () => {
  396. const renderSpy = sinon.spy( view._renderer, 'render' );
  397. const eventSpy = sinon.spy();
  398. view.on( 'render', eventSpy );
  399. view.change( () => {
  400. view.render();
  401. view.change( () => {
  402. view.render();
  403. } );
  404. view.render();
  405. } );
  406. sinon.assert.calledOnce( renderSpy );
  407. sinon.assert.calledOnce( eventSpy );
  408. sinon.assert.callOrder( renderSpy, eventSpy );
  409. } );
  410. it( 'should call post fixers after change but before rendering', () => {
  411. const postFixer1 = sinon.spy( () => false );
  412. const postFixer2 = sinon.spy( () => false );
  413. const changeSpy = sinon.spy();
  414. const eventSpy = sinon.spy();
  415. viewDocument.registerPostFixer( postFixer1 );
  416. viewDocument.registerPostFixer( postFixer2 );
  417. view.on( 'render', eventSpy );
  418. view.change( changeSpy );
  419. sinon.assert.calledOnce( postFixer1 );
  420. sinon.assert.calledOnce( postFixer2 );
  421. sinon.assert.calledOnce( changeSpy );
  422. sinon.assert.calledOnce( eventSpy );
  423. sinon.assert.callOrder( changeSpy, postFixer1, postFixer2, eventSpy );
  424. } );
  425. it( 'should call post fixers until all are done', () => {
  426. let called = false;
  427. const postFixer1 = sinon.spy();
  428. const postFixer2 = sinon.spy();
  429. const changeSpy = sinon.spy();
  430. const eventSpy = sinon.spy();
  431. viewDocument.registerPostFixer( () => {
  432. if ( !called ) {
  433. called = true;
  434. postFixer1();
  435. return true;
  436. }
  437. postFixer2();
  438. return false;
  439. } );
  440. view.on( 'render', eventSpy );
  441. view.change( changeSpy );
  442. sinon.assert.calledOnce( postFixer1 );
  443. sinon.assert.calledOnce( postFixer2 );
  444. sinon.assert.calledOnce( changeSpy );
  445. sinon.assert.calledOnce( eventSpy );
  446. sinon.assert.callOrder( changeSpy, postFixer1, postFixer2, eventSpy );
  447. } );
  448. } );
  449. function createRoot( name, rootName, viewDoc ) {
  450. const viewRoot = new RootEditableElement( name );
  451. viewRoot.rootName = rootName;
  452. viewRoot._document = viewDoc;
  453. viewDoc.roots.add( viewRoot );
  454. return viewRoot;
  455. }
  456. } );