simpleuploadadapter.js 8.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308
  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 document */
  6. import ClassicTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/classictesteditor';
  7. import SimpleUploadAdapter from '../../src/adapters/simpleuploadadapter';
  8. import FileRepository from '../../src/filerepository';
  9. import log from '@ckeditor/ckeditor5-utils/src/log';
  10. import { createNativeFileMock } from '../_utils/mocks';
  11. import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils';
  12. describe( 'SimpleUploadAdapter', () => {
  13. let editor, editorElement, sinonXHR, logStub, fileRepository;
  14. testUtils.createSinonSandbox();
  15. beforeEach( () => {
  16. editorElement = document.createElement( 'div' );
  17. document.body.appendChild( editorElement );
  18. sinonXHR = testUtils.sinon.useFakeServer();
  19. logStub = testUtils.sinon.stub( log, 'warn' );
  20. return ClassicTestEditor
  21. .create( editorElement, {
  22. plugins: [ SimpleUploadAdapter ],
  23. simpleUpload: {
  24. uploadUrl: 'http://example.com'
  25. }
  26. } )
  27. .then( newEditor => {
  28. editor = newEditor;
  29. fileRepository = editor.plugins.get( FileRepository );
  30. } );
  31. } );
  32. afterEach( () => {
  33. sinonXHR.restore();
  34. } );
  35. it( 'should require FileRepository plugin', () => {
  36. expect( SimpleUploadAdapter.requires ).to.deep.equal( [ FileRepository ] );
  37. } );
  38. it( 'should be named', () => {
  39. expect( SimpleUploadAdapter.pluginName ).to.equal( 'SimpleUploadAdapter' );
  40. } );
  41. describe( 'init()', () => {
  42. it( 'should set loader', () => {
  43. return ClassicTestEditor
  44. .create( editorElement, {
  45. plugins: [ SimpleUploadAdapter ],
  46. simpleUpload: {
  47. uploadUrl: 'http://example.com'
  48. }
  49. } )
  50. .then( editor => {
  51. expect( editor.plugins.get( FileRepository ).createUploadAdapter ).is.a( 'function' );
  52. return editor.destroy();
  53. } );
  54. } );
  55. } );
  56. describe( 'UploadAdapter', () => {
  57. let adapter, loader;
  58. beforeEach( () => {
  59. const file = createNativeFileMock();
  60. file.name = 'image.jpeg';
  61. loader = fileRepository.createLoader( file );
  62. adapter = editor.plugins.get( FileRepository ).createUploadAdapter( loader );
  63. } );
  64. it( 'crateAdapter method should be registered and have upload and abort methods', () => {
  65. expect( adapter ).to.not.be.undefined;
  66. expect( adapter.upload ).to.be.a( 'function' );
  67. expect( adapter.abort ).to.be.a( 'function' );
  68. } );
  69. it( 'should not set the FileRepository.createUploadAdapter factory if not configured', () => {
  70. const editorElement = document.createElement( 'div' );
  71. document.body.appendChild( editorElement );
  72. return ClassicTestEditor
  73. .create( editorElement, {
  74. plugins: [ SimpleUploadAdapter ],
  75. } )
  76. .then( editor => {
  77. const fileRepository = editor.plugins.get( FileRepository );
  78. expect( fileRepository ).to.not.have.property( 'createUploadAdapter' );
  79. editorElement.remove();
  80. return editor.destroy();
  81. } );
  82. } );
  83. it( 'should not set the FileRepository.createUploadAdapter factory if not configured properly', () => {
  84. const editorElement = document.createElement( 'div' );
  85. document.body.appendChild( editorElement );
  86. return ClassicTestEditor
  87. .create( editorElement, {
  88. plugins: [ SimpleUploadAdapter ],
  89. simpleUpload: {
  90. // Missing "uploadUrl".
  91. foo: 'bar'
  92. }
  93. } )
  94. .then( editor => {
  95. expect( logStub.callCount ).to.equal( 1 );
  96. expect( logStub.firstCall.args[ 0 ] ).to.match( /^simple-upload-adapter-missing-uploadUrl/ );
  97. const fileRepository = editor.plugins.get( FileRepository );
  98. expect( fileRepository ).to.not.have.property( 'createUploadAdapter' );
  99. editorElement.remove();
  100. return editor.destroy();
  101. } );
  102. } );
  103. describe( 'upload', () => {
  104. it( 'should return promise', () => {
  105. return loader.file
  106. .then( () => {
  107. expect( adapter.upload() ).to.be.instanceof( Promise );
  108. } );
  109. } );
  110. it( 'should call url from config', () => {
  111. let request;
  112. const validResponse = {
  113. url: 'http://example.com/images/image.jpeg'
  114. };
  115. const uploadPromise = adapter.upload();
  116. return loader.file
  117. .then( () => {
  118. request = sinonXHR.requests[ 0 ];
  119. request.respond( 200, { 'Content-Type': 'application/json' }, JSON.stringify( validResponse ) );
  120. expect( request.url ).to.equal( 'http://example.com' );
  121. return uploadPromise;
  122. } )
  123. .then( uploadResponse => {
  124. expect( uploadResponse ).to.be.a( 'object' );
  125. expect( uploadResponse ).to.have.property( 'default', 'http://example.com/images/image.jpeg' );
  126. } );
  127. } );
  128. it( 'should modify headers of uploading request if specified', () => {
  129. const editorElement = document.createElement( 'div' );
  130. document.body.appendChild( editorElement );
  131. return ClassicTestEditor
  132. .create( editorElement, {
  133. plugins: [ SimpleUploadAdapter ],
  134. simpleUpload: {
  135. uploadUrl: 'http://example.com',
  136. headers: {
  137. 'X-CSRF-TOKEN': 'foo',
  138. Authorization: 'Bearer <token>'
  139. }
  140. }
  141. } )
  142. .then( editor => {
  143. const adapter = editor.plugins.get( FileRepository ).createUploadAdapter( loader );
  144. const validResponse = {
  145. url: 'http://example.com/images/image.jpeg'
  146. };
  147. const uploadPromise = adapter.upload();
  148. return loader.file
  149. .then( () => {
  150. const request = sinonXHR.requests[ 0 ];
  151. request.respond( 200, { 'Content-Type': 'application/json' }, JSON.stringify( validResponse ) );
  152. const requestHeaders = request.requestHeaders;
  153. expect( requestHeaders ).to.be.a( 'object' );
  154. expect( requestHeaders ).to.have.property( 'X-CSRF-TOKEN', 'foo' );
  155. expect( requestHeaders ).to.have.property( 'Authorization', 'Bearer <token>' );
  156. return uploadPromise;
  157. } )
  158. .then( uploadResponse => {
  159. expect( uploadResponse ).to.be.a( 'object' );
  160. expect( uploadResponse ).to.have.property( 'default', 'http://example.com/images/image.jpeg' );
  161. editorElement.remove();
  162. } )
  163. .then( () => editor.destroy() );
  164. } );
  165. } );
  166. it( 'should throw an error on generic request error', () => {
  167. const promise = adapter.upload()
  168. .then( () => {
  169. throw new Error( 'Promise should throw.' );
  170. } )
  171. .catch( msg => {
  172. expect( msg ).to.equal( 'Couldn\'t upload file: image.jpeg.' );
  173. } );
  174. loader.file.then( () => {
  175. const request = sinonXHR.requests[ 0 ];
  176. request.error();
  177. } );
  178. return promise;
  179. } );
  180. it( 'should throw an error on error from server', () => {
  181. const responseError = {
  182. error: {
  183. message: 'Foo bar baz.'
  184. }
  185. };
  186. const promise = adapter.upload()
  187. .then( () => {
  188. throw new Error( 'Promise should throw.' );
  189. } )
  190. .catch( msg => {
  191. expect( msg ).to.equal( 'Foo bar baz.' );
  192. } );
  193. loader.file.then( () => {
  194. const request = sinonXHR.requests[ 0 ];
  195. request.respond( 200, { 'Content-Type': 'application/json' }, JSON.stringify( responseError ) );
  196. } );
  197. return promise;
  198. } );
  199. it( 'should throw a generic error on error from server without message', () => {
  200. const responseError = {
  201. error: {}
  202. };
  203. const promise = adapter.upload()
  204. .then( () => {
  205. throw new Error( 'Promise should throw.' );
  206. } )
  207. .catch( msg => {
  208. expect( msg ).to.equal( 'Couldn\'t upload file: image.jpeg.' );
  209. } );
  210. loader.file.then( () => {
  211. const request = sinonXHR.requests[ 0 ];
  212. request.respond( 200, { 'Content-Type': 'application/json' }, JSON.stringify( responseError ) );
  213. } );
  214. return promise;
  215. } );
  216. it( 'should throw an error on abort', () => {
  217. let request;
  218. const promise = adapter.upload()
  219. .then( () => {
  220. throw new Error( 'Promise should throw.' );
  221. } )
  222. .catch( () => {
  223. expect( request.aborted ).to.be.true;
  224. } );
  225. loader.file.then( () => {
  226. request = sinonXHR.requests[ 0 ];
  227. adapter.abort();
  228. } );
  229. return promise;
  230. } );
  231. it( 'abort should not throw before upload', () => {
  232. expect( () => {
  233. adapter.abort();
  234. } ).to.not.throw();
  235. } );
  236. it( 'should update progress', () => {
  237. adapter.upload();
  238. return loader.file.then( () => {
  239. const request = sinonXHR.requests[ 0 ];
  240. request.uploadProgress( { loaded: 4, total: 10 } );
  241. expect( loader.uploadTotal ).to.equal( 10 );
  242. expect( loader.uploaded ).to.equal( 4 );
  243. } );
  244. } );
  245. } );
  246. } );
  247. } );