8
0

imageuploadediting.js 38 KB

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