qa_server 5.2.1 → 5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2981264303c79aed94820ba9955f0e61b005afbc
-  data.tar.gz: 1e506e5f45848be21886d73116fdd4bb48e90d69
+  metadata.gz: c2905e19c557faccf19c7dd83f587f06ceacb2c2
+  data.tar.gz: db5ce48e087afee79569c080898a612f814f5250
 SHA512:
-  metadata.gz: 49baea993d35cfdc84ca8af81c2e577a0d908ff13b77c53ad1e6cbc28b9c291ee9603339c97d64efa7fbfef27ab693b2442237c44baad24c2cc9c55b09db043d
-  data.tar.gz: 85d53d7ccae9be71244f42b0d24f9f1e454d1b8f462c9329e5e3519d85be7034cc8ac59e2965f628773b35a17656ccb5da4c6f7d46d88344678d7127cb299e37
+  metadata.gz: ac00bc271dd281d3d7e42c5b926cc292210ed200566c9083fab772fbd1e2fd96f0c76f12d9b27536e91c0474d62cdceeca5df0f11ec893776bb7ac86c18482e9
+  data.tar.gz: c56721d0a15ddc0d683d9b758a621ae4ae9f26a1b1685d97d22d468332caa9370bb6db77376415abcf1dfea53a1437f18bfd6832bc40da3c6c5226fcba628b49

data/.travis.yml

@@ -8,7 +8,7 @@ cache:
   bundler: true
 
 before_install:
-  - gem update --system
+  - gem update bundler
   - gem install bundler
   - google-chrome-stable --headless --disable-gpu --no-sandbox --remote-debugging-port=9222 http://localhost &
 

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+### 5.3.0 (2019-12-19)
+
+* optionally log browser and platform user agent info
+* update to qa 5.3
+  * add a request id to the search and find request headers
+  * log exception for graph load failures
+  * optionally include IP info at start of search/find linked data requests
+
 ### 5.2.1 (2019-12-13)
 
 * fix - add defaults to the initializer generator template for new configs

data/app/models/qa_server/performance_cache.rb

@@ -41,8 +41,8 @@ module QaServer
     end
 
     def log(id:)
-      Rails.logger.info("*** performance data for id: #{id} ***")
-      Rails.logger.info(@cache[id].to_yaml)
+      Rails.logger.debug("*** performance data for id: #{id} ***")
+      Rails.logger.debug(@cache[id].to_yaml)
     end
 
     private

data/app/prepends/prepended_linked_data/find_term.rb

@@ -2,30 +2,35 @@
 module PrependedLinkedData::FindTerm
   # Override Qa::Authorities::LinkedData::FindTerm#find method
   # @return [Hash] single term results in requested format
-  def find(id, request_header: {}, language: nil, replacements: {}, subauth: nil, format: nil, performance_data: false) # rubocop:disable Metrics/ParameterLists, Metrics/CyclomaticComplexity
+  def find(id, request_header: {}, language: nil, replacements: {}, subauth: nil, format: nil, performance_data: false) # rubocop:disable Metrics/ParameterLists
     return super if QaServer.config.suppress_performance_gathering
-
-    start_time_s = QaServer.current_time_s
-    request_header = build_request_header(language: language, replacements: replacements, subauth: subauth, format: format, performance_data: performance_data) if request_header.empty?
-    saved_performance_data = performance_data || request_header[:performance_data]
-    request_header[:performance_data] = true
-
+    request_header = setup_find(request_header: request_header, language: language, replacements: replacements, subauth: subauth,
+                                format: format, performance_data: performance_data)
     @phid = QaServer.config.performance_cache.new_entry(authority: authority_name, action: 'fetch')
     begin
       full_results = super
-      update_performance_history_record(full_results, start_time_s)
+      update_performance_history_record(full_results)
     rescue Exception => e # rubocop:disable Lint/RescueException
       QaServer.config.performance_cache.destroy(@phid)
       raise e
     end
-    saved_performance_data || !full_results.is_a?(Hash) ? full_results : full_results[:results]
+    requested_results(full_results)
   end
 
   private
 
-    def update_performance_history_record(full_results, start_time_s)
+    def setup_find(request_header: {}, language: nil, replacements: {}, subauth: nil, format: nil, performance_data: false) # rubocop:disable Metrics/ParameterLists
+      QaServer.log_agent_info(request_header[:request])
+      @start_time_s = QaServer.current_time_s
+      request_header = build_request_header(language: language, replacements: replacements, subauth: subauth, format: format, performance_data: performance_data) if request_header.empty?
+      @saved_performance_data = performance_data || request_header[:performance_data]
+      request_header[:performance_data] = true
+      request_header
+    end
+
+    def update_performance_history_record(full_results)
       return QaServer.config.performance_cache.destroy(@phid) unless full_results.is_a?(Hash) && full_results.key?(:performance)
