imageuploadediting.js 37 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031
  1. /**
  2. * @license Copyright (c) 2003-2019, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. /* globals window, setTimeout, atob, URL, Blob */
  6. import VirtualTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/virtualtesteditor';
  7. import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
  8. import Clipboard from '@ckeditor/ckeditor5-clipboard/src/clipboard';
  9. import ImageEditing from '../../src/image/imageediting';
  10. import ImageUploadEditing from '../../src/imageupload/imageuploadediting';
  11. import ImageUploadCommand from '../../src/imageupload/imageuploadcommand';
  12. import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph';
  13. import UndoEditing from '@ckeditor/ckeditor5-undo/src/undoediting';
  14. import DataTransfer from '@ckeditor/ckeditor5-clipboard/src/datatransfer';
  15. import FileRepository from '@ckeditor/ckeditor5-upload/src/filerepository';
  16. import { UploadAdapterMock, createNativeFileMock, NativeFileReaderMock } from '@ckeditor/ckeditor5-upload/tests/_utils/mocks';
  17. import { setData as setModelData, getData as getModelData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model';
  18. import { getData as getViewData, stringify as stringifyView } from '@ckeditor/ckeditor5-engine/src/dev-utils/view';
  19. import log from '@ckeditor/ckeditor5-utils/src/log';
  20. import env from '@ckeditor/ckeditor5-utils/src/env';
  21. import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils';
  22. import Notification from '@ckeditor/ckeditor5-ui/src/notification/notification';
  23. describe( 'ImageUploadEditing', () => {
  24. // eslint-disable-next-line max-len
  25. const base64Sample = 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+A8AAQUBAScY42YAAAAASUVORK5CYII=';
  26. const isEdgeEnv = env.isEdge;
  27. let adapterMocks = [];
  28. let editor, model, view, doc, fileRepository, viewDocument, nativeReaderMock, loader;
  29. testUtils.createSinonSandbox();
  30. class UploadAdapterPluginMock extends Plugin {
  31. init() {
  32. fileRepository = this.editor.plugins.get( FileRepository );
  33. fileRepository.createUploadAdapter = newLoader => {
  34. loader = newLoader;
  35. const adapterMock = new UploadAdapterMock( loader );
  36. adapterMocks.push( adapterMock );
  37. return adapterMock;
  38. };
  39. }
  40. }
  41. beforeEach( () => {
  42. if ( isEdgeEnv ) {
  43. testUtils.sinon.stub( window, 'File' ).callsFake( () => {
  44. return { name: 'file.jpg' };
  45. } );
  46. }
  47. // Most tests assume non-edge environment but we do not set `contenteditable=false` on Edge so stub `env.isEdge`.
  48. testUtils.sinon.stub( env, 'isEdge' ).get( () => false );
  49. testUtils.sinon.stub( window, 'FileReader' ).callsFake( () => {
  50. nativeReaderMock = new NativeFileReaderMock();
  51. return nativeReaderMock;
  52. } );
  53. return VirtualTestEditor
  54. .create( {
  55. plugins: [ ImageEditing, ImageUploadEditing, Paragraph, UndoEditing, UploadAdapterPluginMock, Clipboard ]
  56. } )
  57. .then( newEditor => {
  58. editor = newEditor;
  59. model = editor.model;
  60. doc = model.document;
  61. view = editor.editing.view;
  62. viewDocument = view.document;
  63. // Stub `view.scrollToTheSelection` as it will fail on VirtualTestEditor without DOM.
  64. testUtils.sinon.stub( view, 'scrollToTheSelection' ).callsFake( () => {} );
  65. } );
  66. } );
  67. afterEach( () => {
  68. adapterMocks = [];
  69. return editor.destroy();
  70. } );
  71. it( 'should register proper schema rules', () => {
  72. expect( model.schema.checkAttribute( [ '$root', 'image' ], 'uploadId' ) ).to.be.true;
  73. } );
  74. it( 'should register imageUpload command', () => {
  75. expect( editor.commands.get( 'imageUpload' ) ).to.be.instanceOf( ImageUploadCommand );
  76. } );
  77. it( 'should not crash when Clipboard plugin is not available', () => {
  78. return VirtualTestEditor
  79. .create( {
  80. plugins: [ ImageEditing, ImageUploadEditing, Paragraph, UndoEditing, UploadAdapterPluginMock ]
  81. } );
  82. } );
  83. it( 'should insert image when is pasted', () => {
  84. const fileMock = createNativeFileMock();
  85. const dataTransfer = new DataTransfer( { files: [ fileMock ], types: [ 'Files' ] } );
  86. setModelData( model, '<paragraph>[]foo</paragraph>' );
  87. const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 1 ), model.createPositionAt( doc.getRoot(), 1 ) );
  88. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  89. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  90. const id = fileRepository.getLoader( fileMock ).id;
  91. expect( getModelData( model ) ).to.equal(
  92. `<paragraph>foo</paragraph>[<image uploadId="${ id }" uploadStatus="reading"></image>]`
  93. );
  94. } );
  95. it( 'should insert image at optimized position when is pasted', () => {
  96. const fileMock = createNativeFileMock();
  97. const dataTransfer = new DataTransfer( { files: [ fileMock ], types: [ 'Files' ] } );
  98. setModelData( model, '<paragraph>[]foo</paragraph>' );
  99. const paragraph = doc.getRoot().getChild( 0 );
  100. const targetRange = model.createRange( model.createPositionAt( paragraph, 1 ), model.createPositionAt( paragraph, 1 ) ); // f[]oo
  101. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  102. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  103. const id = fileRepository.getLoader( fileMock ).id;
  104. expect( getModelData( model ) ).to.equal(
  105. `[<image uploadId="${ id }" uploadStatus="reading"></image>]<paragraph>foo</paragraph>`
  106. );
  107. } );
  108. it( 'should insert multiple image files when are pasted', () => {
  109. const files = [ createNativeFileMock(), createNativeFileMock() ];
  110. const dataTransfer = new DataTransfer( { files, types: [ 'Files' ] } );
  111. setModelData( model, '<paragraph>[]foo</paragraph>' );
  112. const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 1 ), model.createPositionAt( doc.getRoot(), 1 ) );
  113. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  114. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  115. const id1 = fileRepository.getLoader( files[ 0 ] ).id;
  116. const id2 = fileRepository.getLoader( files[ 1 ] ).id;
  117. expect( getModelData( model ) ).to.equal(
  118. '<paragraph>foo</paragraph>' +
  119. `<image uploadId="${ id1 }" uploadStatus="reading"></image>` +
  120. `[<image uploadId="${ id2 }" uploadStatus="reading"></image>]`
  121. );
  122. } );
  123. it( 'should insert image when is pasted on allowed position when ImageUploadCommand is disabled', () => {
  124. setModelData( model, '<paragraph>foo</paragraph>[<image></image>]' );
  125. const fileMock = createNativeFileMock();
  126. const dataTransfer = new DataTransfer( { files: [ fileMock ], types: [ 'Files' ] } );
  127. const command = editor.commands.get( 'imageUpload' );
  128. expect( command.isEnabled ).to.be.false;
  129. const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 0 ), model.createPositionAt( doc.getRoot(), 0 ) );
  130. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  131. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  132. const id = fileRepository.getLoader( fileMock ).id;
  133. expect( getModelData( model ) ).to.equal(
  134. `[<image uploadId="${ id }" uploadStatus="reading"></image>]<paragraph>foo</paragraph><image></image>`
  135. );
  136. } );
  137. it( 'should not insert image when editor is in read-only mode', () => {
  138. // Clipboard plugin is required for this test.
  139. return VirtualTestEditor
  140. .create( {
  141. plugins: [ ImageEditing, ImageUploadEditing, Paragraph, UploadAdapterPluginMock, Clipboard ]
  142. } )
  143. .then( editor => {
  144. const fileMock = createNativeFileMock();
  145. const dataTransfer = new DataTransfer( { files: [ fileMock ], types: [ 'Files' ] } );
  146. setModelData( editor.model, '<paragraph>[]foo</paragraph>' );
  147. const targetRange = editor.model.document.selection.getFirstRange();
  148. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  149. editor.isReadOnly = true;
  150. editor.editing.view.document.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  151. expect( getModelData( editor.model ) ).to.equal( '<paragraph>[]foo</paragraph>' );
  152. return editor.destroy();
  153. } );
  154. } );
  155. it( 'should not insert image when file is not an image', () => {
  156. const viewDocument = editor.editing.view.document;
  157. const fileMock = {
  158. type: 'media/mp3',
  159. size: 1024
  160. };
  161. const dataTransfer = new DataTransfer( {
  162. files: [ fileMock ],
  163. types: [ 'Files' ],
  164. getData: () => ''
  165. } );
  166. setModelData( model, '<paragraph>foo[]</paragraph>' );
  167. const targetRange = doc.selection.getFirstRange();
  168. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  169. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  170. expect( getModelData( model ) ).to.equal( '<paragraph>foo[]</paragraph>' );
  171. } );
  172. it( 'should not insert image when file is null', () => {
  173. const viewDocument = editor.editing.view.document;
  174. const dataTransfer = new DataTransfer( { files: [ null ], types: [ 'Files' ], getData: () => null } );
  175. setModelData( model, '<paragraph>foo[]</paragraph>' );
  176. const targetRange = doc.selection.getFirstRange();
  177. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  178. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  179. expect( getModelData( model ) ).to.equal( '<paragraph>foo[]</paragraph>' );
  180. } );
  181. it( 'should not insert image when there is non-empty HTML content pasted', () => {
  182. const fileMock = createNativeFileMock();
  183. const dataTransfer = new DataTransfer( {
  184. files: [ fileMock ],
  185. types: [ 'Files', 'text/html' ],
  186. getData: type => type === 'text/html' ? '<p>SomeData</p>' : ''
  187. } );
  188. setModelData( model, '<paragraph>[]foo</paragraph>' );
  189. const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 1 ), model.createPositionAt( doc.getRoot(), 1 ) );
  190. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  191. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  192. expect( getModelData( model ) ).to.equal( '<paragraph>SomeData[]foo</paragraph>' );
  193. } );
  194. it( 'should not insert image nor crash when pasted image could not be inserted', () => {
  195. model.schema.register( 'other', {
  196. allowIn: '$root',
  197. isLimit: true
  198. } );
  199. model.schema.extend( '$text', { allowIn: 'other' } );
  200. editor.conversion.elementToElement( { model: 'other', view: 'p' } );
  201. setModelData( model, '<other>[]</other>' );
  202. const fileMock = createNativeFileMock();
  203. const dataTransfer = new DataTransfer( { files: [ fileMock ], types: [ 'Files' ] } );
  204. const targetRange = doc.selection.getFirstRange();
  205. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  206. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  207. expect( getModelData( model ) ).to.equal( '<other>[]</other>' );
  208. } );
  209. it( 'should not throw when upload adapter is not set (FileRepository will log an error anyway) when image is pasted', () => {
  210. const fileMock = createNativeFileMock();
  211. const dataTransfer = new DataTransfer( { files: [ fileMock ], types: [ 'Files' ] } );
  212. const logStub = testUtils.sinon.stub( log, 'error' );
  213. setModelData( model, '<paragraph>[]foo</paragraph>' );
  214. fileRepository.createUploadAdapter = undefined;
  215. const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 1 ), model.createPositionAt( doc.getRoot(), 1 ) );
  216. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  217. expect( () => {
  218. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  219. } ).to.not.throw();
  220. expect( getModelData( model ) ).to.equal( '<paragraph>foo[]</paragraph>' );
  221. sinon.assert.calledOnce( logStub );
  222. } );
  223. // https://github.com/ckeditor/ckeditor5-upload/issues/70
  224. it( 'should not crash on browsers which do not implement DOMStringList as a child class of an Array', () => {
  225. const typesDomStringListMock = {
  226. length: 2,
  227. '0': 'text/html',
  228. '1': 'text/plain'
  229. };
  230. const dataTransfer = new DataTransfer( {
  231. types: typesDomStringListMock,
  232. getData: type => type === 'text/html' ? '<p>SomeData</p>' : 'SomeData'
  233. } );
  234. setModelData( model, '<paragraph>[]foo</paragraph>' );
  235. const targetRange = doc.selection.getFirstRange();
  236. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  237. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  238. // Well, there's no clipboard plugin, so nothing happens.
  239. expect( getModelData( model ) ).to.equal( '<paragraph>SomeData[]foo</paragraph>' );
  240. } );
  241. it( 'should not convert image\'s uploadId attribute if is consumed already', () => {
  242. editor.editing.downcastDispatcher.on( 'attribute:uploadId:image', ( evt, data, conversionApi ) => {
  243. conversionApi.consumable.consume( data.item, evt.name );
  244. }, { priority: 'high' } );
  245. setModelData( model, '<image uploadId="1234"></image>' );
  246. expect( getViewData( view ) ).to.equal(
  247. '[<figure class="ck-widget image" contenteditable="false">' +
  248. '<img></img>' +
  249. '</figure>]' );
  250. } );
  251. it( 'should use read data once it is present', done => {
  252. const file = createNativeFileMock();
  253. setModelData( model, '<paragraph>{}foo bar</paragraph>' );
  254. editor.execute( 'imageUpload', { file } );
  255. model.document.once( 'change', () => {
  256. tryExpect( done, () => {
  257. expect( getViewData( view ) ).to.equal(
  258. '[<figure class="ck-widget image" contenteditable="false">' +
  259. `<img src="${ base64Sample }"></img>` +
  260. '</figure>]' +
  261. '<p>foo bar</p>'
  262. );
  263. expect( loader.status ).to.equal( 'uploading' );
  264. } );
  265. } );
  266. expect( loader.status ).to.equal( 'reading' );
  267. loader.file.then( () => nativeReaderMock.mockSuccess( base64Sample ) );
  268. } );
  269. it( 'should replace read data with server response once it is present', done => {
  270. const file = createNativeFileMock();
  271. setModelData( model, '<paragraph>{}foo bar</paragraph>' );
  272. editor.execute( 'imageUpload', { file } );
  273. model.document.once( 'change', () => {
  274. model.document.once( 'change', () => {
  275. tryExpect( done, () => {
  276. expect( getViewData( view ) ).to.equal(
  277. '[<figure class="ck-widget image" contenteditable="false"><img src="image.png"></img></figure>]<p>foo bar</p>'
  278. );
  279. expect( loader.status ).to.equal( 'idle' );
  280. } );
  281. }, { priority: 'lowest' } );
  282. loader.file.then( () => adapterMocks[ 0 ].mockSuccess( { default: 'image.png' } ) );
  283. } );
  284. loader.file.then( () => nativeReaderMock.mockSuccess( base64Sample ) );
  285. } );
  286. it( 'should fire notification event in case of error', done => {
  287. const notification = editor.plugins.get( Notification );
  288. const file = createNativeFileMock();
  289. notification.on( 'show:warning', ( evt, data ) => {
  290. tryExpect( done, () => {
  291. expect( data.message ).to.equal( 'Reading error.' );
  292. expect( data.title ).to.equal( 'Upload failed' );
  293. evt.stop();
  294. } );
  295. }, { priority: 'high' } );
  296. setModelData( model, '<paragraph>{}foo bar</paragraph>' );
  297. editor.execute( 'imageUpload', { file } );
  298. loader.file.then( () => nativeReaderMock.mockError( 'Reading error.' ) );
  299. } );
  300. it( 'should not fire notification on abort', done => {
  301. const notification = editor.plugins.get( Notification );
  302. const file = createNativeFileMock();
  303. const spy = testUtils.sinon.spy();
  304. notification.on( 'show:warning', evt => {
  305. spy();
  306. evt.stop();
  307. }, { priority: 'high' } );
  308. setModelData( model, '<paragraph>{}foo bar</paragraph>' );
  309. editor.execute( 'imageUpload', { file } );
  310. loader.file.then( () => {
  311. nativeReaderMock.abort();
  312. setTimeout( () => {
  313. sinon.assert.notCalled( spy );
  314. done();
  315. }, 0 );
  316. } );
  317. } );
  318. it( 'should throw when other error happens during upload', done => {
  319. const file = createNativeFileMock();
  320. const error = new Error( 'Foo bar baz' );
  321. const uploadEditing = editor.plugins.get( ImageUploadEditing );
  322. const loadSpy = sinon.spy( uploadEditing, '_readAndUpload' );
  323. const catchSpy = sinon.spy();
  324. // Throw an error when async attribute change occur.
  325. editor.editing.downcastDispatcher.on( 'attribute:uploadStatus:image', ( evt, data ) => {
  326. if ( data.attributeNewValue == 'uploading' ) {
  327. throw error;
  328. }
  329. } );
  330. setModelData( model, '<paragraph>{}foo bar</paragraph>' );
  331. editor.execute( 'imageUpload', { file } );
  332. sinon.assert.calledOnce( loadSpy );
  333. const promise = loadSpy.returnValues[ 0 ];
  334. // Check if error can be caught.
  335. promise.catch( catchSpy );
  336. loader.file.then( () => {
  337. nativeReaderMock.mockSuccess();
  338. setTimeout( () => {
  339. sinon.assert.calledOnce( catchSpy );
  340. sinon.assert.calledWithExactly( catchSpy, error );
  341. done();
  342. }, 0 );
  343. } );
  344. } );
  345. it( 'should do nothing if image does not have uploadId', () => {
  346. setModelData( model, '<image src="image.png"></image>' );
  347. expect( getViewData( view ) ).to.equal(
  348. '[<figure class="ck-widget image" contenteditable="false"><img src="image.png"></img></figure>]'
  349. );
  350. } );
  351. it( 'should remove image in case of upload error', done => {
  352. const file = createNativeFileMock();
  353. const spy = testUtils.sinon.spy();
  354. const notification = editor.plugins.get( Notification );
  355. setModelData( model, '<paragraph>{}foo bar</paragraph>' );
  356. notification.on( 'show:warning', evt => {
  357. spy();
  358. evt.stop();
  359. }, { priority: 'high' } );
  360. editor.execute( 'imageUpload', { file } );
  361. model.document.once( 'change', () => {
  362. model.document.once( 'change', () => {
  363. tryExpect( done, () => {
  364. expect( getModelData( model ) ).to.equal( '<paragraph>[]foo bar</paragraph>' );
  365. sinon.assert.calledOnce( spy );
  366. } );
  367. } );
  368. } );
  369. loader.file.then( () => nativeReaderMock.mockError( 'Upload error.' ) );
  370. } );
  371. it( 'should abort upload if image is removed', () => {
  372. const file = createNativeFileMock();
  373. setModelData( model, '<paragraph>{}foo bar</paragraph>' );
  374. editor.execute( 'imageUpload', { file } );
  375. const abortSpy = testUtils.sinon.spy( loader, 'abort' );
  376. expect( loader.status ).to.equal( 'reading' );
  377. return loader.file.then( () => {
  378. nativeReaderMock.mockSuccess( base64Sample );
  379. const image = doc.getRoot().getChild( 0 );
  380. model.change( writer => {
  381. writer.remove( image );
  382. } );
  383. expect( loader.status ).to.equal( 'aborted' );
  384. sinon.assert.calledOnce( abortSpy );
  385. } );
  386. } );
  387. it( 'should not abort and not restart upload when image is moved', () => {
  388. const file = createNativeFileMock();
  389. setModelData( model, '<paragraph>{}foo bar</paragraph>' );
  390. editor.execute( 'imageUpload', { file } );
  391. const abortSpy = testUtils.sinon.spy( loader, 'abort' );
  392. const loadSpy = testUtils.sinon.spy( loader, 'read' );
  393. const image = doc.getRoot().getChild( 0 );
  394. model.change( writer => {
  395. writer.move( writer.createRangeOn( image ), writer.createPositionAt( doc.getRoot(), 2 ) );
  396. } );
  397. expect( abortSpy.called ).to.be.false;
  398. expect( loadSpy.called ).to.be.false;
  399. } );
  400. it( 'image should be permanently removed if it is removed by user during upload', done => {
  401. const file = createNativeFileMock();
  402. const notification = editor.plugins.get( Notification );
  403. setModelData( model, '<paragraph>{}foo bar</paragraph>' );
  404. // Prevent popping up alert window.
  405. notification.on( 'show:warning', evt => {
  406. evt.stop();
  407. }, { priority: 'high' } );
  408. editor.execute( 'imageUpload', { file } );
  409. const stub = sinon.stub();
  410. model.document.on( 'change', stub );
  411. // The first `change` event is fired after the "manual" remove.
  412. // The second `change` event is fired after cleaning attributes.
  413. stub.onSecondCall().callsFake( () => {
  414. expect( getModelData( model ) ).to.equal( '<paragraph>[]foo bar</paragraph>' );
  415. editor.execute( 'undo' );
  416. // Expect that the image has not been brought back.
  417. expect( getModelData( model ) ).to.equal( '<paragraph>[]foo bar</paragraph>' );
  418. done();
  419. } );
  420. const image = doc.getRoot().getChild( 0 );
  421. model.change( writer => {
  422. writer.remove( image );
  423. } );
  424. } );
  425. it( 'should create responsive image if server return multiple images', done => {
  426. const file = createNativeFileMock();
  427. setModelData( model, '<paragraph>{}foo bar</paragraph>' );
  428. editor.execute( 'imageUpload', { file } );
  429. model.document.once( 'change', () => {
  430. model.document.once( 'change', () => {
  431. tryExpect( done, () => {
  432. expect( getViewData( view ) ).to.equal(
  433. '[<figure class="ck-widget image" contenteditable="false">' +
  434. '<img sizes="100vw" src="image.png" srcset="image-500.png 500w, image-800.png 800w" width="800"></img>' +
  435. '</figure>]<p>foo bar</p>'
  436. );
  437. expect( loader.status ).to.equal( 'idle' );
  438. } );
  439. }, { priority: 'lowest' } );
  440. loader.file.then( () => adapterMocks[ 0 ].mockSuccess( { default: 'image.png', 500: 'image-500.png', 800: 'image-800.png' } ) );
  441. } );
  442. loader.file.then( () => nativeReaderMock.mockSuccess( base64Sample ) );
  443. } );
  444. it( 'should prevent from browser redirecting when an image is dropped on another image', () => {
  445. const spy = testUtils.sinon.spy();
  446. editor.editing.view.document.fire( 'dragover', {
  447. preventDefault: spy
  448. } );
  449. expect( spy.calledOnce ).to.equal( true );
  450. } );
  451. it( 'should upload image with base64 src', done => {
  452. editor.plugins.get( 'Clipboard' ).on( 'inputTransformation', () => {
  453. const id = adapterMocks[ 0 ].loader.id;
  454. const expected = '<paragraph>bar</paragraph>' +
  455. `[<image src="" uploadId="${ id }" uploadStatus="reading"></image>]` +
  456. '<paragraph>foo</paragraph>';
  457. expectModel( done, getModelData( model ), expected );
  458. }, { priority: 'low' } );
  459. setModelData( model, '<paragraph>[]foo</paragraph>' );
  460. const clipboardHtml = `<p>bar</p><img src=${ base64Sample } />`;
  461. const dataTransfer = mockDataTransfer( clipboardHtml );
  462. const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 1 ), model.createPositionAt( doc.getRoot(), 1 ) );
  463. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  464. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  465. } );
  466. it( 'should upload image with blob src', done => {
  467. editor.plugins.get( 'Clipboard' ).on( 'inputTransformation', () => {
  468. const id = adapterMocks[ 0 ].loader.id;
  469. const expected = `[<image src="" uploadId="${ id }" uploadStatus="reading"></image>]` +
  470. '<paragraph>foo</paragraph>';
  471. expectModel( done, getModelData( model ), expected );
  472. }, { priority: 'low' } );
  473. setModelData( model, '<paragraph>[]foo</paragraph>' );
  474. const clipboardHtml = `<img src=${ base64ToBlobUrl( base64Sample ) } />`;
  475. const dataTransfer = mockDataTransfer( clipboardHtml );
  476. const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 1 ), model.createPositionAt( doc.getRoot(), 1 ) );
  477. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  478. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  479. } );
  480. it( 'should not upload image if no loader available', done => {
  481. editor.plugins.get( 'Clipboard' ).on( 'inputTransformation', () => {
  482. const expected = `[<image src="${ base64Sample }"></image>]<paragraph>foo</paragraph>`;
  483. expectModel( done, getModelData( model ), expected );
  484. }, { priority: 'low' } );
  485. testUtils.sinon.stub( fileRepository, 'createLoader' ).callsFake( () => null );
  486. setModelData( model, '<paragraph>[]foo</paragraph>' );
  487. const clipboardHtml = `<img src=${ base64Sample } />`;
  488. const dataTransfer = mockDataTransfer( clipboardHtml );
  489. const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 1 ), model.createPositionAt( doc.getRoot(), 1 ) );
  490. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  491. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  492. } );
  493. it( 'should not upload and remove image if fetch failed', done => {
  494. const notification = editor.plugins.get( Notification );
  495. // Prevent popping up alert window.
  496. notification.on( 'show:warning', evt => {
  497. evt.stop();
  498. }, { priority: 'high' } );
  499. expectData(
  500. '<img src="" uploadId="#loader1_id" uploadProcessed="true"></img>',
  501. '[<image src="" uploadId="#loader1_id" uploadStatus="reading"></image>]<paragraph>foo</paragraph>',
  502. '<paragraph>[]foo</paragraph>',
  503. done,
  504. false
  505. );
  506. setModelData( model, '<paragraph>[]foo</paragraph>' );
  507. const clipboardHtml = `<img src=${ base64Sample } />`;
  508. const dataTransfer = mockDataTransfer( clipboardHtml );
  509. const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 1 ), model.createPositionAt( doc.getRoot(), 1 ) );
  510. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  511. // Stub `fetch` so it can be rejected.
  512. testUtils.sinon.stub( window, 'fetch' ).callsFake( () => {
  513. return new Promise( ( res, rej ) => rej() );
  514. } );
  515. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  516. } );
  517. it( 'should upload only images which were successfully fetched and remove failed ones', done => {
  518. const notification = editor.plugins.get( Notification );
  519. // Prevent popping up alert window.
  520. notification.on( 'show:warning', evt => {
  521. evt.stop();
  522. }, { priority: 'high' } );
  523. const expectedModel = '<paragraph>bar</paragraph>' +
  524. '<image src="" uploadId="#loader1_id" uploadStatus="reading"></image>' +
  525. '<image src="" uploadId="#loader2_id" uploadStatus="reading"></image>' +
  526. '[<image src="" uploadId="#loader3_id" uploadStatus="reading"></image>]' +
  527. '<paragraph>foo</paragraph>';
  528. const expectedFinalModel = '<paragraph>bar</paragraph>' +
  529. '<image src="" uploadId="#loader1_id" uploadStatus="reading"></image>' +
  530. '[<image src="" uploadId="#loader2_id" uploadStatus="reading"></image>]' +
  531. '<paragraph>foo</paragraph>';
  532. expectData(
  533. '',
  534. expectedModel,
  535. expectedFinalModel,
  536. done
  537. );
  538. setModelData( model, '<paragraph>[]foo</paragraph>' );
  539. const clipboardHtml = `<p>bar</p><img src=${ base64Sample } />` +
  540. `<img src=${ base64ToBlobUrl( base64Sample ) } /><img src=${ base64Sample } />`;
  541. const dataTransfer = mockDataTransfer( clipboardHtml );
  542. const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 1 ), model.createPositionAt( doc.getRoot(), 1 ) );
  543. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  544. // Stub `fetch` in a way that 2 first calls are successful and 3rd fails.
  545. let counter = 0;
  546. const fetch = window.fetch;
  547. testUtils.sinon.stub( window, 'fetch' ).callsFake( src => {
  548. counter++;
  549. if ( counter < 3 ) {
  550. return fetch( src );
  551. } else {
  552. return Promise.reject();
  553. }
  554. } );
  555. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  556. } );
  557. it( 'should not upload and remove image when `File` constructor is not present', done => {
  558. const fileFn = window.File;
  559. window.File = undefined;
  560. const notification = editor.plugins.get( Notification );
  561. // Prevent popping up alert window.
  562. notification.on( 'show:warning', evt => {
  563. evt.stop();
  564. }, { priority: 'high' } );
  565. expectData(
  566. '<img src="" uploadId="#loader1_id" uploadProcessed="true"></img><p>baz</p>',
  567. '<image src="" uploadId="#loader1_id" uploadStatus="reading"></image><paragraph>baz[]foo</paragraph>',
  568. '<paragraph>baz[]foo</paragraph>',
  569. err => {
  570. window.File = fileFn;
  571. done( err );
  572. },
  573. false
  574. );
  575. setModelData( model, '<paragraph>[]foo</paragraph>' );
  576. const clipboardHtml = `<img src=${ base64ToBlobUrl( base64Sample ) } /><p>baz</p>`;
  577. const dataTransfer = mockDataTransfer( clipboardHtml );
  578. const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 1 ), model.createPositionAt( doc.getRoot(), 1 ) );
  579. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  580. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  581. } );
  582. it( 'should not upload and remove image when `File` constructor is not supported', done => {
  583. if ( isEdgeEnv ) {
  584. // Since on Edge `File` is already stubbed, restore it to it native form so that exception will be thrown.
  585. testUtils.sinon.restore();
  586. // Since all stubs were restored, re-stub `scrollToTheSelection`.
  587. testUtils.sinon.stub( editor.editing.view, 'scrollToTheSelection' ).callsFake( () => {} );
  588. } else {
  589. testUtils.sinon.stub( window, 'File' ).throws( 'Function expected.' );
  590. }
  591. const notification = editor.plugins.get( Notification );
  592. // Prevent popping up alert window.
  593. notification.on( 'show:warning', evt => {
  594. evt.stop();
  595. }, { priority: 'high' } );
  596. expectData(
  597. '<p>baz</p><img src="" uploadId="#loader1_id" uploadProcessed="true"></img>',
  598. '<paragraph>baz</paragraph>[<image src="" uploadId="#loader1_id" uploadStatus="reading"></image>]<paragraph>foo</paragraph>',
  599. '<paragraph>baz[]</paragraph><paragraph>foo</paragraph>',
  600. done,
  601. false
  602. );
  603. setModelData( model, '<paragraph>[]foo</paragraph>' );
  604. const clipboardHtml = `<p>baz</p><img src=${ base64ToBlobUrl( base64Sample ) } />`;
  605. const dataTransfer = mockDataTransfer( clipboardHtml );
  606. const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 1 ), model.createPositionAt( doc.getRoot(), 1 ) );
  607. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  608. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  609. } );
  610. // Skip this test on Edge as we mock `File` object there so there is no sense in testing it.
  611. ( isEdgeEnv ? it.skip : it )( 'should get file extension from base64 string', done => {
  612. editor.plugins.get( 'Clipboard' ).on( 'inputTransformation', () => {
  613. tryExpect( done, () => {
  614. loader.file.then( file => expect( file.name.split( '.' ).pop() ).to.equal( 'png' ) );
  615. } );
  616. }, { priority: 'low' } );
  617. setModelData( model, '<paragraph>[]foo</paragraph>' );
  618. const clipboardHtml = `<img src=${ base64Sample } />`;
  619. const dataTransfer = mockDataTransfer( clipboardHtml );
  620. const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 1 ), model.createPositionAt( doc.getRoot(), 1 ) );
  621. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  622. // Stub `fetch` to return custom blob without type.
  623. testUtils.sinon.stub( window, 'fetch' ).callsFake( () => {
  624. return new Promise( res => res( {
  625. blob() {
  626. return new Promise( res => res( new Blob( [ 'foo', 'bar' ] ) ) );
  627. }
  628. } ) );
  629. } );
  630. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  631. } );
  632. // Skip this test on Edge as we mock `File` object there so there is no sense in testing it.
  633. ( isEdgeEnv ? it.skip : it )( 'should use fallback file extension', done => {
  634. editor.plugins.get( 'Clipboard' ).on( 'inputTransformation', () => {
  635. tryExpect( done, () => {
  636. loader.file.then( file => expect( file.name.split( '.' ).pop() ).to.equal( 'jpeg' ) );
  637. } );
  638. }, { priority: 'low' } );
  639. setModelData( model, '<paragraph>[]foo</paragraph>' );
  640. const clipboardHtml = `<img src=${ base64ToBlobUrl( base64Sample ) } />`;
  641. const dataTransfer = mockDataTransfer( clipboardHtml );
  642. const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 1 ), model.createPositionAt( doc.getRoot(), 1 ) );
  643. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  644. // Stub `fetch` to return custom blob without type.
  645. testUtils.sinon.stub( window, 'fetch' ).callsFake( () => {
  646. return new Promise( res => res( {
  647. blob() {
  648. return new Promise( res => res( new Blob( [ 'foo', 'bar' ] ) ) );
  649. }
  650. } ) );
  651. } );
  652. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  653. } );
  654. it( 'should not show notification when file loader failed with no error', done => {
  655. const notification = editor.plugins.get( Notification );
  656. let notificationsCount = 0;
  657. // Prevent popping up alert window.
  658. notification.on( 'show:warning', evt => {
  659. notificationsCount++;
  660. evt.stop();
  661. }, { priority: 'high' } );
  662. // Check data after paste.
  663. editor.plugins.get( 'Clipboard' ).on( 'inputTransformation', () => {
  664. adapterMocks[ 0 ].loader.file.then( () => {
  665. expect.fail( 'Promise should be rejected.' );
  666. } ).catch( () => {
  667. // Deffer so the promise could be resolved.
  668. setTimeout( () => {
  669. expect( notificationsCount ).to.equal( 0 );
  670. done();
  671. } );
  672. } );
  673. }, { priority: 'low' } );
  674. setModelData( model, '<paragraph>[]foo</paragraph>' );
  675. const clipboardHtml = `<img src=${ base64Sample } />`;
  676. const dataTransfer = mockDataTransfer( clipboardHtml );
  677. const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 1 ), model.createPositionAt( doc.getRoot(), 1 ) );
  678. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  679. // Stub `fetch` in a way that it always fails.
  680. testUtils.sinon.stub( window, 'fetch' ).callsFake( () => Promise.reject() );
  681. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  682. } );
  683. // Helper for validating clipboard and model data as a result of a paste operation. This function checks both clipboard
  684. // data and model data synchronously (`expectedClipboardData`, `expectedModel`) and then the model data after `loader.file`
  685. // promise is resolved (so model state after successful/failed file fetch attempt).
  686. //
  687. // @param {String} expectedClipboardData Expected clipboard data on `inputTransformation` event.
  688. // @param {String} expectedModel Expected model data on `inputTransformation` event.
  689. // @param {String} expectedModelOnFile Expected model data after all `file.loader` promises are fetched.
  690. // @param {Function} doneFn Callback function to be called when all assertions are done or error occures.
  691. // @param {Boolean} [onSuccess=true] If `expectedModelOnFile` data should be validated
  692. // on `loader.file` a promise successful resolution or promise rejection.
  693. function expectData( expectedClipboardData, expectedModel, expectedModelOnFile, doneFn, onSuccess ) {
  694. // Check data after paste.
  695. editor.plugins.get( 'Clipboard' ).on( 'inputTransformation', ( evt, data ) => {
  696. const clipboardData = injectLoaderId( expectedClipboardData || '', adapterMocks );
  697. const modelData = injectLoaderId( expectedModel, adapterMocks );
  698. const finalModelData = injectLoaderId( expectedModelOnFile, adapterMocks );
  699. if ( clipboardData.length ) {
  700. expect( stringifyView( data.content ) ).to.equal( clipboardData );
  701. }
  702. expect( getModelData( model ) ).to.equal( modelData );
  703. if ( onSuccess !== false ) {
  704. adapterMocks[ 0 ].loader.file.then( () => {
  705. // Deffer so the promise could be resolved.
  706. setTimeout( () => {
  707. expectModel( doneFn, getModelData( model ), finalModelData );
  708. } );
  709. } );
  710. } else {
  711. adapterMocks[ 0 ].loader.file.then( () => {
  712. expect.fail( 'The `loader.file` should be rejected.' );
  713. } ).catch( () => {
  714. // Deffer so the promise could be resolved.
  715. setTimeout( () => {
  716. expectModel( doneFn, getModelData( model ), finalModelData );
  717. } );
  718. } );
  719. }
  720. }, { priority: 'low' } );
  721. }
  722. } );
  723. // Replaces '#loaderX_id' parameter in the given string with a loader id. It is used
  724. // so data string could be created before loader is initialized.
  725. //
  726. // @param {String} data String which have 'loader params' replaced.
  727. // @param {Array.<UploadAdapterMock>} adapters Adapters list. Each adapter holds a reference to a loader which id is used.
  728. // @returns {String} Data string with 'loader params' replaced.
  729. function injectLoaderId( data, adapters ) {
  730. let newData = data;
  731. if ( newData.includes( '#loader1_id' ) ) {
  732. newData = newData.replace( '#loader1_id', adapters[ 0 ].loader.id );
  733. }
  734. if ( newData.includes( '#loader2_id' ) ) {
  735. newData = newData.replace( '#loader2_id', adapters[ 1 ].loader.id );
  736. }
  737. if ( newData.includes( '#loader3_id' ) ) {
  738. newData = newData.replace( '#loader3_id', adapters[ 2 ].loader.id );
  739. }
  740. return newData;
  741. }
  742. // Asserts actual and expected model data.
  743. //
  744. // @param {function} done Callback function to be called when assertion is done.
  745. // @param {String} actual Actual model data.
  746. // @param {String} expected Expected model data.
  747. function expectModel( done, actual, expected ) {
  748. tryExpect( done, () => {
  749. expect( actual ).to.equal( expected );
  750. } );
  751. }
  752. // Runs given expect function in a try-catch. It should be used only when `expect` is called as a result of a `Promise`
  753. // resolution as all errors may be caught by tested code and needs to be rethrow to be correctly processed by a testing framework.
  754. //
  755. // @param {Function} doneFn Function to run when assertion is done.
  756. // @param {Function} expectFn Function containing all assertions.
  757. function tryExpect( doneFn, expectFn ) {
  758. try {
  759. expectFn();
  760. doneFn();
  761. } catch ( err ) {
  762. doneFn( err );
  763. }
  764. }
  765. // Creates data transfer object with predefined data.
  766. //
  767. // @param {String} content The content returned as `text/html` when queried.
  768. // @returns {module:clipboard/datatransfer~DataTransfer} DataTransfer object.
  769. function mockDataTransfer( content ) {
  770. return new DataTransfer( {
  771. types: [ 'text/html' ],
  772. getData: type => type === 'text/html' ? content : ''
  773. } );
  774. }
  775. // Creates blob url from the given base64 data.
  776. //
  777. // @param {String} base64 The base64 string from which blob url will be generated.
  778. // @returns {String} Blob url.
  779. function base64ToBlobUrl( base64 ) {
  780. return URL.createObjectURL( base64ToBlob( base64.trim() ) );
  781. }
  782. // Transforms base64 data into a blob object.
  783. //
  784. // @param {String} The base64 data to be transformed.
  785. // @returns {Blob} Blob object representing given base64 data.
  786. function base64ToBlob( base64Data ) {
  787. const [ type, data ] = base64Data.split( ',' );
  788. const byteCharacters = atob( data );
  789. const byteArrays = [];
  790. for ( let offset = 0; offset < byteCharacters.length; offset += 512 ) {
  791. const slice = byteCharacters.slice( offset, offset + 512 );
  792. const byteNumbers = new Array( slice.length );
  793. for ( let i = 0; i < slice.length; i++ ) {
  794. byteNumbers[ i ] = slice.charCodeAt( i );
  795. }
  796. byteArrays.push( new Uint8Array( byteNumbers ) );
  797. }
  798. return new Blob( byteArrays, { type } );
  799. }