imageuploadprogress.js 6.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179
  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 ImageEngine from '@ckeditor/ckeditor5-image/src/image/imageengine';
  8. import ImageUploadEngine from '../src/imageuploadengine';
  9. import ImageUploadProgress from '../src/imageuploadprogress';
  10. import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph';
  11. import FileRepository from '../src/filerepository';
  12. import { AdapterMock, createNativeFileMock, NativeFileReaderMock } from './_utils/mocks';
  13. import { setData as setModelData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model';
  14. import { getData as getViewData } from '@ckeditor/ckeditor5-engine/src/dev-utils/view';
  15. import { eventNameToConsumableType } from '@ckeditor/ckeditor5-engine/src/conversion/model-to-view-converters';
  16. import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils';
  17. import imagePlaceholder from '../theme/icons/image_placeholder.svg';
  18. describe( 'ImageUploadProgress', () => {
  19. // eslint-disable-next-line max-len
  20. const base64Sample = 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+A8AAQUBAScY42YAAAAASUVORK5CYII=';
  21. let editor, document, fileRepository, viewDocument, nativeReaderMock, loader, adapterMock;
  22. testUtils.createSinonSandbox();
  23. beforeEach( () => {
  24. testUtils.sinon.stub( window, 'FileReader' ).callsFake( () => {
  25. nativeReaderMock = new NativeFileReaderMock();
  26. return nativeReaderMock;
  27. } );
  28. return ClassicTestEditor
  29. .create( {
  30. plugins: [ ImageEngine, Paragraph, ImageUploadProgress ]
  31. } )
  32. .then( newEditor => {
  33. editor = newEditor;
  34. document = editor.document;
  35. viewDocument = editor.editing.view;
  36. fileRepository = editor.plugins.get( FileRepository );
  37. fileRepository.createAdapter = newLoader => {
  38. loader = newLoader;
  39. adapterMock = new AdapterMock( loader );
  40. return adapterMock;
  41. };
  42. } );
  43. } );
  44. it( 'should include ImageUploadEngine', () => {
  45. expect( editor.plugins.get( ImageUploadEngine ) ).to.be.instanceOf( ImageUploadEngine );
  46. } );
  47. it( 'should convert image\'s "reading" uploadStatus attribute', () => {
  48. setModelData( document, '<paragraph>[]foo</paragraph>' );
  49. editor.execute( 'imageUpload', { file: createNativeFileMock() } );
  50. expect( getViewData( viewDocument ) ).to.equal(
  51. '[<figure class="image ck-widget ck-appear ck-infinite-progress" contenteditable="false">' +
  52. `<img src="data:image/svg+xml;utf8,${ imagePlaceholder }"></img>` +
  53. '</figure>]<p>foo</p>'
  54. );
  55. } );
  56. it( 'should convert image\'s "uploading" uploadStatus attribute', done => {
  57. setModelData( document, '<paragraph>[]foo</paragraph>' );
  58. editor.execute( 'imageUpload', { file: createNativeFileMock() } );
  59. document.once( 'changesDone', () => {
  60. expect( getViewData( viewDocument ) ).to.equal(
  61. '[<figure class="image ck-widget ck-appear" contenteditable="false">' +
  62. `<img src="${ base64Sample }"></img>` +
  63. '<div class="ck-progress-bar"></div>' +
  64. '</figure>]<p>foo</p>'
  65. );
  66. done();
  67. } );
  68. nativeReaderMock.mockSuccess( base64Sample );
  69. } );
  70. it( 'should update progressbar width on progress', done => {
  71. setModelData( document, '<paragraph>[]foo</paragraph>' );
  72. editor.execute( 'imageUpload', { file: createNativeFileMock() } );
  73. document.once( 'changesDone', () => {
  74. adapterMock.mockProgress( 40, 100 );
  75. expect( getViewData( viewDocument ) ).to.equal(
  76. '[<figure class="image ck-widget ck-appear" contenteditable="false">' +
  77. `<img src="${ base64Sample }"></img>` +
  78. '<div class="ck-progress-bar" style="width:40%;"></div>' +
  79. '</figure>]<p>foo</p>'
  80. );
  81. done();
  82. } );
  83. nativeReaderMock.mockSuccess( base64Sample );
  84. } );
  85. it( 'should convert image\'s "complete" uploadStatus attribute', done => {
  86. setModelData( document, '<paragraph>[]foo</paragraph>' );
  87. editor.execute( 'imageUpload', { file: createNativeFileMock() } );
  88. document.once( 'changesDone', () => {
  89. document.once( 'changesDone', () => {
  90. expect( getViewData( viewDocument ) ).to.equal(
  91. '[<figure class="image ck-widget" contenteditable="false">' +
  92. '<img src="image.png"></img>' +
  93. '</figure>]<p>foo</p>'
  94. );
  95. done();
  96. } );
  97. adapterMock.mockSuccess( { default: 'image.png' } );
  98. } );
  99. nativeReaderMock.mockSuccess( base64Sample );
  100. } );
  101. it( 'should allow to customize placeholder image', () => {
  102. const uploadProgress = editor.plugins.get( ImageUploadProgress );
  103. uploadProgress.placeholder = base64Sample;
  104. setModelData( document, '<paragraph>[]foo</paragraph>' );
  105. editor.execute( 'imageUpload', { file: createNativeFileMock() } );
  106. expect( getViewData( viewDocument ) ).to.equal(
  107. '[<figure class="image ck-widget ck-appear ck-infinite-progress" contenteditable="false">' +
  108. `<img src="${ base64Sample }"></img>` +
  109. '</figure>]<p>foo</p>'
  110. );
  111. } );
  112. it( 'should not process attribute change if it is already consumed', () => {
  113. editor.editing.modelToView.on( 'addAttribute:uploadStatus:image', ( evt, data, consumable ) => {
  114. consumable.consume( data.item, eventNameToConsumableType( evt.name ) );
  115. }, { priority: 'highest' } );
  116. setModelData( document, '<paragraph>[]foo</paragraph>' );
  117. editor.execute( 'imageUpload', { file: createNativeFileMock() } );
  118. expect( getViewData( viewDocument ) ).to.equal(
  119. '[<figure class="image ck-widget" contenteditable="false"><img></img></figure>]<p>foo</p>'
  120. );
  121. } );
  122. it( 'should not show progress bar if there is no loader with given uploadId', () => {
  123. setModelData( document, '<image uploadId="123" uploadStatus="reading"></image>' );
  124. const image = document.getRoot().getChild( 0 );
  125. document.enqueueChanges( () => {
  126. document.batch().setAttribute( image, 'uploadStatus', 'uploading' );
  127. } );
  128. expect( getViewData( viewDocument ) ).to.equal(
  129. '[<figure class="image ck-widget ck-appear ck-infinite-progress" contenteditable="false">' +
  130. `<img src="data:image/svg+xml;utf8,${ imagePlaceholder }"></img>` +
  131. '</figure>]'
  132. );
  133. document.enqueueChanges( () => {
  134. document.batch().setAttribute( image, 'uploadStatus', 'complete' );
  135. } );
  136. expect( getViewData( viewDocument ) ).to.equal(
  137. '[<figure class="image ck-widget" contenteditable="false">' +
  138. `<img src="data:image/svg+xml;utf8,${ imagePlaceholder }"></img>` +
  139. '</figure>]'
  140. );
  141. } );
  142. } );