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.
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
Changes in Response Class contructor for status range and null body status check #1706
Open
asingh04
wants to merge
2
commits into
node-fetch:main
Choose a base branch
from
asingh04:response-class-status-code-fix
base: main
Could not load branches
Branch not found: {{ refName }}
Could not load tags
Nothing to show
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+50
−7
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -10,6 +10,22 @@ import {isRedirect} from './utils/is-redirect.js'; | |
|
||
const INTERNALS = Symbol('Response internals'); | ||
|
||
/** | ||
* Checks the provided 'status' property to the Response constructor | ||
* @param {*} status | ||
* @throws RangeError if the status variable is not in the acceptable range of [200, 599] | ||
* @returns The provided status value if it is valid | ||
*/ | ||
function validateStatusValue(status) { | ||
const statusValue = Number.parseInt(status, 10); | ||
|
||
if (Number.isNaN(statusValue) || statusValue < 200 || statusValue > 599) { | ||
throw new RangeError(`Failed to construct 'Response': The status provided (${status}) is outside the range [200, 599].`); | ||
} | ||
|
||
return statusValue; | ||
}; | ||
|
||
/** | ||
* Response class | ||
* | ||
|
@@ -23,12 +39,18 @@ export default class Response extends Body { | |
constructor(body = null, options = {}) { | ||
super(body, options); | ||
|
||
// eslint-disable-next-line no-eq-null, eqeqeq, no-negated-condition | ||
const status = options.status != null ? options.status : 200; | ||
// if status is not provided or is null, let's use default 200 value | ||
// otherwise, lets check if the value is in correct range | ||
const status = (typeof options.status === 'undefined' || options.status === null) ? 200 : | ||
validateStatusValue(options.status); | ||
|
||
const headers = new Headers(options.headers); | ||
|
||
if (body !== null && !headers.has('Content-Type')) { | ||
if (status === 204 && typeof body !== 'undefined' && body !== null) { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think we also need |
||
throw new TypeError("Failed to construct 'Response': Response with null body status cannot have body") | ||
} | ||
|
||
if (body !== null && !headers.has('Content-Type')) { | ||
const contentType = extractContentType(body, this); | ||
if (contentType) { | ||
headers.append('Content-Type', contentType); | ||
|
@@ -119,7 +141,8 @@ export default class Response extends Body { | |
} | ||
|
||
static error() { | ||
const response = new Response(null, {status: 0, statusText: ''}); | ||
// default error status code = 400 | ||
const response = new Response(null, {status: 400, statusText: ''}); | ||
This comment was marked as outdated.
Sorry, something went wrong. |
||
response[INTERNALS].type = 'error'; | ||
return response; | ||
} | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this check with coersion has covered the case
options.status !== undefined
, so you can simply doconst status = options.status != null ? validateStatusValue(options.status) : 200;
but I'm not fussed, happy with either. :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jazelly in this code
if the
status
is undefined( when the client/application hasnt prvovided the value), the default value200
should be assumed, but the functionvalidateStatusValue
will be throwing an error. That's why added the check forundefined
as well.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, but notice it's a
!=
. Whenoptions.status
isundefined
,options.status != null
is falsy, and will set a default 200 to the status.