set child process debug port to an available port - fixes #342 #874

develar · 2016-05-25T18:05:40Z

Continue #613

More robust and maintainable approach was found. Just compute required data before main promise for all files. So, it is simple to add new function in to the existing promise chain. Yeah, I spend a lot of time trying to fix last failed test and decided to rework solution.

This also doesn't handle the case where the user would do --debug-brk 213 instead of --debug-brk=213.
#613 (comment)

This syntax is not supported because node supports only --debug=, but not --debug <port number>.

develar-work:~ develar$ node --debug 12334 foo.js
Debugger listening on port 5858
module.js:442
    throw err;
    ^

Error: Cannot find module '/Users/develar/12334'

Can you add some tests?
#613 (comment)

Tests added. Initially as heavy-weight tests, but I got weird error Test files must be run with the AVA CLI if I run with nyc (passed without nyc). So, I decided to write unit tests.

jamestalmage · 2016-05-25T18:58:52Z

In addition to unit tests, you should have a few integration tests. We can help figure out why NYC causes a failure.

develar · 2016-05-27T09:42:43Z

you should have a few integration tests

Integration test added. Maybe on CI it will be passed, but on my machine I got "Test files must be run with the AVA CLI:" from child stderr if use nyc.

develar · 2016-05-27T09:51:21Z

CI failed " not ok AvaError: test/fixture/debug-arg.js exited with a non-zero exit code: 1" Hmm... it works for me — I use fork of ava in my project and can debug tests in IntelliJ IDEA.

Something is wrong with nyc, but I don't see how it it is connected.

If you will have no clue, I will investigate what's wrong with nyc.

jamestalmage · 2016-05-27T15:53:01Z

As I recall, in linux, ports below some number (1024?) are "privileged", and need some special permissions to run. Try bumping your tests to use something higher.

develar · 2016-05-27T16:05:50Z

Try bumping your tests to use something higher.

Port here doesn't matter — for child we use random free port.

jamestalmage · 2016-05-27T16:14:44Z

Then what does --debug=0 mean?

jamestalmage · 2016-05-27T16:47:37Z

The build runs fine locally on OSX. It's either Linux or Travis specific.

Travis could be blocking this somehow.

develar · 2016-05-27T16:56:53Z

The build runs fine locally on OSX.

I use OS X and it is failed with nyc.

Then what does --debug=0 mean?

Args of the main process. In the tests we don't start main process, we start child only (if I am not wrong). Purpose of this fix is — replace port in the main process args to another free port.

Ok, I will investigate what's wrong with nyc.

develar · 2016-05-27T16:58:33Z

AppVeyor build succeeded only because npm run test-win — in the test-win nyc is not called.

jamestalmage · 2016-05-27T17:00:03Z

Ahhh. Yes. This is almost certainly a spawnwrap bug then.

jamestalmage · 2016-05-27T18:11:53Z

See: https://github.com/jamestalmage/__nyc-ipc-argv-bug

develar · 2016-06-10T16:24:44Z

Sorry for delay, I will investigate it soon. Currently I am working to support new v8 inspector in the IntelliJ IDEA. --inspect has the same problem — no way to ask node to use any port.

jamestalmage · 2016-06-18T07:43:14Z

@develar - The NYC bug is fixed. Any chance of finalizing this soon?

develar · 2016-06-18T17:06:56Z

Rebased — tests passed.
--inspect and combination --inspect + --debug-brk supported (this combination should be used to debug tests because in case of just --inspect tests can be executed before debugger attached).

novemberborn · 2016-06-19T13:35:04Z

test/api.js

+	test('pass ' + execArgv.join(' ') + ' to fork', function (t) {
+		t.plan(expectedInspectIndex === -1 ? 3 : 2);
+
+		var api = new Api({testOnlyExecArgv: execArgv});


This should stub process.execArgv rather than needing a test-only option.

This should stub

Not quite understand, do you mean that we should replace process.execArgv during test? I think, it is not acceptable to touch global state.

do you mean that we should replace process.execArgv during test?

Yes.

I think, it is not acceptable to touch global state.

True, but tests are special.

Something I've done in other projects is to have a process module which exports the global process, and then stubbing that through Proxyquire. But let's not do that unless we really have to.

True, but tests are special.

I think, some day AVA tests will be also executed in parallel, so, it is not wise to сhange properties in the global process object.

I think, some day AVA tests will be also executed in parallel, so, it is not wise to сhange properties in the global process object.

We can deal with it then.

Even when we do self test with AVA, the parallel processes will have their own process.execArgv. Test isolation FTW!

the parallel processes will have their own process.execArgv

But not tests in the same file ;)

Ok, up to you, I removed option and replace process.execArgv.

But not tests in the same file ;)

