qa_server 5.3.0 → 5.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c2905e19c557faccf19c7dd83f587f06ceacb2c2
-  data.tar.gz: db5ce48e087afee79569c080898a612f814f5250
+  metadata.gz: ab89fc6147c1cf32de828a8b2cecaab3ca66b296
+  data.tar.gz: 027160d4a1e0f0090a1c6d81cfdcd74fba5d1423
 SHA512:
-  metadata.gz: ac00bc271dd281d3d7e42c5b926cc292210ed200566c9083fab772fbd1e2fd96f0c76f12d9b27536e91c0474d62cdceeca5df0f11ec893776bb7ac86c18482e9
-  data.tar.gz: c56721d0a15ddc0d683d9b758a621ae4ae9f26a1b1685d97d22d468332caa9370bb6db77376415abcf1dfea53a1437f18bfd6832bc40da3c6c5226fcba628b49
+  metadata.gz: aa48a9de27b5b612d590981dfbb9f4316f496a6ecee810bc25735f7ffd1d5fc73c4a6e9f63af65aaeb767a35d983a9c3680ab1cd27b5558ef7b4c11958d73efe
+  data.tar.gz: 12c86bbeb3d41de071788f93fdfd3ef632a1300c77182a114124a5fd5895ac733e0c4f76b72e973a3cd7b5a691224b2fb7be21b2651e04a0a935ad283ca8a973

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+### 5.4.0 (2020-01-07)
+
+* adds config hour_offset_to_expire_cache
+* deprecates config hour_offset_to_run_monitoring_tests (replaced by hour_offset_to_expire_cache)
+* updates QaServer.monitoring_expires_at to use the new hour_offset_to_expire_cache config
+* adds QaServer.cache_expiry that can be used for expiring all cached data
+* add tests and exceptions for configs
+
 ### 5.3.0 (2019-12-19)
 
 * optionally log browser and platform user agent info

data/lib/generators/qa_server/templates/config/initializers/qa_server.rb

@@ -5,12 +5,12 @@ QaServer.config do |config|
   # @see https://api.rubyonrails.org/classes/ActiveSupport/TimeZone.html for possible values of TimeZone names
   # config.preferred_time_zone_name = 'Eastern Time (US & Canada)'
 
-  # Preferred hour to run monitoring tests
+  # Preferred hour to expire caches related to slow running calculations (e.g. monitoring tests, performance data)
   # @param [Integer] count of hours from midnight (0-23 with 0=midnight)
   # @example
   #   For preferred_time_zone_name of 'Eastern Time (US & Canada)', use 3 for slow down at midnight PT/3am ET
   #   For preferred_time_zone_name of 'Pacific Time (US & Canada)', use 0 for slow down at midnight PT/3am ET
-  # config.hour_offset_to_run_monitoring_tests = 3
+  # config.hour_offset_to_expire_cache = 3
 
   # Displays a graph of historical test data when true
   # @param [Boolean] display history graph when true

data/lib/qa_server.rb

@@ -2,9 +2,13 @@
 require 'qa_server/engine'
 require 'qa_server/version'
 require 'user_agent'
+require 'deprecation'
 
 module QaServer
   extend ActiveSupport::Autoload
+  extend Deprecation
+
+  self.deprecation_horizon = 'LD4P/QaServer v6.0.0'
 
   autoload :Configuration
 
@@ -23,17 +27,27 @@ module QaServer
     @config
   end
 
+  # @return [ActiveSupport::TimeWithZone] current DateTime in the configured preferred_time_zone_name
   def self.current_time
     Time.now.in_time_zone(QaServer.config.preferred_time_zone_name)
   end
 
+  # @return [Float] current DateTime in seconds
   def self.current_time_s
     current_time.to_f
   end
 
+  # @return [ActiveSupport::TimeWithZone] DateTime at which cache should expire
   def self.monitoring_expires_at
-    offset = QaServer.config.hour_offset_to_run_monitoring_tests
-    (current_time - offset.hours).beginning_of_day + offset.hours
+    offset = QaServer.config.hour_offset_to_expire_cache
+    offset_time = current_time
+    offset_time = offset_time.tomorrow unless (offset_time + 5.minutes).hour < offset
+    offset_time.beginning_of_day + offset.hours - 5.minutes
+  end
+
+  # @return [Float] number of seconds until cache should expire
+  def self.cache_expiry
+    monitoring_expires_at - current_time
   end
 
   def self.log_agent_info(request)

