imageuploadediting.js 31 KB

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