mirror of
https://github.com/TryGhost/Ghost.git
synced 2024-12-23 10:53:34 +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
109 lines
3.0 KiB
JavaScript
109 lines
3.0 KiB
JavaScript
const debug = require('ghost-ignition').debug('services:routing:taxonomy-router');
|
|
const common = require('../../lib/common');
|
|
const ParentRouter = require('./ParentRouter');
|
|
const RSSRouter = require('./RSSRouter');
|
|
const urlService = require('../url');
|
|
const controllers = require('./controllers');
|
|
const middlewares = require('./middlewares');
|
|
|
|
/* eslint-disable */
|
|
const knownTaxonomies = {
|
|
tag: {
|
|
filter: "tags:'%s'+tags.visibility:public",
|
|
data: {
|
|
type: 'read',
|
|
resource: 'tags',
|
|
options: {
|
|
slug: '%s',
|
|
visibility: 'public'
|
|
}
|
|
},
|
|
editRedirect: '#/settings/tags/:slug/'
|
|
},
|
|
author: {
|
|
filter: "authors:'%s'",
|
|
data: {
|
|
type: 'read',
|
|
resource: 'users',
|
|
options: {
|
|
slug: '%s',
|
|
visibility: 'public'
|
|
}
|
|
},
|
|
editRedirect: '#/team/:slug/'
|
|
}
|
|
};
|
|
/* eslint-enable */
|
|
|
|
class TaxonomyRouter extends ParentRouter {
|
|
constructor(key, permalinks) {
|
|
super('Taxonomy');
|
|
|
|
this.taxonomyKey = key;
|
|
|
|
this.permalinks = {
|
|
value: permalinks
|
|
};
|
|
|
|
this.permalinks.getValue = () => {
|
|
return this.permalinks.value;
|
|
};
|
|
|
|
debug(this.permalinks);
|
|
|
|
this._registerRoutes();
|
|
}
|
|
|
|
_registerRoutes() {
|
|
// REGISTER: context middleware
|
|
this.router().use(this._prepareContext.bind(this));
|
|
|
|
// REGISTER: enable rss by default
|
|
this.mountRouter(this.permalinks.getValue(), new RSSRouter().router());
|
|
|
|
// REGISTER: e.g. /tag/:slug/
|
|
this.mountRoute(this.permalinks.getValue(), controllers.collection);
|
|
|
|
// REGISTER: enable pagination for each taxonomy by default
|
|
this.router().param('page', middlewares.pageParam);
|
|
this.mountRoute(urlService.utils.urlJoin(this.permalinks.value, 'page', ':page(\\d+)'), controllers.collection);
|
|
|
|
this.mountRoute(urlService.utils.urlJoin(this.permalinks.value, 'edit'), this._redirectEditOption.bind(this));
|
|
|
|
common.events.emit('router.created', this);
|
|
}
|
|
|
|
_prepareContext(req, res, next) {
|
|
res.locals.routerOptions = {
|
|
name: this.taxonomyKey,
|
|
permalinks: this.permalinks.getValue(),
|
|
data: {[this.taxonomyKey]: knownTaxonomies[this.taxonomyKey].data},
|
|
filter: knownTaxonomies[this.taxonomyKey].filter,
|
|
type: this.getType(),
|
|
context: [this.taxonomyKey],
|
|
slugTemplate: true,
|
|
identifier: this.identifier
|
|
};
|
|
|
|
res._route = {
|
|
type: 'collection'
|
|
};
|
|
|
|
next();
|
|
}
|
|
|
|
_redirectEditOption(req, res) {
|
|
urlService.utils.redirectToAdmin(302, res, knownTaxonomies[this.taxonomyKey].editRedirect.replace(':slug', req.params.slug));
|
|
}
|
|
|
|
getType() {
|
|
return knownTaxonomies[this.taxonomyKey].data.resource;
|
|
}
|
|
|
|
getRoute() {
|
|
return null;
|
|
}
|
|
}
|
|
|
|
module.exports = TaxonomyRouter;
|