floe 0.11.2 → 0.12.0

data/lib/floe/workflow.rb

@@ -6,6 +6,7 @@ require "json"
 module Floe
   class Workflow
     include Logging
+    include ValidationMixin
 
     class << self
       def load(path_or_io, context = nil, credentials = {}, name = nil)
@@ -85,61 +86,73 @@ module Floe
       end
     end
 
-    attr_reader :context, :credentials, :payload, :states, :states_by_name, :start_at, :name, :comment
+    attr_reader :context, :payload, :states, :states_by_name, :start_at, :name, :comment
 
-    def initialize(payload, context = nil, credentials = {}, name = nil)
+    def initialize(payload, context = nil, credentials = nil, name = nil)
       payload     = JSON.parse(payload)     if payload.kind_of?(String)
       credentials = JSON.parse(credentials) if credentials.kind_of?(String)
       context     = Context.new(context)    unless context.kind_of?(Context)
 
-      raise Floe::InvalidWorkflowError, "Missing field \"States\""  if payload["States"].nil?
-      raise Floe::InvalidWorkflowError, "Missing field \"StartAt\"" if payload["StartAt"].nil?
-      raise Floe::InvalidWorkflowError, "\"StartAt\" not in the \"States\" field" unless payload["States"].key?(payload["StartAt"])
+      # backwards compatibility
+      # caller should really put credentials into context and not pass that variable
+      context.credentials = credentials if credentials
 
-      @name        = name
+      # NOTE: this is a string, and states use an array
+      @name        = name || "State Machine"
       @payload     = payload
       @context     = context
-      @credentials = credentials || {}
       @comment     = payload["Comment"]
       @start_at    = payload["StartAt"]
 
-      @states         = payload["States"].to_a.map { |state_name, state| State.build!(self, state_name, state) }
-      @states_by_name = @states.each_with_object({}) { |state, result| result[state.name] = state }
+      # NOTE: Everywhere else we include our name (i.e.: parent name) when building the child name.
+      #       When creating the states, we are dropping our name (i.e.: the workflow name)
+      @states      = payload["States"].to_a.map { |state_name, state| State.build!(self, ["States", state_name], state) }
 
-      unless context.state.key?("Name")
-        context.state["Name"] = start_at
-        context.state["Input"] = context.execution["Input"].dup
-      end
-    rescue StandardError => err
+      validate_workflow
+
+      @states_by_name = @states.each_with_object({}) { |state, result| result[state.short_name] = state }
+    rescue Floe::Error
+      raise
+    rescue => err
       raise Floe::InvalidWorkflowError, err.message
     end
 
     def run_nonblock
+      start_workflow
       loop while step_nonblock == 0 && !end?
       self
     end
 
+    # NOTE: If running manually, make sure to call start_workflow at startup
     def step_nonblock
       return Errno::EPERM if end?
 
-      step_next
-      current_state.run_nonblock!
+      result = current_state.run_nonblock!(context)
+      return result if result != 0
+
+      # if it completed the step
+      context.state_history << context.state
+      context.next_state ? step! : end_workflow!
+
+      result
     end
 
+    # if this hasn't started (and we have no current_state yet), assume it is ready
     def step_nonblock_wait(timeout: nil)
-      current_state.wait(:timeout => timeout)
+      context.started? ? current_state.wait(context, :timeout => timeout) : 0
     end
 
+    # if this hasn't started (and we have no current_state yet), assume it is ready
     def step_nonblock_ready?
-      current_state.ready?
+      !context.started? || current_state.ready?(context)
     end
 
     def waiting?
-      current_state.waiting?
+      current_state.waiting?(context)
     end
 
     def wait_until
-      current_state.wait_until
+      current_state.wait_until(context)
     end
 
     def status
@@ -147,21 +160,60 @@ module Floe
     end
 
     def output
-      context.output if end?
+      context.json_output if end?
     end
 
     def end?
       context.ended?
     end
 
+    # setup a workflow
+    def start_workflow
+      return if context.state_name
+
+      context.state["Name"]  = start_at
+      context.state["Input"] = context.execution["Input"].dup
+      context.state["Guid"]  = SecureRandom.uuid
+
+      context.execution["Id"]        = SecureRandom.uuid
+      context.execution["StartTime"] = Time.now.utc.iso8601
+
+      self
+    end
+
+    # NOTE: Expecting the context to be initialized (via start_workflow) before this
     def current_state
       @states_by_name[context.state_name]
     end
 
+    # backwards compatibility. Caller should access directly from context
+    def credentials
+      @context.credentials
+    end
+
     private
 