data/lib/qa_server/configuration.rb

@@ -9,16 +9,40 @@ module QaServer
       @preferred_time_zone_name ||= 'Eastern Time (US & Canada)'
     end
 
-    # Preferred hour to run monitoring tests
+    # Set preferred hour to expire caches related to slow running calculations (e.g. monitoring tests, performance data)
+    # @param [Integer] count of hours after midnight (0-23 with 0=midnight)
+    # @raise [ArgumentError] if offset is not between 0 and 23
+    # @example
+    #   For preferred_time_zone_name of 'Eastern Time (US & Canada)', use 3 for slow down at midnight PT/3am ET
+    #   For preferred_time_zone_name of 'Pacific Time (US & Canada)', use 0 for slow down at midnight PT/3am ET
+    def hour_offset_to_expire_cache=(offset)
+      raise ArgumentError, 'offset must be between 0 and 23' unless (0..23).cover? offset
+      @hour_offset_to_expire_cache = offset
+    end
+
+    # Preferred hour to expire caches related to slow running calculations (e.g. monitoring tests, performance data)
+    # @return [Integer] count of hours after midnight (0-23 with 0=midnight)
+    def hour_offset_to_expire_cache
+      @hour_offset_to_expire_cache ||= 3
+    end
+
+    # Set preferred hour to run monitoring tests (deprecated)
     # @param [Integer] count of hours from midnight (0-23 with 0=midnight)
     # @example
     #   For preferred_time_zone_name of 'Eastern Time (US & Canada)', use 3 for slow down at midnight PT/3am ET
     #   For preferred_time_zone_name of 'Pacific Time (US & Canada)', use 0 for slow down at midnight PT/3am ET
-    attr_writer :hour_offset_to_run_monitoring_tests
-    def hour_offset_to_run_monitoring_tests
-      @hour_offset_to_run_monitoring_tests ||= 3
+    # @deprecated Use {#hour_offset_to_expire_cache=} instead.
+    def hour_offset_to_run_monitoring_tests=(offset)
+      Deprecation.warn(QaServer, "hour_offset_to_run_monitoring_tests= is deprecated and will be removed from a future release (use #hour_offset_to_expire_cache= instead)")
+      @hour_offset_to_expire_cache = offset
     end
 
+    # Preferred hour to run monitoring tests (deprecated)
+    # @return [Integer] count of hours from midnight (0-23 with 0=midnight)
+    # @deprecated Use {#hour_offset_to_expire_cache} instead.
+    alias hour_offset_to_run_monitoring_tests hour_offset_to_expire_cache
+    deprecation_deprecate hour_offset_to_run_monitoring_tests: "use #hour_offset_to_expire_cache instead"
+
     # Displays a graph of historical test data when true
     # @param [Boolean] display history graph when true
     attr_writer :display_historical_graph
@@ -74,8 +98,15 @@ module QaServer
     end
 
     # Performance graph default time period for all graphs.  All authorities will show the graph for this time period on page load.
-    # @param [String] :day, :month, or :year
-    attr_writer :performance_graph_default_time_period
+    # @param [Symbol] time period for default display of performance graphs (i.e., one of :day, :month, or :year)
+    # @raise [ArgumentError] if time_period is not one of :day, :month, or :year
+    def performance_graph_default_time_period=(time_period)
+      raise ArgumentError, 'time_period must be one of :day, :month, or :year' unless [:day, :month, :year].include? time_period
+      @performance_graph_default_time_period = time_period
+    end
+
+    # Performance graph default time period for all graphs.  All authorities will show the graph for this time period on page load.
+    # @return [Symbol] time period for default display of performance graphs (i.e., one of :day, :month, or :year)
     def performance_graph_default_time_period
       @performance_graph_default_time_period ||= :month
     end
@@ -89,8 +120,15 @@ module QaServer
     end
 
     # Performance datatable default time period for calculating stats.
