imageuploadengine.js 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379
  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 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 ImageUploadCommand from '../src/imageuploadcommand';
  11. import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph';
  12. import UndoEngine from '@ckeditor/ckeditor5-undo/src/undoengine';
  13. import DataTransfer from '@ckeditor/ckeditor5-clipboard/src/datatransfer';
  14. import FileRepository from '../src/filerepository';
  15. import { AdapterMock, createNativeFileMock, NativeFileReaderMock } from './_utils/mocks';
  16. import { setData as setModelData, getData as getModelData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model';
  17. import { getData as getViewData } from '@ckeditor/ckeditor5-engine/src/dev-utils/view';
  18. import { eventNameToConsumableType } from '@ckeditor/ckeditor5-engine/src/conversion/model-to-view-converters';
  19. import Range from '@ckeditor/ckeditor5-engine/src/model/range';
  20. import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils';
  21. import Notification from '@ckeditor/ckeditor5-ui/src/notification/notification';
  22. describe( 'ImageUploadEngine', () => {
  23. // eslint-disable-next-line max-len
  24. const base64Sample = 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+A8AAQUBAScY42YAAAAASUVORK5CYII=';
  25. let editor, doc, fileRepository, viewDocument, nativeReaderMock, loader, adapterMock;
  26. testUtils.createSinonSandbox();
  27. class UploadAdapterPluginMock extends Plugin {
  28. init() {
  29. fileRepository = this.editor.plugins.get( FileRepository );
  30. fileRepository.createAdapter = newLoader => {
  31. loader = newLoader;
  32. adapterMock = new AdapterMock( loader );
  33. return adapterMock;
  34. };
  35. }
  36. }
  37. beforeEach( () => {
  38. testUtils.sinon.stub( window, 'FileReader' ).callsFake( () => {
  39. nativeReaderMock = new NativeFileReaderMock();
  40. return nativeReaderMock;
  41. } );
  42. return ClassicTestEditor
  43. .create( {
  44. plugins: [ ImageEngine, ImageUploadEngine, Paragraph, UndoEngine, UploadAdapterPluginMock ]
  45. } )
  46. .then( newEditor => {
  47. editor = newEditor;
  48. doc = editor.document;
  49. viewDocument = editor.editing.view;
  50. } );
  51. } );
  52. it( 'should register proper schema rules', () => {
  53. expect( doc.schema.check( { name: 'image', attributes: [ 'uploadId' ], inside: '$root' } ) ).to.be.true;
  54. } );
  55. it( 'should register imageUpload command', () => {
  56. expect( editor.commands.get( 'imageUpload' ) ).to.be.instanceOf( ImageUploadCommand );
  57. } );
  58. it( 'should execute imageUpload command when image is pasted', () => {
  59. const spy = sinon.spy( editor, 'execute' );
  60. const fileMock = createNativeFileMock();
  61. const dataTransfer = new DataTransfer( { files: [ fileMock ] } );
  62. setModelData( doc, '<paragraph>[]foo</paragraph>' );
  63. const targetRange = Range.createFromParentsAndOffsets( doc.getRoot(), 1, doc.getRoot(), 1 );
  64. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  65. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  66. sinon.assert.calledOnce( spy );
  67. sinon.assert.calledWith( spy, 'imageUpload' );
  68. const id = fileRepository.getLoader( fileMock ).id;
  69. expect( getModelData( doc ) ).to.equal(
  70. `<paragraph>foo</paragraph>[<image uploadId="${ id }" uploadStatus="reading"></image>]`
  71. );
  72. } );
  73. it( 'should execute imageUpload command with an optimized position when image is pasted', () => {
  74. const spy = sinon.spy( editor, 'execute' );
  75. const fileMock = createNativeFileMock();
  76. const dataTransfer = new DataTransfer( { files: [ fileMock ] } );
  77. setModelData( doc, '<paragraph>[]foo</paragraph>' );
  78. const paragraph = doc.getRoot().getChild( 0 );
  79. const targetRange = Range.createFromParentsAndOffsets( paragraph, 1, paragraph, 1 ); // f[]oo
  80. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  81. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  82. sinon.assert.calledOnce( spy );
  83. sinon.assert.calledWith( spy, 'imageUpload' );
  84. const id = fileRepository.getLoader( fileMock ).id;
  85. expect( getModelData( doc ) ).to.equal(
  86. `[<image uploadId="${ id }" uploadStatus="reading"></image>]<paragraph>foo</paragraph>`
  87. );
  88. } );
  89. it( 'should execute imageUpload command when multiple files image are pasted', () => {
  90. const spy = sinon.spy( editor, 'execute' );
  91. const files = [ createNativeFileMock(), createNativeFileMock() ];
  92. const dataTransfer = new DataTransfer( { files } );
  93. setModelData( doc, '<paragraph>[]foo</paragraph>' );
  94. const targetRange = Range.createFromParentsAndOffsets( doc.getRoot(), 1, doc.getRoot(), 1 );
  95. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  96. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  97. sinon.assert.calledTwice( spy );
  98. sinon.assert.calledWith( spy, 'imageUpload' );
  99. const id1 = fileRepository.getLoader( files[ 0 ] ).id;
  100. const id2 = fileRepository.getLoader( files[ 1 ] ).id;
  101. expect( getModelData( doc ) ).to.equal(
  102. '<paragraph>foo</paragraph>' +
  103. `<image uploadId="${ id1 }" uploadStatus="reading"></image>` +
  104. `[<image uploadId="${ id2 }" uploadStatus="reading"></image>]`
  105. );
  106. } );
  107. it( 'should not execute imageUpload command when file is not an image', () => {
  108. const spy = sinon.spy( editor, 'execute' );
  109. const viewDocument = editor.editing.view;
  110. const fileMock = {
  111. type: 'media/mp3',
  112. size: 1024
  113. };
  114. const dataTransfer = new DataTransfer( { files: [ fileMock ] } );
  115. setModelData( doc, '<paragraph>foo[]</paragraph>' );
  116. const targetRange = Range.createFromParentsAndOffsets( doc.getRoot(), 1, doc.getRoot(), 1 );
  117. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  118. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  119. sinon.assert.notCalled( spy );
  120. } );
  121. it( 'should not convert image\'s uploadId attribute if is consumed already', () => {
  122. editor.editing.modelToView.on( 'addAttribute:uploadId:image', ( evt, data, consumable ) => {
  123. consumable.consume( data.item, eventNameToConsumableType( evt.name ) );
  124. }, { priority: 'high' } );
  125. setModelData( doc, '<image uploadId="1234"></image>' );
  126. expect( getViewData( viewDocument ) ).to.equal(
  127. '[<figure class="image ck-widget" contenteditable="false">' +
  128. '<img></img>' +
  129. '</figure>]' );
  130. } );
  131. it( 'should use read data once it is present', done => {
  132. const file = createNativeFileMock();
  133. setModelData( doc, '<paragraph>{}foo bar</paragraph>' );
  134. editor.execute( 'imageUpload', { file } );
  135. doc.once( 'changesDone', () => {
  136. expect( getViewData( viewDocument ) ).to.equal(
  137. '[<figure class="image ck-widget" contenteditable="false">' +
  138. `<img src="${ base64Sample }"></img>` +
  139. '</figure>]' +
  140. '<p>foo bar</p>' );
  141. expect( loader.status ).to.equal( 'uploading' );
  142. done();
  143. } );
  144. expect( loader.status ).to.equal( 'reading' );
  145. nativeReaderMock.mockSuccess( base64Sample );
  146. } );
  147. it( 'should replace read data with server response once it is present', done => {
  148. const file = createNativeFileMock();
  149. setModelData( doc, '<paragraph>{}foo bar</paragraph>' );
  150. editor.execute( 'imageUpload', { file } );
  151. doc.once( 'changesDone', () => {
  152. doc.once( 'changesDone', () => {
  153. expect( getViewData( viewDocument ) ).to.equal(
  154. '[<figure class="image ck-widget" contenteditable="false"><img src="image.png"></img></figure>]<p>foo bar</p>'
  155. );
  156. expect( loader.status ).to.equal( 'idle' );
  157. done();
  158. } );
  159. adapterMock.mockSuccess( { default: 'image.png' } );
  160. } );
  161. nativeReaderMock.mockSuccess( base64Sample );
  162. } );
  163. it( 'should fire notification event in case of error', done => {
  164. const notification = editor.plugins.get( Notification );
  165. const file = createNativeFileMock();
  166. notification.on( 'show:warning', ( evt, data ) => {
  167. expect( data.message ).to.equal( 'Reading error.' );
  168. expect( data.title ).to.equal( 'Upload failed' );
  169. evt.stop();
  170. done();
  171. }, { priority: 'high' } );
  172. setModelData( doc, '<paragraph>{}foo bar</paragraph>' );
  173. editor.execute( 'imageUpload', { file } );
  174. nativeReaderMock.mockError( 'Reading error.' );
  175. } );
  176. it( 'should not fire notification on abort', done => {
  177. const notification = editor.plugins.get( Notification );
  178. const file = createNativeFileMock();
  179. const spy = testUtils.sinon.spy();
  180. notification.on( 'show:warning', evt => {
  181. spy();
  182. evt.stop();
  183. }, { priority: 'high' } );
  184. setModelData( doc, '<paragraph>{}foo bar</paragraph>' );
  185. editor.execute( 'imageUpload', { file } );
  186. nativeReaderMock.abort();
  187. setTimeout( () => {
  188. sinon.assert.notCalled( spy );
  189. done();
  190. }, 0 );
  191. } );
  192. it( 'should do nothing if image does not have uploadId', () => {
  193. setModelData( doc, '<image src="image.png"></image>' );
  194. expect( getViewData( viewDocument ) ).to.equal(
  195. '[<figure class="image ck-widget" contenteditable="false"><img src="image.png"></img></figure>]'
  196. );
  197. } );
  198. it( 'should remove image in case of upload error', done => {
  199. const file = createNativeFileMock();
  200. const spy = testUtils.sinon.spy();
  201. const notification = editor.plugins.get( Notification );
  202. setModelData( doc, '<paragraph>{}foo bar</paragraph>' );
  203. notification.on( 'show:warning', evt => {
  204. spy();
  205. evt.stop();
  206. }, { priority: 'high' } );
  207. editor.execute( 'imageUpload', { file } );
  208. doc.once( 'changesDone', () => {
  209. doc.once( 'changesDone', () => {
  210. expect( getModelData( doc ) ).to.equal( '<paragraph>[]foo bar</paragraph>' );
  211. sinon.assert.calledOnce( spy );
  212. done();
  213. } );
  214. } );
  215. nativeReaderMock.mockError( 'Upload error.' );
  216. } );
  217. it( 'should abort upload if image is removed', () => {
  218. const file = createNativeFileMock();
  219. setModelData( doc, '<paragraph>{}foo bar</paragraph>' );
  220. editor.execute( 'imageUpload', { file } );
  221. const abortSpy = testUtils.sinon.spy( loader, 'abort' );
  222. expect( loader.status ).to.equal( 'reading' );
  223. nativeReaderMock.mockSuccess( base64Sample );
  224. const image = doc.getRoot().getChild( 0 );
  225. doc.enqueueChanges( () => {
  226. const batch = doc.batch();
  227. batch.remove( image );
  228. } );
  229. expect( loader.status ).to.equal( 'aborted' );
  230. sinon.assert.calledOnce( abortSpy );
  231. } );
  232. it( 'image should be permanently removed if it is removed by user during upload', done => {
  233. const file = createNativeFileMock();
  234. const notification = editor.plugins.get( Notification );
  235. setModelData( doc, '<paragraph>{}foo bar</paragraph>' );
  236. // Prevent popping up alert window.
  237. notification.on( 'show:warning', evt => {
  238. evt.stop();
  239. }, { priority: 'high' } );
  240. editor.execute( 'imageUpload', { file } );
  241. doc.once( 'changesDone', () => {
  242. // This is called after "manual" remove.
  243. doc.once( 'changesDone', () => {
  244. // This is called after attributes are removed.
  245. let undone = false;
  246. doc.once( 'changesDone', () => {
  247. if ( !undone ) {
  248. undone = true;
  249. // This is called after abort remove.
  250. expect( getModelData( doc ) ).to.equal( '<paragraph>[]foo bar</paragraph>' );
  251. editor.execute( 'undo' );
  252. // Expect that the image has not been brought back.
  253. expect( getModelData( doc ) ).to.equal( '<paragraph>[]foo bar</paragraph>' );
  254. done();
  255. }
  256. } );
  257. } );
  258. } );
  259. const image = doc.getRoot().getChild( 0 );
  260. doc.enqueueChanges( () => {
  261. const batch = doc.batch();
  262. batch.remove( image );
  263. } );
  264. } );
  265. it( 'should create responsive image if server return multiple images', done => {
  266. const file = createNativeFileMock();
  267. setModelData( doc, '<paragraph>{}foo bar</paragraph>' );
  268. editor.execute( 'imageUpload', { file } );
  269. doc.once( 'changesDone', () => {
  270. doc.once( 'changesDone', () => {
  271. expect( getViewData( viewDocument ) ).to.equal(
  272. '[<figure class="image ck-widget" contenteditable="false">' +
  273. '<img sizes="100vw" src="image.png" srcset="image-500.png 500w, image-800.png 800w"></img>' +
  274. '</figure>]<p>foo bar</p>'
  275. );
  276. expect( loader.status ).to.equal( 'idle' );
  277. done();
  278. } );
  279. adapterMock.mockSuccess( { default: 'image.png', 500: 'image-500.png', 800: 'image-800.png' } );
  280. } );
  281. nativeReaderMock.mockSuccess( base64Sample );
  282. } );
  283. it( 'should prevent from browser redirecting when an image is dropped on another image', () => {
  284. const spy = testUtils.sinon.spy();
  285. editor.editing.view.fire( 'dragover', {
  286. preventDefault: spy
  287. } );
  288. expect( spy.calledOnce ).to.equal( true );
  289. } );
  290. } );