Skip to content
This repository has been archived by the owner on Jun 26, 2020. It is now read-only.

Commit

Permalink
Merge pull request #98 from ckeditor/t/97
Browse files Browse the repository at this point in the history
Feature: Implemented the responsive image support in the `SimpleUploadAdapter`. Closes #97.
  • Loading branch information
jodator committed Aug 1, 2019
2 parents 83d552f + 4e2f287 commit b5092a4
Show file tree
Hide file tree
Showing 3 changed files with 52 additions and 14 deletions.
31 changes: 24 additions & 7 deletions docs/features/simple-upload-adapter.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,15 +87,32 @@ The [`responseType`](https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpReq

### Successful upload

If the upload is successful, the server should return an object containing the `url` property which points out to the uploaded image on the server:
If the upload is successful, the server should either return:

```json
{
"url": "https://example.com/images/foo.jpg"
}
```
* an object containing the `url` property which points out to the uploaded image on the server:

```json
{
"url": "https://example.com/images/foo.jpg"
}
```

* an object with the `urls` property, if you want to use [responsive images](https://developer.mozilla.org/en-US/docs/Learn/HTML/Multimedia_and_embedding/Responsive_images) and the server supports it:

```json
{
"urls": {
"default": "https://example.com/images/foo.jpg",
"800": "https://example.com/images/foo-800.jpg",
"1024": "https://example.com/images/foo-1024.jpg",
"1920": "https://example.com/images/foo-1920.jpg"
}
}
```

The `"default"` URL will be used in the `src` attribute of the image in the editor content. Other URLs will be used in the `srcset` attribute allowing the web browser to select the best one for the geometry of the viewport.

That image URL is essential because it will be used:
URL(s) in the server response are used:

* to display the image during the editing (as seen by the user in the editor),
* in the editor content {@link builds/guides/integration/saving-data saved to the databse}.
Expand Down
4 changes: 1 addition & 3 deletions src/adapters/simpleuploadadapter.js
Original file line number Diff line number Diff line change
Expand Up @@ -176,9 +176,7 @@ class Adapter {
return reject( response && response.error && response.error.message ? response.error.message : genericErrorText );
}

resolve( {
default: response.url
} );
resolve( response.url ? { default: response.url } : response.urls );
} );

// Upload progress when it is supported.
Expand Down
31 changes: 27 additions & 4 deletions tests/adapters/simpleuploadadapter.js
Original file line number Diff line number Diff line change
Expand Up @@ -136,8 +136,7 @@ describe( 'SimpleUploadAdapter', () => {
} );
} );

it( 'should call url from config', () => {
let request;
it( 'should send a request to config#uploadUrl', () => {
const validResponse = {
url: 'http:https://example.com/images/image.jpeg'
};
Expand All @@ -146,7 +145,7 @@ describe( 'SimpleUploadAdapter', () => {

return loader.file
.then( () => {
request = sinonXHR.requests[ 0 ];
const request = sinonXHR.requests[ 0 ];
request.respond( 200, { 'Content-Type': 'application/json' }, JSON.stringify( validResponse ) );

expect( request.url ).to.equal( 'http:https://example.com' );
Expand All @@ -159,7 +158,31 @@ describe( 'SimpleUploadAdapter', () => {
} );
} );

it( 'should modify headers of uploading request if specified', () => {
it( 'should support responsive image URLs returned in the server response', () => {
const validResponse = {
urls: {
default: 'http:https://example.com/images/image.jpeg',
'120': 'http:https://example.com/images/image-120.jpeg',
'240': 'http:https://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 use config#headers in the request (when specified)', () => {
const editorElement = document.createElement( 'div' );
document.body.appendChild( editorElement );

Expand Down

0 comments on commit b5092a4

Please sign in to comment.