mirror of
https://github.com/TryGhost/Ghost.git
synced 2025-02-03 23:00:14 -05:00
Refactored theme service to use async/await
refs: https://github.com/TryGhost/Team/issues/831 - We prefer async/await over promise chains because it makes the code much more readable - the Theme Service needs further work and this should make that work much easier - e.g. https://github.com/TryGhost/Team/issues/831 - e.g. fixing up the index.js file
This commit is contained in:
Hannah Wolfe
parent
ee5962bd5d
commit
82ef700d81
3 changed files with 110 additions and 131 deletions
|
|
@ -1,25 +1,19 @@
|
|||
const debug = require('@tryghost/debug')('themes');
|
||||
const config = require('../../../shared/config');
|
||||
const packageJSON = require('@tryghost/package-json');
|
||||
|
||||
const config = require('../../../shared/config');
|
||||
const themeList = require('./list');
|
||||
|
||||
const loadAllThemes = function loadAllThemes() {
|
||||
return packageJSON
|
||||
.readPackages(config.getContentPath('themes'))
|
||||
.then(function updateThemeList(themes) {
|
||||
debug('loading themes', Object.keys(themes));
|
||||
|
||||
themeList.init(themes);
|
||||
});
|
||||
const loadAllThemes = async function loadAllThemes() {
|
||||
const themes = await packageJSON.readPackages(config.getContentPath('themes'));
|
||||
debug('loading themes', Object.keys(themes));
|
||||
themeList.init(themes);
|
||||
};
|
||||
|
||||
const loadOneTheme = function loadOneTheme(themeName) {
|
||||
return packageJSON
|
||||
.readPackage(config.getContentPath('themes'), themeName)
|
||||
.then(function (readThemes) {
|
||||
debug('loaded one theme', themeName);
|
||||
return themeList.set(themeName, readThemes[themeName]);
|
||||
});
|
||||
const loadOneTheme = async function loadOneTheme(themeName) {
|
||||
const theme = await packageJSON.readPackage(config.getContentPath('themes'), themeName);
|
||||
debug('loaded one theme', themeName);
|
||||
return themeList.set(themeName, theme[themeName]);
|
||||
};
|
||||
|
||||
module.exports = {
|
||||
|
|
|
|||
|
|
@ -1,7 +1,11 @@
|
|||
const debug = require('@tryghost/debug')('themes');
|
||||
const fs = require('fs-extra');
|
||||
const ObjectID = require('bson-objectid');
|
||||
|
||||
const tpl = require('@tryghost/tpl');
|
||||
const logging = require('@tryghost/logging');
|
||||
const errors = require('@tryghost/errors');
|
||||
|
||||
const bridge = require('../../../bridge');
|
||||
const validate = require('./validate');
|
||||
const list = require('./list');
|
||||
const ThemeStorage = require('./ThemeStorage');
|
||||
|
|
@ -9,11 +13,7 @@ const themeLoader = require('./loader');
|
|||
const toJSON = require('./to-json');
|
||||
|
||||
const settingsCache = require('../../../shared/settings-cache');
|
||||
const tpl = require('@tryghost/tpl');
|
||||
const logging = require('@tryghost/logging');
|
||||
const errors = require('@tryghost/errors');
|
||||
|
||||
const ObjectID = require('bson-objectid');
|
||||
const bridge = require('../../../bridge');
|
||||
|
||||
const messages = {
|
||||
themeDoesNotExist: 'Theme does not exist.',
|
||||
|
|
@ -32,20 +32,20 @@ const getStorage = () => {
|
|||
};
|
||||
|
||||
module.exports = {
|
||||
getZip: (themeName) => {
|
||||
getZip: async (themeName) => {
|
||||
const theme = list.get(themeName);
|
||||
|
||||
if (!theme) {
|
||||
return Promise.reject(new errors.BadRequestError({
|
||||
throw new errors.BadRequestError({
|
||||
message: tpl(messages.invalidThemeName)
|
||||
}));
|
||||
});
|
||||
}
|
||||
|
||||
return getStorage().serve({
|
||||
return await getStorage().serve({
|
||||
name: themeName
|
||||
});
|
||||
},
|
||||
setFromZip: (zip) => {
|
||||
setFromZip: async (zip) => {
|
||||
const shortName = getStorage().getSanitizedFileName(zip.name.split('.zip')[0]);
|
||||
const backupName = `${shortName}_${ObjectID()}`;
|
||||
|
||||
|
|
@ -57,79 +57,69 @@ module.exports = {
|
|||
}
|
||||
|
||||
let checkedTheme;
|
||||
let overrideTheme;
|
||||
let renamedExisting = false;
|
||||
|
||||
return validate.checkSafe(zip, true)
|
||||
.then((_checkedTheme) => {
|
||||
checkedTheme = _checkedTheme;
|
||||
try {
|
||||
checkedTheme = await validate.checkSafe(zip, true);
|
||||
const themeExists = await getStorage().exists(shortName);
|
||||
// CASE: move the existing theme to a backup folder
|
||||
if (themeExists) {
|
||||
renamedExisting = true;
|
||||
await getStorage().rename(shortName, backupName);
|
||||
}
|
||||
|
||||
return getStorage().exists(shortName);
|
||||
})
|
||||
.then((themeExists) => {
|
||||
// CASE: move the existing theme to a backup folder
|
||||
if (themeExists) {
|
||||
renamedExisting = true;
|
||||
return getStorage().rename(shortName, backupName);
|
||||
}
|
||||
})
|
||||
.then(() => {
|
||||
// CASE: store extracted theme
|
||||
return getStorage().save({
|
||||
name: shortName,
|
||||
path: checkedTheme.path
|
||||
});
|
||||
})
|
||||
.then(() => {
|
||||
// CASE: loads the theme from the fs & sets the theme on the themeList
|
||||
return themeLoader.loadOneTheme(shortName);
|
||||
})
|
||||
.then((loadedTheme) => {
|
||||
const overrideTheme = (shortName === settingsCache.get('active_theme'));
|
||||
// CASE: if this is the active theme, we are overriding
|
||||
if (overrideTheme) {
|
||||
debug('Activating theme (method C, on API "override")', shortName);
|
||||
bridge.activateTheme(loadedTheme, checkedTheme);
|
||||
}
|
||||
// CASE: store extracted theme
|
||||
await getStorage().save({
|
||||
name: shortName,
|
||||
path: checkedTheme.path
|
||||
});
|
||||
// CASE: loads the theme from the fs & sets the theme on the themeList
|
||||
const loadedTheme = await themeLoader.loadOneTheme(shortName);
|
||||
overrideTheme = (shortName === settingsCache.get('active_theme'));
|
||||
// CASE: if this is the active theme, we are overriding
|
||||
if (overrideTheme) {
|
||||
debug('Activating theme (method C, on API "override")', shortName);
|
||||
bridge.activateTheme(loadedTheme, checkedTheme);
|
||||
}
|
||||
|
||||
// @TODO: unify the name across gscan and Ghost!
|
||||
return {
|
||||
themeOverridden: overrideTheme,
|
||||
theme: toJSON(shortName, checkedTheme)
|
||||
};
|
||||
})
|
||||
.catch((error) => {
|
||||
// restore backup if we renamed an existing theme but saving failed
|
||||
if (renamedExisting) {
|
||||
return getStorage().exists(shortName).then((themeExists) => {
|
||||
if (!themeExists) {
|
||||
return getStorage().rename(backupName, shortName).then(() => {
|
||||
throw error;
|
||||
});
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
throw error;
|
||||
})
|
||||
.finally(() => {
|
||||
// @TODO: we should probably do this as part of saving the theme
|
||||
// CASE: remove extracted dir from gscan happens in background
|
||||
if (checkedTheme) {
|
||||
fs.remove(checkedTheme.path)
|
||||
.catch((err) => {
|
||||
logging.error(new errors.GhostError({err: err}));
|
||||
// @TODO: unify the name across gscan and Ghost!
|
||||
return {
|
||||
themeOverridden: overrideTheme,
|
||||
theme: toJSON(shortName, checkedTheme)
|
||||
};
|
||||
} catch (error) {
|
||||
// restore backup if we renamed an existing theme but saving failed
|
||||
if (renamedExisting) {
|
||||
return getStorage().exists(shortName).then((themeExists) => {
|
||||
if (!themeExists) {
|
||||
return getStorage().rename(backupName, shortName).then(() => {
|
||||
throw error;
|
||||
});
|
||||
}
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
// CASE: remove the backup we created earlier
|
||||
getStorage()
|
||||
.delete(backupName)
|
||||
throw error;
|
||||
} finally {
|
||||
// @TODO: we should probably do this as part of saving the theme
|
||||
// CASE: remove extracted dir from gscan happens in background
|
||||
if (checkedTheme) {
|
||||
fs.remove(checkedTheme.path)
|
||||
.catch((err) => {
|
||||
logging.error(new errors.GhostError({err: err}));
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
// CASE: remove the backup we created earlier
|
||||
getStorage()
|
||||
.delete(backupName)
|
||||
.catch((err) => {
|
||||
logging.error(new errors.GhostError({err: err}));
|
||||
});
|
||||
}
|
||||
},
|
||||
destroy: function (themeName) {
|
||||
destroy: async function (themeName) {
|
||||
if (themeName === 'casper') {
|
||||
throw new errors.ValidationError({
|
||||
message: tpl(messages.destroyCasper)
|
||||
|
|
@ -150,9 +140,8 @@ module.exports = {
|
|||
});
|
||||
}
|
||||
|
||||
return getStorage().delete(themeName)
|
||||
.then(() => {
|
||||
list.del(themeName);
|
||||
});
|
||||
let result = await getStorage().delete(themeName);
|
||||
list.del(themeName);
|
||||
return result;
|
||||
}
|
||||
};
|
||||
|
|
|
|||
|
|
@ -16,63 +16,59 @@ const canActivate = function canActivate(checkedTheme) {
|
|||
return !checkedTheme.results.error.length || (config.get('env') === 'development') && !checkedTheme.results.hasFatalErrors;
|
||||
};
|
||||
|
||||
const check = function check(theme, isZip) {
|
||||
const check = async function check(theme, isZip) {
|
||||
debug('Begin: Check');
|
||||
// gscan can slow down boot time if we require on boot, for now nest the require.
|
||||
const gscan = require('gscan');
|
||||
let checkPromise;
|
||||
let checkedTheme;
|
||||
|
||||
if (isZip) {
|
||||
debug('zip mode');
|
||||
checkPromise = gscan.checkZip(theme, {
|
||||
checkedTheme = await gscan.checkZip(theme, {
|
||||
keepExtractedDir: true,
|
||||
checkVersion: 'canary'
|
||||
});
|
||||
} else {
|
||||
debug('non-zip mode');
|
||||
checkPromise = gscan.check(theme.path, {
|
||||
checkedTheme = await gscan.check(theme.path, {
|
||||
checkVersion: 'canary'
|
||||
});
|
||||
}
|
||||
|
||||
return checkPromise
|
||||
.then(function resultHandler(checkedTheme) {
|
||||
checkedTheme = gscan.format(checkedTheme, {
|
||||
onlyFatalErrors: config.get('env') === 'production',
|
||||
checkVersion: 'canary'
|
||||
});
|
||||
checkedTheme = gscan.format(checkedTheme, {
|
||||
onlyFatalErrors: config.get('env') === 'production',
|
||||
checkVersion: 'canary'
|
||||
});
|
||||
|
||||
debug('End: Check');
|
||||
return checkedTheme;
|
||||
});
|
||||
debug('End: Check');
|
||||
return checkedTheme;
|
||||
};
|
||||
|
||||
const checkSafe = function checkSafe(theme, isZip) {
|
||||
return check(theme, isZip)
|
||||
.then((checkedTheme) => {
|
||||
if (canActivate(checkedTheme)) {
|
||||
return checkedTheme;
|
||||
}
|
||||
const checkSafe = async function checkSafe(theme, isZip) {
|
||||
const checkedTheme = await check(theme, isZip);
|
||||
|
||||
// NOTE: When theme cannot be activated and gscan explicitly keeps extracted files (after
|
||||
// being called with `keepExtractedDir: true`), this is the closes place for a cleanup.
|
||||
// TODO: The `keepExtractedDir` flag is the cause of confusion for when and where the cleanup
|
||||
// should be done. It's probably best if gscan is called directly with path to the extracted
|
||||
// directory, this would allow keeping gscan to do just one thing - validate the theme, and
|
||||
// file manipulations could be left to another module/library
|
||||
if (isZip) {
|
||||
fs.remove(checkedTheme.path);
|
||||
}
|
||||
if (canActivate(checkedTheme)) {
|
||||
return checkedTheme;
|
||||
}
|
||||
|
||||
return Promise.reject(new errors.ThemeValidationError({
|
||||
message: tpl(messages.invalidTheme),
|
||||
errorDetails: Object.assign(
|
||||
_.pick(checkedTheme, ['checkedVersion', 'name', 'path', 'version']), {
|
||||
errors: checkedTheme.results.error
|
||||
}
|
||||
)
|
||||
}));
|
||||
});
|
||||
// NOTE: When theme cannot be activated and gscan explicitly keeps extracted files (after
|
||||
// being called with `keepExtractedDir: true`), this is the best place for a cleanup.
|
||||
// TODO: The `keepExtractedDir` flag is the cause of confusion for when and where the cleanup
|
||||
// should be done. It's probably best if gscan is called directly with path to the extracted
|
||||
// directory, this would allow keeping gscan to do just one thing - validate the theme, and
|
||||
// file manipulations could be left to another module/library
|
||||
if (isZip) {
|
||||
fs.remove(checkedTheme.path);
|
||||
}
|
||||
|
||||
return Promise.reject(new errors.ThemeValidationError({
|
||||
message: tpl(messages.invalidTheme),
|
||||
errorDetails: Object.assign(
|
||||
_.pick(checkedTheme, ['checkedVersion', 'name', 'path', 'version']), {
|
||||
errors: checkedTheme.results.error
|
||||
}
|
||||
)
|
||||
}));
|
||||
};
|
||||
|
||||
module.exports.check = check;
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue