simpleuploadadapter.js 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454
  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. describe( 'using public feature configuration', () => {
  112. it( 'should send a request to config#uploadUrl', () => {
  113. const validResponse = {
  114. url: 'http://example.com/images/image.jpeg'
  115. };
  116. const uploadPromise = adapter.upload();
  117. return loader.file
  118. .then( () => {
  119. const request = sinonXHR.requests[ 0 ];
  120. request.respond( 200, { 'Content-Type': 'application/json' }, JSON.stringify( validResponse ) );
  121. expect( request.url ).to.equal( 'http://example.com' );
  122. return uploadPromise;
  123. } )
  124. .then( uploadResponse => {
  125. expect( uploadResponse ).to.be.a( 'object' );
  126. expect( uploadResponse ).to.have.property( 'default', 'http://example.com/images/image.jpeg' );
  127. } );
  128. } );
  129. it( 'should use config#headers in the request (when specified)', () => {
  130. const editorElement = document.createElement( 'div' );
  131. document.body.appendChild( editorElement );
  132. return ClassicTestEditor
  133. .create( editorElement, {
  134. plugins: [ SimpleUploadAdapter ],
  135. simpleUpload: {
  136. uploadUrl: 'http://example.com',
  137. headers: {
  138. 'X-CSRF-TOKEN': 'foo',
  139. Authorization: 'Bearer <token>'
  140. }
  141. }
  142. } )
  143. .then( editor => {
  144. const adapter = editor.plugins.get( FileRepository ).createUploadAdapter( loader );
  145. const validResponse = {
  146. url: 'http://example.com/images/image.jpeg'
  147. };
  148. const uploadPromise = adapter.upload();
  149. return loader.file
  150. .then( () => {
  151. const request = sinonXHR.requests[ 0 ];
  152. request.respond( 200, { 'Content-Type': 'application/json' }, JSON.stringify( validResponse ) );
  153. const requestHeaders = request.requestHeaders;
  154. expect( requestHeaders ).to.be.a( 'object' );
  155. expect( requestHeaders ).to.have.property( 'X-CSRF-TOKEN', 'foo' );
  156. expect( requestHeaders ).to.have.property( 'Authorization', 'Bearer <token>' );
  157. return uploadPromise;
  158. } )
  159. .then( uploadResponse => {
  160. expect( uploadResponse ).to.be.a( 'object' );
  161. expect( uploadResponse ).to.have.property( 'default', 'http://example.com/images/image.jpeg' );
  162. editorElement.remove();
  163. } )
  164. .then( () => editor.destroy() );
  165. } );
  166. } );
  167. it( 'should not set #requestHeaders of the request if config#headers is not specified', () => {
  168. const editorElement = document.createElement( 'div' );
  169. document.body.appendChild( editorElement );
  170. return ClassicTestEditor
  171. .create( editorElement, {
  172. plugins: [ SimpleUploadAdapter ],
  173. simpleUpload: {
  174. uploadUrl: 'http://example.com'
  175. }
  176. } )
  177. .then( editor => {
  178. const adapter = editor.plugins.get( FileRepository ).createUploadAdapter( loader );
  179. const validResponse = {
  180. url: 'http://example.com/images/image.jpeg'
  181. };
  182. const uploadPromise = adapter.upload();
  183. return loader.file
  184. .then( () => {
  185. const request = sinonXHR.requests[ 0 ];
  186. request.respond( 200, { 'Content-Type': 'application/json' }, JSON.stringify( validResponse ) );
  187. const requestHeaders = request.requestHeaders;
  188. expect( requestHeaders ).to.be.a( 'object' );
  189. expect( requestHeaders ).to.be.empty;
  190. return uploadPromise;
  191. } )
  192. .then( uploadResponse => {
  193. expect( uploadResponse ).to.be.a( 'object' );
  194. expect( uploadResponse ).to.have.property( 'default', 'http://example.com/images/image.jpeg' );
  195. editorElement.remove();
  196. } )
  197. .then( () => editor.destroy() );
  198. } );
  199. } );
  200. it( 'should use config#withCredentials in the request (when specified)', () => {
  201. const editorElement = document.createElement( 'div' );
  202. document.body.appendChild( editorElement );
  203. return ClassicTestEditor
  204. .create( editorElement, {
  205. plugins: [ SimpleUploadAdapter ],
  206. simpleUpload: {
  207. uploadUrl: 'http://example.com',
  208. withCredentials: true
  209. }
  210. } )
  211. .then( editor => {
  212. const adapter = editor.plugins.get( FileRepository ).createUploadAdapter( loader );
  213. const validResponse = {
  214. url: 'http://example.com/images/image.jpeg'
  215. };
  216. const uploadPromise = adapter.upload();
  217. return loader.file
  218. .then( () => {
  219. const request = sinonXHR.requests[ 0 ];
  220. request.respond( 200, { 'Content-Type': 'application/json' }, JSON.stringify( validResponse ) );
  221. expect( request ).to.have.property( 'withCredentials', true );
  222. return uploadPromise;
  223. } )
  224. .then( uploadResponse => {
  225. expect( uploadResponse ).to.be.a( 'object' );
  226. expect( uploadResponse ).to.have.property( 'default', 'http://example.com/images/image.jpeg' );
  227. editorElement.remove();
  228. } )
  229. .then( () => editor.destroy() );
  230. } );
  231. } );
  232. it( 'should not set #withCredentials of the request if config#withCredentials is not set', () => {
  233. const editorElement = document.createElement( 'div' );
  234. document.body.appendChild( editorElement );
  235. return ClassicTestEditor
  236. .create( editorElement, {
  237. plugins: [ SimpleUploadAdapter ],
  238. simpleUpload: {
  239. uploadUrl: 'http://example.com'
  240. }
  241. } )
  242. .then( editor => {
  243. const adapter = editor.plugins.get( FileRepository ).createUploadAdapter( loader );
  244. const validResponse = {
  245. url: 'http://example.com/images/image.jpeg'
  246. };
  247. const uploadPromise = adapter.upload();
  248. return loader.file
  249. .then( () => {
  250. const request = sinonXHR.requests[ 0 ];
  251. request.respond( 200, { 'Content-Type': 'application/json' }, JSON.stringify( validResponse ) );
  252. expect( request ).to.have.property( 'withCredentials', false );
  253. return uploadPromise;
  254. } )
  255. .then( uploadResponse => {
  256. expect( uploadResponse ).to.be.a( 'object' );
  257. expect( uploadResponse ).to.have.property( 'default', 'http://example.com/images/image.jpeg' );
  258. editorElement.remove();
  259. } )
  260. .then( () => editor.destroy() );
  261. } );
  262. } );
  263. } );
  264. it( 'should support responsive image URLs returned in the server response', () => {
  265. const validResponse = {
  266. urls: {
  267. default: 'http://example.com/images/image.jpeg',
  268. '120': 'http://example.com/images/image-120.jpeg',
  269. '240': 'http://example.com/images/image-240.jpeg'
  270. }
  271. };
  272. const uploadPromise = adapter.upload();
  273. return loader.file
  274. .then( () => {
  275. sinonXHR.requests[ 0 ].respond( 200, {
  276. 'Content-Type': 'application/json'
  277. }, JSON.stringify( validResponse ) );
  278. return uploadPromise;
  279. } )
  280. .then( uploadResponse => {
  281. expect( uploadResponse ).to.deep.equal( validResponse.urls );
  282. } );
  283. } );
  284. it( 'should throw on a generic request error', () => {
  285. const promise = adapter.upload()
  286. .then( () => {
  287. throw new Error( 'Promise should throw.' );
  288. } )
  289. .catch( msg => {
  290. expect( msg ).to.equal( 'Couldn\'t upload file: image.jpeg.' );
  291. } );
  292. loader.file.then( () => {
  293. const request = sinonXHR.requests[ 0 ];
  294. request.error();
  295. } );
  296. return promise;
  297. } );
  298. it( 'should throw on an error from server', () => {
  299. const responseError = {
  300. error: {
  301. message: 'Foo bar baz.'
  302. }
  303. };
  304. const promise = adapter.upload()
  305. .then( () => {
  306. throw new Error( 'Promise should throw.' );
  307. } )
  308. .catch( msg => {
  309. expect( msg ).to.equal( 'Foo bar baz.' );
  310. } );
  311. loader.file.then( () => {
  312. const request = sinonXHR.requests[ 0 ];
  313. request.respond( 200, { 'Content-Type': 'application/json' }, JSON.stringify( responseError ) );
  314. } );
  315. return promise;
  316. } );
  317. it( 'should throw a generic error on an error from server without a message', () => {
  318. const responseError = {
  319. error: {}
  320. };
  321. const promise = adapter.upload()
  322. .then( () => {
  323. throw new Error( 'Promise should throw.' );
  324. } )
  325. .catch( msg => {
  326. expect( msg ).to.equal( 'Couldn\'t upload file: image.jpeg.' );
  327. } );
  328. loader.file.then( () => {
  329. const request = sinonXHR.requests[ 0 ];
  330. request.respond( 200, { 'Content-Type': 'application/json' }, JSON.stringify( responseError ) );
  331. } );
  332. return promise;
  333. } );
  334. it( 'should throw an error on abort()', () => {
  335. let request;
  336. const promise = adapter.upload()
  337. .then( () => {
  338. throw new Error( 'Promise should throw.' );
  339. } )
  340. .catch( () => {
  341. expect( request.aborted ).to.be.true;
  342. } );
  343. loader.file.then( () => {
  344. request = sinonXHR.requests[ 0 ];
  345. adapter.abort();
  346. } );
  347. return promise;
  348. } );
  349. it( 'abort() should not throw before upload', () => {
  350. expect( () => {
  351. adapter.abort();
  352. } ).to.not.throw();
  353. } );
  354. it( 'should update progress', () => {
  355. adapter.upload();
  356. return loader.file.then( () => {
  357. const request = sinonXHR.requests[ 0 ];
  358. request.uploadProgress( { loaded: 4, total: 10 } );
  359. expect( loader.uploadTotal ).to.equal( 10 );
  360. expect( loader.uploaded ).to.equal( 4 );
  361. } );
  362. } );
  363. } );
  364. } );
  365. } );