8
0

imageuploadediting.js 38 KB

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