imageuploadediting.js 35 KB

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