trackguard 0.28.0 → 0.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2629b3c673c2ac2c1f4e338dedc3abc7f9b572fb57e9b4f9091139809e362bc
-  data.tar.gz: 6b4657343eecf9de2b48bea0df3f24c4463109dc6ae521dc83dad79741bbfe99
+  metadata.gz: 1372d974514748b7cb553b4299b14de6345339c00947e24102be03ec7ac0be0d
+  data.tar.gz: 142f9a999003624989fa47ad7a422a5bc76c504dbb8666a8e676d49970490775
 SHA512:
-  metadata.gz: d8b5fc84be6801c276f5d7cb7dd0007a7b1c7d5d19d5db9858f2412396e3c99fc604e9276cc34ee0a05b4b63cc01f72fac8e176b1c2e852405813e0e484b4733
-  data.tar.gz: 96c791bce0d1cd72230e89e34a6335e4c7dfdbe818f90dccbd466bb3e908c2b9437e820dfe6afb9ced8a605e5293f341c65dd541e603a8bd9594210009c4dfe8
+  metadata.gz: e3f01bd73d5701b53f8e7a3ef37ab3c3a43b016dc72e9388c8b8f9db225412380889b8fd13ae1df8783231fcdb6fde828f7f6807854c6ef9fa0ee6a4924dc774
+  data.tar.gz: 9ff260dc894d2cbc70e69062bb878d394be1913faf4edd61dad5b9c10c41db2e68805985832ba8f4b7762af6a6483e0b6a0d9690447993d0c3f5ea542d8eb98c

data/app/assets/stylesheets/trackguard/admin.css

@@ -240,6 +240,7 @@
 /* ── Table ─────────────────────────────────────────────────────────── */
 .tg-table {
   width: 100%;
+  table-layout: fixed;
   border-collapse: collapse;
   font-size: 0.875rem;
   margin-bottom: 2rem;
@@ -269,6 +270,14 @@
   text-align: right;
   color: #9ca3af;
   font-weight: 400;
+  white-space: nowrap;
+  width: 3.5rem;
+}
+
+.tg-td--label {
+  overflow: hidden;
+  text-overflow: ellipsis;
+  white-space: nowrap;
 }
 
 .tg-td--break { word-break: break-all; }

data/app/controllers/concerns/trackguard/page_tracker.rb

@@ -15,7 +15,7 @@ module Trackguard
     private
 
     def set_trace_id
-      @trace_id = SecureRandom.uuid
+      @trace_id = request.env["trackguard.trace_id"]
     end
 
     def track_page_view
@@ -31,10 +31,17 @@ module Trackguard
         trace_id: @trace_id,
         source: extract_source,
         tracking_layer: "backend",
-        http_method: request.request_method
+        http_method: request.request_method,
+        prefetch: turbo_prefetch?
       )
     end
 
+    def turbo_prefetch?
+      request.headers["Purpose"] == "prefetch" ||
+        request.headers["Sec-Purpose"]&.start_with?("prefetch") ||
+        request.headers["X-Sec-Purpose"]&.start_with?("prefetch")
+    end
+
     def extract_source
       raw = params[:ref].presence || params[:utm_source].presence
       raw && raw.strip.downcase.first(64)

data/app/helpers/trackguard/application_helper.rb

@@ -1,10 +1,18 @@
 module Trackguard
   module ApplicationHelper
-    def trackguard_meta_tags
-      safe_join([
-                  tag.meta(name: "trackguard-url", content: trackguard.page_views_path),
-                  tag.meta(name: "trace-id", content: @trace_id)
-                ], "\n")
+    def trackguard_header_tags
+      tags = [ tag.meta(name: "trace-id", content: @trace_id) ]
+
+      case Trackguard.adapter
+      when Trackguard::Adapters::Local
+        tags << tag.meta(name: "trackguard-url", content: trackguard.page_views_path)
+      when Trackguard::Adapters::Hub
+        if Rails.env.production?
+          tags << tag.script(src: "#{Trackguard.hub_url}/track.js", data: { api_key: Trackguard.hub_api_key })
+        end
+      end
+
+      safe_join(tags, "\n")
     end
 
     def trackguard_nav_links

