@architect/inventory 2.2.0 → 2.2.1-RC.0

package/changelog.md

@@ -2,6 +2,14 @@
 
 ---
 
+## [2.2.1] 2021-11-22
+
+### Fixed
+
+- Adds HTTP route sorting, which should ensure Sandbox behaves much more like API Gateway despite how you've organized your `@http` pragma; fixes #977
+
+---
+
 ## [2.2.0] 2021-11-16
 
 ### Added

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@architect/inventory",
-  "version": "2.2.0",
+  "version": "2.2.1-RC.0",
   "description": "Architect project resource enumeration utility",
   "main": "src/index.js",
   "scripts": {

package/src/config/pragmas/http.js

@@ -2,6 +2,7 @@ let { join } = require('path')
 let populate = require('./populate-lambda')
 let asapSrc = require('../../lib/asap-src')
 let validate = require('./validate')
+let sort = require('./sort/http')
 
 module.exports = function configureHTTP ({ arc, inventory, errors }) {
   if (!arc.http) return null
@@ -67,7 +68,9 @@ module.exports = function configureHTTP ({ arc, inventory, errors }) {
   // Impure but it's way less complicated to just do this
   inventory._project.rootHandler = rootHandler
 
+  // Final steps: validate, then ensure the route order works as API Gateway would
   validate.http(http, errors)
+  http = sort(http)
 
   return http
 }

package/src/config/pragmas/sort/http.js

@@ -0,0 +1,71 @@
+let methods = require('../../../lib/http-methods')
+
+/**
+ * HTTP route sorter; this is a multifurcating tree, so we'll do a few passes
+ * Broadly in the theme of most to least specific:
+ * - First, by method, with `any` last
+ * - Then by path depth (descending)
+ * - Within each depth downrank for contained params
+ * - Then sort alphabetically
+ * - Then, ensure trailing captures are last
+ * - Finally, ensure root captures rank below a root literal
+ */
+module.exports = function sortHTTP (http) {
+  // Construct the tree from HTTP methods
+  let tree = {}
+  http.forEach(({ method, path }) => {
+    if (!tree[method]) tree[method] = []
+    let parts = path.split('/').filter(Boolean)
+    let depth = parts.length
+    let item = { depth, path }
+    let param = /\/:/
+    if (path.match(param)) {
+      item.hasParam = true
+      item.paramIndex = path.match(param).index // If multiple, we want the earliest
+    }
+    if (parts.length) {
+      if (parts[depth - 1] === '*') item.trailingCapture = 'catchall'
+      if (parts[depth - 1].startsWith(':')) item.trailingCapture = 'param'
+    }
+    tree[method].push(item)
+  })
+
+  // Multi-pass route sort
+  let sorted = []
+  methods.forEach(method => {
+    if (!tree[method]) return
+    /* istanbul ignore next: random test shuffles may not trigger all paths */
+    tree[method]
+      // Sort by depth
+      .sort((a, b) => b.depth - a.depth)
+      // Sort within a given depth
+      .sort((a, b) => {
+        // Handle root (depth: 0)
+        if (a.depth - b.depth < 0) return
+        if (a.hasParam && b.hasParam) {
+          // Sort at the earliest param
+          if (a.paramIndex < b.paramIndex) return 1
+          if (a.paramIndex > b.paramIndex) return -1
+          // Then sort alphabetically
+          if (a.path < b.path) return -1
+          if (a.path > b.path) return 1
+        }
+        if (a.hasParam) return 1
+        if (b.hasParam) return -1
+        if (a.path < b.path) return -1
+        if (a.path > b.path) return 1
+      })
+      .sort((a, b) => {
+        if (!a.depth && b.depth === 1 && b.trailingCapture) return -1
+        if (a.depth - b.depth < 0) return
+        if (a.trailingCapture) return 1
+        if (b.trailingCapture) return -1
+      })
+    tree[method].forEach(({ path }) => {
+      let route = http.find(i => i.method === method && i.path === path)
+      sorted.push(route)
+    })
+  })
+
+  return sorted
+}

package/src/config/pragmas/validate/_http.js

@@ -1,10 +1,10 @@
 let { unique } = require('./_lib')
+let methods = require('../../../lib/http-methods')
 
 module.exports = function validateHTTP (http, errors) {
   if (http.length) {
     unique(http, '@http routes', errors)
 
-    let methods = [ 'get', 'post', 'put', 'patch', 'delete', 'options', 'head', 'any' ]
     let validMethod = str => methods.includes(str.toLowerCase())
     let validPath = str => str.match(/^\/[a-zA-Z0-9/\-:._\*]*$/)
     http.forEach(route => {

package/src/lib/http-methods.js

@@ -0,0 +1,2 @@
+// Any must come last for Sandbox route sorting purposes
+module.exports = [ 'get', 'post', 'put', 'patch', 'delete', 'options', 'head', 'any' ]