imageuploadediting.js 31 KB

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