imageuploadprogress.js 6.9 KB

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