True. Though you can always just do test.serial for the few that would interfere.

novemberborn · 2016-06-19T13:38:44Z

This looks pretty good @develar!

I wonder if there's anybody who'd like to install this PR locally to debug their tests?

jamestalmage · 2016-06-20T03:35:11Z

Hmm.

I kinda think we're going about this the wrong way. Instead of parsing process.execArgv, let's use process.argv:

ava --debug=<PORT>

If a user is debugging their tests, they aren't going to care about attaching a debugger to the parent process.

Using the debug flag would imply --concurrency=1, so multiple processes don't compete for the same port.

Then the debug client can connect to a single port, no parsing stderr for port numbers (which seems unreliable IMO).

IMO, If you really want to do it this way (find random open ports and print to stderr for parsing). Then that should be implemented as a separate tool using spawn-wrap (that is what nyc uses under the hood to give us coverage across many processes). That allow much wider reuse.

develar · 2016-06-20T05:46:22Z

@jamestalmage Why? User just run debug in the IDE. Or run debug using standard node args. That's all. Nothing more. No need to reinvent the wheel and introduce new tool-specific API. User just use standard tools and way to debug.

JetBrains IDE — we reimplement multiprocess debug specially for AVA. It just works. No multiple debug tabs anymore, it is like chrome workers (you can select "thread" using combo box if need). You just hit "debug" and it works (in context runner for AVA not yet implemented, but it is another task).

Chrome using --inspect — copy url and debug. Yes, it is not seamless as in the IDE, but... IDE is IDE. I think, you told exactly about it — simplify debug using some Ava-specific tool.

But, at first, I think, we should support debug using standard tools and way.

jamestalmage · 2016-06-20T06:28:34Z

we reimplement multiprocess debug specially for AVA

Is that available for us to take a look at? It sounds kinda awesome. Having multiple processes running at a time sounds cool, but I'm not sure how useful it is. Maybe you could debug two test-files that interleave disk operations in some way with clever breakpoints? IDK.

Either way, I don't think we want them to use execArgv, especially with --debug-brk. Using execArgv with --debug-brk causes it to pause the main process. So you need to manually continue it each time before child processes are launched.

node --debug node_modules/.bin/ava tests/foo.js

vs.

ava --debug test/foo.js

The second is more convenient.

See #929 - It works really well with node-inspector right now, and the CLI command node debug localhost:<PORT> works OK (you need to manually reconnect between tests by typing run). I tried this PR out locally, and I didn't find it nearly as convenient using node-inspector as #929. That might be me misunderstanding how this supposed to work (some basic instructions on how I should use this with node-inspector or similar would be good).

develar · 2016-06-20T07:13:43Z

Is that available for us to take a look at?

Yes, these changes available since 2016.1 release. You can try 2016.2 EAP — IDEA or WebStorm. --inspect not yet supported for child process (it is in the unreleased 2016.3 (163 branch)).

Video: https://youtu.be/C75UwuZXI98

Having multiple processes running at a time sounds cool, but I'm not sure how useful it is.

I use --match if I want to debug test. I run npm run test in terminal and then debug failed tests in the IDE.

Using execArgv with --debug-brk causes it to pause the main process.
So you need to manually continue it each time before child processes are launched.

IDE uses this break to set breakpoints, find sourcemaps and then continues debug automatically.

develar · 2016-06-20T07:20:52Z

#929 is about how to simplify AVA debug in the CLI using special ava specific CLI. This PR is to make AVA debug working using standard way (i.e. IDE vendor should not explicitly support AVA). Strictly speaking, this PR is a workaround of nodejs/node#5025

develar · 2016-06-20T07:51:55Z

Maybe you could debug two test-files that interleave disk operations in some way with clever breakpoints? IDK.

You can use conditional breakpoints.

sindresorhus · 2016-08-12T08:50:19Z

Landed. Finally :)

Thanks for doing the hard work here @develar and persevering through this long review.

develar · 2016-08-17T18:11:54Z

@korsmakolnikov Please specify IDE version, do you use ava from sources?

KeKs0r · 2016-09-20T09:20:43Z

@develar It does not work for me. I am using this version of webstorm:

