imageuploadediting.js 39 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065
  1. /**
  2. * @license Copyright (c) 2003-2019, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  4. */
  5. /* globals window, setTimeout, atob, URL, Blob, console */
  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 EventInfo from '@ckeditor/ckeditor5-utils/src/eventinfo';
  16. import FileRepository from '@ckeditor/ckeditor5-upload/src/filerepository';
  17. import { UploadAdapterMock, createNativeFileMock, NativeFileReaderMock } from '@ckeditor/ckeditor5-upload/tests/_utils/mocks';
  18. import { setData as setModelData, getData as getModelData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model';
  19. import { getData as getViewData, stringify as stringifyView } from '@ckeditor/ckeditor5-engine/src/dev-utils/view';
  20. import env from '@ckeditor/ckeditor5-utils/src/env';
  21. import Notification from '@ckeditor/ckeditor5-ui/src/notification/notification';
  22. describe( 'ImageUploadEditing', () => {
  23. // eslint-disable-next-line max-len
  24. const base64Sample = 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+A8AAQUBAScY42YAAAAASUVORK5CYII=';
  25. const isEdgeEnv = env.isEdge;
  26. let adapterMocks = [];
  27. let editor, model, view, doc, fileRepository, viewDocument, nativeReaderMock, loader;
  28. class UploadAdapterPluginMock extends Plugin {
  29. init() {
  30. fileRepository = this.editor.plugins.get( FileRepository );
  31. fileRepository.createUploadAdapter = newLoader => {
  32. loader = newLoader;
  33. const adapterMock = new UploadAdapterMock( loader );
  34. adapterMocks.push( adapterMock );
  35. return adapterMock;
  36. };
  37. }
  38. }
  39. beforeEach( () => {
  40. if ( isEdgeEnv ) {
  41. sinon.stub( window, 'File' ).callsFake( () => {
  42. return { name: 'file.jpg' };
  43. } );
  44. }
  45. // Most tests assume non-edge environment but we do not set `contenteditable=false` on Edge so stub `env.isEdge`.
  46. sinon.stub( env, 'isEdge' ).get( () => false );
  47. sinon.stub( window, 'FileReader' ).callsFake( () => {
  48. nativeReaderMock = new NativeFileReaderMock();
  49. return nativeReaderMock;
  50. } );
  51. return VirtualTestEditor
  52. .create( {
  53. plugins: [ ImageEditing, ImageUploadEditing, Paragraph, UndoEditing, UploadAdapterPluginMock, Clipboard ]
  54. } )
  55. .then( newEditor => {
  56. editor = newEditor;
  57. model = editor.model;
  58. doc = model.document;
  59. view = editor.editing.view;
  60. viewDocument = view.document;
  61. // Stub `view.scrollToTheSelection` as it will fail on VirtualTestEditor without DOM.
  62. sinon.stub( view, 'scrollToTheSelection' ).callsFake( () => {} );
  63. } );
  64. } );
  65. afterEach( () => {
  66. sinon.restore();
  67. adapterMocks = [];
  68. return editor.destroy();
  69. } );
  70. it( 'should register proper schema rules', () => {
  71. expect( model.schema.checkAttribute( [ '$root', 'image' ], 'uploadId' ) ).to.be.true;
  72. } );
  73. it( 'should register imageUpload command', () => {
  74. expect( editor.commands.get( 'imageUpload' ) ).to.be.instanceOf( ImageUploadCommand );
  75. } );
  76. it( 'should load Clipboard plugin', () => {
  77. return VirtualTestEditor
  78. .create( {
  79. plugins: [ ImageEditing, ImageUploadEditing, Paragraph, UndoEditing, UploadAdapterPluginMock ]
  80. } )
  81. .then( editor => {
  82. expect( editor.plugins.get( Clipboard ) ).to.be.instanceOf( Clipboard );
  83. } );
  84. } );
  85. it( 'should insert image when is pasted', () => {
  86. const fileMock = createNativeFileMock();
  87. const dataTransfer = new DataTransfer( { files: [ fileMock ], types: [ 'Files' ] } );
  88. setModelData( model, '<paragraph>[]foo</paragraph>' );
  89. const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 1 ), model.createPositionAt( doc.getRoot(), 1 ) );
  90. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  91. const eventInfo = new EventInfo( viewDocument, 'clipboardInput' );
  92. viewDocument.fire( eventInfo, { dataTransfer, targetRanges: [ targetViewRange ] } );
  93. const id = fileRepository.getLoader( fileMock ).id;
  94. expect( getModelData( model ) ).to.equal(
  95. `<paragraph>foo</paragraph>[<image uploadId="${ id }" uploadStatus="reading"></image>]`
  96. );
  97. expect( eventInfo.stop.called ).to.be.true;
  98. } );
  99. it( 'should insert image at optimized position when is pasted', () => {
  100. const fileMock = createNativeFileMock();
  101. const dataTransfer = new DataTransfer( { files: [ fileMock ], types: [ 'Files' ] } );
  102. setModelData( model, '<paragraph>[]foo</paragraph>' );
  103. const paragraph = doc.getRoot().getChild( 0 );
  104. const targetRange = model.createRange( model.createPositionAt( paragraph, 1 ), model.createPositionAt( paragraph, 1 ) ); // f[]oo
  105. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  106. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  107. const id = fileRepository.getLoader( fileMock ).id;
  108. expect( getModelData( model ) ).to.equal(
  109. `[<image uploadId="${ id }" uploadStatus="reading"></image>]<paragraph>foo</paragraph>`
  110. );
  111. } );
  112. it( 'should insert multiple image files when are pasted', () => {
  113. const files = [ createNativeFileMock(), createNativeFileMock() ];
  114. const dataTransfer = new DataTransfer( { files, types: [ 'Files' ] } );
  115. setModelData( model, '<paragraph>[]foo</paragraph>' );
  116. const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 1 ), model.createPositionAt( doc.getRoot(), 1 ) );
  117. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  118. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  119. const id1 = fileRepository.getLoader( files[ 0 ] ).id;
  120. const id2 = fileRepository.getLoader( files[ 1 ] ).id;
  121. expect( getModelData( model ) ).to.equal(
  122. '<paragraph>foo</paragraph>' +
  123. `<image uploadId="${ id1 }" uploadStatus="reading"></image>` +
  124. `[<image uploadId="${ id2 }" uploadStatus="reading"></image>]`
  125. );
  126. } );
  127. it( 'should insert image when is pasted on allowed position when ImageUploadCommand is disabled', () => {
  128. setModelData( model, '<paragraph>foo</paragraph>[<image></image>]' );
  129. const fileMock = createNativeFileMock();
  130. const dataTransfer = new DataTransfer( { files: [ fileMock ], types: [ 'Files' ] } );
  131. const command = editor.commands.get( 'imageUpload' );
  132. expect( command.isEnabled ).to.be.false;
  133. const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 0 ), model.createPositionAt( doc.getRoot(), 0 ) );
  134. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  135. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  136. const id = fileRepository.getLoader( fileMock ).id;
  137. expect( getModelData( model ) ).to.equal(
  138. `[<image uploadId="${ id }" uploadStatus="reading"></image>]<paragraph>foo</paragraph><image></image>`
  139. );
  140. } );
  141. it( 'should not insert image when editor is in read-only mode', () => {
  142. // Clipboard plugin is required for this test.
  143. return VirtualTestEditor
  144. .create( {
  145. plugins: [ ImageEditing, ImageUploadEditing, Paragraph, UploadAdapterPluginMock, Clipboard ]
  146. } )
  147. .then( editor => {
  148. const fileMock = createNativeFileMock();
  149. const dataTransfer = new DataTransfer( { files: [ fileMock ], types: [ 'Files' ] } );
  150. setModelData( editor.model, '<paragraph>[]foo</paragraph>' );
  151. const targetRange = editor.model.document.selection.getFirstRange();
  152. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  153. editor.isReadOnly = true;
  154. editor.editing.view.document.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  155. expect( getModelData( editor.model ) ).to.equal( '<paragraph>[]foo</paragraph>' );
  156. return editor.destroy();
  157. } );
  158. } );
  159. it( 'should not insert image when file is not an image', () => {
  160. const viewDocument = editor.editing.view.document;
  161. const fileMock = {
  162. type: 'media/mp3',
  163. size: 1024
  164. };
  165. const dataTransfer = new DataTransfer( {
  166. files: [ fileMock ],
  167. types: [ 'Files' ],
  168. getData: () => ''
  169. } );
  170. setModelData( model, '<paragraph>foo[]</paragraph>' );
  171. const targetRange = doc.selection.getFirstRange();
  172. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  173. const eventInfo = new EventInfo( viewDocument, 'clipboardInput' );
  174. viewDocument.fire( eventInfo, { dataTransfer, targetRanges: [ targetViewRange ] } );
  175. expect( getModelData( model ) ).to.equal( '<paragraph>foo[]</paragraph>' );
  176. expect( eventInfo.stop.called ).to.be.undefined;
  177. } );
  178. it( 'should not insert image when file is not an configured image type', () => {
  179. const viewDocument = editor.editing.view.document;
  180. const fileMock = {
  181. type: 'image/svg+xml',
  182. size: 1024
  183. };
  184. const dataTransfer = new DataTransfer( {
  185. files: [ fileMock ],
  186. types: [ 'Files' ],
  187. getData: () => ''
  188. } );
  189. setModelData( model, '<paragraph>foo[]</paragraph>' );
  190. const targetRange = doc.selection.getFirstRange();
  191. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  192. const eventInfo = new EventInfo( viewDocument, 'clipboardInput' );
  193. viewDocument.fire( eventInfo, { dataTransfer, targetRanges: [ targetViewRange ] } );
  194. expect( getModelData( model ) ).to.equal( '<paragraph>foo[]</paragraph>' );
  195. expect( eventInfo.stop.called ).to.be.undefined;
  196. } );
  197. it( 'should not insert image when file is null', () => {
  198. const viewDocument = editor.editing.view.document;
  199. const dataTransfer = new DataTransfer( { files: [ null ], types: [ 'Files' ], getData: () => null } );
  200. setModelData( model, '<paragraph>foo[]</paragraph>' );
  201. const targetRange = doc.selection.getFirstRange();
  202. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  203. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  204. expect( getModelData( model ) ).to.equal( '<paragraph>foo[]</paragraph>' );
  205. } );
  206. it( 'should not insert image when there is non-empty HTML content pasted', () => {
  207. const fileMock = createNativeFileMock();
  208. const dataTransfer = new DataTransfer( {
  209. files: [ fileMock ],
  210. types: [ 'Files', 'text/html' ],
  211. getData: type => type === 'text/html' ? '<p>SomeData</p>' : ''
  212. } );
  213. setModelData( model, '<paragraph>[]foo</paragraph>' );
  214. const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 1 ), model.createPositionAt( doc.getRoot(), 1 ) );
  215. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  216. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  217. expect( getModelData( model ) ).to.equal( '<paragraph>SomeData[]foo</paragraph>' );
  218. } );
  219. it( 'should not insert image nor crash when pasted image could not be inserted', () => {
  220. model.schema.register( 'other', {
  221. allowIn: '$root',
  222. isLimit: true
  223. } );
  224. model.schema.extend( '$text', { allowIn: 'other' } );
  225. editor.conversion.elementToElement( { model: 'other', view: 'p' } );
  226. setModelData( model, '<other>[]</other>' );
  227. const fileMock = createNativeFileMock();
  228. const dataTransfer = new DataTransfer( { files: [ fileMock ], types: [ 'Files' ] } );
  229. const targetRange = doc.selection.getFirstRange();
  230. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  231. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  232. expect( getModelData( model ) ).to.equal( '<other>[]</other>' );
  233. } );
  234. it( 'should not throw when upload adapter is not set (FileRepository will log an warn anyway) when image is pasted', () => {
  235. const fileMock = createNativeFileMock();
  236. const dataTransfer = new DataTransfer( { files: [ fileMock ], types: [ 'Files' ] } );
  237. const consoleWarnStub = sinon.stub( console, 'warn' );
  238. setModelData( model, '<paragraph>[]foo</paragraph>' );
  239. fileRepository.createUploadAdapter = undefined;
  240. const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 1 ), model.createPositionAt( doc.getRoot(), 1 ) );
  241. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  242. expect( () => {
  243. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  244. } ).to.not.throw();
  245. expect( getModelData( model ) ).to.equal( '<paragraph>foo[]</paragraph>' );
  246. sinon.assert.calledOnce( consoleWarnStub );
  247. } );
  248. // https://github.com/ckeditor/ckeditor5-upload/issues/70
  249. it( 'should not crash on browsers which do not implement DOMStringList as a child class of an Array', () => {
  250. const typesDomStringListMock = {
  251. length: 2,
  252. '0': 'text/html',
  253. '1': 'text/plain'
  254. };
  255. const dataTransfer = new DataTransfer( {
  256. types: typesDomStringListMock,
  257. getData: type => type === 'text/html' ? '<p>SomeData</p>' : 'SomeData'
  258. } );
  259. setModelData( model, '<paragraph>[]foo</paragraph>' );
  260. const targetRange = doc.selection.getFirstRange();
  261. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  262. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  263. // Well, there's no clipboard plugin, so nothing happens.
  264. expect( getModelData( model ) ).to.equal( '<paragraph>SomeData[]foo</paragraph>' );
  265. } );
  266. it( 'should not convert image\'s uploadId attribute if is consumed already', () => {
  267. editor.editing.downcastDispatcher.on( 'attribute:uploadId:image', ( evt, data, conversionApi ) => {
  268. conversionApi.consumable.consume( data.item, evt.name );
  269. }, { priority: 'high' } );
  270. setModelData( model, '<image uploadId="1234"></image>' );
  271. expect( getViewData( view ) ).to.equal(
  272. '[<figure class="ck-widget image" contenteditable="false">' +
  273. '<img></img>' +
  274. '</figure>]' );
  275. } );
  276. it( 'should not use read data once it is present', done => {
  277. const file = createNativeFileMock();
  278. setModelData( model, '<paragraph>{}foo bar</paragraph>' );
  279. editor.execute( 'imageUpload', { file } );
  280. model.document.once( 'change', () => {
  281. tryExpect( done, () => {
  282. expect( getViewData( view ) ).to.equal(
  283. '[<figure class="ck-widget image" contenteditable="false">' +
  284. // Rendering the image data is left to a upload progress converter.
  285. '<img></img>' +
  286. '</figure>]' +
  287. '<p>foo bar</p>'
  288. );
  289. expect( loader.status ).to.equal( 'uploading' );
  290. } );
  291. } );
  292. expect( loader.status ).to.equal( 'reading' );
  293. loader.file.then( () => nativeReaderMock.mockSuccess( base64Sample ) );
  294. } );
  295. it( 'should replace read data with server response once it is present', done => {
  296. const file = createNativeFileMock();
  297. setModelData( model, '<paragraph>{}foo bar</paragraph>' );
  298. editor.execute( 'imageUpload', { file } );
  299. model.document.once( 'change', () => {
  300. model.document.once( 'change', () => {
  301. tryExpect( done, () => {
  302. expect( getViewData( view ) ).to.equal(
  303. '[<figure class="ck-widget image" contenteditable="false"><img src="image.png"></img></figure>]<p>foo bar</p>'
  304. );
  305. expect( loader.status ).to.equal( 'idle' );
  306. } );
  307. }, { priority: 'lowest' } );
  308. loader.file.then( () => adapterMocks[ 0 ].mockSuccess( { default: 'image.png' } ) );
  309. } );
  310. loader.file.then( () => nativeReaderMock.mockSuccess( base64Sample ) );
  311. } );
  312. it( 'should fire notification event in case of error', done => {
  313. const notification = editor.plugins.get( Notification );
  314. const file = createNativeFileMock();
  315. notification.on( 'show:warning', ( evt, data ) => {
  316. tryExpect( done, () => {
  317. expect( data.message ).to.equal( 'Reading error.' );
  318. expect( data.title ).to.equal( 'Upload failed' );
  319. evt.stop();
  320. } );
  321. }, { priority: 'high' } );
  322. setModelData( model, '<paragraph>{}foo bar</paragraph>' );
  323. editor.execute( 'imageUpload', { file } );
  324. loader.file.then( () => nativeReaderMock.mockError( 'Reading error.' ) );
  325. } );
  326. it( 'should not fire notification on abort', done => {
  327. const notification = editor.plugins.get( Notification );
  328. const file = createNativeFileMock();
  329. const spy = sinon.spy();
  330. notification.on( 'show:warning', evt => {
  331. spy();
  332. evt.stop();
  333. }, { priority: 'high' } );
  334. setModelData( model, '<paragraph>{}foo bar</paragraph>' );
  335. editor.execute( 'imageUpload', { file } );
  336. loader.file.then( () => {
  337. nativeReaderMock.abort();
  338. setTimeout( () => {
  339. sinon.assert.notCalled( spy );
  340. done();
  341. }, 0 );
  342. } );
  343. } );
  344. it( 'should throw when other error happens during upload', done => {
  345. const file = createNativeFileMock();
  346. const error = new Error( 'Foo bar baz' );
  347. const uploadEditing = editor.plugins.get( ImageUploadEditing );
  348. const loadSpy = sinon.spy( uploadEditing, '_readAndUpload' );
  349. const catchSpy = sinon.spy();
  350. // Throw an error when async attribute change occur.
  351. editor.editing.downcastDispatcher.on( 'attribute:uploadStatus:image', ( evt, data ) => {
  352. if ( data.attributeNewValue == 'uploading' ) {
  353. throw error;
  354. }
  355. } );
  356. setModelData( model, '<paragraph>{}foo bar</paragraph>' );
  357. editor.execute( 'imageUpload', { file } );
  358. sinon.assert.calledOnce( loadSpy );
  359. const promise = loadSpy.returnValues[ 0 ];
  360. // Check if error can be caught.
  361. promise.catch( catchSpy );
  362. loader.file.then( () => {
  363. nativeReaderMock.mockSuccess();
  364. setTimeout( () => {
  365. sinon.assert.calledOnce( catchSpy );
  366. const error = catchSpy.getCall( 0 ).args[ 0 ];
  367. expect( error ).to.be.instanceOf( Error );
  368. expect( error ).to.haveOwnProperty( 'message', 'Foo bar baz' );
  369. done();
  370. }, 0 );
  371. } );
  372. } );
  373. it( 'should do nothing if image does not have uploadId', () => {
  374. setModelData( model, '<image src="image.png"></image>' );
  375. expect( getViewData( view ) ).to.equal(
  376. '[<figure class="ck-widget image" contenteditable="false"><img src="image.png"></img></figure>]'
  377. );
  378. } );
  379. it( 'should remove image in case of upload error', done => {
  380. const file = createNativeFileMock();
  381. const spy = sinon.spy();
  382. const notification = editor.plugins.get( Notification );
  383. setModelData( model, '<paragraph>{}foo bar</paragraph>' );
  384. notification.on( 'show:warning', evt => {
  385. spy();
  386. evt.stop();
  387. }, { priority: 'high' } );
  388. editor.execute( 'imageUpload', { file } );
  389. model.document.once( 'change', () => {
  390. model.document.once( 'change', () => {
  391. tryExpect( done, () => {
  392. expect( getModelData( model ) ).to.equal( '<paragraph>[]foo bar</paragraph>' );
  393. sinon.assert.calledOnce( spy );
  394. } );
  395. } );
  396. } );
  397. loader.file.then( () => nativeReaderMock.mockError( 'Upload error.' ) );
  398. } );
  399. it( 'should abort upload if image is removed', () => {
  400. const file = createNativeFileMock();
  401. setModelData( model, '<paragraph>{}foo bar</paragraph>' );
  402. editor.execute( 'imageUpload', { file } );
  403. const abortSpy = sinon.spy( loader, 'abort' );
  404. expect( loader.status ).to.equal( 'reading' );
  405. return loader.file.then( () => {
  406. nativeReaderMock.mockSuccess( base64Sample );
  407. const image = doc.getRoot().getChild( 0 );
  408. model.change( writer => {
  409. writer.remove( image );
  410. } );
  411. expect( loader.status ).to.equal( 'aborted' );
  412. sinon.assert.calledOnce( abortSpy );
  413. } );
  414. } );
  415. it( 'should not abort and not restart upload when image is moved', () => {
  416. const file = createNativeFileMock();
  417. setModelData( model, '<paragraph>{}foo bar</paragraph>' );
  418. editor.execute( 'imageUpload', { file } );
  419. const abortSpy = sinon.spy( loader, 'abort' );
  420. const loadSpy = sinon.spy( loader, 'read' );
  421. const image = doc.getRoot().getChild( 0 );
  422. model.change( writer => {
  423. writer.move( writer.createRangeOn( image ), writer.createPositionAt( doc.getRoot(), 2 ) );
  424. } );
  425. expect( abortSpy.called ).to.be.false;
  426. expect( loadSpy.called ).to.be.false;
  427. } );
  428. it( 'image should be permanently removed if it is removed by user during upload', done => {
  429. const file = createNativeFileMock();
  430. const notification = editor.plugins.get( Notification );
  431. setModelData( model, '<paragraph>{}foo bar</paragraph>' );
  432. // Prevent popping up alert window.
  433. notification.on( 'show:warning', evt => {
  434. evt.stop();
  435. }, { priority: 'high' } );
  436. editor.execute( 'imageUpload', { file } );
  437. const stub = sinon.stub();
  438. model.document.on( 'change', stub );
  439. // The first `change` event is fired after the "manual" remove.
  440. // The second `change` event is fired after cleaning attributes.
  441. stub.onSecondCall().callsFake( () => {
  442. expect( getModelData( model ) ).to.equal( '<paragraph>[]foo bar</paragraph>' );
  443. editor.execute( 'undo' );
  444. // Expect that the image has not been brought back.
  445. expect( getModelData( model ) ).to.equal( '<paragraph>[]foo bar</paragraph>' );
  446. done();
  447. } );
  448. const image = doc.getRoot().getChild( 0 );
  449. model.change( writer => {
  450. writer.remove( image );
  451. } );
  452. } );
  453. it( 'should create responsive image if server return multiple images', done => {
  454. const file = createNativeFileMock();
  455. setModelData( model, '<paragraph>{}foo bar</paragraph>' );
  456. editor.execute( 'imageUpload', { file } );
  457. model.document.once( 'change', () => {
  458. model.document.once( 'change', () => {
  459. tryExpect( done, () => {
  460. expect( getViewData( view ) ).to.equal(
  461. '[<figure class="ck-widget image" contenteditable="false">' +
  462. '<img sizes="100vw" src="image.png" srcset="image-500.png 500w, image-800.png 800w" width="800"></img>' +
  463. '</figure>]<p>foo bar</p>'
  464. );
  465. expect( loader.status ).to.equal( 'idle' );
  466. } );
  467. }, { priority: 'lowest' } );
  468. loader.file.then( () => adapterMocks[ 0 ].mockSuccess( { default: 'image.png', 500: 'image-500.png', 800: 'image-800.png' } ) );
  469. } );
  470. loader.file.then( () => nativeReaderMock.mockSuccess( base64Sample ) );
  471. } );
  472. it( 'should prevent from browser redirecting when an image is dropped on another image', () => {
  473. const spy = sinon.spy();
  474. editor.editing.view.document.fire( 'dragover', {
  475. preventDefault: spy
  476. } );
  477. expect( spy.calledOnce ).to.equal( true );
  478. } );
  479. it( 'should upload image with base64 src', done => {
  480. editor.plugins.get( 'Clipboard' ).on( 'inputTransformation', () => {
  481. const id = adapterMocks[ 0 ].loader.id;
  482. const expected = '<paragraph>bar</paragraph>' +
  483. `[<image src="" uploadId="${ id }" uploadStatus="reading"></image>]` +
  484. '<paragraph>foo</paragraph>';
  485. expectModel( done, getModelData( model ), expected );
  486. }, { priority: 'low' } );
  487. setModelData( model, '<paragraph>[]foo</paragraph>' );
  488. const clipboardHtml = `<p>bar</p><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. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  493. } );
  494. it( 'should upload image with blob src', done => {
  495. editor.plugins.get( 'Clipboard' ).on( 'inputTransformation', () => {
  496. const id = adapterMocks[ 0 ].loader.id;
  497. const expected = `[<image src="" uploadId="${ id }" uploadStatus="reading"></image>]` +
  498. '<paragraph>foo</paragraph>';
  499. expectModel( done, getModelData( model ), expected );
  500. }, { priority: 'low' } );
  501. setModelData( model, '<paragraph>[]foo</paragraph>' );
  502. const clipboardHtml = `<img src=${ base64ToBlobUrl( base64Sample ) } />`;
  503. const dataTransfer = mockDataTransfer( clipboardHtml );
  504. const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 1 ), model.createPositionAt( doc.getRoot(), 1 ) );
  505. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  506. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  507. } );
  508. it( 'should not upload image if no loader available', done => {
  509. editor.plugins.get( 'Clipboard' ).on( 'inputTransformation', () => {
  510. const expected = `[<image src="${ base64Sample }"></image>]<paragraph>foo</paragraph>`;
  511. expectModel( done, getModelData( model ), expected );
  512. }, { priority: 'low' } );
  513. sinon.stub( fileRepository, 'createLoader' ).callsFake( () => null );
  514. setModelData( model, '<paragraph>[]foo</paragraph>' );
  515. const clipboardHtml = `<img src=${ base64Sample } />`;
  516. const dataTransfer = mockDataTransfer( clipboardHtml );
  517. const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 1 ), model.createPositionAt( doc.getRoot(), 1 ) );
  518. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  519. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  520. } );
  521. it( 'should not upload and remove image if fetch failed', done => {
  522. const notification = editor.plugins.get( Notification );
  523. // Prevent popping up alert window.
  524. notification.on( 'show:warning', evt => {
  525. evt.stop();
  526. }, { priority: 'high' } );
  527. expectData(
  528. '<img src="" uploadId="#loader1_id" uploadProcessed="true"></img>',
  529. '[<image src="" uploadId="#loader1_id" uploadStatus="reading"></image>]<paragraph>foo</paragraph>',
  530. '<paragraph>[]foo</paragraph>',
  531. done,
  532. false
  533. );
  534. setModelData( model, '<paragraph>[]foo</paragraph>' );
  535. const clipboardHtml = `<img src=${ base64Sample } />`;
  536. const dataTransfer = mockDataTransfer( clipboardHtml );
  537. const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 1 ), model.createPositionAt( doc.getRoot(), 1 ) );
  538. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  539. // Stub `fetch` so it can be rejected.
  540. sinon.stub( window, 'fetch' ).callsFake( () => {
  541. return new Promise( ( res, rej ) => rej( 'could not fetch' ) );
  542. } );
  543. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  544. } );
  545. it( 'should upload only images which were successfully fetched and remove failed ones', done => {
  546. const notification = editor.plugins.get( Notification );
  547. // Prevent popping up alert window.
  548. notification.on( 'show:warning', evt => {
  549. evt.stop();
  550. }, { priority: 'high' } );
  551. const expectedModel = '<paragraph>bar</paragraph>' +
  552. '<image src="" uploadId="#loader1_id" uploadStatus="reading"></image>' +
  553. '<image src="" uploadId="#loader2_id" uploadStatus="reading"></image>' +
  554. '[<image src="" uploadId="#loader3_id" uploadStatus="reading"></image>]' +
  555. '<paragraph>foo</paragraph>';
  556. const expectedFinalModel = '<paragraph>bar</paragraph>' +
  557. '<image src="" uploadId="#loader1_id" uploadStatus="reading"></image>' +
  558. '[<image src="" uploadId="#loader2_id" uploadStatus="reading"></image>]' +
  559. '<paragraph>foo</paragraph>';
  560. expectData(
  561. '',
  562. expectedModel,
  563. expectedFinalModel,
  564. done
  565. );
  566. setModelData( model, '<paragraph>[]foo</paragraph>' );
  567. const clipboardHtml = `<p>bar</p><img src=${ base64Sample } />` +
  568. `<img src=${ base64ToBlobUrl( base64Sample ) } /><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` in a way that 2 first calls are successful and 3rd fails.
  573. let counter = 0;
  574. const fetch = window.fetch;
  575. sinon.stub( window, 'fetch' ).callsFake( src => {
  576. counter++;
  577. if ( counter < 3 ) {
  578. return fetch( src );
  579. } else {
  580. return Promise.reject();
  581. }
  582. } );
  583. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  584. } );
  585. it( 'should not upload and remove image when `File` constructor is not present', done => {
  586. const fileFn = window.File;
  587. window.File = undefined;
  588. const notification = editor.plugins.get( Notification );
  589. // Prevent popping up alert window.
  590. notification.on( 'show:warning', evt => {
  591. evt.stop();
  592. }, { priority: 'high' } );
  593. expectData(
  594. '<img src="" uploadId="#loader1_id" uploadProcessed="true"></img><p>baz</p>',
  595. '<image src="" uploadId="#loader1_id" uploadStatus="reading"></image><paragraph>baz[]foo</paragraph>',
  596. '<paragraph>baz[]foo</paragraph>',
  597. err => {
  598. window.File = fileFn;
  599. done( err );
  600. },
  601. false
  602. );
  603. setModelData( model, '<paragraph>[]foo</paragraph>' );
  604. const clipboardHtml = `<img src=${ base64ToBlobUrl( base64Sample ) } /><p>baz</p>`;
  605. const dataTransfer = mockDataTransfer( clipboardHtml );
  606. const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 1 ), model.createPositionAt( doc.getRoot(), 1 ) );
  607. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  608. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  609. } );
  610. it( 'should not upload and remove image when `File` constructor is not supported', done => {
  611. if ( isEdgeEnv ) {
  612. // Since on Edge `File` is already stubbed, restore it to it native form so that exception will be thrown.
  613. sinon.restore();
  614. // Since all stubs were restored, re-stub `scrollToTheSelection`.
  615. sinon.stub( editor.editing.view, 'scrollToTheSelection' ).callsFake( () => {} );
  616. } else {
  617. sinon.stub( window, 'File' ).throws( 'Function expected.' );
  618. }
  619. const notification = editor.plugins.get( Notification );
  620. // Prevent popping up alert window.
  621. notification.on( 'show:warning', evt => {
  622. evt.stop();
  623. }, { priority: 'high' } );
  624. expectData(
  625. '<p>baz</p><img src="" uploadId="#loader1_id" uploadProcessed="true"></img>',
  626. '<paragraph>baz</paragraph>[<image src="" uploadId="#loader1_id" uploadStatus="reading"></image>]<paragraph>foo</paragraph>',
  627. '<paragraph>baz[]</paragraph><paragraph>foo</paragraph>',
  628. done,
  629. false
  630. );
  631. setModelData( model, '<paragraph>[]foo</paragraph>' );
  632. const clipboardHtml = `<p>baz</p><img src=${ base64ToBlobUrl( base64Sample ) } />`;
  633. const dataTransfer = mockDataTransfer( clipboardHtml );
  634. const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 1 ), model.createPositionAt( doc.getRoot(), 1 ) );
  635. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  636. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  637. } );
  638. // Skip this test on Edge as we mock `File` object there so there is no sense in testing it.
  639. ( isEdgeEnv ? it.skip : it )( 'should get file extension from base64 string', done => {
  640. editor.plugins.get( 'Clipboard' ).on( 'inputTransformation', () => {
  641. tryExpect( done, () => {
  642. loader.file.then( file => expect( file.name.split( '.' ).pop() ).to.equal( 'png' ) );
  643. } );
  644. }, { priority: 'low' } );
  645. setModelData( model, '<paragraph>[]foo</paragraph>' );
  646. const clipboardHtml = `<img src=${ base64Sample } />`;
  647. const dataTransfer = mockDataTransfer( clipboardHtml );
  648. const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 1 ), model.createPositionAt( doc.getRoot(), 1 ) );
  649. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  650. // Stub `fetch` to return custom blob without type.
  651. sinon.stub( window, 'fetch' ).callsFake( () => {
  652. return new Promise( res => res( {
  653. blob() {
  654. return new Promise( res => res( new Blob( [ 'foo', 'bar' ] ) ) );
  655. }
  656. } ) );
  657. } );
  658. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  659. } );
  660. // Skip this test on Edge as we mock `File` object there so there is no sense in testing it.
  661. ( isEdgeEnv ? it.skip : it )( 'should use fallback file extension', done => {
  662. editor.plugins.get( 'Clipboard' ).on( 'inputTransformation', () => {
  663. tryExpect( done, () => {
  664. loader.file.then( file => expect( file.name.split( '.' ).pop() ).to.equal( 'jpeg' ) );
  665. } );
  666. }, { priority: 'low' } );
  667. setModelData( model, '<paragraph>[]foo</paragraph>' );
  668. const clipboardHtml = `<img src=${ base64ToBlobUrl( base64Sample ) } />`;
  669. const dataTransfer = mockDataTransfer( clipboardHtml );
  670. const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 1 ), model.createPositionAt( doc.getRoot(), 1 ) );
  671. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  672. // Stub `fetch` to return custom blob without type.
  673. sinon.stub( window, 'fetch' ).callsFake( () => {
  674. return new Promise( res => res( {
  675. blob() {
  676. return new Promise( res => res( new Blob( [ 'foo', 'bar' ] ) ) );
  677. }
  678. } ) );
  679. } );
  680. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  681. } );
  682. it( 'should not show notification when file loader failed with no error', done => {
  683. const notification = editor.plugins.get( Notification );
  684. let notificationsCount = 0;
  685. // Prevent popping up alert window.
  686. notification.on( 'show:warning', evt => {
  687. notificationsCount++;
  688. evt.stop();
  689. }, { priority: 'high' } );
  690. // Check data after paste.
  691. editor.plugins.get( 'Clipboard' ).on( 'inputTransformation', () => {
  692. adapterMocks[ 0 ].loader.file.then( () => {
  693. expect.fail( 'Promise should be rejected.' );
  694. } ).catch( () => {
  695. // Deffer so the promise could be resolved.
  696. setTimeout( () => {
  697. expect( notificationsCount ).to.equal( 0 );
  698. done();
  699. } );
  700. } );
  701. }, { priority: 'low' } );
  702. setModelData( model, '<paragraph>[]foo</paragraph>' );
  703. const clipboardHtml = `<img src=${ base64Sample } />`;
  704. const dataTransfer = mockDataTransfer( clipboardHtml );
  705. const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 1 ), model.createPositionAt( doc.getRoot(), 1 ) );
  706. const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
  707. // Stub `fetch` in a way that it always fails.
  708. sinon.stub( window, 'fetch' ).callsFake( () => Promise.reject() );
  709. viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
  710. } );
  711. // Helper for validating clipboard and model data as a result of a paste operation. This function checks both clipboard
  712. // data and model data synchronously (`expectedClipboardData`, `expectedModel`) and then the model data after `loader.file`
  713. // promise is resolved (so model state after successful/failed file fetch attempt).
  714. //
  715. // @param {String} expectedClipboardData Expected clipboard data on `inputTransformation` event.
  716. // @param {String} expectedModel Expected model data on `inputTransformation` event.
  717. // @param {String} expectedModelOnFile Expected model data after all `file.loader` promises are fetched.
  718. // @param {Function} doneFn Callback function to be called when all assertions are done or error occures.
  719. // @param {Boolean} [onSuccess=true] If `expectedModelOnFile` data should be validated
  720. // on `loader.file` a promise successful resolution or promise rejection.
  721. function expectData( expectedClipboardData, expectedModel, expectedModelOnFile, doneFn, onSuccess ) {
  722. // Check data after paste.
  723. editor.plugins.get( 'Clipboard' ).on( 'inputTransformation', ( evt, data ) => {
  724. const clipboardData = injectLoaderId( expectedClipboardData || '', adapterMocks );
  725. const modelData = injectLoaderId( expectedModel, adapterMocks );
  726. const finalModelData = injectLoaderId( expectedModelOnFile, adapterMocks );
  727. if ( clipboardData.length ) {
  728. expect( stringifyView( data.content ) ).to.equal( clipboardData );
  729. }
  730. expect( getModelData( model ) ).to.equal( modelData );
  731. if ( onSuccess !== false ) {
  732. adapterMocks[ 0 ].loader.file.then( () => {
  733. // Deffer so the promise could be resolved.
  734. setTimeout( () => {
  735. expectModel( doneFn, getModelData( model ), finalModelData );
  736. } );
  737. } );
  738. } else {
  739. adapterMocks[ 0 ].loader.file.then( () => {
  740. expect.fail( 'The `loader.file` should be rejected.' );
  741. } ).catch( () => {
  742. // Deffer so the promise could be resolved.
  743. setTimeout( () => {
  744. expectModel( doneFn, getModelData( model ), finalModelData );
  745. } );
  746. } );
  747. }
  748. }, { priority: 'low' } );
  749. }
  750. } );
  751. // Replaces '#loaderX_id' parameter in the given string with a loader id. It is used
  752. // so data string could be created before loader is initialized.
  753. //
  754. // @param {String} data String which have 'loader params' replaced.
  755. // @param {Array.<UploadAdapterMock>} adapters Adapters list. Each adapter holds a reference to a loader which id is used.
  756. // @returns {String} Data string with 'loader params' replaced.
  757. function injectLoaderId( data, adapters ) {
  758. let newData = data;
  759. if ( newData.includes( '#loader1_id' ) ) {
  760. newData = newData.replace( '#loader1_id', adapters[ 0 ].loader.id );
  761. }
  762. if ( newData.includes( '#loader2_id' ) ) {
  763. newData = newData.replace( '#loader2_id', adapters[ 1 ].loader.id );
  764. }
  765. if ( newData.includes( '#loader3_id' ) ) {
  766. newData = newData.replace( '#loader3_id', adapters[ 2 ].loader.id );
  767. }
  768. return newData;
  769. }
  770. // Asserts actual and expected model data.
  771. //
  772. // @param {function} done Callback function to be called when assertion is done.
  773. // @param {String} actual Actual model data.
  774. // @param {String} expected Expected model data.
  775. function expectModel( done, actual, expected ) {
  776. tryExpect( done, () => {
  777. expect( actual ).to.equal( expected );
  778. } );
  779. }
  780. // Runs given expect function in a try-catch. It should be used only when `expect` is called as a result of a `Promise`
  781. // resolution as all errors may be caught by tested code and needs to be rethrow to be correctly processed by a testing framework.
  782. //
  783. // @param {Function} doneFn Function to run when assertion is done.
  784. // @param {Function} expectFn Function containing all assertions.
  785. function tryExpect( doneFn, expectFn ) {
  786. try {
  787. expectFn();
  788. doneFn();
  789. } catch ( err ) {
  790. doneFn( err );
  791. }
  792. }
  793. // Creates data transfer object with predefined data.
  794. //
  795. // @param {String} content The content returned as `text/html` when queried.
  796. // @returns {module:clipboard/datatransfer~DataTransfer} DataTransfer object.
  797. function mockDataTransfer( content ) {
  798. return new DataTransfer( {
  799. types: [ 'text/html' ],
  800. getData: type => type === 'text/html' ? content : ''
  801. } );
  802. }
  803. // Creates blob url from the given base64 data.
  804. //
  805. // @param {String} base64 The base64 string from which blob url will be generated.
  806. // @returns {String} Blob url.
  807. function base64ToBlobUrl( base64 ) {
  808. return URL.createObjectURL( base64ToBlob( base64.trim() ) );
  809. }
  810. // Transforms base64 data into a blob object.
  811. //
  812. // @param {String} The base64 data to be transformed.
  813. // @returns {Blob} Blob object representing given base64 data.
  814. function base64ToBlob( base64Data ) {
  815. const [ type, data ] = base64Data.split( ',' );
  816. const byteCharacters = atob( data );
  817. const byteArrays = [];
  818. for ( let offset = 0; offset < byteCharacters.length; offset += 512 ) {
  819. const slice = byteCharacters.slice( offset, offset + 512 );
  820. const byteNumbers = new Array( slice.length );
  821. for ( let i = 0; i < slice.length; i++ ) {
  822. byteNumbers[ i ] = slice.charCodeAt( i );
  823. }
  824. byteArrays.push( new Uint8Array( byteNumbers ) );
  825. }
  826. return new Blob( byteArrays, { type } );
  827. }