False Positive: CloseReader.ql reports resources that are either transferred to another owner or closed by a wrapper.
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Anfängerfreundlichkeit
- 50/100
Rechercherichtung
Lies Likely Bugs/Resource Leaks/CloseReader.ql und vergleiche sein Verhalten mit NegCase3.java und NegCase7.java; führe anschließend die betroffenen Query-Tests aus. Erledigt ist die Aufgabe, wenn diese beiden gemeldeten Zeilen nicht mehr als Fehler markiert werden, während echte Fälle von nicht geschlossenen Readern, InputStreams und ZipFiles weiterhin erkannt werden.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
Version
codeql 2.24.3
Checker
- Checker id:
Likely Bugs/Resource Leaks/CloseReader.ql - Checker description: This checker detects instances of Reader, InputStream, or ZipFile objects that are created but not guaranteed to be closed on method exit, potentially causing resource leaks.
Description of the false positive
Neither sample is a straightforward leak.
In NegCase3.java, the FileInputStream is immediately wrapped by a type whose close() implementation delegates to the underlying stream. In NegCase7.java, the stream is passed into another object and stored there, which is an ownership-transfer pattern rather than a local leak.
Affected test cases
NegCase3.java
The wrapper is the owner. Reporting the inner FileInputStream as leaked means the query is not trusting a wrapper that clearly forwards close().
NegCase7.java
The stream escapes through field = new Outer(is). That may or may not be a great API design, but it is not the same as dropping a local resource on the floor.
Reproduction code
NegCase3.java
// A FileInputStream wrapped in a custom closeable with empty close should not be flagged as a leak.
package scensct.core.neg;
import java.io.FileInputStream;
import java.io.InputStream;
import java.io.IOException;
public class NegCase3 {
// Custom wrapper with empty close method.
static class NoCloseWrapper extends InputStream {
private final InputStream inner;
NoCloseWrapper(InputStream in) { this.inner = in; }
@Override public int read() throws IOException { return inner.read(); }
@Override public void close() throws IOException { inner.close(); } // Now delegates closing.
}
public void test() throws IOException {
// Scenario 3: Transitive closeable parent satisfies noNeedToClose.
new NoCloseWrapper(new FileInputStream("test.txt")); // Inner resource managed by wrapper. // [REPORTED LINE]
}
}
NegCase7.java
// A FileInputStream passed to a locally initialized outer constructor and escaping should not be flagged as a leak.
package scensct.core.neg;
import java.io.FileInputStream;
import java.io.InputStream;
import java.io.IOException;
public class NegCase7 {
static class Outer {
private final InputStream inner;
Outer(InputStream in) { this.inner = in; } // No exceptions declared.
}
private Outer field;
public void test() throws IOException {
// Scenario 7: Resource not assigned, passed to constructor, escapes via field.
InputStream is = new FileInputStream("test.txt"); // [REPORTED LINE]
field = new Outer(is); // Resource escapes, no leak.
}
}
Cause analysis
These results suggest two over-approximations in Likely Bugs/Resource Leaks/CloseReader.ql.
First, the query is not reliably recognizing wrapper classes that take responsibility for the underlying resource. Second, it is treating ownership transfer as if it were equivalent to local abandonment. Both behaviors inflate the result set with cases that developers will not read as direct leaks in the current method.
- Vorherrschende Sprache
- CodeQL
- Sterne
- 10.1k
- Forks
- 2.1k
- Ø Merge
- 2 T. 16 Std.
- Gemergte PRs (30 T.)
- 143
Beitragsleitfaden
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus github/codeql
-
agentic-workflows
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 70/100
-
false-positive javascript
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 84/100
-
C#: cs/simplifiable-boolean-expression false positive on Nullable<bool> compared with a literal Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 82/100
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
-
false-positive
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 70/100
Ähnliche Issues
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 75/100
palladius/rails8-app-on-gcp#145 ·
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 75/100
elastic/gradle-plugins#156 ·
-
area:workflow bug ready-for-agent
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 75/100
fil-donadoni/tolaria#4409 ·
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 65/100
dotenvx/dotenv-vscode#139 ·
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 70/100
Fission-AI/OpenSpec#1960 ·