Merge pull request #528 from alpaca-tc/fix-route-tracker

Fix route tracker

Author: danmayer

lib/coverband/collectors/route_tracker.rb

@@ -25,26 +25,29 @@ def initialize(options = {})
       # and ensure high performance
       ###
       def track_key(payload)
-        route = if payload[:request]
+        route = if payload.key?(:location)
+          # For redirect.action_dispatch
+          return unless Coverband.configuration.track_redirect_routes
+
           {
             controller: nil,
             action: nil,
             url_path: payload[:request].path,
             verb: payload[:request].method
           }
         else
+          # For start_processing.action_controller
           {
             controller: payload[:params]["controller"],
             action: payload[:action],
             url_path: nil,
             verb: payload[:method]
           }
         end
-        if route
-          if newly_seen_key?(route)
-            @logged_keys << route
-            @keys_to_record << route if track_key?(route)
-          end
+
+        if newly_seen_key?(route)
+          @logged_keys << route
+          @keys_to_record << route if track_key?(route)
         end
       end
 

lib/coverband/configuration.rb

@@ -12,7 +12,7 @@ class Configuration
       :test_env, :web_enable_clear, :gem_details, :web_debug, :report_on_exit,
       :simulate_oneshot_lines_coverage,
       :view_tracker, :defer_eager_loading_data,
-      :track_routes, :route_tracker,
+      :track_routes, :track_redirect_routes, :route_tracker,
       :track_translations, :translations_tracker,
       :trackers, :csp_policy, :hide_settings
 
@@ -77,6 +77,7 @@ def reset
       @track_views = true
       @view_tracker = nil
       @track_routes = false
+      @track_redirect_routes = true
       @route_tracker = nil
       @track_translations = false
       @translations_tracker = nil

test/coverband/collectors/route_tracker_test.rb

@@ -33,14 +33,32 @@ def setup
     tracker = Coverband::Collectors::RouteTracker.new(store: store, roots: "dir")
 
     payload = {
-      request: Payload.new("path", "GET")
+      request: Payload.new("path", "GET"),
+      status: 302,
+      location: 'https://coverband.dev/'
     }
     tracker.track_key(payload)
     tracker.save_report
     assert_equal [route_hash], tracker.logged_keys
   end
 
-  test "track controller routes" do
+  test "track redirect routes when track_redirect_routes is false" do
+    Coverband.configuration.track_redirect_routes = false
+
+    store = fake_store
+    tracker = Coverband::Collectors::RouteTracker.new(store: store, roots: "dir")
+
+    payload = {
+      request: Payload.new("path", "GET"),
+      status: 302,
+      location: 'https://coverband.dev/'
+    }
+    tracker.track_key(payload)
+    tracker.save_report
+    assert_equal [], tracker.logged_keys
+  end
+
+  test "track controller routes in Rails < 6.1" do
     store = fake_store
     route_hash = {controller: "some/controller", action: "index", url_path: nil, verb: "GET"}
     store.raw_store.expects(:hset).with(tracker_key, route_hash.to_s, anything)
@@ -57,6 +75,27 @@ def setup
     assert_equal [route_hash], tracker.logged_keys
   end
 
+  test "track controller routes in Rails >= 6.1" do
+    store = fake_store
+    route_hash = {controller: "some/controller", action: "index", url_path: nil, verb: "GET"}
+    store.raw_store.expects(:hset).with(tracker_key, route_hash.to_s, anything)
+    tracker = Coverband::Collectors::RouteTracker.new(store: store, roots: "dir")
+    payload = {
+      params: {
+        "controller"=>"some/controller",
+        "action"=>"index"
+      },
+      controller: "SomeController",
+      action: "index",
+      path: "path",
+      method: "GET",
+      request: Payload.new("path", "GET")
+    }
+    tracker.track_key(payload)
+    tracker.save_report
+    assert_equal [route_hash], tracker.logged_keys
+  end
+
   test "report used routes" do
     store = fake_store
     route_hash = {controller: "some/controller", action: "index", url_path: nil, verb: "GET"}