imageuploadprogress.js 6.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180
  1. /**
  2. * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. /* globals window */
  6. import ClassicTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/virtualtesteditor';
  7. import ImageEngine from '@ckeditor/ckeditor5-image/src/image/imageengine';
  8. import ImageUploadEngine from '../src/imageuploadengine';
  9. import ImageUploadProgress from '../src/imageuploadprogress';
  10. import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph';
  11. import FileRepository from '../src/filerepository';
  12. import { AdapterMock, createNativeFileMock, NativeFileReaderMock } from './_utils/mocks';
  13. import { setData as setModelData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model';
  14. import { getData as getViewData } from '@ckeditor/ckeditor5-engine/src/dev-utils/view';
  15. import { eventNameToConsumableType } from '@ckeditor/ckeditor5-engine/src/conversion/model-to-view-converters';
  16. import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils';
  17. import svgPlaceholder from '../theme/icons/image_placeholder.svg';
  18. describe( 'ImageUploadProgress', () => {
  19. const imagePlaceholder = encodeURIComponent( svgPlaceholder );
  20. // eslint-disable-next-line max-len
  21. const base64Sample = 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+A8AAQUBAScY42YAAAAASUVORK5CYII=';
  22. let editor, document, fileRepository, viewDocument, nativeReaderMock, loader, adapterMock;
  23. testUtils.createSinonSandbox();
  24. beforeEach( () => {
  25. testUtils.sinon.stub( window, 'FileReader' ).callsFake( () => {
  26. nativeReaderMock = new NativeFileReaderMock();
  27. return nativeReaderMock;
  28. } );
  29. return ClassicTestEditor
  30. .create( {
  31. plugins: [ ImageEngine, Paragraph, ImageUploadProgress ]
  32. } )
  33. .then( newEditor => {
  34. editor = newEditor;
  35. document = editor.document;
  36. viewDocument = editor.editing.view;
  37. fileRepository = editor.plugins.get( FileRepository );
  38. fileRepository.createAdapter = newLoader => {
  39. loader = newLoader;
  40. adapterMock = new AdapterMock( loader );
  41. return adapterMock;
  42. };
  43. } );
  44. } );
  45. it( 'should include ImageUploadEngine', () => {
  46. expect( editor.plugins.get( ImageUploadEngine ) ).to.be.instanceOf( ImageUploadEngine );
  47. } );
  48. it( 'should convert image\'s "reading" uploadStatus attribute', () => {
  49. setModelData( document, '<paragraph>[]foo</paragraph>' );
  50. editor.execute( 'imageUpload', { file: createNativeFileMock() } );
  51. expect( getViewData( viewDocument ) ).to.equal(
  52. '[<figure class="image ck-widget ck-appear ck-infinite-progress" contenteditable="false">' +
  53. `<img src="data:image/svg+xml;utf8,${ imagePlaceholder }"></img>` +
  54. '</figure>]<p>foo</p>'
  55. );
  56. } );
  57. it( 'should convert image\'s "uploading" uploadStatus attribute', done => {
  58. setModelData( document, '<paragraph>[]foo</paragraph>' );
  59. editor.execute( 'imageUpload', { file: createNativeFileMock() } );
  60. document.once( 'changesDone', () => {
  61. expect( getViewData( viewDocument ) ).to.equal(
  62. '[<figure class="image ck-widget ck-appear" contenteditable="false">' +
  63. `<img src="${ base64Sample }"></img>` +
  64. '<div class="ck-progress-bar"></div>' +
  65. '</figure>]<p>foo</p>'
  66. );
  67. done();
  68. } );
  69. nativeReaderMock.mockSuccess( base64Sample );
  70. } );
  71. it( 'should update progressbar width on progress', done => {
  72. setModelData( document, '<paragraph>[]foo</paragraph>' );
  73. editor.execute( 'imageUpload', { file: createNativeFileMock() } );
  74. document.once( 'changesDone', () => {
  75. adapterMock.mockProgress( 40, 100 );
  76. expect( getViewData( viewDocument ) ).to.equal(
  77. '[<figure class="image ck-widget ck-appear" contenteditable="false">' +
  78. `<img src="${ base64Sample }"></img>` +
  79. '<div class="ck-progress-bar" style="width:40%;"></div>' +
  80. '</figure>]<p>foo</p>'
  81. );
  82. done();
  83. } );
  84. nativeReaderMock.mockSuccess( base64Sample );
  85. } );
  86. it( 'should convert image\'s "complete" uploadStatus attribute', done => {
  87. setModelData( document, '<paragraph>[]foo</paragraph>' );
  88. editor.execute( 'imageUpload', { file: createNativeFileMock() } );
  89. document.once( 'changesDone', () => {
  90. document.once( 'changesDone', () => {
  91. expect( getViewData( viewDocument ) ).to.equal(
  92. '[<figure class="image ck-widget" contenteditable="false">' +
  93. '<img src="image.png"></img>' +
  94. '</figure>]<p>foo</p>'
  95. );
  96. done();
  97. } );
  98. adapterMock.mockSuccess( { default: 'image.png' } );
  99. } );
  100. nativeReaderMock.mockSuccess( base64Sample );
  101. } );
  102. it( 'should allow to customize placeholder image', () => {
  103. const uploadProgress = editor.plugins.get( ImageUploadProgress );
  104. uploadProgress.placeholder = base64Sample;
  105. setModelData( document, '<paragraph>[]foo</paragraph>' );
  106. editor.execute( 'imageUpload', { file: createNativeFileMock() } );
  107. expect( getViewData( viewDocument ) ).to.equal(
  108. '[<figure class="image ck-widget ck-appear ck-infinite-progress" contenteditable="false">' +
  109. `<img src="${ base64Sample }"></img>` +
  110. '</figure>]<p>foo</p>'
  111. );
  112. } );
  113. it( 'should not process attribute change if it is already consumed', () => {
  114. editor.editing.modelToView.on( 'addAttribute:uploadStatus:image', ( evt, data, consumable ) => {
  115. consumable.consume( data.item, eventNameToConsumableType( evt.name ) );
  116. }, { priority: 'highest' } );
  117. setModelData( document, '<paragraph>[]foo</paragraph>' );
  118. editor.execute( 'imageUpload', { file: createNativeFileMock() } );
  119. expect( getViewData( viewDocument ) ).to.equal(
  120. '[<figure class="image ck-widget" contenteditable="false"><img></img></figure>]<p>foo</p>'
  121. );
  122. } );
  123. it( 'should not show progress bar if there is no loader with given uploadId', () => {
  124. setModelData( document, '<image uploadId="123" uploadStatus="reading"></image>' );
  125. const image = document.getRoot().getChild( 0 );
  126. document.enqueueChanges( () => {
  127. document.batch().setAttribute( image, 'uploadStatus', 'uploading' );
  128. } );
  129. expect( getViewData( viewDocument ) ).to.equal(
  130. '[<figure class="image ck-widget ck-appear ck-infinite-progress" contenteditable="false">' +
  131. `<img src="data:image/svg+xml;utf8,${ imagePlaceholder }"></img>` +
  132. '</figure>]'
  133. );
  134. document.enqueueChanges( () => {
  135. document.batch().setAttribute( image, 'uploadStatus', 'complete' );
  136. } );
  137. expect( getViewData( viewDocument ) ).to.equal(
  138. '[<figure class="image ck-widget" contenteditable="false">' +
  139. `<img src="data:image/svg+xml;utf8,${ imagePlaceholder }"></img>` +
  140. '</figure>]'
  141. );
  142. } );
  143. } );