0
Fork 0
mirror of https://github.com/TryGhost/Ghost.git synced 2025-01-20 22:42:53 -05:00
ghost/core/server/helpers
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
..
tpl Removed html usage in error messages (#9444) 2018-02-07 09:35:48 +01:00
asset.js Fixed single lodash import 2018-06-04 22:44:41 +02:00
author.js Dynamic Routing Beta (#9596) 2018-06-05 19:02:20 +02:00
authors.js Dynamic Routing Beta (#9596) 2018-06-05 19:02:20 +02:00
body_class.js Switch to Eslint (#9197) 2017-11-01 13:44:54 +00:00
content.js Helper Proxy & single express-hbs instance (#8225) 2017-04-04 18:07:35 +02:00
date.js Theme translations and blog localisation (#8437) 2018-01-09 14:50:57 +01:00
encode.js Helper Proxy & single express-hbs instance (#8225) 2017-04-04 18:07:35 +02:00
excerpt.js 🐛 Fixed custom post excerpt length (#8826) 2017-08-02 15:09:12 +04:00
facebook_url.js Fixed comment in facebook_url helper (#9430) 2018-01-28 18:25:06 +01:00
foreach.js Moved visibility utility to static model fn (#9327) 2017-12-13 13:19:51 +01:00
get.js Fixed broken i18n keys 2018-04-18 15:05:20 +02:00
ghost_foot.js Switch to Eslint (#9197) 2017-11-01 13:44:54 +00:00
ghost_head.js Removed unnecessary type attribute in script tags (#9586) 2018-04-18 14:33:31 +02:00
has.js 🔥 Drop Node v4 Support 2018-05-01 14:06:18 +02:00
img_url.js Dynamic Routing Beta (#9596) 2018-06-05 19:02:20 +02:00
index.js Multiple authors (#9426) 2018-03-27 15:16:15 +01:00
is.js Helper Proxy & single express-hbs instance (#8225) 2017-04-04 18:07:35 +02:00
lang.js Theme translations and blog localisation (#8437) 2018-01-09 14:50:57 +01:00
meta_description.js Switch to Eslint (#9197) 2017-11-01 13:44:54 +00:00
meta_title.js 🐛Fixed i18n for the {{meta_title}} helper (#9468) 2018-03-19 09:48:07 +01:00
navigation.js Helper Proxy & single express-hbs instance (#8225) 2017-04-04 18:07:35 +02:00
page_url.js Switch to Eslint (#9197) 2017-11-01 13:44:54 +00:00
pagination.js 🎨 Improved pagination misusage error 2017-11-28 13:44:14 +00:00
plural.js Theme translations and blog localisation (#8437) 2018-01-09 14:50:57 +01:00
post_class.js Switch to Eslint (#9197) 2017-11-01 13:44:54 +00:00
prev_next.js Multiple authors (#9426) 2018-03-27 15:16:15 +01:00
proxy.js Dynamic Routing Beta (#9596) 2018-06-05 19:02:20 +02:00
reading_time.js 🎨Removed seconds option from {{reading_time}} (#9573) 2018-04-18 10:55:08 +08:00
register.js Moved labs, auth, permissions, settings, mail, themes to services (#9339) 2017-12-14 03:01:23 +01:00
t.js Theme translations and blog localisation (#8437) 2018-01-09 14:50:57 +01:00
tags.js Dynamic Routing Beta (#9596) 2018-06-05 19:02:20 +02:00
template.js Moved labs, auth, permissions, settings, mail, themes to services (#9339) 2017-12-14 03:01:23 +01:00
title.js Helper Proxy & single express-hbs instance (#8225) 2017-04-04 18:07:35 +02:00
twitter_url.js Moved social utility to lib/social 2017-12-14 22:34:05 +01:00
url.js Helper Proxy & single express-hbs instance (#8225) 2017-04-04 18:07:35 +02:00
utils.js 🔥 Drop Node v4 Support 2018-05-01 14:06:18 +02:00