test: move WPT to its own testing module #12736

Trott · 2017-04-29T05:25:53Z

This is first in a hoped-for series of moves away from a monolithic
common.js that is loaded for every test and towards a more modular
approach. (In the end, common.js will hopefully contain checks for
variables leaking into the global space and perhaps some of the more
ubiquitous functions like common.mustCall().)

Move the WPT testing code to its own module.

Checklist

make -j4 test (UNIX), or vcbuild test (Windows) passes
documentation is changed or added
commit message follows commit guidelines

Affected core subsystem(s)

test url

Trott · 2017-04-29T05:27:26Z

This is a sort of trial balloon to see if there's support for this sort of change generally. /cc @nodejs/testing @nodejs/url

Trott · 2017-04-29T05:32:50Z

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

gibfahn · 2017-04-29T08:43:05Z

test/README.md

@@ -226,109 +228,109 @@ Tests whether `name` and `expected` are part of a raised warning.



## getArrayBufferViews(buf) -> #### getArrayBufferViews(buf) right? (L225)

targos · 2017-04-29T08:45:36Z

+1 on the initiative, but I wonder if we shouldn't have a test/lib/ directory to put those factored out modules.

gibfahn · 2017-04-29T09:27:33Z

LGTM in this case as common.WPT seems always used separately, so

-const { test, assert_equals } = common.WPT;
+const { test, assert_equals } = require('../wpt');

isn't a big deal.

But in general if we're going to split up common and start having:

-const common = require('../common');
+require('../common');
+const commonx = require('../commonx');
+const commony = require('../commony');
+const commonz = require('../commonz');

then I'm not sure what the benefit is (or if it outweighs the increased complexity, especially for new contributors).

Same applies to adding a test/lib/ directory. At the moment anyone looking at test/ sees test folders and a common.js file, which I'd hope is pretty intuitive (and a style used by other projects). Of course we do already have test/testpy/, which is non-obvious. Maybe a test/common/ directory would be obvious enough, 🤷‍♀️ .

targos · 2017-04-29T09:35:53Z

Maybe a test/common/ directory would be obvious enough

Good idea. We could move common.js to test/common/index.js in that case, keeping require('../common') compatibility.

benjamingr

I'm +0 on doing this but the changes LGTM

richardlau · 2017-04-29T11:19:27Z

test/README.md

 * return [&lt;Boolean>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type)

 Checks whether `IPv6` is supported on this platform.

-### hasMultiLocalhost
+#### hasMultiLocalhost


If we're editing these, could we move the h* properties so that they're in alphabetical order?

cjihrig · 2017-04-29T14:43:57Z

I like the idea of a test/common/ directory to split up the existing large file.

I don't like losing access to everything I need for testing from require('../common'). What if we lazy loaded less commonly used things?

mhdawson · 2017-05-01T22:12:13Z

I'm +0 zero on this change. Is it a problem to load it for every test ? If not then if we want to modularize into separate files maybe we can do that but still end up with a single import ?

Trott · 2017-05-01T23:04:41Z

rebased to resolve conflict and resolve README nits

Trott · 2017-05-01T23:12:13Z

Even if we don't do this for anything else, I think it makes a lot of sense to split out the WPT stuff because it really is its own thing that gets used its own way. People shouldn't use it without fully understanding where it comes from and why it is the way it is. At the same time, it isn't something people need to bother with in the vast majority of cases.

Fishrock123 · 2017-05-01T23:34:22Z

Uhm, what is "WPT"?

Trott · 2017-05-01T23:40:42Z

Uhm, what is "WPT"?

https://github.com/nodejs/node/tree/aea7269c45f91fd983e8ca91fddd4021fc40d099/test#wpt

TimothyGu · 2017-05-02T00:10:51Z

I'm indifferent towards splitting out WPT. Its (very specific) use is documented, and I'm of the opinion that people generally won't touch the stuff they don't know about. Though I can see how logically it might not fit with the rest of test/common.js.

On splitting up test/common.js in general, I'm –½. What are the benefits of splitting it up? This might sound snarky, but AFAICT the utilities can all go under one category "miscellaneous."

On splitting up and lazy-loading different utilities, I'm –1. If the time being spent on loading test/common/* is insignificant then lazy-loading would be overkill, and if not I'd advocate for not splitting it at all.

Trott · 2017-05-02T00:18:48Z

@TimothyGu You make some good points, for sure. The main benefit would be for newcomers looking at the docs. Instead of dozens of properties, many of which won't matter to them, it can just be properties that are easy to understand and whose value is readily apparent. Like, common.isWindows? Sure, I get it. common.mustCall()? Yup, that's useful. Someone can read the common docs and feel like they've understood the module rather than puzzling over when, why, and how to use common.spawnSyncPwd() and common.arrayStream.

