taskinator 0.3.10 → 0.3.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1cac7446426c45fc14b6cc0dee7620874e322fa2
-  data.tar.gz: 7dd667765ef5e6a139b99ea03604aef198f80130
+  metadata.gz: e57a5add32ebc7ffc6af22bbe9768db6c89f896f
+  data.tar.gz: 434f7323883114425d9f24351f503557a2cc72c2
 SHA512:
-  metadata.gz: de3cc2b3dd447ed10b1662cca01ea0398c35c375466ee3a55b3ed67eefc28cd1a8d5888e56f50258bc2027f7ea4f8462ba0bc52cac2d2f242dbd56b46b7548b4
-  data.tar.gz: c98d31d5968ecfc7289831b327a1fd00bb9be75c0206304f3d8aed6b38fbf3ec4d3460b85b3cf439604ea2490095d8fee60280c27c43a18b71c6a9b3aa47d03c
+  metadata.gz: 917159bb5af8a31a8ea8ef8dc76b2cdb1a0c78336fc163fd38af2b63e327692550e3eecf92275bdc5f3fe24f7e17ab93d053809bb3a23b99ed69b1d9b01d9938
+  data.tar.gz: 0ff149a53cb1952b160e9cf3c4d3eb196da080c2dd0f63112a63c0511cec01258f5d47a548326ddd03cbeda5cf8fd056fb85c54d57677e2a0a41aba363d30eec

data/Gemfile

@@ -20,3 +20,5 @@ gem 'rspec'
 gem 'coveralls'       , '>= 0.7.0'
 gem 'pry'             , '>= 0.9.0'
 gem 'pry-byebug'      , '>= 1.3.0'
+
+gem 'fakeredis'       , '~> 0.6.0'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    taskinator (0.3.10)
+    taskinator (0.3.11)
       builder (>= 3.2.2)
       connection_pool (>= 2.2.0)
       globalid (~> 0.3)
@@ -9,6 +9,7 @@ PATH
       redis (>= 3.2.1)
       redis-namespace (>= 1.5.2)
       redis-semaphore (>= 0.2.4)
+      statsd-ruby (~> 1.2.0)
 
 GEM
   remote: https://rubygems.org/
@@ -20,7 +21,7 @@ GEM
       thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
     builder (3.2.2)
-    byebug (9.0.5)
+    byebug (9.0.6)
     coderay (1.1.1)
     concurrent-ruby (1.0.2)
     connection_pool (2.2.0)
@@ -34,12 +35,14 @@ GEM
       activesupport (>= 3.0, < 5.1)
     diff-lcs (1.2.5)
     docile (1.1.5)
+    fakeredis (0.6.0)
+      redis (~> 3.2)
     globalid (0.3.7)
       activesupport (>= 4.1.0)
     i18n (0.7.0)
     json (1.8.3)
     method_source (0.8.2)
-    minitest (5.9.0)
+    minitest (5.9.1)
     mono_logger (1.1.0)
     multi_json (1.12.1)
     pry (0.10.4)
@@ -52,7 +55,7 @@ GEM
     rack (1.6.4)
     rack-protection (1.5.3)
       rack
-    rake (11.2.2)
+    rake (11.3.0)
     redis (3.3.1)
     redis-namespace (1.5.2)
       redis (~> 3.0, >= 3.0.4)
@@ -73,7 +76,7 @@ GEM
       rspec-core (~> 3.5.0)
       rspec-expectations (~> 3.5.0)
       rspec-mocks (~> 3.5.0)
-    rspec-core (3.5.3)
+    rspec-core (3.5.4)
       rspec-support (~> 3.5.0)
     rspec-expectations (3.5.0)
       diff-lcs (>= 1.2.0, < 2.0)
@@ -85,11 +88,11 @@ GEM
       rspec (~> 3.0, >= 3.0.0)
       sidekiq (>= 2.4.0)
     rspec-support (3.5.0)
-    sidekiq (4.1.4)
+    sidekiq (4.2.3)
       concurrent-ruby (~> 1.0)
       connection_pool (~> 2.2, >= 2.2.0)
+      rack-protection (>= 1.5.0)
       redis (~> 3.2, >= 3.2.1)
-      sinatra (>= 1.4.7)
     simplecov (0.12.0)
       docile (~> 1.1.0)
       json (>= 1.8, < 3)
@@ -100,7 +103,8 @@ GEM
       rack-protection (~> 1.4)
       tilt (>= 1.3, < 3)
     slop (3.6.0)
