Merge pull request #530 from danmayer/add_last_touched

resolve #494 pull in the work that @FeLvi-zzz committed to support last accessed time

Author: danmayer

lib/coverband/adapters/hash_redis_store.rb

@@ -167,7 +167,7 @@ def save_report(report)
 
           arguments_key = [@redis_namespace, SecureRandom.uuid].compact.join(".")
           @redis.set(arguments_key, {ttl: @ttl, files_data: files_data}.to_json, ex: JSON_PAYLOAD_EXPIRATION)
-          @redis.evalsha(hash_incr_script, [arguments_key])
+          @redis.evalsha(hash_incr_script, [arguments_key], [report_time])
         end
         @redis.sadd(files_key, keys) if keys.any?
       end
@@ -289,9 +289,10 @@ def add_coverage_for_file(data_from_redis, hash)
         return unless file_hash(file) == data_from_redis[FILE_HASH]
 
         data = coverage_data_from_redis(data_from_redis)
+        timedata = coverage_time_data_from_redis(data_from_redis)
         hash[file] = data_from_redis.select do |meta_data_key, _value|
           META_DATA_KEYS.include?(meta_data_key)
-        end.merge!("data" => data)
+        end.merge!("data" => data, "timedata" => timedata)
         hash[file][LAST_UPDATED_KEY] =
           (hash[file][LAST_UPDATED_KEY].nil? || hash[file][LAST_UPDATED_KEY] == "") ? nil : hash[file][LAST_UPDATED_KEY].to_i
         hash[file].merge!(LAST_UPDATED_KEY => hash[file][LAST_UPDATED_KEY],
@@ -306,6 +307,14 @@ def coverage_data_from_redis(data_from_redis)
         end
       end
 
+      def coverage_time_data_from_redis(data_from_redis)
+        max = data_from_redis[FILE_LENGTH_KEY].to_i - 1
+        Array.new(max + 1) do |index|
+          unixtime = data_from_redis["#{index}_last_posted"]
+          unixtime.nil? ? nil : Time.at(unixtime.to_i)
+        end
+      end
+
       def script_input(key:, file:, file_hash:, data:, report_time:, updated_time:)
         coverage_data = data.each_with_index.each_with_object({}) do |(coverage, index), hash|
           hash[index] = coverage if coverage

lib/coverband/utils/html_formatter.rb

@@ -155,11 +155,11 @@ def id(source_file)
         Digest::SHA1.hexdigest(source_file.filename)
       end
 
-      def timeago(time)
-        if time
+      def timeago(time, err_msg = "Not Available")
+        if time.respond_to?(:iso8601)
           "<abbr class=\"timeago\" title=\"#{time.iso8601}\">#{time.iso8601}</abbr>"
         else
-          "Not Available"
+          err_msg
         end
       end
 

lib/coverband/utils/source_file.rb

@@ -25,13 +25,15 @@ class Line
         attr_reader :coverage
         # Whether this line was skipped
         attr_reader :skipped
+        # The coverage data posted time for this line: either nil (never), nil (missed) or Time instance (last posted)
+        attr_reader :coverage_posted
 
         # Lets grab some fancy aliases, shall we?
         alias source src
         alias line line_number
         alias number line_number
 
-        def initialize(src, line_number, coverage)
+        def initialize(src, line_number, coverage, coverage_posted = nil)
           raise ArgumentError, "Only String accepted for source" unless src.is_a?(String)
           raise ArgumentError, "Only Integer accepted for line_number" unless line_number.is_a?(Integer)
           raise ArgumentError, "Only Integer and nil accepted for coverage" unless coverage.is_a?(Integer) || coverage.nil?
@@ -40,6 +42,7 @@ def initialize(src, line_number, coverage)
           @line_number = line_number
           @coverage = coverage
           @skipped = false
+          @coverage_posted = coverage_posted
         end
 
         # Returns true if this is a line that should have been covered, but was not
@@ -82,6 +85,8 @@ def status
       attr_reader :filename
       # The array of coverage data received from the Coverage.result
       attr_reader :coverage
+      # The array of coverage timedata received from the Coverage.result
+      attr_reader :coverage_posted
 
       # the date this version of the file first started to record coverage
       attr_reader :first_updated_at
@@ -96,6 +101,7 @@ def initialize(filename, file_data)
         @runtime_relavant_lines = nil
         if file_data.is_a?(Hash)
           @coverage = file_data["data"]
+          @coverage_posted = file_data["timedata"] || [] # NOTE: only implement timedata for HashRedisStore
           @first_updated_at = @last_updated_at = NOT_AVAILABLE
           @first_updated_at = Time.at(file_data["first_updated_at"]) if file_data["first_updated_at"]
           @last_updated_at = Time.at(file_data["last_updated_at"]) if file_data["last_updated_at"]
@@ -139,7 +145,12 @@ def build_lines
         coverage_exceeding_source_warn if coverage.size > src.size
 
         lines = src.map.with_index(1) { |src, i|
-          Coverband::Utils::SourceFile::Line.new(src, i, never_loaded ? 0 : coverage[i - 1])
+          Coverband::Utils::SourceFile::Line.new(
+            src,
+            i,
+            never_loaded ? 0 : coverage[i - 1],
+            (never_loaded || !coverage_posted.is_a?(Array)) ? nil : coverage_posted[i - 1]
+          )
         }
 
         process_skipped_lines(lines)
@@ -200,6 +211,10 @@ def line_coverage(index)
         lines[index]&.coverage
       end
 
+      def line_coverage_posted(index)
+        lines[index]&.coverage_posted
+      end
+
       # Returns all lines that should have been, but were not covered
       # as instances of SimpleCov::SourceFile::Line
       def missed_lines

lua/lib/persist-coverage.lua

@@ -21,6 +21,9 @@ for _, file_data in ipairs(files_data) do
   redis.call('HSETNX', hash_key, 'first_updated_at', first_updated_at)
   for line, coverage in pairs(file_data.coverage) do
     redis.call("HINCRBY", hash_key, line, coverage)
+    if coverage > 0 then
+      redis.call("HSET", hash_key, line .. "_last_posted", ARGV[1])
+    end
   end
   if ttl and ttl ~= cjson.null then
     redis.call("EXPIRE", hash_key, ttl)

test/coverband/adapters/hash_redis_store_test.rb

@@ -57,23 +57,21 @@ def test_coverage_for_file
         "first_updated_at" => yesterday.to_i,
         "last_updated_at" => yesterday.to_i,
         "file_hash" => "abcd",
-        "data" => [0, 1, 2]
+        "data" => [0, 1, 2],
+        "timedata" => [nil, Time.at(yesterday.to_i), Time.at(yesterday.to_i)]
       },
       @store.coverage["./dog.rb"]
     )
     mock_time(today)
     @store.save_report(
       "app_path/dog.rb" => [1, 1, 0]
     )
