8
0

imageuploadediting.js 37 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029
  1. /**
  2. * @license Copyright (c) 2003-2019, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. /* globals window, setTimeout, atob, URL, Blob */
  6. import VirtualTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/virtualtesteditor';
  7. import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
  8. import Clipboard from '@ckeditor/ckeditor5-clipboard/src/clipboard';
  9. import ImageEditing from '../../src/image/imageediting';
  10. import ImageUploadEditing from '../../src/imageupload/imageuploadediting';
  11. import ImageUploadCommand from '../../src/imageupload/imageuploadcommand';
  12. import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph';
  13. import UndoEditing from '@ckeditor/ckeditor5-undo/src/undoediting';
  14. import DataTransfer from '@ckeditor/ckeditor5-clipboard/src/datatransfer';
  15. import FileRepository from '@ckeditor/ckeditor5-upload/src/filerepository';
  16. import { UploadAdapterMock, createNativeFileMock, NativeFileReaderMock } from '@ckeditor/ckeditor5-upload/tests/_utils/mocks';
  17. import { setData as setModelData, getData as getModelData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model';
  18. import { getData as getViewData, stringify as stringifyView } from '@ckeditor/ckeditor5-engine/src/dev-utils/view';
  19. import log from '@ckeditor/ckeditor5-utils/src/log';
  20. import env from '@ckeditor/ckeditor5-utils/src/env';
  21. import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils';
  22. import Notification from '@ckeditor/ckeditor5-ui/src/notification/notification';
  23. describe( 'ImageUploadEditing', () => {
  24. // eslint-disable-next-line max-len
  25. const base64Sample = 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+A8AAQUBAScY42YAAAAASUVORK5CYII=';
  26. const isEdgeEnv = env.isEdge;
  27. let adapterMocks = [];
  28. let editor, model, view, doc, fileRepository, viewDocument, nativeReaderMock, loader;
  29. testUtils.createSinonSandbox();
  30. class UploadAdapterPluginMock extends Plugin {
  31. init() {
  32. fileRepository = this.editor.plugins.get( FileRepository );
  33. fileRepository.createUploadAdapter = newLoader => {
  34. loader = newLoader;
  35. const adapterMock = new UploadAdapterMock( loader );
  36. adapterMocks.push( adapterMock );
  37. return adapterMock;
  38. };
  39. }
  40. }
  41. beforeEach( () => {
  42. if ( isEdgeEnv ) {
  43. testUtils.sinon.stub( window, 'File' ).callsFake( () => {
  44. return { name: 'file.jpg' };
  45. } );
  46. }
  47. // Most tests assume non-edge environment but we do not set `contenteditable=false` on Edge so stub `env.isEdge`.
  48. testUtils.sinon.stub( env, 'isEdge' ).get( () => false );
  49. testUtils.sinon.stub( window, 'FileReader' ).callsFake( () => {
  50. nativeReaderMock = new NativeFileReaderMock();
  51. return nativeReaderMock;
  52. } );
  53. return VirtualTestEditor
  54. .create( {
  55. plugins: [ ImageEditing, ImageUploadEditing, Paragraph, UndoEditing, UploadAdapterPluginMock, Clipboard ]
  56. } )
  57. .then( newEditor => {
  58. editor = newEditor;
  59. model = editor.model;
  60. doc = model.document;
  61. view = editor.editing.view;
  62. viewDocument = view.document;
  63. // Stub `view.scrollToTheSelection` as it will fail on VirtualTestEditor without DOM.
  64. testUtils.sinon.stub( view, 'scrollToTheSelection' ).callsFake( () => {} );
  65. } );
  66. } );
  67. afterEach( () => {
  68. adapterMocks = [];
  69. return editor.destroy();
  70. } );
  71. it( 'should register proper schema rules', () => {
  72. expect( model.schema.checkAttribute( [ '$root', 'image' ], 'uploadId' ) ).to.be.true;
  73. } );
  74. it( 'should register imageUpload command', () => {
  75. expect( editor.commands.get( 'imageUpload' ) ).to.be.instanceOf( ImageUploadCommand );
  76. } );
  77. it( 'should 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. tryExpect( done, () => {
  257. expect( getViewData( view ) ).to.equal(
  258. '[<figure class="ck-widget image" contenteditable="false">' +
  259. `<img src="${ base64Sample }"></img>` +
  260. '</figure>]' +
  261. '<p>foo bar</p>' );
  262. expect( loader.status ).to.equal( 'uploading' );
  263. } );
  264. } );
  265. expect( loader.status ).to.equal( 'reading' );
  266. loader.file.then( () => nativeReaderMock.mockSuccess( base64Sample ) );
  267. } );
  268. it( 'should replace read data with server response once it is present', done => {
  269. const file = createNativeFileMock();
  270. setModelData( model, '<paragraph>{}foo bar</paragraph>' );
  271. editor.execute( 'imageUpload', { file } );
  272. model.document.once( 'change', () => {
  273. model.document.once( 'change', () => {
  274. tryExpect( done, () => {
  275. expect( getViewData( view ) ).to.equal(
  276. '[<figure class="ck-widget image" contenteditable="false"><img src="image.png"></img></figure>]<p>foo bar</p>'
  277. );
  278. expect( loader.status ).to.equal( 'idle' );
  279. } );
  280. }, { priority: 'lowest' } );
  281. loader.file.then( () => adapterMocks[ 0 ].mockSuccess( { default: 'image.png' } ) );
  282. } );
  283. loader.file.then( () => nativeReaderMock.mockSuccess( base64Sample ) );
  284. } );
  285. it( 'should fire notification event in case of error', done => {
  286. const notification = editor.plugins.get( Notification );
  287. const file = createNativeFileMock();
  288. notification.on( 'show:warning', ( evt, data ) => {
  289. tryExpect( done, () => {
  290. expect( data.message ).to.equal( 'Reading error.' );
  291. expect( data.title ).to.equal( 'Upload failed' );
  292. evt.stop();
  293. } );
  294. }, { priority: 'high' } );
  295. setModelData( model, '<paragraph>{}foo bar</paragraph>' );
  296. editor.execute( 'imageUpload', { file } );
  297. loader.file.then( () => nativeReaderMock.mockError( 'Reading error.' ) );
  298. } );
  299. it( 'should not fire notification on abort', done => {
  300. const notification = editor.plugins.get( Notification );
  301. const file = createNativeFileMock();
  302. const spy = testUtils.sinon.spy();
  303. notification.on( 'show:warning', evt => {
  304. spy();
  305. evt.stop();
  306. }, { priority: 'high' } );
  307. setModelData( model, '<paragraph>{}foo bar</paragraph>' );
  308. editor.execute( 'imageUpload', { file } );
  309. loader.file.then( () => {
  310. nativeReaderMock.abort();
  311. setTimeout( () => {
  312. sinon.assert.notCalled( spy );
  313. done();
  314. }, 0 );
  315. } );
  316. } );
  317. it( 'should throw when other error happens during upload', done => {
  318. const file = createNativeFileMock();
  319. const error = new Error( 'Foo bar baz' );
  320. const uploadEditing = editor.plugins.get( ImageUploadEditing );
  321. const loadSpy = sinon.spy( uploadEditing, '_readAndUpload' );
  322. const catchSpy = sinon.spy();
  323. // Throw an error when async attribute change occur.
  324. editor.editing.downcastDispatcher.on( 'attribute:uploadStatus:image', ( evt, data ) => {
  325. if ( data.attributeNewValue == 'uploading' ) {
  326. throw error;
  327. }
  328. } );
  329. setModelData( model, '<paragraph>{}foo bar</paragraph>' );
  330. editor.execute( 'imageUpload', { file } );
  331. sinon.assert.calledOnce( loadSpy );
  332. const promise = loadSpy.returnValues[ 0 ];
  333. // Check if error can be caught.
  334. promise.catch( catchSpy );
  335. loader.file.then( () => {
  336. nativeReaderMock.mockSuccess();
  337. setTimeout( () => {
  338. sinon.assert.calledOnce( catchSpy );
  339. sinon.assert.calledWithExactly( catchSpy, error );
  340. done();
  341. }, 0 );
  342. } );
  343. } );
  344. it( 'should do nothing if image does not have uploadId', () => {
  345. setModelData( model, '<image src="image.png"></image>' );
  346. expect( getViewData( view ) ).to.equal(
  347. '[<figure class="ck-widget image" contenteditable="false"><img src="image.png"></img></figure>]'
  348. );
  349. } );
  350. it( 'should remove image in case of upload error', done => {
  351. const file = createNativeFileMock();
  352. const spy = testUtils.sinon.spy();
  353. const notification = editor.plugins.get( Notification );
  354. setModelData( model, '<paragraph>{}foo bar</paragraph>' );
  355. notification.on( 'show:warning', evt => {
  356. spy();
  357. evt.stop();
  358. }, { priority: 'high' } );
  359. editor.execute( 'imageUpload', { file } );
  360. model.document.once( 'change', () => {
  361. model.document.once( 'change', () => {
  362. tryExpect( done, () => {
  363. expect( getModelData( model ) ).to.equal( '<paragraph>[]foo bar</paragraph>' );
  364. sinon.assert.calledOnce( spy );
  365. } );
  366. } );
  367. } );
  368. loader.file.then( () => nativeReaderMock.mockError( 'Upload error.' ) );
  369. } );
  370. it( 'should abort upload if image is removed', () => {
  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. expect( loader.status ).to.equal( 'reading' );
  376. return loader.file.then( () => {
  377. nativeReaderMock.mockSuccess( base64Sample );
  378. const image = doc.getRoot().getChild( 0 );
  379. model.change( writer => {
  380. writer.remove( image );
  381. } );
  382. expect( loader.status ).to.equal( 'aborted' );
  383. sinon.assert.calledOnce( abortSpy );
  384. } );
  385. } );
  386. it( 'should not abort and not restart upload when image is moved', () => {
  387. const file = createNativeFileMock();
  388. setModelData( model, '<paragraph>{}foo bar</paragraph>' );
  389. editor.execute( 'imageUpload', { file } );
  390. const abortSpy = testUtils.sinon.spy( loader, 'abort' );
  391. const loadSpy = testUtils.sinon.spy( loader, 'read' );
  392. const image = doc.getRoot().getChild( 0 );
  393. model.change( writer => {
  394. writer.move( writer.createRangeOn( image ), writer.createPositionAt( doc.getRoot(), 2 ) );
  395. } );
  396. expect( abortSpy.called ).to.be.false;
  397. expect( loadSpy.called ).to.be.false;
  398. } );
  399. it( 'image should be permanently removed if it is removed by user during upload', done => {
  400. const file = createNativeFileMock();
  401. const notification = editor.plugins.get( Notification );
  402. setModelData( model, '<paragraph>{}foo bar</paragraph>' );
  403. // Prevent popping up alert window.
  404. notification.on( 'show:warning', evt => {
  405. evt.stop();
  406. }, { priority: 'high' } );
  407. editor.execute( 'imageUpload', { file } );
  408. const stub = sinon.stub();
  409. model.document.on( 'change', stub );
  410. // The first `change` event is fired after the "manual" remove.
  411. // The second `change` event is fired after cleaning attributes.
  412. stub.onSecondCall().callsFake( () => {
  413. expect( getModelData( model ) ).to.equal( '<paragraph>[]foo bar</paragraph>' );
  414. editor.execute( 'undo' );
  415. // Expect that the image has not been brought back.
  416. expect( getModelData( model ) ).to.equal( '<paragraph>[]foo bar</paragraph>' );
  417. done();
  418. } );
  419. const image = doc.getRoot().getChild( 0 );
  420. model.change( writer => {
  421. writer.remove( image );
  422. } );
  423. } );
  424. it( 'should create responsive image if server return multiple images', done => {
  425. const file = createNativeFileMock();
  426. setModelData( model, '<paragraph>{}foo bar</paragraph>' );
  427. editor.execute( 'imageUpload', { file } );
  428. model.document.once( 'change', () => {
  429. model.document.once( 'change', () => {
  430. tryExpect( done, () => {
  431. expect( getViewData( view ) ).to.equal(
  432. '[<figure class="ck-widget image" contenteditable="false">' +
  433. '<img sizes="100vw" src="image.png" srcset="image-500.png 500w, image-800.png 800w" width="800"></img>' +
  434. '</figure>]<p>foo bar</p>'
  435. );
  436. expect( loader.status ).to.equal( 'idle' );
  437. } );
  438. }, { priority: 'lowest' } );
  439. loader.file.then( () => adapterMocks[ 0 ].mockSuccess( { default: 'image.png', 500: 'image-500.png', 800: 'image-800.png' } ) );
  440. } );
  441. loader.file.then( () => nativeReaderMock.mockSuccess( base64Sample ) );
  442. } );
  443. it( 'should prevent from browser redirecting when an image is dropped on another image', () => {
  444. const spy = testUtils.sinon.spy();
  445. editor.editing.view.document.fire( 'dragover', {
  446. preventDefault: spy
  447. } );
  448. expect( spy.calledOnce ).to.equal( true );
  449. } );
  450. it( 'should upload image with base64 src', done => {
  451. editor.plugins.get( 'Clipboard' ).on( 'inputTransformation', () => {
  452. const id = adapterMocks[ 0 ].loader.id;
  453. const expected = '<paragraph>bar</paragraph>' +
  454. `[<image src="" uploadId="${ id }" uploadStatus="reading"></image>]` +
  455. '<paragraph>foo</paragraph>';
  456. expectModel( done, getModelData( model ), expected );
  457. }, { priority: 'low' } );
  458. setModelData( model, '<paragraph>[]foo</paragraph>' );
  459. const clipboardHtml = `<p>bar</p><img src=${ base64Sample } />`;
  460. const dataTransfer = mockDataTransfer( clipboardHtml );
  461. const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 1 ), model.createPositionAt( doc.getRoot(), 1 ) );
  462. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  463. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  464. } );
  465. it( 'should upload image with blob src', done => {
  466. editor.plugins.get( 'Clipboard' ).on( 'inputTransformation', () => {
  467. const id = adapterMocks[ 0 ].loader.id;
  468. const expected = `[<image src="" uploadId="${ id }" uploadStatus="reading"></image>]` +
  469. '<paragraph>foo</paragraph>';
  470. expectModel( done, getModelData( model ), expected );
  471. }, { priority: 'low' } );
  472. setModelData( model, '<paragraph>[]foo</paragraph>' );
  473. const clipboardHtml = `<img src=${ base64ToBlobUrl( base64Sample ) } />`;
  474. const dataTransfer = mockDataTransfer( clipboardHtml );
  475. const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 1 ), model.createPositionAt( doc.getRoot(), 1 ) );
  476. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  477. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  478. } );
  479. it( 'should not upload image if no loader available', done => {
  480. editor.plugins.get( 'Clipboard' ).on( 'inputTransformation', () => {
  481. const expected = `[<image src="${ base64Sample }"></image>]<paragraph>foo</paragraph>`;
  482. expectModel( done, getModelData( model ), expected );
  483. }, { priority: 'low' } );
  484. testUtils.sinon.stub( fileRepository, 'createLoader' ).callsFake( () => null );
  485. setModelData( model, '<paragraph>[]foo</paragraph>' );
  486. const clipboardHtml = `<img src=${ base64Sample } />`;
  487. const dataTransfer = mockDataTransfer( clipboardHtml );
  488. const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 1 ), model.createPositionAt( doc.getRoot(), 1 ) );
  489. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  490. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  491. } );
  492. it( 'should not upload and remove image if fetch failed', done => {
  493. const notification = editor.plugins.get( Notification );
  494. // Prevent popping up alert window.
  495. notification.on( 'show:warning', evt => {
  496. evt.stop();
  497. }, { priority: 'high' } );
  498. expectData(
  499. '<img src="" uploadId="#loader1_id" uploadProcessed="true"></img>',
  500. '[<image src="" uploadId="#loader1_id" uploadStatus="reading"></image>]<paragraph>foo</paragraph>',
  501. '<paragraph>[]foo</paragraph>',
  502. done,
  503. false
  504. );
  505. setModelData( model, '<paragraph>[]foo</paragraph>' );
  506. const clipboardHtml = `<img src=${ base64Sample } />`;
  507. const dataTransfer = mockDataTransfer( clipboardHtml );
  508. const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 1 ), model.createPositionAt( doc.getRoot(), 1 ) );
  509. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  510. // Stub `fetch` so it can be rejected.
  511. testUtils.sinon.stub( window, 'fetch' ).callsFake( () => {
  512. return new Promise( ( res, rej ) => rej() );
  513. } );
  514. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  515. } );
  516. it( 'should upload only images which were successfully fetched and remove failed ones', done => {
  517. const notification = editor.plugins.get( Notification );
  518. // Prevent popping up alert window.
  519. notification.on( 'show:warning', evt => {
  520. evt.stop();
  521. }, { priority: 'high' } );
  522. const expectedModel = '<paragraph>bar</paragraph>' +
  523. '<image src="" uploadId="#loader1_id" uploadStatus="reading"></image>' +
  524. '<image src="" uploadId="#loader2_id" uploadStatus="reading"></image>' +
  525. '[<image src="" uploadId="#loader3_id" uploadStatus="reading"></image>]' +
  526. '<paragraph>foo</paragraph>';
  527. const expectedFinalModel = '<paragraph>bar</paragraph>' +
  528. '<image src="" uploadId="#loader1_id" uploadStatus="reading"></image>' +
  529. '[<image src="" uploadId="#loader2_id" uploadStatus="reading"></image>]' +
  530. '<paragraph>foo</paragraph>';
  531. expectData(
  532. '',
  533. expectedModel,
  534. expectedFinalModel,
  535. done
  536. );
  537. setModelData( model, '<paragraph>[]foo</paragraph>' );
  538. const clipboardHtml = `<p>bar</p><img src=${ base64Sample } />` +
  539. `<img src=${ base64ToBlobUrl( base64Sample ) } /><img src=${ base64Sample } />`;
  540. const dataTransfer = mockDataTransfer( clipboardHtml );
  541. const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 1 ), model.createPositionAt( doc.getRoot(), 1 ) );
  542. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  543. // Stub `fetch` in a way that 2 first calls are successful and 3rd fails.
  544. let counter = 0;
  545. const fetch = window.fetch;
  546. testUtils.sinon.stub( window, 'fetch' ).callsFake( src => {
  547. counter++;
  548. if ( counter < 3 ) {
  549. return fetch( src );
  550. } else {
  551. return Promise.reject();
  552. }
  553. } );
  554. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  555. } );
  556. it( 'should not upload and remove image when `File` constructor is not present', done => {
  557. const fileFn = window.File;
  558. window.File = undefined;
  559. const notification = editor.plugins.get( Notification );
  560. // Prevent popping up alert window.
  561. notification.on( 'show:warning', evt => {
  562. evt.stop();
  563. }, { priority: 'high' } );
  564. expectData(
  565. '<img src="" uploadId="#loader1_id" uploadProcessed="true"></img><p>baz</p>',
  566. '<image src="" uploadId="#loader1_id" uploadStatus="reading"></image><paragraph>baz[]foo</paragraph>',
  567. '<paragraph>baz[]foo</paragraph>',
  568. err => {
  569. window.File = fileFn;
  570. done( err );
  571. },
  572. false
  573. );
  574. setModelData( model, '<paragraph>[]foo</paragraph>' );
  575. const clipboardHtml = `<img src=${ base64ToBlobUrl( base64Sample ) } /><p>baz</p>`;
  576. const dataTransfer = mockDataTransfer( clipboardHtml );
  577. const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 1 ), model.createPositionAt( doc.getRoot(), 1 ) );
  578. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  579. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  580. } );
  581. it( 'should not upload and remove image when `File` constructor is not supported', done => {
  582. if ( isEdgeEnv ) {
  583. // Since on Edge `File` is already stubbed, restore it to it native form so that exception will be thrown.
  584. testUtils.sinon.restore();
  585. // Since all stubs were restored, re-stub `scrollToTheSelection`.
  586. testUtils.sinon.stub( editor.editing.view, 'scrollToTheSelection' ).callsFake( () => {} );
  587. } else {
  588. testUtils.sinon.stub( window, 'File' ).throws( 'Function expected.' );
  589. }
  590. const notification = editor.plugins.get( Notification );
  591. // Prevent popping up alert window.
  592. notification.on( 'show:warning', evt => {
  593. evt.stop();
  594. }, { priority: 'high' } );
  595. expectData(
  596. '<p>baz</p><img src="" uploadId="#loader1_id" uploadProcessed="true"></img>',
  597. '<paragraph>baz</paragraph>[<image src="" uploadId="#loader1_id" uploadStatus="reading"></image>]<paragraph>foo</paragraph>',
  598. '<paragraph>baz[]</paragraph><paragraph>foo</paragraph>',
  599. done,
  600. false
  601. );
  602. setModelData( model, '<paragraph>[]foo</paragraph>' );
  603. const clipboardHtml = `<p>baz</p><img src=${ base64ToBlobUrl( base64Sample ) } />`;
  604. const dataTransfer = mockDataTransfer( clipboardHtml );
  605. const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 1 ), model.createPositionAt( doc.getRoot(), 1 ) );
  606. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  607. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  608. } );
  609. // Skip this test on Edge as we mock `File` object there so there is no sense in testing it.
  610. ( isEdgeEnv ? it.skip : it )( 'should get file extension from base64 string', done => {
  611. editor.plugins.get( 'Clipboard' ).on( 'inputTransformation', () => {
  612. tryExpect( done, () => {
  613. loader.file.then( file => expect( file.name.split( '.' ).pop() ).to.equal( 'png' ) );
  614. } );
  615. }, { priority: 'low' } );
  616. setModelData( model, '<paragraph>[]foo</paragraph>' );
  617. const clipboardHtml = `<img src=${ base64Sample } />`;
  618. const dataTransfer = mockDataTransfer( clipboardHtml );
  619. const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 1 ), model.createPositionAt( doc.getRoot(), 1 ) );
  620. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  621. // Stub `fetch` to return custom blob without type.
  622. testUtils.sinon.stub( window, 'fetch' ).callsFake( () => {
  623. return new Promise( res => res( {
  624. blob() {
  625. return new Promise( res => res( new Blob( [ 'foo', 'bar' ] ) ) );
  626. }
  627. } ) );
  628. } );
  629. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  630. } );
  631. // Skip this test on Edge as we mock `File` object there so there is no sense in testing it.
  632. ( isEdgeEnv ? it.skip : it )( 'should use fallback file extension', done => {
  633. editor.plugins.get( 'Clipboard' ).on( 'inputTransformation', () => {
  634. tryExpect( done, () => {
  635. loader.file.then( file => expect( file.name.split( '.' ).pop() ).to.equal( 'jpeg' ) );
  636. } );
  637. }, { priority: 'low' } );
  638. setModelData( model, '<paragraph>[]foo</paragraph>' );
  639. const clipboardHtml = `<img src=${ base64ToBlobUrl( base64Sample ) } />`;
  640. const dataTransfer = mockDataTransfer( clipboardHtml );
  641. const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 1 ), model.createPositionAt( doc.getRoot(), 1 ) );
  642. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  643. // Stub `fetch` to return custom blob without type.
  644. testUtils.sinon.stub( window, 'fetch' ).callsFake( () => {
  645. return new Promise( res => res( {
  646. blob() {
  647. return new Promise( res => res( new Blob( [ 'foo', 'bar' ] ) ) );
  648. }
  649. } ) );
  650. } );
  651. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  652. } );
  653. it( 'should not show notification when file loader failed with no error', done => {
  654. const notification = editor.plugins.get( Notification );
  655. let notificationsCount = 0;
  656. // Prevent popping up alert window.
  657. notification.on( 'show:warning', evt => {
  658. notificationsCount++;
  659. evt.stop();
  660. }, { priority: 'high' } );
  661. // Check data after paste.
  662. editor.plugins.get( 'Clipboard' ).on( 'inputTransformation', () => {
  663. adapterMocks[ 0 ].loader.file.then( () => {
  664. expect.fail( 'Promise should be rejected.' );
  665. } ).catch( () => {
  666. // Deffer so the promise could be resolved.
  667. setTimeout( () => {
  668. expect( notificationsCount ).to.equal( 0 );
  669. done();
  670. } );
  671. } );
  672. }, { priority: 'low' } );
  673. setModelData( model, '<paragraph>[]foo</paragraph>' );
  674. const clipboardHtml = `<img src=${ base64Sample } />`;
  675. const dataTransfer = mockDataTransfer( clipboardHtml );
  676. const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 1 ), model.createPositionAt( doc.getRoot(), 1 ) );
  677. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  678. // Stub `fetch` in a way that it always fails.
  679. testUtils.sinon.stub( window, 'fetch' ).callsFake( () => Promise.reject() );
  680. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  681. } );
  682. // Helper for validating clipboard and model data as a result of a paste operation. This function checks both clipboard
  683. // data and model data synchronously (`expectedClipboardData`, `expectedModel`) and then the model data after `loader.file`
  684. // promise is resolved (so model state after successful/failed file fetch attempt).
  685. //
  686. // @param {String} expectedClipboardData Expected clipboard data on `inputTransformation` event.
  687. // @param {String} expectedModel Expected model data on `inputTransformation` event.
  688. // @param {String} expectedModelOnFile Expected model data after all `file.loader` promises are fetched.
  689. // @param {Function} doneFn Callback function to be called when all assertions are done or error occures.
  690. // @param {Boolean} [onSuccess=true] If `expectedModelOnFile` data should be validated
  691. // on `loader.file` a promise successful resolution or promise rejection.
  692. function expectData( expectedClipboardData, expectedModel, expectedModelOnFile, doneFn, onSuccess ) {
  693. // Check data after paste.
  694. editor.plugins.get( 'Clipboard' ).on( 'inputTransformation', ( evt, data ) => {
  695. const clipboardData = injectLoaderId( expectedClipboardData || '', adapterMocks );
  696. const modelData = injectLoaderId( expectedModel, adapterMocks );
  697. const finalModelData = injectLoaderId( expectedModelOnFile, adapterMocks );
  698. if ( clipboardData.length ) {
  699. expect( stringifyView( data.content ) ).to.equal( clipboardData );
  700. }
  701. expect( getModelData( model ) ).to.equal( modelData );
  702. if ( onSuccess !== false ) {
  703. adapterMocks[ 0 ].loader.file.then( () => {
  704. // Deffer so the promise could be resolved.
  705. setTimeout( () => {
  706. expectModel( doneFn, getModelData( model ), finalModelData );
  707. } );
  708. } );
  709. } else {
  710. adapterMocks[ 0 ].loader.file.then( () => {
  711. expect.fail( 'The `loader.file` should be rejected.' );
  712. } ).catch( () => {
  713. // Deffer so the promise could be resolved.
  714. setTimeout( () => {
  715. expectModel( doneFn, getModelData( model ), finalModelData );
  716. } );
  717. } );
  718. }
  719. }, { priority: 'low' } );
  720. }
  721. } );
  722. // Replaces '#loaderX_id' parameter in the given string with a loader id. It is used
  723. // so data string could be created before loader is initialized.
  724. //
  725. // @param {String} data String which have 'loader params' replaced.
  726. // @param {Array.<UploadAdapterMock>} adapters Adapters list. Each adapter holds a reference to a loader which id is used.
  727. // @returns {String} Data string with 'loader params' replaced.
  728. function injectLoaderId( data, adapters ) {
  729. let newData = data;
  730. if ( newData.includes( '#loader1_id' ) ) {
  731. newData = newData.replace( '#loader1_id', adapters[ 0 ].loader.id );
  732. }
  733. if ( newData.includes( '#loader2_id' ) ) {
  734. newData = newData.replace( '#loader2_id', adapters[ 1 ].loader.id );
  735. }
  736. if ( newData.includes( '#loader3_id' ) ) {
  737. newData = newData.replace( '#loader3_id', adapters[ 2 ].loader.id );
  738. }
  739. return newData;
  740. }
  741. // Asserts actual and expected model data.
  742. //
  743. // @param {function} done Callback function to be called when assertion is done.
  744. // @param {String} actual Actual model data.
  745. // @param {String} expected Expected model data.
  746. function expectModel( done, actual, expected ) {
  747. tryExpect( done, () => {
  748. expect( actual ).to.equal( expected );
  749. } );
  750. }
  751. // Runs given expect function in a try-catch. It should be used only when `expect` is called as a result of a `Promise`
  752. // resolution as all errors may be caught by tested code and needs to be rethrow to be correctly processed by a testing framework.
  753. //
  754. // @param {Function} doneFn Function to run when assertion is done.
  755. // @param {Function} expectFn Function containing all assertions.
  756. function tryExpect( doneFn, expectFn ) {
  757. try {
  758. expectFn();
  759. doneFn();
  760. } catch ( err ) {
  761. doneFn( err );
  762. }
  763. }
  764. // Creates data transfer object with predefined data.
  765. //
  766. // @param {String} content The content returned as `text/html` when queried.
  767. // @returns {module:clipboard/datatransfer~DataTransfer} DataTransfer object.
  768. function mockDataTransfer( content ) {
  769. return new DataTransfer( {
  770. types: [ 'text/html' ],
  771. getData: type => type === 'text/html' ? content : ''
  772. } );
  773. }
  774. // Creates blob url from the given base64 data.
  775. //
  776. // @param {String} base64 The base64 string from which blob url will be generated.
  777. // @returns {String} Blob url.
  778. function base64ToBlobUrl( base64 ) {
  779. return URL.createObjectURL( base64ToBlob( base64.trim() ) );
  780. }
  781. // Transforms base64 data into a blob object.
  782. //
  783. // @param {String} The base64 data to be transformed.
  784. // @returns {Blob} Blob object representing given base64 data.
  785. function base64ToBlob( base64Data ) {
  786. const [ type, data ] = base64Data.split( ',' );
  787. const byteCharacters = atob( data );
  788. const byteArrays = [];
  789. for ( let offset = 0; offset < byteCharacters.length; offset += 512 ) {
  790. const slice = byteCharacters.slice( offset, offset + 512 );
  791. const byteNumbers = new Array( slice.length );
  792. for ( let i = 0; i < slice.length; i++ ) {
  793. byteNumbers[ i ] = slice.charCodeAt( i );
  794. }
  795. byteArrays.push( new Uint8Array( byteNumbers ) );
  796. }
  797. return new Blob( byteArrays, { type } );
  798. }