data/app/jobs/trackguard/hub/submit_blocked_request_job.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "json"
+
+module Trackguard
+  module Hub
+    class SubmitBlockedRequestJob < ApplicationJob
+      queue_as :default
+
+      def perform(ip:, user_agent:, path:, http_method:, block_reason:)
+        uri  = URI("#{Trackguard.hub_url}/api/backend/blocked_requests")
+        body = {
+          blocked_request: {
+            ip: ip, user_agent: user_agent, path: path,
+            http_method: http_method, block_reason: block_reason
+          }
+        }.to_json
+
+        req                  = Net::HTTP::Post.new(uri)
+        req["X-Api-Key"]     = Trackguard.hub_api_key
+        req["Authorization"] = "Bearer #{Trackguard.hub_secret_key}"
+        req["Content-Type"]  = "application/json"
+        req.body             = body
+
+        opts     = { use_ssl: uri.scheme == "https", open_timeout: 3, read_timeout: 5 }
+        response = Net::HTTP.start(uri.hostname, uri.port, **opts) { |http| http.request(req) }
+
+        unless response.is_a?(Net::HTTPSuccess)
+          Rails.logger.warn(
+            "[Trackguard::Hub::SubmitBlockedRequestJob] Unexpected response #{response.code} for path=#{path}"
+          )
+        end
+      rescue StandardError => e
+        Rails.logger.warn("[Trackguard::Hub::SubmitBlockedRequestJob] Failed to submit blocked request: #{e.message}")
+      end
+    end
+  end
+end

data/app/jobs/trackguard/hub/submit_page_view_job.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "json"
+
+module Trackguard
+  module Hub
+    class SubmitPageViewJob < ApplicationJob
+      queue_as :default
+
+      def perform(path:, ip:, user_agent:, referer:, session_id:, trace_id:, source:, http_method:, **)
+        uri  = URI("#{Trackguard.hub_url}/api/backend/page_views")
+        body = {
+          page_view: {
+            path: path, referer: referer, session_id: session_id, trace_id: trace_id,
+            source: source, http_method: http_method, ip: ip, user_agent: user_agent
+          }
+        }.to_json
+
+        req                  = Net::HTTP::Post.new(uri)
+        req["X-Api-Key"]     = Trackguard.hub_api_key
+        req["Authorization"] = "Bearer #{Trackguard.hub_secret_key}"
+        req["Content-Type"]  = "application/json"
+        req.body             = body
+
+        opts     = { use_ssl: uri.scheme == "https", open_timeout: 3, read_timeout: 5 }
+        response = Net::HTTP.start(uri.hostname, uri.port, **opts) { |http| http.request(req) }
+
+        unless response.is_a?(Net::HTTPSuccess)
+          Rails.logger.warn(
+            "[Trackguard::Hub::SubmitPageViewJob] Unexpected response #{response.code} for path=#{path}"
+          )
+        end
+      rescue StandardError => e
+        Rails.logger.warn("[Trackguard::Hub::SubmitPageViewJob] Failed to submit page view: #{e.message}")
+      end
+    end
+  end
+end

data/app/jobs/trackguard/track_blocked_request_job.rb

@@ -5,20 +5,7 @@ module Trackguard
     queue_as :default
 
     def perform(ip:, user_agent:, path:, http_method:, block_reason:)
-      visitor = Visitor.find_or_create_by!(ip: ip) do |v|
-        v.user_agent    = user_agent
-        v.first_seen_at = Time.current
-        v.last_seen_at  = Time.current
-      end
-      visitor.update!(last_seen_at: Time.current, user_agent: user_agent)
-
-      BlockedRequest.create!(
-        path: path,
-        user_agent: user_agent,
-        http_method: http_method,
-        block_reason: block_reason,
-        visitor: visitor
-      )
+      TrackBlockedRequest.call(ip:, user_agent:, path:, http_method:, block_reason:)
     end
   end
 end

data/app/services/trackguard/track_blocked_request.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Trackguard
+  class TrackBlockedRequest < ApplicationService
+    def initialize(ip:, user_agent:, path:, http_method:, block_reason:, visitor_scope: {})
+      @ip           = ip
+      @user_agent   = user_agent
+      @path         = path
+      @http_method  = http_method
+      @block_reason = block_reason
+      @visitor_scope = visitor_scope
+    end
+
+    def call
+      visitor = Visitor.find_or_create_by!(ip: @ip, **@visitor_scope) do |v|
+        v.user_agent    = @user_agent
+        v.first_seen_at = Time.current
+        v.last_seen_at  = Time.current
+      end
+      visitor.update!(last_seen_at: Time.current, user_agent: @user_agent)
+
+      BlockedRequest.create!(
+        path: @path,
+        user_agent: @user_agent,
+        http_method: @http_method,
+        block_reason: @block_reason,
+        visitor: visitor,
+        **@visitor_scope
+      )
+    end
+  end
+end

