@superhero/http-server 4.4.7 → 4.7.1

package/README.md

@@ -67,7 +67,7 @@ const settings = {
   router: {
     routes: {
       hello: {
-        criteria: '/hello',
+        condition: '/hello',
         dispatcher: 'hello-dispatcher',
       },
     },
@@ -115,7 +115,7 @@ const serverSettings = {
   router: {
     routes: {
       secure: {
-        criteria: '/secure',
+        condition: '/secure',
         dispatcher: 'secure-dispatcher',
       },
     },
@@ -145,7 +145,7 @@ const settings = {
   router: {
     routes: {
       custom: {
-        criteria: '/custom',
+        condition: '/custom',
         dispatcher: 'custom-dispatcher',
       },
     },
@@ -174,7 +174,7 @@ const settings = {
   router: {
     routes: {
       abort: {
-        criteria: '/abort',
+        condition: '/abort',
         dispatcher: 'abort-dispatcher',
       },
     },
@@ -208,7 +208,7 @@ const settings = {
   router: {
     routes: {
       sse: {
-        criteria: '/sse',
+        condition: '/sse',
         dispatcher: 'sse-dispatcher',
       },
     },

package/conditions/upstream/header/accept.js

@@ -0,0 +1,13 @@
+export default
+{
+  isValid(request, session)
+  {
+    const
+      header      = request.headers['accept'],
+      lowerCased  = header.toLowerCase(),
+      accept      = lowerCased.split(';')[0].split('*')[0].trim()
+
+    return [session.route['condition.accept']].flat().some(supported =>
+      supported.startsWith(accept) || accept.startsWith(supported.split('*')[0]))
+  }
+}

package/conditions/upstream/header/content-type.js

@@ -0,0 +1,13 @@
+export default
+{
+  isValid(request, session)
+  {
+    const
+      header      = request.headers['content-type'],
+      lowerCased  = header.toLowerCase(),
+      contentType = lowerCased.split(';')[0].split('*')[0].trim()
+
+    return [session.route['condition.content-type']].flat().some(supported =>
+      supported.startsWith(contentType) || contentType.startsWith(supported.split('*')[0]))
+  }
+}

package/conditions/upstream/method.js

@@ -0,0 +1,7 @@
+export default
+{
+  isValid(request, session)
+  {
+    return [session.route['condition.method']].flat().includes(request.method)
+  }
+}

package/index.js

@@ -231,17 +231,17 @@ export default class HttpServer
     this.log.info`${requestID} ⇡ request`
 
     const
-      session     = {},
-      request     = {},
-      url         = new URL(upstream.url, `${protocol}://${upstream.headers.host}`),
-      criteria    = url.pathname.replace(/\/+$/, ''), // removed trailing slashes
-      body        = this.#bufferBody(upstream, request),
-      abortion    = new AbortController
+      session   = {},
+      request   = {},
+      url       = new URL(upstream.url, `${protocol}://${upstream.headers.host}`),
+      condition = url.pathname.replace(/\/+$/, ''), // removed trailing slashes
+      body      = this.#bufferBody(upstream, request),
+      abortion  = new AbortController
 
     Object.defineProperties(request, 
     {
-      // configurable and writable criteria property
-      criteria    : { writable:true, configurable:true, value:criteria },
+      // configurable and writable condition property
+      condition   : { writable:true, configurable:true, value:condition },
       // configurable and writable stream data reader
       body        : { writable:true, configurable:true, value:body },
       // enumerable data readers, non-configurable 
@@ -254,7 +254,7 @@ export default class HttpServer
       // non enumerable and non-configurable session properties
       downstream  : { value:downstream },
       upstream    : { value:upstream },
-      abortion    : { value:abortion }
+      abortion    : { value:abortion },
     })
 
     Object.defineProperty(session, 'view', { enumerable: true, value: new View(session) })

package/index.test.js

@@ -135,14 +135,14 @@ suite('@superhero/http-server', () =>
 
       test('Support connection keep-alive header', async () => 
       {
+        locator.set('foo-dispatcher', { dispatch: () => null })
+
         server.router.setRoutes(
           { 'foo':
-            { criteria   : '/test/foo',
+            { condition  : '/test/foo',
               dispatcher : 'foo-dispatcher'
             }})
 
-        locator.set('foo-dispatcher', { dispatch: () => null })
-
         // Set the keep-alive timeout to 10 seconds on the server.
         const keepAlive = 10
         server.http1Server.keepAliveTimeout = keepAlive * 1e3
@@ -172,19 +172,19 @@ suite('@superhero/http-server', () =>
     {
       test('Can dispatch a request aligned to the route map', async () => 
       {
+        let dispatched
+        locator.set('foo-dispatcher', { dispatch: () => dispatched = 'foo' })
+        locator.set('bar-dispatcher', { dispatch: () => dispatched = 'bar' })
+
         server.router.setRoutes(
           { 'foo':
-            { criteria   : '/test/foo',
+            { condition  : '/test/foo',
               dispatcher : 'foo-dispatcher'
             },
             'bar':
-            { criteria   : '/test/bar',
+            { condition  : '/test/bar',
               dispatcher : 'bar-dispatcher' }})
 
-        let dispatched
-        locator.set('foo-dispatcher', { dispatch: () => dispatched = 'foo' })
-        locator.set('bar-dispatcher', { dispatch: () => dispatched = 'bar' })
-
         const fooResponse = await request.get(`/test/foo`)
 
         assert.equal(fooResponse.status, 200, 'Should have received a 200 status')
@@ -197,14 +197,14 @@ suite('@superhero/http-server', () =>
 
       test('Can alter the output body', async () => 
       {
+        locator.set('foo-dispatcher', 
+          { dispatch: (_, session) => session.view.body.foo = 'bar' })
+
         server.router.setRoutes(
           { 'foo':
-            { criteria   : '/test/foo',
+            { condition  : '/test/foo',
               dispatcher : 'foo-dispatcher' }})
 
-        locator.set('foo-dispatcher', 
-          { dispatch: (_, session) => session.view.body.foo = 'bar' })
-
         const response = await request.get(`/test/foo`)
         assert.equal(response.status, 200, 'Should have received a 200 status')
         assert.equal(response.body.foo, 'bar', 'Response body should have been altered')
@@ -212,11 +212,6 @@ suite('@superhero/http-server', () =>
 
       test('Can stream HTML5 standard Server-Sent Events (SSE)', async () => 
       {
-        server.router.setRoutes(
-          { 'sse':
-            { criteria   : '/test/sse',
-              dispatcher : 'sse-dispatcher' }})
-
         locator.set('sse-dispatcher', 
           { dispatch: (_, session) => 
             {
@@ -226,6 +221,11 @@ suite('@superhero/http-server', () =>
               session.view.stream.end()
             }})
 
+        server.router.setRoutes(
+          { 'sse':
+            { condition  : '/test/sse',
+              dispatcher : 'sse-dispatcher' }})
+
         const response = await request.get(`/test/sse`)
 
         assert.equal(response.status, 200, 'Should have received a 200 status')
@@ -237,14 +237,14 @@ suite('@superhero/http-server', () =>
 
       test('Can alter the output headers', async () => 
       {
-        server.router.setRoutes(
-          { 'foo':
-            { criteria   : '/test/foo',
-              dispatcher : 'foo-dispatcher' }})
-
         locator.set('foo-dispatcher', 
           { dispatch: (_, session) => session.view.headers.foo = 'bar' })
 
+        server.router.setRoutes(
+          { 'foo':
+            { condition  : '/test/foo',
+              dispatcher : 'foo-dispatcher' }})
+  
         const response = await request.get(`/test/foo`)
         assert.equal(response.status, 200, 'Should have received a 200 status')
         assert.equal(response.headers.foo, 'bar', 'Response header should have been altered')
@@ -252,28 +252,28 @@ suite('@superhero/http-server', () =>
 
       test('Can alter the output status', async () => 
       {
-        server.router.setRoutes(
-          { 'foo':
-            { criteria   : '/test/foo',
-              dispatcher : 'foo-dispatcher' }})
-
         locator.set('foo-dispatcher', 
           { dispatch: (_, session) => session.view.status = 204 })
 
+        server.router.setRoutes(
+          { 'foo':
+            { condition  : '/test/foo',
+              dispatcher : 'foo-dispatcher' }})
+  
         const response = await request.get(`/test/foo`)
         assert.equal(response.status, 204, 'Should have received a 204 status')
       })
 
       test('Can abort the dispatcher', async () => 
       {
-        server.router.setRoutes(
-          { 'foo':
-            { criteria   : '/test/foo',
-              dispatcher : 'foo-dispatcher' }})
-
         locator.set('foo-dispatcher', 
           { dispatch: (_, session) => session.abortion.abort(new Error('Aborted')) })
 
+        server.router.setRoutes(
+          { 'foo':
+            { condition  : '/test/foo',
+              dispatcher : 'foo-dispatcher' }})
+  
         const response = await request.get(`/test/foo`)
 
         assert.equal(response.status, 500, 'Should have failed with a 500 status')
@@ -282,11 +282,6 @@ suite('@superhero/http-server', () =>
 
       test('Can describe an abortion in detail', async () => 
       {
-        server.router.setRoutes(
-          { 'foo':
-            { criteria   : '/test/foo',
-              dispatcher : 'foo-dispatcher' }})
-
         locator.set('foo-dispatcher', 
         {
           dispatch: (_, session) => 
@@ -300,6 +295,11 @@ suite('@superhero/http-server', () =>
           }
         })
 
+        server.router.setRoutes(
+          { 'foo':
+            { condition  : '/test/foo',
+              dispatcher : 'foo-dispatcher' }})
+
         const response = await request.get(`/test/foo`)
 
         assert.equal(response.status, 500, 'Should have failed with a 500 status')
@@ -311,11 +311,6 @@ suite('@superhero/http-server', () =>
 
       test('Can manage thrown errors in the dispatcher', async () => 
       {
-        server.router.setRoutes(
-          { 'foo':
-            { criteria   : '/test/foo',
-              dispatcher : 'foo-dispatcher' }})
-
         locator.set('foo-dispatcher', 
         { 
           dispatch: () => 
@@ -326,6 +321,11 @@ suite('@superhero/http-server', () =>
           }
         })
 
+        server.router.setRoutes(
+          { 'foo':
+            { condition  : '/test/foo',
+              dispatcher : 'foo-dispatcher' }})
+
         let errorLoggerCalled = false
 
         server.log.on('fail', (_, error) => 
@@ -345,14 +345,14 @@ suite('@superhero/http-server', () =>
 
       test('Can not mistakenly access the wrong view property', async () => 
       {
-        server.router.setRoutes(
-          { 'foo':
-            { criteria   : '/test/foo',
-              dispatcher : 'foo-dispatcher' }})
-
         locator.set('foo-dispatcher',
           { dispatch: (_, session) => session.view.invalidAttribute })
 
+        server.router.setRoutes(
+          { 'foo':
+            { condition  : '/test/foo',
+              dispatcher : 'foo-dispatcher' }})
+  
         let errorLoggerCalled = false
 
         server.log.on('fail', (_, error) => 
@@ -371,14 +371,13 @@ suite('@superhero/http-server', () =>
 
       test('Can not mistakenly assign a value to the wrong view property', async () => 
       {
-        server.router.setRoutes(
-          { 'foo':
-            { criteria   : '/test/foo',
-              dispatcher : 'foo-dispatcher' }})
-
         locator.set('foo-dispatcher',
           { dispatch: (_, session) => session.view.invalidAttribute = 'This should not be possible' })
 
+        server.router.setRoutes(
+          { 'foo':
+            { condition  : '/test/foo',
+              dispatcher : 'foo-dispatcher' }})
         
         let errorLoggerCalled = false
 
@@ -430,17 +429,17 @@ suite('@superhero/http-server', () =>
 
             fs.rmSync('test', { recursive: true, force: true })
 
+            locator.set('test-dispatcher', 
+              { dispatch: (_, session) => session.view.body.dispatched = true })
+
             await assert.doesNotReject(server.bootstrap(
               { server: { cert, key, minVersion: tlsVersion, maxVersion: tlsVersion }, 
                 router:
                 { routes:
                   { 'test':
-                    { criteria   : '/test',
+                    { condition  : '/test',
                       dispatcher : 'test-dispatcher' }}}}))
 
-            locator.set('test-dispatcher', 
-              { dispatch: (_, session) => session.view.body.dispatched = true })
-
             assert.ok(server.gateway      instanceof tls.Server)
             assert.ok(server.http1Server  instanceof https.Server)
             assert.ok(server.http2Server?.constructor.name === 'Http2SecureServer')

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@superhero/http-server",
-  "version": "4.4.7",
+  "version": "4.7.1",
   "description": "HTTP(S) server component supporting both HTTP 1.1 and HTTP 2.0",
   "keywords": [
     "http server",
@@ -22,18 +22,21 @@
     "./*/*/*/*/*": "./*/*/*/*/*.js",
     "./*/*/*/*/*/*": "./*/*/*/*/*/*.js"
   },
+  "scripts": {
+    "syntax-check": "syntax-check",
+    "test": "syntax-check; node --test --test-reporter=@superhero/audit/reporter --experimental-test-coverage"
+  },
   "dependencies": {
-    "@superhero/router": "^4.1.9",
-    "@superhero/deep": "^4.5.0",
-    "@superhero/log": "^4.0.2",
-    "@superhero/id-name-generator": "^4.0.0"
+    "@superhero/router": "4.7.1",
+    "@superhero/deep": "4.7.1",
+    "@superhero/log": "4.7.1",
+    "@superhero/id-name-generator": "4.7.1"
   },
   "devDependencies": {
-    "@superhero/locator": "^4.4.5",
-    "@superhero/http-request": "^4.0.10"
-  },
-  "scripts": {
-    "test": "node --trace-warnings --test --experimental-test-coverage"
+    "@superhero/audit": "4.7.1",
+    "@superhero/syntax-check": "0.0.2",
+    "@superhero/locator": "4.7.1",
+    "@superhero/http-request": "4.7.1"
   },
   "author": {
     "name": "Erik Landvall",
@@ -41,6 +44,6 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/superhero/http-server.git"
+    "url": "https://github.com/superhero/http-server.git"
   }
 }