Merge branch 'master' into develop

Author: tstack

NEWS.md

@@ -54,6 +54,15 @@ Features:
 ## lnav v0.14.1
 
 Features:
+* The DB view now shows a status bar above the bottom
+  status bar with the SQL query that populated the view,
+  the relative time when it was run, and how long it took.
+  A reload icon at the left side of the bar can be clicked
+  to re-run the query.  For queries that read from log-backed
+  tables, the status bar also calls out whether the results
+  are "on current log data" or "on old log data" relative to
+  what lnav is currently indexing.  The same information is
+  exposed via the new `lnav_views.view_details` column.
 * For terminals that support the Kitty Keyboard
   protocol, the following hotkeys are now supported
   in the prompt:

TESTS_ENVIRONMENT.in

@@ -122,6 +122,7 @@ run_cap_test() {
 
     sed -ibak \
         -e "s;${prefix}/etc;{prefix}/etc;g" \
+        -e 's;run_at\\":\\".*\\";;' \
         -e "s;${LNAV_VERSION};{LNAV_VERSION};g" \
         -e "s;${test_dir};{test_dir};g" \
         -e "s;${builddir};{test_dir};g" \

docs/schemas/config-v1.schema.json

@@ -557,6 +557,11 @@
                                             "description": "Icon for a 'busy' status",
                                             "title": "/ui/theme-defs/<theme_name>/icons/busy",
                                             "$ref": "#/definitions/icon"
+                                        },
+                                        "reload": {
+                                            "description": "Icon for a 'reload' button",
+                                            "title": "/ui/theme-defs/<theme_name>/icons/reload",
+                                            "$ref": "#/definitions/icon"
                                         }
                                     },
                                     "additionalProperties": false
@@ -646,6 +651,11 @@
                                             "title": "/ui/theme-defs/<theme_name>/styles/offset-time",
                                             "$ref": "#/definitions/style"
                                         },
+                                        "time-ago": {
+                                            "description": "Styling for a relative 'N ago' timestamp",
+                                            "title": "/ui/theme-defs/<theme_name>/styles/time-ago",
+                                            "$ref": "#/definitions/style"
+                                        },
                                         "time-column": {
                                             "description": "Styling for the time column",
                                             "title": "/ui/theme-defs/<theme_name>/styles/time-column",

docs/source/ui.rst

@@ -429,6 +429,21 @@ PRQL [#]_ statement.
 
 Press :kbd:`v` to switch to the database result view.
 
+A status bar above the bottom status bar shows the query that populated
+the view, how long ago it ran, and how long it took.  Clicking
+the reload icon (↻) at the left of the bar re-runs the query.
+
+If the query reads from log-backed tables (:code:`all_logs`,
+per-format tables like :code:`syslog_log`, :code:`all_opids`, etc.),
+the timing status also notes whether the results are based on
+the current log data or old log data.  For queries that don't
+read from log data (e.g. :code:`;SELECT 1`), the timing status
+does not mention the log data freshness.
+
+The same query metadata is exposed via the :code:`view_details`
+column on the :code:`lnav_views` vtable as a JSON object containing
+:code:`query`, :code:`run_at`, and :code:`duration_us`.
+
 .. [#] lnav must be compiled in an environment with Rust/Cargo available
    for PRQL support.
 

src/CMakeLists.txt

@@ -536,6 +536,7 @@ add_library(
         command_executor.cc
         crashd.client.cc
         curl_looper.cc
+        db_status_source.cc
         db_sub_source.cc
         dump_internals.cc
         elem_to_json.cc
@@ -674,6 +675,7 @@ add_library(
         column_namer.hh
         crashd.client.hh
         curl_looper.hh
+        db_status_source.hh
         doc_status_source.hh
         dump_internals.hh
         elem_to_json.hh

src/Makefile.am

@@ -274,6 +274,7 @@ noinst_HEADERS = \
 	data_scanner.hh \
 	data_scanner_re.re \
 	data_parser.hh \
+	db_status_source.hh \
 	db_sub_source.hh \
 	doc_status_source.hh \
 	document.sections.hh \
@@ -501,6 +502,7 @@ libdiag_a_SOURCES = \
 	command_executor.cc \
 	crashd.client.cc \
 	curl_looper.cc \
+	db_status_source.cc \
 	db_sub_source.cc \
 	document.sections.cc \
 	dump_internals.cc \

src/base/humanize.time.cc

@@ -69,9 +69,14 @@ point::as_time_ago() const
     if (delta < 0s) {
         return "in the future";
     }
-    if (delta < 1min) {
+    if (delta < 5s) {
         return "just now";
     }
+    if (delta < 1min) {
+        return fmt::format(
+            FMT_STRING("{}s ago"),
+            std::chrono::duration_cast<std::chrono::seconds>(delta).count());
+    }
     if (delta < 2min) {
         return "one minute ago";
     }

src/base/humanize.time.tests.cc

@@ -42,10 +42,10 @@ TEST_CASE("time ago")
     auto t1_chrono = std::chrono::seconds(t1);
 
     auto p1 = humanize::time::point::from_tv({t1, 0}).with_recent_point(
-        {(time_t) t1 + 5, 0});
+        {(time_t) t1 + 4, 0});
 
     CHECK(p1.as_time_ago() == "just now");
-    CHECK(p1.as_precise_time_ago() == " 5 seconds ago");
+    CHECK(p1.as_precise_time_ago() == " 4 seconds ago");
 
     auto p2 = humanize::time::point::from_tv({t1, 0}).with_recent_point(
         {(time_t) t1 + 65, 0});

src/base/lnav.console.cc

@@ -541,6 +541,8 @@ wchar_for_icon(ui_icon_t ic)
             return {U'\u2291', role_t::VCR_TEXT};
         case ui_icon_t::busy:
             return {U'\u23f3', role_t::VCR_TEXT};
+        case ui_icon_t::reload:
+            return {U'\u21bb', role_t::VCR_WARNING};
     }
 
     ensure(false);

src/base/string_attr_type.hh

@@ -75,9 +75,11 @@ enum class ui_icon_t : int32_t {
     tag,
     partition,
     busy,
+    reload,
 };
 
-constexpr auto ui_icon_count = lnav::enums::to_underlying(ui_icon_t::busy) + 1;
+constexpr auto ui_icon_count
+    = lnav::enums::to_underlying(ui_icon_t::reload) + 1;
 
 /** Roles that can be mapped to curses attributes using attrs_for_role() */
 enum class role_t : int32_t {
@@ -98,6 +100,7 @@ enum class role_t : int32_t {
     VCR_ADJUSTED_TIME,
     VCR_SKEWED_TIME,
     VCR_OFFSET_TIME,
+    VCR_TIME_AGO,
     VCR_TIME_COLUMN,
     VCR_TIME_COLUMN_TO_TEXT,
     VCR_FILE_OFFSET,
@@ -537,6 +540,13 @@ ok(S str)
     return std::make_pair(std::move(str), VC_ROLE.value(role_t::VCR_OK));
 }
 
+template<typename S>
+std::pair<S, string_attr_pair>
+time_ago(S str)
+{
+    return std::make_pair(std::move(str), VC_ROLE.value(role_t::VCR_TIME_AGO));
+}
+
 template<typename S>
 std::pair<S, string_attr_pair>
 hidden(S str)