data/app/views/trackguard/admin/_stats_panel.html.erb

@@ -15,7 +15,7 @@
       <tbody>
         <% rows.each do |label, count| %>
           <tr>
-            <td class="tg-td"><%= label %></td>
+            <td class="tg-td tg-td--label"><%= label %></td>
             <td class="tg-td tg-td--num"><%= count %></td>
           </tr>
         <% end %>

data/config/importmap.rb

@@ -1 +1,3 @@
-pin_all_from File.expand_path("../app/assets/javascripts/controllers", __dir__), under: "controllers"
+if Trackguard.adapter.is_a?(Trackguard::Adapters::Local)
+  pin_all_from File.expand_path("../app/assets/javascripts/controllers", __dir__), under: "controllers"
+end

data/lib/trackguard/adapters/base.rb

@@ -9,7 +9,7 @@ module Trackguard
       def flagged_visitor?(ip)            = raise NotImplementedError, "#{self.class}#flagged_visitor?"
 
       def track_page_view(path:, ip:, user_agent:, referer:, session_id:, trace_id:, source:, tracking_layer:,
-                          http_method:)
+                          http_method:, prefetch: false)
         return if blocked_user_agent?(user_agent)
         return if blocked_path?(path)
         return if path.blank? || path.start_with?(Trackguard.admin_path)
@@ -17,7 +17,7 @@ module Trackguard
         perform_track_page_view(
           path: path, ip: ip, user_agent: user_agent, referer: referer,
           session_id: session_id, trace_id: trace_id, source: source,
-          tracking_layer: tracking_layer, http_method: http_method
+          tracking_layer: tracking_layer, http_method: http_method, prefetch: prefetch
         )
       end
 
@@ -28,7 +28,7 @@ module Trackguard
       protected
 
       def perform_track_page_view(path:, ip:, user_agent:, referer:, session_id:, trace_id:, source:,
-                                  tracking_layer:, http_method:)
+                                  tracking_layer:, http_method:, prefetch: false)
         raise NotImplementedError, "#{self.class}#perform_track_page_view"
       end
     end

data/lib/trackguard/adapters/hub.rb

@@ -31,14 +31,22 @@ module Trackguard
       end
 
       def track_blocked_request(ip:, user_agent:, path:, http_method:, block_reason:)
-        # placeholder: hub adapter does not persist blocked requests locally
+        Trackguard::Hub::SubmitBlockedRequestJob.perform_later(
+          ip: ip, user_agent: user_agent, path: path, http_method: http_method, block_reason: block_reason
+        )
       end
 
       protected
 
       def perform_track_page_view(path:, ip:, user_agent:, referer:, session_id:, trace_id:, source:,
-                                  tracking_layer:, http_method:)
-        # placeholder: hub tracking not yet implemented
+                                  tracking_layer:, http_method:, prefetch: false)
+        return if prefetch
+
+        Trackguard::Hub::SubmitPageViewJob.perform_later(
+          path: path, ip: ip, user_agent: user_agent, referer: referer,
+          session_id: session_id, trace_id: trace_id, source: source,
+          tracking_layer: tracking_layer, http_method: http_method
+        )
       end
 
       private
@@ -55,22 +63,8 @@ module Trackguard
       end
 
       def fetch_rules_from_hub
-        uri = URI("#{Trackguard.hub_url}/api/rules")
-        request = Net::HTTP::Get.new(uri)
-        request["Authorization"] = "Bearer #{Trackguard.hub_secret_key}"
-        request["Accept"] = "application/json"
-
-        etag = Rails.cache.read(ETAG_KEY)
-        request["If-None-Match"] = etag if etag
-
-        response = Net::HTTP.start(
-          uri.hostname, uri.port,
-          use_ssl: uri.scheme == "https",
-          open_timeout: 3,
-          read_timeout: 5
-        ) do |http|
-          http.request(request)
-        end
+        uri = URI("#{Trackguard.hub_url}/api/backend/rules")
+        response = execute_http(uri, build_request(uri))
 
         return Rails.cache.read(STALE_KEY) || {} if response.is_a?(Net::HTTPNotModified)
 
@@ -80,6 +74,21 @@ module Trackguard
         Rails.cache.write(ETAG_KEY, response["ETag"], expires_in: 24.hours) if response["ETag"]
         fresh
       end
