imageuploadprogress.js 10 KB

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