8
0

imageuploadprogress.js 9.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270
  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. 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, doc, 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. doc = 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-widget image" contenteditable="false">' +
  61. `<img src="data:image/svg+xml;utf8,${ imagePlaceholder }"></img>` +
  62. '<div class="ck-upload-placeholder-loader"></div>' +
  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 = doc.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 = doc.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-widget image" contenteditable="false">' +
  109. `<img src="data:image/svg+xml;utf8,${ imagePlaceholder }"></img>` +
  110. '<div class="ck-upload-placeholder-loader"></div>' +
  111. '</figure>]'
  112. );
  113. } );
  114. it( 'should "clear" image when uploadId changes to null', () => {
  115. setModelData( model, '<image></image>' );
  116. const image = doc.getRoot().getChild( 0 );
  117. // Set attributes directly on image to simulate instant "uploading" status.
  118. model.change( writer => {
  119. writer.setAttribute( 'uploadStatus', 'uploading', image );
  120. writer.setAttribute( 'uploadId', '12345', image );
  121. } );
  122. model.change( writer => {
  123. writer.setAttribute( 'uploadStatus', null, image );
  124. writer.setAttribute( 'uploadId', null, image );
  125. } );
  126. expect( getViewData( view ) ).to.equal(
  127. '[<figure class="ck-widget image" contenteditable="false">' +
  128. `<img src="data:image/svg+xml;utf8,${ imagePlaceholder }"></img>` +
  129. '</figure>]'
  130. );
  131. } );
  132. it( 'should update progressbar width on progress', done => {
  133. setModelData( model, '<paragraph>[]foo</paragraph>' );
  134. editor.execute( 'imageUpload', { file: createNativeFileMock() } );
  135. model.document.once( 'change', () => {
  136. adapterMock.mockProgress( 40, 100 );
  137. expect( getViewData( view ) ).to.equal(
  138. '[<figure class="ck-appear ck-widget image" contenteditable="false">' +
  139. `<img src="${ base64Sample }"></img>` +
  140. '<div class="ck-progress-bar" style="width:40%"></div>' +
  141. '</figure>]<p>foo</p>'
  142. );
  143. done();
  144. }, { priority: 'lowest' } );
  145. nativeReaderMock.mockSuccess( base64Sample );
  146. } );
  147. it( 'should convert image\'s "complete" uploadStatus attribute and display temporary icon', done => {
  148. const clock = testUtils.sinon.useFakeTimers();
  149. setModelData( model, '<paragraph>[]foo</paragraph>' );
  150. editor.execute( 'imageUpload', { file: createNativeFileMock() } );
  151. model.document.once( 'change', () => {
  152. model.document.once( 'change', () => {
  153. expect( getViewData( view ) ).to.equal(
  154. '[<figure class="ck-widget image" contenteditable="false">' +
  155. '<img src="image.png"></img>' +
  156. '<div class="ck-image-upload-complete-icon"></div>' +
  157. '</figure>]<p>foo</p>'
  158. );
  159. clock.tick( 3000 );
  160. expect( getViewData( view ) ).to.equal(
  161. '[<figure class="ck-widget image" contenteditable="false">' +
  162. '<img src="image.png"></img>' +
  163. '</figure>]<p>foo</p>'
  164. );
  165. done();
  166. }, { priority: 'lowest' } );
  167. adapterMock.mockSuccess( { default: 'image.png' } );
  168. } );
  169. nativeReaderMock.mockSuccess( base64Sample );
  170. } );
  171. it( 'should allow to customize placeholder image', () => {
  172. const uploadProgress = editor.plugins.get( ImageUploadProgress );
  173. uploadProgress.placeholder = base64Sample;
  174. setModelData( model, '<paragraph>[]foo</paragraph>' );
  175. editor.execute( 'imageUpload', { file: createNativeFileMock() } );
  176. expect( getViewData( view ) ).to.equal(
  177. '[<figure class="ck-appear ck-image-upload-placeholder ck-widget image" contenteditable="false">' +
  178. `<img src="${ base64Sample }"></img>` +
  179. '<div class="ck-upload-placeholder-loader"></div>' +
  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 = doc.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-widget image" contenteditable="false">' +
  201. `<img src="data:image/svg+xml;utf8,${ imagePlaceholder }"></img>` +
  202. '<div class="ck-upload-placeholder-loader"></div>' +
  203. '</figure>]'
  204. );
  205. model.change( writer => {
  206. writer.setAttribute( 'uploadStatus', 'complete', image );
  207. } );
  208. expect( getViewData( view ) ).to.equal(
  209. '[<figure class="ck-widget image" contenteditable="false">' +
  210. `<img src="data:image/svg+xml;utf8,${ imagePlaceholder }"></img>` +
  211. '</figure>]'
  212. );
  213. } );
  214. } );