+
+      def build_request(uri)
+        req = Net::HTTP::Get.new(uri)
+        req["Authorization"] = "Bearer #{Trackguard.hub_secret_key}"
+        req["X-Api-Key"] = Trackguard.hub_api_key
+        req["Accept"] = "application/json"
+        etag = Rails.cache.read(ETAG_KEY)
+        req["If-None-Match"] = etag if etag
+        req
+      end
+
+      def execute_http(uri, request)
+        opts = { use_ssl: uri.scheme == "https", open_timeout: 3, read_timeout: 5 }
+        Net::HTTP.start(uri.hostname, uri.port, **opts) { |http| http.request(request) }
+      end
     end
   end
 end

data/lib/trackguard/adapters/local.rb

@@ -32,7 +32,7 @@ module Trackguard
       protected
 
       def perform_track_page_view(path:, ip:, user_agent:, referer:, session_id:, trace_id:, source:,
-                                  tracking_layer:, http_method:)
+                                  tracking_layer:, http_method:, prefetch: false)
         TrackPageViewJob.perform_later(
           path: path,
           ip: ip,

data/lib/trackguard/engine.rb

@@ -6,7 +6,6 @@ module Trackguard
 
     config.to_prepare do
       ActionController::Base.helper Trackguard::ApplicationHelper
-      ActionController::Base.helper Trackguard::HubHelper
     end
 
     initializer "trackguard.assets" do |app|
@@ -17,6 +16,10 @@ module Trackguard
       app.config.importmap.paths << root.join("config/importmap.rb") if app.config.respond_to?(:importmap)
     end
 
+    initializer "trackguard.trace_id_middleware" do |app|
+      app.middleware.use Trackguard::TraceIdMiddleware
+    end
+
     config.after_initialize do
       Trackguard::RackAttack.configure
     end

data/lib/trackguard/trace_id_middleware.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Trackguard
+  class TraceIdMiddleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      env["trackguard.trace_id"] = SecureRandom.uuid
+      @app.call(env)
+    end
+  end
+end

data/lib/trackguard/version.rb

@@ -1,3 +1,3 @@
 module Trackguard
-  VERSION = "0.28.0".freeze
+  VERSION = "0.29.0".freeze
 end

data/lib/trackguard.rb

@@ -3,6 +3,7 @@
 require "trackguard/version"
 require "trackguard/engine"
 require "trackguard/rack_attack"
+require "trackguard/trace_id_middleware"
 require "trackguard/adapters/base"
 require "trackguard/adapters/local"
 require "trackguard/adapters/hub"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trackguard
 version: !ruby/object:Gem::Version
-  version: 0.28.0
+  version: 0.29.0
 platform: ruby
 authors:
 - Krzysztof Rygielski
@@ -58,8 +58,9 @@ files:
 - app/controllers/trackguard/admin/whitelisted_ips_controller.rb
 - app/controllers/trackguard/page_views_controller.rb
 - app/helpers/trackguard/application_helper.rb
-- app/helpers/trackguard/hub_helper.rb
 - app/jobs/trackguard/detect_suspicious_visitors_job.rb
+- app/jobs/trackguard/hub/submit_blocked_request_job.rb
+- app/jobs/trackguard/hub/submit_page_view_job.rb
 - app/jobs/trackguard/track_blocked_request_job.rb
 - app/jobs/trackguard/track_page_view_job.rb
 - app/models/trackguard/blocked_path.rb
@@ -71,6 +72,7 @@ files:
 - app/models/trackguard/whitelisted_ip.rb
 - app/services/trackguard/analytics_query.rb
 - app/services/trackguard/application_service.rb
+- app/services/trackguard/track_blocked_request.rb
 - app/services/trackguard/track_page_view.rb
 - app/views/layouts/trackguard/admin.html.erb
 - app/views/trackguard/admin/_nav.html.erb
@@ -98,6 +100,7 @@ files:
 - lib/trackguard/adapters/local.rb
 - lib/trackguard/engine.rb
 - lib/trackguard/rack_attack.rb
+- lib/trackguard/trace_id_middleware.rb
 - lib/trackguard/version.rb
 - trackguard.gemspec
 homepage: https://github.com/riggy/trackguard

data/app/helpers/trackguard/hub_helper.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-module Trackguard
-  module HubHelper
-    def trackguard_hub_js_tag
-      return unless Trackguard.adapter.is_a?(Trackguard::Adapters::Hub)
-
-      tag.script(src: "https://app.trackguard.dev/track.js", data: { api_key: Trackguard.hub_api_key })
-    end
-  end
-end