imageloadobserver.js 5.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188
  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 document, Event */
  6. import ImageLoadObserver from '../../src/image/imageloadobserver';
  7. import Observer from '@ckeditor/ckeditor5-engine/src/view/observer/observer';
  8. import View from '@ckeditor/ckeditor5-engine/src/view/view';
  9. import createViewRoot from '@ckeditor/ckeditor5-engine/tests/view/_utils/createroot';
  10. import { setData } from '@ckeditor/ckeditor5-engine/src/dev-utils/view';
  11. import { StylesProcessor } from '@ckeditor/ckeditor5-engine/src/view/stylesmap';
  12. describe( 'ImageLoadObserver', () => {
  13. let view, viewDocument, observer, domRoot, viewRoot;
  14. beforeEach( () => {
  15. view = new View( new StylesProcessor() );
  16. viewDocument = view.document;
  17. observer = view.addObserver( ImageLoadObserver );
  18. viewRoot = createViewRoot( viewDocument );
  19. domRoot = document.createElement( 'div' );
  20. view.attachDomRoot( domRoot );
  21. } );
  22. afterEach( () => {
  23. view.destroy();
  24. } );
  25. it( 'should extend Observer', () => {
  26. expect( observer ).instanceof( Observer );
  27. } );
  28. it( 'should fire `loadImage` event for images in the document that are loaded with a delay', () => {
  29. const spy = sinon.spy();
  30. viewDocument.on( 'imageLoaded', spy );
  31. setData( view, '<img src="/assets/sample.png" />' );
  32. sinon.assert.notCalled( spy );
  33. domRoot.querySelector( 'img' ).dispatchEvent( new Event( 'load' ) );
  34. sinon.assert.calledOnce( spy );
  35. } );
  36. it( 'should fire `layoutChanged` along with `imageLoaded` event', () => {
  37. const layoutChangedSpy = sinon.spy();
  38. const imageLoadedSpy = sinon.spy();
  39. view.document.on( 'layoutChanged', layoutChangedSpy );
  40. view.document.on( 'imageLoaded', imageLoadedSpy );
  41. observer._fireEvents( {} );
  42. sinon.assert.calledOnce( layoutChangedSpy );
  43. sinon.assert.calledOnce( imageLoadedSpy );
  44. } );
  45. it( 'should not fire events when observer is disabled', () => {
  46. const layoutChangedSpy = sinon.spy();
  47. const imageLoadedSpy = sinon.spy();
  48. view.document.on( 'layoutChanged', layoutChangedSpy );
  49. view.document.on( 'imageLoaded', imageLoadedSpy );
  50. observer.isEnabled = false;
  51. observer._fireEvents( {} );
  52. sinon.assert.notCalled( layoutChangedSpy );
  53. sinon.assert.notCalled( imageLoadedSpy );
  54. } );
  55. it( 'should not fire `loadImage` event for images removed from document', () => {
  56. const spy = sinon.spy();
  57. viewDocument.on( 'imageLoaded', spy );
  58. setData( view, '<img src="/assets/sample.png" />' );
  59. sinon.assert.notCalled( spy );
  60. const img = domRoot.querySelector( 'img' );
  61. setData( view, '' );
  62. img.dispatchEvent( new Event( 'load' ) );
  63. sinon.assert.notCalled( spy );
  64. } );
  65. it( 'should not fire `loadImage` event for non-image elements', () => {
  66. const spy = sinon.spy();
  67. viewDocument.on( 'imageLoaded', spy );
  68. setData( view, '<p>foo</p>' );
  69. sinon.assert.notCalled( spy );
  70. const img = domRoot.querySelector( 'p' );
  71. img.dispatchEvent( new Event( 'load' ) );
  72. sinon.assert.notCalled( spy );
  73. } );
  74. it( 'should not fire `loadImage` event if an image has `data-cke-ignore-events` attribute', () => {
  75. const spy = sinon.spy();
  76. viewDocument.on( 'imageLoaded', spy );
  77. setData( view, '<img src="/assets/sample.png" data-cke-ignore-events="true" />' );
  78. domRoot.querySelector( 'img' ).dispatchEvent( new Event( 'load' ) );
  79. sinon.assert.notCalled( spy );
  80. } );
  81. it( 'should not fire `loadImage` event if an image has an ancestor with `data-cke-ignore-events` attribute', () => {
  82. const spy = sinon.spy();
  83. viewDocument.on( 'imageLoaded', spy );
  84. setData( view, '<div data-cke-ignore-events="true"><p><img src="/assets/sample.png" /></p></div>' );
  85. domRoot.querySelector( 'img' ).dispatchEvent( new Event( 'load' ) );
  86. sinon.assert.notCalled( spy );
  87. } );
  88. it( 'should do nothing with an image when changes are in the other parent', () => {
  89. setData(
  90. view,
  91. '<container:p><attribute:b>foo</attribute:b></container:p><container:div><img src="/assets/sample.png" /></container:div>'
  92. );
  93. const viewP = viewRoot.getChild( 0 );
  94. const viewDiv = viewRoot.getChild( 1 );
  95. const mapSpy = sinon.spy( view.domConverter, 'mapViewToDom' );
  96. // Change only the paragraph.
  97. view.change( writer => {
  98. const text = writer.createText( 'foo', { b: true } );
  99. writer.insert( writer.createPositionAt( viewRoot.getChild( 0 ).getChild( 0 ), 0 ), text );
  100. writer.wrap( writer.createRangeOn( text ), writer.createAttributeElement( 'b' ) );
  101. } );
  102. sinon.assert.calledWith( mapSpy, viewP );
  103. sinon.assert.neverCalledWith( mapSpy, viewDiv );
  104. } );
  105. it( 'should not throw when synced child was removed in the meanwhile', () => {
  106. let viewDiv;
  107. const mapSpy = sinon.spy( view.domConverter, 'mapViewToDom' );
  108. view.change( writer => {
  109. viewDiv = writer.createContainerElement( 'div' );
  110. viewRoot.fire( 'change:children', viewDiv );
  111. } );
  112. expect( () => {
  113. view._renderer.render();
  114. sinon.assert.calledWith( mapSpy, viewDiv );
  115. } ).to.not.throw();
  116. } );
  117. it( 'should stop observing images on destroy', () => {
  118. const spy = sinon.spy();
  119. viewDocument.on( 'imageLoaded', spy );
  120. setData( view, '<img src="/assets/sample.png" />' );
  121. observer.destroy();
  122. domRoot.querySelector( 'img' ).dispatchEvent( new Event( 'load' ) );
  123. sinon.assert.notCalled( spy );
  124. } );
  125. } );