glider 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4aa4101f0537f562aa326ba31408d9ff2035b08a
+  data.tar.gz: 9cf46b6473470aa0029b7b599c8b98763c228abb
+SHA512:
+  metadata.gz: 14458f9f29b9c9f1ab8032d73ae189811c1cfe6448a7e5b712545df7764783ca301ba722defe2076950d6e32f0109b602162e7b697b25293a5b068ac3f39879f
+  data.tar.gz: 72306154571324a022b22c3e09ddee1778602b4362e8cf985dee25e8e9a74f7a71803aa6fe2f3d600938b4c6447121bad60025ad5990b026ba27730efe6601f4

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'pry'
+gem 'aws-sdk'
+gem 'colorize'
+gem 'activesupport', '~> 4.0.1', require: 'active_support/inflector'

data/Gemfile.lock

@@ -0,0 +1,40 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.0.1)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    atomic (1.1.14)
+    aws-sdk (1.26.0)
+      json (~> 1.4)
+      nokogiri (>= 1.4.4, < 1.6.0)
+      uuidtools (~> 2.1)
+    coderay (1.0.9)
+    colorize (0.6.0)
+    i18n (0.6.5)
+    json (1.8.1)
+    method_source (0.8.2)
+    minitest (4.7.5)
+    multi_json (1.8.2)
+    nokogiri (1.5.10)
+    pry (0.9.12.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    slop (3.4.6)
+    thread_safe (0.1.3)
+      atomic
+    tzinfo (0.3.38)
+    uuidtools (2.1.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (~> 4.0.1)
+  aws-sdk
+  colorize
+  pry

data/README.md

@@ -0,0 +1,36 @@
+Useful documentation links:
+
+http://docs.aws.amazon.com/amazonswf/latest/apireference/API_RespondDecisionTaskCompleted.html
+
+http://docs.aws.amazon.com/amazonswf/latest/apireference/API_HistoryEvent.html
+
+http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-workflow-exec-lifecycle.html
+
+USEFUL TO DECIDE WHAT TO PASS TO THE METHOD
+
+INFO 15:16:05 	Starting workers for ["hello_world-1.0"] and ["say_hi-1.0"]
+INFO 15:16:05 	Startig worker for say_hi (class: MySWF)
+INFO 15:16:42 	Processing decision task workflow_id=bb235559-9ee6-4a80-96c5-9eed168046d5
+INFO 15:16:42 	say_hi event=workflow_execution_started data=ALOHA
+WARN 15:16:42 	No result for decision_task_scheduled, attributes: {:task_list=>"say_hi", :start_to_close_timeout=>5}
+WARN 15:16:42 	say_hi event=decision_task_scheduled data=
+WARN 15:16:42 	No result for decision_task_started, attributes: {:identity=>"dmb.local:49424", :scheduled_event_id=>2}
+WARN 15:16:42 	say_hi event=decision_task_started data=
+WARN 15:16:42 	No result for decision_task_timed_out, attributes: {:timeout_type=>"START_TO_CLOSE", :scheduled_event_id=>2, :started_event_id=>3}
+WARN 15:16:42 	say_hi event=decision_task_timed_out data=
+WARN 15:16:42 	No result for decision_task_scheduled, attributes: {:task_list=>"say_hi", :start_to_close_timeout=>5}
+WARN 15:16:42 	say_hi event=decision_task_scheduled data=
+WARN 15:16:42 	No result for decision_task_started, attributes: {:identity=>"dmb.local:49461", :scheduled_event_id=>5}
+WARN 15:16:42 	say_hi event=decision_task_started data=
+DEBUG 15:16:42 	[{:decision_type=>"CompleteWorkflowExecution", :complete_workflow_execution_decision_attributes=>{}}]
+
+terminations dont trigger decisions
+
+
+TODO:
+
+Proces monitoring
+activity task signaling
+
+Exec scoped logger
+instance methods

data/docs/event_names.md

@@ -0,0 +1,129 @@
+
+taken from docs.aws.amazon.com/amazonswf/latest/apireference/API_HistoryEvent.html
+
+
+WorkflowExecutionStarted:
+The workflow execution was started.
+
+WorkflowExecutionCompleted:
+The workflow execution was closed due to successful completion.
+
+WorkflowExecutionFailed:
+The workflow execution closed due to a failure.
+
+WorkflowExecutionTimedOut:
+The workflow execution was closed because a time out was exceeded.
+
+WorkflowExecutionCanceled:
+The workflow execution was successfully canceled and closed.
+
+WorkflowExecutionTerminated:
+The workflow execution was terminated.
+
+WorkflowExecutionContinuedAsNew:
+The workflow execution was closed and a new execution of the same type was created with the same workflowId.
+
+WorkflowExecutionCancelRequested:
+A request to cancel this workflow execution was made.
+
+DecisionTaskScheduled:
+A decision task was scheduled for the workflow execution.
+
+DecisionTaskStarted:
+The decision task was dispatched to a decider.
+
+DecisionTaskCompleted:
+The decider successfully completed a decision task by calling RespondDecisionTaskCompleted.
+
+DecisionTaskTimedOut:
+The decision task timed out.
+
+ActivityTaskScheduled:
+An activity task was scheduled for execution.
+
+ScheduleActivityTaskFailed:
+Failed to process ScheduleActivityTask decision. This happens when the decision is not configured properly, for example the activity type specified is not registered.
+
+ActivityTaskStarted:
+The scheduled activity task was dispatched to a worker.
+
+ActivityTaskCompleted:
+An activity worker successfully completed an activity task by calling RespondActivityTaskCompleted.
+
+ActivityTaskFailed:
+An activity worker failed an activity task by calling RespondActivityTaskFailed.
+
+ActivityTaskTimedOut:
+The activity task timed out.
+
+ActivityTaskCanceled:
+The activity task was successfully canceled.
+
+ActivityTaskCancelRequested:
+A RequestCancelActivityTask decision was received by the system.
+
+RequestCancelActivityTaskFailed:
+Failed to process RequestCancelActivityTask decision. This happens when the decision is not configured properly.
+
+WorkflowExecutionSignaled:
+An external signal was received for the workflow execution.
+
+MarkerRecorded:
+A marker was recorded in the workflow history as the result of a RecordMarker decision.
+
+TimerStarted:
+A timer was started for the workflow execution due to a StartTimer decision.
+
+StartTimerFailed:
+Failed to process StartTimer decision. This happens when the decision is not configured properly, for example a timer already exists with the specified timer Id.
+
+TimerFired:
+A timer, previously started for this workflow execution, fired.
+
+TimerCanceled:
+A timer, previously started for this workflow execution, was successfully canceled.
+
+CancelTimerFailed:
+Failed to process CancelTimer decision. This happens when the decision is not configured properly, for example no timer exists with the specified timer Id.
+
+StartChildWorkflowExecutionInitiated:
+A request was made to start a child workflow execution.
+
+StartChildWorkflowExecutionFailed:
+Failed to process StartChildWorkflowExecution decision. This happens when the decision is not configured properly, for example the workflow type specified is not registered.
+
+ChildWorkflowExecutionStarted:
+A child workflow execution was successfully started.
+
+ChildWorkflowExecutionCompleted:
+A child workflow execution, started by this workflow execution, completed successfully and was closed.
+
+ChildWorkflowExecutionFailed:
+A child workflow execution, started by this workflow execution, failed to complete successfully and was closed.
+
+ChildWorkflowExecutionTimedOut:
+A child workflow execution, started by this workflow execution, timed out and was closed.
+
+ChildWorkflowExecutionCanceled:
+A child workflow execution, started by this workflow execution, was canceled and closed.
+
+ChildWorkflowExecutionTerminated:
+A child workflow execution, started by this workflow execution, was terminated.
+
+SignalExternalWorkflowExecutionInitiated:
+A request to signal an external workflow was made.
+
+ExternalWorkflowExecutionSignaled:
+A signal, requested by this workflow execution, was successfully delivered to the target external workflow execution.
+
+SignalExternalWorkflowExecutionFailed:
+The request to signal an external workflow execution failed.
+
+RequestCancelExternalWorkflowExecutionInitiated:
+A request was made to request the cancellation of an external workflow execution.
+
+ExternalWorkflowExecutionCancelRequested:
+Request to cancel an external workflow execution was successfully delivered to the target execution.
+
+RequestCancelExternalWorkflowExecutionFailed:
+Request to cancel an external workflow execution failed.

data/lib/glider.rb

@@ -0,0 +1,11 @@
+$LOAD_PATH << File.dirname(__FILE__)
+
+require 'pry'
+
+require 'glider/utils'
+
+require 'glider/component'
+require 'glider/process_manager'
+
+require 'glider/workflows'
+require 'glider/activities'

data/lib/glider/activities.rb

@@ -0,0 +1,69 @@
+# isolates the common needed tasks of other elemtns
+
+module Glider
+
+	class Component
+		class << self
+
+			def activities
+				@activities ||= []
+			end
+
+			def register_activity(name, version, options={})
+				default_options = {
+					:default_task_list => name.to_s,
+					:default_task_schedule_to_start_timeout => :none,
+					:default_task_start_to_close_timeout => 60,
+					:default_task_schedule_to_close_timeout => :none,
+					:default_task_heartbeat_timeout => :none
+
+				}
+
+				options = default_options.merge options
+
+				begin
+					activity_type = domain.activity_types.create name.to_s, version, options
+				rescue AWS::SimpleWorkflow::Errors::TypeAlreadyExistsFault
+					# already registered
+					activity_type = domain.activity_types[name.to_s, version]
+				end
+				workers.times do 
+					ProcessManager.register_worker loop_block_for_activity(activity_type)
+				end
+			end
+
+
+
+			def loop_block_for_activity(activity_type)
+				Proc.new do
+					$0 = "ruby #{activity_type.name}-#{activity_type.version}"
+					signal_handling
+					Glider.logger.info "Startig worker for #{activity_type.name} activity (pid #{Process.pid})"
+					begin
+						domain.activity_tasks.poll activity_type.name do |activity_task|
+							task_lock! do
+								begin
+									workflow_id = activity_task.workflow_execution.workflow_id
+									Glider.logger.info "Executing activity=#{activity_type.name} workflow_id=#{workflow_id}"
+									target_instance = self.new activity_task
+									activity_result = target_instance.send activity_type.name, activity_task.input
+									activity_task.complete! result: activity_result.to_s
+								rescue AWS::SimpleWorkflow::ActivityTask::CancelRequestedError
+									# cleanup after ourselves
+									activity_task.cancel!
+								end
+							end
+						end
+					rescue AWS::SimpleWorkflow::Errors::UnknownResourceFault
+						$logger.error "An action relating to an expired workflow was sent. Probably the activity took longer than the execution timeout span. Killing activity process."
+						exit 1
+					end
+				end
+			end
+
+
+		end
+
+	end
+
+end

data/lib/glider/component.rb

@@ -0,0 +1,67 @@
+# isolates the common needed tasks of other elemtns
+
+module Glider
+
+	class Component
+
+		attr_reader :task, :event
+
+		def initialize(task, event=nil)
+			@task = task
+			@event = event
+		end
+
+
+		class << self
+
+			def task_lock!
+				@in_task = true
+				yield
+			ensure
+				@in_task = false
+				Process.exit! 0 if @time_to_exit # in case an exit signal was received during task processing
+			end
+
+			def graceful_exit
+				if @in_task
+					@time_to_exit = true
+				else
+					Process.exit! 0
+				end
+			end
+
+			def signal_handling
+				Signal.trap('USR1') do
+					graceful_exit
+				end
+			end
+
+			def swf
+				@swf ||= AWS::SimpleWorkflow.new
+			end
+
+			# both setter and getter
+			def workers(workers_count=nil)
+				workers_count ? @workers = workers_count : @workers ||= 1
+			end
+
+			# both setter and getter
+			def domain(domain_name=nil, retention_period: 10)
+				if domain_name
+					begin
+						@domain = swf.domains[domain_name.to_s]
+						@domain.status
+					rescue AWS::SimpleWorkflow::Errors::UnknownResourceFault => e
+						# create it if necessary
+						@domain = swf.domains.create(domain_name.to_s, retention_period)
+					end
+				else
+					@domain
+				end
+			end
+
+		end
+
+	end
+
+end

data/lib/glider/utils.rb

@@ -0,0 +1,19 @@
+module Glider
+
+	def Glider.logger
+		$logger ||= Logger.new STDOUT
+	end
+
+	def Glider.execute(domain_name, workflow_name, version, input)
+		swf = AWS::SimpleWorkflow.new
+		domain = swf.domains[domain_name.to_s]
+		domain.workflow_types[workflow_name.to_s, version].start_execution input: input, task_start_to_close_timeout: 5
+	end
+
+	def Glider.signal(domain_name, workflow_id, signal_name, options={})
+		swf = AWS::SimpleWorkflow.new
+		domain = swf.domains[domain_name.to_s]
+		workflow_execution = domain.workflow_executions.with_workflow_id(workflow_id).with_status(:open).first
+		workflow_execution.signal signal_name.to_s, options
+	end
+end

data/lib/glider/workflows.rb

@@ -0,0 +1,146 @@
+# isolates the common needed tasks of other elemtns
+
+module Glider
+
+	class Component
+
+		
+
+		class << self
+			def workflows
+				@workflows ||= []
+			end
+
+			def register_workflow(name, version, options={})
+
+				default_options = {
+					:default_task_list => name.to_s,
+					:default_child_policy => :request_cancel,
+					:default_task_start_to_close_timeout => 10, # decider timeout
+					:default_execution_start_to_close_timeout => 120
+				}
+				options = default_options.merge options
+				begin
+					workflow_type = domain.workflow_types.create name.to_s, version, options
+				rescue AWS::SimpleWorkflow::Errors::TypeAlreadyExistsFault
+					# already registered
+					workflow_type = domain.workflow_types[name.to_s, version]
+				end
+				workers.times do 
+					ProcessManager.register_worker loop_block_for_workflow(workflow_type)
+				end
+			end
+
+			# let's us determine if :decised_task_started should be called :workflow_execution_started
+            def has_previous_decisions?(workflow_execution)
+                    workflow_execution.history_events.each do |event|
+                            event_type = ActiveSupport::Inflector.underscore(event.event_type).to_sym
+                            return true if event_type == :decision_task_completed
+                    end
+                    return false
+            end
+
+			def should_call_workflow_target?(event_name, workflow_execution)
+				case event_name
+				when 	:activity_task_scheduled,
+						:activity_task_started,
+						:decision_task_scheduled,
+						:decision_task_started,
+						:decision_task_completed,
+						:marker_recorded,
+						:timer_started,
+						:start_child_workflow_execution_initiated,
+						:start_child_workflow_execution_started,
+						:signal_external_workflow_execution_initiated,
+						:request_cancel_external_workflow_execution_initiated
+
+					Glider.logger.debug "Skipping decider call event=#{event_name} workflow_id=#{workflow_execution.workflow_id}"
+					return false
+				else
+					return true
+				end
+			end
+
+			def workflow_data_for(event_name, event)
+				case event_name
+				when :workflow_execution_started #:decision_task_scheduled
+					event.attributes.input
+				when :workflow_execution_signaled
+					begin event.attributes.input rescue nil end
+				when :activity_task_completed
+					begin event.attributes.result rescue nil end
+				else
+					begin 
+						event.attributes.result
+					rescue
+						Glider.logger.debug "no input or result in event, data will be nil event=#{event_name} attributes=#{event.attributes.to_h}"
+						nil
+					end
+				end 
+			end
+
+			# used for timeouts and activity task completed
+			def activity_name_for(task, event)
+				# taken from SimplerWorkflow
+		 		completed_event = task.workflow_execution.events.reverse_order.find do |e| 
+		 			e.id == event.attributes.scheduled_event_id
+		 		end
+		 		activity_name = completed_event.attributes.activity_type.name
+				inflected_name = ActiveSupport::Inflector.underscore activity_name
+			end
+
+			def process_decision_task(workflow_type, task)
+				workflow_id = task.workflow_execution.workflow_id
+				Glider.logger.info "Deciding workflow=#{workflow_type.name} workflow_id=#{workflow_id}"
+				task.new_events.each do |event| 
+					event_name = ActiveSupport::Inflector.underscore(event.event_type).to_sym
+					if should_call_workflow_target? event_name, task.workflow_execution
+					 	target_instance = self.new task, event
+					 	data = workflow_data_for(event_name, event)
+					 	# convert signals to event names!
+					 	case event_name
+					 	when :workflow_execution_signaled
+					 		event_name = "#{event.attributes.signal_name}_signal".to_sym
+					 	when :activity_task_completed
+					 		event_name = "#{activity_name_for(task, event)}_activity_completed".to_sym
+					 	when :activity_task_timed_out
+					 		event_name = "#{activity_name_for(task, event)}_activity_timed_out".to_sym
+						end
+						
+						target_instance.send workflow_type.name, event_name, event, data
+						
+
+						# ensure proper response was given (aka a decision taken)
+						decisions = task.instance_eval {@decisions}
+						Glider.logger.debug decisions
+						if decisions.length == 0 && !task.responded?
+							# the decider didn't add any decision
+							Glider.logger.warn "No decision made workflow=#{workflow_type.name}  workflow_id=#{task.workflow_execution.workflow_id}"
+						end
+					end
+				end
+			end
+
+			def loop_block_for_workflow(workflow_type)
+				Proc.new do
+					$0 = "ruby #{workflow_type.name}-#{workflow_type.version}"
+					signal_handling
+					Glider.logger.info "Startig worker for #{workflow_type.name} (pid #{Process.pid})"
+					begin
+						domain.decision_tasks.poll workflow_type.name do |decision_task|
+							task_lock! do
+								process_decision_task workflow_type, decision_task
+							end
+						end
+					rescue AWS::SimpleWorkflow::Errors::UnknownResourceFault
+						$logger.error "An action relating to an expired decision was sent. Probably the decider took longer than the decision timeout span. Killing decider process."
+						exit 1
+					end
+				end
+			end
+
+		end
+
+	end
+
+end

data/readme.md

@@ -0,0 +1,36 @@
+Useful documentation links:
+
+http://docs.aws.amazon.com/amazonswf/latest/apireference/API_RespondDecisionTaskCompleted.html
+
+http://docs.aws.amazon.com/amazonswf/latest/apireference/API_HistoryEvent.html
+
+http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-workflow-exec-lifecycle.html
+
+USEFUL TO DECIDE WHAT TO PASS TO THE METHOD
+
+INFO 15:16:05 	Starting workers for ["hello_world-1.0"] and ["say_hi-1.0"]
+INFO 15:16:05 	Startig worker for say_hi (class: MySWF)
+INFO 15:16:42 	Processing decision task workflow_id=bb235559-9ee6-4a80-96c5-9eed168046d5
+INFO 15:16:42 	say_hi event=workflow_execution_started data=ALOHA
+WARN 15:16:42 	No result for decision_task_scheduled, attributes: {:task_list=>"say_hi", :start_to_close_timeout=>5}
+WARN 15:16:42 	say_hi event=decision_task_scheduled data=
+WARN 15:16:42 	No result for decision_task_started, attributes: {:identity=>"dmb.local:49424", :scheduled_event_id=>2}
+WARN 15:16:42 	say_hi event=decision_task_started data=
+WARN 15:16:42 	No result for decision_task_timed_out, attributes: {:timeout_type=>"START_TO_CLOSE", :scheduled_event_id=>2, :started_event_id=>3}
+WARN 15:16:42 	say_hi event=decision_task_timed_out data=
+WARN 15:16:42 	No result for decision_task_scheduled, attributes: {:task_list=>"say_hi", :start_to_close_timeout=>5}
+WARN 15:16:42 	say_hi event=decision_task_scheduled data=
+WARN 15:16:42 	No result for decision_task_started, attributes: {:identity=>"dmb.local:49461", :scheduled_event_id=>5}
+WARN 15:16:42 	say_hi event=decision_task_started data=
+DEBUG 15:16:42 	[{:decision_type=>"CompleteWorkflowExecution", :complete_workflow_execution_decision_attributes=>{}}]
+
+terminations dont trigger decisions
+
+
+TODO:
+
+Proces monitoring
+activity task signaling
+
+Exec scoped logger
+instance methods

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: glider
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- David Pelaez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.7
+description: Minimal opinionated wrapper around SimpleWorkflow
+email: david@vlipco.co
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- Gemfile
+- Gemfile.lock
+- docs/event_names.md
+- lib/glider.rb
+- lib/glider/activities.rb
+- lib/glider/component.rb
+- lib/glider/utils.rb
+- lib/glider/workflows.rb
+- readme.md
+- README.md
+homepage: http://github.com/vlipco/glider
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.9
+signing_key: 
+specification_version: 4
+summary: Minimal opinionated wrapper around SimpleWorkflow
+test_files: []