| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054 |
- /**
- * @license Copyright (c) 2003-2020, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
- /* globals window, setTimeout, atob, URL, Blob, console */
- import VirtualTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/virtualtesteditor';
- import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
- import Clipboard from '@ckeditor/ckeditor5-clipboard/src/clipboard';
- import ImageEditing from '../../src/image/imageediting';
- import ImageUploadEditing from '../../src/imageupload/imageuploadediting';
- import ImageUploadCommand from '../../src/imageupload/imageuploadcommand';
- import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph';
- import UndoEditing from '@ckeditor/ckeditor5-undo/src/undoediting';
- import DataTransfer from '@ckeditor/ckeditor5-clipboard/src/datatransfer';
- import EventInfo from '@ckeditor/ckeditor5-utils/src/eventinfo';
- import FileRepository from '@ckeditor/ckeditor5-upload/src/filerepository';
- import { UploadAdapterMock, createNativeFileMock, NativeFileReaderMock } from '@ckeditor/ckeditor5-upload/tests/_utils/mocks';
- import { setData as setModelData, getData as getModelData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model';
- import { getData as getViewData, stringify as stringifyView } from '@ckeditor/ckeditor5-engine/src/dev-utils/view';
- import Notification from '@ckeditor/ckeditor5-ui/src/notification/notification';
- describe( 'ImageUploadEditing', () => {
- // eslint-disable-next-line max-len
- const base64Sample = 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+A8AAQUBAScY42YAAAAASUVORK5CYII=';
- let adapterMocks = [];
- let editor, model, view, doc, fileRepository, viewDocument, nativeReaderMock, loader;
- class UploadAdapterPluginMock extends Plugin {
- init() {
- fileRepository = this.editor.plugins.get( FileRepository );
- fileRepository.createUploadAdapter = newLoader => {
- loader = newLoader;
- const adapterMock = new UploadAdapterMock( loader );
- adapterMocks.push( adapterMock );
- return adapterMock;
- };
- }
- }
- beforeEach( () => {
- sinon.stub( window, 'FileReader' ).callsFake( () => {
- nativeReaderMock = new NativeFileReaderMock();
- return nativeReaderMock;
- } );
- return VirtualTestEditor
- .create( {
- plugins: [ ImageEditing, ImageUploadEditing, Paragraph, UndoEditing, UploadAdapterPluginMock, Clipboard ]
- } )
- .then( newEditor => {
- editor = newEditor;
- model = editor.model;
- doc = model.document;
- view = editor.editing.view;
- viewDocument = view.document;
- // Stub `view.scrollToTheSelection` as it will fail on VirtualTestEditor without DOM.
- sinon.stub( view, 'scrollToTheSelection' ).callsFake( () => {} );
- } );
- } );
- afterEach( () => {
- sinon.restore();
- adapterMocks = [];
- return editor.destroy();
- } );
- it( 'should register proper schema rules', () => {
- expect( model.schema.checkAttribute( [ '$root', 'image' ], 'uploadId' ) ).to.be.true;
- } );
- it( 'should register imageUpload command', () => {
- expect( editor.commands.get( 'imageUpload' ) ).to.be.instanceOf( ImageUploadCommand );
- } );
- it( 'should load Clipboard plugin', () => {
- return VirtualTestEditor
- .create( {
- plugins: [ ImageEditing, ImageUploadEditing, Paragraph, UndoEditing, UploadAdapterPluginMock ]
- } )
- .then( editor => {
- expect( editor.plugins.get( Clipboard ) ).to.be.instanceOf( Clipboard );
- } );
- } );
- it( 'should insert image when is pasted', () => {
- const fileMock = createNativeFileMock();
- const dataTransfer = new DataTransfer( { files: [ fileMock ], types: [ 'Files' ] } );
- setModelData( model, '<paragraph>[]foo</paragraph>' );
- const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 1 ), model.createPositionAt( doc.getRoot(), 1 ) );
- const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
- const eventInfo = new EventInfo( viewDocument, 'clipboardInput' );
- viewDocument.fire( eventInfo, { dataTransfer, targetRanges: [ targetViewRange ] } );
- const id = fileRepository.getLoader( fileMock ).id;
- expect( getModelData( model ) ).to.equal(
- `<paragraph>foo</paragraph>[<image uploadId="${ id }" uploadStatus="reading"></image>]`
- );
- expect( eventInfo.stop.called ).to.be.true;
- } );
- it( 'should insert image at optimized position when is pasted', () => {
- const fileMock = createNativeFileMock();
- const dataTransfer = new DataTransfer( { files: [ fileMock ], types: [ 'Files' ] } );
- setModelData( model, '<paragraph>[]foo</paragraph>' );
- const paragraph = doc.getRoot().getChild( 0 );
- const targetRange = model.createRange( model.createPositionAt( paragraph, 1 ), model.createPositionAt( paragraph, 1 ) ); // f[]oo
- const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
- viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
- const id = fileRepository.getLoader( fileMock ).id;
- expect( getModelData( model ) ).to.equal(
- `[<image uploadId="${ id }" uploadStatus="reading"></image>]<paragraph>foo</paragraph>`
- );
- } );
- it( 'should insert multiple image files when are pasted', () => {
- const files = [ createNativeFileMock(), createNativeFileMock() ];
- const dataTransfer = new DataTransfer( { files, types: [ 'Files' ] } );
- setModelData( model, '<paragraph>[]foo</paragraph>' );
- const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 1 ), model.createPositionAt( doc.getRoot(), 1 ) );
- const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
- viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
- const id1 = fileRepository.getLoader( files[ 0 ] ).id;
- const id2 = fileRepository.getLoader( files[ 1 ] ).id;
- expect( getModelData( model ) ).to.equal(
- '<paragraph>foo</paragraph>' +
- `<image uploadId="${ id1 }" uploadStatus="reading"></image>` +
- `[<image uploadId="${ id2 }" uploadStatus="reading"></image>]`
- );
- } );
- it( 'should insert image when is pasted on allowed position when ImageUploadCommand is disabled', () => {
- setModelData( model, '<paragraph>foo</paragraph>[<image></image>]' );
- const fileMock = createNativeFileMock();
- const dataTransfer = new DataTransfer( { files: [ fileMock ], types: [ 'Files' ] } );
- const command = editor.commands.get( 'imageUpload' );
- expect( command.isEnabled ).to.be.true;
- const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 0 ), model.createPositionAt( doc.getRoot(), 0 ) );
- const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
- viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
- const id = fileRepository.getLoader( fileMock ).id;
- expect( getModelData( model ) ).to.equal(
- `[<image uploadId="${ id }" uploadStatus="reading"></image>]<paragraph>foo</paragraph><image></image>`
- );
- } );
- it( 'should not insert image when editor is in read-only mode', () => {
- // Clipboard plugin is required for this test.
- return VirtualTestEditor
- .create( {
- plugins: [ ImageEditing, ImageUploadEditing, Paragraph, UploadAdapterPluginMock, Clipboard ]
- } )
- .then( editor => {
- const fileMock = createNativeFileMock();
- const dataTransfer = new DataTransfer( { files: [ fileMock ], types: [ 'Files' ] } );
- setModelData( editor.model, '<paragraph>[]foo</paragraph>' );
- const targetRange = editor.model.document.selection.getFirstRange();
- const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
- editor.isReadOnly = true;
- editor.editing.view.document.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
- expect( getModelData( editor.model ) ).to.equal( '<paragraph>[]foo</paragraph>' );
- return editor.destroy();
- } );
- } );
- it( 'should not insert image when file is not an image', () => {
- const viewDocument = editor.editing.view.document;
- const fileMock = {
- type: 'media/mp3',
- size: 1024
- };
- const dataTransfer = new DataTransfer( {
- files: [ fileMock ],
- types: [ 'Files' ],
- getData: () => ''
- } );
- setModelData( model, '<paragraph>foo[]</paragraph>' );
- const targetRange = doc.selection.getFirstRange();
- const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
- const eventInfo = new EventInfo( viewDocument, 'clipboardInput' );
- viewDocument.fire( eventInfo, { dataTransfer, targetRanges: [ targetViewRange ] } );
- expect( getModelData( model ) ).to.equal( '<paragraph>foo[]</paragraph>' );
- expect( eventInfo.stop.called ).to.be.undefined;
- } );
- it( 'should not insert image when file is not an configured image type', () => {
- const viewDocument = editor.editing.view.document;
- const fileMock = {
- type: 'image/svg+xml',
- size: 1024
- };
- const dataTransfer = new DataTransfer( {
- files: [ fileMock ],
- types: [ 'Files' ],
- getData: () => ''
- } );
- setModelData( model, '<paragraph>foo[]</paragraph>' );
- const targetRange = doc.selection.getFirstRange();
- const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
- const eventInfo = new EventInfo( viewDocument, 'clipboardInput' );
- viewDocument.fire( eventInfo, { dataTransfer, targetRanges: [ targetViewRange ] } );
- expect( getModelData( model ) ).to.equal( '<paragraph>foo[]</paragraph>' );
- expect( eventInfo.stop.called ).to.be.undefined;
- } );
- it( 'should not insert image when file is null', () => {
- const viewDocument = editor.editing.view.document;
- const dataTransfer = new DataTransfer( { files: [ null ], types: [ 'Files' ], getData: () => null } );
- setModelData( model, '<paragraph>foo[]</paragraph>' );
- const targetRange = doc.selection.getFirstRange();
- const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
- viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
- expect( getModelData( model ) ).to.equal( '<paragraph>foo[]</paragraph>' );
- } );
- it( 'should not insert image when there is non-empty HTML content pasted', () => {
- const fileMock = createNativeFileMock();
- const dataTransfer = new DataTransfer( {
- files: [ fileMock ],
- types: [ 'Files', 'text/html' ],
- getData: type => type === 'text/html' ? '<p>SomeData</p>' : ''
- } );
- setModelData( model, '<paragraph>[]foo</paragraph>' );
- const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 1 ), model.createPositionAt( doc.getRoot(), 1 ) );
- const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
- viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
- expect( getModelData( model ) ).to.equal( '<paragraph>SomeData[]foo</paragraph>' );
- } );
- it( 'should not insert image nor crash when pasted image could not be inserted', () => {
- model.schema.register( 'other', {
- allowIn: '$root',
- isLimit: true
- } );
- model.schema.extend( '$text', { allowIn: 'other' } );
- editor.conversion.elementToElement( { model: 'other', view: 'p' } );
- setModelData( model, '<other>[]</other>' );
- const fileMock = createNativeFileMock();
- const dataTransfer = new DataTransfer( { files: [ fileMock ], types: [ 'Files' ] } );
- const targetRange = doc.selection.getFirstRange();
- const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
- viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
- expect( getModelData( model ) ).to.equal( '<other>[]</other>' );
- } );
- it( 'should not throw when upload adapter is not set (FileRepository will log an warn anyway) when image is pasted', () => {
- const fileMock = createNativeFileMock();
- const dataTransfer = new DataTransfer( { files: [ fileMock ], types: [ 'Files' ] } );
- const consoleWarnStub = sinon.stub( console, 'warn' );
- setModelData( model, '<paragraph>[]foo</paragraph>' );
- fileRepository.createUploadAdapter = undefined;
- const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 1 ), model.createPositionAt( doc.getRoot(), 1 ) );
- const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
- expect( () => {
- viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
- } ).to.not.throw();
- expect( getModelData( model ) ).to.equal( '<paragraph>foo[]</paragraph>' );
- sinon.assert.calledOnce( consoleWarnStub );
- } );
- // https://github.com/ckeditor/ckeditor5-upload/issues/70
- it( 'should not crash on browsers which do not implement DOMStringList as a child class of an Array', () => {
- const typesDomStringListMock = {
- length: 2,
- '0': 'text/html',
- '1': 'text/plain'
- };
- const dataTransfer = new DataTransfer( {
- types: typesDomStringListMock,
- getData: type => type === 'text/html' ? '<p>SomeData</p>' : 'SomeData'
- } );
- setModelData( model, '<paragraph>[]foo</paragraph>' );
- const targetRange = doc.selection.getFirstRange();
- const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
- viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
- // Well, there's no clipboard plugin, so nothing happens.
- expect( getModelData( model ) ).to.equal( '<paragraph>SomeData[]foo</paragraph>' );
- } );
- it( 'should not convert image\'s uploadId attribute if is consumed already', () => {
- editor.editing.downcastDispatcher.on( 'attribute:uploadId:image', ( evt, data, conversionApi ) => {
- conversionApi.consumable.consume( data.item, evt.name );
- }, { priority: 'high' } );
- setModelData( model, '<image uploadId="1234"></image>' );
- expect( getViewData( view ) ).to.equal(
- '[<figure class="ck-widget image" contenteditable="false">' +
- '<img></img>' +
- '</figure>]' );
- } );
- it( 'should not use read data once it is present', done => {
- const file = createNativeFileMock();
- setModelData( model, '<paragraph>{}foo bar</paragraph>' );
- editor.execute( 'imageUpload', { file } );
- model.document.once( 'change', () => {
- tryExpect( done, () => {
- expect( getViewData( view ) ).to.equal(
- '[<figure class="ck-widget image" contenteditable="false">' +
- // Rendering the image data is left to a upload progress converter.
- '<img></img>' +
- '</figure>]' +
- '<p>foo bar</p>'
- );
- expect( loader.status ).to.equal( 'uploading' );
- } );
- } );
- expect( loader.status ).to.equal( 'reading' );
- loader.file.then( () => nativeReaderMock.mockSuccess( base64Sample ) );
- } );
- it( 'should replace read data with server response once it is present', done => {
- const file = createNativeFileMock();
- setModelData( model, '<paragraph>{}foo bar</paragraph>' );
- editor.execute( 'imageUpload', { file } );
- model.document.once( 'change', () => {
- model.document.once( 'change', () => {
- tryExpect( done, () => {
- expect( getViewData( view ) ).to.equal(
- '[<figure class="ck-widget image" contenteditable="false"><img src="image.png"></img></figure>]<p>foo bar</p>'
- );
- expect( loader.status ).to.equal( 'idle' );
- } );
- }, { priority: 'lowest' } );
- loader.file.then( () => adapterMocks[ 0 ].mockSuccess( { default: 'image.png' } ) );
- } );
- loader.file.then( () => nativeReaderMock.mockSuccess( base64Sample ) );
- } );
- it( 'should fire notification event in case of error', done => {
- const notification = editor.plugins.get( Notification );
- const file = createNativeFileMock();
- notification.on( 'show:warning', ( evt, data ) => {
- tryExpect( done, () => {
- expect( data.message ).to.equal( 'Reading error.' );
- expect( data.title ).to.equal( 'Upload failed' );
- evt.stop();
- } );
- }, { priority: 'high' } );
- setModelData( model, '<paragraph>{}foo bar</paragraph>' );
- editor.execute( 'imageUpload', { file } );
- loader.file.then( () => nativeReaderMock.mockError( 'Reading error.' ) );
- } );
- it( 'should not fire notification on abort', done => {
- const notification = editor.plugins.get( Notification );
- const file = createNativeFileMock();
- const spy = sinon.spy();
- notification.on( 'show:warning', evt => {
- spy();
- evt.stop();
- }, { priority: 'high' } );
- setModelData( model, '<paragraph>{}foo bar</paragraph>' );
- editor.execute( 'imageUpload', { file } );
- loader.file.then( () => {
- nativeReaderMock.abort();
- setTimeout( () => {
- sinon.assert.notCalled( spy );
- done();
- }, 0 );
- } );
- } );
- it( 'should throw when other error happens during upload', done => {
- const file = createNativeFileMock();
- const error = new Error( 'Foo bar baz' );
- const uploadEditing = editor.plugins.get( ImageUploadEditing );
- const loadSpy = sinon.spy( uploadEditing, '_readAndUpload' );
- const catchSpy = sinon.spy();
- // Throw an error when async attribute change occur.
- editor.editing.downcastDispatcher.on( 'attribute:uploadStatus:image', ( evt, data ) => {
- if ( data.attributeNewValue == 'uploading' ) {
- throw error;
- }
- } );
- setModelData( model, '<paragraph>{}foo bar</paragraph>' );
- editor.execute( 'imageUpload', { file } );
- sinon.assert.calledOnce( loadSpy );
- const promise = loadSpy.returnValues[ 0 ];
- // Check if error can be caught.
- promise.catch( catchSpy );
- loader.file.then( () => {
- nativeReaderMock.mockSuccess();
- setTimeout( () => {
- sinon.assert.calledOnce( catchSpy );
- const error = catchSpy.getCall( 0 ).args[ 0 ];
- expect( error ).to.be.instanceOf( Error );
- expect( error ).to.haveOwnProperty( 'message', 'Foo bar baz' );
- done();
- }, 0 );
- } );
- } );
- it( 'should do nothing if image does not have uploadId', () => {
- setModelData( model, '<image src="image.png"></image>' );
- expect( getViewData( view ) ).to.equal(
- '[<figure class="ck-widget image" contenteditable="false"><img src="image.png"></img></figure>]'
- );
- } );
- it( 'should remove image in case of upload error', done => {
- const file = createNativeFileMock();
- const spy = sinon.spy();
- const notification = editor.plugins.get( Notification );
- setModelData( model, '<paragraph>{}foo bar</paragraph>' );
- notification.on( 'show:warning', evt => {
- spy();
- evt.stop();
- }, { priority: 'high' } );
- editor.execute( 'imageUpload', { file } );
- model.document.once( 'change', () => {
- model.document.once( 'change', () => {
- tryExpect( done, () => {
- expect( getModelData( model ) ).to.equal( '<paragraph>[]foo bar</paragraph>' );
- sinon.assert.calledOnce( spy );
- } );
- } );
- } );
- loader.file.then( () => nativeReaderMock.mockError( 'Upload error.' ) );
- } );
- it( 'should abort upload if image is removed', () => {
- const file = createNativeFileMock();
- setModelData( model, '<paragraph>{}foo bar</paragraph>' );
- editor.execute( 'imageUpload', { file } );
- const abortSpy = sinon.spy( loader, 'abort' );
- expect( loader.status ).to.equal( 'reading' );
- return loader.file.then( () => {
- nativeReaderMock.mockSuccess( base64Sample );
- const image = doc.getRoot().getChild( 0 );
- model.change( writer => {
- writer.remove( image );
- } );
- expect( loader.status ).to.equal( 'aborted' );
- sinon.assert.calledOnce( abortSpy );
- } );
- } );
- it( 'should not abort and not restart upload when image is moved', () => {
- const file = createNativeFileMock();
- setModelData( model, '<paragraph>{}foo bar</paragraph>' );
- editor.execute( 'imageUpload', { file } );
- const abortSpy = sinon.spy( loader, 'abort' );
- const loadSpy = sinon.spy( loader, 'read' );
- const image = doc.getRoot().getChild( 0 );
- model.change( writer => {
- writer.move( writer.createRangeOn( image ), writer.createPositionAt( doc.getRoot(), 2 ) );
- } );
- expect( abortSpy.called ).to.be.false;
- expect( loadSpy.called ).to.be.false;
- } );
- it( 'image should be permanently removed if it is removed by user during upload', done => {
- const file = createNativeFileMock();
- const notification = editor.plugins.get( Notification );
- setModelData( model, '<paragraph>{}foo bar</paragraph>' );
- // Prevent popping up alert window.
- notification.on( 'show:warning', evt => {
- evt.stop();
- }, { priority: 'high' } );
- editor.execute( 'imageUpload', { file } );
- const stub = sinon.stub();
- model.document.on( 'change', stub );
- // The first `change` event is fired after the "manual" remove.
- // The second `change` event is fired after cleaning attributes.
- stub.onSecondCall().callsFake( () => {
- expect( getModelData( model ) ).to.equal( '<paragraph>[]foo bar</paragraph>' );
- editor.execute( 'undo' );
- // Expect that the image has not been brought back.
- expect( getModelData( model ) ).to.equal( '<paragraph>[]foo bar</paragraph>' );
- done();
- } );
- const image = doc.getRoot().getChild( 0 );
- model.change( writer => {
- writer.remove( image );
- } );
- } );
- it( 'should create responsive image if server return multiple images', done => {
- const file = createNativeFileMock();
- setModelData( model, '<paragraph>{}foo bar</paragraph>' );
- editor.execute( 'imageUpload', { file } );
- model.document.once( 'change', () => {
- model.document.once( 'change', () => {
- tryExpect( done, () => {
- expect( getViewData( view ) ).to.equal(
- '[<figure class="ck-widget image" contenteditable="false">' +
- '<img sizes="100vw" src="image.png" srcset="image-500.png 500w, image-800.png 800w" width="800"></img>' +
- '</figure>]<p>foo bar</p>'
- );
- expect( loader.status ).to.equal( 'idle' );
- } );
- }, { priority: 'lowest' } );
- loader.file.then( () => adapterMocks[ 0 ].mockSuccess( { default: 'image.png', 500: 'image-500.png', 800: 'image-800.png' } ) );
- } );
- loader.file.then( () => nativeReaderMock.mockSuccess( base64Sample ) );
- } );
- it( 'should prevent from browser redirecting when an image is dropped on another image', () => {
- const spy = sinon.spy();
- editor.editing.view.document.fire( 'dragover', {
- preventDefault: spy
- } );
- expect( spy.calledOnce ).to.equal( true );
- } );
- it( 'should upload image with base64 src', done => {
- setModelData( model, '<paragraph>[]foo</paragraph>' );
- const clipboardHtml = `<p>bar</p><img src=${ base64Sample } />`;
- const dataTransfer = mockDataTransfer( clipboardHtml );
- const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 1 ), model.createPositionAt( doc.getRoot(), 1 ) );
- const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
- viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
- const id = adapterMocks[ 0 ].loader.id;
- const expected = '<paragraph>bar</paragraph>' +
- `[<image src="" uploadId="${ id }" uploadStatus="reading"></image>]` +
- '<paragraph>foo</paragraph>';
- expectModel( done, getModelData( model ), expected );
- } );
- it( 'should upload image with blob src', done => {
- setModelData( model, '<paragraph>[]foo</paragraph>' );
- const clipboardHtml = `<img src=${ base64ToBlobUrl( base64Sample ) } />`;
- const dataTransfer = mockDataTransfer( clipboardHtml );
- const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 1 ), model.createPositionAt( doc.getRoot(), 1 ) );
- const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
- viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
- const id = adapterMocks[ 0 ].loader.id;
- const expected = `[<image src="" uploadId="${ id }" uploadStatus="reading"></image>]` +
- '<paragraph>foo</paragraph>';
- expectModel( done, getModelData( model ), expected );
- } );
- it( 'should not upload image if no loader available', done => {
- sinon.stub( fileRepository, 'createLoader' ).callsFake( () => null );
- setModelData( model, '<paragraph>[]foo</paragraph>' );
- const clipboardHtml = `<img src=${ base64Sample } />`;
- const dataTransfer = mockDataTransfer( clipboardHtml );
- const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 1 ), model.createPositionAt( doc.getRoot(), 1 ) );
- const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
- viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
- const expected = `[<image src="${ base64Sample }"></image>]<paragraph>foo</paragraph>`;
- expectModel( done, getModelData( model ), expected );
- } );
- it( 'should not upload and remove image if fetch failed', done => {
- const notification = editor.plugins.get( Notification );
- // Prevent popping up alert window.
- notification.on( 'show:warning', evt => {
- evt.stop();
- }, { priority: 'high' } );
- setModelData( model, '<paragraph>[]foo</paragraph>' );
- const clipboardHtml = `<img src=${ base64Sample } />`;
- const dataTransfer = mockDataTransfer( clipboardHtml );
- const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 1 ), model.createPositionAt( doc.getRoot(), 1 ) );
- const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
- // Stub `fetch` so it can be rejected.
- sinon.stub( window, 'fetch' ).callsFake( () => {
- return new Promise( ( res, rej ) => rej( 'could not fetch' ) );
- } );
- let content = null;
- editor.plugins.get( 'Clipboard' ).on( 'inputTransformation', ( evt, data ) => {
- content = data.content;
- } );
- viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
- expectData(
- '<img src="" uploadId="#loader1_id" uploadProcessed="true"></img>',
- '[<image src="" uploadId="#loader1_id" uploadStatus="reading"></image>]<paragraph>foo</paragraph>',
- '<paragraph>[]foo</paragraph>',
- content,
- done,
- false
- );
- } );
- it( 'should upload only images which were successfully fetched and remove failed ones', done => {
- const notification = editor.plugins.get( Notification );
- // Prevent popping up alert window.
- notification.on( 'show:warning', evt => {
- evt.stop();
- }, { priority: 'high' } );
- const expectedModel = '<paragraph>bar</paragraph>' +
- '<image src="" uploadId="#loader1_id" uploadStatus="reading"></image>' +
- '<image src="" uploadId="#loader2_id" uploadStatus="reading"></image>' +
- '[<image src="" uploadId="#loader3_id" uploadStatus="reading"></image>]' +
- '<paragraph>foo</paragraph>';
- const expectedFinalModel = '<paragraph>bar</paragraph>' +
- '<image src="" uploadId="#loader1_id" uploadStatus="reading"></image>' +
- '[<image src="" uploadId="#loader2_id" uploadStatus="reading"></image>]' +
- '<paragraph>foo</paragraph>';
- setModelData( model, '<paragraph>[]foo</paragraph>' );
- const clipboardHtml = `<p>bar</p><img src=${ base64Sample } />` +
- `<img src=${ base64ToBlobUrl( base64Sample ) } /><img src=${ base64Sample } />`;
- const dataTransfer = mockDataTransfer( clipboardHtml );
- const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 1 ), model.createPositionAt( doc.getRoot(), 1 ) );
- const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
- // Stub `fetch` in a way that 2 first calls are successful and 3rd fails.
- let counter = 0;
- const fetch = window.fetch;
- sinon.stub( window, 'fetch' ).callsFake( src => {
- counter++;
- if ( counter < 3 ) {
- return fetch( src );
- } else {
- return Promise.reject();
- }
- } );
- let content = null;
- editor.plugins.get( 'Clipboard' ).on( 'inputTransformation', ( evt, data ) => {
- content = data.content;
- } );
- viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
- expectData(
- '',
- expectedModel,
- expectedFinalModel,
- content,
- done
- );
- } );
- it( 'should not upload and remove image when `File` constructor is not present', done => {
- const fileFn = window.File;
- window.File = undefined;
- const notification = editor.plugins.get( Notification );
- // Prevent popping up alert window.
- notification.on( 'show:warning', evt => {
- evt.stop();
- }, { priority: 'high' } );
- setModelData( model, '<paragraph>[]foo</paragraph>' );
- const clipboardHtml = `<img src=${ base64ToBlobUrl( base64Sample ) } /><p>baz</p>`;
- const dataTransfer = mockDataTransfer( clipboardHtml );
- const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 1 ), model.createPositionAt( doc.getRoot(), 1 ) );
- const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
- let content = null;
- editor.plugins.get( 'Clipboard' ).on( 'inputTransformation', ( evt, data ) => {
- content = data.content;
- } );
- viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
- expectData(
- '<img src="" uploadId="#loader1_id" uploadProcessed="true"></img><p>baz</p>',
- '<image src="" uploadId="#loader1_id" uploadStatus="reading"></image><paragraph>baz[]foo</paragraph>',
- '<paragraph>baz[]foo</paragraph>',
- content,
- err => {
- window.File = fileFn;
- done( err );
- },
- false
- );
- } );
- it( 'should not upload and remove image when `File` constructor is not supported', done => {
- sinon.stub( window, 'File' ).throws( 'Function expected.' );
- const notification = editor.plugins.get( Notification );
- // Prevent popping up alert window.
- notification.on( 'show:warning', evt => {
- evt.stop();
- }, { priority: 'high' } );
- setModelData( model, '<paragraph>[]foo</paragraph>' );
- const clipboardHtml = `<p>baz</p><img src=${ base64ToBlobUrl( base64Sample ) } />`;
- const dataTransfer = mockDataTransfer( clipboardHtml );
- const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 1 ), model.createPositionAt( doc.getRoot(), 1 ) );
- const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
- let content = null;
- editor.plugins.get( 'Clipboard' ).on( 'inputTransformation', ( evt, data ) => {
- content = data.content;
- } );
- viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
- expectData(
- '<p>baz</p><img src="" uploadId="#loader1_id" uploadProcessed="true"></img>',
- '<paragraph>baz</paragraph>[<image src="" uploadId="#loader1_id" uploadStatus="reading"></image>]<paragraph>foo</paragraph>',
- '<paragraph>baz[]</paragraph><paragraph>foo</paragraph>',
- content,
- done,
- false
- );
- } );
- it( 'should get file extension from base64 string', done => {
- setModelData( model, '<paragraph>[]foo</paragraph>' );
- const clipboardHtml = `<img src=${ base64Sample } />`;
- const dataTransfer = mockDataTransfer( clipboardHtml );
- const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 1 ), model.createPositionAt( doc.getRoot(), 1 ) );
- const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
- // Stub `fetch` to return custom blob without type.
- sinon.stub( window, 'fetch' ).callsFake( () => {
- return new Promise( res => res( {
- blob() {
- return new Promise( res => res( new Blob( [ 'foo', 'bar' ] ) ) );
- }
- } ) );
- } );
- viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
- tryExpect( done, () => {
- loader.file.then( file => expect( file.name.split( '.' ).pop() ).to.equal( 'png' ) );
- } );
- } );
- it( 'should use fallback file extension', done => {
- setModelData( model, '<paragraph>[]foo</paragraph>' );
- const clipboardHtml = `<img src=${ base64ToBlobUrl( base64Sample ) } />`;
- const dataTransfer = mockDataTransfer( clipboardHtml );
- const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 1 ), model.createPositionAt( doc.getRoot(), 1 ) );
- const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
- // Stub `fetch` to return custom blob without type.
- sinon.stub( window, 'fetch' ).callsFake( () => {
- return new Promise( res => res( {
- blob() {
- return new Promise( res => res( new Blob( [ 'foo', 'bar' ] ) ) );
- }
- } ) );
- } );
- viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
- tryExpect( done, () => {
- loader.file.then( file => expect( file.name.split( '.' ).pop() ).to.equal( 'jpeg' ) );
- } );
- } );
- it( 'should not show notification when file loader failed with no error', done => {
- const notification = editor.plugins.get( Notification );
- let notificationsCount = 0;
- // Prevent popping up alert window.
- notification.on( 'show:warning', evt => {
- notificationsCount++;
- evt.stop();
- }, { priority: 'high' } );
- setModelData( model, '<paragraph>[]foo</paragraph>' );
- const clipboardHtml = `<img src=${ base64Sample } />`;
- const dataTransfer = mockDataTransfer( clipboardHtml );
- const targetRange = model.createRange( model.createPositionAt( doc.getRoot(), 1 ), model.createPositionAt( doc.getRoot(), 1 ) );
- const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
- // Stub `fetch` in a way that it always fails.
- sinon.stub( window, 'fetch' ).callsFake( () => Promise.reject() );
- viewDocument.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
- adapterMocks[ 0 ].loader.file.then( () => {
- expect.fail( 'Promise should be rejected.' );
- } ).catch( () => {
- // Deffer so the promise could be resolved.
- setTimeout( () => {
- expect( notificationsCount ).to.equal( 0 );
- done();
- } );
- } );
- } );
- // Helper for validating clipboard and model data as a result of a paste operation. This function checks both clipboard
- // data and model data synchronously (`expectedClipboardData`, `expectedModel`) and then the model data after `loader.file`
- // promise is resolved (so model state after successful/failed file fetch attempt).
- //
- // @param {String} expectedClipboardData Expected clipboard data on `inputTransformation` event.
- // @param {String} expectedModel Expected model data on `inputTransformation` event.
- // @param {String} expectedModelOnFile Expected model data after all `file.loader` promises are fetched.
- // @param {DocumentFragment} content Content processed in inputTransformation
- // @param {Function} doneFn Callback function to be called when all assertions are done or error occures.
- // @param {Boolean} [onSuccess=true] If `expectedModelOnFile` data should be validated
- // on `loader.file` a promise successful resolution or promise rejection.
- function expectData( expectedClipboardData, expectedModel, expectedModelOnFile, content, doneFn, onSuccess ) {
- const clipboardData = injectLoaderId( expectedClipboardData || '', adapterMocks );
- const modelData = injectLoaderId( expectedModel, adapterMocks );
- const finalModelData = injectLoaderId( expectedModelOnFile, adapterMocks );
- if ( clipboardData.length ) {
- expect( stringifyView( content ) ).to.equal( clipboardData );
- }
- expect( getModelData( model ) ).to.equal( modelData );
- if ( onSuccess !== false ) {
- adapterMocks[ 0 ].loader.file.then( () => {
- // Deffer so the promise could be resolved.
- setTimeout( () => {
- expectModel( doneFn, getModelData( model ), finalModelData );
- } );
- } );
- } else {
- adapterMocks[ 0 ].loader.file.then( () => {
- expect.fail( 'The `loader.file` should be rejected.' );
- } ).catch( () => {
- // Deffer so the promise could be resolved.
- setTimeout( () => {
- expectModel( doneFn, getModelData( model ), finalModelData );
- } );
- } );
- }
- }
- } );
- // Replaces '#loaderX_id' parameter in the given string with a loader id. It is used
- // so data string could be created before loader is initialized.
- //
- // @param {String} data String which have 'loader params' replaced.
- // @param {Array.<UploadAdapterMock>} adapters Adapters list. Each adapter holds a reference to a loader which id is used.
- // @returns {String} Data string with 'loader params' replaced.
- function injectLoaderId( data, adapters ) {
- let newData = data;
- if ( newData.includes( '#loader1_id' ) ) {
- newData = newData.replace( '#loader1_id', adapters[ 0 ].loader.id );
- }
- if ( newData.includes( '#loader2_id' ) ) {
- newData = newData.replace( '#loader2_id', adapters[ 1 ].loader.id );
- }
- if ( newData.includes( '#loader3_id' ) ) {
- newData = newData.replace( '#loader3_id', adapters[ 2 ].loader.id );
- }
- return newData;
- }
- // Asserts actual and expected model data.
- //
- // @param {function} done Callback function to be called when assertion is done.
- // @param {String} actual Actual model data.
- // @param {String} expected Expected model data.
- function expectModel( done, actual, expected ) {
- tryExpect( done, () => {
- expect( actual ).to.equal( expected );
- } );
- }
- // Runs given expect function in a try-catch. It should be used only when `expect` is called as a result of a `Promise`
- // resolution as all errors may be caught by tested code and needs to be rethrow to be correctly processed by a testing framework.
- //
- // @param {Function} doneFn Function to run when assertion is done.
- // @param {Function} expectFn Function containing all assertions.
- function tryExpect( doneFn, expectFn ) {
- try {
- expectFn();
- doneFn();
- } catch ( err ) {
- doneFn( err );
- }
- }
- // Creates data transfer object with predefined data.
- //
- // @param {String} content The content returned as `text/html` when queried.
- // @returns {module:clipboard/datatransfer~DataTransfer} DataTransfer object.
- function mockDataTransfer( content ) {
- return new DataTransfer( {
- types: [ 'text/html' ],
- getData: type => type === 'text/html' ? content : ''
- } );
- }
- // Creates blob url from the given base64 data.
- //
- // @param {String} base64 The base64 string from which blob url will be generated.
- // @returns {String} Blob url.
- function base64ToBlobUrl( base64 ) {
- return URL.createObjectURL( base64ToBlob( base64.trim() ) );
- }
- // Transforms base64 data into a blob object.
- //
- // @param {String} The base64 data to be transformed.
- // @returns {Blob} Blob object representing given base64 data.
- function base64ToBlob( base64Data ) {
- const [ type, data ] = base64Data.split( ',' );
- const byteCharacters = atob( data );
- const byteArrays = [];
- for ( let offset = 0; offset < byteCharacters.length; offset += 512 ) {
- const slice = byteCharacters.slice( offset, offset + 512 );
- const byteNumbers = new Array( slice.length );
- for ( let i = 0; i < slice.length; i++ ) {
- byteNumbers[ i ] = slice.charCodeAt( i );
- }
- byteArrays.push( new Uint8Array( byteNumbers ) );
- }
- return new Blob( byteArrays, { type } );
- }
|