imageuploadediting.js 38 KB

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