rack-tracker 1.12.0 → 1.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96cc84b108179e10df6c41c10fb536597f8ba93ac7106d38bbfe9b8d36e6da6e
-  data.tar.gz: dccdd57d1f3c8985ef500c45a6441b0821e7a1dc33dd232503bd1ca73d5ed1ef
+  metadata.gz: 0ba26127c80f03ca9e62148bcc7bed290e716f268ee5b0db44ab0e8f0bfda6b7
+  data.tar.gz: 53c75c93dc91a11a0d55e2b415ce3f4a4045ea5c36e0bf3f606f7b2174c0ec02
 SHA512:
-  metadata.gz: 78b014112e736701afb694c07384cd368a37054c8d734a8b38d9bb9224a33d0b857e8596e486a9e06d8c0038a54e9917835e7e2ba64efc96ecb5f06a21bc7b30
-  data.tar.gz: 9d81d707139e7393409c15a2e1f9fe7289394988bf1804613550bab4a114d3c393e175c512062bca1b3816b97ad3aa4c913614fd51a27cbc736a57bd8517aa96
+  metadata.gz: a50ac45ea4aed6309bdf29b910b2d86ef25a1b1543c1d322ee51932711cc929e9ce5acd068f2785ed9dbb124ac991cb238741f3d06c6c189075b684e11b30734
+  data.tar.gz: 36a514edc61a4d2b1357ac347610749fba442cf7f16da4457b20749ae3545327d7ea793e75d127ad84def56b00165ccbb4cbf79fa5e2982f1636b677926e47f2

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 1.12.1
+
+* [ENHANCEMENT] Use local variables to prevent instance state #151 (thx @bumi)
+* [ENHANCEMENT] Make middleware thread safe #150 (thx @kspe)
+
 # 1.12.0
 
 * [ENHANCEMENT] Add support for Heap #147 (thx @mohanzhang)

data/lib/rack/tracker.rb

@@ -38,10 +38,14 @@ module Rack
     end
 
     def call(env)
-      @status, @headers, @body = @app.call(env)
-      return [@status, @headers, @body] unless html?
-      response = Rack::Response.new([], @status, @headers)
+      dup._call(env)
+    end
+
+    def _call(env)
+      status, headers, body = @app.call(env)
+      return [status, headers, body] unless headers['Content-Type'] =~ /html/
 
+      response = Rack::Response.new([], status, headers)
       env[EVENT_TRACKING_KEY] ||= {}
 
       if session = env["rack.session"]
@@ -52,16 +56,14 @@ module Rack
         session[EVENT_TRACKING_KEY] = env[EVENT_TRACKING_KEY]
       end
 
-      @body.each { |fragment| response.write inject(env, fragment) }
-      @body.close if @body.respond_to?(:close)
+      body.each { |fragment| response.write inject(env, fragment) }
+      body.close if body.respond_to?(:close)
 
       response.finish
     end
 
     private
 
-    def html?; @headers['Content-Type'] =~ /html/; end
-
     def inject(env, response)
       duplicated_response = response.dup
       @handlers.each(env) do |handler|

data/lib/rack/tracker/google_analytics/template/google_analytics.erb

@@ -8,37 +8,37 @@
 
     ga('create', '<%= tracker %>', <%= tracker_options.to_json %>);
   }
-<% if options[:enhanced_link_attribution] %>
-  ga('require', 'linkid', 'linkid.js');
-<% end %>
-<% if options[:advertising] %>
-  ga('require', 'displayfeatures');
-<% end %>
-<% if options[:enhanced_ecommerce] %>
-  ga('require', 'ec');
-<% end %>
-<% if options[:ecommerce] %>
-  ga('require', 'ecommerce', 'ecommerce.js');
-<% end %>
-<% if options[:optimize] %>
-  ga('require', '<%= options[:optimize] %>');
-<% end %>
-<% if options[:anonymize_ip] %>
-  ga('set', 'anonymizeIp', true);
-<% end %>
-<% if options[:adjusted_bounce_rate_timeouts] %>
-  <% options[:adjusted_bounce_rate_timeouts].each do |timeout| %>
-      setTimeout(function() { ga('send', 'event', '<%= "#{timeout.to_s}_seconds" %>', 'read'); },<%= timeout*1000 %>);
+  <% if options[:enhanced_link_attribution] %>
+    ga('require', 'linkid', 'linkid.js');
+  <% end %>
+  <% if options[:advertising] %>
+    ga('require', 'displayfeatures');
+  <% end %>
+  <% if options[:enhanced_ecommerce] %>
+    ga('require', 'ec');
+  <% end %>
+  <% if options[:ecommerce] %>
+    ga('require', 'ecommerce', 'ecommerce.js');
+  <% end %>
+  <% if options[:optimize] %>
+    ga('require', '<%= options[:optimize] %>');
+  <% end %>
+  <% if options[:anonymize_ip] %>
+    ga('set', 'anonymizeIp', true);
+  <% end %>
+  <% if options[:adjusted_bounce_rate_timeouts] %>
+    <% options[:adjusted_bounce_rate_timeouts].each do |timeout| %>
+        setTimeout(function() { ga('send', 'event', '<%= "#{timeout.to_s}_seconds" %>', 'read'); },<%= timeout*1000 %>);
+    <% end %>
+  <% end %>
+  <% events.each do |var| %>
+    ga(<%= var.write() %>);
+  <% end %>
+  <% if options[:ecommerce] && ecommerce_events.any? %>
+    ga('ecommerce:send');
+  <% end %>
+  <% if tracker && options[:explicit_pageview] %>
+    ga('send', 'pageview', <%= pageview_url_script %>);
   <% end %>
