url: check forEach callback is a function #10905

TimothyGu · 2017-01-20T00:28:13Z

Currently, URLSearchParams' forEach function does not have a check to make sure that the type of the provided callback is a function. However, the Web IDL spec, to which this function should conform, insists that a TypeError be thrown if the callback is not callable.

This PR fulfills that requirement. Also included in this PR are additional tests for certain aspects of forEach that are defined in the spec but not yet tested.

Web IDL defines forEach as the following:

void forEach(Function callback, optional any thisArg);

callback therefore has type Function, which in turn is defined as a callback function:

callback Function = any (any... arguments);

The process to convert an ECMAScript value to an IDL callback function then contains the following:

If the result of calling IsCallable(V) is false and the conversion to an IDL value is not being performed due to V being assigned to an attribute whose type is a nullable callback function that is annotated with [TreatNonObjectAsNull], then throw a TypeError.

And since callback is not declared with [TreatNonObjectAsNull], forEach should throw a TypeError in case callback is not a function.

Checklist

make -j4 test (UNIX), or vcbuild test (Windows) passes
tests and/or benchmarks are included
commit message follows commit guidelines

Affected core subsystem(s)

url

Per spec.

cjihrig · 2017-01-20T00:48:18Z

lib/internal/url.js

@@ -817,6 +817,9 @@ class URLSearchParams {
    if (arguments.length < 1) {
      throw new TypeError('The `callback` argument needs to be specified');
    }
+    if (typeof callback !== 'function') {


Does this make the check on line 817 obsolete?

@cjihrig, this provides more granular error messages, which I think is a good thing. Do you prefer me to just use the same error message for both cases?

In the browser, they have different error messages as well:

>> new URLSearchParams().forEach() ** TypeError: Failed to execute 'forEach' on 'URLSearchParams': 1 argument required, but only 0 present. >> new URLSearchParams().forEach(2) ** TypeError: Failed to execute 'forEach' on 'URLSearchParams': The callback provided as parameter 1 is not a function.

I would remove the extraneous check as suggested

Our error messages don't even seem to match up though. I'd still change it, but I won't fight it too much.

cjihrig · 2017-01-20T00:50:08Z

test/parallel/test-whatwg-url-searchparams.js

+sp.forEach(function() {
+  assert.strictEqual(this, m);
+}, m);
+assert.throws(() => sp.forEach(), TypeError);


Instead of the TypeError constructor, can you pass a regular expression like /^TypeError: The callback argument must be a function$/

TimothyGu · 2017-01-20T01:56:49Z

/cc @nodejs/url

targos · 2017-01-20T14:10:18Z

lib/internal/url.js

@@ -817,6 +817,9 @@ class URLSearchParams {
    if (arguments.length < 1) {
      throw new TypeError('The `callback` argument needs to be specified');
    }
+    if (typeof callback !== 'function') {
+      throw new TypeError('The `callback` argument must be a function');


our standard way of writing this would be TypeError('"callback" argument must be a function')

TimothyGu · 2017-01-22T22:09:45Z

CI: https://ci.nodejs.org/job/node-test-pull-request/5985/

TimothyGu · 2017-01-24T00:44:04Z

Landed in ed0086f.

The Web IDL spec mandates such a check. Also make error messages consistent with rest of Node.js and add additional tests for forEach(). PR-URL: #10905 Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com>

The Web IDL spec mandates such a check. Also make error messages consistent with rest of Node.js and add additional tests for forEach(). PR-URL: nodejs#10905 Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com>

TimothyGu added 2 commits January 19, 2017 16:10

url: add additional tests for URLSearchParams#forEach

f0f65de

url: check forEach callback is a function

44acced

Per spec.

nodejs-github-bot added dont-land-on-v4.x whatwg-url Issues and PRs related to the WHATWG URL implementation. labels Jan 20, 2017

cjihrig reviewed Jan 20, 2017

View reviewed changes

mscdex removed the dont-land-on-v7.x label Jan 20, 2017

TimothyGu mentioned this pull request Jan 20, 2017

url: track status of a spec-compliant URLSearchParams #10821

Closed

11 tasks

nodejs-github-bot added the dont-land-on-v7.x label Jan 20, 2017

More specific error message tests

182ce97

TimothyGu force-pushed the urlsearchparams-foreach branch from 981f558 to 182ce97 Compare January 20, 2017 02:04

nodejs-github-bot added the dont-land-on-v7.x label Jan 20, 2017

joyeecheung approved these changes Jan 20, 2017

View reviewed changes

targos reviewed Jan 20, 2017

View reviewed changes

cjihrig approved these changes Jan 20, 2017

View reviewed changes

TimothyGu added 3 commits January 20, 2017 11:28

Remove obsolete arguments.length check in forEach()

c6f5900

Make argument check error messages consistent with rest of code base

6775629

Update error messages in test

593a0d9

targos approved these changes Jan 21, 2017

View reviewed changes

TimothyGu mentioned this pull request Jan 22, 2017

test: increase coverage for URL.searchParams #10952

Closed

3 tasks

TimothyGu removed the dont-land-on-v7.x label Jan 24, 2017

TimothyGu closed this Jan 24, 2017

TimothyGu deleted the urlsearchparams-foreach branch January 24, 2017 00:44

italoacasas mentioned this pull request Jan 25, 2017

Proposal to update v7.x-staging #10989

Closed

italoacasas mentioned this pull request Jan 29, 2017

v7.5.0 proposal #11062

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

url: check forEach callback is a function #10905

url: check forEach callback is a function #10905

TimothyGu commented Jan 20, 2017

cjihrig Jan 20, 2017

TimothyGu Jan 20, 2017

jasnell Jan 20, 2017

cjihrig Jan 20, 2017

TimothyGu Jan 20, 2017

cjihrig Jan 20, 2017

TimothyGu Jan 20, 2017

TimothyGu commented Jan 20, 2017

targos Jan 20, 2017

TimothyGu Jan 20, 2017

TimothyGu commented Jan 22, 2017

TimothyGu commented Jan 24, 2017

url: check forEach callback is a function #10905

url: check forEach callback is a function #10905

Conversation

TimothyGu commented Jan 20, 2017

Checklist

Affected core subsystem(s)

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TimothyGu commented Jan 20, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TimothyGu commented Jan 22, 2017

TimothyGu commented Jan 24, 2017