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

Java: Add parameterized module for restricting the number of returned results in telemetry queries.

Browse Source
This commit is contained in:
Michael Nebel
2022-06-15 10:48:44 +02:00
parent e3ecc5a66b
commit e6e2427154
1 changed files with 33 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
java/ql/src/Telemetry/ExternalApi.qll
View File

@@ -98,3 +98,36 @@ class ExternalApi extends Callable {
/** DEPRECATED: Alias for ExternalApi */
deprecated class ExternalAPI = ExternalApi;
/**
* A limit for the number of results produced by a telemetry query.
*/
int resultLimit() { result = 1000 }
/**
* A predicate signature for relevant usage counts of an External API `api`.
*/
signature predicate relevantUsagesSig(ExternalApi api, int usages);
/**
* Given a predicate to count relevant API usages, this module provides a predicate
* for restricting the number or returned results based on a certain limit.
*/
module Results<relevantUsagesSig/2 getRelevantUsages> {
private int getOrder(ExternalApi api) {
api =
rank[result](ExternalApi a, int usages |
getRelevantUsages(a, usages)
|
a order by usages desc, a.getApiName()
)
}
/**
* Holds if `api` is being used `usages` times and if it is
* in the top results (guarded by resultLimit).
*/
predicate restrict(ExternalApi api, int usages) {
getRelevantUsages(api, usages) and getOrder(api) <= resultLimit()
}
}