imageuploadprogress.js 9.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266
  1. /**
  2. * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. /* globals window, setTimeout */
  6. import VirtualTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/virtualtesteditor';
  7. import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
  8. import ImageEditing from '../../src/image/imageediting';
  9. import ImageUploadEditing from '../../src/imageupload/imageuploadediting';
  10. import ImageUploadProgress from '../../src/imageupload/imageuploadprogress';
  11. import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph';
  12. import FileRepository from '@ckeditor/ckeditor5-upload/src/filerepository';
  13. import { UploadAdapterMock, createNativeFileMock, NativeFileReaderMock } from '@ckeditor/ckeditor5-upload/tests/_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 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, model, document, fileRepository, view, nativeReaderMock, loader, adapterMock;
  23. class UploadAdapterPluginMock extends Plugin {
  24. init() {
  25. fileRepository = this.editor.plugins.get( FileRepository );
  26. fileRepository.createUploadAdapter = newLoader => {
  27. loader = newLoader;
  28. adapterMock = new UploadAdapterMock( loader );
  29. return adapterMock;
  30. };
  31. }
  32. }
  33. testUtils.createSinonSandbox();
  34. beforeEach( () => {
  35. testUtils.sinon.stub( window, 'FileReader' ).callsFake( () => {
  36. nativeReaderMock = new NativeFileReaderMock();
  37. return nativeReaderMock;
  38. } );
  39. return VirtualTestEditor
  40. .create( {
  41. plugins: [ ImageEditing, Paragraph, ImageUploadEditing, ImageUploadProgress, UploadAdapterPluginMock ]
  42. } )
  43. .then( newEditor => {
  44. editor = newEditor;
  45. model = editor.model;
  46. document = model.document;
  47. view = editor.editing.view;
  48. fileRepository = editor.plugins.get( FileRepository );
  49. fileRepository.createUploadAdapter = newLoader => {
  50. loader = newLoader;
  51. adapterMock = new UploadAdapterMock( loader );
  52. return adapterMock;
  53. };
  54. } );
  55. } );
  56. it( 'should convert image\'s "reading" uploadStatus attribute', () => {
  57. setModelData( model, '<paragraph>[]foo</paragraph>' );
  58. editor.execute( 'imageUpload', { file: createNativeFileMock() } );
  59. expect( getViewData( view ) ).to.equal(
  60. '[<figure class="ck-appear ck-image-upload-placeholder ck-infinite-progress ck-widget image" contenteditable="false">' +
  61. `<img src="data:image/svg+xml;utf8,${ imagePlaceholder }"></img>` +
  62. '</figure>]<p>foo</p>'
  63. );
  64. } );
  65. it( 'should convert image\'s "uploading" uploadStatus attribute', done => {
  66. setModelData( model, '<paragraph>[]foo</paragraph>' );
  67. editor.execute( 'imageUpload', { file: createNativeFileMock() } );
  68. model.document.once( 'change', () => {
  69. expect( getViewData( view ) ).to.equal(
  70. '[<figure class="ck-appear ck-widget image" contenteditable="false">' +
  71. `<img src="${ base64Sample }"></img>` +
  72. '<div class="ck-progress-bar"></div>' +
  73. '</figure>]<p>foo</p>'
  74. );
  75. done();
  76. }, { priority: 'lowest' } );
  77. nativeReaderMock.mockSuccess( base64Sample );
  78. } );
  79. it( 'should work correctly when there is no "reading" status and go straight to "uploading"', () => {
  80. const fileRepository = editor.plugins.get( FileRepository );
  81. const file = createNativeFileMock();
  82. const loader = fileRepository.createLoader( file );
  83. setModelData( model, '<image></image>' );
  84. const image = document.getRoot().getChild( 0 );
  85. // Set attributes directly on image to simulate instant "uploading" status.
  86. model.change( writer => {
  87. writer.setAttribute( 'uploadStatus', 'uploading', image );
  88. writer.setAttribute( 'uploadId', loader.id, image );
  89. writer.setAttribute( 'src', 'image.png', image );
  90. } );
  91. expect( getViewData( view ) ).to.equal(
  92. '[<figure class="ck-appear ck-widget image" contenteditable="false">' +
  93. '<img src="image.png"></img>' +
  94. '<div class="ck-progress-bar"></div>' +
  95. '</figure>]'
  96. );
  97. } );
  98. it( 'should work correctly when there is no "reading" status and go straight to "uploading" - external changes', () => {
  99. setModelData( model, '<image></image>' );
  100. const image = document.getRoot().getChild( 0 );
  101. // Set attributes directly on image to simulate instant "uploading" status.
  102. model.change( writer => {
  103. writer.setAttribute( 'uploadStatus', 'uploading', image );
  104. writer.setAttribute( 'uploadId', '12345', image );
  105. } );
  106. expect( getViewData( view ) ).to.equal(
  107. '[<figure class="ck-appear ck-image-upload-placeholder ck-infinite-progress ck-widget image" contenteditable="false">' +
  108. `<img src="data:image/svg+xml;utf8,${ imagePlaceholder }"></img>` +
  109. '</figure>]'
  110. );
  111. } );
  112. it( 'should "clear" image when uploadId changes to null', () => {
  113. setModelData( model, '<image></image>' );
  114. const image = document.getRoot().getChild( 0 );
  115. // Set attributes directly on image to simulate instant "uploading" status.
  116. model.change( writer => {
  117. writer.setAttribute( 'uploadStatus', 'uploading', image );
  118. writer.setAttribute( 'uploadId', '12345', image );
  119. } );
  120. model.change( writer => {
  121. writer.setAttribute( 'uploadStatus', null, image );
  122. writer.setAttribute( 'uploadId', null, image );
  123. } );
  124. expect( getViewData( view ) ).to.equal(
  125. '[<figure class="ck-widget image" contenteditable="false">' +
  126. `<img src="data:image/svg+xml;utf8,${ imagePlaceholder }"></img>` +
  127. '</figure>]'
  128. );
  129. } );
  130. it( 'should update progressbar width on progress', done => {
  131. setModelData( model, '<paragraph>[]foo</paragraph>' );
  132. editor.execute( 'imageUpload', { file: createNativeFileMock() } );
  133. model.document.once( 'change', () => {
  134. adapterMock.mockProgress( 40, 100 );
  135. expect( getViewData( view ) ).to.equal(
  136. '[<figure class="ck-appear ck-widget image" contenteditable="false">' +
  137. `<img src="${ base64Sample }"></img>` +
  138. '<div class="ck-progress-bar" style="width:40%"></div>' +
  139. '</figure>]<p>foo</p>'
  140. );
  141. done();
  142. }, { priority: 'lowest' } );
  143. nativeReaderMock.mockSuccess( base64Sample );
  144. } );
  145. it( 'should convert image\'s "complete" uploadStatus attribute and display temporary icon', done => {
  146. const clock = testUtils.sinon.useFakeTimers();
  147. setModelData( model, '<paragraph>[]foo</paragraph>' );
  148. editor.execute( 'imageUpload', { file: createNativeFileMock() } );
  149. model.document.once( 'change', () => {
  150. model.document.once( 'change', () => {
  151. expect( getViewData( view ) ).to.equal(
  152. '[<figure class="ck-widget image" contenteditable="false">' +
  153. '<img src="image.png"></img>' +
  154. '<div class="ck-image-upload-finish"></div>' +
  155. '</figure>]<p>foo</p>'
  156. );
  157. clock.tick( 3000 );
  158. expect( getViewData( view ) ).to.equal(
  159. '[<figure class="ck-widget image" contenteditable="false">' +
  160. '<img src="image.png"></img>' +
  161. '</figure>]<p>foo</p>'
  162. );
  163. done();
  164. }, { priority: 'lowest' } );
  165. adapterMock.mockSuccess( { default: 'image.png' } );
  166. } );
  167. nativeReaderMock.mockSuccess( base64Sample );
  168. } );
  169. it( 'should allow to customize placeholder image', () => {
  170. const uploadProgress = editor.plugins.get( ImageUploadProgress );
  171. uploadProgress.placeholder = base64Sample;
  172. setModelData( model, '<paragraph>[]foo</paragraph>' );
  173. editor.execute( 'imageUpload', { file: createNativeFileMock() } );
  174. expect( getViewData( view ) ).to.equal(
  175. '[<figure class="ck-appear ck-image-upload-placeholder ck-infinite-progress ck-widget image" contenteditable="false">' +
  176. `<img src="${ base64Sample }"></img>` +
  177. '</figure>]<p>foo</p>'
  178. );
  179. } );
  180. it( 'should not process attribute change if it is already consumed', () => {
  181. editor.editing.downcastDispatcher.on( 'attribute:uploadStatus:image', ( evt, data, conversionApi ) => {
  182. conversionApi.consumable.consume( data.item, evt.name );
  183. }, { priority: 'highest' } );
  184. setModelData( model, '<paragraph>[]foo</paragraph>' );
  185. editor.execute( 'imageUpload', { file: createNativeFileMock() } );
  186. expect( getViewData( view ) ).to.equal(
  187. '[<figure class="ck-widget image" contenteditable="false"><img></img></figure>]<p>foo</p>'
  188. );
  189. } );
  190. it( 'should not show progress bar and complete icon if there is no loader with given uploadId', () => {
  191. setModelData( model, '<image uploadId="123" uploadStatus="reading"></image>' );
  192. const image = document.getRoot().getChild( 0 );
  193. model.change( writer => {
  194. writer.setAttribute( 'uploadStatus', 'uploading', image );
  195. } );
  196. expect( getViewData( view ) ).to.equal(
  197. '[<figure class="ck-appear ck-image-upload-placeholder ck-infinite-progress ck-widget image" contenteditable="false">' +
  198. `<img src="data:image/svg+xml;utf8,${ imagePlaceholder }"></img>` +
  199. '</figure>]'
  200. );
  201. model.change( writer => {
  202. writer.setAttribute( 'uploadStatus', 'complete', image );
  203. } );
  204. expect( getViewData( view ) ).to.equal(
  205. '[<figure class="ck-widget image" contenteditable="false">' +
  206. `<img src="data:image/svg+xml;utf8,${ imagePlaceholder }"></img>` +
  207. '</figure>]'
  208. );
  209. } );
  210. } );