onlylogs 0.9.0 → 0.11.0

data/app/models/onlylogs/file.rb

@@ -8,6 +8,7 @@ module Onlylogs
       self.path = path
       self.last_position = last_position
       validate!
+      @inode = ::File.stat(path).ino
     end
 
     def go_to_position(position)
@@ -16,11 +17,12 @@ module Onlylogs
       self.last_position = position
     end
 
+    # Yields new lines until the file is rotated away from under its name; then
+    # returns, since the position no longer means anything on the file now there.
     def watch(&block)
-      # return enum_for(:watch) unless block
-
       loop do
         sleep 0.5
+        return if rotated?
 
         new_lines = read_new_lines
         next if new_lines.empty?
@@ -29,6 +31,15 @@ module Onlylogs
       end
     end
 
+    # A rename rotation puts another inode under the name, a copytruncate rotation
+    # keeps the inode but makes the file smaller than what was already read.
+    def rotated?
+      return true unless exist?
+
+      stat = ::File.stat(path)
+      stat.ino != @inode || stat.size < last_position
+    end
+
     def size
       ::File.size(path)
     end

data/app/models/onlylogs/grep.rb

@@ -94,7 +94,8 @@ module Onlylogs
       reader, writer = IO.pipe
 
       begin
-        pid = Process.spawn(*bounded(command_args, timeout), out: writer, err: ::File::NULL, pgroup: true)
+        pid = Process.spawn(*deprioritised(bounded(command_args, timeout)),
+          out: writer, err: ::File::NULL, pgroup: true)
       rescue
         reader.close
         raise
@@ -116,6 +117,12 @@ module Onlylogs
     TIMED_OUT_EXIT_STATUS = 124
     KILL_GRACE_PERIOD = 0.5
 
+    SEARCH_NICENESS = 19
+
+    def self.deprioritised(command_args)
+      ["nice", "-n", SEARCH_NICENESS.to_s, *command_args]
+    end
+
     def self.bounded(command_args, timeout)
       return command_args unless timeout && timeout_command_available?
 
@@ -161,17 +168,18 @@ module Onlylogs
       nil
     end
 