WebStorm 2016.2
Build #WS-162.1121.31, built on July 9, 2016
JRE: 1.8.0_76-release-b216 x86_64
JVM: OpenJDK 64-Bit Server VM by JetBrains s.r.o

And Ava from master, but my debugger just never stops. I was trying with single file debugging (without match):

Not sure why the debugger never stops. It also does not terminate.

develar · 2016-09-20T12:24:35Z

@KeKs0r Please use WebStorm 2016.3 EAP

mightyiam · 2016-11-16T13:34:44Z

Is this documented anywhere, please? Does it need to be, or will it simply work with anything that debugs node, like Chrome DevTools?

develar · 2016-11-16T13:36:12Z

@mightyiam https://github.com/avajs/ava/blob/master/docs/recipes/debugging-with-webstorm.md

mightyiam · 2016-11-16T20:10:56Z

How likely is this to ever work in Chrome DevTools?

sindresorhus · 2016-11-16T20:32:14Z

@mightyiam It's planned with #929, but that PR stalled.

Workaround for now. Put a debugger; statement somewhere in your code and run:

$ node --inspect node_modules/ava/profile.js test.js

Where node_modules/ava/profile.js is the relative path to that file.

develar · 2016-11-17T06:15:25Z

@mightyiam In addition to --inspect you need to pass --debug-brk So, Chrome will stop on first line.

This will output a link that you can open in Chrome. After opening that link, the Chrome Developer Tools will be displayed, and a breakpoint will be set at the first line of the Jest CLI script (this is done simply to give you time to open the developer tools and to prevent Jest from executing before you have time to do so). Click the button that looks like a "play" button in the upper right hand side of the screen to continue execution. When Jest executes the test that contains the debugger statement, execution will pause and you can examine the current scope and call stack.

