✨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 20:02:20 +03:00
|
|
|
const _ = require('lodash'),
|
2017-10-30 15:31:04 +03:00
|
|
|
api = require('../../api'),
|
|
|
|
helpers = require('../../helpers/register'),
|
|
|
|
filters = require('../../filters'),
|
2017-12-12 00:47:46 +03:00
|
|
|
common = require('../../lib/common'),
|
✨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 20:02:20 +03:00
|
|
|
routingService = require('../routing');
|
|
|
|
|
|
|
|
let generateProxyFunctions;
|
2013-11-15 06:17:33 +04:00
|
|
|
|
2016-04-14 20:32:43 +03:00
|
|
|
generateProxyFunctions = function (name, permissions, isInternal) {
|
✨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 20:02:20 +03:00
|
|
|
const appRouter = routingService.registry.getRouter('appRouter');
|
|
|
|
|
2014-04-22 04:22:13 +04:00
|
|
|
var getPermission = function (perm) {
|
|
|
|
return permissions[perm];
|
|
|
|
},
|
|
|
|
getPermissionToMethod = function (perm, method) {
|
|
|
|
var perms = getPermission(perm);
|
|
|
|
|
|
|
|
if (!perms) {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
return _.find(perms, function (name) {
|
|
|
|
return name === method;
|
|
|
|
});
|
|
|
|
},
|
|
|
|
runIfPermissionToMethod = function (perm, method, wrappedFunc, context, args) {
|
2016-04-14 20:32:43 +03:00
|
|
|
// internal apps get all permissions
|
|
|
|
if (isInternal) {
|
|
|
|
return wrappedFunc.apply(context, args);
|
|
|
|
}
|
|
|
|
|
2014-04-22 04:22:13 +04:00
|
|
|
var permValue = getPermissionToMethod(perm, method);
|
|
|
|
|
|
|
|
if (!permValue) {
|
2017-12-12 00:47:46 +03:00
|
|
|
throw new Error(common.i18n.t('errors.apps.accessResourceWithoutPermission.error', {
|
|
|
|
name: name,
|
|
|
|
perm: perm,
|
|
|
|
method: method
|
|
|
|
}));
|
2014-04-22 04:22:13 +04:00
|
|
|
}
|
|
|
|
|
|
|
|
return wrappedFunc.apply(context, args);
|
|
|
|
},
|
|
|
|
checkRegisterPermissions = function (perm, registerMethod) {
|
|
|
|
return _.wrap(registerMethod, function (origRegister, name) {
|
|
|
|
return runIfPermissionToMethod(perm, name, origRegister, this, _.toArray(arguments).slice(1));
|
|
|
|
});
|
|
|
|
},
|
|
|
|
passThruAppContextToApi = function (perm, apiMethods) {
|
|
|
|
var appContext = {
|
2017-11-01 16:44:54 +03:00
|
|
|
app: name
|
|
|
|
};
|
2014-04-22 04:22:13 +04:00
|
|
|
|
|
|
|
return _.reduce(apiMethods, function (memo, apiMethod, methodName) {
|
|
|
|
memo[methodName] = function () {
|
Refactor API arguments
closes #2610, refs #2697
- cleanup API index.js, and add docs
- all API methods take consistent arguments: object & options
- browse, read, destroy take options, edit and add take object and options
- the context is passed as part of options, meaning no more .call
everywhere
- destroy expects an object, rather than an id all the way down to the model layer
- route params such as :id, :slug, and :key are passed as an option & used
to perform reads, updates and deletes where possible - settings / themes
may need work here still
- HTTP posts api can find a post by slug
- Add API utils for checkData
2014-05-08 16:41:19 +04:00
|
|
|
var args = _.toArray(arguments),
|
|
|
|
options = args[args.length - 1];
|
|
|
|
|
|
|
|
if (_.isObject(options)) {
|
|
|
|
options.context = _.clone(appContext);
|
|
|
|
}
|
|
|
|
return apiMethod.apply({}, args);
|
2014-04-22 04:22:13 +04:00
|
|
|
};
|
|
|
|
|
|
|
|
return memo;
|
|
|
|
}, {});
|
|
|
|
},
|
|
|
|
proxy;
|
|
|
|
|
|
|
|
proxy = {
|
|
|
|
filters: {
|
|
|
|
register: checkRegisterPermissions('filters', filters.registerFilter.bind(filters)),
|
|
|
|
deregister: checkRegisterPermissions('filters', filters.deregisterFilter.bind(filters))
|
|
|
|
},
|
|
|
|
helpers: {
|
|
|
|
register: checkRegisterPermissions('helpers', helpers.registerThemeHelper.bind(helpers)),
|
|
|
|
registerAsync: checkRegisterPermissions('helpers', helpers.registerAsyncThemeHelper.bind(helpers))
|
|
|
|
},
|
2017-10-31 12:46:59 +03:00
|
|
|
// Expose the route service...
|
|
|
|
routeService: {
|
|
|
|
// This allows for mounting an entirely new Router at a path...
|
✨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 20:02:20 +03:00
|
|
|
registerRouter: checkRegisterPermissions('routes', appRouter.mountRouter.bind(appRouter))
|
2017-10-31 12:46:59 +03:00
|
|
|
},
|
|
|
|
// Mini proxy to the API - needs review
|
2014-04-22 04:22:13 +04:00
|
|
|
api: {
|
Refactor API arguments
closes #2610, refs #2697
- cleanup API index.js, and add docs
- all API methods take consistent arguments: object & options
- browse, read, destroy take options, edit and add take object and options
- the context is passed as part of options, meaning no more .call
everywhere
- destroy expects an object, rather than an id all the way down to the model layer
- route params such as :id, :slug, and :key are passed as an option & used
to perform reads, updates and deletes where possible - settings / themes
may need work here still
- HTTP posts api can find a post by slug
- Add API utils for checkData
2014-05-08 16:41:19 +04:00
|
|
|
posts: passThruAppContextToApi('posts',
|
|
|
|
_.pick(api.posts, 'browse', 'read', 'edit', 'add', 'destroy')
|
|
|
|
),
|
|
|
|
tags: passThruAppContextToApi('tags',
|
|
|
|
_.pick(api.tags, 'browse')
|
|
|
|
),
|
|
|
|
notifications: passThruAppContextToApi('notifications',
|
|
|
|
_.pick(api.notifications, 'browse', 'add', 'destroy')
|
|
|
|
),
|
|
|
|
settings: passThruAppContextToApi('settings',
|
|
|
|
_.pick(api.settings, 'browse', 'read', 'edit')
|
|
|
|
)
|
2014-04-22 04:22:13 +04:00
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
return proxy;
|
2013-11-29 20:26:56 +04:00
|
|
|
};
|
2013-11-15 06:17:33 +04:00
|
|
|
|
2014-04-22 04:22:13 +04:00
|
|
|
function AppProxy(options) {
|
|
|
|
if (!options.name) {
|
2017-12-12 00:47:46 +03:00
|
|
|
throw new Error(common.i18n.t('errors.apps.mustProvideAppName.error'));
|
2014-04-22 04:22:13 +04:00
|
|
|
}
|
|
|
|
|
|
|
|
if (!options.permissions) {
|
2017-12-12 00:47:46 +03:00
|
|
|
throw new Error(common.i18n.t('errors.apps.mustProvideAppPermissions.error'));
|
2014-04-22 04:22:13 +04:00
|
|
|
}
|
|
|
|
|
2016-04-14 20:32:43 +03:00
|
|
|
_.extend(this, generateProxyFunctions(options.name, options.permissions, options.internal));
|
2014-04-22 04:22:13 +04:00
|
|
|
}
|
|
|
|
|
|
|
|
module.exports = AppProxy;
|