8
0

imageuploadediting.js 39 KB

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