-    term-ansicolor (1.3.2)
+    statsd-ruby (1.2.1)
+    term-ansicolor (1.4.0)
       tins (~> 1.0)
     thor (0.19.1)
     thread_safe (0.3.5)
@@ -119,6 +123,7 @@ DEPENDENCIES
   bundler (>= 1.6.0)
   coveralls (>= 0.7.0)
   delayed_job (~> 4.1.0)
+  fakeredis (~> 0.6.0)
   pry (>= 0.9.0)
   pry-byebug (>= 1.3.0)
   rake (>= 10.3.0)
@@ -130,4 +135,4 @@ DEPENDENCIES
   taskinator!
 
 BUNDLED WITH
-   1.12.5
+   1.13.4

data/lib/taskinator.rb

@@ -6,6 +6,8 @@ require 'benchmark'
 
 require 'taskinator/version'
 
+require 'taskinator/log_stats'
+
 require 'taskinator/complete_on'
 require 'taskinator/redis_connection'
 require 'taskinator/logger'
@@ -70,16 +72,6 @@ module Taskinator
       redis_pool.with(&block)
     end
 
-    def redis_mutex(lockid, options={}, &block)
-      raise ArgumentError, "requires a block" unless block_given?
-      m = Benchmark.measure do
-        redis do |r|
-          Redis::Semaphore.new(lockid, {:redis => r}.merge(options)).lock(&block)
-        end
-      end
-      logger.debug("Time spent in mutex: #{m.real}")
-    end
-
     def redis_pool
       @redis ||= Taskinator::RedisConnection.create
     end
@@ -96,6 +88,14 @@ module Taskinator
       Taskinator::Logging.logger = log
     end
 
+    def statsd_client
+      Taskinator::LogStats.client
+    end
+
+    def statsd_client=(client)
+      Taskinator::LogStats.client = client
+    end
+
     # the queue adapter to use
     # supported adapters include
     # :delayed_job, :redis and :sidekiq

data/lib/taskinator/log_stats.rb

@@ -0,0 +1,49 @@
+require 'statsd'
+
+module Taskinator
+  module LogStats
+    class << self
+
+      def initialize_client
+        @client = Statsd.new()
+      end
+
+      def client
+        defined?(@client) ? @client : initialize_client
+      end
+
+      def client=(statsd_client)
+        @client = (statsd_client ? statsd_client : initialize_client)
+      end
+
+      def duration(stat, duration)
+        client.timing(stat, duration * 1000)
+      end
+
+      def timing(stat, &block)
+        result = nil
+        duration = Benchmark.realtime do
+          result = yield
+        end
+        duration(stat, duration)
+        result
+      end
+
+      def gauge(stat, count)
+        client.gauge(stat, count)
+      end
+
+      def count(stat, count)
+        client.count(stat, count)
+      end
+
+      def increment(stat)
+        client.increment(stat)
+      end
+
+      def decrement(stat)
+        client.decrement(stat)
+      end
+    end
+  end
+end

data/lib/taskinator/persistence.rb

@@ -191,6 +191,12 @@ module Taskinator
 
       end
 
+      def deincr_pending_tasks
+        Taskinator.redis do |conn|
+          conn.incrby("#{key}.pending", -1)
+        end
+      end
+
       # retrieves the process options of the root process
       # this is so that meta data of the process can be maintained
       # and accessible to instrumentation subscribers
@@ -203,13 +209,13 @@ module Taskinator
         end
       end
 
-      EXPIRE_IN = 10 * 60 # 10 minutes
+      EXPIRE_IN = 30 * 60 # 30 minutes
 
-      def cleanup(expire_at=Time.now+EXPIRE_IN)
+      def cleanup(expire_in=EXPIRE_IN)
         Taskinator.redis do |conn|
 
           # use the "clean up" visitor
-          RedisCleanupVisitor.new(conn, self, expire_at).visit
+          RedisCleanupVisitor.new(conn, self, expire_in).visit
 
           # remove from the list
           conn.srem(Persistence.processes_list_key(scope), uuid)
@@ -276,6 +282,8 @@ module Taskinator
             @base_visitor.incr_task_count
           end
         end
+        @conn.set("#{@key}.count", tasks.count)
+        @conn.set("#{@key}.pending", tasks.count)
       end
 
       def visit_attribute(attribute)
@@ -377,7 +385,7 @@ module Taskinator
       end
 
       def visit_tasks(tasks)
-        builder.tag!('tasks') do |xml|
+        builder.tag!('tasks', :count => tasks.count) do |xml|
           tasks.each do |task|
             xml.tag!('task', :key => task.key) do |xml2|
               XmlSerializationVisitor.new(xml2, task, @base_visitor).visit
