ntswf 1.0.5 → 1.0.6

data/README.md

@@ -9,6 +9,7 @@ AWS Simple Workflow.
 [![Gem Version](https://badge.fury.io/rb/ntswf.png)](http://badge.fury.io/rb/ntswf)
 [![Code Climate](https://codeclimate.com/github/infopark/ntswf.png)](https://codeclimate.com/github/infopark/ntswf)
 [![Dependency Status](https://gemnasium.com/infopark/ntswf.png)](https://gemnasium.com/infopark/ntswf)
+[![Build Status](https://travis-ci.org/infopark/ntswf.png)](https://travis-ci.org/infopark/ntswf)
 
 Usage
 -----
@@ -69,4 +70,4 @@ See {Ntswf::Utils}
 
 License
 -------
-[LPGLv3](http://www.gnu.org/licenses/lgpl-3.0.html)
+[LPGLv3](http://www.gnu.org/licenses/lgpl-3.0.html)

data/lib/ntswf/client.rb

@@ -10,12 +10,18 @@ module Ntswf
     # The options configure the control flow of the task.
     # Excluding *:execution_id* they will be stored in the *input* argument of the task as JSON.
     # @param options [Hash] The task's options. Keys with special meaning:
-    # @option options [String] :execution_id Mandatory workflow ID suffix, allowed IDs are documented at docs.amazonwebservices.com (WorkflowId Property)
-    # @option options [Numeric] :interval Optional, in seconds. Enforces periodic re-run of the task, even in case of failure
+    # @option options [String] :execution_id
+    #   Mandatory workflow ID suffix, allowed IDs are documented at docs.amazonwebservices.com
+    #   (WorkflowId Property)
+    # @option options [Numeric] :interval
+    #   Optional, in seconds. Enforces periodic start of
+    #   new executions, even in case of failure
     # @option options [String] :name Identifies the kind of task for the executing unit
     # @option options [Hash] :params Custom task parameters passed on to the executing unit
-    # @option options [String] :unit The executing unit's key, a corresponding activity task list must be configured
-    # @option options [Numeric] :version Optional minimum version of the client. The task may be rescheduled by older clients.
+    # @option options [String] :unit
+    #   The executing unit's key, a corresponding activity task list must be configured
+    # @option options [Numeric] :version
+    #   Optional minimum version of the client. The task may be rescheduled by older clients.
     # @return [AWS::SimpleWorkflow::WorkflowExecution]
     # @raise [AWS::SimpleWorkflow::Errors::WorkflowExecutionAlreadyStartedFault]
     def start_execution(options)

data/lib/ntswf/decision_worker.rb

@@ -11,7 +11,9 @@ module Ntswf
     # reason:: reschedule if {RETRY}
     # result:: Interpreted as {Hash}, see below for keys
     # Result keys
-    # :seconds_until_retry:: Planned reschedule after task completion
+    # :seconds_until_retry::
+    # Planned re-schedule after task completion. Please note that
+    # given an *:interval* option the behaviour of this key is undefined
     def process_decision_task
       announce("polling for decision task #{decision_task_list}")
       domain.decision_tasks.poll_for_single_task(decision_task_list) do |task|
@@ -33,17 +35,7 @@ module Ntswf
       when 'WorkflowExecutionStarted'
         schedule(task, event)
       when 'TimerFired'
-        start_event = task.events.first
-        keys = [
-          :child_policy,
-          :execution_start_to_close_timeout,
-          :input,
-          :tag_list,
-          :task_list,
-          :task_start_to_close_timeout,
-        ]
-        attributes = start_event.attributes.to_h.keep_if {|k| keys.include? k}
-        task.continue_as_new_workflow_execution(attributes)
+        retry_or_continue_as_new(task, task.events.first)
       when 'ActivityTaskCompleted'
         result = parse_result(event.attributes.result)
         start_timer(task, result["seconds_until_retry"]) or task.complete_workflow_execution(
@@ -53,7 +45,7 @@ module Ntswf
           schedule(task, task.events.first)
         else
           start_timer(task) or task.fail_workflow_execution(
-              event.attributes.to_h.slice(:details, :reason))
+              event.attributes.to_h.keep_if {|k| [:details, :reason].include? k})
         end
       when 'ActivityTaskTimedOut'
         notify("Timeout in Simple Workflow. Possible cause: all workers busy",
@@ -72,6 +64,24 @@ module Ntswf
       interval
     end
 
+    def retry_or_continue_as_new(task, original_event)
+      options = parse_input(original_event.attributes.input)
+      if options['interval']
+        keys = [
+          :child_policy,
+          :execution_start_to_close_timeout,
+          :input,
+          :tag_list,
+          :task_list,
+          :task_start_to_close_timeout,
+        ]
+        attributes = original_event.attributes.to_h.keep_if {|k| keys.include? k}
+        task.continue_as_new_workflow_execution(attributes)
+      else
+        schedule(task, original_event)
+      end
+    end
+
     def schedule(task, data_providing_event)
       input = data_providing_event.attributes.input
       options = parse_input(input)

data/spec/decision_worker_spec.rb

@@ -0,0 +1,214 @@
+require "ntswf"
+require "json"
+
+describe Ntswf::DecisionWorker do
+  class Worker
+    include Ntswf::DecisionWorker
+  end
+
+  let(:atl_config) { { "test" => "atl" } }
+  let(:dtl_config) { "dtl" }
+  let(:unit) { "testt" }
+  let(:config) { { unit: unit, decision_task_list: dtl_config, activity_task_lists: atl_config } }
+  let(:worker) { Worker.new config }
+
+  let(:options) { {} }
+  let(:input) { options.merge('params' => {'test' => 'value'}).to_json }
+  let(:reason) { nil }
+  let(:result) { nil }
+  let(:attributes_hash) { { input: input, reason: reason, result: result } }
+  let(:attributes) { double("Attributes", attributes_hash.merge(to_h: attributes_hash)) }
+  let(:workflow_execution) { double("Workflow Execution", workflow_type: double(name: 'test-wf')) }
+  let(:event) do
+    double("Event", attributes: attributes, event_type: event_type, workflow_execution:
+        workflow_execution)
+  end
+  let(:task) { double("Task", new_events: [event], events: [event]).as_null_object }
+
+  before { worker.stub(announce: nil, log: nil, activity_type: "test_activity") }
+
+  describe "processing a decision task" do
+    it "should only query for the configured task list" do
+      AWS::SimpleWorkflow::DecisionTaskCollection.any_instance.
+          should_receive(:poll_for_single_task).with("dtl")
+      worker.process_decision_task
+    end
+
+    describe "handling event" do
+      before do
+        AWS::SimpleWorkflow::DecisionTaskCollection.any_instance.stub(
+            :poll_for_single_task).and_yield(task)
+      end
+
+      describe "ActivityTaskTimedOut" do
+        let(:event_type) {"ActivityTaskTimedOut"}
+
+        it "should cancel the execution" do
+          task.should_receive :cancel_workflow_execution
+          worker.process_decision_task
+        end
+
+        it "should notify" do
+          worker.should_receive :notify
+          worker.process_decision_task
+        end
+      end
+
+      describe "ActivityTaskCompleted" do
+        let(:event_type) {"ActivityTaskCompleted"}
+
+        context "when requesting re-execution per seconds_until_retry" do
+          let(:result) { {seconds_until_retry: 321}.to_json }
+
+          it "schedules a timer event" do
+            task.should_receive(:start_timer).with(321)
+            worker.process_decision_task
+          end
+        end
+
+        context "when not requesting re-execution" do
+          let(:result) { {outcome: "some_data"}.to_json }
+
+          it "schedules a workflow completed event" do
+            task.should_receive(:complete_workflow_execution).with(result: result)
+            worker.process_decision_task
+          end
+        end
+      end
+
+      describe "WorkflowExecutionStarted" do
+        let(:event_type) {"WorkflowExecutionStarted"}
+
+        it "should schedule an activity task avoiding defaults" do
+          task.should_receive(:schedule_activity_task).with("test_activity", hash_including(
+            heartbeat_timeout: :none,
+            input: anything,
+            schedule_to_close_timeout: anything,
+            schedule_to_start_timeout: anything,
+            start_to_close_timeout: anything,
+            task_list: "atl",
+          ))
+          worker.process_decision_task
+        end
+
+        context "given no app in charge" do
+          let(:input) { ["legacy_stuff", {}].to_json }
+
+          it "should schedule an activity task for a guessed task list" do
+            task.should_receive(:schedule_activity_task).with("test_activity", hash_including(
+                task_list: "atl"))
+            worker.process_decision_task
+          end
+        end
+      end
+
+      describe "ActivityTaskFailed" do
+        let(:event_type) {"ActivityTaskFailed"}
+
+        context "without retry" do
+          let(:reason) { "Error" }
+
+          it "should fail" do
+            task.should_receive(:fail_workflow_execution)
+            worker.process_decision_task
+          end
+
+          it "should not re-schedule the task" do
+            task.should_not_receive(:schedule_activity_task)
+            worker.process_decision_task
+          end
+        end
+
+        context "with retry" do
+          let(:reason) { "Retry" }
+
+          it "should not fail" do
+            task.should_not_receive(:fail_workflow_execution)
+            worker.process_decision_task
+          end
+
+          it "should re-schedule the task" do
+            task.should_receive(:schedule_activity_task).with("test_activity", hash_including(
+              heartbeat_timeout: :none,
+              input: input,
+              schedule_to_close_timeout: anything,
+              schedule_to_start_timeout: anything,
+              start_to_close_timeout: anything,
+              task_list: "atl",
+            ))
+            worker.process_decision_task
+          end
+        end
+      end
+
+      describe "TimerFired" do
+        let(:event_type) {"TimerFired"}
+        let(:attributes_hash) do
+          {
+            child_policy: 1,
+            execution_start_to_close_timeout: 2,
+            input: input,
+            tag_list: ["tag"],
+            task_list: "list",
+            task_start_to_close_timeout: 3,
+          }
+        end
+
+        context "given an interval option" do
+          let(:options) { {interval: 1234} }
+
+          it "should continue wiht mandatory attributes" do
+            task.should_receive(:continue_as_new_workflow_execution).with(hash_including(
+                attributes_hash))
+            worker.process_decision_task
+          end
+        end
+
+        context "given no interval" do
+          it "should re-schedule, assuming seconds_until_retry was set" do
+            task.should_receive(:schedule_activity_task).with("test_activity", hash_including(
+              heartbeat_timeout: :none,
+              input: input,
+              schedule_to_close_timeout: anything,
+              schedule_to_start_timeout: anything,
+              start_to_close_timeout: anything,
+              task_list: "atl",
+            ))
+            worker.process_decision_task
+          end
+        end
+      end
+
+      context "given an interval" do
+        let(:options) { {interval: 1234} }
+
+        events = %w(
+          ActivityTaskCompleted
+          ActivityTaskFailed
+          ActivityTaskTimedOut
+        )
+
+        events.each do |event|
+          describe event do
+            let(:event_type) { event }
+
+            it "should start a timer" do
+              task.should_receive(:start_timer).with(1234)
+              worker.process_decision_task
+            end
+          end
+        end
+
+        describe "string options for compatibility" do
+          let(:event_type) { "ActivityTaskCompleted" }
+          let(:input) { ["interval", {}].to_json }
+
+          it "should not be interpreted" do
+            task.should_not_receive :start_timer
+            worker.process_decision_task
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ntswf
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-22 00:00:00.000000000 Z
+date: 2014-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -58,6 +58,7 @@ files:
 - lib/ntswf/client.rb
 - lib/ntswf/base.rb
 - lib/ntswf.rb
+- spec/decision_worker_spec.rb
 - spec/activity_worker_spec.rb
 homepage: https://github.com/infopark/ntswf
 licenses:
@@ -85,5 +86,6 @@ signing_key:
 specification_version: 3
 summary: Not That Simple Workflow
 test_files:
+- spec/decision_worker_spec.rb
 - spec/activity_worker_spec.rb
 has_rdoc: