Add route registration option. (#110)

CHANGELOG.md

@@ -2,6 +2,9 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## Unreleased
+### Added option to allow output routes to be registered before provider routes; if true any conflicts will default to output routes
+
 ## [3.17.3] - 2020-03-26
 ### Fixed
 * Prevent overwriting cache and option assignments that occur in provider model constructors

src/helpers/register-plugin-routes.js

@@ -2,7 +2,7 @@ const _ = require('lodash')
 const validateHttpMethods = require('./validate-http-methods')
 const composeRouteString = require('./compose-route-string')
 
-function registerProviderRoutes ({ provider, controller, server, pluginRoutes }, options = {}) {
+function registerPluginRoutes ({ provider, controller, server, pluginRoutes }, options = {}) {
   const namespace = provider.namespace.replace(/\s/g, '').toLowerCase()
   const { hosts, disableIdParam } = provider
   const { routePrefix } = options
@@ -58,4 +58,4 @@ function addMethodsToRouteMap (map, path, methods) {
   _.set(map, path, _.concat(existingMethods, methods))
 }
 
-module.exports = registerProviderRoutes
+module.exports = registerPluginRoutes

src/index.js

@@ -35,7 +35,8 @@ const providerOptionsSchema = Joi.object({
   routePrefix: Joi.string().optional(),
   before: Joi.function().arity(2).optional(),
   after: Joi.function().arity(3).optional(),
-  name: Joi.string().optional()
+  name: Joi.string().optional(),
+  defaultToOutputRoutes: Joi.boolean().optional()
 }).unknown(true)
 
 function Koop (config) {
@@ -202,11 +203,21 @@ function extend (klass, extender) {
  * @param {object} controller - the initiated provider's controller
  * @param {object} server - the koop express server
  */
-function registerRoutes ({ provider, controller, server, pluginRoutes }, options) {
-  // Provider-routes are bound first; any routing conflicts will result in requests routed to provider
-  const providerRouteMap = registerProviderRoutes({ provider, controller, server }, options)
+function registerRoutes ({ provider, controller, server, pluginRoutes }, options = {}) {
+  // Plugin and provider-routes may conflict; which ever is registered first gets precendence; default is provider route precedence
+  if (options.defaultToOutputRoutes) return registerPluginRoutesFirst({ provider, controller, server, pluginRoutes }, options)
+  return registerProviderRoutesFirst({ provider, controller, server, pluginRoutes }, options)
+}
+
+function registerPluginRoutesFirst ({ provider, controller, server, pluginRoutes }, options = {}) {
   const pluginRouteMap = registerPluginRoutes({ provider, controller, server, pluginRoutes }, options)
+  const providerRouteMap = registerProviderRoutes({ provider, controller, server }, options)
+  return { providerRouteMap, pluginRouteMap }
+}
 
+function registerProviderRoutesFirst ({ provider, controller, server, pluginRoutes }, options = {}) {
+  const providerRouteMap = registerProviderRoutes({ provider, controller, server }, options)
+  const pluginRouteMap = registerPluginRoutes({ provider, controller, server, pluginRoutes }, options)
   return { providerRouteMap, pluginRouteMap }
 }
 

test/index-test.js

@@ -41,6 +41,18 @@ describe('Index tests for registering providers', function () {
       providerRouteIndex.should.be.below(pluginRouteIndex)
     })
 
+    it('should register plugin-routes before provider-routes', function () {
+      const koop = new Koop()
+      koop.register(_.cloneDeep(provider), { defaultToOutputRoutes: true })
+      // Check that the stack index of the plugin routes are prior to index of provider routes
+      const routePaths = koop.server._router.stack
+        .filter((layer) => { return _.has(layer, 'route.path') })
+        .map(layer => { return _.get(layer, 'route.path') })
+      const pluginRouteIndex = routePaths.findIndex(path => path.includes('/test-provider/:id/FeatureServer'))
+      const providerRouteIndex = routePaths.findIndex(path => path.includes('/fake/:id'))
+      pluginRouteIndex.should.be.below(providerRouteIndex)
+    })
+
     it('should register successfully and attach cache and options object to model', function () {
       const koop = new Koop()
       koop.register(_.cloneDeep(provider), { routePrefix: 'path-to-route' })