ga_events 4.1.0 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b93d2ffe7308a325730dc5c73faf0765807c9a3c83aea96d911199044e73cf89
-  data.tar.gz: 044d35f5bba0adf9613e5886065cef5eadd38fded5957879b13ff16beb0dfb89
+  metadata.gz: 83fd5b6e15c900730f8f41e03ade3efab0b619a7c4e9e67074db8730ac0701db
+  data.tar.gz: e866ec33593b82a6f826004c4c03486203963be5eae9e534ed6be0cad9a3e626
 SHA512:
-  metadata.gz: e3ae1007735e30a3217f69fbbb026883eebb1096bb390ed831d855e9324b8444d5460b68842df05e9e5e0ffa5072d0f4ea4b7b09a95d63de8093f74f0c8f2212
-  data.tar.gz: 68ea2765ce64928d0b64bfebed5a9fdee2feffd4be04d22a31e3f6d40cd63584c60a576e6dce89809723f82f7c1b36263fa56f2a3af8e646c489e6755479c15f
+  metadata.gz: 0345da75e6b2500c22ef51b72823c3eaf42e71a0e57c9e617119dcacfa4a2aed07ea4120fb25db030d2c3394c322cfce44bdcd44c300ef0deaf275e36b9d5613
+  data.tar.gz: d2c2449b6117600eebd172680950a5e42c98f2669c75bb6eda9651d1e1dda0a8da731881b78d205236bedb17130f046a6df500cefd56641667e1c39bc9af35a3

data/README.md

@@ -15,7 +15,11 @@ pushes it to Google Analytics via gtag.js or Google Tag Manager.
 
 * Ruby >= 3.4
 * Rails 7.2 onwards
+
+## Optional dependencies
+
 * jQuery
+* Turbolinks or Hotwire Turbo
 
 ## Installation
 
@@ -27,7 +31,7 @@ gem 'ga_events'
 
 Run the `bundle` command to install it.
 
