hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2026-05-02 12:15:17 +02:00
Code Issues Packages Projects Releases Wiki Activity

TS: Add debugging flag and document how to run the debugger

Browse Source
This commit is contained in:
Asger F
2019-08-19 15:04:02 +01:00
parent 24f407c104
commit ca79b083cf
2 changed files with 46 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
javascript/extractor/lib/typescript/README.md Normal file
View File

@@ -0,0 +1,21 @@
TypeScript parser wrapper
-------------------------
The TypeScript "parser wrapper" is a Node.js program launched from the JavaScript
extractor in order to extract TypeScript code.
The two processes communicate via a command/response protocol via stdin/stdout.
Debugging
---------
To debug the parser script:
1. Launch an extraction process with the environment variable `SEMMLE_TYPESCRIPT_ATTACH_DEBUGGER`
set to `break`.
2. Open VSCode and choose "Debug: Attach to Node process" from the command palette, and
choose the process that looks like the parser-wrapper.
If you don't wish to pause on entry, instead set `SEMMLE_TYPESCRIPT_ATTACH_DEBUGGER` to
any non-empty value.

27
javascript/extractor/src/com/semmle/js/parser/TypeScriptParser.java
View File

@@ -98,6 +98,16 @@ public class TypeScriptParser {
*/
public static final String TYPESCRIPT_RAM_RESERVE_SUFFIX = "TYPESCRIPT_RAM_RESERVE";
/**
* An environment variable which, if set, allows a debugger to be attached to the Node.js
* process. Remote debugging will not be enabled.
* <p>
* If set to <code>break</code> the Node.js process will pause on entry waiting for the
* debugger to attach (<code>--inspect-brk</code>). If set to any other non-empty value,
* it will just enable debugging (<code>--inspect</code>).
*/
public static final String TYPESCRIPT_ATTACH_DEBUGGER = "SEMMLE_TYPESCRIPT_ATTACH_DEBUGGER";
/** The Node.js parser wrapper process, if it has been started already. */
private Process parserWrapperProcess;
@@ -203,7 +213,9 @@ public class TypeScriptParser {
result.add(nodeJsRuntime);
result.addAll(nodeJsRuntimeExtraArgs);
for(String arg : args) {
result.add(arg);
if (arg.length() > 0) {
result.add(arg);
}
}
return result;
}
@@ -236,9 +248,20 @@ public class TypeScriptParser {
int reserveMemoryMb = getMegabyteCountFromPrefixedEnv(TYPESCRIPT_RAM_RESERVE_SUFFIX, 400);
File parserWrapper = getParserWrapper();
String debuggerFlag = Env.systemEnv().get(TYPESCRIPT_ATTACH_DEBUGGER);
String inspectArg = "";
if (debuggerFlag != null && debuggerFlag.length() > 0) {
if (debuggerFlag.equalsIgnoreCase("break")) {
inspectArg = "--inspect-brk";
} else {
inspectArg = "--inspect";
}
}
List<String> cmd = getNodeJsRuntimeInvocation(
"--max_old_space_size=" + (mainMemoryMb + reserveMemoryMb),
inspectArg,
parserWrapper.getAbsolutePath()
);
ProcessBuilder pb = new ProcessBuilder(cmd);