Class: ShopCircle::Orbit::Rails::Middleware

Inherits:
Object
  • Object
show all
Defined in:
lib/shopcircle/orbit/rails/middleware.rb

Overview

Rack middleware that auto-tracks screen_view events for full HTML page requests (server-rendered navigations). Skips assets, XHR/AJAX, and non-GET requests — client-side SPA/AJAX/Turbo route changes are not visible to the server, so track those with the browser JS SDK (trackScreenViews) instead.

Emits "screen_view" (the platform's canonical page/screen-view event) so it is counted in Pages, pageviews, bounce rate and journeys.

Opt out by removing from the middleware stack:

# config/application.rb
config.middleware.delete ShopCircle::Orbit::Rails::Middleware

Constant Summary collapse

SKIP_PREFIXES = 
%w[/assets /packs /rails /cable].freeze

Instance Method Summary collapse

Constructor Details

#initialize(app) ⇒ Middleware

Returns a new instance of Middleware.



22
23
24
 
# File 'lib/shopcircle/orbit/rails/middleware.rb', line 22

def initialize(app)
  @app = app
end

Instance Method Details

#call(env) ⇒ Object 



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/shopcircle/orbit/rails/middleware.rb', line 26

def call(env)
  status, headers, response = @app.call(env)
  begin
    if trackable?(env, status)
      request = Rack::Request.new(env)
      props = {
        path: request.path,
        method: request.request_method,
        status: status
      }
      unless ShopCircle::Orbit.configuration.redact_pii
        props[:user_agent] = request.user_agent
        props[:ip] = request.ip
        props[:referrer] = request.referrer
      end
      ShopCircle::Orbit.track("screen_view", props)
    end
  rescue StandardError => e
    ShopCircle::Orbit.configuration.resolved_logger.warn("[shopcircle-orbit] Tracking error: #{e.message}")
  ensure
    Thread.current[:shopcircle_orbit_profile_id] = nil
    Thread.current[:shopcircle_orbit_device_id] = nil
  end
  [status, headers, response]
end