8
0

imageuploadprogress.js 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332
  1. /**
  2. * @license Copyright (c) 2003-2020, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  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 { createNativeFileMock, NativeFileReaderMock, UploadAdapterMock } 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. 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. 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, Clipboard ]
  43. } )
  44. .then( newEditor => {
  45. editor = newEditor;
  46. model = editor.model;
  47. doc = 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-widget image" contenteditable="false">' +
  62. `<img src="data:image/svg+xml;utf8,${ imagePlaceholder }"></img>` +
  63. '<div class="ck-upload-placeholder-loader"></div>' +
  64. '</figure>]<p>foo</p>'
  65. );
  66. } );
  67. it( 'should convert image\'s "uploading" uploadStatus attribute', done => {
  68. setModelData( model, '<paragraph>[]foo</paragraph>' );
  69. editor.execute( 'imageUpload', { file: createNativeFileMock() } );
  70. model.document.once( 'change', () => {
  71. try {
  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. } catch ( err ) {
  80. done( err );
  81. }
  82. }, { priority: 'lowest' } );
  83. loader.file.then( () => nativeReaderMock.mockSuccess( base64Sample ) );
  84. } );
  85. // See https://github.com/ckeditor/ckeditor5/issues/1985.
  86. it( 'should work if image parent is refreshed by the differ', function( done ) {
  87. model.schema.register( 'outerBlock', {
  88. allowWhere: '$block',
  89. isBlock: true
  90. } );
  91. model.schema.register( 'innerBlock', {
  92. allowIn: 'outerBlock',
  93. isLimit: true
  94. } );
  95. model.schema.extend( '$block', { allowIn: 'innerBlock' } );
  96. editor.conversion.elementToElement( { model: 'outerBlock', view: 'outerBlock' } );
  97. editor.conversion.elementToElement( { model: 'innerBlock', view: 'innerBlock' } );
  98. model.document.registerPostFixer( () => {
  99. for ( const change of doc.differ.getChanges() ) {
  100. // The differ.refreshItem() simulates remove and insert of and image parent thus preventing image from proper work.
  101. if ( change.type == 'insert' && change.name == 'image' ) {
  102. doc.differ.refreshItem( change.position.parent );
  103. return true;
  104. }
  105. }
  106. } );
  107. setModelData( model, '<outerBlock><innerBlock><paragraph>[]</paragraph></innerBlock></outerBlock>' );
  108. editor.execute( 'imageUpload', { file: createNativeFileMock() } );
  109. model.document.once( 'change', () => {
  110. try {
  111. expect( getViewData( view ) ).to.equal(
  112. '<outerBlock><innerBlock>[<figure class="ck-appear ck-widget image" contenteditable="false">' +
  113. `<img src="${ base64Sample }"></img>` +
  114. '<div class="ck-progress-bar"></div>' +
  115. '</figure>]</innerBlock></outerBlock>'
  116. );
  117. done();
  118. } catch ( err ) {
  119. done( err );
  120. }
  121. }, { priority: 'lowest' } );
  122. loader.file.then( () => nativeReaderMock.mockSuccess( base64Sample ) );
  123. } );
  124. it( 'should work correctly when there is no "reading" status and go straight to "uploading"', () => {
  125. const fileRepository = editor.plugins.get( FileRepository );
  126. const file = createNativeFileMock();
  127. const loader = fileRepository.createLoader( file );
  128. setModelData( model, '<image></image>' );
  129. const image = doc.getRoot().getChild( 0 );
  130. // Set attributes directly on image to simulate instant "uploading" status.
  131. model.change( writer => {
  132. writer.setAttribute( 'uploadStatus', 'uploading', image );
  133. writer.setAttribute( 'uploadId', loader.id, image );
  134. writer.setAttribute( 'src', 'image.png', image );
  135. } );
  136. expect( getViewData( view ) ).to.equal(
  137. '[<figure class="ck-appear ck-widget image" contenteditable="false">' +
  138. '<img src="image.png"></img>' +
  139. '<div class="ck-progress-bar"></div>' +
  140. '</figure>]'
  141. );
  142. } );
  143. it( 'should work correctly when there is no "reading" status and go straight to "uploading" - external changes', () => {
  144. setModelData( model, '<image></image>' );
  145. const image = doc.getRoot().getChild( 0 );
  146. // Set attributes directly on image to simulate instant "uploading" status.
  147. model.change( writer => {
  148. writer.setAttribute( 'uploadStatus', 'uploading', image );
  149. writer.setAttribute( 'uploadId', '12345', image );
  150. } );
  151. expect( getViewData( view ) ).to.equal(
  152. '[<figure class="ck-appear ck-image-upload-placeholder ck-widget image" contenteditable="false">' +
  153. `<img src="data:image/svg+xml;utf8,${ imagePlaceholder }"></img>` +
  154. '<div class="ck-upload-placeholder-loader"></div>' +
  155. '</figure>]'
  156. );
  157. } );
  158. it( 'should "clear" image when uploadId changes to null', () => {
  159. setModelData( model, '<image></image>' );
  160. const image = doc.getRoot().getChild( 0 );
  161. // Set attributes directly on image to simulate instant "uploading" status.
  162. model.change( writer => {
  163. writer.setAttribute( 'uploadStatus', 'uploading', image );
  164. writer.setAttribute( 'uploadId', '12345', image );
  165. } );
  166. model.change( writer => {
  167. writer.setAttribute( 'uploadStatus', null, image );
  168. writer.setAttribute( 'uploadId', null, image );
  169. } );
  170. expect( getViewData( view ) ).to.equal(
  171. '[<figure class="ck-widget image" contenteditable="false">' +
  172. `<img src="data:image/svg+xml;utf8,${ imagePlaceholder }"></img>` +
  173. '</figure>]'
  174. );
  175. } );
  176. it( 'should update progressbar width on progress', done => {
  177. setModelData( model, '<paragraph>[]foo</paragraph>' );
  178. editor.execute( 'imageUpload', { file: createNativeFileMock() } );
  179. model.document.once( 'change', () => {
  180. adapterMock.mockProgress( 40, 100 );
  181. try {
  182. expect( getViewData( view ) ).to.equal(
  183. '[<figure class="ck-appear ck-widget image" contenteditable="false">' +
  184. `<img src="${ base64Sample }"></img>` +
  185. '<div class="ck-progress-bar" style="width:40%"></div>' +
  186. '</figure>]<p>foo</p>'
  187. );
  188. done();
  189. } catch ( err ) {
  190. done( err );
  191. }
  192. }, { priority: 'lowest' } );
  193. loader.file.then( () => nativeReaderMock.mockSuccess( base64Sample ) );
  194. } );
  195. it( 'should convert image\'s "complete" uploadStatus attribute and display temporary icon', done => {
  196. const clock = testUtils.sinon.useFakeTimers();
  197. setModelData( model, '<paragraph>[]foo</paragraph>' );
  198. editor.execute( 'imageUpload', { file: createNativeFileMock() } );
  199. model.document.once( 'change', () => {
  200. model.document.once( 'change', () => {
  201. try {
  202. expect( getViewData( view ) ).to.equal(
  203. '[<figure class="ck-widget image" contenteditable="false">' +
  204. '<img src="image.png"></img>' +
  205. '<div class="ck-image-upload-complete-icon"></div>' +
  206. '</figure>]<p>foo</p>'
  207. );
  208. clock.tick( 3000 );
  209. expect( getViewData( view ) ).to.equal(
  210. '[<figure class="ck-widget image" contenteditable="false">' +
  211. '<img src="image.png"></img>' +
  212. '</figure>]<p>foo</p>'
  213. );
  214. done();
  215. } catch ( err ) {
  216. done( err );
  217. }
  218. }, { priority: 'lowest' } );
  219. loader.file.then( () => adapterMock.mockSuccess( { default: 'image.png' } ) );
  220. } );
  221. loader.file.then( () => nativeReaderMock.mockSuccess( base64Sample ) );
  222. } );
  223. it( 'should allow to customize placeholder image', () => {
  224. const uploadProgress = editor.plugins.get( ImageUploadProgress );
  225. uploadProgress.placeholder = base64Sample;
  226. setModelData( model, '<paragraph>[]foo</paragraph>' );
  227. editor.execute( 'imageUpload', { file: createNativeFileMock() } );
  228. expect( getViewData( view ) ).to.equal(
  229. '[<figure class="ck-appear ck-image-upload-placeholder ck-widget image" contenteditable="false">' +
  230. `<img src="${ base64Sample }"></img>` +
  231. '<div class="ck-upload-placeholder-loader"></div>' +
  232. '</figure>]<p>foo</p>'
  233. );
  234. } );
  235. it( 'should not process attribute change if it is already consumed', () => {
  236. editor.editing.downcastDispatcher.on( 'attribute:uploadStatus:image', ( evt, data, conversionApi ) => {
  237. conversionApi.consumable.consume( data.item, evt.name );
  238. }, { priority: 'highest' } );
  239. setModelData( model, '<paragraph>[]foo</paragraph>' );
  240. editor.execute( 'imageUpload', { file: createNativeFileMock() } );
  241. expect( getViewData( view ) ).to.equal(
  242. '[<figure class="ck-widget image" contenteditable="false"><img></img></figure>]<p>foo</p>'
  243. );
  244. } );
  245. it( 'should not show progress bar and complete icon if there is no loader with given uploadId', () => {
  246. setModelData( model, '<image uploadId="123" uploadStatus="reading"></image>' );
  247. const image = doc.getRoot().getChild( 0 );
  248. model.change( writer => {
  249. writer.setAttribute( 'uploadStatus', 'uploading', image );
  250. } );
  251. expect( getViewData( view ) ).to.equal(
  252. '[<figure class="ck-appear ck-image-upload-placeholder ck-widget image" contenteditable="false">' +
  253. `<img src="data:image/svg+xml;utf8,${ imagePlaceholder }"></img>` +
  254. '<div class="ck-upload-placeholder-loader"></div>' +
  255. '</figure>]'
  256. );
  257. model.change( writer => {
  258. writer.setAttribute( 'uploadStatus', 'complete', image );
  259. } );
  260. expect( getViewData( view ) ).to.equal(
  261. '[<figure class="ck-widget image" contenteditable="false">' +
  262. `<img src="data:image/svg+xml;utf8,${ imagePlaceholder }"></img>` +
  263. '</figure>]'
  264. );
  265. } );
  266. } );