imageuploadediting.js 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856
  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 } 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. let adapterMocks = [];
  27. let editor, model, view, doc, fileRepository, viewDocument, nativeReaderMock, loader;
  28. testUtils.createSinonSandbox();
  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 ( env.isEdge ) {
  42. testUtils.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. testUtils.sinon.stub( env, 'isEdge' ).get( () => false );
  48. testUtils.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. testUtils.sinon.stub( view, 'scrollToTheSelection' ).callsFake( () => {} );
  64. } );
  65. } );
  66. afterEach( () => {
  67. adapterMocks = [];
  68. return editor.destroy();
  69. } );
  70. it( 'should register proper schema rules', () => {
  71. expect( model.schema.checkAttribute( [ '$root', 'image' ], 'uploadId' ) ).to.be.true;
  72. } );
  73. it( 'should register imageUpload command', () => {
  74. expect( editor.commands.get( 'imageUpload' ) ).to.be.instanceOf( ImageUploadCommand );
  75. } );
  76. it( 'should insert image when is pasted', () => {
  77. const fileMock = createNativeFileMock();
  78. const dataTransfer = new DataTransfer( { files: [ fileMock ], types: [ 'Files' ] } );
  79. setModelData( model, '<paragraph>[]foo</paragraph>' );
  80. const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 1 ), model.createPositionAt( doc.getRoot(), 1 ) );
  81. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  82. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  83. const id = fileRepository.getLoader( fileMock ).id;
  84. expect( getModelData( model ) ).to.equal(
  85. `<paragraph>foo</paragraph>[<image uploadId="${ id }" uploadStatus="reading"></image>]`
  86. );
  87. } );
  88. it( 'should insert image at optimized position when is pasted', () => {
  89. const fileMock = createNativeFileMock();
  90. const dataTransfer = new DataTransfer( { files: [ fileMock ], types: [ 'Files' ] } );
  91. setModelData( model, '<paragraph>[]foo</paragraph>' );
  92. const paragraph = doc.getRoot().getChild( 0 );
  93. const targetRange = model.createRange( model.createPositionAt( paragraph, 1 ), model.createPositionAt( paragraph, 1 ) ); // f[]oo
  94. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  95. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  96. const id = fileRepository.getLoader( fileMock ).id;
  97. expect( getModelData( model ) ).to.equal(
  98. `[<image uploadId="${ id }" uploadStatus="reading"></image>]<paragraph>foo</paragraph>`
  99. );
  100. } );
  101. it( 'should insert multiple image files when are pasted', () => {
  102. const files = [ createNativeFileMock(), createNativeFileMock() ];
  103. const dataTransfer = new DataTransfer( { files, types: [ 'Files' ] } );
  104. setModelData( model, '<paragraph>[]foo</paragraph>' );
  105. const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 1 ), model.createPositionAt( doc.getRoot(), 1 ) );
  106. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  107. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  108. const id1 = fileRepository.getLoader( files[ 0 ] ).id;
  109. const id2 = fileRepository.getLoader( files[ 1 ] ).id;
  110. expect( getModelData( model ) ).to.equal(
  111. '<paragraph>foo</paragraph>' +
  112. `<image uploadId="${ id1 }" uploadStatus="reading"></image>` +
  113. `[<image uploadId="${ id2 }" uploadStatus="reading"></image>]`
  114. );
  115. } );
  116. it( 'should insert image when is pasted on allowed position when ImageUploadCommand is disabled', () => {
  117. setModelData( model, '<paragraph>foo</paragraph>[<image></image>]' );
  118. const fileMock = createNativeFileMock();
  119. const dataTransfer = new DataTransfer( { files: [ fileMock ], types: [ 'Files' ] } );
  120. const command = editor.commands.get( 'imageUpload' );
  121. expect( command.isEnabled ).to.be.false;
  122. const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 0 ), model.createPositionAt( doc.getRoot(), 0 ) );
  123. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  124. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  125. const id = fileRepository.getLoader( fileMock ).id;
  126. expect( getModelData( model ) ).to.equal(
  127. `[<image uploadId="${ id }" uploadStatus="reading"></image>]<paragraph>foo</paragraph><image></image>`
  128. );
  129. } );
  130. it( 'should not insert image when editor is in read-only mode', () => {
  131. // Clipboard plugin is required for this test.
  132. return VirtualTestEditor
  133. .create( {
  134. plugins: [ ImageEditing, ImageUploadEditing, Paragraph, UploadAdapterPluginMock, Clipboard ]
  135. } )
  136. .then( editor => {
  137. const fileMock = createNativeFileMock();
  138. const dataTransfer = new DataTransfer( { files: [ fileMock ], types: [ 'Files' ] } );
  139. setModelData( editor.model, '<paragraph>[]foo</paragraph>' );
  140. const targetRange = editor.model.document.selection.getFirstRange();
  141. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  142. editor.isReadOnly = true;
  143. editor.editing.view.document.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  144. expect( getModelData( editor.model ) ).to.equal( '<paragraph>[]foo</paragraph>' );
  145. return editor.destroy();
  146. } );
  147. } );
  148. it( 'should not insert image when file is not an image', () => {
  149. const viewDocument = editor.editing.view.document;
  150. const fileMock = {
  151. type: 'media/mp3',
  152. size: 1024
  153. };
  154. const dataTransfer = new DataTransfer( {
  155. files: [ fileMock ],
  156. types: [ 'Files' ],
  157. getData: () => ''
  158. } );
  159. setModelData( model, '<paragraph>foo[]</paragraph>' );
  160. const targetRange = doc.selection.getFirstRange();
  161. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  162. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  163. expect( getModelData( model ) ).to.equal( '<paragraph>foo[]</paragraph>' );
  164. } );
  165. it( 'should not insert image when there is non-empty HTML content pasted', () => {
  166. const fileMock = createNativeFileMock();
  167. const dataTransfer = new DataTransfer( {
  168. files: [ fileMock ],
  169. types: [ 'Files', 'text/html' ],
  170. getData: type => type === 'text/html' ? '<p>SomeData</p>' : ''
  171. } );
  172. setModelData( model, '<paragraph>[]foo</paragraph>' );
  173. const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 1 ), model.createPositionAt( doc.getRoot(), 1 ) );
  174. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  175. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  176. expect( getModelData( model ) ).to.equal( '<paragraph>SomeData[]foo</paragraph>' );
  177. } );
  178. it( 'should not insert image nor crash when pasted image could not be inserted', () => {
  179. model.schema.register( 'other', {
  180. allowIn: '$root',
  181. isLimit: true
  182. } );
  183. model.schema.extend( '$text', { allowIn: 'other' } );
  184. editor.conversion.elementToElement( { model: 'other', view: 'p' } );
  185. setModelData( model, '<other>[]</other>' );
  186. const fileMock = createNativeFileMock();
  187. const dataTransfer = new DataTransfer( { files: [ fileMock ], types: [ 'Files' ] } );
  188. const targetRange = doc.selection.getFirstRange();
  189. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  190. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  191. expect( getModelData( model ) ).to.equal( '<other>[]</other>' );
  192. } );
  193. it( 'should not throw when upload adapter is not set (FileRepository will log an error anyway) when image is pasted', () => {
  194. const fileMock = createNativeFileMock();
  195. const dataTransfer = new DataTransfer( { files: [ fileMock ], types: [ 'Files' ] } );
  196. const logStub = testUtils.sinon.stub( log, 'error' );
  197. setModelData( model, '<paragraph>[]foo</paragraph>' );
  198. fileRepository.createUploadAdapter = undefined;
  199. const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 1 ), model.createPositionAt( doc.getRoot(), 1 ) );
  200. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  201. expect( () => {
  202. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  203. } ).to.not.throw();
  204. expect( getModelData( model ) ).to.equal( '<paragraph>foo[]</paragraph>' );
  205. sinon.assert.calledOnce( logStub );
  206. } );
  207. // https://github.com/ckeditor/ckeditor5-upload/issues/70
  208. it( 'should not crash on browsers which do not implement DOMStringList as a child class of an Array', () => {
  209. const typesDomStringListMock = {
  210. length: 2,
  211. '0': 'text/html',
  212. '1': 'text/plain'
  213. };
  214. const dataTransfer = new DataTransfer( {
  215. types: typesDomStringListMock,
  216. getData: type => type === 'text/html' ? '<p>SomeData</p>' : 'SomeData'
  217. } );
  218. setModelData( model, '<paragraph>[]foo</paragraph>' );
  219. const targetRange = doc.selection.getFirstRange();
  220. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  221. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  222. // Well, there's no clipboard plugin, so nothing happens.
  223. expect( getModelData( model ) ).to.equal( '<paragraph>SomeData[]foo</paragraph>' );
  224. } );
  225. it( 'should not convert image\'s uploadId attribute if is consumed already', () => {
  226. editor.editing.downcastDispatcher.on( 'attribute:uploadId:image', ( evt, data, conversionApi ) => {
  227. conversionApi.consumable.consume( data.item, evt.name );
  228. }, { priority: 'high' } );
  229. setModelData( model, '<image uploadId="1234"></image>' );
  230. expect( getViewData( view ) ).to.equal(
  231. '[<figure class="ck-widget image" contenteditable="false">' +
  232. '<img></img>' +
  233. '</figure>]' );
  234. } );
  235. it( 'should use read data once it is present', done => {
  236. const file = createNativeFileMock();
  237. setModelData( model, '<paragraph>{}foo bar</paragraph>' );
  238. editor.execute( 'imageUpload', { files: file } );
  239. model.once( '_change', () => {
  240. expect( getViewData( view ) ).to.equal(
  241. '[<figure class="ck-widget image" contenteditable="false">' +
  242. `<img src="${ base64Sample }"></img>` +
  243. '</figure>]' +
  244. '<p>foo bar</p>' );
  245. expect( loader.status ).to.equal( 'uploading' );
  246. done();
  247. } );
  248. expect( loader.status ).to.equal( 'reading' );
  249. nativeReaderMock.mockSuccess( base64Sample );
  250. } );
  251. it( 'should replace read data with server response once it is present', done => {
  252. const file = createNativeFileMock();
  253. setModelData( model, '<paragraph>{}foo bar</paragraph>' );
  254. editor.execute( 'imageUpload', { files: file } );
  255. model.document.once( 'change', () => {
  256. model.document.once( 'change', () => {
  257. expect( getViewData( view ) ).to.equal(
  258. '[<figure class="ck-widget image" contenteditable="false"><img src="image.png"></img></figure>]<p>foo bar</p>'
  259. );
  260. expect( loader.status ).to.equal( 'idle' );
  261. done();
  262. }, { priority: 'lowest' } );
  263. adapterMocks[ 0 ].mockSuccess( { default: 'image.png' } );
  264. } );
  265. nativeReaderMock.mockSuccess( base64Sample );
  266. } );
  267. it( 'should fire notification event in case of error', done => {
  268. const notification = editor.plugins.get( Notification );
  269. const file = createNativeFileMock();
  270. notification.on( 'show:warning', ( evt, data ) => {
  271. expect( data.message ).to.equal( 'Reading error.' );
  272. expect( data.title ).to.equal( 'Upload failed' );
  273. evt.stop();
  274. done();
  275. }, { priority: 'high' } );
  276. setModelData( model, '<paragraph>{}foo bar</paragraph>' );
  277. editor.execute( 'imageUpload', { files: file } );
  278. nativeReaderMock.mockError( 'Reading error.' );
  279. } );
  280. it( 'should not fire notification on abort', done => {
  281. const notification = editor.plugins.get( Notification );
  282. const file = createNativeFileMock();
  283. const spy = testUtils.sinon.spy();
  284. notification.on( 'show:warning', evt => {
  285. spy();
  286. evt.stop();
  287. }, { priority: 'high' } );
  288. setModelData( model, '<paragraph>{}foo bar</paragraph>' );
  289. editor.execute( 'imageUpload', { files: file } );
  290. nativeReaderMock.abort();
  291. setTimeout( () => {
  292. sinon.assert.notCalled( spy );
  293. done();
  294. }, 0 );
  295. } );
  296. it( 'should throw when other error happens during upload', done => {
  297. const file = createNativeFileMock();
  298. const error = new Error( 'Foo bar baz' );
  299. const uploadEditing = editor.plugins.get( ImageUploadEditing );
  300. const loadSpy = sinon.spy( uploadEditing, '_readAndUpload' );
  301. const catchSpy = sinon.spy();
  302. // Throw an error when async attribute change occur.
  303. editor.editing.downcastDispatcher.on( 'attribute:uploadStatus:image', ( evt, data ) => {
  304. if ( data.attributeNewValue == 'uploading' ) {
  305. throw error;
  306. }
  307. } );
  308. setModelData( model, '<paragraph>{}foo bar</paragraph>' );
  309. editor.execute( 'imageUpload', { files: file } );
  310. sinon.assert.calledOnce( loadSpy );
  311. const promise = loadSpy.returnValues[ 0 ];
  312. // Check if error can be caught.
  313. promise.catch( catchSpy );
  314. nativeReaderMock.mockSuccess();
  315. setTimeout( () => {
  316. sinon.assert.calledOnce( catchSpy );
  317. sinon.assert.calledWithExactly( catchSpy, error );
  318. done();
  319. }, 0 );
  320. } );
  321. it( 'should do nothing if image does not have uploadId', () => {
  322. setModelData( model, '<image src="image.png"></image>' );
  323. expect( getViewData( view ) ).to.equal(
  324. '[<figure class="ck-widget image" contenteditable="false"><img src="image.png"></img></figure>]'
  325. );
  326. } );
  327. it( 'should remove image in case of upload error', done => {
  328. const file = createNativeFileMock();
  329. const spy = testUtils.sinon.spy();
  330. const notification = editor.plugins.get( Notification );
  331. setModelData( model, '<paragraph>{}foo bar</paragraph>' );
  332. notification.on( 'show:warning', evt => {
  333. spy();
  334. evt.stop();
  335. }, { priority: 'high' } );
  336. editor.execute( 'imageUpload', { files: file } );
  337. model.document.once( 'change', () => {
  338. model.document.once( 'change', () => {
  339. expect( getModelData( model ) ).to.equal( '<paragraph>[]foo bar</paragraph>' );
  340. sinon.assert.calledOnce( spy );
  341. done();
  342. } );
  343. } );
  344. nativeReaderMock.mockError( 'Upload error.' );
  345. } );
  346. it( 'should abort upload if image is removed', () => {
  347. const file = createNativeFileMock();
  348. setModelData( model, '<paragraph>{}foo bar</paragraph>' );
  349. editor.execute( 'imageUpload', { files: file } );
  350. const abortSpy = testUtils.sinon.spy( loader, 'abort' );
  351. expect( loader.status ).to.equal( 'reading' );
  352. nativeReaderMock.mockSuccess( base64Sample );
  353. const image = doc.getRoot().getChild( 0 );
  354. model.change( writer => {
  355. writer.remove( image );
  356. } );
  357. expect( loader.status ).to.equal( 'aborted' );
  358. sinon.assert.calledOnce( abortSpy );
  359. } );
  360. it( 'should not abort and not restart upload when image is moved', () => {
  361. const file = createNativeFileMock();
  362. setModelData( model, '<paragraph>{}foo bar</paragraph>' );
  363. editor.execute( 'imageUpload', { files: file } );
  364. const abortSpy = testUtils.sinon.spy( loader, 'abort' );
  365. const loadSpy = testUtils.sinon.spy( loader, 'read' );
  366. const image = doc.getRoot().getChild( 0 );
  367. model.change( writer => {
  368. writer.move( writer.createRangeOn( image ), writer.createPositionAt( doc.getRoot(), 2 ) );
  369. } );
  370. expect( abortSpy.called ).to.be.false;
  371. expect( loadSpy.called ).to.be.false;
  372. } );
  373. it( 'image should be permanently removed if it is removed by user during upload', done => {
  374. const file = createNativeFileMock();
  375. const notification = editor.plugins.get( Notification );
  376. setModelData( model, '<paragraph>{}foo bar</paragraph>' );
  377. // Prevent popping up alert window.
  378. notification.on( 'show:warning', evt => {
  379. evt.stop();
  380. }, { priority: 'high' } );
  381. editor.execute( 'imageUpload', { files: file } );
  382. model.document.once( 'change', () => {
  383. // This is called after "manual" remove.
  384. model.document.once( 'change', () => {
  385. // This is called after attributes are removed.
  386. let undone = false;
  387. model.document.once( 'change', () => {
  388. if ( !undone ) {
  389. undone = true;
  390. // This is called after abort remove.
  391. expect( getModelData( model ) ).to.equal( '<paragraph>[]foo bar</paragraph>' );
  392. editor.execute( 'undo' );
  393. // Expect that the image has not been brought back.
  394. expect( getModelData( model ) ).to.equal( '<paragraph>[]foo bar</paragraph>' );
  395. done();
  396. }
  397. } );
  398. } );
  399. } );
  400. const image = doc.getRoot().getChild( 0 );
  401. model.change( writer => {
  402. writer.remove( image );
  403. } );
  404. } );
  405. it( 'should create responsive image if server return multiple images', done => {
  406. const file = createNativeFileMock();
  407. setModelData( model, '<paragraph>{}foo bar</paragraph>' );
  408. editor.execute( 'imageUpload', { files: file } );
  409. model.document.once( 'change', () => {
  410. model.document.once( 'change', () => {
  411. expect( getViewData( view ) ).to.equal(
  412. '[<figure class="ck-widget image" contenteditable="false">' +
  413. '<img sizes="100vw" src="image.png" srcset="image-500.png 500w, image-800.png 800w" width="800"></img>' +
  414. '</figure>]<p>foo bar</p>'
  415. );
  416. expect( loader.status ).to.equal( 'idle' );
  417. done();
  418. }, { priority: 'lowest' } );
  419. adapterMocks[ 0 ].mockSuccess( { default: 'image.png', 500: 'image-500.png', 800: 'image-800.png' } );
  420. } );
  421. nativeReaderMock.mockSuccess( base64Sample );
  422. } );
  423. it( 'should prevent from browser redirecting when an image is dropped on another image', () => {
  424. const spy = testUtils.sinon.spy();
  425. editor.editing.view.document.fire( 'dragover', {
  426. preventDefault: spy
  427. } );
  428. expect( spy.calledOnce ).to.equal( true );
  429. } );
  430. it( 'should upload image with base64 src', done => {
  431. editor.plugins.get( 'Clipboard' ).on( 'inputTransformation', () => {
  432. const id = adapterMocks[ 0 ].loader.id;
  433. const expected = '<paragraph>bar</paragraph>' +
  434. `[<image src="" uploadId="${ id }" uploadStatus="reading"></image>]` +
  435. '<paragraph>foo</paragraph>';
  436. expectModel( done, getModelData( model ), expected );
  437. }, { priority: 'low' } );
  438. setModelData( model, '<paragraph>[]foo</paragraph>' );
  439. const clipboardHtml = `<p>bar</p><img src=${ base64Sample } />`;
  440. const dataTransfer = mockDataTransfer( clipboardHtml );
  441. const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 1 ), model.createPositionAt( doc.getRoot(), 1 ) );
  442. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  443. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  444. } );
  445. it( 'should upload image with blob src', done => {
  446. editor.plugins.get( 'Clipboard' ).on( 'inputTransformation', () => {
  447. const id = adapterMocks[ 0 ].loader.id;
  448. const expected = `[<image src="" uploadId="${ id }" uploadStatus="reading"></image>]` +
  449. '<paragraph>foo</paragraph>';
  450. expectModel( done, getModelData( model ), expected );
  451. }, { priority: 'low' } );
  452. setModelData( model, '<paragraph>[]foo</paragraph>' );
  453. const clipboardHtml = `<img src=${ base64ToBlobUrl( base64Sample ) } />`;
  454. const dataTransfer = mockDataTransfer( clipboardHtml );
  455. const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 1 ), model.createPositionAt( doc.getRoot(), 1 ) );
  456. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  457. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  458. } );
  459. it( 'should not upload image if no loader available', done => {
  460. editor.plugins.get( 'Clipboard' ).on( 'inputTransformation', () => {
  461. const expected = `[<image src="${ base64Sample }"></image>]<paragraph>foo</paragraph>`;
  462. expectModel( done, getModelData( model ), expected );
  463. }, { priority: 'low' } );
  464. testUtils.sinon.stub( fileRepository, 'createLoader' ).callsFake( () => null );
  465. setModelData( model, '<paragraph>[]foo</paragraph>' );
  466. const clipboardHtml = `<img src=${ base64Sample } />`;
  467. const dataTransfer = mockDataTransfer( clipboardHtml );
  468. const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 1 ), model.createPositionAt( doc.getRoot(), 1 ) );
  469. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  470. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  471. } );
  472. it( 'should not upload and remove image if fetch failed', done => {
  473. editor.plugins.get( 'Clipboard' ).on( 'inputTransformation', () => {
  474. const expected = '<paragraph>[]foo</paragraph>';
  475. expectModel( done, getModelData( model ), expected );
  476. }, { priority: 'low' } );
  477. setModelData( model, '<paragraph>[]foo</paragraph>' );
  478. const clipboardHtml = `<img src=${ base64Sample } />`;
  479. const dataTransfer = mockDataTransfer( clipboardHtml );
  480. const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 1 ), model.createPositionAt( doc.getRoot(), 1 ) );
  481. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  482. // Stub `fetch` so it can be rejected.
  483. testUtils.sinon.stub( window, 'fetch' ).callsFake( () => {
  484. return new Promise( ( res, rej ) => rej() );
  485. } );
  486. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  487. } );
  488. it( 'should upload only images which were successfully fetched and remove failed ones', done => {
  489. editor.plugins.get( 'Clipboard' ).on( 'inputTransformation', () => {
  490. const expected = '<paragraph>bar</paragraph>' +
  491. `<image src="" uploadId="${ adapterMocks[ 0 ].loader.id }" uploadStatus="reading"></image>` +
  492. `[<image src="" uploadId="${ adapterMocks[ 1 ].loader.id }" uploadStatus="reading"></image>]` +
  493. '<paragraph>foo</paragraph>';
  494. expectModel( done, getModelData( model ), expected );
  495. }, { priority: 'low' } );
  496. setModelData( model, '<paragraph>[]foo</paragraph>' );
  497. const clipboardHtml = `<p>bar</p><img src=${ base64Sample } />` +
  498. `<img src=${ base64ToBlobUrl( base64Sample ) } /><img src=${ base64Sample } />`;
  499. const dataTransfer = mockDataTransfer( clipboardHtml );
  500. const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 1 ), model.createPositionAt( doc.getRoot(), 1 ) );
  501. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  502. // Stub `fetch` in a way that 2 first calls are successful and 3rd fails.
  503. let counter = 0;
  504. const fetch = window.fetch;
  505. testUtils.sinon.stub( window, 'fetch' ).callsFake( src => {
  506. counter++;
  507. if ( counter < 3 ) {
  508. return fetch( src );
  509. } else {
  510. return new Promise( ( res, rej ) => rej() );
  511. }
  512. } );
  513. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  514. } );
  515. it( 'should not upload and remove image when `File` constructor is not present', done => {
  516. const fileFn = window.File;
  517. window.File = undefined;
  518. editor.plugins.get( 'Clipboard' ).on( 'inputTransformation', () => {
  519. window.File = fileFn;
  520. const expected = '<paragraph>baz[]foo</paragraph>';
  521. expectModel( done, getModelData( model ), expected );
  522. }, { priority: 'low' } );
  523. setModelData( model, '<paragraph>[]foo</paragraph>' );
  524. const clipboardHtml = `<img src=${ base64ToBlobUrl( base64Sample ) } /><p>baz</p>`;
  525. const dataTransfer = mockDataTransfer( clipboardHtml );
  526. const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 1 ), model.createPositionAt( doc.getRoot(), 1 ) );
  527. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  528. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  529. } );
  530. it( 'should not upload and remove image when `File` constructor is not supported', done => {
  531. const fileFn = window.File;
  532. window.File = function() {
  533. throw new Error( 'Function expected.' ); // Simulating Edge browser behaviour here.
  534. };
  535. editor.plugins.get( 'Clipboard' ).on( 'inputTransformation', () => {
  536. window.File = fileFn;
  537. const expected = '<paragraph>baz[]foo</paragraph>';
  538. expectModel( done, getModelData( model ), expected );
  539. }, { priority: 'low' } );
  540. setModelData( model, '<paragraph>[]foo</paragraph>' );
  541. const clipboardHtml = `<p>baz</p><img src=${ base64ToBlobUrl( base64Sample ) } />`;
  542. const dataTransfer = mockDataTransfer( clipboardHtml );
  543. const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 1 ), model.createPositionAt( doc.getRoot(), 1 ) );
  544. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  545. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  546. } );
  547. it( 'should get file extension from base64 string', done => {
  548. editor.plugins.get( 'Clipboard' ).on( 'inputTransformation', () => {
  549. try {
  550. expect( loader.file.name.split( '.' ).pop() ).to.equal( 'png' );
  551. done();
  552. } catch ( err ) {
  553. done( err );
  554. }
  555. }, { priority: 'low' } );
  556. setModelData( model, '<paragraph>[]foo</paragraph>' );
  557. const clipboardHtml = `<img src=${ base64Sample } />`;
  558. const dataTransfer = mockDataTransfer( clipboardHtml );
  559. const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 1 ), model.createPositionAt( doc.getRoot(), 1 ) );
  560. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  561. // Stub `fetch` to return custom blob without type.
  562. testUtils.sinon.stub( window, 'fetch' ).callsFake( () => {
  563. return new Promise( res => res( {
  564. blob() {
  565. return new Promise( res => res( new Blob( [ 'foo', 'bar' ] ) ) );
  566. }
  567. } ) );
  568. } );
  569. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  570. } );
  571. it( 'should use fallback file extension', done => {
  572. editor.plugins.get( 'Clipboard' ).on( 'inputTransformation', () => {
  573. try {
  574. expect( loader.file.name.split( '.' ).pop() ).to.equal( 'jpeg' );
  575. done();
  576. } catch ( err ) {
  577. done( err );
  578. }
  579. }, { priority: 'low' } );
  580. setModelData( model, '<paragraph>[]foo</paragraph>' );
  581. const clipboardHtml = `<img src=${ base64ToBlobUrl( base64Sample ) } />`;
  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. // Stub `fetch` to return custom blob without type.
  586. testUtils.sinon.stub( window, 'fetch' ).callsFake( () => {
  587. return new Promise( res => res( {
  588. blob() {
  589. return new Promise( res => res( new Blob( [ 'foo', 'bar' ] ) ) );
  590. }
  591. } ) );
  592. } );
  593. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  594. } );
  595. } );
  596. // Asserts actual and expected model data.
  597. // Note: Since this function is run inside a promise, all errors needs to be caught
  598. // and rethrow to be correctly processed by a testing framework.
  599. //
  600. // @param {function} done Callback function to be called when assertion is done.
  601. // @param {String} actual Actual model data.
  602. // @param {String} expected Expected model data.
  603. function expectModel( done, actual, expected ) {
  604. try {
  605. expect( actual ).to.equal( expected );
  606. done();
  607. } catch ( err ) {
  608. done( err );
  609. }
  610. }
  611. // Creates data transfer object with predefined data.
  612. //
  613. // @param {String} content The content returned as `text/html` when queried.
  614. // @returns {module:clipboard/datatransfer~DataTransfer} DataTransfer object.
  615. function mockDataTransfer( content ) {
  616. return new DataTransfer( {
  617. types: [ 'text/html' ],
  618. getData: type => type === 'text/html' ? content : ''
  619. } );
  620. }
  621. // Creates blob url from the given base64 data.
  622. //
  623. // @param {String} base64 The base64 string from which blob url will be generated.
  624. // @returns {String} Blob url.
  625. function base64ToBlobUrl( base64 ) {
  626. return URL.createObjectURL( base64ToBlob( base64.trim() ) );
  627. }
  628. // Transforms base64 data into a blob object.
  629. //
  630. // @param {String} The base64 data to be transformed.
  631. // @returns {Blob} Blob object representing given base64 data.
  632. function base64ToBlob( base64Data ) {
  633. const [ type, data ] = base64Data.split( ',' );
  634. const byteCharacters = atob( data );
  635. const byteArrays = [];
  636. for ( let offset = 0; offset < byteCharacters.length; offset += 512 ) {
  637. const slice = byteCharacters.slice( offset, offset + 512 );
  638. const byteNumbers = new Array( slice.length );
  639. for ( let i = 0; i < slice.length; i++ ) {
  640. byteNumbers[ i ] = slice.charCodeAt( i );
  641. }
  642. byteArrays.push( new Uint8Array( byteNumbers ) );
  643. }
  644. return new Blob( byteArrays, { type } );
  645. }