@@ -495,7 +503,7 @@ module Taskinator
         # tasks are a linked list, so just get the first one
         Taskinator.redis do |conn|
           uuid = conn.lindex("#{@key}:tasks", 0)
-          tasks << lazy_instance_for(Task, uuid) if uuid
+          tasks.attach(lazy_instance_for(Task, uuid), conn.get("#{@key}.count").to_i) if uuid
         end
       end
 
@@ -576,28 +584,28 @@ module Taskinator
     class RedisCleanupVisitor < Taskinator::Visitor::Base
 
       attr_reader :instance
-      attr_reader :expire_at
+      attr_reader :expire_in # seconds
 
-      def initialize(conn, instance, expire_at)
+      def initialize(conn, instance, expire_in)
         @conn = conn
         @instance = instance
-        @expire_at = expire_at.utc
+        @expire_in = expire_in.to_i
         @key = instance.key
       end
 
       def visit
         @instance.accept(self)
-        @conn.expireat(@key, expire_at.to_i)
+        @conn.expire(@key, expire_in)
       end
 
       def visit_process(attribute)
         process = @instance.send(attribute)
-        RedisCleanupVisitor.new(@conn, process, expire_at).visit if process
+        RedisCleanupVisitor.new(@conn, process, expire_in).visit if process
       end
 
       def visit_tasks(tasks)
         tasks.each do |task|
-          RedisCleanupVisitor.new(@conn, task, expire_at).visit
+          RedisCleanupVisitor.new(@conn, task, expire_in).visit
         end
       end
 

data/lib/taskinator/process.rb

@@ -228,6 +228,8 @@ module Taskinator
         if tasks.empty?
           complete! # weren't any tasks to start with
         else
+          Taskinator.statsd_client.count("taskinator.#{definition.name.underscore.parameterize}.pending", tasks.count)
+          Taskinator.logger.info("Enqueuing #{tasks.count} tasks for process '#{uuid}'.")
           tasks.each(&:enqueue!)
         end
       end
@@ -256,18 +258,20 @@ module Taskinator
       end
 
       def task_completed(task)
+        # skip if failed
+        return if failed?
+
+        # deincrement the count of pending concurrent tasks
+        pending = deincr_pending_tasks
+
+        Taskinator.statsd_client.count("taskinator.#{definition.name.underscore.parameterize}.pending", pending)
+        Taskinator.logger.info("Completed task for process '#{uuid}'. Pending is #{pending}.")
+
         # when complete on first, then don't bother with subsequent tasks completing
-        return if completed? || failed?
-
-        if tasks_completed?
-          # prevent re-entrance so that two tasks completing
-          # simultaneously can't complete the process twice,
-          # which enqueues/starts the same subsequent task
-          Taskinator.redis_mutex(uuid) do
-            # double check, since the status may have
-            # changed while waiting in the mutex
-            complete! if tasks_completed?
-          end
+        if (complete_on == CompleteOn::First)
+          complete! unless completed?
+        else
+          complete! if pending < 1
         end
       end
 

data/lib/taskinator/redis_connection.rb

@@ -60,8 +60,6 @@ module Taskinator
           opts.delete(:network_timeout)
         end
 
-        opts[:driver] = opts[:driver] || 'ruby'
-
         opts
       end
 

data/lib/taskinator/task_worker.rb

@@ -8,6 +8,7 @@ module Taskinator
 
     def perform
       task = Taskinator::Task.fetch(@uuid)
+      raise "ERROR: Task '#{@uuid}' not found." unless task
       return if task.paused? || task.cancelled?
       task.start!
     end

data/lib/taskinator/tasks.rb

@@ -7,19 +7,31 @@ module Taskinator
     attr_reader :head
     alias_method :first, :head
 
+    attr_reader :count
+    alias_method :length, :count
+
     def initialize(first=nil)
-      @head = first
+      @count = 0
+      add(first) if first
+    end
+
+    def attach(task, count)
+      @head = task
+      @count = count
+      task
     end
 
     def add(task)
       if @head.nil?
         @head = task
+        @count = 1
       else
         current = @head
         while current.next
           current = current.next
         end
         current.next = task
+        @count += 1
       end
       task
     end

data/lib/taskinator/version.rb

@@ -1,3 +1,3 @@
 module Taskinator
-  VERSION = "0.3.10"
+  VERSION = "0.3.11"
 end

data/spec/spec_helper.rb

