timberline 0.8.5 → 0.8.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6f3dfd9c720cbfdd13437a4f993314cc6bd1efd0
-  data.tar.gz: 711690699ad0b93354396aacb8d550d41759513e
+  metadata.gz: e1b6a21eb5632e2c1c6aa2bf9a5b10b959845257
+  data.tar.gz: ef713d037a79f52d7ab59bd00c883ba5ffeb1566
 SHA512:
-  metadata.gz: 9864cd6bd4aef55a8871f1e3cf7103c7ab42e8ec0e75552e3097a625852717f1f132a07477ff1c0ff522a05b83133e04d27dcfc576e3b3fc7a92f4f770f3077f
-  data.tar.gz: b3c073f280198da05af738b1a94d37187231e11795f534b5abfdb695a2b774fc40b601b89f1fd8b94fbc20caf14a237d09a728799cb067c7a6b727543847211e
+  metadata.gz: 67996b724ec828c41b5a44c179b55899bf646c8d0ef5f6f3928514e4968c0fed7eb0282016acc4c7ab0340381f0a731f74fcb007581a99c3d1d6e62d08dacd8c
+  data.tar.gz: e56e9d483a53122a8cfb572bd0d6b8d07c1262d167d68de37d9061f9d2ef137af66344ce97391b22aff0d3b1cbc1fcd63dfb3d01bc3b94f28a888a82937c8703

data/.travis.yml

@@ -1,10 +1,9 @@
 language: ruby
 rvm:
-  - 1.9.3
+  - 2.2.0
+  - 2.5.0
   - jruby-19mode
   - jruby-head
-  - 2.0.0
-  - 2.1.0
   - ruby-head
 services: 
   - redis-server

data/CHANGELOG

@@ -1,3 +1,6 @@
+0.8.6
+  - Turned off job stat logging by default (configure with log_job_result_stats config property)
+  - Updated outdated redis api
 0.8.4
   - Allow stat_timeout and max_retries to be set from config 
 0.8.3

data/lib/timberline.rb

@@ -141,6 +141,13 @@ class Timberline
     @config.stat_timeout * 60
   end
 
+  # Lazy-loads the Timberline configuration.
+  # @return [Boolean] whether we want to record result stats for each job in a redis queue
+  def self.log_job_results?
+    initialize_if_necessary
+    @config.log_job_result_stats
+  end
+
   # Create and start a new AnonymousWorker with the given
   # queue_name and block. Convenience method.
   #

data/lib/timberline/config.rb

@@ -27,7 +27,7 @@ class Timberline
   #   for failover protection.
   #
   class Config
-    attr_accessor :database, :host, :port, :timeout, :password,
+    attr_accessor :database, :host, :port, :timeout, :password, :log_job_result_stats,
                   :logger, :namespace, :max_retries, :stat_timeout, :sentinels
 
     # Attemps to load configuration from TIMBERLINE_YAML, if it exists.
@@ -52,6 +52,12 @@ class Timberline
       @stat_timeout ||= 60
     end
 
+    # @return [Boolean] configuration setting for logging each job success or error in redis
+    # created in response to max memory limit on redis queues in aws
+    def log_job_result_stats
+      @log_job_result_stats ||= false
+    end
+
     # @return [{host: "x", port: 1}] list of sentinel server
     def sentinels
       @sentinels ||= []
@@ -93,6 +99,11 @@ class Timberline
       val.match(/\A[+-]?\d+\Z/) ? val.to_i : val
     end
 
+    def convert_if_bool(val)
+      # convert potential string respresentations of boolean values to ruby booleans
+      val.to_s.strip.downcase == "true"
+    end
+
     def configure_via_env
       return unless ENV.key?("TIMBERLINE_URL")
 
@@ -105,6 +116,10 @@ class Timberline
       @password = uri.password
 
       params = uri.query.nil? ? {} : CGI.parse(uri.query)
+      %w(log_job_result_stats).each do |setting|
+        next unless params.key?(setting)
+        instance_variable_set("@#{setting}", convert_if_bool(params[setting][0]))
+      end
       %w(timeout namespace stat_timeout max_retries).each do |setting|
         next unless params.key?(setting)
         instance_variable_set("@#{setting}", convert_if_int(params[setting][0]))
@@ -119,7 +134,7 @@ class Timberline
 
     def load_from_yaml(yaml_config)
       fail "Missing yaml configs!" if yaml_config.nil?
-      %w(database host port timeout password namespace sentinels stat_timeout max_retries).each do |setting|
+      %w(database host port timeout password namespace sentinels stat_timeout max_retries log_job_result_stats).each do |setting|
         instance_variable_set("@#{setting}", yaml_config[setting])
       end
     end

data/lib/timberline/queue.rb

@@ -99,21 +99,21 @@ class Timberline
     # @see Timberline::Queue#pop
     #
     def pause
-      @redis[attr("paused")] = "true"
+      @redis.set(attr("paused"), "true")
     end
 
     # Takes this queue back out of paused mode.
     # @see Timberline::Queue#pop
     #
     def unpause
