8
0

imageuploadprogress.js 6.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197
  1. /**
  2. * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. /* globals window */
  6. import ClassicTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/virtualtesteditor';
  7. import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
  8. import ImageEngine from '@ckeditor/ckeditor5-image/src/image/imageengine';
  9. import ImageUploadEngine from '../src/imageuploadengine';
  10. import ImageUploadProgress from '../src/imageuploadprogress';
  11. import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph';
  12. import FileRepository from '../src/filerepository';
  13. import { AdapterMock, createNativeFileMock, NativeFileReaderMock } from './_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 { eventNameToConsumableType } from '@ckeditor/ckeditor5-engine/src/conversion/model-to-view-converters';
  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, document, fileRepository, viewDocument, nativeReaderMock, loader, adapterMock;
  24. class UploadAdapterPluginMock extends Plugin {
  25. init() {
  26. fileRepository = this.editor.plugins.get( FileRepository );
  27. fileRepository.createAdapter = newLoader => {
  28. loader = newLoader;
  29. adapterMock = new AdapterMock( 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 ClassicTestEditor
  41. .create( {
  42. plugins: [ ImageEngine, Paragraph, ImageUploadProgress, UploadAdapterPluginMock ]
  43. } )
  44. .then( newEditor => {
  45. editor = newEditor;
  46. document = editor.document;
  47. viewDocument = editor.editing.view;
  48. fileRepository = editor.plugins.get( FileRepository );
  49. fileRepository.createAdapter = newLoader => {
  50. loader = newLoader;
  51. adapterMock = new AdapterMock( loader );
  52. return adapterMock;
  53. };
  54. } );
  55. } );
  56. it( 'should include ImageUploadEngine', () => {
  57. expect( editor.plugins.get( ImageUploadEngine ) ).to.be.instanceOf( ImageUploadEngine );
  58. } );
  59. it( 'should convert image\'s "reading" uploadStatus attribute', () => {
  60. setModelData( document, '<paragraph>[]foo</paragraph>' );
  61. editor.execute( 'imageUpload', { file: createNativeFileMock() } );
  62. expect( getViewData( viewDocument ) ).to.equal(
  63. '[<figure class="image ck-widget ck-appear ck-infinite-progress" 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( document, '<paragraph>[]foo</paragraph>' );
  70. editor.execute( 'imageUpload', { file: createNativeFileMock() } );
  71. document.once( 'changesDone', () => {
  72. expect( getViewData( viewDocument ) ).to.equal(
  73. '[<figure class="image ck-widget ck-appear" contenteditable="false">' +
  74. `<img src="${ base64Sample }"></img>` +
  75. '<div class="ck-progress-bar"></div>' +
  76. '</figure>]<p>foo</p>'
  77. );
  78. done();
  79. } );
  80. nativeReaderMock.mockSuccess( base64Sample );
  81. } );
  82. it( 'should update progressbar width on progress', done => {
  83. setModelData( document, '<paragraph>[]foo</paragraph>' );
  84. editor.execute( 'imageUpload', { file: createNativeFileMock() } );
  85. document.once( 'changesDone', () => {
  86. adapterMock.mockProgress( 40, 100 );
  87. expect( getViewData( viewDocument ) ).to.equal(
  88. '[<figure class="image ck-widget ck-appear" contenteditable="false">' +
  89. `<img src="${ base64Sample }"></img>` +
  90. '<div class="ck-progress-bar" style="width:40%;"></div>' +
  91. '</figure>]<p>foo</p>'
  92. );
  93. done();
  94. } );
  95. nativeReaderMock.mockSuccess( base64Sample );
  96. } );
  97. it( 'should convert image\'s "complete" uploadStatus attribute', done => {
  98. setModelData( document, '<paragraph>[]foo</paragraph>' );
  99. editor.execute( 'imageUpload', { file: createNativeFileMock() } );
  100. document.once( 'changesDone', () => {
  101. document.once( 'changesDone', () => {
  102. expect( getViewData( viewDocument ) ).to.equal(
  103. '[<figure class="image ck-widget" contenteditable="false">' +
  104. '<img src="image.png"></img>' +
  105. '</figure>]<p>foo</p>'
  106. );
  107. done();
  108. } );
  109. adapterMock.mockSuccess( { default: 'image.png' } );
  110. } );
  111. nativeReaderMock.mockSuccess( base64Sample );
  112. } );
  113. it( 'should allow to customize placeholder image', () => {
  114. const uploadProgress = editor.plugins.get( ImageUploadProgress );
  115. uploadProgress.placeholder = base64Sample;
  116. setModelData( document, '<paragraph>[]foo</paragraph>' );
  117. editor.execute( 'imageUpload', { file: createNativeFileMock() } );
  118. expect( getViewData( viewDocument ) ).to.equal(
  119. '[<figure class="image ck-widget ck-appear ck-infinite-progress" contenteditable="false">' +
  120. `<img src="${ base64Sample }"></img>` +
  121. '</figure>]<p>foo</p>'
  122. );
  123. } );
  124. it( 'should not process attribute change if it is already consumed', () => {
  125. editor.editing.modelToView.on( 'addAttribute:uploadStatus:image', ( evt, data, consumable ) => {
  126. consumable.consume( data.item, eventNameToConsumableType( evt.name ) );
  127. }, { priority: 'highest' } );
  128. setModelData( document, '<paragraph>[]foo</paragraph>' );
  129. editor.execute( 'imageUpload', { file: createNativeFileMock() } );
  130. expect( getViewData( viewDocument ) ).to.equal(
  131. '[<figure class="image ck-widget" contenteditable="false"><img></img></figure>]<p>foo</p>'
  132. );
  133. } );
  134. it( 'should not show progress bar if there is no loader with given uploadId', () => {
  135. setModelData( document, '<image uploadId="123" uploadStatus="reading"></image>' );
  136. const image = document.getRoot().getChild( 0 );
  137. document.enqueueChanges( () => {
  138. document.batch().setAttribute( image, 'uploadStatus', 'uploading' );
  139. } );
  140. expect( getViewData( viewDocument ) ).to.equal(
  141. '[<figure class="image ck-widget ck-appear ck-infinite-progress" contenteditable="false">' +
  142. `<img src="data:image/svg+xml;utf8,${ imagePlaceholder }"></img>` +
  143. '</figure>]'
  144. );
  145. document.enqueueChanges( () => {
  146. document.batch().setAttribute( image, 'uploadStatus', 'complete' );
  147. } );
  148. expect( getViewData( viewDocument ) ).to.equal(
  149. '[<figure class="image ck-widget" contenteditable="false">' +
  150. `<img src="data:image/svg+xml;utf8,${ imagePlaceholder }"></img>` +
  151. '</figure>]'
  152. );
  153. } );
  154. } );