aws-flow 2.2.1 → 2.2.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    N2I5YWE5Y2IxMWMzY2E1YzFkN2ExNjJmMWZmZDUyZDYzMzBhYmE3OA==
+    ZDI2ZDNmZmEwMDNiODkwZWY0ODBkZDI0ZDM1OTFjZjBjZGU4YzJjZg==
   data.tar.gz: !binary |-
-    ZTRkMjE3NWU1ZmZiNTNmN2I0YWI1M2Y5MGIyZDY5N2I0MTlkMzU1MA==
+    MzExMWQ1YjhkZjZmZWVlMTQ4MDU4NTFmNjkxYjUwNTVjMTU5YTIxMA==
 SHA512:
   metadata.gz: !binary |-
-    MWQwOWRkNGM2MGU3YjJkYTYzNzE2NGZhZTYxM2ZiYTMwM2YzNzBjODRlNWE5
-    NTUwMDgwY2Y0OGNmMDE4MzVjMWRiOTc0NzRhZGNmMTQ3YTFjMTAxOTA0MDYx
-    ODQ3MThkZTgzNzNhYmM2MDdmNjA4YjcxNDhkYTJkZWVkMTBlMzE=
+    NWRkNTIyNjk3ZmNkM2E4NWNjYTU3NTIyNTE0NjhjOGEzZjY5YjAwMDcwMTRj
+    YWNhOTNlM2E3M2E4ZDdhNGYzNGY4OTU4MjljMjBhOTIwMjIwNGNlYWVkM2Y0
+    MzVjODgyYjcyYjQ3NWU3NTJhNzM1M2RkNDNmNDI0MTJkMzUzNDQ=
   data.tar.gz: !binary |-
-    MzkzZDA4ZWE5YzFhZWExMWZlZmFlNjA3YzgwZDkyZWNkY2FmNTljMTNkYWE5
-    ZWYyZjVkNDI5OTlkYTFkODAyMmIyMTIxNDA2M2QyNDBkNGQwYmFhZjU3NWQy
-    NDVjOGMyNjRjNzgwNjM1NmZlZDYwNmE2YzI1MTViMGVhNWU3YmQ=
+    MjA3NDUyYWVmOTJiMzUwODMwZTVjOGY3ODhlYWY1YzBmYTM4NzdjOWUyYjZh
+    ZGU2YjMxNTBjYTgyMGYzY2RiNTEyMWM1NzZiOGNhZTI1MDc5ZjI1NjhiY2Yy
+    ZWI4ZTU5NWMzZTI1NTZkYzNiNjA4YTA5NTdjNTI1YzMyYmYxMmU=

data/lib/aws/decider/options.rb

@@ -537,43 +537,50 @@ module AWS
       def data_converter; FlowConstants.default_data_converter; end
     end
 
+    # Default values for a registered activity type. These values are set by
+    # default for all activities that use the activity type.
     class ActivityRegistrationDefaults < ActivityDefaults
 
-      # The default schedule-to-start timeout for activity tasks. This timeout
-      # represents the time, in seconds, between when the activity task is first
-      # scheduled to when it is started.
+      # *Optional*. The default schedule-to-start timeout for activity tasks.
+      # This timeout represents the time, in seconds, between when the activity
+      # task is first scheduled to when it is started.
       #
       # This default can be overridden when scheduling an activity task. You can
       # set this value to "NONE" to imply no timeout value.
       def default_task_schedule_to_start_timeout; Float::INFINITY; end
 
-      # The default schedule-to-close timeout for activity tasks. This timeout
-      # represents the time, in seconds, between when the activity task is first
-      # scheduled to when it is closed (whether due to success, failure, or a
-      # timeout).
+      # *Optional*. The default schedule-to-close timeout for activity tasks.
+      # This timeout represents the time, in seconds, between when the activity
+      # task is first scheduled to when it is closed (whether due to success,
+      # failure, or a timeout).
       #
       # This default can be overridden when scheduling an activity task. You can
       # set this value to "NONE" to imply no timeout value.
-      def default_task_schedule_to_close_timeout;  Float::INFINITY; end
+      def default_task_schedule_to_close_timeout; Float::INFINITY; end
 
