@srfnstack/spliffy 1.1.4 → 1.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@srfnstack/spliffy",
-  "version": "1.1.4",
+  "version": "1.2.0",
   "author": "snowbldr",
   "private": false,
   "homepage": "https://github.com/narcolepticsnowman/spliffy",
@@ -33,7 +33,7 @@
     "cookie": "^0.4.1",
     "etag": "^1.8.1",
     "uuid": "^8.3.2",
-    "uWebSockets.js": "github:uNetworking/uWebSockets.js#v20.34.0"
+    "uWebSockets.js": "github:uNetworking/uWebSockets.js#v20.40.0"
   },
   "devDependencies": {
     "helmet": "^4.6.0",

package/src/decorator.mjs

@@ -45,20 +45,15 @@ export function decorateRequest (uwsReq, pathParameters, res, {
   const query = uwsReq.getQuery()
   req.path = uwsReq.getUrl()
   req.url = `${req.path}${query ? '?' + query : ''}`
+  const paramToIndex = pathParameters.reduce((acc, cur, i) => {
+    acc[cur] = i
+    return acc
+  }, {})
   req.spliffyUrl = {
     path: req.path,
     query: (query && parseQuery(query, decodeQueryParameters)) || {},
-    pathParameters: {}
+    param: name => uwsReq.getParameter(paramToIndex[name])
   }
-  if (pathParameters && pathParameters.length > 0) {
-    for (const i in pathParameters) {
-      req.spliffyUrl.pathParameters[pathParameters[i]] =
-        decodePathParameters
-          ? decodeURIComponent(uwsReq.getParameter(i))
-          : uwsReq.getParameter(i)
-    }
-  }
-  req.params = req.spliffyUrl.pathParameters
   req.query = req.spliffyUrl.query
   req.headers = {}
   uwsReq.forEach((header, value) => { req.headers[header] = value })
@@ -97,19 +92,21 @@ export function decorateResponse (res, req, finalizeResponse, errorTransformer,
     if (!res.statusCode) res.statusCode = httpStatusCodes.OK
     if (!res.statusMessage) res.statusMessage = defaultStatusMessages[res.statusCode]
     res.headersSent = true
-    res.writeStatus(`${res.statusCode} ${res.statusMessage}`)
-    if (typeof res.onFlushHeaders === 'function') {
-      res.onFlushHeaders(res)
-    }
-    for (const header of Object.keys(res.headers)) {
-      if (Array.isArray(res.headers[header])) {
-        for (const multiple of res.headers[header]) {
-          res.writeHeader(header, multiple.toString())
+    res.cork(() => {
+      res.writeStatus(`${res.statusCode} ${res.statusMessage}`)
+      if (typeof res.onFlushHeaders === 'function') {
+        res.onFlushHeaders(res)
+      }
+      for (const header of Object.keys(res.headers)) {
+        if (Array.isArray(res.headers[header])) {
+          for (const multiple of res.headers[header]) {
+            res.writeHeader(header, multiple.toString())
+          }
+        } else {
+          res.writeHeader(header, res.headers[header].toString())
         }
-      } else {
-        res.writeHeader(header, res.headers[header].toString())
       }
-    }
+    })
   }
   res.writeHead = (status, headers) => {
     res.statusCode = status
@@ -128,22 +125,26 @@ export function decorateResponse (res, req, finalizeResponse, errorTransformer,
     return this
   }
 
-  res.writeArrayBuffer = res.write
+  res.uwsWrite = res.write
   res.write = (chunk, encoding, cb) => {
     try {
-      res.streaming = true
-      res.flushHeaders()
       let result
-      if (chunk instanceof Buffer) {
-        result = res.writeArrayBuffer(toArrayBuffer(chunk))
-      } else if (typeof chunk === 'string') {
-        result = res.writeArrayBuffer(toArrayBuffer(Buffer.from(chunk, encoding || 'utf8')))
-      } else {
-        result = res.writeArrayBuffer(toArrayBuffer(Buffer.from(JSON.stringify(chunk), encoding || 'utf8')))
-      }
-      if (typeof cb === 'function') {
-        cb()
-      }
+      res.cork(() => {
+        res.streaming = true
+        res.flushHeaders()
+        let data
+        if (chunk instanceof Buffer) {
+          data = toArrayBuffer(chunk)
+        } else if (typeof chunk === 'string') {
+          data = toArrayBuffer(Buffer.from(chunk, encoding || 'utf8'))
+        } else {
+          data = toArrayBuffer(Buffer.from(JSON.stringify(chunk), encoding || 'utf8'))
+        }
+        result = res.uwsWrite(data)
+        if (typeof cb === 'function') {
+          cb()
+        }
+      })
       return result
     } catch (e) {
       if (typeof cb === 'function') {
@@ -181,10 +182,12 @@ export function decorateResponse (res, req, finalizeResponse, errorTransformer,
     }
     // provide writableEnded like node does, with slightly different behavior
     if (!res.writableEnded) {
-      res.flushHeaders()
-      uwsEnd.call(res, body)
-      res.writableEnded = true
-      res.ended = true
+      res.cork(() => {
+        res.flushHeaders()
+        uwsEnd.call(res, body)
+        res.writableEnded = true
+        res.ended = true
+      })
     }
     if (typeof res.onEnd === 'function') {
       res.onEnd()

package/src/handler.mjs

@@ -47,7 +47,11 @@ const endError = (res, e, refId, errorTransformer) => {
     e = errorTransformer(e, refId)
   }
   res.headers['x-ref-id'] = refId
-  end(res, e.statusCode || 500, null, e.body || '')
+  const status = e.statusCode || 500
+  if (status === 500) {
+    log.error(e)
+  }
+  end(res, status, null, e.body || '')
 }
 
 const end = (res, defaultStatusCode, statusCodeOverride, body) => {
@@ -56,7 +60,6 @@ const end = (res, defaultStatusCode, statusCodeOverride, body) => {
   if (body instanceof Readable || res.streaming) {
     res.streaming = true
     if (body instanceof Readable) {
-      res.flushHeaders()
       pipeResponse(res, body)
     }
     // handler is responsible for ending the response if they are streaming
@@ -65,10 +68,14 @@ const end = (res, defaultStatusCode, statusCodeOverride, body) => {
   }
 }
 
+const ipv6CompressRegex = /\b:?(?:0+:?){2,}/g
+
+const compressIpv6 = ip => ip && ip.includes(':') ? ip.replaceAll(ipv6CompressRegex, '::') : ip
+
 const writeAccess = function (req, res) {
   const start = new Date().getTime()
   return () => {
-    log.access(req.remoteAddress, res.proxiedRemoteAddress || '', res.statusCode, req.method, req.url, new Date().getTime() - start + 'ms')
+    log.access(compressIpv6(req.remoteAddress), compressIpv6(res.proxiedRemoteAddress) || '', res.statusCode, req.method, req.url, new Date().getTime() - start + 'ms')
   }
 }
 
@@ -233,7 +240,7 @@ export const createNotFoundHandler = config => {
             res.statusCode = 500
           })
         } else {
-          res.statusCode = 405
+          res.statusCode = 404
           res.end()
         }
       } else {

package/src/middleware.mjs

@@ -50,6 +50,7 @@ export const validateMiddleware = (middleware) => {
 }
 
 export const validateMiddlewareArray = (arr) => {
+  if (!arr) return
   if (!Array.isArray(arr)) {
     throw new Error('middleware must be an array of functions')
   }

package/src/server.mjs

@@ -39,7 +39,7 @@ const startHttpRedirect = (host, port) => {
   uws.App().any('/*',
     (req, res) => {
       try {
-        res.writeHead(301, { Location: `https://${req.headers.host}:${port}${req.url}` })
+        res.writeHead(301, { Location: `https://${req.headers.get('host')}:${port}${req.url}` })
         res.end()
       } catch (e) {
         log.error(`Failed to handle http request on port ${port}`, req.url, e)
@@ -91,18 +91,27 @@ export async function startServer (config) {
       if (config.defaultRoute && config.defaultRoute.match(routePattern)) {
         config.defaultRouteHandler = route
       }
+      let hadSlash = false
+      if (route.urlPath.endsWith('/')) {
+        hadSlash = true
+        route.urlPath = route.urlPath.substring(0, route.urlPath.length - 1)
+      }
       for (const method in route.handlers) {
         const theHandler = createHandler(route.handlers[method], route.middleware, route.pathParameters, config)
         app[appMethods[method]](route.urlPath, theHandler)
-        if (route.urlPath.endsWith('/') && route.urlPath.length > 1) {
-          app[appMethods[method]](route.urlPath.substr(0, route.urlPath.length - 1), theHandler)
+        if (hadSlash && config.serveRoutesWithSlash) {
+          app[appMethods[method]](route.urlPath + '/', theHandler)
         }
         if (route.urlPath.endsWith('/*')) {
           app[appMethods[method]](route.urlPath.substr(0, route.urlPath.length - 2), theHandler)
         }
       }
       if (config.autoOptions && !route.handlers.OPTIONS) {
-        app.options(route.urlPath, optionsHandler(config, route.middleware, Object.keys(route.handlers).join(', ')))
+        const theHandler = optionsHandler(config, route.middleware, Object.keys(route.handlers).join(', '))
+        app.options(route.urlPath, theHandler)
+        if (hadSlash && config.serveRoutesWithSlash) {
+          app.options(route.urlPath + '/', theHandler)
+        }
       }
     }
 

package/src/staticHandler.mjs

@@ -71,4 +71,4 @@ export function createStaticHandler (fullPath, contentType, cacheStatic, staticC
       }
     }
   }
-}
+}