Skip to content

Commit

Permalink
ghost_head improvements (TryGhost#8983)
Browse files Browse the repository at this point in the history 
no issue

- Added debug statements to ghost_head
  - useful for determining how much render time is spent in ghost head
- Make promises more readable
- Used join instead of props for less code
  • Loading branch information
@ErisDS @kirrg001
ErisDS authored and kirrg001 committed Sep 7, 2017
1 parent c64c56f commit cdf6a10
Showing 1 changed file with 79 additions and 77 deletions.
156 changes: 79 additions & 77 deletions core/server/helpers/ghost_head.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
var proxy = require('./proxy'),
_ = require('lodash'),
Promise = require('bluebird'),
debug = require('ghost-ignition').debug('ghost_head'),

getMetaData = proxy.metaData.get,
getAssetUrl = proxy.metaData.getAssetUrl,
Expand All @@ -24,18 +25,20 @@ var proxy = require('./proxy'),

function getClient() {
if (labs.isSet('publicAPI') === true) {
return api.clients.read({slug: 'ghost-frontend'}).then(function (client) {
client = client.clients[0];

if (client.status === 'enabled') {
return {
id: client.slug,
secret: client.secret
};
}
return api.clients
.read({slug: 'ghost-frontend'})
.then(function handleClient(client) {
client = client.clients[0];

if (client.status === 'enabled') {
return {
id: client.slug,
secret: client.secret
};
}

return {};
});
return {};
});
}
return Promise.resolve({});
}
Expand Down Expand Up @@ -80,99 +83,98 @@ function getAjaxHelper(clientId, clientSecret) {
}

module.exports = function ghost_head(options) {
debug('begin');
// if server error page do nothing
if (this.statusCode >= 500) {
return;
}

var metaData,
client,
head = [],
var head = [],
globalCodeinjection = settingsCache.get('ghost_head'),
postCodeInjection = options.data.root && options.data.root.post ? options.data.root.post.codeinjection_head : null,
context = this.context ? this.context : null,
useStructuredData = !config.isPrivacyDisabled('useStructuredData'),
safeVersion = this.safeVersion,
referrerPolicy = config.get('referrerPolicy') ? config.get('referrerPolicy') : 'no-referrer-when-downgrade',
fetch = {
metaData: getMetaData(this, options.data.root),
client: getClient()
},
favicon = blogIconUtils.getIconUrl(),
iconType = blogIconUtils.getIconType(favicon);

return Promise.props(fetch).then(function (response) {
client = response.client;
metaData = response.metaData;
debug('preparation complete, begin fetch');
return Promise
.join(getMetaData(this, options.data.root), getClient(), function handleData(metaData, client) {
debug('end fetch');

if (context) {
// head is our main array that holds our meta data
if (metaData.metaDescription && metaData.metaDescription.length > 0) {
head.push('<meta name="description" content="' + escapeExpression(metaData.metaDescription) + '" />');
}
if (context) {
// head is our main array that holds our meta data
if (metaData.metaDescription && metaData.metaDescription.length > 0) {
head.push('<meta name="description" content="' + escapeExpression(metaData.metaDescription) + '" />');
}

head.push('<link rel="shortcut icon" href="' + favicon + '" type="image/' + iconType + '" />');
head.push('<link rel="canonical" href="' +
escapeExpression(metaData.canonicalUrl) + '" />');
head.push('<meta name="referrer" content="' + referrerPolicy + '" />');
head.push('<link rel="shortcut icon" href="' + favicon + '" type="image/' + iconType + '" />');
head.push('<link rel="canonical" href="' +
escapeExpression(metaData.canonicalUrl) + '" />');
head.push('<meta name="referrer" content="' + referrerPolicy + '" />');

// show amp link in post when 1. we are not on the amp page and 2. amp is enabled
if (_.includes(context, 'post') && !_.includes(context, 'amp') && settingsCache.get('amp')) {
head.push('<link rel="amphtml" href="' +
escapeExpression(metaData.ampUrl) + '" />');
}
// show amp link in post when 1. we are not on the amp page and 2. amp is enabled
if (_.includes(context, 'post') && !_.includes(context, 'amp') && settingsCache.get('amp')) {
head.push('<link rel="amphtml" href="' +
escapeExpression(metaData.ampUrl) + '" />');
}

if (metaData.previousUrl) {
head.push('<link rel="prev" href="' +
escapeExpression(metaData.previousUrl) + '" />');
}
if (metaData.previousUrl) {
head.push('<link rel="prev" href="' +
escapeExpression(metaData.previousUrl) + '" />');
}

if (metaData.nextUrl) {
head.push('<link rel="next" href="' +
escapeExpression(metaData.nextUrl) + '" />');
}
if (metaData.nextUrl) {
head.push('<link rel="next" href="' +
escapeExpression(metaData.nextUrl) + '" />');
}

if (!_.includes(context, 'paged') && useStructuredData) {
head.push('');
head.push.apply(head, finaliseStructuredData(metaData));
head.push('');
if (!_.includes(context, 'paged') && useStructuredData) {
head.push('');
head.push.apply(head, finaliseStructuredData(metaData));
head.push('');

if (metaData.schema) {
head.push('<script type="application/ld+json">\n' +
JSON.stringify(metaData.schema, null, ' ') +
'\n </script>\n');
if (metaData.schema) {
head.push('<script type="application/ld+json">\n' +
JSON.stringify(metaData.schema, null, ' ') +
'\n </script>\n');
}
}
}

if (client && client.id && client.secret && !_.includes(context, 'amp')) {
head.push(getAjaxHelper(client.id, client.secret));
if (client && client.id && client.secret && !_.includes(context, 'amp')) {
head.push(getAjaxHelper(client.id, client.secret));
}
}
}

head.push('<meta name="generator" content="Ghost ' +
escapeExpression(safeVersion) + '" />');
head.push('<meta name="generator" content="Ghost ' +
escapeExpression(safeVersion) + '" />');

head.push('<link rel="alternate" type="application/rss+xml" title="' +
escapeExpression(metaData.blog.title) + '" href="' +
escapeExpression(metaData.rssUrl) + '" />');
head.push('<link rel="alternate" type="application/rss+xml" title="' +
escapeExpression(metaData.blog.title) + '" href="' +
escapeExpression(metaData.rssUrl) + '" />');

// no code injection for amp context!!!
if (!_.includes(context, 'amp')) {
if (!_.isEmpty(globalCodeinjection)) {
head.push(globalCodeinjection);
}
// no code injection for amp context!!!
if (!_.includes(context, 'amp')) {
if (!_.isEmpty(globalCodeinjection)) {
head.push(globalCodeinjection);
}

if (!_.isEmpty(postCodeInjection)) {
head.push(postCodeInjection);
if (!_.isEmpty(postCodeInjection)) {
head.push(postCodeInjection);
}
}
}
return filters.doFilter('ghost_head', head);
}).then(function (head) {
return new SafeString(head.join('\n ').trim());
}).catch(function handleError(err) {
logging.error(err);

// Return what we have so far (currently nothing)
return new SafeString(head.join('\n ').trim());
});
return filters.doFilter('ghost_head', head);
})
.then(function afterFilters(head) {
debug('end');
return new SafeString(head.join('\n ').trim());
})
.catch(function handleError(err) {
logging.error(err);

// Return what we have so far (currently nothing)
return new SafeString(head.join('\n ').trim());
});
};

0 comments on commit cdf6a10

Please sign in to comment.