mirror of
https://github.com/TryGhost/Ghost.git
synced 2025-02-10 23:36:14 -05:00
b392d1925a
refs #9601 ### Dynamic Routing This is the beta version of dynamic routing. - we had a initial implementation of "channels" available in the codebase - we have removed and moved this implementation - there is now a centralised place for dynamic routing - server/services/routing - each routing component is represented by a router type e.g. collections, routes, static pages, taxonomies, rss, preview of posts - keep as much as possible logic of routing helpers, middlewares and controllers - ensure test coverage - connect all the things together - yaml file + validation - routing + routers - url service - sitemaps - url access - deeper implementation of yaml validations - e.g. hard require slashes - ensure routing hierarchy/order - e.g. you enable the subscriber app - you have a custom static page, which lives under the same slug /subscribe - static pages are stronger than apps - e.g. the first collection owns the post it has filtered - a post cannot live in two collections - ensure apps are still working and hook into the routers layer (or better said: and register in the routing service) - put as much as possible comments to the code base for better understanding - ensure a clean debug log - ensure we can unmount routes - e.g. you have a collection permalink of /:slug/ represented by {globals.permalink} - and you change the permalink in the admin to dated permalink - the express route get's refreshed from /:slug/ to /:year/:month/:day/:slug/ - unmount without server restart, yey - ensure we are backwards compatible - e.g. render home.hbs for collection index if collection route is / - ensure you can access your configured permalink from the settings table with {globals.permalink} ### Render 503 if url service did not finish - return 503 if the url service has not finished generating the resource urls ### Rewrite sitemaps - we have rewritten the sitemaps "service", because the url generator does no longer happen on runtime - we generate all urls on bootstrap - the sitemaps service will consume created resource and router urls - these urls will be shown on the xml pages - we listen on url events - we listen on router events - we no longer have to fetch the resources, which is nice - the urlservice pre-fetches resources and emits their urls - the urlservice is the only component who knows which urls are valid - i made some ES6 adaptions - we keep the caching logic -> only regenerate xml if there is a change - updated tests - checked test coverage (100%) ### Re-work usage of Url utility - replace all usages of `urlService.utils.urlFor` by `urlService.getByResourceId` - only for resources e.g. post, author, tag - this is important, because with dynamic routing we no longer create static urls based on the settings permalink on runtime - adapt url utility - adapt tests
96 lines
2.8 KiB
JavaScript
96 lines
2.8 KiB
JavaScript
var common = require('../lib/common'),
|
|
request = require('../lib/request'),
|
|
imageLib = require('../lib/image'),
|
|
urlService = require('../services/url'),
|
|
settingsCache = require('./settings/cache'),
|
|
schema = require('../data/schema').checks,
|
|
defaultPostSlugs = [
|
|
'welcome',
|
|
'the-editor',
|
|
'using-tags',
|
|
'managing-users',
|
|
'private-sites',
|
|
'advanced-markdown',
|
|
'themes'
|
|
];
|
|
|
|
function getSlackSettings() {
|
|
var setting = settingsCache.get('slack');
|
|
// This might one day have multiple entries, for now its always a array
|
|
// and we return the first item or an empty object
|
|
return setting ? setting[0] : {};
|
|
}
|
|
|
|
function ping(post) {
|
|
var message,
|
|
slackData = {},
|
|
slackSettings = getSlackSettings();
|
|
|
|
// If this is a post, we want to send the link of the post
|
|
if (schema.isPost(post)) {
|
|
message = urlService.getUrlByResourceId(post.id, {absolute: true});
|
|
} else {
|
|
message = post.message;
|
|
}
|
|
// Quit here if slack integration is not activated
|
|
if (slackSettings.url && slackSettings.url !== '') {
|
|
// Only ping when not a page
|
|
if (post.page) {
|
|
return;
|
|
}
|
|
|
|
// Don't ping for the default posts.
|
|
// This also handles the case where during ghost's first run
|
|
// models.init() inserts this post but permissions.init() hasn't
|
|
// (can't) run yet.
|
|
if (defaultPostSlugs.indexOf(post.slug) > -1) {
|
|
return;
|
|
}
|
|
|
|
slackData = {
|
|
text: message,
|
|
unfurl_links: true,
|
|
icon_url: imageLib.blogIcon.getIconUrl(true),
|
|
username: 'Ghost'
|
|
};
|
|
|
|
return request(slackSettings.url, {
|
|
body: JSON.stringify(slackData),
|
|
headers: {
|
|
'Content-type': 'application/json'
|
|
}
|
|
}).catch(function (err) {
|
|
common.logging.error(new common.errors.GhostError({
|
|
err: err,
|
|
context: common.i18n.t('errors.services.ping.requestFailed.error', {service: 'slack'}),
|
|
help: common.i18n.t('errors.services.ping.requestFailed.help', {url: 'http://docs.ghost.org'})
|
|
}));
|
|
});
|
|
}
|
|
}
|
|
|
|
function listener(model, options) {
|
|
// CASE: do not ping slack if we import a database
|
|
// TODO: refactor post.published events to never fire on importing
|
|
if (options && options.importing) {
|
|
return;
|
|
}
|
|
|
|
ping(model.toJSON());
|
|
}
|
|
|
|
function testPing() {
|
|
ping({
|
|
message: 'Heya! This is a test notification from your Ghost blog :smile:. Seems to work fine!'
|
|
});
|
|
}
|
|
|
|
function listen() {
|
|
common.events.on('post.published', listener);
|
|
common.events.on('slack.test', testPing);
|
|
}
|
|
|
|
// Public API
|
|
module.exports = {
|
|
listen: listen
|
|
};
|