Docs from Jest is true and correct for AVA as well. (Irony that currently Jest debug doesn't work due to NodeJS bug nodejs/node#7593, only AVA debug works ;)) So, you can debug in Chrome DevTools also.

mightyiam · 2016-11-17T12:32:00Z

Thanks!

richchurcher · 2017-02-28T06:13:21Z

Just because I couldn't find this anywhere else: when using VS Code as a debugger, you can coerce AVA to behave by using @sindresorhus 's suggestion as part of a launch.json config:

{
    "version": "0.2.0",
    "configurations": [
        {
            "type": "node2",
            "request": "launch",
            "name": "Launch Program",
            "program": "${workspaceRoot}/tests/index.test.js",
            "cwd": "${workspaceRoot}",
            "sourceMaps": true,
            "runtimeArgs": [
                "${workspaceRoot}/node_modules/ava/profile.js"
            ]
        }
    ]
}

ImTheDeveloper · 2017-05-06T18:57:04Z

Worth mentioning that this setup worked for me but the one bit I had missing was that I forgot to install the webstorm debug helper in chrome https://chrome.google.com/webstore/detail/jetbrains-ide-support/hmhgeddbohgjknpmjagkdomcpobmllji?hl=en-GB

dohomi · 2017-06-13T00:30:58Z

@develar @mightyiam did you guys managed to test AVA tests in Webstorm with the current 2017.2? I use the configuration mentioned in this document: https://github.com/avajs/ava/blob/master/docs/recipes/debugging-with-webstorm.md
It seems that Webstorm is starting the debugging mode with: --inspect-brk=INT and due to this it results in:
address is already in use

melisoner2006 · 2017-08-04T14:37:11Z

I was also having problem with debugging ava unit tests with Webstorm 2017.2. It didn't stop at the break points. Adding inspect-brk to node options fixed the problem. Here's my SO question & answer. Thanks @develar and @mightyiam for mentioning the node options.

novemberborn · 2017-08-05T16:30:28Z

@melisoner2006 would you be interested in opening a PR to fix the recipe?

melisoner2006 · 2017-08-06T00:42:11Z

@novemberborn I'd love to. I'll get on it now.

Gregoyle · 2018-02-20T16:19:03Z

@dohomi Did you ever get this working? I'm having a hard time getting the WS debugger to work. It could be related to the fact that our project is using babel. @melisoner2006 Was your project ES6 or something else?

melisoner2006 · 2018-02-20T16:38:31Z

@Gregoyle Yes, my project was ES6.

develar mentioned this pull request May 25, 2016

fix #342 set child process debug port to available #613

Closed

develar force-pushed the debug2 branch 2 times, most recently from 7f63137 to 8815163 Compare May 27, 2016 09:41

develar mentioned this pull request Jun 10, 2016

debugger: bind to random port with --debug-port=0 nodejs/node#5025

Closed

chicoxyzzy mentioned this pull request Jun 13, 2016

Merge rx-recompose into main project acdlite/recompose#196

Merged

3 tasks

develar force-pushed the debug2 branch from 8815163 to 1cf393b Compare June 18, 2016 16:04

novemberborn reviewed Jun 19, 2016
View reviewed changes

jamestalmage mentioned this pull request Jun 20, 2016

Proof Of Concept: Alternate debug #929

Closed

develar force-pushed the debug2 branch from 1edc685 to 00ea657 Compare June 20, 2016 07:47

sindresorhus changed the title ~~fix #342 set child process debug port to available~~ set child process debug port to an available port - fix #342 Aug 12, 2016

sindresorhus changed the title ~~set child process debug port to an available port - fix #342~~ set child process debug port to an available port - fixes #342 Aug 12, 2016

sindresorhus merged commit c268c8d into avajs:master Aug 12, 2016

develar deleted the debug2 branch August 12, 2016 08:51

This was referenced Aug 12, 2016

Remove Node.js --debug-port / --inspect workaround #997

Closed

Recipe for debugging AVA tests with WebStorm #998

Closed

prigara mentioned this pull request Aug 17, 2016

WebStorm recipe #1009

Merged

This was referenced Nov 16, 2016

Feature request: API for debugging node child processes nodejs/node#9621

Closed

Please release new version to make debugging possible #1110

Closed

mightyiam mentioned this pull request Nov 17, 2016

Document how to debug with Node.js debugger/Chrome DevTools/etc. #1112

Closed

jcrben mentioned this pull request Apr 21, 2017

Supporting interactive debugger for tests mochajs/mocha#2775

Closed

novemberborn mentioned this pull request Jun 16, 2023

Add option to filter invalid arguments from execArgv when launching worker threads #3207

Closed

set child process debug port to an available port - fixes #342 #874

set child process debug port to an available port - fixes #342 #874

Conversation

develar commented May 25, 2016 • edited Loading

jamestalmage commented May 25, 2016

develar commented May 27, 2016

develar commented May 27, 2016

jamestalmage commented May 27, 2016

develar commented May 27, 2016

jamestalmage commented May 27, 2016

jamestalmage commented May 27, 2016

develar commented May 27, 2016

develar commented May 27, 2016

jamestalmage commented May 27, 2016

jamestalmage commented May 27, 2016

develar commented Jun 10, 2016

jamestalmage commented Jun 18, 2016

develar commented Jun 18, 2016 • edited Loading

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

Choose a reason for hiding this comment

novemberborn commented Jun 19, 2016

jamestalmage commented Jun 20, 2016

develar commented Jun 20, 2016 • edited Loading

jamestalmage commented Jun 20, 2016 • edited Loading

develar commented Jun 20, 2016 • edited Loading

develar commented Jun 20, 2016 • edited Loading

develar commented Jun 20, 2016

sindresorhus commented Aug 12, 2016

develar commented Aug 17, 2016

KeKs0r commented Sep 20, 2016 • edited Loading

develar commented Sep 20, 2016

mightyiam commented Nov 16, 2016

develar commented Nov 16, 2016

mightyiam commented Nov 16, 2016

sindresorhus commented Nov 16, 2016

develar commented Nov 17, 2016 • edited Loading

mightyiam commented Nov 17, 2016

richchurcher commented Feb 28, 2017

ImTheDeveloper commented May 6, 2017

dohomi commented Jun 13, 2017 • edited Loading

melisoner2006 commented Aug 4, 2017

novemberborn commented Aug 5, 2017

melisoner2006 commented Aug 6, 2017

Gregoyle commented Feb 20, 2018

melisoner2006 commented Feb 20, 2018 • edited Loading

develar commented May 25, 2016 •

edited

Loading

develar commented Jun 18, 2016 •

edited

Loading

develar commented Jun 20, 2016 •

edited

Loading

jamestalmage commented Jun 20, 2016 •

edited

Loading

develar commented Jun 20, 2016 •

edited

Loading

develar commented Jun 20, 2016 •

edited

Loading

KeKs0r commented Sep 20, 2016 •

edited

Loading

develar commented Nov 17, 2016 •

edited

Loading

dohomi commented Jun 13, 2017 •

edited

Loading

melisoner2006 commented Feb 20, 2018 •

edited

Loading