Ghost/test/unit/frontend/helpers/asset.test.js
Simon Backx a051ab3b69
🎨 Reduced favicon requirements and added image formatting (#14918)
fixes https://github.com/TryGhost/Team/issues/1652
fixes https://github.com/TryGhost/Ghost/issues/13319

**Image formatting**
Added support for changing the format of images via the `handle-image-sizes` middleware (e.g. format SVG to png, jpeg, webp)

This change was required:
- Not all browsers support SVG favicons, so we need to convert them to PNGs
- We can't fit image resizing and formatting in the `serve-favicon` middleware: we need to store the resized image to avoid resizing on every request. This system was already present in the `handle-image-sizes` middleware.

To format an uploaded image:
- Original URL: https://localhost/blog/content/images/2022/05/giphy.gif
- To resize: https://localhost/blog/content/images/size/w256h256/2022/05/giphy.gif (already supported)
- To resize and format to webp: https://localhost/blog/content/images/size/w256h256/format/webp/2022/05/giphy.gif
- Animations are preserved when converting Gifs to Webp and in reverse, and also when only resizing (https://github.com/TryGhost/Ghost/issues/13319)

**Favicons**
- Custom favicons are no longer served via `/favicon.png` or `/favicon.ico` (only for default favicon), but use their full path
- Added support for uploading more image extensions in Ghost as a favicon: .jpg, .jpeg, .gif, .webp and .svg are now supported (already supported .png and .ico).
- File extensions other than jpg/jpeg, png, or ico will always get transformed to the image/png format to guarantee browser support (webp and svg images are not yet supported as favicons by all browsers).

For all image formats, other than .ico files:
- Allowed to upload images larger than 1000px in width and height, they will get cropped to 256x256px.
- Allowed uploading favicons that are not square. They will get cropped automatically.
- Allowed to upload larger files, up to 20MB (will get served at a lower file size after being resized)

For .svg files:
- The minimum size of 60x60px is no longer required.

For .ico files:
- The file size limit is increased to 200kb (coming from 100kb)
2022-05-27 16:36:53 +02:00

112 lines
4.0 KiB
JavaScript

// NOTE: the sole purpose of this suite is to test is it calls through to getAssetUrlHelper
// more complicated use cases are tested directly in asset_url.spec
const should = require('should');
const sinon = require('sinon');
const configUtils = require('../../../utils/configUtils');
const asset = require('../../../../core/frontend/helpers/asset');
const settingsCache = require('../../../../core/shared/settings-cache');
describe('{{asset}} helper', function () {
let rendered;
const localSettingsCache = {};
before(function () {
configUtils.set({assetHash: 'abc'});
configUtils.set({useMinFiles: true});
sinon.stub(settingsCache, 'get').callsFake(function (key) {
return localSettingsCache[key];
});
});
after(function () {
configUtils.restore();
sinon.restore();
});
describe('no subdirectory', function () {
it('handles favicon correctly', function () {
rendered = asset('favicon.ico');
should.exist(rendered);
String(rendered).should.equal('/favicon.ico');
});
it('handles ghost.css for default templates correctly', function () {
rendered = asset('public/ghost.css');
should.exist(rendered);
String(rendered).should.equal('/public/ghost.css?v=abc');
});
it('handles custom favicon correctly', function () {
// with png
localSettingsCache.icon = '/content/images/favicon.png';
rendered = asset('favicon.png');
should.exist(rendered);
String(rendered).should.equal('/content/images/size/w256h256/favicon.png');
// with ico
localSettingsCache.icon = '/content/images/favicon.ico';
rendered = asset('favicon.ico');
should.exist(rendered);
String(rendered).should.equal('/content/images/favicon.ico');
// with webp
localSettingsCache.icon = '/content/images/favicon.webp';
rendered = asset('favicon.png');
should.exist(rendered);
String(rendered).should.equal('/content/images/size/w256h256/format/png/favicon.webp');
// with svg
localSettingsCache.icon = '/content/images/favicon.svg';
rendered = asset('favicon.png');
should.exist(rendered);
String(rendered).should.equal('/content/images/size/w256h256/format/png/favicon.svg');
});
it('handles public assets correctly', function () {
localSettingsCache.icon = '';
rendered = asset('public/asset.js');
should.exist(rendered);
String(rendered).should.equal('/public/asset.js?v=abc');
});
it('handles theme assets correctly', function () {
rendered = asset('js/asset.js');
should.exist(rendered);
String(rendered).should.equal('/assets/js/asset.js?v=abc');
});
it('handles hasMinFile assets correctly', function () {
rendered = asset('js/asset.js', {hash: {hasMinFile: true}});
should.exist(rendered);
String(rendered).should.equal('/assets/js/asset.min.js?v=abc');
});
});
describe('different admin and site urls', function () {
before(function () {
configUtils.set({url: 'http://127.0.0.1'});
configUtils.set({'admin:url': 'http://localhost'});
});
after(function () {
configUtils.restore();
});
it('handles favicon correctly', function () {
rendered = asset('favicon.ico');
should.exist(rendered);
String(rendered).should.equal('http://127.0.0.1/favicon.ico');
});
it('handles ghost.css for default templates correctly', function () {
rendered = asset('public/ghost.css');
should.exist(rendered);
String(rendered).should.equal('http://127.0.0.1/public/ghost.css?v=abc');
});
});
});