Ghost/core/test/integration/api
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
..
advanced_browse_spec.js Multiple authors (#9426) 2018-03-27 15:16:15 +01:00
api_authentication_spec.js Sorted out the mixed usages of include and withRelated (#9425) 2018-02-15 10:53:53 +01:00
api_configuration_spec.js Fixed incorrect return value for publicAPI from the configuration endpoint 2018-05-31 15:14:59 +02:00
api_db_spec.js Fixed post.unpublished when deleting all content 2018-04-06 15:49:25 +02:00
api_invites_spec.js Use Bookshelf in our test env (#9592) 2018-04-25 17:13:35 +02:00
api_mail_spec.js Import lib/common only 2017-12-12 10:28:13 +01:00
api_notifications_spec.js Use Bookshelf in our test env (#9592) 2018-04-25 17:13:35 +02:00
api_posts_spec.js Dynamic Routing Beta (#9596) 2018-06-05 19:02:20 +02:00
api_roles_spec.js Use Bookshelf in our test env (#9592) 2018-04-25 17:13:35 +02:00
api_schedules_spec.js Use Bookshelf in our test env (#9592) 2018-04-25 17:13:35 +02:00
api_settings_spec.js Use Bookshelf in our test env (#9592) 2018-04-25 17:13:35 +02:00
api_slugs_spec.js Use Bookshelf in our test env (#9592) 2018-04-25 17:13:35 +02:00
api_subscribers_spec.js Use Bookshelf in our test env (#9592) 2018-04-25 17:13:35 +02:00
api_tags_spec.js Use Bookshelf in our test env (#9592) 2018-04-25 17:13:35 +02:00
api_users_spec.js Use Bookshelf in our test env (#9592) 2018-04-25 17:13:35 +02:00
api_webhooks_spec.js Contributor Role (#9315) 2018-02-07 10:46:22 +01:00
redirects_spec.js Bump sinon to version 4.1.2 (#9283) 2017-11-28 18:19:23 +01:00