Merge pull request #1101 from travis-ci/ha-meters-update

Tweak User-Agent meters

Author: BanzaiMan

lib/travis/api/app/middleware/user_agent_tracker.rb

@@ -11,15 +11,33 @@ class UserAgentTracker < Middleware
         "Opera", "Mozilla"
       ]
 
+      PATHS_IGNORED = [
+        '/uptime'
+      ]
+
+      attr_reader :metrik_prefix
+
+      before do
+        @metrik_prefix = if version = request.env['HTTP_TRAVIS_API_VERSION'].to_s.match(/^\d+(\.\d+)*/)
+          "api.v#{version}"
+        else
+          "api.v2"
+        end
+      end
+
       before(agent: /^$/) do
-        ::Metriks.meter("api.v2.user_agent.missing").mark
+        return if PATHS_IGNORED.include?(request.path)
+        ::Metriks.meter("#{metrik_prefix}.user_agent.missing").mark
         halt(400, "error" => "missing User-Agent header") if Travis::Features.feature_active?(:require_user_agent)
       end
 
       before(agent: /^.+$/) do
+        return if PATHS_IGNORED.include?(request.path)
         agent = UserAgent.parse(request.user_agent)
         case agent.browser
-        when *WEB_BROWSERS                   then mark_browser
+        when *WEB_BROWSERS
+          # if X-User-Agent header is set, honor that instead
+          mark :browser, UserAgent.parse(env['HTTP_X_USER_AGENT'] || request.user_agent).browser
         when "curl", "Wget"                  then mark(:console, agent.browser)
         when "travis-api-wrapper"            then mark(:script, :node_js, agent.browser)
         when "TravisPy"                      then mark(:script, :python,  agent.browser)
@@ -30,12 +48,6 @@ class UserAgentTracker < Middleware
         end
       end
 
-      def mark_browser
-        # allows a JavaScript Client to set X-User-Agent, for instance to "travis-web" in travis-web
-        x_agent = UserAgent.parse(env['HTTP_X_USER_AGENT'] || 'unknown').browser
-        mark(:browser, x_agent)
-      end
-
       def mark_travis(agent)
         command = agent.application.comment.detect { |c| c.start_with? "command " } if agent.application.comment
 
@@ -54,7 +66,7 @@ def mark_unknown
       end
 
       def mark(*keys)
-        key = "api.v2.user_agent." << keys.map { |k| k.to_s.downcase.gsub(/[^a-z0-9\-\.]+/, '_') }.join('.')
+        key = "#{metrik_prefix}.user_agent." << keys.map { |k| k.to_s.downcase.gsub(/[^a-z0-9\-\.]+/, '_') }.join('.')
         ::Metriks.meter(key).mark
       end
     end

spec/unit/middleware/user_agent_tracker_spec.rb

@@ -3,16 +3,17 @@
     mock_app do
       use Travis::Api::App::Middleware::UserAgentTracker
       get('/') { 'ok' }
+      get('/uptime') { 'OK' }
     end
   end
 
   def expect_meter(name)
     allow(Metriks).to receive(:meter).with(name).and_return(double("meter", mark: nil))
   end
 
-  def get(env = {})
+  def get(env = {}, path = '/')
     env['HTTP_USER_AGENT'] ||= agent if agent
-    super('/', {}, env)
+    super(path, {}, env)
   end
 
   context 'missing User-Agent' do
@@ -27,13 +28,18 @@ def get(env = {})
       allow(Travis::Features).to receive(:feature_active?).with(:require_user_agent).and_return(true)
       expect(get.status).to eq(400)
     end
+
+    specify do
+      expect(Metriks).to_not receive(:meter)
+      get({}, '/uptime')
+    end
   end
 
   context 'web browser' do
     let(:agent) { "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/39.0.2171.36 Safari/537.36" }
 
     specify 'without X-User-Agent' do
-      expect_meter("api.v2.user_agent.browser.unknown")
+      expect_meter("api.v2.user_agent.browser.chrome")
       get
     end
 
@@ -89,6 +95,18 @@ def get(env = {})
       expect_meter("api.v2.user_agent.script.ruby.travis.version.1.6.8")
       get
     end
+
+    context 'Travis-API-Version header' do
+      specify "with Travis-API-Version: 3" do
+        expect_meter("api.v3.user_agent.script.ruby.travis.version.1.6.8")
+        get('HTTP_TRAVIS_API_VERSION' => '3')
+      end
+
+      specify "with Travis-API-Version: 1.7f" do
+        expect_meter("api.v1.7.user_agent.script.ruby.travis.version.1.6.8")
+        get('HTTP_TRAVIS_API_VERSION' => '1.7')
+      end
+    end
   end
 
   context 'Travis CLI' do
@@ -99,4 +117,12 @@ def get(env = {})
       get
     end
   end
+
+  context 'get /uptime' do
+    let(:agent) { 'Travis/1.6.8 (Mac OS X 10.9.2 like Darwin; Ruby 2.1.1p42; RubyGems 2.0.14) Faraday/0.8.9 Typhoeus/0.6.7' }
+    specify do
+      expect(Metriks).to_not receive(:meter)
+      get({}, '/uptime')
+    end
+  end
 end