ruote-couch 2.1.7 → 2.1.8

data/CHANGELOG.txt

@@ -2,6 +2,11 @@
 = ruote-couch - CHANGELOG.txt
 
 
+== ruote-couch 2.1.8    released 2010/03/15
+
+- 'prefix' and :prefix as configuration parameter
+
+
 == ruote-couch 2.1.7    released 2010/02/15
 
 - enabled Ruote::StorageParticipant#query(criteria)

data/Rakefile

@@ -33,7 +33,7 @@ CouchDB storage for ruote 2.1 (ruby workflow engine)
   gem.test_file = 'test/test.rb'
 
   gem.add_dependency 'ruote', ">= #{Ruote::Couch::VERSION}"
-  gem.add_dependency 'rufus-jig', '>= 0.1.13'
+  gem.add_dependency 'rufus-jig', '>= 0.1.15'
   gem.add_development_dependency 'yard'
   gem.add_development_dependency 'jeweler'
 

data/TODO.txt

@@ -1,8 +1,13 @@
 
+[x] ct_2 --couch says put(gone) is returning nil... :(
+[o] ?feed=longpool&heartbeat=x (parallel thread or smarter scheduler ?)
+
 [ ] view for ats
 [ ] view for crons
 
 [ ] jig / r-couch should not rely on exceptions
 
-[x] ct_2 --couch says put(gone) is returning nil... :(
+[ ] re-run suite with --patron
+[ ] run suite with --net
+[ ] run suite with --em
 

data/lib/ruote/couch/database.rb

@@ -39,7 +39,11 @@ module Ruote::Couch
 
     def initialize (host, port, type, name, re_put_ok=true)
 
-      @couch = Rufus::Jig::Couch.new(host, port, name, :re_put_ok => re_put_ok)
+      opts = { :re_put_ok => re_put_ok }
+      #opts[:timeout] = TODO
+
+      @couch = Rufus::Jig::Couch.new(host, port, name, opts)
+
       @couch.put('.') unless @couch.get('.')
 
       @type = type
@@ -58,9 +62,9 @@ module Ruote::Couch
         # direct "create then apply" chaining
     end
 
-    def get (key)
+    def get (key, opts={})
 
-      @couch.get(key)
+      @couch.get(key, opts)
     end
 
     def delete (doc)

data/lib/ruote/couch/storage.rb

@@ -45,9 +45,14 @@ module Couch
 
     # Hooks the storage to a CouchDB instance.
     #
-    # The main option is 'prefix', which indicate which prefix should be
+    # The main option is 'couch_prefix', which indicate which prefix should be
     # added to all the database names used by this storage.
     #
+    # The option 'couch_timeout' is used what is the get_msgs timeout. This
+    # is the long-polling timeout. For functional test it is set to two seconds
+    # but for a production system, something like 10 minutes or 8 hours might
+    # be OK.
+    #
     def initialize (host, port, options={})
 
       @host = host
@@ -55,9 +60,12 @@ module Couch
 
       @options = options
 
-      @prefix = options['prefix'] || ''
+      @prefix = options['couch_prefix'] || options['prefix'] || ''
       @prefix = "#{@prefix}_" if @prefix.size > 0
 
+      @zeroes = 21 # maybe make it an option
+      @timeout = options['couch_timeout'] || 60
+
       @dbs = {}
 
       %w[ msgs schedules configurations variables ].each do |type|
@@ -76,6 +84,8 @@ module Couch
         @host, @port, 'workitems', "#{@prefix}ruote_workitems")
 
       put_configuration
+
+      @zero_msgs_offset = @zeroes
     end
 
     def put (doc, opts={})
@@ -119,6 +129,8 @@ module Couch
 
     def shutdown
 
+      @poller.kill if @poller
+
       @dbs.values.each { |db| db.shutdown }
     end
 
@@ -161,6 +173,63 @@ module Couch
       @dbs['workitems'].query_workitems(criteria)
     end
 
+    # Overwriting Ruote::StorageBase.get_msgs
+    #
+    # Taking care of using long-polling
+    # (http://wiki.apache.org/couchdb/HTTP_database_API) when possible
+    #
+    def get_msgs
+
+      if @zero_msgs_offset > 0
+
+        msgs = get_many(
+          'msgs', nil, :limit => 300
+        ).sort { |a, b|
+          a['put_at'] <=> b['put_at']
+        }
+
+        @zero_msgs_offset = @zero_msgs_offset - 1 if msgs.size == 0
+        return msgs
+      end
+
+      @zero_msgs_offset = @zeroes
+
+      schedules = get_many('schedules')
+
+      next_at = schedules.collect { |s| s['at'] }.sort.first
+      delta = next_at ? (Time.parse(next_at) - Time.now) : nil
+
+      #p [ delta, @timeout ]
+
+      return [] if delta && delta < 5.0
+
+      last_seq = @dbs['msgs'].get('_changes')['last_seq']
+
+      timeout = delta ? delta - 3.0 : -1.0
+      timeout = (timeout < 0.0 || timeout > @timeout) ? @timeout : timeout
+
+      #p [ Time.now, :last_seq, last_seq, :timeout, timeout ]
+
+      begin
+
+        @poller = Thread.current
+
+        @dbs['msgs'].get(
+          "_changes?feed=longpoll&heartbeat=60000&since=#{last_seq}",
+          :timeout => timeout)
+            # block until there is a change in the 'msgs' db
+
+      rescue Exception => e
+      #rescue Rufus::Jig::TimeoutError => te
+      #  p [ :caught, e.class ]
+      #  e.backtrace.each { |l| puts l }
+      ensure
+        @poller = nil
+      end
+
+      []
+    end
+
     protected
 
     def put_configuration

data/lib/ruote/couch/version.rb

@@ -1,7 +1,7 @@
 
 module Ruote
 module Couch
-  VERSION = '2.1.7'
+  VERSION = '2.1.8'
 end
 end
 

data/ruote-couch.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ruote-couch}
-  s.version = "2.1.7"
+  s.version = "2.1.8"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["John Mettraux"]
-  s.date = %q{2010-02-15}
+  s.date = %q{2010-03-15}
   s.description = %q{CouchDB storage for ruote 2.1 (ruby workflow engine)}
   s.email = %q{jmettraux@gmail.com}
   s.extra_rdoc_files = [
@@ -28,6 +28,9 @@ Gem::Specification.new do |s|
      "lib/ruote/couch/storage.rb",
      "lib/ruote/couch/version.rb",
      "ruote-couch.gemspec",
+     "test/functional/base.rb",
+     "test/functional/ft_0_long_polling.rb",
+     "test/functional/test.rb",
      "test/integration_connection.rb",
      "test/test.rb"
   ]
