8
0

imageuploadediting.js 31 KB

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