(On the other hand, looking at common, most of the things fall into the "ubiquitous, simple, and useful" category. But for the things that don't...)

Trott · 2017-05-02T00:20:29Z

I really like the common/ directory idea so I went ahead and did that....

Trott · 2017-05-02T00:21:15Z

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

richardlau · 2017-05-02T02:11:01Z

test/README.md

 * return [&lt;String>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type)

 Name of the temp directory used by tests.

-### WPT
+### wpt


Should this be common/wpt?

richardlau · 2017-05-02T02:13:44Z

test/README.md

-## Common module API
+## Testing Module APIs
+
+### common

 The common.js module is used by tests for consistency across repeated


Are we still calling the module common.js after the refactor? How about just common?

Trott · 2017-05-02T05:29:30Z

Pushed fixes for README nits.

Probably want to move the docs for the common module etc. into test/common/README.md and provide a link in test/README.md?

Trott · 2017-05-02T21:57:09Z

Split out into separate READMEs and force-pushed.

Trott · 2017-05-02T21:57:37Z

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

Trott · 2017-05-03T03:26:27Z

Rebased to resolve conflict.

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

richardlau · 2017-05-03T03:35:16Z

Probably want to move the docs for the common module etc. into test/common/README.md and provide a link in test/README.md?

The link is missing. Probably should add an entry for common under the test directories table.

Trott · 2017-05-03T03:57:32Z

The link is missing. Probably should add an entry for common under the test directories table.

Heh! Also: Should add an entry for the common directory in the main README and put the link there (either in addition or instead).

Trott · 2017-05-03T04:10:47Z

Entry for common directory and link to that directory's README.md added to main test directory's README.

Trott · 2017-05-03T04:11:11Z

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

richardlau · 2017-05-03T04:27:17Z

test/README.md

@@ -49,6 +44,14 @@ On how to run tests in this direcotry, see
      </td>
    </tr>
    <tr>
+      <td>common</td>
+      <td>No</td>


fixtures and testpy leave this column empty.

richardlau

Minor nit otherwise LGTM.

This is first in a hoped-for series of moves away from a monolithic common.js that is loaded for every test and towards a more modular approach. (In the end, common.js will hopefully contain checks for variables leaking into the global space and perhaps some of the more ubiquitous functions like common.mustCall().) Move the WPT testing code to its own module.

Trott · 2017-05-03T06:20:09Z

Nit addressed. CI: https://ci.nodejs.org/job/node-test-pull-request/7822/

Trott · 2017-05-04T00:01:36Z

Landed in ff001c1

This is first in a hoped-for series of moves away from a monolithic common.js that is loaded for every test and towards a more modular approach. (In the end, common.js will hopefully contain checks for variables leaking into the global space and perhaps some of the more ubiquitous functions like common.mustCall().) Move the WPT testing code to its own module. PR-URL: nodejs#12736 Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com>

gibfahn · 2017-06-18T23:23:15Z

@Trott could you backport this to v6.x-staging? It'd be good to get this backported as otherwise this is going to cause a lot of conflicts.

If yes please follow the guide and raise a backport PR, if no let me know or add the dont-land-on label.

This is first in a hoped-for series of moves away from a monolithic common.js that is loaded for every test and towards a more modular approach. (In the end, common.js will hopefully contain checks for variables leaking into the global space and perhaps some of the more ubiquitous functions like common.mustCall().) Move the WPT testing code to its own module. PR-URL: nodejs#12736 Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com>

Trott · 2017-06-19T03:11:03Z

@gibfahn backport in #13775

This is first in a hoped-for series of moves away from a monolithic common.js that is loaded for every test and towards a more modular approach. (In the end, common.js will hopefully contain checks for variables leaking into the global space and perhaps some of the more ubiquitous functions like common.mustCall().) Move the WPT testing code to its own module. PR-URL: #12736 Backport-PR-URL: #13775 Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com>

Trott added test Issues and PRs related to the tests. whatwg-url Issues and PRs related to the WHATWG URL implementation. labels Apr 29, 2017

nodejs-github-bot added the test Issues and PRs related to the tests. label Apr 29, 2017

gibfahn reviewed Apr 29, 2017

View reviewed changes

gibfahn approved these changes Apr 29, 2017

View reviewed changes

benjamingr approved these changes Apr 29, 2017

View reviewed changes

richardlau reviewed Apr 29, 2017

View reviewed changes

Trott force-pushed the demonolith-wpt branch from bfb1c0d to b8bdf9f Compare May 1, 2017 23:04

Trott force-pushed the demonolith-wpt branch from b8bdf9f to 448adbd Compare May 2, 2017 00:20

richardlau reviewed May 2, 2017

View reviewed changes

Trott force-pushed the demonolith-wpt branch from 448adbd to 4fc779c Compare May 2, 2017 05:28

Trott force-pushed the demonolith-wpt branch from 4fc779c to be8b5b0 Compare May 2, 2017 21:57

Trott force-pushed the demonolith-wpt branch from be8b5b0 to ed2664a Compare May 3, 2017 03:25

Trott force-pushed the demonolith-wpt branch from ed2664a to 4b16ca3 Compare May 3, 2017 04:10

richardlau reviewed May 3, 2017

View reviewed changes

richardlau approved these changes May 3, 2017

View reviewed changes

Trott force-pushed the demonolith-wpt branch from 4b16ca3 to 4086e82 Compare May 3, 2017 06:19

Trott closed this May 4, 2017

jasnell mentioned this pull request May 11, 2017

8.0.0 Release Proposal #12220

Closed

gibfahn mentioned this pull request Jun 15, 2017

Auditing for 6.11.1 nodejs/Release#230

Closed

3 tasks

gibfahn added the backport-requested-v6.x label Jun 18, 2017

Trott mentioned this pull request Jun 19, 2017

(v6.x backport) test: move WPT to its own testing module #13775

Closed

4 tasks

gibfahn added backported-to-v6.x and removed backport-requested-v6.x labels Jun 20, 2017

MylesBorins mentioned this pull request Jul 18, 2017

v6.11.2 proposal #14356

Merged

Trott deleted the demonolith-wpt branch January 13, 2022 22:45

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

test: move WPT to its own testing module #12736

test: move WPT to its own testing module #12736

Trott commented Apr 29, 2017

Trott commented Apr 29, 2017

Trott commented Apr 29, 2017

gibfahn Apr 29, 2017

targos commented Apr 29, 2017

gibfahn commented Apr 29, 2017 •

edited

Loading

targos commented Apr 29, 2017

benjamingr left a comment

richardlau Apr 29, 2017

cjihrig commented Apr 29, 2017

mhdawson commented May 1, 2017

Trott commented May 1, 2017

Trott commented May 1, 2017 •

edited

Loading

Fishrock123 commented May 1, 2017

Trott commented May 1, 2017

TimothyGu commented May 2, 2017

Trott commented May 2, 2017 •

edited

Loading

Trott commented May 2, 2017

Trott commented May 2, 2017

richardlau May 2, 2017

richardlau May 2, 2017 •

edited

Loading

Trott commented May 2, 2017

Trott commented May 2, 2017

Trott commented May 2, 2017

Trott commented May 3, 2017

richardlau commented May 3, 2017

Trott commented May 3, 2017

Trott commented May 3, 2017

Trott commented May 3, 2017

richardlau May 3, 2017

richardlau left a comment

Trott commented May 3, 2017

Trott commented May 4, 2017

gibfahn commented Jun 18, 2017

Trott commented Jun 19, 2017

		@@ -226,109 +228,109 @@ Tests whether `name` and `expected` are part of a raised warning.

test: move WPT to its own testing module #12736

test: move WPT to its own testing module #12736

Conversation

Trott commented Apr 29, 2017

Checklist

Affected core subsystem(s)

Trott commented Apr 29, 2017

Trott commented Apr 29, 2017

gibfahn Apr 29, 2017

Choose a reason for hiding this comment

targos commented Apr 29, 2017

gibfahn commented Apr 29, 2017 • edited Loading

targos commented Apr 29, 2017

benjamingr left a comment

Choose a reason for hiding this comment

richardlau Apr 29, 2017

Choose a reason for hiding this comment

cjihrig commented Apr 29, 2017

mhdawson commented May 1, 2017

Trott commented May 1, 2017

Trott commented May 1, 2017 • edited Loading

Fishrock123 commented May 1, 2017

Trott commented May 1, 2017

TimothyGu commented May 2, 2017

Trott commented May 2, 2017 • edited Loading

Trott commented May 2, 2017

Trott commented May 2, 2017

richardlau May 2, 2017

Choose a reason for hiding this comment

richardlau May 2, 2017 • edited Loading

Choose a reason for hiding this comment

Trott commented May 2, 2017

Trott commented May 2, 2017

Trott commented May 2, 2017

Trott commented May 3, 2017

richardlau commented May 3, 2017

Trott commented May 3, 2017

Trott commented May 3, 2017

Trott commented May 3, 2017

richardlau May 3, 2017

Choose a reason for hiding this comment

richardlau left a comment

Choose a reason for hiding this comment

Trott commented May 3, 2017

Trott commented May 4, 2017

gibfahn commented Jun 18, 2017

Trott commented Jun 19, 2017

gibfahn commented Apr 29, 2017 •

edited

Loading

Trott commented May 1, 2017 •

edited

Loading

Trott commented May 2, 2017 •

edited

Loading

richardlau May 2, 2017 •

edited

Loading