imageuploadediting.js 38 KB

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