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
74 lines
2.3 KiB
JavaScript
74 lines
2.3 KiB
JavaScript
const common = require('../../../lib/common'),
|
|
IndexMapGenerator = require('./index-generator'),
|
|
PagesMapGenerator = require('./page-generator'),
|
|
PostsMapGenerator = require('./post-generator'),
|
|
UsersMapGenerator = require('./user-generator'),
|
|
TagsMapGenerator = require('./tag-generator');
|
|
|
|
class SiteMapManager {
|
|
constructor(options) {
|
|
options = options || {};
|
|
|
|
this.pages = options.pages || this.createPagesGenerator(options);
|
|
this.posts = options.posts || this.createPostsGenerator(options);
|
|
this.users = this.authors = options.authors || this.createUsersGenerator(options);
|
|
this.tags = options.tags || this.createTagsGenerator(options);
|
|
this.index = options.index || this.createIndexGenerator(options);
|
|
|
|
common.events.on('router.created', (router) => {
|
|
if (router.name === 'StaticRoutesRouter') {
|
|
this.pages.addUrl(router.getRoute({absolute: true}), {id: router.identifier, staticRoute: true});
|
|
}
|
|
|
|
if (router.name === 'CollectionRouter') {
|
|
this.pages.addUrl(router.getRoute({absolute: true}), {id: router.identifier, staticRoute: false});
|
|
}
|
|
});
|
|
|
|
common.events.on('url.added', (obj) => {
|
|
this[obj.resource.config.type].addUrl(obj.url.absolute, obj.resource.data);
|
|
});
|
|
|
|
common.events.on('url.removed', (obj) => {
|
|
this[obj.resource.config.type].removeUrl(obj.url.absolute, obj.resource.data);
|
|
});
|
|
}
|
|
|
|
createIndexGenerator() {
|
|
return new IndexMapGenerator({
|
|
types: {
|
|
pages: this.pages,
|
|
posts: this.posts,
|
|
authors: this.authors,
|
|
tags: this.tags
|
|
}
|
|
});
|
|
}
|
|
|
|
createPagesGenerator(options) {
|
|
return new PagesMapGenerator(options);
|
|
}
|
|
|
|
createPostsGenerator(options) {
|
|
return new PostsMapGenerator(options);
|
|
}
|
|
|
|
createUsersGenerator(options) {
|
|
return new UsersMapGenerator(options);
|
|
}
|
|
|
|
createTagsGenerator(options) {
|
|
return new TagsMapGenerator(options);
|
|
}
|
|
|
|
getIndexXml() {
|
|
return this.index.getXml();
|
|
}
|
|
|
|
getSiteMapXml(type) {
|
|
return this[type].getXml();
|
|
}
|
|
}
|
|
|
|
module.exports = SiteMapManager;
|