imageuploadediting.js 38 KB

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