imageuploadprogress.js 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288
  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 { 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. import env from '@ckeditor/ckeditor5-utils/src/env';
  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, view, nativeReaderMock, loader, adapterMock;
  24. class UploadAdapterPluginMock extends Plugin {
  25. init() {
  26. fileRepository = this.editor.plugins.get( FileRepository );
  27. fileRepository.createUploadAdapter = newLoader => {
  28. loader = newLoader;
  29. adapterMock = new UploadAdapterMock( 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 VirtualTestEditor
  41. .create( {
  42. plugins: [ ImageEditing, Paragraph, ImageUploadEditing, ImageUploadProgress, UploadAdapterPluginMock ]
  43. } )
  44. .then( newEditor => {
  45. editor = newEditor;
  46. model = editor.model;
  47. document = model.document;
  48. view = editor.editing.view;
  49. fileRepository = editor.plugins.get( FileRepository );
  50. fileRepository.createUploadAdapter = newLoader => {
  51. loader = newLoader;
  52. adapterMock = new UploadAdapterMock( loader );
  53. return adapterMock;
  54. };
  55. } );
  56. } );
  57. it( 'should convert image\'s "reading" uploadStatus attribute', () => {
  58. setModelData( model, '<paragraph>[]foo</paragraph>' );
  59. editor.execute( 'imageUpload', { file: createNativeFileMock() } );
  60. expect( getViewData( view ) ).to.equal(
  61. '[<figure class="ck-appear ck-image-upload-placeholder ck-infinite-progress ck-widget image" contenteditable="false">' +
  62. `<img src="data:image/svg+xml;utf8,${ imagePlaceholder }"></img>` +
  63. '</figure>]<p>foo</p>'
  64. );
  65. } );
  66. it( 'should convert image\'s "uploading" uploadStatus attribute', done => {
  67. setModelData( model, '<paragraph>[]foo</paragraph>' );
  68. editor.execute( 'imageUpload', { file: createNativeFileMock() } );
  69. model.document.once( 'change', () => {
  70. expect( getViewData( view ) ).to.equal(
  71. '[<figure class="ck-appear ck-widget image" contenteditable="false">' +
  72. `<img src="${ base64Sample }"></img>` +
  73. '<div class="ck-progress-bar"></div>' +
  74. '</figure>]<p>foo</p>'
  75. );
  76. done();
  77. }, { priority: 'lowest' } );
  78. nativeReaderMock.mockSuccess( base64Sample );
  79. } );
  80. it( 'should work correctly when there is no "reading" status and go straight to "uploading"', () => {
  81. const fileRepository = editor.plugins.get( FileRepository );
  82. const file = createNativeFileMock();
  83. const loader = fileRepository.createLoader( file );
  84. setModelData( model, '<image></image>' );
  85. const image = document.getRoot().getChild( 0 );
  86. // Set attributes directly on image to simulate instant "uploading" status.
  87. model.change( writer => {
  88. writer.setAttribute( 'uploadStatus', 'uploading', image );
  89. writer.setAttribute( 'uploadId', loader.id, image );
  90. writer.setAttribute( 'src', 'image.png', image );
  91. } );
  92. expect( getViewData( view ) ).to.equal(
  93. '[<figure class="ck-appear ck-widget image" contenteditable="false">' +
  94. '<img src="image.png"></img>' +
  95. '<div class="ck-progress-bar"></div>' +
  96. '</figure>]'
  97. );
  98. } );
  99. it( 'should work correctly when there is no "reading" status and go straight to "uploading" - external changes', () => {
  100. setModelData( model, '<image></image>' );
  101. const image = document.getRoot().getChild( 0 );
  102. // Set attributes directly on image to simulate instant "uploading" status.
  103. model.change( writer => {
  104. writer.setAttribute( 'uploadStatus', 'uploading', image );
  105. writer.setAttribute( 'uploadId', '12345', image );
  106. } );
  107. expect( getViewData( view ) ).to.equal(
  108. '[<figure class="ck-appear ck-image-upload-placeholder ck-infinite-progress ck-widget image" contenteditable="false">' +
  109. `<img src="data:image/svg+xml;utf8,${ imagePlaceholder }"></img>` +
  110. '</figure>]'
  111. );
  112. } );
  113. it( 'should "clear" image when uploadId changes to null', () => {
  114. setModelData( model, '<image></image>' );
  115. const image = document.getRoot().getChild( 0 );
  116. // Set attributes directly on image to simulate instant "uploading" status.
  117. model.change( writer => {
  118. writer.setAttribute( 'uploadStatus', 'uploading', image );
  119. writer.setAttribute( 'uploadId', '12345', image );
  120. } );
  121. model.change( writer => {
  122. writer.setAttribute( 'uploadStatus', null, image );
  123. writer.setAttribute( 'uploadId', null, image );
  124. } );
  125. expect( getViewData( view ) ).to.equal(
  126. '[<figure class="ck-widget image" contenteditable="false">' +
  127. `<img src="data:image/svg+xml;utf8,${ imagePlaceholder }"></img>` +
  128. '</figure>]'
  129. );
  130. } );
  131. it( 'should update progressbar width on progress', done => {
  132. setModelData( model, '<paragraph>[]foo</paragraph>' );
  133. editor.execute( 'imageUpload', { file: createNativeFileMock() } );
  134. model.document.once( 'change', () => {
  135. adapterMock.mockProgress( 40, 100 );
  136. expect( getViewData( view ) ).to.equal(
  137. '[<figure class="ck-appear ck-widget image" contenteditable="false">' +
  138. `<img src="${ base64Sample }"></img>` +
  139. '<div class="ck-progress-bar" style="width:40%"></div>' +
  140. '</figure>]<p>foo</p>'
  141. );
  142. done();
  143. }, { priority: 'lowest' } );
  144. nativeReaderMock.mockSuccess( base64Sample );
  145. } );
  146. it( 'should convert image\'s "complete" uploadStatus attribute and display temporary icon', done => {
  147. const clock = testUtils.sinon.useFakeTimers();
  148. setModelData( model, '<paragraph>[]foo</paragraph>' );
  149. editor.execute( 'imageUpload', { file: createNativeFileMock() } );
  150. model.document.once( 'change', () => {
  151. model.document.once( 'change', () => {
  152. expect( getViewData( view ) ).to.equal(
  153. '[<figure class="ck-widget image" contenteditable="false">' +
  154. '<img src="image.png"></img>' +
  155. '<div class="ck-image-upload-complete-icon"></div>' +
  156. '</figure>]<p>foo</p>'
  157. );
  158. clock.tick( 3000 );
  159. expect( getViewData( view ) ).to.equal(
  160. '[<figure class="ck-widget image" contenteditable="false">' +
  161. '<img src="image.png"></img>' +
  162. '</figure>]<p>foo</p>'
  163. );
  164. done();
  165. }, { priority: 'lowest' } );
  166. adapterMock.mockSuccess( { default: 'image.png' } );
  167. } );
  168. nativeReaderMock.mockSuccess( base64Sample );
  169. } );
  170. it( 'should allow to customize placeholder image', () => {
  171. const uploadProgress = editor.plugins.get( ImageUploadProgress );
  172. uploadProgress.placeholder = base64Sample;
  173. setModelData( model, '<paragraph>[]foo</paragraph>' );
  174. editor.execute( 'imageUpload', { file: createNativeFileMock() } );
  175. expect( getViewData( view ) ).to.equal(
  176. '[<figure class="ck-appear ck-image-upload-placeholder ck-infinite-progress ck-widget image" contenteditable="false">' +
  177. `<img src="${ base64Sample }"></img>` +
  178. '</figure>]<p>foo</p>'
  179. );
  180. } );
  181. it( 'should not process attribute change if it is already consumed', () => {
  182. editor.editing.downcastDispatcher.on( 'attribute:uploadStatus:image', ( evt, data, conversionApi ) => {
  183. conversionApi.consumable.consume( data.item, evt.name );
  184. }, { priority: 'highest' } );
  185. setModelData( model, '<paragraph>[]foo</paragraph>' );
  186. editor.execute( 'imageUpload', { file: createNativeFileMock() } );
  187. expect( getViewData( view ) ).to.equal(
  188. '[<figure class="ck-widget image" contenteditable="false"><img></img></figure>]<p>foo</p>'
  189. );
  190. } );
  191. it( 'should not show progress bar and complete icon if there is no loader with given uploadId', () => {
  192. setModelData( model, '<image uploadId="123" uploadStatus="reading"></image>' );
  193. const image = document.getRoot().getChild( 0 );
  194. model.change( writer => {
  195. writer.setAttribute( 'uploadStatus', 'uploading', image );
  196. } );
  197. expect( getViewData( view ) ).to.equal(
  198. '[<figure class="ck-appear ck-image-upload-placeholder ck-infinite-progress ck-widget image" contenteditable="false">' +
  199. `<img src="data:image/svg+xml;utf8,${ imagePlaceholder }"></img>` +
  200. '</figure>]'
  201. );
  202. model.change( writer => {
  203. writer.setAttribute( 'uploadStatus', 'complete', image );
  204. } );
  205. expect( getViewData( view ) ).to.equal(
  206. '[<figure class="ck-widget image" contenteditable="false">' +
  207. `<img src="data:image/svg+xml;utf8,${ imagePlaceholder }"></img>` +
  208. '</figure>]'
  209. );
  210. } );
  211. it( 'should not create completeIcon element when browser is Microsoft Edge', () => {
  212. testUtils.sinon.stub( env, 'isEdge' ).returns( true );
  213. setModelData( model, '<paragraph>[]foo</paragraph>' );
  214. editor.execute( 'imageUpload', { file: createNativeFileMock() } );
  215. model.document.once( 'change', () => {
  216. model.document.once( 'change', () => {
  217. expect( getViewData( view ) ).to.equal(
  218. '[<figure class="ck-widget image" contenteditable="false">' +
  219. '<img src="image.png"></img>' +
  220. '</figure>]<p>foo</p>'
  221. );
  222. }, { priority: 'lowest' } );
  223. adapterMock.mockSuccess( { default: 'image.png' } );
  224. } );
  225. nativeReaderMock.mockSuccess( base64Sample );
  226. } );
  227. } );