Show first log entries on review screen

Author: mbriand

swattool/logsview.py

@@ -200,6 +200,37 @@ def _get_log_highlights(loglines: list[str], failure: swatbuild.Failure
     return highlight_lines
 
 
+_cached_log_highlights: dict[tuple[swatbuild.Failure, str],
+                             dict[int, _Highlight]] = {}
+
+
+def _get_cached_log_highlights(failure: swatbuild.Failure, logname: str,
+                               loglines: list[str]
+                               ) -> dict[int, _Highlight]:
+    highlights = _cached_log_highlights.get((failure, logname), None)
+    if highlights:
+        return highlights
+
+    highlights = _get_log_highlights(loglines, failure)
+    _cached_log_highlights[(failure, logname)] = highlights
+    return highlights
+
+
+def get_log_highlights(failure: swatbuild.Failure, logname: str
+                       ) -> list[str]:
+    """Get log highlights for a given log file."""
+    logdata = _load_log(failure, logname)
+    if not logdata:
+        return []
+
+    loglines = logdata.splitlines()
+
+    highlights = _get_cached_log_highlights(failure, logname, loglines)
+
+    return [loglines[line - 1] for line in highlights
+            if highlights[line].in_menu]
+
+
 def _show_log(loglines: list[str], selected_line: Optional[int],
               highlight_lines: dict[int, _Highlight],
               preview_height: Optional[int], preview_width: Optional[int]):
@@ -248,7 +279,7 @@ def show_log_menu(failure: swatbuild.Failure, logname: str) -> bool:
 
     utils.clear()
     loglines = logdata.splitlines()
-    highlights = _get_log_highlights(loglines, failure)
+    highlights = _get_cached_log_highlights(failure, logname, loglines)
 
     entries = ["View entire log file|",
                "View entire log file in default editor|",

swattool/review.py

@@ -3,7 +3,9 @@
 """Swatbot review functions."""
 
 import logging
+import shutil
 import sys
+import textwrap
 from typing import Any, Optional
 
 import click
@@ -262,6 +264,27 @@ def review_menu(builds: list[swatbuild.Build],
     return (new_entry, need_refresh)
 
 
+def _show_infos(build: swatbuild.Build, userinfo: userdata.UserInfo):
+    # Reserve chars for spacing.
+    reserved = 8
+    termwidth = shutil.get_terminal_size((80, 20)).columns
+    width = termwidth - reserved
+    maxhighlights = 5
+
+    print(build.format_description(userinfo, width))
+    print()
+
+    failure = build.get_first_failure()
+    highlights = logsview.get_log_highlights(failure, "stdio")
+    wrapped_highlights = [textwrap.indent(line, " " * 4)
+                          for highlight in highlights[:maxhighlights]
+                          for line in textwrap.wrap(highlight, width)
+                          ]
+    print("Key log infos:")
+    print("\n".join(wrapped_highlights))
+    print()
+
+
 def review_failures(builds: list[swatbuild.Build],
                     userinfos: userdata.UserInfos,
                     open_autobuilder_url: bool,
@@ -285,16 +308,10 @@ def review_failures(builds: list[swatbuild.Build],
                 if open_swatbot_url:
                     click.launch(build.swat_url)
                 if open_stdio_url:
-                    if build.test in ["a-full", "a-quick"]:
-                        # TODO: can we do anything better here ?
-                        logger.warning("Test is %s, "
-                                       "fail log might be the log of a child",
-                                       build.test)
                     build.get_first_failure().open_log_url()
 
             if show_infos:
-                print(build.format_description(userinfo))
-                print()
+                _show_infos(build, userinfo)
                 show_infos = False
 
             prev_entry = entry

swattool/swatbuild.py

@@ -5,7 +5,6 @@
 import enum
 import json
 import logging
-import shutil
 from datetime import datetime
 from typing import Any, Iterable, Optional
 
@@ -250,7 +249,8 @@ def get_field(field):
 
         return tuple(get_field(k) for k in keys)
 
-    def format_description(self, userinfo: userdata.UserInfo) -> str:
+    def format_description(self, userinfo: userdata.UserInfo,
+                           maxwidth: int) -> str:
         """Get info on one given failure in a pretty way."""
         def format_field(field):
             if field == Field.STATUS:
@@ -289,12 +289,7 @@ def format_field(field):
         desc = tabulate.tabulate(table, tablefmt="plain")
 
         if userinfo.notes:
-            # Reserve chars for spacing.
-            reserved = 8
-            termwidth = shutil.get_terminal_size((80, 20)).columns
-            width = termwidth - reserved
-
-            wrapped = userinfo.get_wrapped_notes(width, " " * 4)
+            wrapped = userinfo.get_wrapped_notes(maxwidth, " " * 4)
             desc += f"\n\n{Field.USER_NOTES}:\n{wrapped}"
 
         return desc