imageuploadprogress.js 12 KB

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