0
Fork 0
mirror of https://github.com/TryGhost/Ghost.git synced 2025-02-03 23:00:14 -05:00
ghost/core/server/data/meta
Katharina Irrgang b392d1925a
Dynamic Routing Beta (#9596)
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
2018-06-05 19:02:20 +02:00
..
amp_url.js Moved utils/url.js to UrlService 2017-12-11 20:05:33 +01:00
asset_url.js 🔥 Drop Node v4 Support 2018-05-01 14:06:18 +02:00
author_fb_url.js Multiple authors (#9426) 2018-03-27 15:16:15 +01:00
author_image.js Multiple authors (#9426) 2018-03-27 15:16:15 +01:00
author_url.js Dynamic Routing Beta (#9596) 2018-06-05 19:02:20 +02:00
blog_logo.js Moved image utils to lib/image 2017-12-14 20:46:53 +01:00
canonical_url.js Moved utils/url.js to UrlService 2017-12-11 20:05:33 +01:00
context_object.js Moved labs, auth, permissions, settings, mail, themes to services (#9339) 2017-12-14 03:01:23 +01:00
cover_image.js Moved utils/url.js to UrlService 2017-12-11 20:05:33 +01:00
creator_url.js Multiple authors (#9426) 2018-03-27 15:16:15 +01:00
description.js Moved labs, auth, permissions, settings, mail, themes to services (#9339) 2017-12-14 03:01:23 +01:00
excerpt.js Switch to Eslint (#9197) 2017-11-01 13:44:54 +00:00
image-dimensions.js Moved image utils to lib/image 2017-12-14 20:46:53 +01:00
index.js Multiple authors (#9426) 2018-03-27 15:16:15 +01:00
keywords.js 🔥 Drop Node v4 Support 2018-05-01 14:06:18 +02:00
modified_date.js [FEATURE] AMP (#7229) 2016-08-22 18:49:27 +02:00
og_image.js Moved utils/url.js to UrlService 2017-12-11 20:05:33 +01:00
og_type.js [FEATURE] AMP (#7229) 2016-08-22 18:49:27 +02:00
paginated_url.js Replaced routeKeywords in config with hard coded keywords (#9561) 2018-04-17 10:36:05 +01:00
published_date.js [FEATURE] AMP (#7229) 2016-08-22 18:49:27 +02:00
rss_url.js Dynamic Routing Beta (#9596) 2018-06-05 19:02:20 +02:00
schema.js Multiple authors (#9426) 2018-03-27 15:16:15 +01:00
structured_data.js Moved social utility to lib/social 2017-12-14 22:34:05 +01:00
title.js 🐛Fixed i18n for the {{meta_title}} helper (#9468) 2018-03-19 09:48:07 +01:00
twitter_image.js Moved utils/url.js to UrlService 2017-12-11 20:05:33 +01:00
url.js Dynamic Routing Beta (#9596) 2018-06-05 19:02:20 +02:00