imageuploadprogress.js 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362
  1. /**
  2. * @license Copyright (c) 2003-2019, 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. import env from '@ckeditor/ckeditor5-utils/src/env';
  20. describe( 'ImageUploadProgress', () => {
  21. const imagePlaceholder = encodeURIComponent( svgPlaceholder );
  22. // eslint-disable-next-line max-len
  23. const base64Sample = 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+A8AAQUBAScY42YAAAAASUVORK5CYII=';
  24. let editor, model, doc, fileRepository, view, nativeReaderMock, loader, adapterMock;
  25. class UploadAdapterPluginMock extends Plugin {
  26. init() {
  27. fileRepository = this.editor.plugins.get( FileRepository );
  28. fileRepository.createUploadAdapter = newLoader => {
  29. loader = newLoader;
  30. adapterMock = new UploadAdapterMock( loader );
  31. return adapterMock;
  32. };
  33. }
  34. }
  35. testUtils.createSinonSandbox();
  36. beforeEach( () => {
  37. // Most tests assume non-edge environment but we do not set `contenteditable=false` on Edge so stub `env.isEdge`.
  38. testUtils.sinon.stub( env, 'isEdge' ).get( () => false );
  39. testUtils.sinon.stub( window, 'FileReader' ).callsFake( () => {
  40. nativeReaderMock = new NativeFileReaderMock();
  41. return nativeReaderMock;
  42. } );
  43. return VirtualTestEditor
  44. .create( {
  45. plugins: [ ImageEditing, Paragraph, ImageUploadEditing, ImageUploadProgress, UploadAdapterPluginMock, Clipboard ]
  46. } )
  47. .then( newEditor => {
  48. editor = newEditor;
  49. model = editor.model;
  50. doc = model.document;
  51. view = editor.editing.view;
  52. fileRepository = editor.plugins.get( FileRepository );
  53. fileRepository.createUploadAdapter = newLoader => {
  54. loader = newLoader;
  55. adapterMock = new UploadAdapterMock( loader );
  56. return adapterMock;
  57. };
  58. } );
  59. } );
  60. it( 'should convert image\'s "reading" uploadStatus attribute', () => {
  61. setModelData( model, '<paragraph>[]foo</paragraph>' );
  62. editor.execute( 'imageUpload', { file: createNativeFileMock() } );
  63. expect( getViewData( view ) ).to.equal(
  64. '[<figure class="ck-appear ck-image-upload-placeholder ck-widget image" contenteditable="false">' +
  65. `<img src="data:image/svg+xml;utf8,${ imagePlaceholder }"></img>` +
  66. '<div class="ck-upload-placeholder-loader"></div>' +
  67. '</figure>]<p>foo</p>'
  68. );
  69. } );
  70. it( 'should convert image\'s "uploading" uploadStatus attribute', done => {
  71. setModelData( model, '<paragraph>[]foo</paragraph>' );
  72. editor.execute( 'imageUpload', { file: createNativeFileMock() } );
  73. model.document.once( 'change', () => {
  74. try {
  75. expect( getViewData( view ) ).to.equal(
  76. '[<figure class="ck-appear ck-widget image" contenteditable="false">' +
  77. `<img src="${ base64Sample }"></img>` +
  78. '<div class="ck-progress-bar"></div>' +
  79. '</figure>]<p>foo</p>'
  80. );
  81. done();
  82. } catch ( err ) {
  83. done( err );
  84. }
  85. }, { priority: 'lowest' } );
  86. loader.file.then( () => nativeReaderMock.mockSuccess( base64Sample ) );
  87. } );
  88. it( 'should work if image parent is refreshed by the differ', function( done ) {
  89. model.schema.register( 'outerBlock', {
  90. allowWhere: '$block',
  91. isBlock: true
  92. } );
  93. model.schema.register( 'innerBlock', {
  94. allowIn: 'outerBlock',
  95. isLimit: true
  96. } );
  97. model.schema.extend( '$block', { allowIn: 'innerBlock' } );
  98. editor.conversion.elementToElement( { model: 'outerBlock', view: 'outerBlock' } );
  99. editor.conversion.elementToElement( { model: 'innerBlock', view: 'innerBlock' } );
  100. model.document.registerPostFixer( () => {
  101. for ( const change of doc.differ.getChanges() ) {
  102. // The differ.refreshItem() simulates remove and insert of and image parent thus preventing image from proper work.
  103. if ( change.type == 'insert' && change.name == 'image' ) {
  104. doc.differ.refreshItem( change.position.parent );
  105. return true;
  106. }
  107. }
  108. } );
  109. setModelData( model, '<outerBlock><innerBlock><paragraph>[]</paragraph></innerBlock></outerBlock>' );
  110. editor.execute( 'imageUpload', { file: createNativeFileMock() } );
  111. model.document.once( 'change', () => {
  112. try {
  113. expect( getViewData( view ) ).to.equal(
  114. '<outerBlock><innerBlock>[<figure class="ck-appear ck-widget image" contenteditable="false">' +
  115. `<img src="${ base64Sample }"></img>` +
  116. '<div class="ck-progress-bar"></div>' +
  117. '</figure>]</innerBlock></outerBlock>'
  118. );
  119. done();
  120. } catch ( err ) {
  121. done( err );
  122. }
  123. }, { priority: 'lowest' } );
  124. loader.file.then( () => nativeReaderMock.mockSuccess( base64Sample ) );
  125. } );
  126. it( 'should work correctly when there is no "reading" status and go straight to "uploading"', () => {
  127. const fileRepository = editor.plugins.get( FileRepository );
  128. const file = createNativeFileMock();
  129. const loader = fileRepository.createLoader( file );
  130. setModelData( model, '<image></image>' );
  131. const image = doc.getRoot().getChild( 0 );
  132. // Set attributes directly on image to simulate instant "uploading" status.
  133. model.change( writer => {
  134. writer.setAttribute( 'uploadStatus', 'uploading', image );
  135. writer.setAttribute( 'uploadId', loader.id, image );
  136. writer.setAttribute( 'src', 'image.png', image );
  137. } );
  138. expect( getViewData( view ) ).to.equal(
  139. '[<figure class="ck-appear ck-widget image" contenteditable="false">' +
  140. '<img src="image.png"></img>' +
  141. '<div class="ck-progress-bar"></div>' +
  142. '</figure>]'
  143. );
  144. } );
  145. it( 'should work correctly when there is no "reading" status and go straight to "uploading" - external changes', () => {
  146. setModelData( model, '<image></image>' );
  147. const image = doc.getRoot().getChild( 0 );
  148. // Set attributes directly on image to simulate instant "uploading" status.
  149. model.change( writer => {
  150. writer.setAttribute( 'uploadStatus', 'uploading', image );
  151. writer.setAttribute( 'uploadId', '12345', image );
  152. } );
  153. expect( getViewData( view ) ).to.equal(
  154. '[<figure class="ck-appear ck-image-upload-placeholder ck-widget image" contenteditable="false">' +
  155. `<img src="data:image/svg+xml;utf8,${ imagePlaceholder }"></img>` +
  156. '<div class="ck-upload-placeholder-loader"></div>' +
  157. '</figure>]'
  158. );
  159. } );
  160. it( 'should "clear" image when uploadId changes to null', () => {
  161. setModelData( model, '<image></image>' );
  162. const image = doc.getRoot().getChild( 0 );
  163. // Set attributes directly on image to simulate instant "uploading" status.
  164. model.change( writer => {
  165. writer.setAttribute( 'uploadStatus', 'uploading', image );
  166. writer.setAttribute( 'uploadId', '12345', image );
  167. } );
  168. model.change( writer => {
  169. writer.setAttribute( 'uploadStatus', null, image );
  170. writer.setAttribute( 'uploadId', null, image );
  171. } );
  172. expect( getViewData( view ) ).to.equal(
  173. '[<figure class="ck-widget image" contenteditable="false">' +
  174. `<img src="data:image/svg+xml;utf8,${ imagePlaceholder }"></img>` +
  175. '</figure>]'
  176. );
  177. } );
  178. it( 'should update progressbar width on progress', done => {
  179. setModelData( model, '<paragraph>[]foo</paragraph>' );
  180. editor.execute( 'imageUpload', { file: createNativeFileMock() } );
  181. model.document.once( 'change', () => {
  182. adapterMock.mockProgress( 40, 100 );
  183. try {
  184. expect( getViewData( view ) ).to.equal(
  185. '[<figure class="ck-appear ck-widget image" contenteditable="false">' +
  186. `<img src="${ base64Sample }"></img>` +
  187. '<div class="ck-progress-bar" style="width:40%"></div>' +
  188. '</figure>]<p>foo</p>'
  189. );
  190. done();
  191. } catch ( err ) {
  192. done( err );
  193. }
  194. }, { priority: 'lowest' } );
  195. loader.file.then( () => nativeReaderMock.mockSuccess( base64Sample ) );
  196. } );
  197. it( 'should convert image\'s "complete" uploadStatus attribute and display temporary icon', done => {
  198. const clock = testUtils.sinon.useFakeTimers();
  199. setModelData( model, '<paragraph>[]foo</paragraph>' );
  200. editor.execute( 'imageUpload', { file: createNativeFileMock() } );
  201. model.document.once( 'change', () => {
  202. model.document.once( 'change', () => {
  203. try {
  204. expect( getViewData( view ) ).to.equal(
  205. '[<figure class="ck-widget image" contenteditable="false">' +
  206. '<img src="image.png"></img>' +
  207. '<div class="ck-image-upload-complete-icon"></div>' +
  208. '</figure>]<p>foo</p>'
  209. );
  210. clock.tick( 3000 );
  211. expect( getViewData( view ) ).to.equal(
  212. '[<figure class="ck-widget image" contenteditable="false">' +
  213. '<img src="image.png"></img>' +
  214. '</figure>]<p>foo</p>'
  215. );
  216. done();
  217. } catch ( err ) {
  218. done( err );
  219. }
  220. }, { priority: 'lowest' } );
  221. loader.file.then( () => adapterMock.mockSuccess( { default: 'image.png' } ) );
  222. } );
  223. loader.file.then( () => nativeReaderMock.mockSuccess( base64Sample ) );
  224. } );
  225. it( 'should allow to customize placeholder image', () => {
  226. const uploadProgress = editor.plugins.get( ImageUploadProgress );
  227. uploadProgress.placeholder = base64Sample;
  228. setModelData( model, '<paragraph>[]foo</paragraph>' );
  229. editor.execute( 'imageUpload', { file: createNativeFileMock() } );
  230. expect( getViewData( view ) ).to.equal(
  231. '[<figure class="ck-appear ck-image-upload-placeholder ck-widget image" contenteditable="false">' +
  232. `<img src="${ base64Sample }"></img>` +
  233. '<div class="ck-upload-placeholder-loader"></div>' +
  234. '</figure>]<p>foo</p>'
  235. );
  236. } );
  237. it( 'should not process attribute change if it is already consumed', () => {
  238. editor.editing.downcastDispatcher.on( 'attribute:uploadStatus:image', ( evt, data, conversionApi ) => {
  239. conversionApi.consumable.consume( data.item, evt.name );
  240. }, { priority: 'highest' } );
  241. setModelData( model, '<paragraph>[]foo</paragraph>' );
  242. editor.execute( 'imageUpload', { file: createNativeFileMock() } );
  243. expect( getViewData( view ) ).to.equal(
  244. '[<figure class="ck-widget image" contenteditable="false"><img></img></figure>]<p>foo</p>'
  245. );
  246. } );
  247. it( 'should not show progress bar and complete icon if there is no loader with given uploadId', () => {
  248. setModelData( model, '<image uploadId="123" uploadStatus="reading"></image>' );
  249. const image = doc.getRoot().getChild( 0 );
  250. model.change( writer => {
  251. writer.setAttribute( 'uploadStatus', 'uploading', image );
  252. } );
  253. expect( getViewData( view ) ).to.equal(
  254. '[<figure class="ck-appear ck-image-upload-placeholder ck-widget image" contenteditable="false">' +
  255. `<img src="data:image/svg+xml;utf8,${ imagePlaceholder }"></img>` +
  256. '<div class="ck-upload-placeholder-loader"></div>' +
  257. '</figure>]'
  258. );
  259. model.change( writer => {
  260. writer.setAttribute( 'uploadStatus', 'complete', image );
  261. } );
  262. expect( getViewData( view ) ).to.equal(
  263. '[<figure class="ck-widget image" contenteditable="false">' +
  264. `<img src="data:image/svg+xml;utf8,${ imagePlaceholder }"></img>` +
  265. '</figure>]'
  266. );
  267. } );
  268. it( 'should not create completeIcon element when browser is Microsoft Edge', done => {
  269. testUtils.sinon.stub( env, 'isEdge' ).get( () => true );
  270. setModelData( model, '<paragraph>[]foo</paragraph>' );
  271. editor.execute( 'imageUpload', { file: createNativeFileMock() } );
  272. model.document.once( 'change', () => {
  273. model.document.once( 'change', () => {
  274. try {
  275. expect( getViewData( view ) ).to.equal(
  276. '[<figure class="ck-widget image">' +
  277. '<img src="image.png"></img>' +
  278. '</figure>]<p>foo</p>'
  279. );
  280. done();
  281. } catch ( err ) {
  282. done( err );
  283. }
  284. }, { priority: 'lowest' } );
  285. loader.file.then( () => adapterMock.mockSuccess( { default: 'image.png' } ) );
  286. } );
  287. loader.file.then( () => nativeReaderMock.mockSuccess( base64Sample ) );
  288. } );
  289. } );