simpleuploadadapter.js 9.2 KB

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