-    # @param [String] :day, :month, :year, :all
-    attr_writer :performance_datatable_default_time_period
+    # @param [Symbol] time period for calculating performance stats (i.e., one of :day, :month, :year, or :all)
+    # @raise [ArgumentError] if time_period is not one of :day, :month, :year, or :all
+    def performance_datatable_default_time_period=(time_period)
+      raise ArgumentError, 'time_period must be one of :day, :month, :year, or :all' unless [:day, :month, :year, :all].include? time_period
+      @performance_datatable_default_time_period = time_period
+    end
+
+    # Performance datatable default time period for calculating stats.
+    # @return [Symbol] time period for calculating performance stats (i.e., one of :day, :month, :year, or :all)
     def performance_datatable_default_time_period
       @performance_datatable_default_time_period ||= :year
     end

data/lib/qa_server/version.rb

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

data/qa_server.gemspec

@@ -38,6 +38,7 @@ Gem::Specification.new do |spec|
   # spec.add_development_dependency "capybara", '~> 3.29'
   # spec.add_development_dependency 'capybara-maleficent', '~> 0.3.0'
   # spec.add_development_dependency 'chromedriver-helper', '~> 2.1'
+  spec.add_development_dependency 'deprecation'
   spec.add_development_dependency 'engine_cart', '~> 2.0'
   spec.add_development_dependency "factory_bot", '~> 4.4'
   spec.add_development_dependency 'simplecov'

data/spec/lib/configuration_spec.rb

