Merge pull request github#12277 from github/tausbn/clean-up-structured-logs-module

QL: Clean up structured logs module

Author: MathiasVP

ql/ql/src/codeql_ql/StructuredLogs.qll

@@ -3,9 +3,8 @@ private import codeql_ql.ast.internal.TreeSitter
 
 class Object extends JSON::Object {
   JSON::Value getValue(string key) {
-    exists(JSON::Pair p |
-      p = this.getChild(_) and p.getKey().(JSON::String).getChild().getValue() = key
-    |
+    exists(JSON::Pair p | p = this.getChild(_) |
+      key = p.getKey().(JSON::String).getChild().getValue() and
       result = p.getValue()
     )
   }
@@ -35,104 +34,106 @@ class Array extends JSON::Array {
   Array getArray(int i) { result = this.getChild(i) }
 }
 
-abstract class LogEntry extends Object { }
+module EvaluatorLog {
+  class Entry extends Object { }
 
-class LogHeader extends LogEntry {
-  LogHeader() { this.getType() = "LOG_HEADER" }
+  class LogHeader extends Entry {
+    LogHeader() { this.getType() = "LOG_HEADER" }
 
-  string getCodeQLVersion() { result = this.getString("codeqlVersion") }
+    string getCodeQLVersion() { result = this.getString("codeqlVersion") }
 
-  string getLogVersion() { result = this.getString("logVersion") }
-}
+    string getLogVersion() { result = this.getString("logVersion") }
+  }
 
-class QueryStarted extends LogEntry {
-  QueryStarted() { this.getType() = "QUERY_STARTED" }
+  class QueryStarted extends Entry {
+    QueryStarted() { this.getType() = "QUERY_STARTED" }
 
-  string getQueryName() { result = this.getString("queryName") }
+    string getQueryName() { result = this.getString("queryName") }
 
-  int getStage(int i) { result = this.getArray("stage").getNumber(i) }
-}
+    int getStage(int i) { result = this.getArray("stage").getNumber(i) }
+  }
 
-class PredicateStarted extends LogEntry {
-  PredicateStarted() { this.getType() = "PREDICATE_STARTED" }
+  class PredicateStarted extends Entry {
+    PredicateStarted() { this.getType() = "PREDICATE_STARTED" }
 
-  string getPredicateName() { result = this.getString("predicateName") }
+    string getPredicateName() { result = this.getString("predicateName") }
 
-  string getPosition() { result = this.getString("position") }
+    string getPosition() { result = this.getString("position") }
 
-  string getPredicateType() { result = this.getString("predicateType") }
+    string getPredicateType() { result = this.getString("predicateType") }
 
-  int getQueryCausingWork() { result = this.getNumber("queryCausingWork") }
+    int getQueryCausingWork() { result = this.getNumber("queryCausingWork") }
 
-  string getRAHash() { result = this.getString("raHash") }
+    string getRAHash() { result = this.getString("raHash") }
 
-  Object getRA() { result = this.getValue("ra") }
+    Object getRA() { result = this.getValue("ra") }
 
-  string getDependency(string key) { result = this.getObject("dependencies").getString(key) }
-}
+    string getDependency(string key) { result = this.getObject("dependencies").getString(key) }
+  }
 
-class PipelineStarted extends LogEntry {
-  PipelineStarted() { this.getType() = "PIPELINE_STARTED" }
+  class PipelineStarted extends Entry {
+    PipelineStarted() { this.getType() = "PIPELINE_STARTED" }
 
-  int getPredicateStartEvent() { result = this.getNumber("predicateStartEvent") }
+    int getPredicateStartEvent() { result = this.getNumber("predicateStartEvent") }
 
-  string getRAReference() { result = this.getString("raReference") }
-}
+    string getRAReference() { result = this.getString("raReference") }
+  }
 
-class PipelineCompleted extends LogEntry {
-  PipelineCompleted() { this.getType() = "PIPELINE_COMPLETED" }
+  class PipelineCompleted extends Entry {
+    PipelineCompleted() { this.getType() = "PIPELINE_COMPLETED" }
 
-  int getStartEvent() { result = this.getNumber("startEvent") }
+    int getStartEvent() { result = this.getNumber("startEvent") }
 
-  string getRAReference() { result = this.getString("raReference") }
+    string getRAReference() { result = this.getString("raReference") }
 
-  int getCount(int i) { result = this.getArray("counts").getNumber(i) }
+    int getCount(int i) { result = this.getArray("counts").getNumber(i) }
 
-  int getDuplicationPercentage(int i) {
-    result = this.getArray("duplicationPercentages").getNumber(i)
-  }
+    int getDuplicationPercentage(int i) {
+      result = this.getArray("duplicationPercentages").getNumber(i)
+    }
 
-  int getResultSize() { result = this.getNumber("resultSize") }
-}
+    int getResultSize() { result = this.getNumber("resultSize") }
+  }
 
-class PredicateCompleted extends LogEntry {
-  PredicateCompleted() { this.getType() = "PREDICATE_COMPLETED" }
+  class PredicateCompleted extends Entry {
+    PredicateCompleted() { this.getType() = "PREDICATE_COMPLETED" }
 
-  int getStartEvent() { result = this.getNumber("startEvent") }
+    int getStartEvent() { result = this.getNumber("startEvent") }
 
-  int getResultSize() { result = this.getNumber("resultSize") }
-}
+    int getResultSize() { result = this.getNumber("resultSize") }
+  }
 
-class QueryCompleted extends LogEntry {
-  QueryCompleted() { this.getType() = "QUERY_COMPLETED" }
+  class QueryCompleted extends Entry {
+    QueryCompleted() { this.getType() = "QUERY_COMPLETED" }
 
-  int getStartEvent() { result = this.getNumber("startEvent") }
+    int getStartEvent() { result = this.getNumber("startEvent") }
 
-  string getTerminationType() { result = this.getString("terminationType") }
-}
+    string getTerminationType() { result = this.getString("terminationType") }
+  }
 
-class LogFooter extends LogEntry {
-  LogFooter() { this.getType() = "LOG_FOOTER" }
-}
+  class LogFooter extends Entry {
+    LogFooter() { this.getType() = "LOG_FOOTER" }
+  }
 
-class CacheLookup extends LogEntry {
-  CacheLookup() { this.getType() = "CACHE_LOOKUP" }
+  class CacheLookup extends Entry {
+    CacheLookup() { this.getType() = "CACHE_LOOKUP" }
 
-  int getRelationSize() { result = this.getNumber("relationSize") }
-}
+    int getRelationSize() { result = this.getNumber("relationSize") }
+  }
 
-class SentinelEmpty extends LogEntry {
-  SentinelEmpty() { this.getType() = "SENTINEL_EMPTY" }
+  class SentinelEmpty extends Entry {
+    SentinelEmpty() { this.getType() = "SENTINEL_EMPTY" }
+  }
 }
 
 // Stuff to test whether we've covered all event types
-private File logFile() { result = any(LogHeader h).getLocation().getFile() }
+private File logFile() { result = any(EvaluatorLog::LogHeader h).getLocation().getFile() }
 
 private Object missing() {
   result =
     any(Object o |
       o.getLocation().getFile() = logFile() and
-      not o instanceof LogEntry and
+      not o instanceof EvaluatorLog::Entry and
       not exists(o.getParent().getParent()) // don't count nested objects
     )
 }