-Add to the top of your `application.js` (but after requiring jQuery):
+Add to the top of your `application.js`
 
 ```javascript
 //= require ga_events.js

data/app/assets/javascripts/ga_events.js.coffee

@@ -16,24 +16,33 @@ class GaEvents.Event
   # Decompose an event-string (ruby side) into an event object.
   @from_json: (string) ->
     events = JSON.parse(string)
-
-    $.map events, (event) =>
+    events.map((event) ->
       if event_name = event.__event__
         delete event.__event__
         new @(event_name, event)
+    , @)
 
   @from_dom: ->
     data_attribute = "data-#{@html_key}"
-    dom_events = $("div[#{data_attribute}]").attr data_attribute
-    @from_json dom_events if dom_events?
+    dom_events = document
+      .querySelector("div[#{data_attribute}]")
+      ?.getAttribute(data_attribute)
+
+    @from_json(dom_events) if dom_events?
 
   # Events should not be sent to an adapter unless the DOM has finished loading.
   @flush: ->
     return if @require_user_consent && !@user_consent_given
 
-    if @list.length > 0 and @may_flush
-      $.map @list, (event) -> event.push_to_adapter()
-      @list = []
+    push_events = =>
+      if @list.length > 0 and @may_flush
+        @list.forEach((event) -> event.push_to_adapter())
+        @list = []
+
+    if window.requestIdleCallback
+      requestIdleCallback(push_events, timeout: 250)
+    else
+      setTimeout(push_events, 1)
 
   # Add all events to a queue to flush them later
   constructor: (@event_name, @options = {}) ->
@@ -49,21 +58,44 @@ class GaEvents.Event
   # https://support.google.com/analytics/answer/13316687?hl=en#zippy=%2Cweb
   is_valid_event_name: -> /^[a-z]+[a-z0-9_]*$/i.test(@event_name)
 
-  jQuery =>
+
+  start = ->
     @may_flush = true
     @flush()
 
+    addEventListener = document.addEventListener
+
     process_xhr = (xhr) =>
       xhr_events = xhr.getResponseHeader @header_key
       @from_json decodeURIComponent(xhr_events) if xhr_events?
 
-    $(document).ajaxComplete((_, xhr) -> process_xhr(xhr))
-    $(document).on "turbolinks:request-end", (event) ->
-      xhr = event.originalEvent.data.xhr
-      process_xhr(xhr)
+    process_fetch = (response) =>
+      events = response.headers.get @header_key
+      @from_json decodeURIComponent(events) if events?
+
+    # jQuery $.ajax
+    if window.jQuery && jQuery.ajax
+      # This event can only be caught on the jQuery event bus.
+      jQuery(document).on("ajaxComplete",  (_, xhr) -> process_xhr(xhr))
+
+
+    # classic Turbolinks
+    addEventListener("turbolinks:request-end", (event) ->
+      process_xhr(event.originalEvent.data.xhr)
+    )
+
+    # Hotwire/Turbo
+    addEventListener("turbo:before-fetch-response", (event) ->
+      process_fetch(event.detail.fetchResponse.response)
+    )
 
     @from_dom()
 
+  if document.readyState == "loading"
+    addEventListener("DOMContentLoaded", start.bind(@), once: true)
+  else
+    start.call(@)
+
 
 class GaEvents.GTagAdapter
   constructor: (options) ->

data/lib/ga_events/middleware.rb

@@ -9,6 +9,7 @@ require 'rubygems'
 module GaEvents
   class Middleware
     SESSION_GA_EVENTS_KEY = 'ga_events.events'
+    RESPONSE_HEADER = 'x-ga-events'
 
     HEADERS_KLASS = if Gem::Version.new(Rack.release) < Gem::Version.new('3.0')
                       Rack::Utils::HeaderHash
@@ -31,9 +32,9 @@ module GaEvents
 
         # Can outgrow, headers might get too big
         serialized_events = GaEvents::List.to_s
-        if xhr_or_turbolinks?(request)
+        if xhr_or_turbo?(request)
           # AJAX request
-          headers['x-ga-events'] = CGI.escapeURIComponent(serialized_events)
+          headers[RESPONSE_HEADER] = CGI.escapeURIComponent(serialized_events)
         elsif redirect?(status)
           # 30x/redirect? Then add event list to rack session to survive the
           # redirect.
@@ -76,18 +77,20 @@ module GaEvents
 
     # Taken from:
     # https://github.com/rack/rack-contrib/blob/master/lib/rack/contrib/jsonp.rb
-    def html?(status, headers)
+    def html?(status, response_headers)
       !Rack::Utils::STATUS_WITH_NO_ENTITY_BODY.include?(status.to_i) &&
-        headers.key?('content-type') &&
-        headers['content-type'].start_with?('text/html')
+        response_headers.key?('content-type') &&
+        response_headers['content-type'].start_with?('text/html')
     end
 
     def redirect?(status)
       (300..399).cover?(status)
     end
 
-    def xhr_or_turbolinks?(request)
-      request.xhr? || request.env['HTTP_TURBOLINKS_REFERRER']
+    def xhr_or_turbo?(request)
+      request.xhr? ||
+        request.env['HTTP_TURBOLINKS_REFERRER'] ||
+        request.env['HTTP_X_TURBO_REQUEST_ID']
     end
   end
 end

data/lib/ga_events/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GaEvents
-  VERSION = '4.1.0'
+  VERSION = '4.2.0'
 end

data/spec/middlware_event_placement_spec.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe GaEvents::Middleware do
+  let(:app) do
+    lambda do |env|
+      status_code = env.delete('app_status_code').to_i
+
+      GaEvents::Event.new('test', 'event' => 'stuff')
+      [status_code, { 'content-type' => 'text/html' }, [<<~HTML]]
+        <!doctype html>
+        <html lang=en>
+          <head>
+            <meta charset=utf-8>
+            <title>ABC</title>
+          </head>
+          <body>
+            <p>I'm the content</p>
+          </body>
+        </html>
+      HTML
+    end
+  end
+
+  describe 'html requests' do
+    it 'adds events in an injected div' do
+      response = make_request
+      expect(response.body).to include('<div data-ga-events="[{')
+    end
+
+    it 'does no write to rack ression or response headers' do
+      session = {}
+      response = make_request('rack.session' => session)
+      expect(session[GaEvents::Middleware::SESSION_GA_EVENTS_KEY]).to be_nil
+      expect(response.headers).not_to have_key(
+        GaEvents::Middleware::RESPONSE_HEADER
+      )
+    end
+  end
+
+  describe 'non xhr/fetch redirects' do
+    it 'writes to session' do
+      session = {}
+      make_request('app_status_code' => '302', 'rack.session' => session)
+      expect(session[GaEvents::Middleware::SESSION_GA_EVENTS_KEY]).to be_present
+    end
+
+    it 'does not inject html or add response headers' do
+      response = make_request('app_status_code' => '302', 'rack.session' => {})
+      expect(response.body).not_to include('<div data-ga-events="[{')
+      expect(response.headers).not_to have_key(
+        GaEvents::Middleware::RESPONSE_HEADER
+      )
+    end
+  end
+
+  describe 'xhr requests' do
+    it 'adds events as response header' do
+      response = make_request('HTTP_X_REQUESTED_WITH' => 'XMLHttpRequest')
+      expect(
+        response.headers[GaEvents::Middleware::RESPONSE_HEADER]
+      ).to include('__event__')
+    end
+
+    it 'does not inject a div or writes to session' do
+      session = {}
+      response =
+        make_request(
+          'HTTP_X_REQUESTED_WITH' => 'XMLHttpRequest',
+          'rack.session' => session
+        )
+      expect(response.body).not_to include('<div data-ga-events')
+      expect(session[GaEvents::Middleware::SESSION_GA_EVENTS_KEY]).to be_nil
+    end
+  end
+
+  describe 'turbolink requests' do
+    it 'adds events as response header' do
+      response = make_request('HTTP_TURBOLINKS_REFERRER' => '...')
+      expect(
+        response.headers[GaEvents::Middleware::RESPONSE_HEADER]
+      ).to include('__event__')
+    end
+
+    it 'does not inject a div with events' do
+      response = make_request('HTTP_TURBOLINKS_REFERRER' => '...')
+      expect(response.body).not_to include('<div data-ga-events')
+    end
+  end
+
+  describe 'turbo requests' do
+    it 'adds events as response header' do
+      response = make_request('HTTP_X_TURBO_REQUEST_ID' => '...')
+      expect(
+        response.headers[GaEvents::Middleware::RESPONSE_HEADER]
+      ).to include('__event__')
+    end
+
+    it 'does not inject a div with events' do
+      response = make_request('HTTP_X_TURBO_REQUEST_ID' => '...')
+      expect(response.body).not_to include('<div data-ga-events')
+    end
+  end
+
+  private
+
+  def make_request(options = nil)
+    middleware = described_class.new(app)
+    options = {
+      'app_status_code' => '200',
+      :lint => true,
+      :fatal => true,
+      **options
+    }
+    r = Rack::MockRequest.new(middleware)
+    r.get('/', options)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ga_events
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.2.0
 platform: ruby
 authors:
 - Nix-wie-weg Team
@@ -49,6 +49,7 @@ files:
 - spec/event_spec.rb
 - spec/list_spec.rb
 - spec/middleware_spec.rb
+- spec/middlware_event_placement_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/Nix-wie-weg/ga_events
 licenses: