mirror of
https://github.com/TryGhost/Ghost.git
synced 2024-12-22 18:31:57 +03: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
91 lines
2.5 KiB
JavaScript
91 lines
2.5 KiB
JavaScript
/**
|
|
* # Router
|
|
*
|
|
* A wrapper around express.Router
|
|
* Intended to be extended anywhere that routes need to be registered in Ghost
|
|
* Only allows for .use and .get at the moment - we don't have clear use-cases for anything else yet.
|
|
*/
|
|
|
|
const debug = require('ghost-ignition').debug('services:routing:ParentRouter'),
|
|
EventEmitter = require('events').EventEmitter,
|
|
express = require('express'),
|
|
_ = require('lodash'),
|
|
security = require('../../lib/security'),
|
|
urlService = require('../url'),
|
|
// This the route registry for the whole site
|
|
registry = require('./registry');
|
|
|
|
/**
|
|
* We expose a very limited amount of express.Router via specialist methods
|
|
*/
|
|
class ParentRouter extends EventEmitter {
|
|
constructor(name) {
|
|
super();
|
|
|
|
this.identifier = security.identifier.uid(10);
|
|
|
|
this.name = name;
|
|
this._router = express.Router({mergeParams: true});
|
|
}
|
|
|
|
mountRouter(path, router) {
|
|
if (arguments.length === 1) {
|
|
router = path;
|
|
debug(this.name + ': mountRouter: ' + router.name);
|
|
this._router.use(router);
|
|
} else {
|
|
registry.setRoute(this.name, path);
|
|
debug(this.name + ': mountRouter: ' + router.name + ' at ' + path);
|
|
this._router.use(path, router);
|
|
}
|
|
}
|
|
|
|
mountRoute(path, controller) {
|
|
debug(this.name + ': mountRoute for', path, controller.name);
|
|
registry.setRoute(this.name, path);
|
|
this._router.get(path, controller);
|
|
}
|
|
|
|
unmountRoute(path) {
|
|
let indexToRemove = null;
|
|
|
|
_.each(this._router.stack, (item, index) => {
|
|
if (item.path === path) {
|
|
indexToRemove = index;
|
|
}
|
|
});
|
|
|
|
if (indexToRemove !== null) {
|
|
this._router.stack.splice(indexToRemove, 1);
|
|
}
|
|
}
|
|
|
|
router() {
|
|
// @TODO: should this just be the handler that is returned?
|
|
// return this._router.handle.bind(this._router);
|
|
return this._router;
|
|
}
|
|
|
|
getPermalinks() {
|
|
return this.permalinks;
|
|
}
|
|
|
|
getFilter() {
|
|
return this.filter;
|
|
}
|
|
|
|
/**
|
|
* Will return the full route including subdirectory.
|
|
* Do not use this function to mount routes for now, because the subdirectory is already mounted.
|
|
*/
|
|
getRoute(options) {
|
|
options = options || {};
|
|
|
|
return urlService.utils.createUrl(this.route.value, options.absolute, options.secure);
|
|
}
|
|
|
|
reset() {}
|
|
}
|
|
|
|
module.exports = ParentRouter;
|