imageuploadediting.js 38 KB

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