perfectsched 0.8.0 → 0.8.1

data/ChangeLog

@@ -1,4 +1,18 @@
 
+== 2012-06-25 version 0.8.1
+
+* Added autoload for PerfectSched::VERSION
+* Fixed rdb_compat backend to use Integer type for time fields
+* Added IdempotentAlreadyFinishedError and IdempotentAlreadyExistsError
+  which should be ignored for idempotency
+
+
+== 2012-05-23 version 0.8.0
+
+* New major version
+* Redesigned API
+
+
 == 2012-02-21 version 0.7.10
 
 * Fixed NullBackend#modify_checked

data/lib/perfectsched/backend/rdb_compat.rb

@@ -71,7 +71,7 @@ module PerfectSched
 
       def get_schedule_metadata(key, options={})
         connect {
-          row = @db.fetch("SELECT id, timeout, next_time, cron, delay, data, timezone FROM `#{@table}` LIMIT 1").first
+          row = @db.fetch("SELECT id, timeout, next_time, cron, delay, data, timezone FROM `#{@table}` WHERE id=? LIMIT 1", key).first
           unless row
             raise NotFoundError, "schedule key=#{key} does not exist"
           end
@@ -91,14 +91,14 @@ module PerfectSched
       end
 
       def add(key, type, cron, delay, timezone, data, next_time, next_run_time, options)
-        data = data.dup
-        data[:type] = type
+        data = data ? data.dup : {}
+        data['type'] = type
         connect {
           begin
             n = @db["INSERT INTO `#{@table}` (id, timeout, next_time, cron, delay, data, timezone) VALUES (?, ?, ?, ?, ?, ?, ?);", key, next_run_time, next_time, cron, delay, data.to_json, timezone].insert
             return Schedule.new(@client, key)
           rescue Sequel::DatabaseError
-            raise AlreadyExistsError, "schedule key=#{key} already exists"
+            raise IdempotentAlreadyExistsError, "schedule key=#{key} already exists"
           end
         }
       end
@@ -107,7 +107,7 @@ module PerfectSched
         connect {
           n = @db["DELETE FROM `#{@table}` WHERE id=?;", key].delete
           if n <= 0
-            raise NotFoundError, "schedule key=#{key} does no exist"
+            raise IdempotentNotFoundError, "schedule key=#{key} does no exist"
           end
         }
       end
@@ -150,7 +150,7 @@ module PerfectSched
 
               n = @db["UPDATE `#{@table}` SET timeout=? WHERE id=? AND timeout=?;", next_timeout, row[:id], row[:timeout]].update
               if n > 0
-                scheduled_time = Time.at(row[:next_time]).utc
+                scheduled_time = row[:next_time]
                 attributes = create_attributes(row)
                 task_token = Token.new(row[:id], row[:next_time], attributes[:cron], attributes[:delay], attributes[:timezone])
                 task = Task.new(@client, row[:id], attributes, scheduled_time, task_token)
@@ -189,7 +189,7 @@ module PerfectSched
         connect {
           n = @db["UPDATE `#{@table}` SET timeout=?, next_time=? WHERE id=? AND next_time=?;", next_run_time, next_time, row_id, scheduled_time].update
           if n < 0
-            raise AlreadyFinishedError, "task time=#{Time.at(scheduled_time).utc} is already finished"
+            raise IdempotentAlreadyFinishedError, "task time=#{Time.at(scheduled_time).utc} is already finished"
           end
         }
       end
@@ -224,16 +224,24 @@ module PerfectSched
         timezone = row[:timezone] || 'UTC'
         delay = row[:delay] || 0
         cron = row[:cron]
-        next_time = Time.at(row[:next_time]).utc
-        next_run_time = Time.at(row[:timeout]).utc
+        next_time = row[:next_time]
+        next_run_time = row[:timeout]
 
-        begin
-          data = JSON.parse(row[:data] || '{}')
-        rescue
+        d = row[:data]
+        if d == nil || d == ''
           data = {}
+        else
+          begin
+            data = JSON.parse(d)
+          rescue
+            data = {}
+          end
         end
 
-        type = data.delete('type') || ''
+        type = data.delete('type')
+        if type == nil || type.empty?
+          type = row[:id].split(/\./, 2)[0]
+        end
 
         attributes = {
           :timezone => timezone,

data/lib/perfectsched/error.rb

@@ -40,4 +40,20 @@ module PerfectSched
 
   class ProcessStopError < RuntimeError
   end
+
+  # Applications can ignore these errors to achieve idempotency
+  module IdempotentError
+  end
+
+  class IdempotentAlreadyFinishedError < AlreadyFinishedError
+    include IdempotentError
+  end
+
+  class IdempotentAlreadyExistsError < AlreadyExistsError
+    include IdempotentError
+  end
+
+  class IdempotentNotFoundError < NotFoundError
+    include IdempotentError
+  end
 end

data/lib/perfectsched/version.rb

@@ -1,3 +1,3 @@
 module PerfectSched
-  VERSION = "0.8.0"
+  VERSION = "0.8.1"
 end

data/lib/perfectsched.rb

@@ -38,6 +38,7 @@ module PerfectSched
     :SignalQueue => 'perfectsched/signal_queue',
     :Task => 'perfectsched/task',
     :Worker => 'perfectsched/worker',
+    :VERSION => 'perfectsched/version',
   }.each_pair {|k,v|
     autoload k, File.expand_path(v, File.dirname(__FILE__))
   }

data/spec/rdb_compat_backend_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+require 'perfectsched/backend/rdb_compat'
+
+describe Backend::RDBCompatBackend do
+  let :sc do
+    FileUtils.rm_f 'spec/test.db'
+    sc = PerfectSched.open({:type=>'rdb_compat', :url=>'sqlite://spec/test.db', :table=>'test_scheds'})
+    sc.client.init_database
+    sc
+  end
+
+  let :client do
+    sc.client
+  end
+
+  let :backend do
+    client.backend
+  end
+
+  it 'backward compatibility 1' do
+    backend.db["INSERT INTO test_scheds (id, timeout, next_time, cron, delay, data, timezone) VALUES (?, ?, ?, ?, ?, ?, ?)", "maint_sched.1.do_hourly", 1339812000, 1339812000, "0 * * * *", 0, {"account_id"=>1}.to_json, "UTC"].insert
+    ts = backend.acquire(60, 1, {:now=>1339812003})
+    ts.should_not == nil
+    t = ts[0]
+    t.data.should == {'account_id'=>1}
+    t.type.should == 'maint_sched'
+    t.key.should == 'maint_sched.1.do_hourly'
+    t.next_time.should == 1339812000
+  end
+
+  it 'backward compatibility 2' do
+    backend.db["INSERT INTO test_scheds (id, timeout, next_time, cron, delay, data, timezone) VALUES (?, ?, ?, ?, ?, ?, ?)", "merge", 1339812060, 1339812000, "@hourly", 60, '', "Asia/Tokyo"].insert
+    ts = backend.acquire(60, 1, {:now=>1339812060})
+    t = ts[0]
+    t.data.should == {}
+    t.type.should == 'merge'
+    t.key.should == 'merge'
+    t.next_time.should == 1339812000
+  end
+end
+

data/spec/schedule_collection_spec.rb

@@ -1,142 +1,142 @@
 
 describe ScheduleCollection do
-  before do
-    @sc = create_test_sched
+  let :sc do
+    create_test_sched
   end
 
   after do
-    @sc.client.close
+    sc.client.close
   end
 
   it 'is a ScheduleCollection' do
-    @sc.class.should == PerfectSched::ScheduleCollection
+    sc.class.should == PerfectSched::ScheduleCollection
   end
 
   it 'succeess add' do
-    @sc.add('sched01', 't01', {:cron=>'* * * * *', :timezone=>'UTC'})
+    sc.add('sched01', 't01', {:cron=>'* * * * *', :timezone=>'UTC'})
   end
 
   it 'fail duplicated add' do
-    @sc.add('sched01', 't01', {:cron=>'* * * * *', :timezone=>'UTC'})
+    sc.add('sched01', 't01', {:cron=>'* * * * *', :timezone=>'UTC'})
 
     lambda {
-      @sc.add('sched01', 't01', {:cron=>'* * * * *', :timezone=>'UTC'})
+      sc.add('sched01', 't01', {:cron=>'* * * * *', :timezone=>'UTC'})
     }.should raise_error AlreadyExistsError
 
-    @sc['sched01'].delete!
+    sc['sched01'].delete!
 
-    @sc.add('sched01', 't01', {:cron=>'* * * * *', :timezone=>'UTC'})
+    sc.add('sched01', 't01', {:cron=>'* * * * *', :timezone=>'UTC'})
   end
 
   it 'acquire' do
     time = 1323820800  # 2011-12-14 00:00:00 UTC
 
-    s01 = @sc.add('sched01', 't01', :cron=>"* * * * *", :data=>{'k'=>1}, :next_time=>time)
+    s01 = sc.add('sched01', 't01', :cron=>"* * * * *", :data=>{'k'=>1}, :next_time=>time)
 
-    t01 = @sc.poll(:alive_time=>120, :now=>time)
+    t01 = sc.poll(:alive_time=>120, :now=>time)
     t01.key.should == 'sched01'
     t01.type.should == 't01'
     t01.cron.should == "* * * * *"
     t01.delay.should == 0
     t01.data.should == {'k'=>1}
-    t01.scheduled_time.should == Time.at(time).utc
+    t01.scheduled_time.should == time
 
-    t02 = @sc.poll(:alive_time=>120, :now=>time+60)
+    t02 = sc.poll(:alive_time=>120, :now=>time+60)
     t02.should == nil
 
     t01.finish!
 
-    t04 = @sc.poll(:alive_time=>120, :now=>time+60)
+    t04 = sc.poll(:alive_time=>120, :now=>time+60)
     t04.key.should == 'sched01'
     t01.type.should == 't01'
     t04.cron.should == "* * * * *"
     t04.delay.should == 0
     t04.data.should == {'k'=>1}
-    t04.scheduled_time.should == Time.at(time+60).utc
+    t04.scheduled_time.should == time+60
   end
 
   it 'timezone' do
     time = 1323820800  # 2011-12-14 00:00:00 UTC
 
-    s01 = @sc.add('sched01', 't01', :cron=>"0 0 * * *", :next_time=>time-60, :timezone=>'UTC')
+    s01 = sc.add('sched01', 't01', :cron=>"0 0 * * *", :next_time=>time-60, :timezone=>'UTC')
     #s01.class.should == Schedule
     #s01.key.should == 'sched01'
 
-    s02 = @sc.add('sched02', 't01', :cron=>"0 0 * * *", :next_time=>time-60, :timezone=>'Asia/Tokyo')
+    s02 = sc.add('sched02', 't01', :cron=>"0 0 * * *", :next_time=>time-60, :timezone=>'Asia/Tokyo')
     #s02.class.should == Schedule
     #s02.key.should == 'sched02'
 
-    t01 = @sc.poll(:alive_time=>86400, :now=>time)
+    t01 = sc.poll(:alive_time=>86400, :now=>time)
     t01.class.should == Task
     t01.key.should == 'sched01'
     t01.type.should == 't01'
-    t01.scheduled_time.should == Time.at(time).utc
+    t01.scheduled_time.should == time
 
-    t02 = @sc.poll(:alive_time=>86400, :now=>time+54000)
+    t02 = sc.poll(:alive_time=>86400, :now=>time+54000)
     t02.class.should == Task
     t02.key.should == 'sched02'
     t02.type.should == 't01'
-    t02.scheduled_time.should == Time.at(time+54000).utc
+    t02.scheduled_time.should == time+54000
   end
 
   it 'delay' do
     time = 1323820800  # 2011-12-14 00:00:00 UTC
 
-    s01 = @sc.add('sched01', 't01', :cron=>"0 * * * *", :delay=>30, :next_time=>time, :timezone=>'UTC')
+    s01 = sc.add('sched01', 't01', :cron=>"0 * * * *", :delay=>30, :next_time=>time, :timezone=>'UTC')
 
-    t01 = @sc.poll(:alive_time=>86400, :now=>time)
+    t01 = sc.poll(:alive_time=>86400, :now=>time)
     t01.should == nil
 
-    t02 = @sc.poll(:alive_time=>86400, :now=>time+30)
+    t02 = sc.poll(:alive_time=>86400, :now=>time+30)
     t02.class.should == Task
     t02.key.should == 'sched01'
     t02.type.should == 't01'
-    t02.scheduled_time.should == Time.at(time).utc
+    t02.scheduled_time.should == time
     t02.delay.should == 30
 
     t02.finish!
 
-    t03 = @sc.poll(:alive_time=>86400, :now=>time+3600)
+    t03 = sc.poll(:alive_time=>86400, :now=>time+3600)
     t03.should == nil
 
-    t04 = @sc.poll(:alive_time=>86400, :now=>time+3630)
+    t04 = sc.poll(:alive_time=>86400, :now=>time+3630)
     t04.class.should == Task
     t04.key.should == 'sched01'
     t04.type.should == 't01'
-    t04.scheduled_time.should == Time.at(time+3600).utc
+    t04.scheduled_time.should == time+3600
     t04.delay.should == 30
   end
 
   it 'invalid cron format' do
     lambda {
-      @sc.add('sched01', 't01', :cron=>'???')
+      sc.add('sched01', 't01', :cron=>'???')
     }.should raise_error ArgumentError
 
     lambda {
-      @sc.add('sched01', 't01', :cron=>'* * * * * *')
+      sc.add('sched01', 't01', :cron=>'* * * * * *')
     }.should raise_error ArgumentError
   end
 
   it 'fail duplicated add' do
-    @sc.add('sched01', 't01', :cron=>"0 * * * *")
+    sc.add('sched01', 't01', :cron=>"0 * * * *")
     lambda {
-      @sc.add('sched01', 't01', :cron=>"0 * * * *")
+      sc.add('sched01', 't01', :cron=>"0 * * * *")
     }.should raise_error AlreadyExistsError
 
-    @sc['sched01'].delete!
+    sc['sched01'].delete!
 
-    @sc.add('sched01', 't01', :cron=>"0 * * * *")
+    sc.add('sched01', 't01', :cron=>"0 * * * *")
   end
 
   it 'list' do
     time = 1323820800  # 2011-12-14 00:00:00 UTC
 
-    @sc.add('sched01', 't01', :cron=>"0 * * * *", :next_time=>time, :delay=>1)
-    @sc.add('sched02', 't02', :cron=>"0 * * * *", :next_time=>time, :delay=>2)
-    @sc.add('sched03', 't03', :cron=>"0 * * * *", :next_time=>time, :delay=>3, :next_run_time=>time+3600)
+    sc.add('sched01', 't01', :cron=>"0 * * * *", :next_time=>time, :delay=>1)
+    sc.add('sched02', 't02', :cron=>"0 * * * *", :next_time=>time, :delay=>2)
+    sc.add('sched03', 't03', :cron=>"0 * * * *", :next_time=>time, :delay=>3, :next_run_time=>time+3600)
 
     a = []
-    @sc.list {|s|
+    sc.list {|s|
       a << s
     }
     a.sort_by! {|s| s.key }
@@ -147,8 +147,8 @@ describe ScheduleCollection do
     s01.type.should == 't01'
     s01.cron.should == '0 * * * *'
     s01.delay.should == 1
-    s01.next_time.should == Time.at(time).utc
-    s01.next_run_time.should == Time.at(time+1).utc
+    s01.next_time.should == time
+    s01.next_run_time.should == time+1
 
     s02 = a.shift
     s02.class.should == ScheduleWithMetadata
@@ -156,8 +156,8 @@ describe ScheduleCollection do
     s02.type.should == 't02'
     s02.cron.should == '0 * * * *'
     s02.delay.should == 2
-    s02.next_time.should == Time.at(time).utc
-    s02.next_run_time.should == Time.at(time+2).utc
+    s02.next_time.should == time
+    s02.next_run_time.should == time+2
 
     s03 = a.shift
     s03.class.should == ScheduleWithMetadata
@@ -165,8 +165,8 @@ describe ScheduleCollection do
     s03.type.should == 't03'
     s03.cron.should == '0 * * * *'
     s03.delay.should == 3
-    s03.next_time.should == Time.at(time).utc
-    s03.next_run_time.should == Time.at(time+3600).utc
+    s03.next_time.should == time
+    s03.next_run_time.should == time+3600
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: perfectsched
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-23 00:00:00.000000000Z
+date: 2012-06-25 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cron-spec
-  requirement: &70253331590900 !ruby/object:Gem::Requirement
+  requirement: &70165887081720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -24,10 +24,10 @@ dependencies:
         version: 0.1.2
   type: :runtime
   prerelease: false
-  version_requirements: *70253331590900
+  version_requirements: *70165887081720
 - !ruby/object:Gem::Dependency
   name: sequel
-  requirement: &70253331589420 !ruby/object:Gem::Requirement
+  requirement: &70165887079760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -35,10 +35,10 @@ dependencies:
         version: 3.26.0
   type: :runtime
   prerelease: false
-  version_requirements: *70253331589420
+  version_requirements: *70165887079760
 - !ruby/object:Gem::Dependency
   name: tzinfo
-  requirement: &70253331588280 !ruby/object:Gem::Requirement
+  requirement: &70165887078760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -46,10 +46,10 @@ dependencies:
         version: 0.3.29
   type: :runtime
   prerelease: false
-  version_requirements: *70253331588280
+  version_requirements: *70165887078760
 - !ruby/object:Gem::Dependency
   name: perfectqueue
-  requirement: &70253331587400 !ruby/object:Gem::Requirement
+  requirement: &70165887077360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -57,10 +57,10 @@ dependencies:
         version: 0.8.0
   type: :runtime
   prerelease: false
-  version_requirements: *70253331587400
+  version_requirements: *70165887077360
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70253331576220 !ruby/object:Gem::Requirement
+  requirement: &70165887076440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -68,10 +68,10 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *70253331576220
+  version_requirements: *70165887076440
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70253331573960 !ruby/object:Gem::Requirement
+  requirement: &70165887075580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -79,10 +79,10 @@ dependencies:
         version: 2.10.0
   type: :development
   prerelease: false
-  version_requirements: *70253331573960
+  version_requirements: *70165887075580
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70253331573320 !ruby/object:Gem::Requirement
+  requirement: &70165887074140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -90,10 +90,10 @@ dependencies:
         version: 0.5.4
   type: :development
   prerelease: false
-  version_requirements: *70253331573320
+  version_requirements: *70165887074140
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70253331572160 !ruby/object:Gem::Requirement
+  requirement: &70165887069320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -101,7 +101,7 @@ dependencies:
         version: 1.3.3
   type: :development
   prerelease: false
-  version_requirements: *70253331572160
+  version_requirements: *70165887069320
 description: Highly available distributed cron built on RDBMS
 email: frsyuki@gmail.com
 executables:
@@ -135,6 +135,7 @@ files:
 - lib/perfectsched/version.rb
 - lib/perfectsched/worker.rb
 - perfectsched.gemspec
+- spec/rdb_compat_backend_spec.rb
 - spec/schedule_collection_spec.rb
 - spec/spec_helper.rb
 - spec/worker_spec.rb
@@ -163,6 +164,7 @@ signing_key:
 specification_version: 3
 summary: Highly available distributed cron built on RDBMS
 test_files:
+- spec/rdb_compat_backend_spec.rb
 - spec/schedule_collection_spec.rb
 - spec/spec_helper.rb
 - spec/worker_spec.rb