Merge pull request #5 from fabrix-app/v1.1

[chore] update router

lib/config/index.ts

@@ -1,9 +1,10 @@
 import { spool } from './spool'
 import { web } from './web'
 import { session } from './session'
-
+import { router } from './router'
 export {
   spool,
   web,
-  session
+  session,
+  router
 }

lib/config/router.ts

@@ -0,0 +1,3 @@
+export const router = {
+  sortOrder: 'asc'
+}

lib/server.ts

@@ -259,8 +259,8 @@ export const Server = {
       })
     }
 
-    Object.keys(routes).forEach(r => {
-      const route = routes[r]
+    routes.forEach((route, r) => {
+
       RouterUtils.methods.forEach(m => {
         if (route[m]) {
           this.serverRoutes[m.toLowerCase() + ' ' + r] = {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fabrix/spool-express",
-  "version": "1.1.2",
+  "version": "1.1.3",
   "description": "Spool Express - Binds the routes compiled in spool-router to a Express 4 Server.",
   "homepage": "https://fabrix.app",
   "author": "Fabrix-app Team <[email protected]>",
@@ -56,12 +56,12 @@
     "methods": "^1.1.2"
   },
   "devDependencies": {
-    "@fabrix/fabrix": "^1.1.0",
+    "@fabrix/fabrix": "^1.1.1",
     "@fabrix/lint": "^1.0.0-alpha.3",
     "@fabrix/spool-i18n": "^1.1.0",
-    "@fabrix/spool-router": "^1.1.1",
+    "@fabrix/spool-router": "^1.1.2",
     "@fabrix/spool-sequelize": "^1.1.0",
-    "@fabrix/spool-tapestries": "^1.1.0",
+    "@fabrix/spool-tapestries": "^1.1.2",
     "@types/body-parser": "^1.17.0",
     "@types/compression": "0.0.36",
     "@types/cookie-parser": "^1.4.1",
@@ -91,8 +91,8 @@
     "typescript": "~2.8.1"
   },
   "peerDependencies": {
-    "@fabrix/fabrix": "^1.1.0",
-    "@fabrix/spool-router": "^1.1.1",
+    "@fabrix/fabrix": "^1.1.1",
+    "@fabrix/spool-router": "^1.1.2",
     "@fabrix/spool-i18n": "^1.1.0"
   },
   "engines": {

test/fixtures/api/controllers/DefaultController.js

@@ -39,4 +39,12 @@ module.exports = class DefaultController extends Controller {
     const where = req.jsonCriteria(req.query.where)
     res.json(where)
   }
+  worldController(req, res) {
+    const where = req.jsonCriteria(req.query.where)
+    res.json({world: where})
+  }
+  planetController(req, res) {
+    const where = req.jsonCriteria(req.query.where)
+    res.json({[req.params.planet]: where})
+  }
 }

test/fixtures/app.js

@@ -240,6 +240,16 @@ const App = {
       },
       '/jsonCriteria': {
         'GET': 'DefaultController.jsonCriteria'
+      },
+      // Routes that potentially could get out of order from the router.
+      '/test/earth': {
+        'GET': 'DefaultController.worldController'
+      },
+      '/test/:planet': {
+        'GET': 'DefaultController.planetController'
+      },
+      '/test/world': {
+        'GET': 'DefaultController.worldController'
       }
     },
     web: {

test/integration/controller.test.js

@@ -81,6 +81,41 @@ describe('express controllers', () => {
           done(err)
         })
     })
+
+    it('should test order', (done) => {
+      request
+        .get('/test/world')
+        .query({ where: {hello: 'world'}})
+        .expect(200)
+        .end((err, res) => {
+          assert.ok(res.body)
+          assert.deepEqual(res.body, { world: { hello: 'world' } })
+          done(err)
+        })
+    })
+    // TODO fix spool-router and come back to this
+    it.skip('should test order', (done) => {
+      request
+        .get('/test/earth')
+        .query({ where: {hello: 'world'}})
+        .expect(200)
+        .end((err, res) => {
+          assert.ok(res.body)
+          assert.deepEqual(res.body, { world: { hello: 'world' } })
+          done(err)
+        })
+    })
+    it('should test order', (done) => {
+      request
+        .get('/test/mars')
+        .query({ where: {hello: 'mars'}})
+        .expect(200)
+        .end((err, res) => {
+          assert.ok(res.body)
+          assert.deepEqual(res.body, {mars: { hello: 'mars' } })
+          done(err)
+        })
+    })
   })
   describe('ViewController', () => {
     describe('helloWorld', () => {

test/unit/utils/routeSortOrder.test.js

@@ -1,13 +1,15 @@
 'use strict'
 /* global describe, it */
 const assert = require('assert')
+const routeOrder = require('@fabrix/spool-router').Utils.createSpecificityComparator
 const sort = require('@fabrix/spool-router').Utils.sortRoutes
 
 describe('Utils Route Sort Order', () => {
   it('should exist', () => {
+    assert(routeOrder)
     assert(sort)
   })
-  it('should sort the routes for express', () => {
+  it('should sort the routes for free variables (express style)', () => {
     let routes = {
       '/a': {},
       '/a/:id': {},
@@ -23,9 +25,11 @@ describe('Utils Route Sort Order', () => {
       '/b/*': {}
     }
 
-    routes = sort(routes, {order: 'asc'})
-
-    assert.deepEqual(routes, {
+    routes = sort(routes, 'asc')
+    assert(routes)
+    console.log(routes)
+    const ordered = new Map()
+    const order = {
       '/a': {},
       '/a/:id': {},
       '/a/*': {},
@@ -37,11 +41,15 @@ describe('Utils Route Sort Order', () => {
       '/b/:id/:world': {},
       '/b/:id/*': {},
       '/': {},
-      '*': {}
+      '*': {},
+    }
+    Object.keys(order).forEach(k => {
+      ordered.set(k, order[k])
     })
+    assert.deepEqual(routes, ordered)
   })
 
-  it('should sort the routes for free variables', () => {
+  it('should sort the routes for free variables (hapi style)', () => {
     let routes = {
       '/a': {},
       '/a/{id}': {},
@@ -58,8 +66,49 @@ describe('Utils Route Sort Order', () => {
     }
 
     routes = sort(routes, 'asc')
+    assert(routes)
+
+    const ordered = new Map()
+    const order = {
+      '/a': {},
+      '/a/{id}': {},
+      '/a/*': {},
+      '/a/{id}/{world}': {},
+      '/a/{id}/*': {},
+      '/b': {},
+      '/b/{id}': {},
+      '/b/*': {},
+      '/b/{id}/{world}': {},
+      '/b/{id}/*': {},
+      '/': {},
+      '*': {},
+    }
+    Object.keys(order).forEach(k => {
+      ordered.set(k, order[k])
+    })
+    assert.deepEqual(routes, ordered)
+  })
+
+  it('should sort the routes for free variables desc', () => {
+    let routes = {
+      '/a': {},
+      '/a/{id}': {},
+      '/a/*': {},
+      '/b': {},
+      '/a/{id}/{world}': {},
+      '/a/{id}/*': {},
+      '*': {},
+      '/b/{id}/{world}': {},
+      '/': {},
+      '/b/{id}/*': {},
+      '/b/{id}': {},
+      '/b/*': {},
+    }
 
-    assert.deepEqual(routes, {
+    routes = sort(routes, 'desc')
+    assert(routes)
+    const ordered = new Map()
+    const order = {
       '/a': {},
       '/a/{id}': {},
       '/a/*': {},
@@ -72,6 +121,78 @@ describe('Utils Route Sort Order', () => {
       '/b/{id}/*': {},
       '/': {},
       '*': {},
+    }
+    Object.keys(order).forEach(k => {
+      ordered.set(k, order[k])
     })
+    assert.deepEqual(routes, ordered)
+  })
+
+  it('should sort the routes for free variables asc', () => {
+    let routes = {
+      '/a': {},
+      '/a/{id}': {},
+      '/a/*': {},
+      '/b': {},
+      '/a/{id}/{world}': {},
+      '/a/{id}/*': {},
+      '*': {},
+      '/b/{id}/{world}': {},
+      '/': {},
+      '/b/{id}/*': {},
+      '/b/{id}': {},
+      '/b/*': {},
+    }
+
+    const order = Object.keys(routes).sort(routeOrder({order: 'asc'}))
+    assert.deepEqual(order, [
+      '/a',
+      '/a/{id}',
+      '/a/*',
+      '/a/{id}/{world}',
+      '/a/{id}/*',
+      '/b',
+      '/b/{id}',
+      '/b/*',
+      '/b/{id}/{world}',
+      '/b/{id}/*',
+      '/',
+      '*',
+    ])
+  })
+
+  // TODO
+  it.skip('should sort the routes for free variables desc', () => {
+    let routes = {
+      '/a': {},
+      '/a/{id}': {},
+      '/a/*': {},
+      '/b': {},
+      '/a/{id}/{world}': {},
+      '/a/{id}/*': {},
+      '*': {},
+      '/b/{id}/{world}': {},
+      '/': {},
+      '/b/{id}/*': {},
+      '/b/{id}': {},
+      '/b/*': {},
+    }
+
+    const order = Object.keys(routes).sort(routeOrder({order: 'desc'}))
+    console.log('BROKE', order)
+    assert.deepEqual(order, [
+      '*',
+      '/',
+      '/b/{id}/*',
+      '/b/{id}/{world}',
+      '/b/*',
+      '/b/{id}',
+      '/b',
+      '/a/{id}/*',
+      '/a/{id}/{world}',
+      '/a/*',
+      '/a/{id}',
+      '/a'
+    ])
   })
 })