imageuploadprogress.js 10 KB

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