-<% end %>
-<% end %>
-<% events.each do |var| %>
-  ga(<%= var.write() %>);
-<% end %>
-<% if options[:ecommerce] && ecommerce_events.any? %>
-  ga('ecommerce:send');
-<% end %>
-<% if tracker && options[:explicit_pageview] %>
-  ga('send', 'pageview', <%= pageview_url_script %>);
 </script>
 <% end %>

data/lib/rack/tracker/google_global/google_global.rb

@@ -35,9 +35,7 @@ class Rack::Tracker::GoogleGlobal < Rack::Tracker::Handler
   end
 
   def trackers
-    options[:trackers].map { |tracker|
-      tracker[:id].respond_to?(:call) ? tracker.merge(id: tracker[:id].call(env)) : tracker
-    }.reject { |tracker| tracker[:id].nil? }
+    @_trackers ||= build_trackers
   end
 
   def set_options
@@ -46,6 +44,31 @@ class Rack::Tracker::GoogleGlobal < Rack::Tracker::Handler
 
   private
 
+  def build_trackers
+    options[:trackers].map(&method(:call_tracker)).reject(&method(:invalid_tracker?))
+  end
+
+  def call_tracker(tracker)
+    if tracker[:id].respond_to?(:call)
+      tracker.merge(id: tracker[:id].call(env))
+    else
+      tracker
+    end
+  end
+
+  def invalid_tracker?(tracker)
+    if tracker[:id].to_s.strip == ''
+      $stdout.puts <<~WARN
+      WARNING: One of the trackers specified for Rack::Tracker handler 'google_global' is empty.
+               Trackers: #{options[:trackers]}
+      WARN
+
+      true
+    else
+      false
+    end
+  end
+
   def build_set_options
     value = options[:set]
     value.respond_to?(:call) ? value.call(env) : value

data/lib/rack/tracker/google_global/template/google_global.erb

@@ -1,4 +1,4 @@
-<% if trackers %>
+<% if trackers.any? %>
 <script async src='https://www.googletagmanager.com/gtag/js?id=<%= trackers[0][:id] %>'></script>
 <script>
   window.dataLayer = window.dataLayer || [];

data/lib/rack/tracker/version.rb

@@ -1,5 +1,5 @@
 module Rack
   class Tracker
-    VERSION = '1.12.0'
+    VERSION = '1.12.1'
   end
 end

data/spec/integration/google_global_integration_spec.rb

@@ -3,28 +3,39 @@ require 'support/capybara_app_helper'
 RSpec.describe "Google Global Integration Integration" do
   before do
     setup_app(action: :google_global) do |tracker|
-      tracker.handler :google_global, trackers: [{ id: 'U-XXX-Y' }]
+      tracker.handler :google_global, tracker_options
     end
     visit '/'
   end
 
-  subject { page }
+  let(:tracker_options) { { trackers: [{ id: 'U-XXX-Y' }] } }
 
   it "embeds the script tag with tracking event from the controller action" do
     expect(page.find("head")).to have_content('U-XXX-Y')
   end
 
   describe 'adjust tracker position via options' do
-    before do
-      setup_app(action: :google_global) do |tracker|
-        tracker.handler :google_global, trackers: [{ id: 'U-XXX-Y' }], position: :body
-      end
-      visit '/'
-    end
+    let(:tracker_options) { { trackers: [{ id: 'U-XXX-Y' }], position: :body } }
 
     it "will be placed in the specified tag" do
      expect(page.find("head")).to_not have_content('U-XXX-Y')
      expect(page.find("body")).to have_content('U-XXX-Y')
     end
   end
+
+  describe "handles empty tracker id" do
+    let(:tracker_options) { { trackers: [{ id: nil }, { id: "" }, { id: "  " }] } }
+
+    it "does not inject scripts" do
+      expect(page.find("head")).to_not have_content("<script async src='https://www.googletagmanager.com/gtag/js?id=")
+    end
+  end
+
+  describe "callable tracker id" do
+    let(:tracker_options) { { trackers: [{ id: proc { "U-XXX-Y" } }] } }
+
+    it "is injected into head with id from proc" do
+      expect(page.find("head")).to have_content('U-XXX-Y')
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-tracker
 version: !ruby/object:Gem::Version
-  version: 1.12.0
+  version: 1.12.1
 platform: ruby
 authors:
 - Lars Brillert
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-14 00:00:00.000000000 Z
+date: 2020-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack