| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454 |
- /**
- * @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 document, console */
- import ClassicTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/classictesteditor';
- import SimpleUploadAdapter from '../../src/adapters/simpleuploadadapter';
- import FileRepository from '../../src/filerepository';
- import { createNativeFileMock } from '../_utils/mocks';
- import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils';
- describe( 'SimpleUploadAdapter', () => {
- let editor, editorElement, sinonXHR, consoleWarnStub, fileRepository;
- testUtils.createSinonSandbox();
- beforeEach( () => {
- editorElement = document.createElement( 'div' );
- document.body.appendChild( editorElement );
- sinonXHR = testUtils.sinon.useFakeServer();
- consoleWarnStub = testUtils.sinon.stub( console, 'warn' );
- return ClassicTestEditor
- .create( editorElement, {
- plugins: [ SimpleUploadAdapter ],
- simpleUpload: {
- uploadUrl: 'http://example.com'
- }
- } )
- .then( newEditor => {
- editor = newEditor;
- fileRepository = editor.plugins.get( FileRepository );
- } );
- } );
- afterEach( () => {
- sinonXHR.restore();
- editorElement.remove();
- return editor.destroy();
- } );
- it( 'should require the FileRepository plugin', () => {
- expect( SimpleUploadAdapter.requires ).to.deep.equal( [ FileRepository ] );
- } );
- it( 'should be named', () => {
- expect( SimpleUploadAdapter.pluginName ).to.equal( 'SimpleUploadAdapter' );
- } );
- describe( 'init()', () => {
- it( 'should activate the adapter', () => {
- return ClassicTestEditor
- .create( editorElement, {
- plugins: [ SimpleUploadAdapter ],
- simpleUpload: {
- uploadUrl: 'http://example.com'
- }
- } )
- .then( editor => {
- expect( editor.plugins.get( FileRepository ).createUploadAdapter ).is.a( 'function' );
- return editor.destroy();
- } );
- } );
- } );
- describe( 'UploadAdapter', () => {
- let adapter, loader;
- beforeEach( () => {
- const file = createNativeFileMock();
- file.name = 'image.jpeg';
- loader = fileRepository.createLoader( file );
- adapter = editor.plugins.get( FileRepository ).createUploadAdapter( loader );
- } );
- it( 'the crateAdapter() method should be registered and have upload() and abort methods()', () => {
- expect( adapter ).to.not.be.undefined;
- expect( adapter.upload ).to.be.a( 'function' );
- expect( adapter.abort ).to.be.a( 'function' );
- } );
- it( 'should not set the FileRepository.createUploadAdapter() factory if not configured', () => {
- const editorElement = document.createElement( 'div' );
- document.body.appendChild( editorElement );
- return ClassicTestEditor
- .create( editorElement, {
- plugins: [ SimpleUploadAdapter ]
- } )
- .then( editor => {
- const fileRepository = editor.plugins.get( FileRepository );
- expect( fileRepository ).to.not.have.property( 'createUploadAdapter' );
- editorElement.remove();
- return editor.destroy();
- } );
- } );
- it( 'should not set the FileRepository.createUploadAdapter() factory if not configured properly', () => {
- const editorElement = document.createElement( 'div' );
- document.body.appendChild( editorElement );
- return ClassicTestEditor
- .create( editorElement, {
- plugins: [ SimpleUploadAdapter ],
- simpleUpload: {
- // Missing "uploadUrl".
- foo: 'bar'
- }
- } )
- .then( editor => {
- expect( consoleWarnStub.callCount ).to.equal( 1 );
- expect( consoleWarnStub.firstCall.args[ 0 ] ).to.match( /^simple-upload-adapter-missing-uploadurl/ );
- const fileRepository = editor.plugins.get( FileRepository );
- expect( fileRepository ).to.not.have.property( 'createUploadAdapter' );
- editorElement.remove();
- return editor.destroy();
- } );
- } );
- describe( 'upload()', () => {
- it( 'should return a Promise', () => {
- return loader.file
- .then( () => {
- expect( adapter.upload() ).to.be.instanceof( Promise );
- } );
- } );
- describe( 'using public feature configuration', () => {
- it( 'should send a request to config#uploadUrl', () => {
- const validResponse = {
- url: 'http://example.com/images/image.jpeg'
- };
- const uploadPromise = adapter.upload();
- return loader.file
- .then( () => {
- const request = sinonXHR.requests[ 0 ];
- request.respond( 200, { 'Content-Type': 'application/json' }, JSON.stringify( validResponse ) );
- expect( request.url ).to.equal( 'http://example.com' );
- return uploadPromise;
- } )
- .then( uploadResponse => {
- expect( uploadResponse ).to.be.a( 'object' );
- expect( uploadResponse ).to.have.property( 'default', 'http://example.com/images/image.jpeg' );
- } );
- } );
- it( 'should use config#headers in the request (when specified)', () => {
- const editorElement = document.createElement( 'div' );
- document.body.appendChild( editorElement );
- return ClassicTestEditor
- .create( editorElement, {
- plugins: [ SimpleUploadAdapter ],
- simpleUpload: {
- uploadUrl: 'http://example.com',
- headers: {
- 'X-CSRF-TOKEN': 'foo',
- Authorization: 'Bearer <token>'
- }
- }
- } )
- .then( editor => {
- const adapter = editor.plugins.get( FileRepository ).createUploadAdapter( loader );
- const validResponse = {
- url: 'http://example.com/images/image.jpeg'
- };
- const uploadPromise = adapter.upload();
- return loader.file
- .then( () => {
- const request = sinonXHR.requests[ 0 ];
- request.respond( 200, { 'Content-Type': 'application/json' }, JSON.stringify( validResponse ) );
- const requestHeaders = request.requestHeaders;
- expect( requestHeaders ).to.be.a( 'object' );
- expect( requestHeaders ).to.have.property( 'X-CSRF-TOKEN', 'foo' );
- expect( requestHeaders ).to.have.property( 'Authorization', 'Bearer <token>' );
- return uploadPromise;
- } )
- .then( uploadResponse => {
- expect( uploadResponse ).to.be.a( 'object' );
- expect( uploadResponse ).to.have.property( 'default', 'http://example.com/images/image.jpeg' );
- editorElement.remove();
- } )
- .then( () => editor.destroy() );
- } );
- } );
- it( 'should not set #requestHeaders of the request if config#headers is not specified', () => {
- const editorElement = document.createElement( 'div' );
- document.body.appendChild( editorElement );
- return ClassicTestEditor
- .create( editorElement, {
- plugins: [ SimpleUploadAdapter ],
- simpleUpload: {
- uploadUrl: 'http://example.com'
- }
- } )
- .then( editor => {
- const adapter = editor.plugins.get( FileRepository ).createUploadAdapter( loader );
- const validResponse = {
- url: 'http://example.com/images/image.jpeg'
- };
- const uploadPromise = adapter.upload();
- return loader.file
- .then( () => {
- const request = sinonXHR.requests[ 0 ];
- request.respond( 200, { 'Content-Type': 'application/json' }, JSON.stringify( validResponse ) );
- const requestHeaders = request.requestHeaders;
- expect( requestHeaders ).to.be.a( 'object' );
- expect( requestHeaders ).to.be.empty;
- return uploadPromise;
- } )
- .then( uploadResponse => {
- expect( uploadResponse ).to.be.a( 'object' );
- expect( uploadResponse ).to.have.property( 'default', 'http://example.com/images/image.jpeg' );
- editorElement.remove();
- } )
- .then( () => editor.destroy() );
- } );
- } );
- it( 'should use config#withCredentials in the request (when specified)', () => {
- const editorElement = document.createElement( 'div' );
- document.body.appendChild( editorElement );
- return ClassicTestEditor
- .create( editorElement, {
- plugins: [ SimpleUploadAdapter ],
- simpleUpload: {
- uploadUrl: 'http://example.com',
- withCredentials: true
- }
- } )
- .then( editor => {
- const adapter = editor.plugins.get( FileRepository ).createUploadAdapter( loader );
- const validResponse = {
- url: 'http://example.com/images/image.jpeg'
- };
- const uploadPromise = adapter.upload();
- return loader.file
- .then( () => {
- const request = sinonXHR.requests[ 0 ];
- request.respond( 200, { 'Content-Type': 'application/json' }, JSON.stringify( validResponse ) );
- expect( request ).to.have.property( 'withCredentials', true );
- return uploadPromise;
- } )
- .then( uploadResponse => {
- expect( uploadResponse ).to.be.a( 'object' );
- expect( uploadResponse ).to.have.property( 'default', 'http://example.com/images/image.jpeg' );
- editorElement.remove();
- } )
- .then( () => editor.destroy() );
- } );
- } );
- it( 'should not set #withCredentials of the request if config#withCredentials is not set', () => {
- const editorElement = document.createElement( 'div' );
- document.body.appendChild( editorElement );
- return ClassicTestEditor
- .create( editorElement, {
- plugins: [ SimpleUploadAdapter ],
- simpleUpload: {
- uploadUrl: 'http://example.com'
- }
- } )
- .then( editor => {
- const adapter = editor.plugins.get( FileRepository ).createUploadAdapter( loader );
- const validResponse = {
- url: 'http://example.com/images/image.jpeg'
- };
- const uploadPromise = adapter.upload();
- return loader.file
- .then( () => {
- const request = sinonXHR.requests[ 0 ];
- request.respond( 200, { 'Content-Type': 'application/json' }, JSON.stringify( validResponse ) );
- expect( request ).to.have.property( 'withCredentials', false );
- return uploadPromise;
- } )
- .then( uploadResponse => {
- expect( uploadResponse ).to.be.a( 'object' );
- expect( uploadResponse ).to.have.property( 'default', 'http://example.com/images/image.jpeg' );
- editorElement.remove();
- } )
- .then( () => editor.destroy() );
- } );
- } );
- } );
- it( 'should support responsive image URLs returned in the server response', () => {
- const validResponse = {
- urls: {
- default: 'http://example.com/images/image.jpeg',
- '120': 'http://example.com/images/image-120.jpeg',
- '240': 'http://example.com/images/image-240.jpeg'
- }
- };
- const uploadPromise = adapter.upload();
- return loader.file
- .then( () => {
- sinonXHR.requests[ 0 ].respond( 200, {
- 'Content-Type': 'application/json'
- }, JSON.stringify( validResponse ) );
- return uploadPromise;
- } )
- .then( uploadResponse => {
- expect( uploadResponse ).to.deep.equal( validResponse.urls );
- } );
- } );
- it( 'should throw on a generic request error', () => {
- const promise = adapter.upload()
- .then( () => {
- throw new Error( 'Promise should throw.' );
- } )
- .catch( msg => {
- expect( msg ).to.equal( 'Couldn\'t upload file: image.jpeg.' );
- } );
- loader.file.then( () => {
- const request = sinonXHR.requests[ 0 ];
- request.error();
- } );
- return promise;
- } );
- it( 'should throw on an error from server', () => {
- const responseError = {
- error: {
- message: 'Foo bar baz.'
- }
- };
- const promise = adapter.upload()
- .then( () => {
- throw new Error( 'Promise should throw.' );
- } )
- .catch( msg => {
- expect( msg ).to.equal( 'Foo bar baz.' );
- } );
- loader.file.then( () => {
- const request = sinonXHR.requests[ 0 ];
- request.respond( 200, { 'Content-Type': 'application/json' }, JSON.stringify( responseError ) );
- } );
- return promise;
- } );
- it( 'should throw a generic error on an error from server without a message', () => {
- const responseError = {
- error: {}
- };
- const promise = adapter.upload()
- .then( () => {
- throw new Error( 'Promise should throw.' );
- } )
- .catch( msg => {
- expect( msg ).to.equal( 'Couldn\'t upload file: image.jpeg.' );
- } );
- loader.file.then( () => {
- const request = sinonXHR.requests[ 0 ];
- request.respond( 200, { 'Content-Type': 'application/json' }, JSON.stringify( responseError ) );
- } );
- return promise;
- } );
- it( 'should throw an error on abort()', () => {
- let request;
- const promise = adapter.upload()
- .then( () => {
- throw new Error( 'Promise should throw.' );
- } )
- .catch( () => {
- expect( request.aborted ).to.be.true;
- } );
- loader.file.then( () => {
- request = sinonXHR.requests[ 0 ];
- adapter.abort();
- } );
- return promise;
- } );
- it( 'abort() should not throw before upload', () => {
- expect( () => {
- adapter.abort();
- } ).to.not.throw();
- } );
- it( 'should update progress', () => {
- adapter.upload();
- return loader.file.then( () => {
- const request = sinonXHR.requests[ 0 ];
- request.uploadProgress( { loaded: 4, total: 10 } );
- expect( loader.uploadTotal ).to.equal( 10 );
- expect( loader.uploaded ).to.equal( 4 );
- } );
- } );
- } );
- } );
- } );
|