+    MATCH_TIMEOUT = 0.1 # seconds
+
     def self.match_line?(line, string, regexp_mode: false)
       # Strip ANSI color codes from the line before matching
       stripped_line = line.gsub(/\e\[[0-9;]*m/, "")
       # Normalize multiple spaces to single spaces
       normalized_line = stripped_line.gsub(/\s+/, " ")
 
-      if regexp_mode
-        normalized_line.match?(string)
-      else
-        normalized_line.match?(Regexp.escape(string))
-      end
+      pattern = regexp_mode ? string : Regexp.escape(string)
+      normalized_line.match?(Regexp.new(pattern, timeout: MATCH_TIMEOUT))
+    rescue ::RegexpError
+      false
     end
   end
 end

data/app/views/onlylogs/logs/index.html.erb

@@ -1,22 +1,42 @@
 <style>
     .grid {
         display: grid;
-        grid-template-rows: 32px 1fr;
+        grid-template-rows: 38px 1fr;
         height: 100vh;
+        font-family: "SFMono-Regular", Consolas, "Liberation Mono", Menlo, Courier, monospace;
+        font-size: 0.8rem;
     }
 
     .grid-header {
         display: flex;
         align-items: center;
-        border-bottom: 1px solid lightgray;
+        gap: 0.5rem;
+        padding: 0 0.65rem;
+        background-color: #f3f5f9;
+        border-bottom: 1px solid #dde3ec;
+        color: #58626f;
     }
 
-    .log-file-dropdown {
-        margin-left: 0.5rem;
+    .log-file-dropdown select {
+        font: inherit;
+        padding: 0.2rem 0.4rem;
+        border: 1px solid #b9c4d3;
+        border-radius: 3px;
+        background-color: #fff;
+        color: #12171f;
     }
 
     .download-link {
-        margin-left: 0.5rem;
+        color: #1a4fc4;
+        text-decoration: none;
+        padding: 0.2rem 0.45rem;
+        border: 1px solid #9dbcf7;
+        border-radius: 3px;
+        background-color: #e8f0fe;
+    }
+
+    .download-link:hover {
+        background-color: #d7e5fd;
     }
 </style>
 <div class="grid">

data/app/views/onlylogs/shared/_log_container.html.erb

@@ -1,4 +1,4 @@
-<%# locals: (log_file_path:) %>
+<%# locals: (log_file_path:, live_enabled: true) %>
 <script nonce="<%= request.content_security_policy_nonce %>"
         src="<%= asset_path('onlylogs/clusterize.js') %>"></script>
 <link rel="stylesheet" href="<%= asset_path('onlylogs/clusterize.css') %>" />
@@ -8,7 +8,9 @@
     autoscroll = local_assigns[:autoscroll] != false
     filter = local_assigns[:filter] || ""
     regexp_mode = local_assigns[:regexp_mode] == true
-    mode = local_assigns[:mode] || "live"
+    # A file nothing writes to any more (no drain attached, a rotated log) has nothing
+    # to follow, so live mode is not offered at all and the viewer opens in search.
+    mode = live_enabled ? (local_assigns[:mode] || "live") : "static"
     file_size = File.size(log_file_path)
     start_position = local_assigns[:start_position]
     end_position = local_assigns[:end_position]
@@ -27,14 +29,28 @@
      data-log-streamer-auto-scroll-value="<%= autoscroll %>"
      data-log-streamer-regexp-mode-value="<%= regexp_mode %>"
      data-log-streamer-mode-value="<%= mode %>"
+     data-log-streamer-live-enabled-value="<%= live_enabled %>"
      data-log-streamer-file-size-value="<%= file_size %>"
-     data-action="text-selection:start->log-streamer#pauseForSelection"
+     data-action="text-selection:start->log-streamer#pauseForSelection text-selection:search->log-streamer#switchToSearch"
      class="onlylogs-log-container" >
     <div data-log-streamer-target="logLines" data-text-selection-target="logLines" id="scrollArea" class="onlylogs-log-lines clusterize-scroll">
       <div id="contentArea" class="clusterize-content">
       </div>
     </div>
 
+    <%# Search with an empty query would stream the entire file, so it is not run
+        at all until something is typed. This says so instead of looking idle. %>
+    <div class="onlylogs-search-placeholder" data-log-streamer-target="searchPlaceholder" hidden>
+      <p class="onlylogs-search-placeholder__title">Nothing to search for yet</p>
+      <p class="onlylogs-search-placeholder__hint">
+        <% if live_enabled %>
+          Type a query to search this file, or switch to Live to follow it as it is written.
+        <% else %>
+          Type a query to search this file.
+        <% end %>
+      </p>
+    </div>
+
     <button type="button"
             data-text-selection-target="button"
             class="onlylogs-context-menu hidden-button"
@@ -44,32 +60,40 @@
     </button>
 
     <div class="onlylogs-log-toolbar">
-        <div>
-          <label class="toolbar-label">
-            <input id="liveMode" type="checkbox" <%= mode == "live" ? "checked" : "" %> name="liveMode" data-log-streamer-target="liveMode" data-keyboard-shortcuts-target="liveMode" data-action="change->log-streamer#toggleLiveMode">
-            <u>L</u>ive Mode
-          </label>
-        </div>
-        <div>
-          <label class="toolbar-label">
-            <input id="autoscroll" type="checkbox" <%= autoscroll ? "checked" : "" %> name="autoscroll" data-log-streamer-target="autoscroll" data-keyboard-shortcuts-target="autoscroll" data-action="change->log-streamer#toggleAutoScroll">
-            <u>A</u>utoscroll
-          </label>
-        </div>
-        <div>
-          <label class="toolbar-label">
-            <input id="regexpMode" type="checkbox" <%= regexp_mode ? "checked" : "" %> name="regexpMode" data-log-streamer-target="regexpMode" data-text-selection-target="regexpMode" data-action="change->log-streamer#toggleRegexpMode">
-            <u>R</u>egexp Mode
-          </label>
+      <div class="onlylogs-toolbar-row onlylogs-toolbar-row--controls">
+        <% if live_enabled %>
+        <div class="onlylogs-mode-switch" role="group" aria-label="Log mode">
+          <button type="button"
+                  class="onlylogs-mode-switch__button"
+                  data-onlylogs-mode-button="live"
+                  data-log-streamer-target="liveButton"
+                  data-keyboard-shortcuts-target="liveButton"
+                  data-action="click->log-streamer#switchToLive"
+                  aria-pressed="<%= mode == "live" %>"
+                  title="Follow the file as it is written (L)">
+            <span>▶ <u>L</u>ive</span>
+          </button>
+          <button type="button"
+                  class="onlylogs-mode-switch__button"
+                  data-onlylogs-mode-button="static"
+                  data-log-streamer-target="searchButton"
+                  data-keyboard-shortcuts-target="searchButton"
+                  data-action="click->log-streamer#switchToSearch"
+                  aria-pressed="<%= mode != "live" %>"
+                  title="Search what is already in the file (S)">
+            <span>🔍 <u>S</u>earch</span>
+          </button>
         </div>
+        <% end %>
         <div>
           <label class="toolbar-label">
-            Filter:
+            <span data-onlylogs-mode="live">Follow:</span>
+            <span data-onlylogs-mode="static">Query:</span>
             <div class="filter-input-wrapper">
               <input type="text"
                      name="filter"
                      value="<%= filter %>"
-                     placeholder="Enter filter text..."
+                     placeholder="<%= mode == "live" ? "follow lines matching…" : "search the whole file…" %>"
                      data-log-streamer-target="filterInput"
                      data-text-selection-target="filterInput"
                      data-action="input->log-streamer#applyFilter">
@@ -82,7 +106,28 @@
             </div>
           </label>
         </div>
-        <div class="range-slider-wrapper">
+        <div>
+          <label class="toolbar-label">
+            <input id="regexpMode" type="checkbox" <%= regexp_mode ? "checked" : "" %> name="regexpMode" data-log-streamer-target="regexpMode" data-text-selection-target="regexpMode" data-action="change->log-streamer#toggleRegexpMode">
+            <span><u>R</u>egexp</span>
+          </label>
+        </div>
+        <div data-onlylogs-mode="live">
+          <label class="toolbar-label">
+            <input id="autoscroll" type="checkbox" <%= autoscroll ? "checked" : "" %> name="autoscroll" data-log-streamer-target="autoscroll" data-keyboard-shortcuts-target="autoscroll" data-action="change->log-streamer#toggleAutoScroll">
+            <span><u>A</u>utoscroll</span>
+          </label>
+        </div>
+        <div data-onlylogs-mode="live">
+          <button type="button"
+                  data-log-streamer-target="searchWholeFileButton"
+                  class="search-whole-file-button"
+                  data-action="click->log-streamer#searchWholeFile"
+                  title="Search this text across the whole file">
+            Search whole file →
+          </button>
+        </div>
+        <div class="range-slider-wrapper" data-onlylogs-mode="static">
           <%= render "onlylogs/shared/range_slider",
                      start_name: "start_position",
                      end_name: "end_position",
@@ -105,28 +150,30 @@
                   class="stop-search-button hidden-button"
                   data-action="click->log-streamer#stopSearch"
                   title="Stop current search">
-            ⏹️ Stop
+            ■ Stop
           </button>
         </div>
-        <div>
-          <span data-log-streamer-target="results" class="results-text">Results: 0</span>
-        </div>
-        <div data-log-streamer-target="message"></div>
-        <% unless Onlylogs.ripgrep_enabled? %>
-          <span class="grep-warning" title="Search is slow. Install ripgrep for better performance">⚠️</span>
-        <% end %>
-        <div class="file-size" title="File size: <%= number_to_human_size(File.size(log_file_path)) %>">
-          <%= number_to_human_size(File.size(log_file_path)) %>
-        </div>
-        <div class="clear-button-wrapper">
+    </div>
+
+    <div class="onlylogs-toolbar-row onlylogs-toolbar-row--status">
+        <span data-log-streamer-target="results" class="results-text">Results: 0</span>
+        <span data-log-streamer-target="message" class="status-message"></span>
+        <div class="onlylogs-toolbar-row__end">
+          <% unless Onlylogs.ripgrep_enabled? %>
+            <span class="grep-warning" title="Search is slow. Install ripgrep for better performance">⚠️</span>
+          <% end %>
+          <span class="file-size" title="File size: <%= number_to_human_size(File.size(log_file_path)) %>">
+            <%= number_to_human_size(File.size(log_file_path)) %>
+          </span>
           <button type="button"
                   data-log-streamer-target="clearButton"
                   class="clear-logs-button"
                   data-action="click->log-streamer#clearLogs"
+                  aria-label="Clear all log lines"
                   title="Clear all log lines">
-            🗑️ Clear
+            🗑
           </button>
+          <span data-log-streamer-target="websocketStatus" class="websocket-status websocket-status--disconnected" title="WebSocket Disconnected">🔴</span>
         </div>
-        <div data-log-streamer-target="websocketStatus" class="websocket-status websocket-status--disconnected" title="WebSocket Disconnected">🔴</div>
     </div>
 </div>