@@ -35,7 +38,7 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{ruote}
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.6}
   s.summary = %q{CouchDB storage for ruote 2.1}
   s.test_files = [
     "test/test.rb"
@@ -46,19 +49,19 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<ruote>, [">= 2.1.7"])
-      s.add_runtime_dependency(%q<rufus-jig>, [">= 0.1.13"])
+      s.add_runtime_dependency(%q<ruote>, [">= 2.1.8"])
+      s.add_runtime_dependency(%q<rufus-jig>, [">= 0.1.15"])
       s.add_development_dependency(%q<yard>, [">= 0"])
       s.add_development_dependency(%q<jeweler>, [">= 0"])
     else
-      s.add_dependency(%q<ruote>, [">= 2.1.7"])
-      s.add_dependency(%q<rufus-jig>, [">= 0.1.13"])
+      s.add_dependency(%q<ruote>, [">= 2.1.8"])
+      s.add_dependency(%q<rufus-jig>, [">= 0.1.15"])
       s.add_dependency(%q<yard>, [">= 0"])
       s.add_dependency(%q<jeweler>, [">= 0"])
     end
   else
-    s.add_dependency(%q<ruote>, [">= 2.1.7"])
-    s.add_dependency(%q<rufus-jig>, [">= 0.1.13"])
+    s.add_dependency(%q<ruote>, [">= 2.1.8"])
+    s.add_dependency(%q<rufus-jig>, [">= 0.1.15"])
     s.add_dependency(%q<yard>, [">= 0"])
     s.add_dependency(%q<jeweler>, [">= 0"])
   end

data/test/functional/base.rb

@@ -0,0 +1,15 @@
+
+$:.unshift(File.join(File.dirname(__FILE__), '..', '..', '..', 'ruote', 'lib'))
+$:.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
+
+require 'test/unit'
+
+require 'rubygems'
+require 'yajl'
+
+require 'patron' unless ARGV.include?('--net')
+  # TODO : provide for em-http-request
+
+require 'ruote'
+require 'ruote/couch'
+

data/test/functional/ft_0_long_polling.rb

