simpler_workflow 0.1.2 → 0.1.3

data/README.md

@@ -169,6 +169,17 @@ You can also define similar hooks for events using the following methods:
 * ```on_activity_completed``` is called when an activity completes and SWF reports back to the decision loop.
 * ```on_activity_failed``` is called when an activity reports a failure to SWF.
 
+## Workflow and Activity Versioning
+
+All workflow types and activity types are versioned under SWF. This allows an organization to release new versions of a workflow or activity
+as they are updated and allow workflows to complete under the old version number if need be.
+
+Here are a few recommendations on when to change the version of a workflow or activity when using SimplerWorkflow:
+
+1. You need to bump the version when you are changing the defaults associated with an activity or workflow. These are set using the ```default_``` methods. The defaults are commnicated to AWS when the workflow or activity is registered. It does not get updated when they are changed within the code.
+2. You may want to bump a version if you have work in progress under an existing workflow and you need to introduce changes for new work. You will need to keep the older activity and or workflow around while it completes.
+3. You do not need to bump the version when you change the work performed by the activity or the decision loop itself. This is code that is directly managed by SimplerWorkflow and isn't communicated to AWS. This only works if you do not want previous workflows to finish using the previous version of the code though.
+
 ## Contributing
 
 We welcome all kinds of contributions. This include code, fixes, issues, documentation, tests... Here's how you can contribute:

data/lib/simpler_workflow/activity.rb

@@ -6,9 +6,9 @@ module SimplerWorkflow
       Activity.activities[[name, version]] ||= begin
         default_options = {
           :default_task_list => name,
-          :default_task_start_to_close_timeout => 1 * 60 * 60,
+          :default_task_start_to_close_timeout => 5 * 60,
           :default_task_schedule_to_start_timeout => 5 * 60,
-          :default_task_schedule_to_close_timeout => 1 * 60 * 60,
+          :default_task_schedule_to_close_timeout => 10 * 60,
           :default_task_heartbeat_timeout => :none
         }
         @options = default_options.merge(options)

data/lib/simpler_workflow/domain.rb

@@ -4,18 +4,16 @@ module SimplerWorkflow
       domain_name = domain_name.to_s
       @domain = swf.domains[domain_name]
       unless swf.domains.include?(@domain)
-        @domain = swf.domains.create(domain_name, retention)
+        @domain = swf.domains.create(domain_name, retention) rescue @domain
       end
 
-      self.instance_eval(&block) if block
-
-      self
+      self.instance_eval(&block) if block_given?
     end
 
     def Domain.domains(domain_name, &block)
       @domains ||= {}
       @domains[domain_name] ||= Domain.new(domain_name)
-      @domains[domain_name].instance_eval(&block) if block
+      @domains[domain_name].instance_eval(&block) if block_given?
       @domains[domain_name]
     end
 

data/lib/simpler_workflow/version.rb

@@ -1,3 +1,3 @@
 module SimplerWorkflow
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/lib/simpler_workflow/workflow.rb

@@ -7,7 +7,7 @@ module SimplerWorkflow
         default_options = {
           :default_task_list => name,
           :default_task_start_to_close_timeout => 2 * 60,
-          :default_execution_start_to_close_timeout => 1 * 24 * 60 * 60,
+          :default_execution_start_to_close_timeout => 2 * 60,
           :default_child_policy => :terminate
         }
         @options = default_options.merge(options)
@@ -39,6 +39,8 @@ module SimplerWorkflow
             activity_completed(decision_task, event)
           when 'ActivityTaskFailed'
             activity_failed(decision_task, event)
+          when 'ActivityTaskTimedOut'
+            activity_timed_out(decision_task, event)
           end
         end
       end
@@ -95,6 +97,21 @@ module SimplerWorkflow
       end
     end
 
+    def activity_timed_out(decision_task, event)
+      logger.info("Activity timed out.")
+      if @on_activity_timed_out && @on_activity_timed_out.respond_to?(:call)
+        @on_activity_timed_out.call(decision_task, event)
+      else
+        case event.attributes.timeoutType
+        when 'START_TO_CLOSE', 'SCHEDULE_TO_START', 'SCHEDULE_TO_CLOSE'
+          logger.info("Retrying activity #{last_activity(decision_task, event).name} #{last_activity(decision_task, event).version} due to timeout.")
+          decision_task.schedule_activity_task last_activity(decision_task, event), :input => last_input(decision_task, event)
+        when 'HEARTBEAT'
+          decision_task.cancel_workflow_execution
+        end
+      end
+    end
+
     def start_workflow(input, options = {})
       options[:input] = input
       domain.workflow_types[name.to_s, version].start_execution(options)
@@ -112,6 +129,10 @@ module SimplerWorkflow
       @on_activity_failed = block
     end
 
+    def on_activity_timed_out(&block)
+      @on_activity_timed_out = block
+    end
+
     def self.[](name, version)
       workflows[[name, version]]
     end

data/simpler_workflow.gemspec

@@ -15,7 +15,8 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = SimplerWorkflow::VERSION
 
-  gem.add_dependency 'aws-sdk', '~> 1.4.0'
+  gem.add_dependency 'aws-sdk', '~> 1.5.0'
   gem.add_dependency 'map'
+  gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec'
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: simpler_workflow
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 29
   prerelease: 
   segments: 
   - 0
   - 1
-  - 2
-  version: 0.1.2
+  - 3
+  version: 0.1.3
 platform: ruby
 authors: 
 - Frederic Jean
@@ -15,28 +15,26 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-04-27 00:00:00 Z
+date: 2012-05-24 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: aws-sdk
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 7
+        hash: 3
         segments: 
         - 1
-        - 4
+        - 5
         - 0
-        version: 1.4.0
+        version: 1.5.0
+  name: aws-sdk
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: map
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -45,12 +43,26 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  name: map
   type: :runtime
-  version_requirements: *id002
+  prerelease: false
+  requirement: *id002
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: rake
+  type: :development
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -59,8 +71,10 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  name: rspec
   type: :development
-  version_requirements: *id003
+  prerelease: false
+  requirement: *id004
 description: A wrapper around Amazon's Simple Workflow Service
 email: 
 - fred@snugghome.com