-      # The default start-to-close timeout for activity tasks. This timeout
-      # represents the time, in seconds, between when the activity task is first
-      # started to when it is closed (whether due to success, failure, or a
-      # timeout).
+      # *Optional*. The default start-to-close timeout for activity tasks. This
+      # timeout represents the time, in seconds, between when the activity task
+      # is first started to when it is closed (whether due to success, failure,
+      # or a timeout).
       #
       # This default can be overridden when scheduling an activity task. You can
       # set this value to "NONE" to imply no timeout value.
       def default_task_start_to_close_timeout; Float::INFINITY; end
 
-      # The default maximum time, in seconds, before which a worker processing a
-      # task of this type must report progress.  If the timeout is exceeded, the
-      # activity task is automatically timed out. If the worker subsequently
-      # attempts to record a heartbeat or returns a result, it will be ignored.
+      # *Optional*. The default maximum time, in seconds, before which a worker
+      # processing a task of this type must report progress. If the timeout is
+      # exceeded, the activity task is automatically timed out. If the worker
+      # subsequently attempts to record a heartbeat or returns a result, it will
+      # be ignored.
       #
       # This default can be overridden when scheduling an activity task. You can
       # set this value to "NONE" to imply no timeout value.
       def default_task_heartbeat_timeout; Float::INFINITY; end
 
+      # *Optional*. The default task list to use for all activities that use
+      # this activity type. If not specified, the value
+      # `FlowConstants.use_worker_task_list` will be used, which causes the
+      # activities to use the task list specified for the activity worker.
       def default_task_list; FlowConstants.use_worker_task_list; end
     end
 
@@ -746,7 +753,6 @@ module AWS
         end
         result
       end
-
     end
 
     # This class is used to capture the options passed during activity declaration.
@@ -786,7 +792,6 @@ module AWS
       def get_registration_options
         get_options(self.class.registration_options)
       end
-
     end
 
     # Runtime options for an activity.

data/lib/aws/decider/task_poller.rb

@@ -61,7 +61,7 @@ module AWS
             @logger.debug "Didn't get a task on task_list: #{@task_list}"
             return false
           end
-          @logger.info Utilities.workflow_task_to_debug_string("Got decision task", task)
+          @logger.info Utilities.workflow_task_to_debug_string("Got decision task", task, @task_list)
 
           task_completed_request = @handler.handle_decision_task(task)
           @logger.debug "Response to the task will be #{task_completed_request.inspect}"
@@ -93,7 +93,7 @@ module AWS
             end
             @logger.error "#{task.workflow_type.inspect} failed with exception: #{e.inspect}"
           end
-          @logger.info Utilities.workflow_task_to_debug_string("Finished executing task", task)
+          @logger.info Utilities.workflow_task_to_debug_string("Finished executing task", task, @task_list)
         rescue AWS::SimpleWorkflow::Errors::UnknownResourceFault => e
           @logger.error "Error in the poller, #{e.inspect}"
         rescue Exception => e

data/lib/aws/decider/utilities.rb

@@ -33,11 +33,16 @@ module AWS
         end
       end
 
-      def self.workflow_task_to_debug_string(message, task)
-        return "#{message} #{task.workflow_type.name}.#{task.workflow_type.version} for execution with workflow_id: #{task.workflow_execution.workflow_id}, run_id: #{task.workflow_execution.run_id}, task_list: #{task.workflow_execution.task_list} with task_token: #{task.task_token}"
+      def self.workflow_task_to_debug_string(message, task, task_list)
+        "#{message} #{task.workflow_type.name}.#{task.workflow_type.version} "\
+        "for execution with workflow_id: #{task.workflow_execution.workflow_id}, "\
+        "run_id: #{task.workflow_execution.run_id}, task_list: #{task_list} with "\
+        "task_token: #{task.task_token}"
       end
+
       def self.activity_task_to_debug_string(message, task)
-        return "#{message} #{task.activity_type.name}.#{task.activity_type.version} with input: #{task.input} and task_token: #{task.task_token}"
+        "#{message} #{task.activity_type.name}.#{task.activity_type.version} "\
+        "with input: #{task.input} and task_token: #{task.task_token}"
       end
 
       # The following two methods are used to generate an error string when

data/lib/aws/decider/version.rb

@@ -16,7 +16,7 @@
 module AWS
   module Flow
     def self.version
-      "2.2.1"
+      "2.2.2"
     end
   end
 end

data/lib/aws/replayer.rb

@@ -1,32 +1,59 @@
 module AWS
   module Flow
+    # Provides a number of classes useful for debugging workflow executions. For
+    # an example of general use, see {WorkflowReplayer}.
+    #
     module Replayer
       require 'aws/decider'
       include AWS::Flow
 
-      # This class is used by the Replayer to fetch the DecisionTask which will
-      # be used by the DecisionTaskHandler. This is an 'abstract' class. We need
-      # to extend it and implement get_history_page and get_execution_info
-      # methods to use it.
+      # Used by {Replayer} to fetch a [DecisionTask][] which will be used by
+      # {DecisionTaskHandler}.
+      #
+      # [DecisionTask]: http://docs.aws.amazon.com/AWSRubySDK/latest/AWS/SimpleWorkflow/DecisionTask.html
+      #
+      # @abstract Implement the `get_history_page` and `get_execution_info` methods to
+      #   use it.
       class DecisionTaskProvider
 
-        # This method fetches the workflow history and wraps all the history events,
-        # workflow type, workflow execution inside a decision task for the
-        # decider to work on
+        # Fetches the workflow history and wraps all the history events,
+        # workflow type and workflow execution inside a decision task for the
+        # decider to work on.
+        #
+        # @param replay_upto [Fixnum] *Optional*. The event_id of the last event
+        #   to return. If set, returns the history only until the specified
+        #   event is reached. If not set, then all available history will be
+        #   returned. See [HistoryEvent][] for more information.
+        #
+        #   [HistoryEvent]: http://docs.aws.amazon.com/AWSRubySDK/latest/AWS/SimpleWorkflow/HistoryEvent.html
+        #
+        # @return [DecisionTask] the workflow history encapsulated in a
+        #   [DecisionTask][], optionally truncated to the event ID passed to
+        #   `replay_upto`.
+        #
+        #   [DecisionTask]: http://docs.aws.amazon.com/AWSRubySDK/latest/AWS/SimpleWorkflow/DecisionTask.html
+        #
         def get_decision_task(replay_upto = nil)
+
           # Get workflow execution info so that we can populate the workflowType
-          # and execution fields of the DecisionTask.
+          # and execution fields of the [DecisionTask][].
+          #
+          # [DecisionTask]: http://docs.aws.amazon.com/AWSRubySDK/latest/AWS/SimpleWorkflow/DecisionTask.html
+          #
           execution_info = get_execution_info
           events = get_history
 
           # Truncate history if replay_upto variable is set so that we only
           # replay the history till the specified event
+          #
           events = truncate_history(events, replay_upto)
           return nil if events.nil?
 
-          # Generate the hash to instantiate a DecisionTask. We can set
-          # taskToken and nextPageToken to nil since we don't need the values
-          # in the replayer
+          # Generate the hash to instantiate a [DecisionTask][]. We can set
+          # *taskToken* and *nextPageToken* to nil since we don't need the
+          # values in the replayer.
+          #
+          # [DecisionTask]: http://docs.aws.amazon.com/AWSRubySDK/latest/AWS/SimpleWorkflow/DecisionTask.html
           data = {
             'taskToken' => nil,
             'workflowExecution' => execution_info["execution"],
@@ -37,8 +64,17 @@ module AWS
           AWS::SimpleWorkflow::DecisionTask.new(nil, nil, data)
         end
 
-        # This method truncates the workflow history to the event_id specified
-        # by the replay_upto variable
+        # Truncates workflow history to a specified event id.
+        #
+        # @param events the workflow history (events) to truncate.
+        #
+        # @param replay_upto [Fixnum] *Optional*. The event ID of the final
+        #   [HistoryEvent][] to return.
+        #
+        #   [HistoryEvent]: http://docs.aws.amazon.com/AWSRubySDK/latest/AWS/SimpleWorkflow/HistoryEvent.html
+        #
+        # @return the truncated list of events.
+        #
         def truncate_history(events, replay_upto = nil)
           return nil if events.nil? || events.empty?
 
@@ -52,21 +88,44 @@ module AWS
           truncated
         end
 
-        # This method is used to fetch the actual history. Implementing classes
-        # must override this method.
+        # Fetches the workflow history. Implementing classes *must* override
+        # this method.
+        #
+        # @param page_token *Optional*. A token used to get further pages of
+        #   workflow history if all events could not be retrieved by the first
+        #   call to the method.
+        #
+        # @return a list of [HistoryEvent][]s that comprise the workflow's
+        #   available history.
+        #
+        #   [HistoryEvent]: http://docs.aws.amazon.com/AWSRubySDK/latest/AWS/SimpleWorkflow/HistoryEvent.html
+        #
         def get_history(page_token = nil); end
 
-        # This method is used to fetch the WorkflowExecutionInfo to fill in the
-        # DecisionTask details. Implementing classes must override this method
+        # Fetches the workflow execution information used to fill in the
+        # [DecisionTask][] details. Implementing classes *must* override this
+        # method.
+        #
+        # @return the workflow execution information as returned by
+        #   [AWS::SimpleWorkflow::Client#describe_workflow_execution][].
+        #
+        #   [AWS::SimpleWorkflow::Client#describe_workflow_execution]: http://docs.aws.amazon.com/AWSRubySDK/latest/AWS/SimpleWorkflow/Client.html#describe_workflow_execution-instance_method
         def get_execution_info; end
 
       end
 
-      # This DecisionTaskProvider loads the decision task directly from the
-      # SimpleWorkflowService
+      # Loads a decision task directly from the AWS Simple Workflow Service.
       class ServiceDecisionTaskProvider < DecisionTaskProvider
         attr_reader :domain, :execution, :swf
 
+        # Initialize a new **ServiceDecisionTaskProvider**.
+        #
+        # @param options a hash of options to provide. Entries for `:domain` and
+        #   `:execution` must be present in the hash.
+        #
+        # @raise |ArgumentError| if either `:domain` or `:execution` is missing
+        #   from the *options* parameter.
+        #
         def initialize(options = {})
           raise ArgumentError.new("options hash must contain :domain") if options[:domain].nil?
           raise ArgumentError.new("options hash must contain :execution") if options[:execution].nil?
@@ -75,6 +134,7 @@ module AWS
           @swf = AWS::SimpleWorkflow.new.client
         end
 
+        # Get the complete workflow history.
         def get_history
           events = []
           # Get the first page of the workflow history
@@ -89,9 +149,12 @@ module AWS
           events
         end
 
-        # This method calls the service to fetch a page of workflow history
+        # Fetches a page of workflow history.
+        #
+        # @param page_token *Optional*. A page token used to retrieve a
+        #   particular page of results.
         def get_history_page(page_token = nil)
-          # generate the request options for the service call. Optionally merge
+          # Generate the request options for the service call. Optionally merge
           # next_page_token to the hash if the page_token value is not nil.
           request_opts = {
             domain: @domain,
@@ -101,8 +164,11 @@ module AWS
           @swf.get_workflow_execution_history(request_opts)
         end
 
-        # This method calls the service to get the workflow execution
-        # information
+        # Call AWS Simple Workflow Service to get workflow execution
+        # information.
+        #
+        # @return the execution information based on the `:execution` and
+        #   `:domain` provided as input to the class constructor.
         def get_execution_info
           execution = @swf.describe_workflow_execution(
             domain: @domain,
@@ -113,14 +179,15 @@ module AWS
 
       end
 
-      # WorkflowReplayer is an AWS Flow Framework utility that is used to
-      # 'replay' a workflow history in the decider against the workflow
-      # implementation. It is a useful debugging tool.
+      # An AWS Flow Framework utility used to replay a workflow history in the
+      # decider against the workflow implementation. Primarily used for
+      # debugging workflows.
       #
-      # Usage -
+      # ## Usage
       #
-      # # Create an instance of the replayer with the required options -
+      # **Create an instance of the replayer with the required options:**
       #
+      # ~~~~
       # replayer = AWS::Flow::Replayer::WorkflowReplayer.new(
       #   domain: '<domain_name>',
       #   execution: {
@@ -129,14 +196,25 @@ module AWS
       #   },
       #   workflow_class: WorkflowClass
       # )
+      # ~~~~
       #
-      # # Call the replay method (optionally) with the replay_upto event_id number -
+      # **Call the replay method (optionally) with the replay_upto event_id number**
       #
+      # ~~~~
       # decision = replayer.replay(20)
+      # ~~~~
       #
       class WorkflowReplayer
         attr_reader :task_handler, :task_provider
 
+        # Initialize a new **WorkflowReplayer**.
+        #
+        # @param options A hash of options. The hash must contain at least
+        #   `:workflow_class`.
+        #
+        # @raise |ArgumentError| if no options hash was passed in, or if the
+        #   options are missing the `:workflow_class` key.
+        #
         def initialize(options)
           raise ArgumentError.new("You must pass in an options hash") if options.nil?
           raise ArgumentError.new("options hash must contain :workflow_class") if options[:workflow_class].nil?
@@ -147,14 +225,17 @@ module AWS
           @task_handler = DecisionTaskHandler.from_workflow_class(options[:workflow_class])
         end
 
-        # This method performs the actual replay.
+        # Performs a replay of workflow history.
+        #
+        # @param replay_upto [Fixnum] *Optional*. If set, replays the history
+        #   only until the specified event is reached. If not set, then all
+        #   history will be returned.
+        #
         def replay(replay_upto = nil)
           task = @task_provider.get_decision_task(replay_upto)
           @task_handler.handle_decision_task(task) unless task.nil?
         end
-
       end
-
     end
   end
 end

data/spec/aws/decider/unit/decider_spec.rb

@@ -1537,5 +1537,48 @@ describe "Workflow/Activity return values/exceptions" do
     exception.details.should == "SIMULATED"
   end
 
+
+  # A bug was introduced in the previous commit which resulted in unnecessary
+  # calls to #describe_workflow_execution during logging of a DecisionTask. This
+  # test ensures that we don't call describe_workflow_execution anymore.
+  it "ensures describe_workflow_execution is not called during polling" do
+
+    swf = double("swf")
+    domain = double("domain")
+    allow(domain).to receive(:name).and_return("foo")
+    allow(swf).to receive(:domain).and_return(domain)
+
+    # Set the expectations for the test
+    expect_any_instance_of(AWS::SimpleWorkflow::Client::V20120125).to_not receive(:describe_workflow_execution)
+
+    class SomeWorkflow
+      extend Workflows
+      workflow(:start) do
+        {
+          version: "1.0",
+          default_execution_start_to_close_timeout: 600,
+        }
+      end
+      def start; end
+    end
+
+    class SynchronousWorkflowTaskPoller < WorkflowTaskPoller
+      def get_decision_task
+        fake_workflow_type = FakeWorkflowType.new(nil, "SomeWorkflow.start", "1.0")
+        domain = double("domain")
+        TestHistoryWrapper.new(fake_workflow_type, AWS::SimpleWorkflow::WorkflowExecution.new(domain, "workflow_id", "run_id"),
+                               FakeEvents.new(["WorkflowExecutionStarted",
+                                               "DecisionTaskScheduled",
+                                               "DecisionTaskStarted",
+        ]))
+      end
+    end
+    workflow_type = FakeWorkflowType.new(nil, "SomeWorkflow.entry_point", "1")
+    client  = workflow_client(swf, domain) { { from_class: "SomeWorkflow" } }
+
+    worker = SynchronousWorkflowWorker.new(swf, domain, "SomeWorkflow", SomeWorkflow)
+    worker.start
+  end
+
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-flow
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.2.2
 platform: ruby
 authors:
 - Michael Steger, Paritosh Mohan, Jacques Thomas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-03 00:00:00.000000000 Z
+date: 2014-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-v1