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
90 lines
2.9 KiB
JavaScript
90 lines
2.9 KiB
JavaScript
var path = require('path'),
|
|
express = require('express'),
|
|
ampRouter = express.Router(),
|
|
|
|
// Dirty requires
|
|
common = require('../../../lib/common'),
|
|
urlService = require('../../../services/url'),
|
|
helpers = require('../../../services/routing/helpers'),
|
|
templateName = 'amp';
|
|
|
|
function _renderer(req, res, next) {
|
|
// Note: this is super similar to the config middleware used in channels
|
|
// @TODO refactor into to something explicit & DRY this up
|
|
res._route = {
|
|
type: 'custom',
|
|
templateName: templateName,
|
|
defaultTemplate: path.resolve(__dirname, 'views', templateName + '.hbs')
|
|
};
|
|
|
|
// Renderer begin
|
|
// Format data
|
|
var data = req.body || {};
|
|
|
|
// CASE: we only support amp pages for posts that are not static pages
|
|
if (!data.post || data.post.page) {
|
|
return next(new common.errors.NotFoundError({message: common.i18n.t('errors.errors.pageNotFound')}));
|
|
}
|
|
|
|
// Render Call
|
|
return helpers.renderer(req, res, data);
|
|
}
|
|
|
|
// This here is a controller.
|
|
// In fact, this whole file is nothing more than a controller + renderer & doesn't need to be a router
|
|
function getPostData(req, res, next) {
|
|
req.body = req.body || {};
|
|
|
|
const urlWithSubdirectoryWithoutAmp = req.originalUrl.match(/(.*?\/)amp/)[1];
|
|
const urlWithoutSubdirectoryWithoutAmp = res.locals.relativeUrl.match(/(.*?\/)amp/)[1];
|
|
|
|
/**
|
|
* @NOTE
|
|
*
|
|
* We have to figure out the target permalink, otherwise it would be possible to serve a post
|
|
* which lives in two collections.
|
|
*
|
|
* @TODO:
|
|
*
|
|
* This is not optimal and caused by the fact how apps currently work. But apps weren't designed
|
|
* for dynamic routing.
|
|
*
|
|
* I think if the responsible, target router would first take care fetching/determining the post, the
|
|
* request could then be forwarded to this app. Then we don't have to:
|
|
*
|
|
* 1. care about fetching the post
|
|
* 2. care about if the post can be served
|
|
* 3. then this app would act like an extension
|
|
*
|
|
* The challenge is to design different types of apps e.g. extensions of routers, standalone pages etc.
|
|
*/
|
|
const permalinks = urlService.getPermalinkByUrl(urlWithSubdirectoryWithoutAmp, {withUrlOptions: true});
|
|
|
|
if (!permalinks) {
|
|
return next(new common.errors.NotFoundError({
|
|
message: common.i18n.t('errors.errors.pageNotFound')
|
|
}));
|
|
}
|
|
|
|
helpers.postLookup(urlWithoutSubdirectoryWithoutAmp, {permalinks: permalinks})
|
|
.then(function handleResult(result) {
|
|
if (result && result.post) {
|
|
req.body.post = result.post;
|
|
}
|
|
|
|
next();
|
|
})
|
|
.catch(next);
|
|
}
|
|
|
|
// AMP frontend route
|
|
ampRouter
|
|
.route('/')
|
|
.get(
|
|
getPostData,
|
|
_renderer
|
|
);
|
|
|
|
module.exports = ampRouter;
|
|
module.exports.renderer = _renderer;
|
|
module.exports.getPostData = getPostData;
|