imageuploadengine.js 6.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190
  1. /**
  2. * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. /* globals window, setTimeout */
  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 ImageUploadCommand from '../src/imageuploadcommand';
  10. import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph';
  11. import DataTransfer from '@ckeditor/ckeditor5-clipboard/src/datatransfer';
  12. import FileRepository from '../src/filerepository';
  13. import { AdapterMock, createNativeFileMock, NativeFileReaderMock } from './_utils/mocks';
  14. import { setData as setModelData, getData as getModelData } 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 Notification from '@ckeditor/ckeditor5-ui/src/notification/notification';
  19. describe( 'ImageUploadEngine', () => {
  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', () => {
  25. nativeReaderMock = new NativeFileReaderMock();
  26. return nativeReaderMock;
  27. } );
  28. return ClassicTestEditor.create( {
  29. plugins: [ ImageEngine, ImageUploadEngine, Paragraph ]
  30. } )
  31. .then( newEditor => {
  32. editor = newEditor;
  33. document = editor.document;
  34. viewDocument = editor.editing.view;
  35. fileRepository = editor.plugins.get( FileRepository );
  36. fileRepository.createAdapter = newLoader => {
  37. loader = newLoader;
  38. adapterMock = new AdapterMock( loader );
  39. return adapterMock;
  40. };
  41. } );
  42. } );
  43. it( 'should register proper schema rules', () => {
  44. expect( document.schema.check( { name: 'image', attributes: [ 'uploadId' ], inside: '$root' } ) ).to.be.true;
  45. } );
  46. it( 'should register imageUpload command', () => {
  47. expect( editor.commands.get( 'imageUpload' ) ).to.be.instanceOf( ImageUploadCommand );
  48. } );
  49. it( 'should execute imageUpload command when image is pasted', () => {
  50. const spy = sinon.spy( editor, 'execute' );
  51. const fileMock = createNativeFileMock();
  52. const dataTransfer = new DataTransfer( { files: [ fileMock ] } );
  53. setModelData( document, '<paragraph>foo bar baz[]</paragraph>' );
  54. viewDocument.fire( 'clipboardInput', { dataTransfer } );
  55. sinon.assert.calledOnce( spy );
  56. sinon.assert.calledWith( spy, 'imageUpload' );
  57. const id = fileRepository.getLoader( fileMock ).id;
  58. expect( getModelData( document ) ).to.equal(
  59. `[<image uploadId="${ id }" uploadStatus="reading"></image>]<paragraph>foo bar baz</paragraph>`
  60. );
  61. } );
  62. it( 'should not execute imageUpload command when file is not an image', () => {
  63. const spy = sinon.spy( editor, 'execute' );
  64. const viewDocument = editor.editing.view;
  65. const fileMock = {
  66. type: 'media/mp3',
  67. size: 1024
  68. };
  69. const dataTransfer = new DataTransfer( { files: [ fileMock ] } );
  70. setModelData( document, '<paragraph>foo bar baz[]</paragraph>' );
  71. viewDocument.fire( 'clipboardInput', { dataTransfer } );
  72. sinon.assert.notCalled( spy );
  73. } );
  74. it( 'should not convert image\'s uploadId attribute if is consumed already', () => {
  75. editor.editing.modelToView.on( 'addAttribute:uploadId:image', ( evt, data, consumable ) => {
  76. consumable.consume( data.item, eventNameToConsumableType( evt.name ) );
  77. }, { priority: 'high' } );
  78. setModelData( document, '<image uploadId="1234"></image>' );
  79. expect( getViewData( viewDocument ) ).to.equal(
  80. '[]<figure class="image ck-widget" contenteditable="false">' +
  81. '<img></img>' +
  82. '</figure>' );
  83. } );
  84. it( 'should use read data once it is present', ( done ) => {
  85. const file = createNativeFileMock();
  86. setModelData( document, '<paragraph>{}foo bar</paragraph>' );
  87. editor.execute( 'imageUpload', { file } );
  88. document.once( 'changesDone', () => {
  89. expect( getViewData( viewDocument ) ).to.equal(
  90. '[<figure class="image ck-widget" contenteditable="false">' +
  91. `<img src="${ base64Sample }"></img>` +
  92. '</figure>]' +
  93. '<p>foo bar</p>' );
  94. expect( loader.status ).to.equal( 'uploading' );
  95. done();
  96. } );
  97. expect( loader.status ).to.equal( 'reading' );
  98. nativeReaderMock.mockSuccess( base64Sample );
  99. } );
  100. it( 'should replace read data with server response once it is present', ( done ) => {
  101. const file = createNativeFileMock();
  102. setModelData( document, '<paragraph>{}foo bar</paragraph>' );
  103. editor.execute( 'imageUpload', { file } );
  104. document.once( 'changesDone', () => {
  105. document.once( 'changesDone', () => {
  106. expect( getViewData( viewDocument ) ).to.equal(
  107. '[<figure class="image ck-widget" contenteditable="false"><img src="image.png"></img></figure>]<p>foo bar</p>'
  108. );
  109. expect( loader.status ).to.equal( 'idle' );
  110. done();
  111. } );
  112. adapterMock.mockSuccess( { original: 'image.png' } );
  113. } );
  114. nativeReaderMock.mockSuccess( base64Sample );
  115. } );
  116. it( 'should fire notification event in case of error', ( done ) => {
  117. const notification = editor.plugins.get( Notification );
  118. const file = createNativeFileMock();
  119. notification.on( 'show:warning', ( evt, data ) => {
  120. expect( data.message ).to.equal( 'Reading error.' );
  121. evt.stop();
  122. done();
  123. }, { priority: 'high' } );
  124. setModelData( document, '<paragraph>{}foo bar</paragraph>' );
  125. editor.execute( 'imageUpload', { file } );
  126. nativeReaderMock.mockError( 'Reading error.' );
  127. } );
  128. it( 'should not fire notification on abort', ( done ) => {
  129. const notification = editor.plugins.get( Notification );
  130. const file = createNativeFileMock();
  131. const spy = testUtils.sinon.spy();
  132. notification.on( 'show:warning', evt => {
  133. spy();
  134. evt.stop();
  135. }, { priority: 'high' } );
  136. setModelData( document, '<paragraph>{}foo bar</paragraph>' );
  137. editor.execute( 'imageUpload', { file } );
  138. nativeReaderMock.abort();
  139. setTimeout( () => {
  140. sinon.assert.notCalled( spy );
  141. done();
  142. }, 0 );
  143. } );
  144. it( 'should do nothing if image does not have uploadId', () => {
  145. setModelData( document, '<image src="image.png"></image>' );
  146. expect( getViewData( viewDocument ) ).to.equal(
  147. '[]<figure class="image ck-widget" contenteditable="false"><img src="image.png"></img></figure>'
  148. );
  149. } );
  150. } );