-    def step_next
-      context.state = {"Name" => context.next_state, "Input" => context.output} if context.next_state
+    def validate_workflow
+      missing_field_error!("States") if @states.empty?
+      missing_field_error!("StartAt") if @start_at.nil?
+      invalid_field_error!("StartAt", @start_at, "is not found in \"States\"") unless workflow_state?(@start_at, self)
+    end
+
+    def step!
+      next_state = {"Name" => context.next_state, "Guid" => SecureRandom.uuid, "PreviousStateGuid" => context.state["Guid"]}
+
+      # if rerunning due to an error (and we are using Retry)
+      if context.state_name == context.next_state && context.failed? && context.state.key?("Retrier")
+        next_state.merge!(context.state.slice("RetryCount", "Input", "Retrier"))
+      else
+        next_state["Input"] = context.output
+      end
+
+      context.state = next_state
+    end
+
+    def end_workflow!
+      context.execution["EndTime"] = context.state["FinishedTime"]
     end
   end
 end

data/lib/floe.rb

@@ -7,7 +7,9 @@ require_relative "floe/logging"
 
 require_relative "floe/runner"
 
+require_relative "floe/validation_mixin"
 require_relative "floe/workflow"
+require_relative "floe/workflow/error_matcher_mixin"
 require_relative "floe/workflow/catcher"
 require_relative "floe/workflow/choice_rule"
 require_relative "floe/workflow/choice_rule/not"
@@ -15,6 +17,9 @@ require_relative "floe/workflow/choice_rule/or"
 require_relative "floe/workflow/choice_rule/and"
 require_relative "floe/workflow/choice_rule/data"
 require_relative "floe/workflow/context"
+require_relative "floe/workflow/intrinsic_function"
+require_relative "floe/workflow/intrinsic_function/parser"
+require_relative "floe/workflow/intrinsic_function/transformer"
 require_relative "floe/workflow/path"
 require_relative "floe/workflow/payload_template"
 require_relative "floe/workflow/reference_path"
@@ -37,6 +42,7 @@ require "time"
 module Floe
   class Error < StandardError; end
   class InvalidWorkflowError < Error; end
+  class InvalidExecutionInput < Error; end
 
   def self.logger
     @logger ||= NullLogger.new

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: floe
 version: !ruby/object:Gem::Version
-  version: 0.11.2
+  version: 0.12.0
 platform: ruby
 authors:
 - ManageIQ Developers
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-24 00:00:00.000000000 Z
+date: 2024-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_spawn
@@ -80,20 +80,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: parslet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: manageiq-style
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.5.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.5.2
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -122,20 +136,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -164,13 +164,14 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Simple Workflow Runner.
+description: Floe is a runner for Amazon States Language workflows.
 email:
 executables:
 - floe
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_cc.yml"
@@ -178,6 +179,7 @@ files:
 - ".yamllint"
 - CHANGELOG.md
 - Gemfile
+- LICENSE.txt
 - README.md
 - Rakefile
 - examples/set-credential.asl
@@ -185,6 +187,7 @@ files:
 - exe/floe
 - floe.gemspec
 - lib/floe.rb
+- lib/floe/cli.rb
 - lib/floe/container_runner.rb
 - lib/floe/container_runner/docker.rb
 - lib/floe/container_runner/docker_mixin.rb
@@ -193,6 +196,7 @@ files:
 - lib/floe/logging.rb
 - lib/floe/null_logger.rb
 - lib/floe/runner.rb
+- lib/floe/validation_mixin.rb
 - lib/floe/version.rb
 - lib/floe/workflow.rb
 - lib/floe/workflow/catcher.rb
@@ -202,6 +206,10 @@ files:
 - lib/floe/workflow/choice_rule/not.rb
 - lib/floe/workflow/choice_rule/or.rb
 - lib/floe/workflow/context.rb
+- lib/floe/workflow/error_matcher_mixin.rb
+- lib/floe/workflow/intrinsic_function.rb
+- lib/floe/workflow/intrinsic_function/parser.rb
+- lib/floe/workflow/intrinsic_function/transformer.rb
 - lib/floe/workflow/path.rb
 - lib/floe/workflow/payload_template.rb
 - lib/floe/workflow/reference_path.rb
@@ -220,7 +228,8 @@ files:
 - renovate.json
 - sig/floe.rbs/floe.rbs
 homepage: https://github.com/ManageIQ/floe
-licenses: []
+licenses:
+- Apache-2.0
 metadata:
   allowed_push_host: https://rubygems.org
   rubygems_mfa_required: 'true'
@@ -242,8 +251,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.10
+rubygems_version: 3.4.20
 signing_key:
 specification_version: 4
-summary: Simple Workflow Runner.
+summary: Floe is a runner for Amazon States Language workflows.
 test_files: []