-      updates = { action_time_ms: (QaServer.current_time_s - start_time_s) * 1000,
+      updates = { action_time_ms: (QaServer.current_time_s - @start_time_s) * 1000,
                   size_bytes: full_results[:performance][:fetched_bytes],
                   retrieve_plus_graph_load_time_ms: full_results[:performance][:fetch_time_s] * 1000,
                   normalization_time_ms: full_results[:performance][:normalization_time_s] * 1000 }
@@ -51,7 +56,13 @@ module PrependedLinkedData::FindTerm
     # Temporary override to fix bug.  Remove when QA Issue #271 is fixed and a new release is cut
     def performance_data?
       return super if QaServer.config.suppress_performance_gathering
-
       @performance_data == true
     end
+
+    def requested_results(full_results)
+      return full_results if @saved_performance_data || !full_results.is_a?(Hash)
+      return full_results[:results] unless full_results.key? :response_header
+      full_results.delete(:performance)
+      full_results
+    end
 end

data/app/prepends/prepended_linked_data/search_query.rb

@@ -4,28 +4,33 @@ module PrependedLinkedData::SearchQuery
   # @return [String] json results for search query
   def search(query, request_header: {}, language: nil, replacements: {}, subauth: nil, context: false, performance_data: false) # rubocop:disable Metrics/ParameterLists
     return super if QaServer.config.suppress_performance_gathering
-
-    start_time_s = QaServer.current_time_s
-    request_header = build_request_header(language: language, replacements: replacements, subauth: subauth, context: context, performance_data: performance_data) if request_header.empty?
-    saved_performance_data = performance_data || request_header[:performance_data]
-    request_header[:performance_data] = true
-
+    request_header = setup_search(request_header: request_header, language: language, replacements: replacements, subauth: subauth,
+                                  context: context, performance_data: performance_data)
     @phid = QaServer.config.performance_cache.new_entry(authority: authority_name, action: 'search')
     begin
       full_results = super
-      update_performance_history_record(full_results, start_time_s)
+      update_performance_history_record(full_results)
     rescue Exception => e # rubocop:disable Lint/RescueException
       QaServer.config.performance_cache.destroy(@phid)
       raise e
     end
-    requested_results(full_results, saved_performance_data)
+    requested_results(full_results)
   end
 
   private
 
-    def update_performance_history_record(full_results, start_time_s)
+    def setup_search(request_header: {}, language: nil, replacements: {}, subauth: nil, context: false, performance_data: false) # rubocop:disable Metrics/ParameterLists
+      QaServer.log_agent_info(request_header[:request])
+      @start_time_s = QaServer.current_time_s
+      request_header = build_request_header(language: language, replacements: replacements, subauth: subauth, context: context, performance_data: performance_data) if request_header.empty?
+      @saved_performance_data = performance_data || request_header[:performance_data]
+      request_header[:performance_data] = true
+      request_header
+    end
+
+    def update_performance_history_record(full_results)
       return QaServer.config.performance_cache.destroy(@phid) unless full_results.is_a?(Hash) && full_results.key?(:performance)
-      updates = { action_time_ms: (QaServer.current_time_s - start_time_s) * 1000,
+      updates = { action_time_ms: (QaServer.current_time_s - @start_time_s) * 1000,
                   size_bytes: full_results[:performance][:fetched_bytes],
                   retrieve_plus_graph_load_time_ms: full_results[:performance][:fetch_time_s] * 1000,
                   normalization_time_ms: full_results[:performance][:normalization_time_s] * 1000 }
@@ -48,8 +53,8 @@ module PrependedLinkedData::SearchQuery
       Rails.logger.info("Time to receive data from authority: #{access_time_s}s")
     end
 
-    def requested_results(full_results, saved_performance_data)
-      return full_results if saved_performance_data
+    def requested_results(full_results)
+      return full_results if @saved_performance_data
       return full_results[:results] unless full_results.key? :response_header
       full_results.delete(:performance)
       full_results

data/lib/qa_server.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 require 'qa_server/engine'
 require 'qa_server/version'
+require 'user_agent'
 
 module QaServer
   extend ActiveSupport::Autoload
@@ -34,4 +35,15 @@ module QaServer
     offset = QaServer.config.hour_offset_to_run_monitoring_tests
     (current_time - offset.hours).beginning_of_day + offset.hours
   end
+
+  def self.log_agent_info(request)
+    return if !Qa.config.respond_to?(:suppress_ip_data_from_log) || Qa.config.suppress_ip_data_from_log
+    user_agent = request.respond_to?(:user_agent) && !request.user_agent.nil? ? ::UserAgent.parse(request.user_agent) : nil
+    return Rails.logger.info("{browser: UNKNOWN, browser_version: UNKNOWN, platform: UNKNOWN, os: UNKNOWN}") if user_agent.nil?
+    browser = user_agent.browser
+    browser_version = user_agent.version
+    platform = user_agent.platform
+    os = user_agent.os
+    Rails.logger.info("{browser: #{browser}, browser_version: #{browser_version}, platform: #{platform}, os: #{os}}")
+  end
 end

data/lib/qa_server/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module QaServer
-  VERSION = '5.2.1'
+  VERSION = '5.3.0'
 end

data/qa_server.gemspec

@@ -23,9 +23,10 @@ Gem::Specification.new do |spec|
   # minor version releases can include breaking changes; see
   # http://guides.rubyonrails.org/maintenance_policy.html
   spec.add_dependency 'rails', '~> 5.0' # Keep in sync with version supported by Hyrax
+  spec.add_dependency 'useragent'
 
   # Required gems for QA and linked data access
-  spec.add_development_dependency 'qa', '~> 5.1' # required for response_header
+  spec.add_development_dependency 'qa', '~> 5.3'
   spec.add_development_dependency 'linkeddata'
 
   # Produces dashboard charts on monitor status page

data/spec/lib/qa_server_spec.rb

@@ -43,5 +43,49 @@ RSpec.describe QaServer do
       end
     end
   end
+
+  # rubocop:disable RSpec/MessageSpies
+  describe '.log_agent_info' do
+    let(:request) { double }
+
+    context 'when ip logging is suppressed' do
+      before { allow(Qa).to receive_message_chain(:config, :suppress_ip_data_from_log).and_return(true) }
+
+      it 'suppresses agent logging' do
+        expect(Rails.logger).not_to receive(:info).with(/^\{browser: /)
+        described_class.log_agent_info(request)
+      end
+    end
+
+    context 'when ip logging is not suppressed' do
+      before { allow(Qa).to receive_message_chain(:config, :suppress_ip_data_from_log).and_return(false) }
+
+      context 'and user_agent is nil' do
+        before { allow(request).to receive(:user_agent).and_return(nil) }
+        it 'logs agent info as UNKNOWN' do
+          expect(Rails.logger).to receive(:info).with("{browser: UNKNOWN, browser_version: UNKNOWN, platform: UNKNOWN, os: UNKNOWN}")
+          described_class.log_agent_info(request)
+        end
+      end
+
+      context 'and user_agent has data' do
+        # rubocop:disable RSpec/AnyInstance
+        before do
+          allow(request).to receive(:user_agent).and_return("Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/79.0.3945.79 Safari/537.36")
+          allow_any_instance_of(UserAgent::Browsers::Chrome).to receive(:browser).and_return("Chrome")
+          allow_any_instance_of(UserAgent::Browsers::Chrome).to receive(:version).and_return("v1.1")
+          allow_any_instance_of(UserAgent::Browsers::Chrome).to receive(:platform).and_return("Mac")
+          allow_any_instance_of(UserAgent::Browsers::Chrome).to receive(:os).and_return("10.14")
+        end
+        # rubocop:enable RSpec/AnyInstance
+
+        it 'logs agent info as UNKNOWN' do
+          expect(Rails.logger).to receive(:info).with("{browser: Chrome, browser_version: v1.1, platform: Mac, os: 10.14}")
+          described_class.log_agent_info(request)
+        end
+      end
+    end
+  end
+  # rubocop:enable RSpec/MessageSpies
   # rubocop:enable RSpec/MessageChain
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qa_server
 version: !ruby/object:Gem::Version
-  version: 5.2.1
+  version: 5.3.0
 platform: ruby
 authors:
 - E. Lynette Rayle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-14 00:00:00.000000000 Z
+date: 2019-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,20 +24,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: useragent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: qa
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '5.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '5.3'
 - !ruby/object:Gem::Dependency
   name: linkeddata
   requirement: !ruby/object:Gem::Requirement