Infrastructure/ghost
0
Fork 0
mirror of https://github.com/TryGhost/Ghost.git synced 2025-02-03 23:00:14 -05:00
Code Issues Activity

Swapped common for @tryghost/errors in core/server/web

Browse source 
- Update all references to common.errors to use @tryghost/errors
- Use dereferencing to only require used bits of common in each file
This commit is contained in:
Hannah Wolfe 2020-04-09 19:40:00 +01:00
parent 1ffdef98c3
commit 4f5fb3d820
18 changed files with 102 additions and 91 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
core/server/web/admin/controller.js
View file

@ -2,7 +2,7 @@ const debug = require('ghost-ignition').debug('web:admin:controller');
const path = require('path');
const config = require('../../config');
const updateCheck = require('../../update-check');
const common = require('../../lib/common');
const {logging} = require('../../lib/common');
/**
* @description Admin controller to handle /ghost/ requests.
@ -18,7 +18,7 @@ module.exports = function adminController(req, res) {
// CASE: trigger update check unit and let it run in background, don't block the admin rendering
updateCheck()
.catch((err) => {
common.logging.error(err);
logging.error(err);
});
const defaultTemplate = config.get('env') === 'production' ? 'default-prod.html' : 'default.html';

7
core/server/web/api/canary/admin/middleware.js
View file

@ -1,4 +1,5 @@
const common = require('../../../../lib/common');
const errors = require('@tryghost/errors');
const {i18n} = require('../../../../lib/common');
const auth = require('../../../../services/auth');
const shared = require('../../../shared');
@ -38,9 +39,9 @@ const notImplemented = function (req, res, next) {
}
}
next(new common.errors.GhostError({
next(new errors.GhostError({
errorType: 'NotImplementedError',
message: common.i18n.t('errors.api.common.notImplemented'),
message: i18n.t('errors.api.common.notImplemented'),
statusCode: '501'
}));
};

8
core/server/web/api/v2/admin/middleware.js
View file

@ -1,4 +1,5 @@
const common = require('../../../../lib/common');
const errors = require('@tryghost/errors');
const {i18n} = require('../../../../lib/common');
const auth = require('../../../../services/auth');
const shared = require('../../../shared');
@ -35,9 +36,9 @@ const notImplemented = function (req, res, next) {
}
}
next(new common.errors.GhostError({
next(new errors.GhostError({
errorType: 'NotImplementedError',
message: common.i18n.t('errors.api.common.notImplemented'),
message: i18n.t('errors.api.common.notImplemented'),
statusCode: '501'
}));
};
@ -78,4 +79,3 @@ module.exports.publicAdminApi = [
shared.middlewares.prettyUrls,
notImplemented
];

45
core/server/web/shared/middlewares/api/spam-prevention.js
View file

@ -1,8 +1,9 @@
const moment = require('moment');
const extend = require('lodash/extend');
const pick = require('lodash/pick');
const errors = require('@tryghost/errors');
const config = require('../../../../config');
const common = require('../../../../lib/common');
const {logging,i18n} = require('../../../../lib/common');
const spam = config.get('spam') || {};
const spamPrivateBlog = spam.private_blog || {};
@ -24,7 +25,7 @@ let contentApiKeyInstance;
const spamConfigKeys = ['freeRetries', 'minWait', 'maxWait', 'lifetime'];
const handleStoreError = (err) => {
const customError = new common.errors.InternalServerError({
const customError = new errors.InternalServerError({
message: 'Unknown error',
err: err.parent ? err.parent : err
});
@ -34,7 +35,7 @@ const handleStoreError = (err) => {
// we are using reset as synchronous call, so we have to log the error if it occurs
// there is no way to try/catch, because the reset operation happens asynchronous
if (!err.next) {
common.logging.error(err);
logging.error(err);
return;
}
@ -60,11 +61,11 @@ const globalBlock = () => {
extend({
attachResetToRequest: false,
failCallback(req, res, next, nextValidRequestDate) {
return next(new common.errors.TooManyRequestsError({
return next(new errors.TooManyRequestsError({
message: `Too many attempts try again in ${moment(nextValidRequestDate).fromNow(true)}`,
context: common.i18n.t('errors.middleware.spamprevention.forgottenPasswordIp.error',
context: i18n.t('errors.middleware.spamprevention.forgottenPasswordIp.error',
{rfa: spamGlobalBlock.freeRetries + 1 || 5, rfp: spamGlobalBlock.lifetime || 60 * 60}),
help: common.i18n.t('errors.middleware.spamprevention.tooManyAttempts')
help: i18n.t('errors.middleware.spamprevention.tooManyAttempts')
}));
},
handleStoreError: handleStoreError
@ -90,11 +91,11 @@ const globalReset = () => {
attachResetToRequest: false,
failCallback(req, res, next, nextValidRequestDate) {
// TODO use i18n again
return next(new common.errors.TooManyRequestsError({
return next(new errors.TooManyRequestsError({
message: `Too many attempts try again in ${moment(nextValidRequestDate).fromNow(true)}`,
context: common.i18n.t('errors.middleware.spamprevention.forgottenPasswordIp.error',
context: i18n.t('errors.middleware.spamprevention.forgottenPasswordIp.error',
{rfa: spamGlobalReset.freeRetries + 1 || 5, rfp: spamGlobalReset.lifetime || 60 * 60}),
help: common.i18n.t('errors.middleware.spamprevention.forgottenPasswordIp.context')
help: i18n.t('errors.middleware.spamprevention.forgottenPasswordIp.context')
}));
},
handleStoreError: handleStoreError
@ -123,11 +124,11 @@ const userLogin = () => {
extend({
attachResetToRequest: true,
failCallback(req, res, next, nextValidRequestDate) {
return next(new common.errors.TooManyRequestsError({
return next(new errors.TooManyRequestsError({
message: `Too many sign-in attempts try again in ${moment(nextValidRequestDate).fromNow(true)}`,
// TODO add more options to i18n
context: common.i18n.t('errors.middleware.spamprevention.tooManySigninAttempts.context'),
help: common.i18n.t('errors.middleware.spamprevention.tooManySigninAttempts.context')
context: i18n.t('errors.middleware.spamprevention.tooManySigninAttempts.context'),
help: i18n.t('errors.middleware.spamprevention.tooManySigninAttempts.context')
}));
},
handleStoreError: handleStoreError
@ -155,11 +156,11 @@ const userReset = function userReset() {
extend({
attachResetToRequest: true,
failCallback(req, res, next, nextValidRequestDate) {
return next(new common.errors.TooManyRequestsError({
return next(new errors.TooManyRequestsError({
message: `Too many password reset attempts try again in ${moment(nextValidRequestDate).fromNow(true)}`,
context: common.i18n.t('errors.middleware.spamprevention.forgottenPasswordEmail.error',
context: i18n.t('errors.middleware.spamprevention.forgottenPasswordEmail.error',
{rfa: spamUserReset.freeRetries + 1 || 5, rfp: spamUserReset.lifetime || 60 * 60}),
help: common.i18n.t('errors.middleware.spamprevention.forgottenPasswordEmail.context')
help: i18n.t('errors.middleware.spamprevention.forgottenPasswordEmail.context')
}));
},
handleStoreError: handleStoreError
@ -186,16 +187,16 @@ const privateBlog = () => {
extend({
attachResetToRequest: false,
failCallback(req, res, next, nextValidRequestDate) {
common.logging.error(new common.errors.TooManyRequestsError({
message: common.i18n.t('errors.middleware.spamprevention.tooManySigninAttempts.error',
logging.error(new errors.TooManyRequestsError({
message: i18n.t('errors.middleware.spamprevention.tooManySigninAttempts.error',
{
rateSigninAttempts: spamPrivateBlog.freeRetries + 1 || 5,
rateSigninPeriod: spamPrivateBlog.lifetime || 60 * 60
}),
context: common.i18n.t('errors.middleware.spamprevention.tooManySigninAttempts.context')
context: i18n.t('errors.middleware.spamprevention.tooManySigninAttempts.context')
}));
return next(new common.errors.TooManyRequestsError({
return next(new errors.TooManyRequestsError({
message: `Too many private sign-in attempts try again in ${moment(nextValidRequestDate).fromNow(true)}`
}));
},
@ -215,11 +216,11 @@ const contentApiKey = () => {
extend({
attachResetToRequest: true,
failCallback(req, res, next) {
const err = new common.errors.TooManyRequestsError({
message: common.i18n.t('errors.middleware.spamprevention.tooManyAttempts')
const err = new errors.TooManyRequestsError({
message: i18n.t('errors.middleware.spamprevention.tooManyAttempts')
});
common.logging.error(err);
logging.error(err);
return next(err);
},
handleStoreError: handleStoreError

7
core/server/web/shared/middlewares/api/version-match.js
View file

@ -1,5 +1,6 @@
const semver = require('semver');
const common = require('../../../../lib/common');
const errors = require('@tryghost/errors');
const {i18n} = require('../../../../lib/common');
function checkVersionMatch(req, res, next) {
const clientVersion = req.get('X-Ghost-Version');
@ -12,8 +13,8 @@ function checkVersionMatch(req, res, next) {
// always error when the major version is different
if (clientVersion && !semver.satisfies(serverVersion, constraint)) {
return next(new common.errors.VersionMismatchError({
message: common.i18n.t('errors.middleware.api.versionMismatch', {
return next(new errors.VersionMismatchError({
message: i18n.t('errors.middleware.api.versionMismatch', {
clientVersion: clientVersion,
serverVersion: serverVersion
})

11
core/server/web/shared/middlewares/custom-redirects.js
View file

@ -4,7 +4,8 @@ const url = require('url');
const path = require('path');
const debug = require('ghost-ignition').debug('web:shared:mw:custom-redirects');
const config = require('../../../config');
const common = require('../../../lib/common');
const errors = require('@tryghost/errors');
const {logging, i18n} = require('../../../lib/common');
const redirectsService = require('../../../../frontend/services/redirects');
const _private = {};
@ -66,11 +67,11 @@ _private.registerRoutes = () => {
});
});
} catch (err) {
if (common.errors.utils.isIgnitionError(err)) {
common.logging.error(err);
if (errors.utils.isIgnitionError(err)) {
logging.error(err);
} else if (err.code !== 'ENOENT') {
common.logging.error(new common.errors.IncorrectUsageError({
message: common.i18n.t('errors.middleware.redirects.register'),
logging.error(new errors.IncorrectUsageError({
message: i18n.t('errors.middleware.redirects.register'),
context: err.message,
help: 'https://ghost.org/docs/api/handlebars-themes/routing/redirects/'
}));

4
core/server/web/shared/middlewares/emit-events.js
View file

@ -1,10 +1,10 @@
const common = require('../../../lib/common');
const {events} = require('../../../lib/common');
const INVALIDATE_ALL = '/*';
module.exports = function emitEvents(req, res, next) {
res.on('finish', function triggerEvents() {
if (res.get('X-Cache-Invalidate') === INVALIDATE_ALL) {
common.events.emit('site.changed');
events.emit('site.changed');
}
res.removeListener('finish', triggerEvents);

27
core/server/web/shared/middlewares/error-handler.js
View file

@ -1,8 +1,9 @@
const hbs = require('express-hbs');
const _ = require('lodash');
const debug = require('ghost-ignition').debug('error-handler');
const errors = require('@tryghost/errors');
const config = require('../../../config');
const common = require('../../../lib/common');
const {i18n} = require('../../../lib/common');
const helpers = require('../../../../frontend/services/routing/helpers');
const sentry = require('../../../sentry');
@ -33,23 +34,23 @@ _private.prepareError = (err, req, res, next) => {
err = err[0];
}
if (!common.errors.utils.isIgnitionError(err)) {
if (!errors.utils.isIgnitionError(err)) {
// We need a special case for 404 errors
// @TODO look at adding this to the GhostError class
if (err.statusCode && err.statusCode === 404) {
err = new common.errors.NotFoundError({
err = new errors.NotFoundError({
err: err
});
} else if (err instanceof TypeError && err.stack.match(/node_modules\/handlebars\//)) {
// Temporary handling of theme errors from handlebars
// @TODO remove this when #10496 is solved properly
err = new common.errors.IncorrectUsageError({
err = new errors.IncorrectUsageError({
err: err,
message: '{{#if}} or {{#unless}} helper is malformed',
statusCode: err.statusCode
});
} else {
err = new common.errors.GhostError({
err = new errors.GhostError({
err: err,
message: err.message,
statusCode: err.statusCode
@ -102,8 +103,8 @@ _private.prepareUserMessage = (err, res) => {
destroy: 'delete'
};
if (common.i18n.doesTranslationKeyExist(`common.api.actions.${docName}.${method}`)) {
action = common.i18n.t(`common.api.actions.${docName}.${method}`);
if (i18n.doesTranslationKeyExist(`common.api.actions.${docName}.${method}`)) {
action = i18n.t(`common.api.actions.${docName}.${method}`);
} else if (Object.keys(actionMap).includes(method)) {
let resource = docName;
@ -121,7 +122,7 @@ _private.prepareUserMessage = (err, res) => {
userError.context = err.message;
}
userError.message = common.i18n.t(`errors.api.userMessages.${err.name}`, {action: action});
userError.message = i18n.t(`errors.api.userMessages.${err.name}`, {action: action});
}
}
@ -145,10 +146,10 @@ _private.JSONErrorRendererV2 = (err, req, res, next) => { // eslint-disable-line
});
};
_private.ErrorFallbackMessage = err => `<h1>${common.i18n.t('errors.errors.oopsErrorTemplateHasError')}</h1>
<p>${common.i18n.t('errors.errors.encounteredError')}</p>
_private.ErrorFallbackMessage = err => `<h1>${i18n.t('errors.errors.oopsErrorTemplateHasError')}</h1>
<p>${i18n.t('errors.errors.encounteredError')}</p>
<pre>${escapeExpression(err.message || err)}</pre>
<br ><p>${common.i18n.t('errors.errors.whilstTryingToRender')}</p>
<br ><p>${i18n.t('errors.errors.whilstTryingToRender')}</p>
${err.statusCode} <pre>${escapeExpression(err.message || err)}</pre>`;
_private.ThemeErrorRenderer = (err, req, res, next) => {
@ -238,11 +239,11 @@ _private.BasicErrorRenderer = (err, req, res, next) => { // eslint-disable-line
errorHandler.resourceNotFound = (req, res, next) => {
// TODO, handle unknown resources & methods differently, so that we can also produce
// 405 Method Not Allowed
next(new common.errors.NotFoundError({message: common.i18n.t('errors.errors.resourceNotFound')}));
next(new errors.NotFoundError({message: i18n.t('errors.errors.resourceNotFound')}));
};
errorHandler.pageNotFound = (req, res, next) => {
next(new common.errors.NotFoundError({message: common.i18n.t('errors.errors.pageNotFound')}));
next(new errors.NotFoundError({message: i18n.t('errors.errors.pageNotFound')}));
};
errorHandler.handleJSONResponse = [

4
core/server/web/shared/middlewares/labs.js
View file

@ -1,11 +1,11 @@
const errors = require('@tryghost/errors');
const labsUtil = require('../../../services/labs');
const common = require('../../../lib/common');
const labs = flag => (req, res, next) => {
if (labsUtil.isSet(flag) === true) {
return next();
} else {
return next(new common.errors.NotFoundError());
return next(new errors.NotFoundError());
}
};

6
core/server/web/shared/middlewares/log-request.js
View file

@ -1,4 +1,4 @@
const common = require('../../../lib/common');
const {logging} = require('../../../lib/common');
/**
* @TODO: move this middleware to ignition?
@ -11,9 +11,9 @@ module.exports = function logRequest(req, res, next) {
req.userId = req.user ? (req.user.id ? req.user.id : req.user) : null;
if (req.err && req.err.statusCode !== 404) {
common.logging.error({req: req, res: res, err: req.err});
logging.error({req: req, res: res, err: req.err});
} else {
common.logging.info({req: req, res: res});
logging.info({req: req, res: res});
}
res.removeListener('finish', logResponse);

11
core/server/web/shared/middlewares/maintenance.js
View file

@ -1,17 +1,18 @@
const errors = require('@tryghost/errors');
const config = require('../../../config');
const common = require('../../../lib/common');
const {i18n} = require('../../../lib/common');
const urlService = require('../../../../frontend/services/url');
module.exports = function maintenance(req, res, next) {
if (config.get('maintenance').enabled) {
return next(new common.errors.MaintenanceError({
message: common.i18n.t('errors.general.maintenance')
return next(new errors.MaintenanceError({
message: i18n.t('errors.general.maintenance')
}));
}
if (!urlService.hasFinished()) {
return next(new common.errors.MaintenanceError({
message: common.i18n.t('errors.general.maintenanceUrlService')
return next(new errors.MaintenanceError({
message: i18n.t('errors.general.maintenanceUrlService')
}));
}

7
core/server/web/shared/middlewares/serve-public-file.js
View file

@ -1,9 +1,10 @@
const crypto = require('crypto');
const fs = require('fs-extra');
const path = require('path');
const errors = require('@tryghost/errors');
const config = require('../../../config');
const urlUtils = require('../../../lib/url-utils');
const common = require('../../../lib/common');
const {i18n} = require('../../../lib/common');
function createPublicFileMiddleware(file, type, maxAge) {
let content;
@ -23,8 +24,8 @@ function createPublicFileMiddleware(file, type, maxAge) {
return res.sendFile(filePath, (err) => {
if (err && err.status === 404) {
// ensure we're triggering basic asset 404 and not a templated 404
return next(new common.errors.NotFoundError({
message: common.i18n.t('errors.errors.imageNotFound'),
return next(new errors.NotFoundError({
message: i18n.t('errors.errors.imageNotFound'),
code: 'STATIC_FILE_NOT_FOUND',
property: err.path
}));

7
core/server/web/shared/middlewares/uncapitalise.js
View file

@ -12,8 +12,9 @@
// req.baseUrl = /blog
// req.path = /ghost/signin/
const errors = require('@tryghost/errors');
const urlUtils = require('../../../lib/url-utils');
const common = require('../../../lib/common');
const {i18n} = require('../../../lib/common');
const localUtils = require('../utils');
const uncapitalise = (req, res, next) => {
@ -36,8 +37,8 @@ const uncapitalise = (req, res, next) => {
try {
decodedURI = decodeURIComponent(pathToTest);
} catch (err) {
return next(new common.errors.NotFoundError({
message: common.i18n.t('errors.errors.pageNotFound'),
return next(new errors.NotFoundError({
message: i18n.t('errors.errors.pageNotFound'),
err: err
}));
}

4
core/server/web/shared/middlewares/upload.js
View file

@ -2,14 +2,14 @@ const config = require('../../../config');
const os = require('os');
const multer = require('multer');
const fs = require('fs-extra');
const common = require('../../../lib/common');
const {logging} = require('../../../lib/common');
const upload = {
enabledClear: config.get('uploadClear') || true,
multer: multer({dest: os.tmpdir()})
};
const deleteSingleFile = file => fs.unlink(file.path).catch(err => common.logging.error(err));
const deleteSingleFile = file => fs.unlink(file.path).catch(err => logging.error(err));
const single = name => (req, res, next) => {
const singleUpload = upload.multer.single(name);

19
core/server/web/shared/middlewares/validation/blog-icon.js
View file

@ -1,5 +1,6 @@
const errors = require('@tryghost/errors');
const config = require('../../../../config');
const common = require('../../../../lib/common');
const {i18n} = require('../../../../lib/common');
const imageLib = require('../../../../lib/image');
const validIconFileSize = (size) => {
@ -13,8 +14,8 @@ module.exports = function blogIcon() {
// CASE: file should not be larger than 100kb
if (!validIconFileSize(req.file.size)) {
return next(new common.errors.ValidationError({
message: common.i18n.t('errors.api.icons.invalidFile', {extensions: iconExtensions})
return next(new errors.ValidationError({
message: i18n.t('errors.api.icons.invalidFile', {extensions: iconExtensions})
}));
}
@ -24,23 +25,23 @@ module.exports = function blogIcon() {
// CASE: file needs to be a square
if (req.file.dimensions.width !== req.file.dimensions.height) {
return next(new common.errors.ValidationError({
message: common.i18n.t('errors.api.icons.invalidFile', {extensions: iconExtensions})
return next(new errors.ValidationError({
message: i18n.t('errors.api.icons.invalidFile', {extensions: iconExtensions})
}));
}
// CASE: icon needs to be bigger than or equal to 60px
// .ico files can contain multiple sizes, we need at least a minimum of 60px (16px is ok, as long as 60px are present as well)
if (req.file.dimensions.width < 60) {
return next(new common.errors.ValidationError({
message: common.i18n.t('errors.api.icons.invalidFile', {extensions: iconExtensions})
return next(new errors.ValidationError({
message: i18n.t('errors.api.icons.invalidFile', {extensions: iconExtensions})
}));
}
// CASE: icon needs to be smaller than or equal to 1000px
if (req.file.dimensions.width > 1000) {
return next(new common.errors.ValidationError({
message: common.i18n.t('errors.api.icons.invalidFile', {extensions: iconExtensions})
return next(new errors.ValidationError({
message: i18n.t('errors.api.icons.invalidFile', {extensions: iconExtensions})
}));
}

7
core/server/web/shared/middlewares/validation/profile-image.js
View file

@ -1,4 +1,5 @@
const common = require('../../../../lib/common');
const errors = require('@tryghost/errors');
const {i18n} = require('../../../../lib/common');
const imageLib = require('../../../../lib/image');
module.exports = function profileImage(req, res, next) {
@ -9,8 +10,8 @@ module.exports = function profileImage(req, res, next) {
// CASE: file needs to be a square
if (req.file.dimensions.width !== req.file.dimensions.height) {
return next(new common.errors.ValidationError({
message: common.i18n.t('errors.api.images.isNotSquare')
return next(new errors.ValidationError({
message: i18n.t('errors.api.images.isNotSquare')
}));
}

11
core/server/web/shared/middlewares/validation/upload.js
View file

@ -1,5 +1,6 @@
const path = require('path');
const common = require('../../../../lib/common');
const errors = require('@tryghost/errors');
const {i18n} = require('../../../../lib/common');
const config = require('../../../../config');
const localUtils = require('../../utils');
@ -17,8 +18,8 @@ module.exports = function upload(options) {
// Check if a file was provided
if (!localUtils.checkFileExists(req.file)) {
return next(new common.errors.ValidationError({
message: common.i18n.t(`errors.api.${type}.missingFile`)
return next(new errors.ValidationError({
message: i18n.t(`errors.api.${type}.missingFile`)
}));
}
@ -26,8 +27,8 @@ module.exports = function upload(options) {
// Check if the file is valid
if (!localUtils.checkFileIsValid(req.file, contentTypes, extensions)) {
return next(new common.errors.UnsupportedMediaTypeError({
message: common.i18n.t(`errors.api.${type}.invalidFile`, {extensions: extensions})
return next(new errors.UnsupportedMediaTypeError({
message: i18n.t(`errors.api.${type}.invalidFile`, {extensions: extensions})
}));
}

4
core/server/web/site/app.js
View file

@ -3,7 +3,7 @@ const path = require('path');
const express = require('express');
const cors = require('cors');
const {URL} = require('url');
const common = require('../../lib/common');
const errors = require('@tryghost/errors');
// App requires
const config = require('../../config');
@ -40,7 +40,7 @@ const corsOptionsDelegate = function corsOptionsDelegate(req, callback) {
try {
originUrl = new URL(origin);
} catch (err) {
return callback(new common.errors.BadRequestError({err}));
return callback(new errors.BadRequestError({err}));
}
// originUrl will definitely exist here because according to WHATWG URL spec