simpleuploadadapter.js 9.1 KB

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