Skip to content

refactor: optimize internal read function #587

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

refactor: optimize internal read function #587

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
103 changes: 38 additions & 65 deletions lib/read.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Comment on lines -44 to -46
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can remove that 😅

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
Copy link
Contributor Author

@Phillip9587 Phillip9587 Feb 15, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I renamed the option to charset because it holds the content-type header charset (Content-Type: text/plain; charset=utf-8) or the default 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']
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Improves the code by only accessing req.headers['content-length'] and setting the length option for raw-body when the stream needs no decompression

} 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

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 {
Expand All @@ -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,
Expand All @@ -117,10 +123,10 @@ function read (req, res, next, parse, debug, options) {
var 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,
Expand All @@ -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
}
Comment on lines -136 to -167
Copy link
Contributor Author

@Phillip9587 Phillip9587 Feb 15, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This can be seen as follow-up to #564. I included the contentstream function in the main read function for multiple reasons:

  • to prevent the req object from being altered by setting length and resetting it in read.
  • This also improves code by only setting the raw-body length option and thus also only calling req.headers['content-length'] when the requests needs no inflation.


/**
* Create a decompression stream for the given encoding.
* @param {string} encoding
Expand Down
2 changes: 1 addition & 1 deletion lib/types/json.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ function json (options) {

// read
read(req, res, next, parse, debug, {
encoding: charset,
charset,
inflate,
limit,
verify
Expand Down
2 changes: 1 addition & 1 deletion lib/types/raw.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ function raw (options) {

// read
read(req, res, next, parse, debug, {
encoding: null,
charset: null,
inflate,
limit,
verify
Expand Down
2 changes: 1 addition & 1 deletion lib/types/text.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ function text (options) {

// read
read(req, res, next, parse, debug, {
encoding: charset,
charset,
inflate,
limit,
verify
Expand Down
2 changes: 1 addition & 1 deletion lib/types/urlencoded.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ function urlencoded (options) {

// read
read(req, res, next, parse, debug, {
encoding: charset,
charset,
inflate,
limit,
verify
Expand Down