-    assert_equal(
-      {
-        "first_updated_at" => yesterday.to_i,
-        "last_updated_at" => today.to_i,
-        "file_hash" => "abcd",
-        "data" => [1, 2, 2]
-      },
-      @store.coverage["./dog.rb"]
-    )
+
+    assert_equal("abcd", @store.coverage["./dog.rb"]["file_hash"])
+    assert_equal(today.to_i, @store.coverage["./dog.rb"]["last_updated_at"])
+    assert_equal(yesterday.to_i, @store.coverage["./dog.rb"]["first_updated_at"])
+    assert_equal([1, 2, 2], @store.coverage["./dog.rb"]["data"])
+    assert_equal([Time.at(today.to_i), Time.at(today.to_i), Time.at(yesterday.to_i)], @store.coverage["./dog.rb"]["timedata"])
   end
 
   def test_ttl_set
@@ -109,7 +107,8 @@ def test_coverage_for_multiple_files
         "first_updated_at" => current_time.to_i,
         "last_updated_at" => current_time.to_i,
         "file_hash" => "abcd",
-        "data" => [0, nil, 1, 2]
+        "data" => [0, nil, 1, 2],
+        "timedata" => [nil, nil, Time.at(current_time.to_i), Time.at(current_time.to_i)]
       }, @store.coverage["./dog.rb"]
     )
     assert_equal [1, 2, 0, 1, 5], @store.coverage["./cat.rb"]["data"]
@@ -213,7 +212,8 @@ def test_get_coverage_cache
         "first_updated_at" => yesterday.to_i,
         "last_updated_at" => yesterday.to_i,
         "file_hash" => "abcd",
-        "data" => [0, 1, 2]
+        "data" => [0, 1, 2],
+        "timedata" => [nil, Time.at(yesterday.to_i), Time.at(yesterday.to_i)]
       },
       @store.coverage["./dog.rb"]
     )
@@ -225,7 +225,8 @@ def test_get_coverage_cache
         "first_updated_at" => yesterday.to_i,
         "last_updated_at" => yesterday.to_i,
         "file_hash" => "abcd",
-        "data" => [0, 1, 2]
+        "data" => [0, 1, 2],
+        "timedata" => [nil, Time.at(yesterday.to_i), Time.at(yesterday.to_i)]
       },
       @store.coverage["./dog.rb"]
     )
@@ -235,7 +236,8 @@ def test_get_coverage_cache
         "first_updated_at" => yesterday.to_i,
         "last_updated_at" => yesterday.to_i,
         "file_hash" => "abcd",
-        "data" => [0, 2, 4]
+        "data" => [0, 2, 4],
+        "timedata" => [nil, Time.at(yesterday.to_i), Time.at(yesterday.to_i)]
       },
       @store.coverage["./dog.rb"]
     )

views/source_file.erb

@@ -45,6 +45,7 @@
             runtime:
             <%= result.file_with_type(source_file, Coverband::RUNTIME_TYPE)&.line_coverage(index) || 0 %>
             all: <%= line.coverage %>
+            last posted: <%= timeago(result.file_with_type(source_file, Coverband::RUNTIME_TYPE)&.line_coverage_posted(index), "-") %>
           </span><% end %>
           <% if line.skipped? %><span class="hits">skipped</span><% end %>
           <code class="ruby"><%= CGI.escapeHTML(line.src.chomp) %></code>