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

Kotlin: Add warning location to warnings

Browse Source 
This also tweaks how the "too many warnings" logic works
This commit is contained in:
Ian Lynagh
2021-11-04 12:15:19 +00:00
parent 41d4c21910
commit 8330a404df
1 changed files with 24 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
java/kotlin-extractor/src/main/kotlin/utils/Logger.kt
View File

@@ -33,6 +33,20 @@ open class Logger(val logCounter: LogCounter, open val tw: TrapWriter) {
return "[${SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(Date())} K]" return "[${SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(Date())} K]"
} }
private fun getWarningLocation(): String? {
val st = Exception().stackTrace
for(x in st) {
when(x.className) {
"com.github.codeql.Logger",
"com.github.codeql.FileLogger" -> {}
else -> {
return x.toString()
}
}
}
return null
}
fun flush() { fun flush() {
tw.flush() tw.flush()
System.out.flush() System.out.flush()
@@ -53,18 +67,18 @@ open class Logger(val logCounter: LogCounter, open val tw: TrapWriter) {
fun trace(msg: String, exn: Exception) { fun trace(msg: String, exn: Exception) {
trace(msg + " // " + exn) trace(msg + " // " + exn)
} }
fun warn(severity: Severity, msg: String, locationString: String? = null, locationId: Label<DbLocation> = tw.unknownLocation, stackIndex: Int = 2) { fun warn(severity: Severity, msg: String, locationString: String? = null, locationId: Label<DbLocation> = tw.unknownLocation) {
val st = Exception().stackTrace val warningLoc = getWarningLocation()
val warningLocStr = if(warningLoc == null) "<unknown location>" else warningLoc
val suffix = val suffix =
if(st.size < stackIndex + 1) { if(warningLoc == null) {
" Missing caller information.\n" " Missing caller information.\n"
} else { } else {
val caller = st[stackIndex].toString() val count = logCounter.warningCounts.getOrDefault(warningLoc, 0) + 1
val count = logCounter.warningCounts.getOrDefault(caller, 0) + 1 logCounter.warningCounts[warningLoc] = count
logCounter.warningCounts[caller] = count
when { when {
logCounter.warningLimit <= 0 -> "" logCounter.warningLimit <= 0 -> ""
count == logCounter.warningLimit -> " Limit reached for warnings from $caller.\n" count == logCounter.warningLimit -> " Limit reached for warnings from $warningLoc.\n"
count > logCounter.warningLimit -> return count > logCounter.warningLimit -> return
else -> "" else -> ""
} }
@@ -72,7 +86,7 @@ open class Logger(val logCounter: LogCounter, open val tw: TrapWriter) {
val ts = timestamp() val ts = timestamp()
tw.writeDiagnostics(StarLabel(), severity.sev, "", msg, "$ts $msg\n$suffix", locationId) tw.writeDiagnostics(StarLabel(), severity.sev, "", msg, "$ts $msg\n$suffix", locationId)
val locStr = if (locationString == null) "" else "At " + locationString + ": " val locStr = if (locationString == null) "" else "At " + locationString + ": "
print("$ts Warning: $locStr$msg\n$suffix") print("$ts Warning($warningLocStr): $locStr$msg\n$suffix")
} }
fun warn(msg: String, exn: Exception) { fun warn(msg: String, exn: Exception) {
warn(Severity.Warn, msg + " // " + exn) warn(Severity.Warn, msg + " // " + exn)
@@ -102,9 +116,9 @@ class FileLogger(logCounter: LogCounter, override val tw: FileTrapWriter): Logge
return "[${SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(Date())} K]" return "[${SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(Date())} K]"
} }
fun warnElement(severity: Severity, msg: String, element: IrElement, stackIndex: Int = 3) { fun warnElement(severity: Severity, msg: String, element: IrElement) {
val locationString = tw.getLocationString(element) val locationString = tw.getLocationString(element)
val locationId = tw.getLocation(element) val locationId = tw.getLocation(element)
warn(severity, msg, locationString, locationId, stackIndex) warn(severity, msg, locationString, locationId)
} }
} }