-      @redis[attr("paused")] = "false"
+      @redis.set(attr("paused"), "false")
     end
 
     # Indicates whether or not this queue is currently in paused mode.
     # @return [boolean]
     #
     def paused?
-      @redis[attr("paused")] == "true"
+      @redis.get(attr("paused")) == "true"
     end
 
     # Given a key, create a string namespaced to this queue name.
@@ -249,6 +249,7 @@ class Timberline
     private
 
     def add_stat_for_key(key, item)
+      return unless Timberline.log_job_results?
       Timberline.redis.xadd key, item, Time.now + Timberline.stat_timeout_seconds
     end
 

data/lib/timberline/version.rb

@@ -1,4 +1,4 @@
 class Timberline
   # The current canonical version for Timberline.
-  VERSION = "0.8.5"
+  VERSION = "0.8.6"
 end

data/spec/lib/timberline/queue_spec.rb

@@ -38,11 +38,11 @@ describe Timberline::Queue do
     end
 
     it "removes the queue from redis" do
-      expect(Timberline.redis["fritters"]).to be_nil 
+      expect(Timberline.redis.get("fritters")).to be_nil
     end
 
     it "removes all of the queue's attributes from redis" do
-      expect(Timberline.redis["fritters:*"]).to be_nil
+      expect(Timberline.redis.get("fritters:*")).to be_nil
     end
 
     it "removes the queue from the Timberline queue listing" do
@@ -113,6 +113,9 @@ describe Timberline::Queue do
     let(:item) { subject.push("apple"); subject.pop }
 
     before do
+      Timberline.configure do |c|
+        c.log_job_result_stats = true
+      end
       subject.error_item(item)
     end
 
@@ -135,6 +138,9 @@ describe Timberline::Queue do
 
     context "when the item hasn't been retried before" do
       before do
+        Timberline.configure do |c|
+          c.log_job_result_stats = true
+        end
         subject.retry_item(item)
       end
 
@@ -153,6 +159,9 @@ describe Timberline::Queue do
 
     context "when the item has been retried before" do
       before do
+        Timberline.configure do |c|
+          c.log_job_result_stats = true
+        end
         item.retries = 3
         subject.retry_item(item)
       end
@@ -181,4 +190,64 @@ describe Timberline::Queue do
       end
     end
   end
+
+  describe "#add_--_stat" do
+
+    context "error stat logging" do
+      
+      subject    { Timberline::Queue.new("popovers") }
+      let(:item) { subject.push("butter"); subject.pop }
+
+      it "doesn't log an error if log_job_result_stats is set to false (default setting)" do
+        subject.add_error_stat(item)
+        expect(subject.number_errors).to eq(0)
+      end
+
+      it "logs an error if log_job_result_stats is set to true" do
+        Timberline.configure do |c|
+          c.log_job_result_stats = true
+        end
+        subject.add_error_stat(item)
+        expect(subject.number_errors).to eq(1)
+      end
+    end
+
+    context "success stat logging" do
+      
+      subject    { Timberline::Queue.new("dutch_oven") }
+      let(:item) { subject.push("strawberry_jam"); subject.pop }
+
+      it "doesn't log a success if log_job_result_stats is set to false (default setting)" do
+        subject.add_success_stat(item)
+        expect(subject.number_successes).to eq(0)
+      end
+
+      it "logs a success if log_job_result_stats is set to true" do
+        Timberline.configure do |c|
+          c.log_job_result_stats = true
+        end
+        subject.add_success_stat(item)
+        expect(subject.number_successes).to eq(1)
+      end
+    end
+
+    context "retry stat logging" do
+      
+      subject    { Timberline::Queue.new("pancakes") }
+      let(:item) { subject.push("blueberry"); subject.pop }
+
+      it "doesn't log a retry attempt if log_job_result_stats is set to false (default setting)" do
+        subject.add_retry_stat(item)
+        expect(subject.number_retries).to eq(0)
+      end
+
+      it "logs a retry attempt if log_job_result_stats is set to true" do
+        Timberline.configure do |c|
+          c.log_job_result_stats = true
+        end
+        subject.add_retry_stat(item)
+        expect(subject.number_retries).to eq(1)
+      end
+    end
+  end
 end

data/timberline.gemspec

@@ -26,6 +26,6 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency "yard"
   s.add_development_dependency "rake"
-  s.add_development_dependency "rspec", '~> 3.0.0.rc1'
+  s.add_development_dependency "rspec", '~> 3.5'
   s.add_development_dependency "pry"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timberline
 version: !ruby/object:Gem::Version
-  version: 0.8.5
+  version: 0.8.6
 platform: ruby
 authors:
 - Tommy Morgan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-22 00:00:00.000000000 Z
+date: 2018-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0.rc1
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0.rc1
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -197,7 +197,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: timberline
-rubygems_version: 2.2.3
+rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
 summary: Timberline is a simple and extensible queuing system built in Ruby and backed
@@ -212,4 +212,3 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/timberline_reset.rb
 - spec/support/timberline_yaml.rb
-has_rdoc: