Add exceptions for arktype, execa, and highland to prevent them…

… from being flagged by unhandled pipe error query
github · Napalys · Jun 4, 2025 · May 20, 2025 · May 20, 2025 · May 20, 2025
commit c6db32ed73b790aaf5cd094c03473386d4e7920e
diff --git a/javascript/ql/lib/ext/arktype.model.yml b/javascript/ql/lib/ext/arktype.model.yml
@@ -0,0 +1,6 @@
+extensions:
+  - addsTo:
+      pack: codeql/javascript-all
+      extensible: typeModel
+    data:
+      - ["NonNodeStream", "arktype", "Fuzzy"]
diff --git a/javascript/ql/lib/ext/execa.model.yml b/javascript/ql/lib/ext/execa.model.yml
@@ -0,0 +1,6 @@
+extensions:
+  - addsTo:
+      pack: codeql/javascript-all
+      extensible: typeModel
+    data:
+      - ["NonNodeStream", "execa", "Fuzzy"]
diff --git a/javascript/ql/lib/ext/highland.model.yml b/javascript/ql/lib/ext/highland.model.yml
@@ -0,0 +1,6 @@
+extensions:
+  - addsTo:
+      pack: codeql/javascript-all
+      extensible: typeModel
+    data:
+      - ["NonNodeStream", "highland", "Fuzzy"]
diff --git a/javascript/ql/test/query-tests/Quality/UnhandledStreamPipe/arktype.js b/javascript/ql/test/query-tests/Quality/UnhandledStreamPipe/arktype.js
@@ -1,3 +1,3 @@
 import { type } from 'arktype';

-type.string.pipe(Number) // $SPURIOUS:Alert
+type.string.pipe(Number);
diff --git a/javascript/ql/test/query-tests/Quality/UnhandledStreamPipe/execa.js b/javascript/ql/test/query-tests/Quality/UnhandledStreamPipe/execa.js
@@ -4,7 +4,7 @@ const execa = require('execa');
  const first = execa('node', ['empty.js']);
  const second = execa('node', ['stdin.js']);

-  first.stdout.pipe(second.stdin); // $SPURIOUS:Alert
+  first.stdout.pipe(second.stdin);

  const {stdout} = await second;
  console.log(stdout);

diff --git a/javascript/ql/test/query-tests/Quality/UnhandledStreamPipe/highland.js b/javascript/ql/test/query-tests/Quality/UnhandledStreamPipe/highland.js
@@ -5,4 +5,4 @@ highland(fs.createReadStream('input.txt'))
  .map(line => {
    if (line.length === 0) throw new Error('Empty line');
    return line;
-  }).pipe(fs.createWriteStream('output.txt')); // $SPURIOUS:Alert
+  }).pipe(fs.createWriteStream('output.txt'));
diff --git a/javascript/ql/test/query-tests/Quality/UnhandledStreamPipe/test.expected b/javascript/ql/test/query-tests/Quality/UnhandledStreamPipe/test.expected
@@ -1,6 +1,3 @@
-| arktype.js:3:1:3:24 | type.st ... Number) | Stream pipe without error handling on the source stream. Errors won't propagate downstream and may be silently dropped. |
-| execa.js:7:3:7:33 | first.s ... .stdin) | Stream pipe without error handling on the source stream. Errors won't propagate downstream and may be silently dropped. |
-| highland.js:4:1:8:45 | highlan ... .txt')) | Stream pipe without error handling on the source stream. Errors won't propagate downstream and may be silently dropped. |
 | rxjsStreams.js:19:3:19:28 | z.optio ... k("x")) | Stream pipe without error handling on the source stream. Errors won't propagate downstream and may be silently dropped. |
 | test.js:4:5:4:28 | stream. ... nation) | Stream pipe without error handling on the source stream. Errors won't propagate downstream and may be silently dropped. |
 | test.js:19:5:19:17 | s2.pipe(dest) | Stream pipe without error handling on the source stream. Errors won't propagate downstream and may be silently dropped. |