8
0

imageuploadprogress.js 9.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271
  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. // Most tests assume non-edge environment but we do not set `contenteditable=false` on Edge so stub `env.isEdge`.
  37. 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. document = 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-infinite-progress ck-widget image" contenteditable="false">' +
  64. `<img src="data:image/svg+xml;utf8,${ imagePlaceholder }"></img>` +
  65. '</figure>]<p>foo</p>'
  66. );
  67. } );
  68. it( 'should convert image\'s "uploading" uploadStatus attribute', done => {
  69. setModelData( model, '<paragraph>[]foo</paragraph>' );
  70. editor.execute( 'imageUpload', { file: createNativeFileMock() } );
  71. model.document.once( 'change', () => {
  72. expect( getViewData( view ) ).to.equal(
  73. '[<figure class="ck-appear ck-widget image" contenteditable="false">' +
  74. `<img src="${ base64Sample }"></img>` +
  75. '<div class="ck-progress-bar"></div>' +
  76. '</figure>]<p>foo</p>'
  77. );
  78. done();
  79. }, { priority: 'lowest' } );
  80. nativeReaderMock.mockSuccess( base64Sample );
  81. } );
  82. it( 'should work correctly when there is no "reading" status and go straight to "uploading"', () => {
  83. const fileRepository = editor.plugins.get( FileRepository );
  84. const file = createNativeFileMock();
  85. const loader = fileRepository.createLoader( file );
  86. setModelData( model, '<image></image>' );
  87. const image = document.getRoot().getChild( 0 );
  88. // Set attributes directly on image to simulate instant "uploading" status.
  89. model.change( writer => {
  90. writer.setAttribute( 'uploadStatus', 'uploading', image );
  91. writer.setAttribute( 'uploadId', loader.id, image );
  92. writer.setAttribute( 'src', 'image.png', image );
  93. } );
  94. expect( getViewData( view ) ).to.equal(
  95. '[<figure class="ck-appear ck-widget image" contenteditable="false">' +
  96. '<img src="image.png"></img>' +
  97. '<div class="ck-progress-bar"></div>' +
  98. '</figure>]'
  99. );
  100. } );
  101. it( 'should work correctly when there is no "reading" status and go straight to "uploading" - external changes', () => {
  102. setModelData( model, '<image></image>' );
  103. const image = document.getRoot().getChild( 0 );
  104. // Set attributes directly on image to simulate instant "uploading" status.
  105. model.change( writer => {
  106. writer.setAttribute( 'uploadStatus', 'uploading', image );
  107. writer.setAttribute( 'uploadId', '12345', image );
  108. } );
  109. expect( getViewData( view ) ).to.equal(
  110. '[<figure class="ck-appear ck-image-upload-placeholder ck-infinite-progress ck-widget image" contenteditable="false">' +
  111. `<img src="data:image/svg+xml;utf8,${ imagePlaceholder }"></img>` +
  112. '</figure>]'
  113. );
  114. } );
  115. it( 'should "clear" image when uploadId changes to null', () => {
  116. setModelData( model, '<image></image>' );
  117. const image = document.getRoot().getChild( 0 );
  118. // Set attributes directly on image to simulate instant "uploading" status.
  119. model.change( writer => {
  120. writer.setAttribute( 'uploadStatus', 'uploading', image );
  121. writer.setAttribute( 'uploadId', '12345', image );
  122. } );
  123. model.change( writer => {
  124. writer.setAttribute( 'uploadStatus', null, image );
  125. writer.setAttribute( 'uploadId', null, image );
  126. } );
  127. expect( getViewData( view ) ).to.equal(
  128. '[<figure class="ck-widget image" contenteditable="false">' +
  129. `<img src="data:image/svg+xml;utf8,${ imagePlaceholder }"></img>` +
  130. '</figure>]'
  131. );
  132. } );
  133. it( 'should update progressbar width on progress', done => {
  134. setModelData( model, '<paragraph>[]foo</paragraph>' );
  135. editor.execute( 'imageUpload', { file: createNativeFileMock() } );
  136. model.document.once( 'change', () => {
  137. adapterMock.mockProgress( 40, 100 );
  138. expect( getViewData( view ) ).to.equal(
  139. '[<figure class="ck-appear ck-widget image" contenteditable="false">' +
  140. `<img src="${ base64Sample }"></img>` +
  141. '<div class="ck-progress-bar" style="width:40%"></div>' +
  142. '</figure>]<p>foo</p>'
  143. );
  144. done();
  145. }, { priority: 'lowest' } );
  146. nativeReaderMock.mockSuccess( base64Sample );
  147. } );
  148. it( 'should convert image\'s "complete" uploadStatus attribute and display temporary icon', done => {
  149. const clock = testUtils.sinon.useFakeTimers();
  150. setModelData( model, '<paragraph>[]foo</paragraph>' );
  151. editor.execute( 'imageUpload', { file: createNativeFileMock() } );
  152. model.document.once( 'change', () => {
  153. model.document.once( 'change', () => {
  154. expect( getViewData( view ) ).to.equal(
  155. '[<figure class="ck-widget image" contenteditable="false">' +
  156. '<img src="image.png"></img>' +
  157. '<div class="ck-image-upload-complete-icon"></div>' +
  158. '</figure>]<p>foo</p>'
  159. );
  160. clock.tick( 3000 );
  161. expect( getViewData( view ) ).to.equal(
  162. '[<figure class="ck-widget image" contenteditable="false">' +
  163. '<img src="image.png"></img>' +
  164. '</figure>]<p>foo</p>'
  165. );
  166. done();
  167. }, { priority: 'lowest' } );
  168. adapterMock.mockSuccess( { default: 'image.png' } );
  169. } );
  170. nativeReaderMock.mockSuccess( base64Sample );
  171. } );
  172. it( 'should allow to customize placeholder image', () => {
  173. const uploadProgress = editor.plugins.get( ImageUploadProgress );
  174. uploadProgress.placeholder = base64Sample;
  175. setModelData( model, '<paragraph>[]foo</paragraph>' );
  176. editor.execute( 'imageUpload', { file: createNativeFileMock() } );
  177. expect( getViewData( view ) ).to.equal(
  178. '[<figure class="ck-appear ck-image-upload-placeholder ck-infinite-progress ck-widget image" contenteditable="false">' +
  179. `<img src="${ base64Sample }"></img>` +
  180. '</figure>]<p>foo</p>'
  181. );
  182. } );
  183. it( 'should not process attribute change if it is already consumed', () => {
  184. editor.editing.downcastDispatcher.on( 'attribute:uploadStatus:image', ( evt, data, conversionApi ) => {
  185. conversionApi.consumable.consume( data.item, evt.name );
  186. }, { priority: 'highest' } );
  187. setModelData( model, '<paragraph>[]foo</paragraph>' );
  188. editor.execute( 'imageUpload', { file: createNativeFileMock() } );
  189. expect( getViewData( view ) ).to.equal(
  190. '[<figure class="ck-widget image" contenteditable="false"><img></img></figure>]<p>foo</p>'
  191. );
  192. } );
  193. it( 'should not show progress bar and complete icon if there is no loader with given uploadId', () => {
  194. setModelData( model, '<image uploadId="123" uploadStatus="reading"></image>' );
  195. const image = document.getRoot().getChild( 0 );
  196. model.change( writer => {
  197. writer.setAttribute( 'uploadStatus', 'uploading', image );
  198. } );
  199. expect( getViewData( view ) ).to.equal(
  200. '[<figure class="ck-appear ck-image-upload-placeholder ck-infinite-progress ck-widget image" contenteditable="false">' +
  201. `<img src="data:image/svg+xml;utf8,${ imagePlaceholder }"></img>` +
  202. '</figure>]'
  203. );
  204. model.change( writer => {
  205. writer.setAttribute( 'uploadStatus', 'complete', image );
  206. } );
  207. expect( getViewData( view ) ).to.equal(
  208. '[<figure class="ck-widget image" contenteditable="false">' +
  209. `<img src="data:image/svg+xml;utf8,${ imagePlaceholder }"></img>` +
  210. '</figure>]'
  211. );
  212. } );
  213. } );