Merge pull request #14518 from igfoo/igfoo/trap_files

Kotlin: Log when we start and finish writing to TRAP files

Author: igfoo

java/kotlin-extractor/src/main/kotlin/ExternalDeclExtractor.kt

@@ -63,7 +63,9 @@ class ExternalDeclExtractor(val logger: FileLogger, val compression: Compression
                     logger.info("Skipping extracting external decl $shortName")
                 } else {
                     val trapFile = manager.file
+                    logger.info("Will write TRAP file $trapFile")
                     val trapTmpFile = File.createTempFile("${trapFile.nameWithoutExtension}.", ".${trapFile.extension}.tmp", trapFile.parentFile)
+                    logger.debug("Writing temporary TRAP file $trapTmpFile")
                     try {
                         compression.bufferedWriter(trapTmpFile).use {
                             extractorFn(it, signature, manager)
@@ -72,6 +74,7 @@ class ExternalDeclExtractor(val logger: FileLogger, val compression: Compression
                         if (!trapTmpFile.renameTo(trapFile)) {
                             logger.error("Failed to rename $trapTmpFile to $trapFile")
                         }
+                        logger.info("Finished writing TRAP file $trapFile")
                     } catch (e: Exception) {
                         manager.setHasError()
                         logger.error("Failed to extract '$shortName'. Partial TRAP file location is $trapTmpFile", e)

java/kotlin-extractor/src/main/kotlin/KotlinExtractorExtension.kt

@@ -416,10 +416,12 @@ private abstract class TrapFileWriter(val logger: FileLogger, trapName: String,
     }
 
     fun getTempWriter(): BufferedWriter {
+        logger.info("Will write TRAP file $realFile")
         if (this::tempFile.isInitialized) {
             logger.error("Temp writer reinitialized for $realFile")
         }
         tempFile = File.createTempFile(realFile.getName() + ".", ".trap.tmp" + extension, parentDir)
+        logger.debug("Writing temporary TRAP file $tempFile")
         return getWriter(tempFile)
     }
 
@@ -442,6 +444,7 @@ private abstract class TrapFileWriter(val logger: FileLogger, trapName: String,
         if (!tempFile.renameTo(realFile)) {
             logger.warn("Failed to rename $tempFile to $realFile")
         }
+        logger.info("Finished writing TRAP file $realFile")
     }
 }
 

java/ql/integration-tests/all-platforms/kotlin/logs/index_logs.py

@@ -36,6 +36,9 @@ def write_line(origin, kind, msg):
                     if msg.startswith('Peak memory: '):
                         # Peak memory information varies from run to run, so just ignore it
                         continue
+                    if msg.startswith('Will write TRAP file ') or msg.startswith('Finished writing TRAP file '):
+                        # These vary between machines etc, and aren't very interesting, so just ignore them
+                        continue
                     write_line(j['origin'], j['kind'], msg)
 
 runSuccessfully(["codeql", "database", "index-files", "--language=csv", "--include=logs.csv", "test-db"])