view.js 19 KB

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