@@ -6,15 +6,17 @@ require 'coveralls'
 require 'pry'
 require 'active_support/notifications'
 
-SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
   SimpleCov::Formatter::HTMLFormatter,
   Coveralls::SimpleCov::Formatter
-]
+])
 
 SimpleCov.start do
   add_filter 'spec'
 end
 
+require 'fakeredis/rspec'
+
 require 'delayed_job'
 
 require 'sidekiq'

data/spec/taskinator/persistence_spec.rb

@@ -341,6 +341,18 @@ describe Taskinator::Persistence, :redis => true do
 
     end
 
+    describe "#deincr_pending_tasks" do
+      it {
+        Taskinator.redis do |conn|
+          conn.set("#{subject.key}.pending", 99)
+        end
+
+        pending = subject.deincr_pending_tasks
+
+        expect(pending).to eq(98)
+      }
+    end
+
     describe "#process_options" do
       it {
         Taskinator.redis do |conn|
@@ -368,7 +380,7 @@ describe Taskinator::Persistence, :redis => true do
             Taskinator.redis do |conn|
               expect(conn.hget(process.key, :uuid)).to eq(process.uuid)
 
-              process.cleanup(Time.now)
+              process.cleanup(0) # immediately
 
               expect(conn.hget(process.key, :uuid)).to be_nil
 
@@ -389,7 +401,7 @@ describe Taskinator::Persistence, :redis => true do
           Taskinator.redis do |conn|
             expect(conn.hget(process.key, :uuid)).to eq(process.uuid)
 
-            process.cleanup(Time.now + 1)
+            process.cleanup(2)
 
             # still available...
             expect(conn.hget(process.key, :uuid)).to_not be_nil
@@ -397,7 +409,7 @@ describe Taskinator::Persistence, :redis => true do
               expect(conn.hget(task.key, :uuid)).to_not be_nil
             end
 
-            sleep 2
+            sleep 3
 
             # gone!
             expect(conn.hget(process.key, :uuid)).to be_nil

data/spec/taskinator/process_spec.rb

@@ -419,16 +419,17 @@ describe Taskinator::Process do
 
     describe "#task_completed" do
       it "completes when tasks complete (CompleteOn::First)" do
-        allow_any_instance_of(Taskinator::Task).to receive(:completed?) { true }
-
         process = Taskinator::Process.define_concurrent_process_for(definition, Taskinator::CompleteOn::First)
-
         tasks.each {|t| process.tasks << t }
 
-        expect(process).to receive(:complete!).and_call_original
+        allow(process).to receive(:deincr_pending_tasks) { tasks.count - 1 }
+
+        expect(process).to receive(:complete!).once.and_call_original
 
         process.task_completed(tasks.first)
 
+        expect(process.completed?).to be(true)
+
         # remaining tasks should do nothing...
         tasks.each do |task|
           process.task_completed(task)
@@ -436,16 +437,17 @@ describe Taskinator::Process do
       end
 
       it "completes when tasks complete (CompleteOn::Last)" do
-        allow_any_instance_of(Taskinator::Task).to receive(:completed?) { true }
-
         process = Taskinator::Process.define_concurrent_process_for(definition, Taskinator::CompleteOn::Last)
-
         tasks.each {|t| process.tasks << t }
 
-        expect(process).to receive(:complete!).and_call_original
+        pending_count = tasks.count
+        allow(process).to receive(:deincr_pending_tasks) { pending_count -= 1 }
+
+        expect(process).to receive(:complete!).once.and_call_original
 
         tasks.each do |task|
           process.task_completed(task)
+          expect(process.completed?).to be(false) unless pending_count < 1
         end
       end
     end

data/taskinator.gemspec

@@ -28,4 +28,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'json'                        , '>= 1.8.2'
   spec.add_dependency 'builder'                     , '>= 3.2.2'
   spec.add_dependency 'globalid'                    , '~> 0.3'
+  spec.add_dependency 'statsd-ruby'                 , '~> 1.2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: taskinator
 version: !ruby/object:Gem::Version
-  version: 0.3.10
+  version: 0.3.11
 platform: ruby
 authors:
 - Chris Stefano
@@ -108,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: statsd-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
 description: Simple process orchestration
 email:
 - virtualstaticvoid@gmail.com
@@ -139,6 +153,7 @@ files:
 - lib/taskinator/definition/builder.rb
 - lib/taskinator/executor.rb
 - lib/taskinator/instrumentation.rb
+- lib/taskinator/log_stats.rb
 - lib/taskinator/logger.rb
 - lib/taskinator/persistence.rb
 - lib/taskinator/process.rb