@@ -0,0 +1,199 @@
+# frozen_string_literal: true
+require 'spec_helper'
+
+RSpec.describe QaServer::Configuration do
+  let(:config) { described_class.new }
+
+  describe '#preferred_time_zone_name' do
+    it 'returns default as Eastern Time' do
+      expect(config.preferred_time_zone_name).to eq 'Eastern Time (US & Canada)'
+    end
+
+    it 'returns set time zone name' do
+      config.preferred_time_zone_name = 'Pacific Time (US & Canada)'
+      expect(config.preferred_time_zone_name).to eq 'Pacific Time (US & Canada)'
+    end
+  end
+
+  describe '#hour_offset_to_expire_cache=' do
+    it 'raises exception if offset is negative' do
+      expect { config.hour_offset_to_expire_cache = -1 }.to raise_error ArgumentError, 'offset must be between 0 and 23'
+    end
+
+    it 'raises exception if offset is greater than 23' do
+      expect { config.hour_offset_to_expire_cache = 24 }.to raise_error ArgumentError, 'offset must be between 0 and 23'
+    end
+
+    it 'sets offset if between 0..23' do
+      expect(config.hour_offset_to_expire_cache = 5).to eq 5
+    end
+  end
+
+  describe '#hour_offset_to_expire_cache' do
+    it 'returns default as 3' do
+      expect(config.hour_offset_to_expire_cache).to eq 3
+    end
+
+    it 'returns set offset' do
+      config.hour_offset_to_expire_cache = 2
+      expect(config.hour_offset_to_expire_cache).to eq 2
+    end
+  end
+
+  describe '#display_historical_graph?' do
+    it 'return default as false' do
+      expect(config.display_historical_graph?).to eq false
+    end
+
+    it 'returns set value' do
+      config.display_historical_graph = true
+      expect(config.display_historical_graph?).to eq true
+    end
+  end
+
+  describe '#display_historical_datatable?' do
+    it 'return default as true' do
+      expect(config.display_historical_datatable?).to eq true
+    end
+
+    it 'returns set value' do
+      config.display_historical_datatable = false
+      expect(config.display_historical_datatable?).to eq false
+    end
+  end
+
+  describe '#display_performance_graph?' do
+    it 'return default as false' do
+      expect(config.display_performance_graph?).to eq false
+    end
+
+    it 'returns set value' do
+      config.display_performance_graph = true
+      expect(config.display_performance_graph?).to eq true
+    end
+  end
+
+  describe '#performance_y_axis_max' do
+    it 'return default as 4000' do
+      expect(config.performance_y_axis_max).to eq 4000
+    end
+
+    it 'returns set value' do
+      config.performance_y_axis_max = 3500
+      expect(config.performance_y_axis_max).to eq 3500
+    end
+  end
+
+  describe '#performance_retrieve_color' do
+    it 'return default as #ABC3C9' do
+      expect(config.performance_retrieve_color).to eq '#ABC3C9'
+    end
+
+    it 'returns set value' do
+      config.performance_retrieve_color = '#FFFFFF'
+      expect(config.performance_retrieve_color).to eq '#FFFFFF'
+    end
+  end
+
+  describe '#performance_graph_load_color' do
+    it 'return default as #ABC3C9' do
+      expect(config.performance_graph_load_color).to eq '#E8DCD3'
+    end
+
+    it 'returns set value' do
+      config.performance_graph_load_color = '#FFFFFF'
+      expect(config.performance_graph_load_color).to eq '#FFFFFF'
+    end
+  end
+
+  describe '#performance_normalization_color' do
+    it 'return default as #ABC3C9' do
+      expect(config.performance_normalization_color).to eq '#CCBE9F'
+    end
+
+    it 'returns set value' do
+      config.performance_normalization_color = '#FFFFFF'
+      expect(config.performance_normalization_color).to eq '#FFFFFF'
+    end
+  end
+
+  describe '#performance_graph_default_time_period=' do
+    it 'raises exception if time_period is invalid' do
+      expect { config.performance_graph_default_time_period = :decade }.to raise_error ArgumentError, 'time_period must be one of :day, :month, or :year'
+    end
+
+    it 'sets time_period if valid' do
+      expect(config.performance_graph_default_time_period = :day).to eq :day
+      expect(config.performance_graph_default_time_period = :month).to eq :month
+      expect(config.performance_graph_default_time_period = :year).to eq :year
+    end
+  end
+
+  describe '#performance_graph_default_time_period' do
+    it 'return default as :month' do
+      expect(config.performance_graph_default_time_period).to eq :month
+    end
+
+    it 'returns set value' do
+      config.performance_graph_default_time_period = :day
+      expect(config.performance_graph_default_time_period).to eq :day
+    end
+  end
+
+  describe '#display_performance_datatable?' do
+    it 'return default as true' do
+      expect(config.display_performance_datatable?).to eq true
+    end
+
+    it 'returns set value' do
+      config.display_performance_datatable = false
+      expect(config.display_performance_datatable?).to eq false
+    end
+  end
+
+  describe '#performance_datatable_default_time_period=' do
+    it 'raises exception if time_period is invalid' do
+      expect { config.performance_datatable_default_time_period = :decade }.to raise_error ArgumentError, 'time_period must be one of :day, :month, :year, or :all'
+    end
+
+    it 'sets time_period if valid' do
+      expect(config.performance_datatable_default_time_period = :day).to eq :day
+      expect(config.performance_datatable_default_time_period = :month).to eq :month
+      expect(config.performance_datatable_default_time_period = :year).to eq :year
+      expect(config.performance_datatable_default_time_period = :all).to eq :all
+    end
+  end
+
+  describe '#performance_datatable_default_time_period' do
+    it 'return default as :year' do
+      expect(config.performance_datatable_default_time_period).to eq :year
+    end
+
+    it 'returns set value' do
+      config.performance_datatable_default_time_period = :day
+      expect(config.performance_datatable_default_time_period).to eq :day
+    end
+  end
+
+  describe '#performance_datatable_max_threshold' do
+    it 'return default as 1500 (e.g. 1.5s)' do
+      expect(config.performance_datatable_max_threshold).to eq 1500
+    end
+
+    it 'returns set value' do
+      config.performance_datatable_max_threshold = 1200
+      expect(config.performance_datatable_max_threshold).to eq 1200
+    end
+  end
+
+  describe '#performance_datatable_warning_threshold' do
+    it 'return default as 1000 (e.g. 1s)' do
+      expect(config.performance_datatable_warning_threshold).to eq 1000
+    end
+
+    it 'returns set value' do
+      config.performance_datatable_warning_threshold = 500
+      expect(config.performance_datatable_warning_threshold).to eq 500
+    end
+  end
+end

data/spec/lib/qa_server_spec.rb

@@ -4,9 +4,10 @@ require 'spec_helper'
 RSpec.describe QaServer do
   # rubocop:disable RSpec/MessageChain
   let(:timezone_name) { 'Eastern Time (US & Canada)' }
