Skip to content
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

http: verify method is a string #10111

Closed
wants to merge 5 commits into from
Closed

http: verify method is a string #10111

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
242c5c9
http: verify method is a string
lucamaraschi Dec 4, 2016
c711ac7
http: added @cjihrig feedbacks
lucamaraschi Dec 6, 2016
29f78c1
http: renamed method for consistency
lucamaraschi Dec 7, 2016
7774c3a
http: variables rearrangement
lucamaraschi Dec 7, 2016
9561854
http: changed let to var
lucamaraschi Dec 7, 2016
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
5 changes: 5 additions & 0 deletions lib/_http_client.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,11 @@ function ClientRequest(options, cb) {
self.socketPath = options.socketPath;
self.timeout = options.timeout;

const _method = options.method;
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe we can just move the var method declaration up here and re-assign on line 75, that way we don't have a second variable for the same thing?

if (_method !== undefined && _method !== null
Copy link
Contributor

Choose a reason for hiding this comment

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

This can be written as:

if (_method != null && typeof _method !== 'string')

If you don't choose to rewrite like that, the && should be moved to the previous line, and the second line should be lined up. I'm surprised the linter doesn't complain.

&& typeof _method !== 'string') {
throw new TypeError('Method must be a string');
}
Copy link
Contributor

@mscdex mscdex Dec 4, 2016 •
edited
Loading

Choose a reason for hiding this comment

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

For the best backwards compatibility (and to emulate the method value selection behavior below the typeof check), I think the undefined/null check should be removed and just test for truthiness:

if (options.method && typeof options.method !== 'string') {
  throw new TypeError('Method must be a string');
}

The reason being that options.method could be one of several non-truthy values, such as 0 and false.

Copy link
Contributor Author

@lucamaraschi lucamaraschi Dec 4, 2016 •
edited
Loading

Choose a reason for hiding this comment

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

In this case if options.method is set to 0 results in a falsy value which is going to default the method to GET in the following check.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@mscdex that would not fix the non-truthy values, confusing the defaulting of 0 values to GET.

Copy link
Contributor

Choose a reason for hiding this comment

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

Well, it's a difference between semver-ness. This change is definitely going to be semver-major as-is, but it could be semver-patch with the check I suggested. It's up to you.

var method = self.method = (options.method || 'GET').toUpperCase();
Copy link
Contributor

Choose a reason for hiding this comment

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

We should probably use options.method or _method consistently. Right now it's a mix.

Copy link
Member

Choose a reason for hiding this comment

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

The common._checkIsHttpToken() check on line 77 already includes a test to ensure method is a string.

if (!common._checkIsHttpToken(method)) {
throw new TypeError('Method must be a valid HTTP token');
Expand Down
48 changes: 48 additions & 0 deletions test/parallel/test-http-client-check-http-token.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
'use strict';
const common = require('../common');
const assert = require('assert');
const http = require('http');

const expectedSuccesses = {
Copy link
Contributor

Choose a reason for hiding this comment

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

Only the keys seem to be used. This could probably be an array...

undefined: 'GET',
null: 'GET',
'get': 'GET',
'post': 'POST'
};

const methods = Object.keys(expectedSuccesses);
let requestCount = 0;

const server = http.createServer((req, res) => {
requestCount++;
res.end();

if (methods.length === requestCount) {
server.close();
}
}).listen(0, test);

function test() {
function fail(input) {
assert.throws(() => {
http.request({ method: input, path: '/' }, common.fail);
}, /Method must be a string/);
Copy link
Contributor

Choose a reason for hiding this comment

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

If you want to be really strict, this could be /^TypeError: Method must be a string$/.

}

fail(-1);
fail(1);
fail(0);
fail({});
fail(true);
fail(false);
fail([]);

function ok(method) {
http.request({ method: method, port: server.address().port }).end();
}

ok(undefined);
Copy link
Contributor

Choose a reason for hiding this comment

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

... and then you can loop over the array here. Right now, the number of times ok() is called is independent of methods.

ok(null);
ok('get');
ok('post');
}