Verifying VS Code debugger with default configuration works on tests in our SDKs

[deyaaeldeen]

• deletes custom vs code launch.json files that mostly duplicate testing commands that already exist as npm scripts.
• factors out nyc calls to its own coverage scripts in package.json files when it gets in the way of the debugger (when mocha uses ts-node).
• fixes Add VS Code Debug configs for the SDKs #6979 by using the default automatic debug configuration.
• fixes [guidelines] Write down how to use the VSCode debugger with the Azure SDK #8088 by updating the contributing guide accordingly.

See https://code.visualstudio.com/updates/v1_45#_automatic-debug-configurations for release notes on the vs code debugger with default configuration.

[jeremymeng]

• when it gets in the way of the debugger (when mocha uses ts-node).

I'm curious on why nyc is affecting debugging when using ts-node.

[jeremymeng]

The build pipelines run certain npm test scripts and upload the code coverage results. Please ensure that still work.

[xirzec]

So there are two common use cases that I want to confirm still work:

1. I can set a breakpoint in some unit test and hit F5, which should execute the unit tests and hit my breakpoint
2. I can set a breakpoint in some sample code that lives in my source tree (e.g. an example usage of a client I am building) and I can F5 into that TS file and then step into the client, etc.

As long as those two cases work this is great!

[deyaaeldeen]

@jeremymeng I guess it has something to do with source maps. I will do some digging and get back to you.

@xirzec So you do the following. Hit CTRL+SHIFT+D to open the debugger panel, click on "show" all automatic debug configurations (if you do not have other debug configs). choose Node.js (Preview) from the dropdown menu, and finally select your favorite npm testing script. Later, you can hit F5 to debug using that same npm script It remembers the automatic config you selected but sometimes it does not if it is the only config you have.

Regarding the second point, debugging samples in vscode is already not working currently on master, or does it?

[deyaaeldeen]

@jeremymeng yup it is source maps related and is fixed by passing --produce-source-map to nyc, see TypeStrong/ts-node#898. However, this triggers the compilation of the whole sdk including samples and I see broken samples in core-arm.

[deyaaeldeen]

Why do we pass those arguments?

[deyaaeldeen]

@ramya-rao-a in our offline discussion, there were two follow-up items
1- investigating running samples through the debugger, I created #10334.
2- investigating restricting the npm scripts accessible to the debugger.

I will look at them later and I believe they are not blocking merging this PR. Does the PR look good to you?

[deyaaeldeen]

This has been sitting idle for too long, would you guys take a look? cc @willmtemple, @jeremymeng, @richardpark-msft, @XiaoningLiu @HarshaNalluru

[jeremymeng]

/azp run js - storage-queue - tests

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).