TryGhost/Ghost
1
0
Fork 0
mirror of https://github.com/TryGhost/Ghost.git synced 2024-11-30 21:40:39 +03:00
Code Issues Projects Releases Wiki Activity

Cleaner, clearer more consistent API

Browse Source 
- we have 2 methods, one to resize a buffer and one to resize a file path
- make these two things super clear!
This commit is contained in:
Hannah Wolfe 2020-03-25 12:53:33 +00:00
parent 54d3527b14
commit 264ffeceef
2 changed files with 39 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
ghost/image-transform/lib/transform.js
View File

@ -3,16 +3,18 @@ const errors = require('@tryghost/errors');
const fs = require('fs-extra');
/**
* @NOTE: Sharp cannot operate on the same image path, that's why we have to use in & out paths.
*
* We currently can't enable compression or having more config options, because of
* https://github.com/lovell/sharp/issues/1360.
*/
const unsafeProcess = (options = {}) => {
* @NOTE: Sharp cannot operate on the same image path, that's why we have to use in & out paths.
*
* We currently can't enable compression or having more config options, because of
* https://github.com/lovell/sharp/issues/1360.
*
* Resize an image referenced by the `in` path and write it to the `out` path
* @param {{in, out, width}} options
*/
const unsafeResizeFromPath = (options = {}) => {
return fs.readFile(options.in)
.then((data) => {
return unsafeResizeImage(data, {
return unsafeResizeFromBuffer(data, {
width: options.width
});
})
@ -21,7 +23,14 @@ const unsafeProcess = (options = {}) => {
});
};
const unsafeResizeImage = (originalBuffer, {width, height} = {}) => {
/**
* Resize an image
*
* @param {Buffer} originalBuffer image to resize
* @param {{width, height}} options
* @returns {Buffer} the resizedBuffer
*/
const unsafeResizeFromBuffer = (originalBuffer, {width, height} = {}) => {
const sharp = require('sharp');
return sharp(originalBuffer)
.resize(width, height, {
@ -36,12 +45,22 @@ const unsafeResizeImage = (originalBuffer, {width, height} = {}) => {
});
};
// NOTE: .gif optimization is currently not supported by sharp but will be soon
// as there has been support added in underlying libvips library https://github.com/lovell/sharp/issues/1372
// As for .svg files, sharp only supports conversion to png, and this does not
// play well with animated svg files
/**
* Check if this tool can handle a particular extension
* NOTE: .gif optimization is currently not supported by sharp but will be soon
* as there has been support added in underlying libvips library https://github.com/lovell/sharp/issues/1372
* As for .svg files, sharp only supports conversion to png, and this does not
* play well with animated svg files
* @param {String} ext the extension to check, including the leading dot
*/
const canTransformFileExtension = ext => !['.gif', '.svg', '.svgz', '.ico'].includes(ext);
/**
* Internal utility to wrap all transform functions in error handling
* Allows us to keep Sharp as an optional dependency
*
* @param {Function} fn
*/
const makeSafe = fn => (...args) => {
try {
require('sharp');
@ -62,5 +81,5 @@ const makeSafe = fn => (...args) => {
};
module.exports.canTransformFileExtension = canTransformFileExtension;
module.exports.process = makeSafe(unsafeProcess);
module.exports.resizeImage = makeSafe(unsafeResizeImage);
module.exports.resizeFromPath = makeSafe(unsafeResizeFromPath);
module.exports.resizeFromBuffer = makeSafe(unsafeResizeFromBuffer);

10
ghost/image-transform/test/transform.test.js
View File

@ -61,7 +61,7 @@ describe('Transform', function () {
it('resize image', function () {
sharpInstance.toBuffer.resolves('manipulated');
return transform.process({width: 1000})
return transform.resizeFromPath({width: 1000})
.then(() => {
sharpInstance.resize.calledOnce.should.be.true();
sharpInstance.rotate.calledOnce.should.be.true();
@ -74,7 +74,7 @@ describe('Transform', function () {
it('skip resizing if image is too small', function () {
sharpInstance.toBuffer.resolves('manipulated');
return transform.process({width: 1000})
return transform.resizeFromPath({width: 1000})
.then(() => {
sharpInstance.resize.calledOnce.should.be.true();
should.deepEqual(sharpInstance.resize.args[0][2], {
@ -89,7 +89,7 @@ describe('Transform', function () {
it('uses original image as an output when the size (bytes) is bigger after manipulation', function () {
sharpInstance.toBuffer.resolves('manipulated to a very very very very very very very large size');
return transform.process({width: 1000})
return transform.resizeFromPath({width: 1000})
.then(() => {
sharpInstance.resize.calledOnce.should.be.true();
sharpInstance.rotate.calledOnce.should.be.true();
@ -105,7 +105,7 @@ describe('Transform', function () {
fs.writeFile.rejects(new Error('whoops'));
return transform.process({width: 2000})
return transform.resizeFromPath({width: 2000})
.then(() => {
'1'.should.eql(1, 'Expected to fail');
})
@ -122,7 +122,7 @@ describe('Transform', function () {
});
it('sharp was not installed', function () {
return transform.process()
return transform.resizeFromPath()
.then(() => {
'1'.should.eql(1, 'Expected to fail');
})