refactor: optimize internal read function

Author: Phillip9587

lib/read.js

@@ -11,11 +11,11 @@
  * @private
  */
 
-var createError = require('http-errors')
-var getBody = require('raw-body')
-var iconv = require('iconv-lite')
-var onFinished = require('on-finished')
-var zlib = require('node:zlib')
+const createError = require('http-errors')
+const getBody = require('raw-body')
+const iconv = require('iconv-lite')
+const onFinished = require('on-finished')
+const zlib = require('node:zlib')
 
 /**
  * Module exports.
@@ -36,49 +36,55 @@ module.exports = read
  */
 
 function read (req, res, next, parse, debug, options) {
-  var length
-  var opts = options
-  var stream
-
   // read options
-  var encoding = opts.encoding !== null
-    ? opts.encoding
-    : null
-  var verify = opts.verify
-
-  try {
-    // get the content stream
-    stream = contentstream(req, debug, opts.inflate)
-    length = stream.length
-    stream.length = undefined
-  } catch (err) {
-    return next(err)
+  const charset = options.charset
+
+  // get the content stream
+  const contentEncoding = (req.headers['content-encoding'] || 'identity').toLowerCase()
+  debug('content-encoding "%s"', contentEncoding)
+
+  if (options.inflate === false && contentEncoding !== 'identity') {
+    return next(createError(415, 'content encoding unsupported', {
+      encoding: contentEncoding,
+      type: 'encoding.unsupported'
+    }))
   }
 
-  // set raw-body options
-  opts.length = length
-  opts.encoding = verify
-    ? null
-    : encoding
+  let stream
+  if (contentEncoding === 'identity') {
+    // set raw-body expected length
+    stream = req
+    options.length = req.headers['content-length']
+  } else {
+    try {
+      stream = createDecompressionStream(contentEncoding, debug)
+      req.pipe(stream)
+    } catch (err) {
+      return next(err)
+    }
+  }
 
   // assert charset is supported
-  if (opts.encoding === null && encoding !== null && !iconv.encodingExists(encoding)) {
-    return next(createError(415, 'unsupported charset "' + encoding.toUpperCase() + '"', {
-      charset: encoding.toLowerCase(),
+  if (options.verify && charset !== null && !iconv.encodingExists(charset)) {
+    return next(createError(415, 'unsupported charset "' + charset.toUpperCase() + '"', {
+      charset: charset.toLowerCase(),
       type: 'charset.unsupported'
     }))
   }
 
+  // set raw-body encoding
+  options.encoding = options.verify ? null : charset
+
   // read body
   debug('read body')
-  getBody(stream, opts, function (error, body) {
+  getBody(stream, options, function (error, body) {
     if (error) {
-      var _error
+      let _error
 
       if (error.type === 'encoding.unsupported') {
         // echo back charset
-        _error = createError(415, 'unsupported charset "' + encoding.toUpperCase() + '"', {
-          charset: encoding.toLowerCase(),
+        _error = createError(415, 'unsupported charset "' + charset.toUpperCase() + '"', {
+          charset: charset.toLowerCase(),
           type: 'charset.unsupported'
         })
       } else {
@@ -100,10 +106,10 @@ function read (req, res, next, parse, debug, options) {
     }
 
     // verify
-    if (verify) {
+    if (options.verify) {
       try {
         debug('verify body')
-        verify(req, res, body, encoding)
+        options.verify(req, res, body, charset)
       } catch (err) {
         next(createError(403, err, {
           body: body,
@@ -114,13 +120,13 @@ function read (req, res, next, parse, debug, options) {
     }
 
     // parse
-    var str = body
+    let str = body
     try {
       debug('parse body')
-      str = typeof body !== 'string' && encoding !== null
-        ? iconv.decode(body, encoding)
+      str = typeof body !== 'string' && charset !== null
+        ? iconv.decode(body, charset)
         : body
-      req.body = parse(str, encoding)
+      req.body = parse(str, charset)
     } catch (err) {
       next(createError(400, err, {
         body: str,
@@ -133,39 +139,6 @@ function read (req, res, next, parse, debug, options) {
   })
 }
 
-/**
- * Get the content stream of the request.
- *
- * @param {object} req
- * @param {function} debug
- * @param {boolean} [inflate=true]
- * @return {object}
- * @api private
- */
-
-function contentstream (req, debug, inflate) {
-  var encoding = (req.headers['content-encoding'] || 'identity').toLowerCase()
-  var length = req.headers['content-length']
-
-  debug('content-encoding "%s"', encoding)
-
-  if (inflate === false && encoding !== 'identity') {
-    throw createError(415, 'content encoding unsupported', {
-      encoding: encoding,
-      type: 'encoding.unsupported'
-    })
-  }
-
-  if (encoding === 'identity') {
-    req.length = length
-    return req
-  }
-
-  var stream = createDecompressionStream(encoding, debug)
-  req.pipe(stream)
-  return stream
-}
-
 /**
  * Create a decompression stream for the given encoding.
  * @param {string} encoding

lib/types/json.js

@@ -124,10 +124,10 @@ function json (options) {
 
     // read
     read(req, res, next, parse, debug, {
-      encoding: charset,
-      inflate: inflate,
-      limit: limit,
-      verify: verify
+      charset,
+      inflate,
+      limit,
+      verify
     })
   }
 }

lib/types/raw.js

@@ -67,10 +67,10 @@ function raw (options) {
 
     // read
     read(req, res, next, parse, debug, {
-      encoding: null,
-      inflate: inflate,
-      limit: limit,
-      verify: verify
+      charset: null,
+      inflate,
+      limit,
+      verify
     })
   }
 }

lib/types/text.js

@@ -72,10 +72,10 @@ function text (options) {
 
     // read
     read(req, res, next, parse, debug, {
-      encoding: charset,
-      inflate: inflate,
-      limit: limit,
-      verify: verify
+      charset,
+      inflate,
+      limit,
+      verify
     })
   }
 }

lib/types/urlencoded.js

@@ -39,8 +39,6 @@ function urlencoded (options) {
   var { inflate, limit, verify, shouldParse } = normalizeOptions(opts, 'application/x-www-form-urlencoded')
 
   var extended = Boolean(opts.extended)
-  var charsetSentinel = opts.charsetSentinel
-  var interpretNumericEntities = opts.interpretNumericEntities
 
   var defaultCharset = opts.defaultCharset || 'utf-8'
   if (defaultCharset !== 'utf-8' && defaultCharset !== 'iso-8859-1') {
@@ -96,13 +94,10 @@ function urlencoded (options) {
 
     // read
     read(req, res, next, parse, debug, {
-      debug: debug,
-      encoding: charset,
-      inflate: inflate,
-      limit: limit,
-      verify: verify,
-      charsetSentinel: charsetSentinel,
-      interpretNumericEntities: interpretNumericEntities
+      charset,
+      inflate,
+      limit,
+      verify
     })
   }
 }