mirror of
https://github.com/TryGhost/Ghost.git
synced 2025-04-01 02:41:39 -05:00
🐛 Fixed storing original files for images (#16117)
fixes https://github.com/TryGhost/Team/issues/481 This change fixes an issue when multiple images with the same name are uploaded in parallel. The current system does not guarantee that the original filename is stored under NAME+`_o`, because the upload for the original file and the resized file are happening in parallel. Solution: - Wait for the storage of the resized image (= the image without the _o suffix) before storing the original file. - When that is stored, use the generated file name of the stored image to generate the filename with the _o suffix. This way, it will always match and we don't risk both files to have a different number suffix. We'll also set the `targetDir` argument when saving the file, to avoid storing the original file in a different directory (when uploading a file around midnight both files could be stored in 2023/01 and 2023/02). Some extra optimisations needed with this fix: - Previously when uploading image.jpg, while it already exists, it would store two filenames on e.g., `image-3.jpg` and `image_o-3.jpg`. Note the weird positioning of `_o`. This probably caused bugs when uploading files named `image-3.jpg`, which would store the original in `image-3_o.jpg`, but this original would never be used by the handle-image-sizes middleware (it would look for `image_o-3.jpg`). This fix would solve this weird naming issue, and make it more consistent. But we need to make sure our middlewares (including handle-image-sizes) will be able to handle both file locations to remain compatible with the old format. This isn't additional work, because it would fix the old bug too. - Prevent uploading files that end with `_o`, e.g. by automatically stripping that suffix from uploaded files. To prevent collisions. Advantage(s): - We keep the original file name, which is better for SEO. - No changes required to the storage adapters. Downside(s): - The storage of both files will nog happen parallel any longer. But I expect the performance implications to be minimal. - Changes to the routing: normalize middleware is removed
This commit is contained in:
Simon Backx
GitHub
parent
4cdd12214b
commit
8e66edee2b
14 changed files with 504 additions and 221 deletions
|
|
@ -177,7 +177,7 @@ class RouterManager {
|
|||
|
||||
// NOTE: timezone change only affects the collection router with dated permalinks
|
||||
const collectionRouter = this.registry.getRouterByName('CollectionRouter');
|
||||
if (collectionRouter.getPermalinks().getValue().match(/:year|:month|:day/)) {
|
||||
if (collectionRouter && collectionRouter.getPermalinks().getValue().match(/:year|:month|:day/)) {
|
||||
debug('handleTimezoneEdit: trigger regeneration');
|
||||
|
||||
this.urlService.onRouterUpdated(collectionRouter.identifier);
|
||||
|
|
|
|||
|
|
@ -5,6 +5,7 @@ const imageTransform = require('@tryghost/image-transform');
|
|||
const storage = require('../../../server/adapters/storage');
|
||||
const activeTheme = require('../../services/theme-engine/active');
|
||||
const config = require('../../../shared/config');
|
||||
const {imageSize} = require('../../../server/lib/image');
|
||||
|
||||
const SIZE_PATH_REGEX = /^\/size\/([^/]+)\//;
|
||||
const FORMAT_PATH_REGEX = /^\/format\/([^./]+)\//;
|
||||
|
|
@ -21,7 +22,7 @@ module.exports = function (req, res, next) {
|
|||
}
|
||||
|
||||
const requestedDimension = req.url.match(SIZE_PATH_REGEX)[1];
|
||||
|
||||
|
||||
// Note that we don't use sizeImageDir because we need to keep the trailing slash
|
||||
let imagePath = req.url.replace(`/size/${requestedDimension}`, '');
|
||||
|
||||
|
|
@ -39,7 +40,7 @@ module.exports = function (req, res, next) {
|
|||
// We need to keep the first slash here
|
||||
let url = req.originalUrl
|
||||
.replace(`/size/${requestedDimension}`, '');
|
||||
|
||||
|
||||
if (format) {
|
||||
url = url.replace(`/format/${format}`, '');
|
||||
}
|
||||
|
|
@ -81,7 +82,7 @@ module.exports = function (req, res, next) {
|
|||
return redirectToOriginal();
|
||||
}
|
||||
|
||||
if (format) {
|
||||
if (format) {
|
||||
// CASE: When formatting, we need to check if the imageTransform package supports this specific format
|
||||
if (!imageTransform.canTransformToFormat(format)) {
|
||||
// transform not supported
|
||||
|
|
@ -89,7 +90,7 @@ module.exports = function (req, res, next) {
|
|||
}
|
||||
}
|
||||
|
||||
// CASE: when transforming is supported, we need to check if it is desired
|
||||
// CASE: when transforming is supported, we need to check if it is desired
|
||||
// (e.g. it is not desired to resize SVGs when not formatting them to a different type)
|
||||
if (!format && !imageTransform.shouldResizeFileExtension(requestUrlFileExtension)) {
|
||||
return redirectToOriginal();
|
||||
|
|
@ -111,23 +112,7 @@ module.exports = function (req, res, next) {
|
|||
return;
|
||||
}
|
||||
|
||||
const {dir, name, ext} = path.parse(imagePath);
|
||||
const [imageNameMatched, imageName, imageNumber] = name.match(/^(.+?)(-\d+)?$/) || [null];
|
||||
|
||||
if (!imageNameMatched) {
|
||||
// CASE: Image name does not contain any characters?
|
||||
// RESULT: Hand off to `next()` which will 404
|
||||
return;
|
||||
}
|
||||
const unoptimizedImagePath = path.join(dir, `${imageName}_o${imageNumber || ''}${ext}`);
|
||||
|
||||
return storageInstance.exists(unoptimizedImagePath)
|
||||
.then((unoptimizedImageExists) => {
|
||||
if (unoptimizedImageExists) {
|
||||
return unoptimizedImagePath;
|
||||
}
|
||||
return imagePath;
|
||||
})
|
||||
return imageSize.getOriginalImagePath(imagePath)
|
||||
.then((storagePath) => {
|
||||
return storageInstance.read({path: storagePath});
|
||||
})
|
||||
|
|
|
|||
|
|
@ -83,9 +83,19 @@ class LocalStorageBase extends StorageBase {
|
|||
urlToPath(url) {
|
||||
let filePath;
|
||||
|
||||
if (url.match(this.staticFileUrl)) {
|
||||
const prefix = urlUtils.urlJoin('/',
|
||||
urlUtils.getSubdir(),
|
||||
this.staticFileURLPrefix
|
||||
);
|
||||
|
||||
if (url.startsWith(this.staticFileUrl)) {
|
||||
// CASE: full path that includes the site url
|
||||
filePath = url.replace(this.staticFileUrl, '');
|
||||
filePath = path.join(this.storagePath, filePath);
|
||||
} else if (url.startsWith(prefix)) {
|
||||
// CASE: The result of the save method doesn't include the site url. So we need to handle this case.
|
||||
filePath = url.replace(prefix, '');
|
||||
filePath = path.join(this.storagePath, filePath);
|
||||
} else {
|
||||
throw new errors.IncorrectUsageError({
|
||||
message: tpl(messages.invalidUrlParameter, {url})
|
||||
|
|
|
|||
|
|
@ -1,19 +1,60 @@
|
|||
const Promise = require('bluebird');
|
||||
/* eslint-disable ghost/ghost-custom/max-api-complexity */
|
||||
const storage = require('../../adapters/storage');
|
||||
const imageTransform = require('@tryghost/image-transform');
|
||||
const config = require('../../../shared/config');
|
||||
const path = require('path');
|
||||
|
||||
module.exports = {
|
||||
docName: 'images',
|
||||
upload: {
|
||||
statusCode: 201,
|
||||
permissions: false,
|
||||
query(frame) {
|
||||
async query(frame) {
|
||||
const store = storage.getStorage('images');
|
||||
|
||||
if (frame.files) {
|
||||
return Promise
|
||||
.map(frame.files, file => store.save(file))
|
||||
.then(paths => paths[0]);
|
||||
// Normalize
|
||||
const imageOptimizationOptions = config.get('imageOptimization');
|
||||
|
||||
// Trim _o from file name (not allowed suffix)
|
||||
frame.file.name = frame.file.name.replace(/_o(\.\w+?)$/, '$1');
|
||||
|
||||
// CASE: image transform is not capable of transforming file (e.g. .gif)
|
||||
if (imageTransform.shouldResizeFileExtension(frame.file.ext) && imageOptimizationOptions.resize) {
|
||||
const out = `${frame.file.path}_processed`;
|
||||
const originalPath = frame.file.path;
|
||||
|
||||
const options = Object.assign({
|
||||
in: originalPath,
|
||||
out,
|
||||
ext: frame.file.ext,
|
||||
width: config.get('imageOptimization:defaultMaxWidth')
|
||||
}, imageOptimizationOptions);
|
||||
|
||||
await imageTransform.resizeFromPath(options);
|
||||
|
||||
// Store the processed/optimized image
|
||||
const processedImageUrl = await store.save({
|
||||
...frame.file,
|
||||
path: out
|
||||
});
|
||||
const processedImagePath = store.urlToPath(processedImageUrl);
|
||||
|
||||
// Get the path and name of the processed image
|
||||
// We want to store the original image on the same name + _o
|
||||
// So we need to wait for the first store to finish before generating the name of the original image
|
||||
const processedImageName = path.basename(processedImagePath);
|
||||
const processedImageDir = path.dirname(processedImagePath);
|
||||
|
||||
// Store the original image
|
||||
await store.save({
|
||||
...frame.file,
|
||||
path: originalPath,
|
||||
name: imageTransform.generateOriginalImageName(processedImageName)
|
||||
}, processedImageDir);
|
||||
|
||||
return processedImageUrl;
|
||||
}
|
||||
|
||||
return store.save(frame.file);
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -270,18 +270,36 @@ class ImageSize {
|
|||
});
|
||||
}
|
||||
|
||||
async getOriginalImageSizeFromStoragePath(imagePath) {
|
||||
/**
|
||||
* Returns the path of the original image for a given image path (we always store the original image in a separate file, suffixed with _o, while we store a resized version of the image on the original name)
|
||||
* TODO: Preferrably we want to move this to a separate image utils package. Currently not really a good place to put it in image lib.
|
||||
*/
|
||||
async getOriginalImagePath(imagePath) {
|
||||
const {dir, name, ext} = path.parse(imagePath);
|
||||
const storageInstance = this.storage.getStorage('images');
|
||||
|
||||
const preferredUnoptimizedImagePath = path.join(dir, `${name}_o${ext}`);
|
||||
const preferredUnoptimizedImagePathExists = await storageInstance.exists(preferredUnoptimizedImagePath);
|
||||
if (preferredUnoptimizedImagePathExists) {
|
||||
return preferredUnoptimizedImagePath;
|
||||
}
|
||||
|
||||
// Legacy format did some magic with the numbers that could cause bugs. We still need to support it for old files.
|
||||
// refs https://github.com/TryGhost/Team/issues/481
|
||||
const [imageNameMatched, imageName, imageNumber] = name.match(/^(.+?)(-\d+)?$/) || [null];
|
||||
|
||||
if (!imageNameMatched) {
|
||||
return this.getImageSizeFromStoragePath(imagePath);
|
||||
return imagePath;
|
||||
}
|
||||
|
||||
const originalImagePath = path.join(dir, `${imageName}_o${imageNumber || ''}${ext}`);
|
||||
const originalImageExists = await this.storage.getStorage('images').exists(originalImagePath);
|
||||
const legacyOriginalImagePath = path.join(dir, `${imageName}_o${imageNumber || ''}${ext}`);
|
||||
const legacyOriginalImageExists = await storageInstance.exists(legacyOriginalImagePath);
|
||||
|
||||
return this.getImageSizeFromStoragePath(originalImageExists ? originalImagePath : imagePath);
|
||||
return legacyOriginalImageExists ? legacyOriginalImagePath : imagePath;
|
||||
}
|
||||
|
||||
async getOriginalImageSizeFromStoragePath(imagePath) {
|
||||
return this.getImageSizeFromStoragePath(await this.getOriginalImagePath(imagePath));
|
||||
}
|
||||
|
||||
_getPathFromUrl(imageUrl) {
|
||||
|
|
|
|||
|
|
@ -240,7 +240,6 @@ module.exports = function apiRoutes() {
|
|||
mw.authAdminApi,
|
||||
apiMw.upload.single('file'),
|
||||
apiMw.upload.validation({type: 'images'}),
|
||||
apiMw.normalizeImage,
|
||||
http(api.images.upload)
|
||||
);
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,5 @@
|
|||
module.exports = {
|
||||
cors: require('./cors'),
|
||||
normalizeImage: require('./normalize-image'),
|
||||
updateUserLastSeen: require('./update-user-last-seen'),
|
||||
upload: require('./upload'),
|
||||
versionMatch: require('./version-match')
|
||||
|
|
|
|||
|
|
@ -1,42 +0,0 @@
|
|||
const cloneDeep = require('lodash/cloneDeep');
|
||||
const config = require('../../../../shared/config');
|
||||
const logging = require('@tryghost/logging');
|
||||
const imageTransform = require('@tryghost/image-transform');
|
||||
|
||||
module.exports = function normalize(req, res, next) {
|
||||
const imageOptimizationOptions = config.get('imageOptimization');
|
||||
|
||||
// CASE: image transform is not capable of transforming file (e.g. .gif)
|
||||
if (!imageTransform.shouldResizeFileExtension(req.file.ext) || !imageOptimizationOptions.resize) {
|
||||
return next();
|
||||
}
|
||||
|
||||
const out = `${req.file.path}_processed`;
|
||||
const originalPath = req.file.path;
|
||||
|
||||
const options = Object.assign({
|
||||
in: originalPath,
|
||||
out,
|
||||
ext: req.file.ext,
|
||||
width: config.get('imageOptimization:defaultMaxWidth')
|
||||
}, imageOptimizationOptions);
|
||||
|
||||
imageTransform.resizeFromPath(options)
|
||||
.then(() => {
|
||||
req.files = [];
|
||||
|
||||
// CASE: push the processed/optimized image
|
||||
req.files.push(Object.assign(req.file, {path: out}));
|
||||
|
||||
// CASE: push original image, we keep a copy of it
|
||||
const newName = imageTransform.generateOriginalImageName(req.file.name);
|
||||
req.files.push(Object.assign(cloneDeep(req.file), {path: originalPath, name: newName}));
|
||||
|
||||
next();
|
||||
})
|
||||
.catch((err) => {
|
||||
err.context = `${req.file.name} / ${req.file.type}`;
|
||||
logging.error(err);
|
||||
next();
|
||||
});
|
||||
};
|
||||
|
|
@ -212,6 +212,7 @@
|
|||
"eslint": "8.32.0",
|
||||
"expect": "^29.0.0",
|
||||
"html-validate": "7.13.1",
|
||||
"form-data": "^4.0.0",
|
||||
"inquirer": "8.2.5",
|
||||
"jwks-rsa": "3.0.1",
|
||||
"mocha": "10.2.0",
|
||||
|
|
|
|||
|
|
@ -0,0 +1,73 @@
|
|||
// Jest Snapshot v1, https://goo.gl/fbAQLP
|
||||
|
||||
exports[`Images API Can not upload a file without extension 1: [body] 1`] = `
|
||||
Object {
|
||||
"errors": Array [
|
||||
Object {
|
||||
"code": null,
|
||||
"context": null,
|
||||
"details": null,
|
||||
"ghostErrorCode": null,
|
||||
"help": null,
|
||||
"id": StringMatching /\\[a-f0-9\\]\\{8\\}-\\[a-f0-9\\]\\{4\\}-\\[a-f0-9\\]\\{4\\}-\\[a-f0-9\\]\\{4\\}-\\[a-f0-9\\]\\{12\\}/,
|
||||
"message": "Please select a valid image.",
|
||||
"property": null,
|
||||
"type": "UnsupportedMediaTypeError",
|
||||
},
|
||||
],
|
||||
}
|
||||
`;
|
||||
|
||||
exports[`Images API Can not upload a json file 1: [body] 1`] = `
|
||||
Object {
|
||||
"errors": Array [
|
||||
Object {
|
||||
"code": null,
|
||||
"context": null,
|
||||
"details": null,
|
||||
"ghostErrorCode": null,
|
||||
"help": null,
|
||||
"id": StringMatching /\\[a-f0-9\\]\\{8\\}-\\[a-f0-9\\]\\{4\\}-\\[a-f0-9\\]\\{4\\}-\\[a-f0-9\\]\\{4\\}-\\[a-f0-9\\]\\{12\\}/,
|
||||
"message": "Please select a valid image.",
|
||||
"property": null,
|
||||
"type": "UnsupportedMediaTypeError",
|
||||
},
|
||||
],
|
||||
}
|
||||
`;
|
||||
|
||||
exports[`Images API Can not upload a json file with image file extension 1: [body] 1`] = `
|
||||
Object {
|
||||
"errors": Array [
|
||||
Object {
|
||||
"code": null,
|
||||
"context": null,
|
||||
"details": null,
|
||||
"ghostErrorCode": null,
|
||||
"help": null,
|
||||
"id": StringMatching /\\[a-f0-9\\]\\{8\\}-\\[a-f0-9\\]\\{4\\}-\\[a-f0-9\\]\\{4\\}-\\[a-f0-9\\]\\{4\\}-\\[a-f0-9\\]\\{12\\}/,
|
||||
"message": "Please select a valid image.",
|
||||
"property": null,
|
||||
"type": "UnsupportedMediaTypeError",
|
||||
},
|
||||
],
|
||||
}
|
||||
`;
|
||||
|
||||
exports[`Images API Can not upload a json file with image mime type 1: [body] 1`] = `
|
||||
Object {
|
||||
"errors": Array [
|
||||
Object {
|
||||
"code": null,
|
||||
"context": null,
|
||||
"details": null,
|
||||
"ghostErrorCode": null,
|
||||
"help": null,
|
||||
"id": StringMatching /\\[a-f0-9\\]\\{8\\}-\\[a-f0-9\\]\\{4\\}-\\[a-f0-9\\]\\{4\\}-\\[a-f0-9\\]\\{4\\}-\\[a-f0-9\\]\\{12\\}/,
|
||||
"message": "Please select a valid image.",
|
||||
"property": null,
|
||||
"type": "UnsupportedMediaTypeError",
|
||||
},
|
||||
],
|
||||
}
|
||||
`;
|
||||
|
|
@ -1,87 +1,308 @@
|
|||
const path = require('path');
|
||||
const fs = require('fs-extra');
|
||||
const should = require('should');
|
||||
const supertest = require('supertest');
|
||||
const localUtils = require('./utils');
|
||||
const testUtils = require('../../utils');
|
||||
const {agentProvider, fixtureManager, matchers} = require('../../utils/e2e-framework');
|
||||
const FormData = require('form-data');
|
||||
const p = require('path');
|
||||
const {promises: fs, stat} = require('fs');
|
||||
const assert = require('assert');
|
||||
const config = require('../../../core/shared/config');
|
||||
const urlUtils = require('../../../core/shared/url-utils');
|
||||
const imageTransform = require('@tryghost/image-transform');
|
||||
const sinon = require('sinon');
|
||||
const storage = require('../../../core/server/adapters/storage');
|
||||
const sleep = require('../../utils/sleep');
|
||||
const {anyErrorId} = matchers;
|
||||
const {imageSize} = require('../../../core/server/lib/image');
|
||||
const configUtils = require('../../utils/configUtils');
|
||||
|
||||
const images = [];
|
||||
let agent, frontendAgent, ghostServer;
|
||||
/**
|
||||
*
|
||||
* @param {object} options
|
||||
* @param {Buffer} options.fileContents
|
||||
* @param {string} options.filename
|
||||
* @param {string} options.contentType
|
||||
* @param {string} [options.ref]
|
||||
* @returns
|
||||
*/
|
||||
const uploadImageRequest = ({fileContents, filename, contentType, ref}) => {
|
||||
const form = new FormData();
|
||||
form.append('file', fileContents, {
|
||||
filename,
|
||||
contentType
|
||||
});
|
||||
|
||||
form.append('purpose', 'image');
|
||||
if (ref) {
|
||||
form.append('ref', ref);
|
||||
}
|
||||
|
||||
return agent
|
||||
.post('/images/upload/')
|
||||
.body(form);
|
||||
};
|
||||
|
||||
/**
|
||||
*
|
||||
* @param {object} options
|
||||
* @param {string} options.path
|
||||
* @param {string} options.filename
|
||||
* @param {string} options.contentType
|
||||
* @param {string} [options.expectedFileName]
|
||||
* @param {string} [options.expectedOriginalFileName]
|
||||
* @param {string} [options.ref]
|
||||
* @param {boolean} [options.skipOriginal]
|
||||
* @returns
|
||||
*/
|
||||
const uploadImageCheck = async ({path, filename, contentType, expectedFileName, expectedOriginalFileName, ref, skipOriginal}) => {
|
||||
const fileContents = await fs.readFile(path);
|
||||
const {body} = await uploadImageRequest({fileContents, filename, contentType, ref}).expectStatus(201);
|
||||
expectedFileName = expectedFileName || filename;
|
||||
|
||||
assert.match(body.images[0].url, new RegExp(`${urlUtils.urlFor('home', true)}content/images/\\d+/\\d+/${expectedFileName}`));
|
||||
assert.equal(body.images[0].ref, ref);
|
||||
|
||||
const relativePath = body.images[0].url.replace(urlUtils.urlFor('home', true), '/');
|
||||
const filePath = config.getContentPath('images') + relativePath.replace('/content/images/', '');
|
||||
images.push(filePath);
|
||||
|
||||
// Get original image path
|
||||
const originalFilePath = skipOriginal ? filePath : (expectedOriginalFileName ? filePath.replace(expectedFileName, expectedOriginalFileName) : imageTransform.generateOriginalImageName(filePath));
|
||||
images.push(originalFilePath);
|
||||
|
||||
// Check the image is saved to disk
|
||||
const saved = await fs.readFile(originalFilePath);
|
||||
assert.equal(saved.length, fileContents.length);
|
||||
assert.deepEqual(saved, fileContents);
|
||||
|
||||
const savedResized = await fs.readFile(filePath);
|
||||
assert.ok(savedResized.length <= fileContents.length); // should always be smaller
|
||||
|
||||
// Check the image is served in the frontend using the provided URL
|
||||
const {body: data} = await frontendAgent
|
||||
.get(relativePath)
|
||||
//.expect('Content-Length', savedResized.length.toString()) // not working for SVG for some reason?
|
||||
.expect('Content-Type', contentType)
|
||||
.expect(200);
|
||||
assert.equal(Buffer.from(data).length, savedResized.length);
|
||||
|
||||
// Make sure we support w10
|
||||
configUtils.set('imageOptimization:contentImageSizes', {
|
||||
w10: {width: 10},
|
||||
w1: {width: 1}
|
||||
});
|
||||
|
||||
// Check if image resizing and formatting works
|
||||
const resizedPath = relativePath.replace('/content/images/', '/content/images/size/w10/format/webp/');
|
||||
await frontendAgent
|
||||
.get(resizedPath)
|
||||
.expect('Content-Type', 'image/webp')
|
||||
.expect(200);
|
||||
|
||||
const resizedFilePath = filePath.replace('/images/', '/images/size/w10/format/webp/');
|
||||
const size = await imageSize.getImageSizeFromPath(resizedFilePath);
|
||||
assert.equal(size.width, 10, 'Resized images should have a width that has actually changed');
|
||||
|
||||
if (!contentType.includes('svg')) {
|
||||
// Check if image resizing without formatting works
|
||||
const resizedPath2 = relativePath.replace('/content/images/', '/content/images/size/w1/');
|
||||
await frontendAgent
|
||||
.get(resizedPath2)
|
||||
.expect('Content-Type', contentType)
|
||||
.expect(200);
|
||||
|
||||
const resizedFilePath2 = filePath.replace('/images/', '/images/size/w1/');
|
||||
const size2 = await imageSize.getImageSizeFromPath(resizedFilePath2);
|
||||
|
||||
// Note: we chose width 1 because the resized image bytes should be less or it is ignored
|
||||
assert.equal(size2.width, 1, 'Resized images should have a width that has actually changed');
|
||||
}
|
||||
|
||||
return {
|
||||
relativePath,
|
||||
filePath,
|
||||
originalFilePath,
|
||||
fileContents
|
||||
};
|
||||
};
|
||||
|
||||
describe('Images API', function () {
|
||||
const images = [];
|
||||
let request;
|
||||
|
||||
before(async function () {
|
||||
await localUtils.startGhost();
|
||||
request = supertest.agent(config.get('url'));
|
||||
await localUtils.doAuth(request);
|
||||
const agents = await agentProvider.getAgentsWithFrontend();
|
||||
agent = agents.adminAgent;
|
||||
frontendAgent = agents.frontendAgent;
|
||||
ghostServer = agents.ghostServer;
|
||||
await fixtureManager.init();
|
||||
await agent.loginAsOwner();
|
||||
});
|
||||
|
||||
after(function () {
|
||||
images.forEach(function (image) {
|
||||
fs.removeSync(config.get('paths').appRoot + image);
|
||||
});
|
||||
configUtils.restore();
|
||||
ghostServer.stop();
|
||||
});
|
||||
|
||||
afterEach(async function () {
|
||||
// Delete all images after each test
|
||||
for (const image of images) {
|
||||
try {
|
||||
await fs.unlink(image);
|
||||
} catch (e) {
|
||||
// ignore
|
||||
}
|
||||
}
|
||||
|
||||
// Clean
|
||||
images.splice(0, images.length);
|
||||
sinon.restore();
|
||||
});
|
||||
|
||||
it('Can upload a png', async function () {
|
||||
const res = await request.post(localUtils.API.getApiQuery('images/upload'))
|
||||
.set('Origin', config.get('url'))
|
||||
.expect('Content-Type', /json/)
|
||||
.field('purpose', 'image')
|
||||
.field('ref', 'https://ghost.org/ghost-logo.png')
|
||||
.attach('file', path.join(__dirname, '/../../utils/fixtures/images/ghost-logo.png'))
|
||||
.expect(201);
|
||||
|
||||
res.body.images[0].url.should.match(new RegExp(`${config.get('url')}/content/images/\\d+/\\d+/ghost-logo.png`));
|
||||
res.body.images[0].ref.should.equal('https://ghost.org/ghost-logo.png');
|
||||
images.push(res.body.images[0].url.replace(config.get('url'), ''));
|
||||
const originalFilePath = p.join(__dirname, '/../../utils/fixtures/images/ghost-logo.png');
|
||||
await uploadImageCheck({path: originalFilePath, filename: 'ghost-logo.png', contentType: 'image/png', ref: 'https://ghost.org/ghost-logo.png'});
|
||||
});
|
||||
|
||||
it('Can upload a jpg', async function () {
|
||||
const res = await request.post(localUtils.API.getApiQuery('images/upload'))
|
||||
.set('Origin', config.get('url'))
|
||||
.expect('Content-Type', /json/)
|
||||
.attach('file', path.join(__dirname, '/../../utils/fixtures/images/ghosticon.jpg'))
|
||||
.expect(201);
|
||||
|
||||
res.body.images[0].url.should.match(new RegExp(`${config.get('url')}/content/images/\\d+/\\d+/ghosticon.jpg`));
|
||||
should(res.body.images[0].ref).equal(null);
|
||||
|
||||
images.push(res.body.images[0].url.replace(config.get('url'), ''));
|
||||
const originalFilePath = p.join(__dirname, '/../../utils/fixtures/images/ghosticon.jpg');
|
||||
await uploadImageCheck({path: originalFilePath, filename: 'ghosticon.jpg', contentType: 'image/jpeg'});
|
||||
});
|
||||
|
||||
it('Can upload a gif', async function () {
|
||||
const res = await request.post(localUtils.API.getApiQuery('images/upload'))
|
||||
.set('Origin', config.get('url'))
|
||||
.expect('Content-Type', /json/)
|
||||
.attach('file', path.join(__dirname, '/../../utils/fixtures/images/loadingcat.gif'))
|
||||
.expect(201);
|
||||
|
||||
res.body.images[0].url.should.match(new RegExp(`${config.get('url')}/content/images/\\d+/\\d+/loadingcat.gif`));
|
||||
|
||||
images.push(res.body.images[0].url.replace(config.get('url'), ''));
|
||||
const originalFilePath = p.join(__dirname, '/../../utils/fixtures/images/loadingcat.gif');
|
||||
await uploadImageCheck({path: originalFilePath, filename: 'loadingcat.gif', contentType: 'image/gif'});
|
||||
});
|
||||
|
||||
it('Can upload a webp', async function () {
|
||||
const res = await request.post(localUtils.API.getApiQuery('images/upload'))
|
||||
.set('Origin', config.get('url'))
|
||||
.expect('Content-Type', /json/)
|
||||
.attach('file', path.join(__dirname, '/../../utils/fixtures/images/ghosticon.webp'))
|
||||
.expect(201);
|
||||
const originalFilePath = p.join(__dirname, '/../../utils/fixtures/images/ghosticon.webp');
|
||||
await uploadImageCheck({path: originalFilePath, filename: 'ghosticon.webp', contentType: 'image/webp'});
|
||||
});
|
||||
|
||||
res.body.images[0].url.should.match(new RegExp(`${config.get('url')}/content/images/\\d+/\\d+/ghosticon.webp`));
|
||||
|
||||
images.push(res.body.images[0].url.replace(config.get('url'), ''));
|
||||
it('Can upload a svg', async function () {
|
||||
const originalFilePath = p.join(__dirname, '/../../utils/fixtures/images/ghost-logo.svg');
|
||||
await uploadImageCheck({path: originalFilePath, filename: 'ghost.svg', contentType: 'image/svg+xml', skipOriginal: true});
|
||||
});
|
||||
|
||||
it('Can upload a square profile image', async function () {
|
||||
const res = await request.post(localUtils.API.getApiQuery('images/upload'))
|
||||
.set('Origin', config.get('url'))
|
||||
.expect('Content-Type', /json/)
|
||||
.attach('file', path.join(__dirname, '/../../utils/fixtures/images/loadingcat_square.gif'))
|
||||
.expect(201);
|
||||
const originalFilePath = p.join(__dirname, '/../../utils/fixtures/images/loadingcat_square.gif');
|
||||
await uploadImageCheck({path: originalFilePath, filename: 'loadingcat_square.gif', contentType: 'image/gif'});
|
||||
});
|
||||
|
||||
res.body.images[0].url.should.match(new RegExp(`${config.get('url')}/content/images/\\d+/\\d+/loadingcat_square.gif`));
|
||||
it('Can not upload a json file', async function () {
|
||||
const originalFilePath = p.join(__dirname, '/../../utils/fixtures/data/redirects.json');
|
||||
const fileContents = await fs.readFile(originalFilePath);
|
||||
await uploadImageRequest({fileContents, filename: 'redirects.json', contentType: 'application/json'})
|
||||
.expectStatus(415)
|
||||
.matchBodySnapshot({
|
||||
errors: [{
|
||||
id: anyErrorId
|
||||
}]
|
||||
});
|
||||
});
|
||||
|
||||
images.push(res.body.images[0].url.replace(config.get('url'), ''));
|
||||
it('Can not upload a file without extension', async function () {
|
||||
const originalFilePath = p.join(__dirname, '/../../utils/fixtures/data/redirects.json');
|
||||
const fileContents = await fs.readFile(originalFilePath);
|
||||
await uploadImageRequest({fileContents, filename: 'redirects', contentType: 'image/png'})
|
||||
.expectStatus(415)
|
||||
.matchBodySnapshot({
|
||||
errors: [{
|
||||
id: anyErrorId
|
||||
}]
|
||||
});
|
||||
});
|
||||
|
||||
it('Can not upload a json file with image mime type', async function () {
|
||||
const originalFilePath = p.join(__dirname, '/../../utils/fixtures/data/redirects.json');
|
||||
const fileContents = await fs.readFile(originalFilePath);
|
||||
await uploadImageRequest({fileContents, filename: 'redirects.json', contentType: 'image/gif'})
|
||||
.expectStatus(415)
|
||||
.matchBodySnapshot({
|
||||
errors: [{
|
||||
id: anyErrorId
|
||||
}]
|
||||
});
|
||||
});
|
||||
|
||||
it('Can not upload a json file with image file extension', async function () {
|
||||
const originalFilePath = p.join(__dirname, '/../../utils/fixtures/data/redirects.json');
|
||||
const fileContents = await fs.readFile(originalFilePath);
|
||||
await uploadImageRequest({fileContents, filename: 'redirects.png', contentType: 'application/json'})
|
||||
.expectStatus(415)
|
||||
.matchBodySnapshot({
|
||||
errors: [{
|
||||
id: anyErrorId
|
||||
}]
|
||||
});
|
||||
});
|
||||
|
||||
it('Can upload multiple images with the same name', async function () {
|
||||
const originalFilePath = p.join(__dirname, '/../../utils/fixtures/images/ghost-logo.png');
|
||||
const originalFilePath2 = p.join(__dirname, '/../../utils/fixtures/images/ghosticon.jpg');
|
||||
|
||||
await uploadImageCheck({path: originalFilePath, filename: 'a.png', contentType: 'image/png'});
|
||||
await uploadImageCheck({path: originalFilePath2, filename: 'a.png', contentType: 'image/png', expectedFileName: 'a-1.png', expectedOriginalFileName: 'a-1_o.png'});
|
||||
});
|
||||
|
||||
it('Can upload image with number suffix', async function () {
|
||||
const originalFilePath = p.join(__dirname, '/../../utils/fixtures/images/ghost-logo.png');
|
||||
await uploadImageCheck({path: originalFilePath, filename: 'a-2.png', contentType: 'image/png'});
|
||||
});
|
||||
|
||||
it('Trims _o suffix from uploaded files', async function () {
|
||||
const originalFilePath = p.join(__dirname, '/../../utils/fixtures/images/ghost-logo.png');
|
||||
await uploadImageCheck({path: originalFilePath, filename: 'a-3_o.png', contentType: 'image/png', expectedFileName: 'a-3.png', expectedOriginalFileName: 'a-3_o.png'});
|
||||
});
|
||||
|
||||
it('Can use _o in uploaded file name, as long as it is not at the end', async function () {
|
||||
const originalFilePath = p.join(__dirname, '/../../utils/fixtures/images/ghost-logo.png');
|
||||
await uploadImageCheck({path: originalFilePath, filename: 'a_o-3.png', contentType: 'image/png', expectedFileName: 'a_o-3.png', expectedOriginalFileName: 'a_o-3_o.png'});
|
||||
});
|
||||
|
||||
it('Can upload multiple images with the same name in parallel', async function () {
|
||||
const originalFilePath = p.join(__dirname, '/../../utils/fixtures/images/ghost-logo.png');
|
||||
const originalFilePath2 = p.join(__dirname, '/../../utils/fixtures/images/ghosticon.jpg');
|
||||
|
||||
// Delay the first original file upload by 400ms to force race condition
|
||||
const store = storage.getStorage('images');
|
||||
const saveStub = sinon.stub(store, 'save');
|
||||
let calls = 0;
|
||||
saveStub.callsFake(async function (file) {
|
||||
if (file.name.includes('_o')) {
|
||||
calls += 1;
|
||||
if (calls === 1) {
|
||||
await sleep(400);
|
||||
}
|
||||
}
|
||||
return saveStub.wrappedMethod.call(this, ...arguments);
|
||||
});
|
||||
const firstPromise = uploadImageCheck({path: originalFilePath, filename: 'a.png', contentType: 'image/png'});
|
||||
await sleep(10);
|
||||
|
||||
await Promise.all([
|
||||
firstPromise,
|
||||
uploadImageCheck({path: originalFilePath2, filename: 'a.png', contentType: 'image/png', expectedFileName: 'a-1.png'})
|
||||
]);
|
||||
});
|
||||
|
||||
it('Can upload around midnight of month change', async function () {
|
||||
const clock = sinon.useFakeTimers({now: new Date(2022, 0, 31, 23, 59, 59), shouldAdvanceTime: true});
|
||||
assert.equal(new Date().getMonth(), 0);
|
||||
|
||||
const originalFilePath = p.join(__dirname, '/../../utils/fixtures/images/ghost-logo.png');
|
||||
|
||||
// Delay the first original file upload by 400ms to force race condition
|
||||
const store = storage.getStorage('images');
|
||||
const saveStub = sinon.stub(store, 'save');
|
||||
let calls = 0;
|
||||
saveStub.callsFake(async function (file) {
|
||||
if (file.name.includes('_o')) {
|
||||
calls += 1;
|
||||
if (calls === 1) {
|
||||
clock.tick(5000);
|
||||
assert.equal(new Date().getMonth(), 1);
|
||||
}
|
||||
}
|
||||
return saveStub.wrappedMethod.call(this, ...arguments);
|
||||
});
|
||||
await uploadImageCheck({path: originalFilePath, filename: 'a.png', contentType: 'image/png'});
|
||||
clock.restore();
|
||||
});
|
||||
});
|
||||
|
|
|
|||
|
|
@ -118,7 +118,11 @@ describe('Posts API', function () {
|
|||
};
|
||||
|
||||
await agent
|
||||
.post('/posts/?formats=mobiledoc,lexical,html')
|
||||
.post('/posts/?formats=mobiledoc,lexical,html', {
|
||||
headers: {
|
||||
'content-type': 'application/json'
|
||||
}
|
||||
})
|
||||
.body({posts: [post]})
|
||||
.expectStatus(201)
|
||||
.matchBodySnapshot({
|
||||
|
|
|
|||
|
|
@ -1,82 +0,0 @@
|
|||
const should = require('should');
|
||||
const sinon = require('sinon');
|
||||
const configUtils = require('../../../../../utils/configUtils');
|
||||
const imageTransform = require('@tryghost/image-transform');
|
||||
const logging = require('@tryghost/logging');
|
||||
const normalize = require('../../../../../../core/server/web/api/middleware/normalize-image');
|
||||
|
||||
describe('normalize', function () {
|
||||
let res;
|
||||
let req;
|
||||
|
||||
beforeEach(function () {
|
||||
req = {
|
||||
file: {
|
||||
name: 'test',
|
||||
path: '/test/path',
|
||||
ext: '.jpg'
|
||||
}
|
||||
};
|
||||
|
||||
sinon.stub(imageTransform, 'resizeFromPath');
|
||||
sinon.stub(logging, 'error');
|
||||
});
|
||||
|
||||
afterEach(async function () {
|
||||
sinon.restore();
|
||||
await configUtils.restore();
|
||||
});
|
||||
|
||||
it('should do manipulation by default', function (done) {
|
||||
imageTransform.resizeFromPath.resolves();
|
||||
|
||||
normalize(req, res, function () {
|
||||
imageTransform.resizeFromPath.calledOnce.should.be.true();
|
||||
done();
|
||||
});
|
||||
});
|
||||
|
||||
it('should add files array to request object with original and resized files', function (done) {
|
||||
imageTransform.resizeFromPath.resolves();
|
||||
|
||||
normalize(req, res, function () {
|
||||
req.files.length.should.be.equal(2);
|
||||
done();
|
||||
});
|
||||
});
|
||||
|
||||
it('should not do manipulation without resize flag set', function (done) {
|
||||
configUtils.set({
|
||||
imageOptimization: {
|
||||
resize: false
|
||||
}
|
||||
});
|
||||
|
||||
normalize(req, res, function () {
|
||||
imageTransform.resizeFromPath.called.should.be.false();
|
||||
done();
|
||||
});
|
||||
});
|
||||
|
||||
it('should not create files array when resizing fails', function (done) {
|
||||
imageTransform.resizeFromPath.rejects();
|
||||
|
||||
normalize(req, res, () => {
|
||||
logging.error.calledOnce.should.be.true();
|
||||
req.file.should.not.be.equal(undefined);
|
||||
should.not.exist(req.files);
|
||||
done();
|
||||
});
|
||||
});
|
||||
|
||||
['.svg', '.svgz'].forEach(function (extension) {
|
||||
it(`should skip resizing when file extension is ${extension}`, function (done) {
|
||||
req.file.ext = extension;
|
||||
normalize(req, res, function () {
|
||||
req.file.should.not.be.equal(undefined);
|
||||
should.not.exist(req.files);
|
||||
done();
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
56
ghost/core/test/utils/fixtures/images/ghost-logo.svg
Normal file
56
ghost/core/test/utils/fixtures/images/ghost-logo.svg
Normal file
|
|
@ -0,0 +1,56 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- Generator: Adobe Illustrator 16.2.1, SVG Export Plug-In . SVG Version: 6.00 Build 0) -->
|
||||
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
|
||||
<svg version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
|
||||
width="671.98px" height="288px" viewBox="0 0 671.98 288" enable-background="new 0 0 671.98 288" xml:space="preserve">
|
||||
<g id="Background">
|
||||
<g id="Block">
|
||||
<rect fill="#E8E9EB" width="671.98" height="288"/>
|
||||
</g>
|
||||
</g>
|
||||
<g id="Logo">
|
||||
<g>
|
||||
<g opacity="0.7">
|
||||
<rect x="112.197" y="168.302" fill="#3D515B" width="31.703" height="15.852"/>
|
||||
<rect x="159.75" y="168.302" fill="#3D515B" width="31.683" height="15.852"/>
|
||||
<rect x="112.173" y="136.599" fill="#3D515B" width="79.27" height="15.852"/>
|
||||
<rect x="112.197" y="104.898" fill="#3D515B" width="47.559" height="15.851"/>
|
||||
<rect x="175.602" y="104.898" fill="#3D515B" width="15.851" height="15.851"/>
|
||||
</g>
|
||||
<g>
|
||||
<path fill="#404041" d="M421.575,104.807c-25.458,0-38.606,18.003-38.606,40.211c0,22.209,12.824,40.214,38.606,40.214
|
||||
s38.606-18.005,38.606-40.214C460.182,122.81,447.032,104.807,421.575,104.807z M440.835,145.09L440.835,145.09
|
||||
c-0.018,14.281-4.83,25.848-19.26,25.848s-19.243-11.566-19.258-25.848l0,0c0-0.012,0-0.023,0-0.035s0-0.023,0-0.036l0,0
|
||||
c0.015-14.28,4.829-25.846,19.259-25.846c14.429,0,19.241,11.566,19.259,25.846l0,0c0,0.013,0,0.024,0,0.036
|
||||
S440.835,145.078,440.835,145.09z"/>
|
||||
<path fill="#404041" d="M307.584,184.153V72.975c0,0,14.664-2.083,15.801-2.236c1.288-0.174,2.998,0.743,2.998,2.556
|
||||
c0,1.985,0,41.214,0,41.214c3.043-2.893,6.394-5.225,10.046-7.002c3.655-1.775,7.941-2.664,12.865-2.664
|
||||
c4.263,0,8.04,0.723,11.338,2.17c3.3,1.444,6.053,3.476,8.26,6.087c2.207,2.615,3.882,5.735,5.024,9.363
|
||||
c1.141,3.628,1.712,7.624,1.712,11.988v49.701h-18.8v-49.701c0-4.769-1.104-8.461-3.311-11.076
|
||||
c-2.208-2.612-5.519-3.919-9.935-3.919c-3.247,0-6.29,0.736-9.13,2.209c-2.843,1.472-5.532,3.474-8.069,6.013v56.475H307.584z"/>
|
||||
<path fill="#404041" d="M558.565,185.224c-12.937,0-21.045-7.529-21.045-21.575v-41.628h-14.58c0,0,3.099-10.718,3.344-11.562
|
||||
c0.246-0.843,0.887-1.749,2.174-1.928s9.044-1.261,9.044-1.261l3.583-22.794c0,0,10.527-1.484,12.196-1.733
|
||||
c1.576-0.236,3.005,0.899,3.005,2.616c0,1.715,0,21.911,0,21.911h18.44v14.751h-18.44v41.067c0,5.607,3.414,7.75,6.686,7.75
|
||||
c2,0,4.739-1.062,6.783-2.01c1.263-0.584,3.22-0.151,3.726,1.612c0.447,1.562,2.824,9.853,2.824,9.853
|
||||
C574.254,181.617,567.771,185.224,558.565,185.224z"/>
|
||||
<path fill="#404041" d="M512.609,122.267c-3.664-1.19-10.551-3.095-17.102-3.095c-6.675,0-11.927,2.306-11.927,7.856
|
||||
c0,6.932,11.319,8.95,19.067,11.776c5.18,1.889,19.071,5.572,19.071,20.512c0,18.148-15.071,25.907-31.148,25.907
|
||||
c-16.079,0-25.578-5.98-25.578-5.98s2.494-8.81,2.999-10.549c0.457-1.565,2.276-2.114,3.435-1.669
|
||||
c4.138,1.595,11.61,3.812,20.056,3.812c8.551,0,12.688-2.611,12.688-8.177c0-7.408-11.547-9.672-19.184-12.081
|
||||
c-5.261-1.658-19.186-5.525-19.186-21.956c0-16.186,14.213-23.78,29.403-23.78c12.858,0,19.165,2.689,23.876,5.089
|
||||
c0,0-2.625,9.149-3.015,10.512C515.604,122.064,514.275,122.807,512.609,122.267z"/>
|
||||
<path fill="#404041" d="M300.245,107.523c0-1.751-1.496-2.753-2.923-2.59c-6.309,0.723-10.81,3.692-13.722,6.456
|
||||
c-5.718-4.48-13.655-6.619-22.563-6.619c-17.86,0-31.814,8.62-31.814,27.416c0,10.79,4.593,18.225,11.887,22.602
|
||||
c-5.417,2.564-9.025,8.005-9.025,13.354c0,8.948,7.069,11.75,7.069,11.75s-12.36,5.999-12.36,18.001
|
||||
c0,15.364,14.139,21.576,31.416,21.576c24.904,0,42.038-10.286,42.038-29.173c0-11.624-8.895-18.041-28.279-18.804
|
||||
c-11.503-0.454-18.954-0.868-20.8-1.479c-2.439-0.81-3.638-2.763-3.638-4.919c0-2.38,1.955-4.646,5.037-6.202
|
||||
c2.688,0.476,5.525,0.711,8.471,0.711c17.875,0,31.815-8.595,31.815-27.416c0-4.564-0.824-8.526-2.322-11.911
|
||||
c2.626-1.401,5.857-2.387,9.715-2.387C300.245,117.889,300.245,109.12,300.245,107.523z M251.026,184.25
|
||||
c0,0,9.379,0.355,18.751,0.789c10.529,0.487,13.81,2.756,13.81,8.208c0,6.661-9.15,13.14-21.937,13.14
|
||||
c-12.138,0-18.201-4.223-18.201-11.254C243.449,191.099,245.579,186.586,251.026,184.25z M261.071,146.483
|
||||
c-8.461,0-15.062-4.494-15.062-14.297c0-9.804,6.607-14.298,15.062-14.298c8.456,0,15.062,4.482,15.062,14.298
|
||||
S269.535,146.483,261.071,146.483z"/>
|
||||
</g>
|
||||
</g>
|
||||
</g>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 4.3 KiB |
Loading…
Add table
Reference in a new issue