@@ -0,0 +1,66 @@
+
+#
+# testing ruote-couch
+#
+# Fri Mar 12 17:15:27 JST 2010
+#
+
+require File.join(File.dirname(__FILE__), 'base')
+
+
+class FtLongPollingTest < Test::Unit::TestCase
+
+  def setup
+
+    @engine =
+      Ruote::Engine.new(
+        Ruote::Worker.new(
+          Ruote::Couch::CouchStorage.new(
+            '127.0.0.1',
+            5984,
+            'couch_prefix' => 'test', 'couch_timeout' => 2 * 60)))
+  end
+
+  def teardown
+
+    @engine.shutdown
+    @engine.context.storage.purge!
+  end
+
+  def test_wait
+
+    trace = []
+
+    @engine.register_participant '.+' do |workitem|
+      trace << Time.now
+    end
+
+    pdef = Ruote.process_definition do
+      sequence do
+        alpha
+        wait '3m'
+        bravo
+      end
+    end
+
+    @engine.context.logger.noisy = true
+
+    wfid = @engine.launch(pdef)
+
+    sleep 15
+    assert_equal 1, trace.size
+
+    assert_not_nil @engine.context.storage.instance_variable_get(:@poller)
+
+    @engine.wait_for(wfid)
+
+    p trace
+
+    assert_equal 2, trace.size
+
+    delta = trace.last - trace.first
+
+    assert_in_delta 3.0 * 60, delta, 1.0
+  end
+end
+

data/test/functional/test.rb

@@ -0,0 +1,26 @@
+
+#
+# testing ruote-couch
+#
+# Fri Mar 12 17:19:01 JST 2010
+#
+
+def l (t)
+
+  if ARGV.include?('--split')
+
+    _v = ARGV.include?('-v') ? ' -v' : ' '
+
+    puts
+    puts "=== #{t} :"
+    puts `ruby#{_v} #{t} #{ARGV.join(' ')}`
+
+    exit $?.exitstatus if $?.exitstatus != 0
+  else
+    load(t)
+  end
+end
+
+Dir.glob(File.join(File.dirname(__FILE__), 'ft_*.rb')).sort.each { |t| l(t) }
+  # functional tests targetting features rather than expressions
+

data/test/integration_connection.rb

@@ -10,7 +10,7 @@ require 'rufus-json'
 Rufus::Json.detect_backend
 
 begin
-  require 'patron'
+  require 'patron' unless ARGV.include?('--net')
 rescue LoadError
   # then use 'net/http'
 end
@@ -23,6 +23,8 @@ def new_storage (opts)
   opts ||= {}
 
   Ruote::Couch::CouchStorage.new(
-    '127.0.0.1', 5984, opts.merge!('prefix' => 'test'))
+    '127.0.0.1',
+    5984,
+    opts.merge!('couch_prefix' => 'test', 'couch_timeout' => 1))
 end
 

data/test/test.rb

@@ -1,7 +1,3 @@
 
-puts %{
-  ~~~
-  please read the README about how to run ruote-dm tests
-  ~~~
-}
+require File.join(File.dirname(__FILE__), 'functional', 'test.rb')
 

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: ruote-couch
 version: !ruby/object:Gem::Version 
-  version: 2.1.7
+  prerelease: false
+  segments: 
+  - 2
+  - 1
+  - 8
+  version: 2.1.8
 platform: ruby
 authors: 
 - John Mettraux
@@ -9,49 +14,61 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-15 00:00:00 +09:00
+date: 2010-03-15 00:00:00 +09:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: ruote
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 2.1.7
-    version: 
+        segments: 
+        - 2
+        - 1
+        - 8
+        version: 2.1.8
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: rufus-jig
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.1.13
-    version: 
+        segments: 
+        - 0
+        - 1
+        - 15
+        version: 0.1.15
+  type: :runtime
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: yard
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: jeweler
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id004
 description: CouchDB storage for ruote 2.1 (ruby workflow engine)
 email: jmettraux@gmail.com
 executables: []
@@ -73,6 +90,9 @@ files:
 - lib/ruote/couch/storage.rb
 - lib/ruote/couch/version.rb
 - ruote-couch.gemspec
+- test/functional/base.rb
+- test/functional/ft_0_long_polling.rb
+- test/functional/test.rb
 - test/integration_connection.rb
 - test/test.rb
 has_rdoc: true
@@ -88,18 +108,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: ruote
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: CouchDB storage for ruote 2.1