hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2025-12-16 16:53:25 +01:00
Code Issues Packages Projects Releases Wiki Activity

JavaScript: Ignore outDirs that would exclude everything

Browse Source 
In #19680 we added support for automatically ignoring files in the
`outDir` directory as specified in the TSconfig compiler options (as
these files were likely duplicates of `.ts` file we were already
scanning).

However, in some cases people put `outDir: "."` or even `outDir: ".."`
in their configuration, which had the side effect of excluding _all_
files, leading to a failed extraction.

With the changes in this PR, we now ignore any `outDir`s that are not
properly contained within the source root of the code being scanned.
This should prevent the files from being extracted, while still allowing
us to not double-scan files in, say, a `.github` directory, as seen in
some Actions workflows.
This commit is contained in:
Taus
2025-07-11 13:28:59 +00:00
parent 649c8831ec
commit 43accc50cd
2 changed files with 35 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
javascript/extractor/src/com/semmle/js/extractor/AutoBuild.java
View File

@@ -754,7 +754,11 @@ public class AutoBuild {
continue;
}
Path odir = cfg.getParent().resolve(root.getCompilerOptions().getOutDir()).toAbsolutePath().normalize();
outDirs.add(odir);
// Only exclude outDirs that are proper subdirectories of the source root
// This prevents excluding all code when outDir points outside the source root or to the source root itself
if (tryRelativize(LGTM_SRC, odir) != null && !odir.equals(LGTM_SRC)) {
outDirs.add(odir);
}
}
} catch (Exception e) {
// ignore malformed tsconfig or missing fields

30
javascript/extractor/test/com/semmle/js/extractor/test/AutoBuildTests.java
View File

@@ -235,6 +235,36 @@ public class AutoBuildTests {
runTest();
}
@Test
public void skipFilesInTsconfigOutDirPointingToParent() throws IOException {
// Test that outDir pointing to parent directory (outside source root) is ignored
addFile(true, LGTM_SRC, "tsconfig.json");
Path config = Paths.get(LGTM_SRC.toString(), "tsconfig.json");
Files.write(config,
"{\"compilerOptions\":{\"outDir\":\"..\"}}".getBytes(StandardCharsets.UTF_8));
// All files should be extracted since outDir pointing outside source root should be ignored
addFile(true, LGTM_SRC, "src", "app.ts");
addFile(true, LGTM_SRC, "main.js");
runTest();
}
@Test
public void skipFilesInTsconfigOutDirPointingToSourceRoot() throws IOException {
// Test that outDir pointing to source root itself is ignored
addFile(true, LGTM_SRC, "tsconfig.json");
Path config = Paths.get(LGTM_SRC.toString(), "tsconfig.json");
Files.write(config,
"{\"compilerOptions\":{\"outDir\":\".\"}}".getBytes(StandardCharsets.UTF_8));
// All files should be extracted since outDir pointing to source root should be ignored
addFile(true, LGTM_SRC, "src", "app.ts");
addFile(true, LGTM_SRC, "main.js");
runTest();
}
@Test
public void includeFile() throws IOException {
envVars.put("LGTM_INDEX_INCLUDE", "tst.js");