+  before { allow(described_class).to receive_message_chain(:config, :preferred_time_zone_name).and_return(timezone_name) }
+
   describe '.current_time' do
     before do
-      allow(described_class).to receive_message_chain(:config, :preferred_time_zone_name).and_return(timezone_name)
       allow(Time).to receive(:now).and_return(DateTime.parse('2019-12-11 05:00:00 -0500').in_time_zone(timezone_name))
     end
 
@@ -18,32 +19,41 @@ RSpec.describe QaServer do
 
   describe '.monitoring_expires_at' do
     before do
-      allow(described_class).to receive_message_chain(:config, :hour_offset_to_run_monitoring_tests).and_return(3)
+      allow(described_class).to receive_message_chain(:config, :hour_offset_to_expire_cache).and_return(3)
     end
 
-    context 'when current hour is after offset time' do
+    context 'when current hour is before offset time' do
       before do
-        allow(described_class).to receive(:current_time).and_return(DateTime.parse('2019-12-11 05:00:00 -0500').in_time_zone(timezone_name))
+        allow(described_class).to receive(:current_time).and_return(DateTime.parse('2019-12-11 02:54:00 -0500').in_time_zone(timezone_name))
       end
 
       it 'returns expiration on current date at offset time' do
-        puts 'Running QaServer.monitoring_expires_at when current hour is after offset time spec'
-        expect(described_class.monitoring_expires_at).to eq DateTime.parse('2019-12-11 03:00:00 -0500').in_time_zone(timezone_name)
+        expect(described_class.monitoring_expires_at).to eq DateTime.parse('2019-12-11 02:55:00 -0500').in_time_zone(timezone_name)
       end
     end
 
-    context 'when current hour is before offset time' do
+    context 'when current hour is after offset time' do
       before do
-        allow(described_class).to receive(:current_time).and_return(DateTime.parse('2019-12-11 01:00:00 -0500').in_time_zone(timezone_name))
+        allow(described_class).to receive(:current_time).and_return(DateTime.parse('2019-12-11 02:56:00 -0500').in_time_zone(timezone_name))
       end
 
       it 'returns expiration on previous date at offset time' do
-        puts 'Running QaServer.monitoring_expires_at when current hour is before offset time spec'
-        expect(described_class.monitoring_expires_at).to eq DateTime.parse('2019-12-10 03:00:00 -0500').in_time_zone(timezone_name)
+        expect(described_class.monitoring_expires_at).to eq DateTime.parse('2019-12-12 02:55:00 -0500').in_time_zone(timezone_name)
       end
     end
   end
 
+  describe '.cache_expiry' do
+    before do
+      allow(described_class).to receive_message_chain(:config, :hour_offset_to_expire_cache).and_return(3)
+      allow(Time).to receive(:now).and_return(DateTime.parse('2019-12-11 02:54:59 -0500').in_time_zone(timezone_name))
+    end
+
+    it 'returns seconds until offset time (simulates 1 second before offset time)' do
+      expect(described_class.cache_expiry).to eq 1.second
+    end
+  end
+
   # rubocop:disable RSpec/MessageSpies
   describe '.log_agent_info' do
     let(:request) { double }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qa_server
 version: !ruby/object:Gem::Version
-  version: 5.3.0
+  version: 5.4.0
 platform: ruby
 authors:
 - E. Lynette Rayle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-19 00:00:00.000000000 Z
+date: 2020-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -122,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: deprecation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: engine_cart
   requirement: !ruby/object:Gem::Requirement
@@ -457,6 +471,7 @@ files:
 - lib/tasks/qa_server_tasks.rake
 - qa_server.gemspec
 - spec/.gitignore
+- spec/lib/configuration_spec.rb
 - spec/lib/qa_server_spec.rb
 - spec/rails_helper.rb
 - spec/spec_helper.rb
@@ -489,6 +504,7 @@ specification_version: 4
 summary: Authority Lookup Server
 test_files:
 - spec/.gitignore
+- spec/lib/configuration_spec.rb
 - spec/lib/qa_server_spec.rb
 - spec/rails_helper.rb
 - spec/spec_helper.rb