floe 0.21.0 → 0.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17d64b12761527067ed26cda1737c6f4bd20c8d1c9affbb5edf78b176b4713c7
-  data.tar.gz: 22de6a27ac450b71d1467fb5b5fa304c6802e155f956bf2d0a72f6e097717aaa
+  metadata.gz: bf92b02c87a1fa72f7a6424a6f01413fed9830a6e35194762095e7af6e76c366
+  data.tar.gz: 6d9b6209e73739fc7d6f7572b7e630366127de06eb2dca550542dc7558790ca6
 SHA512:
-  metadata.gz: 5e13a84b4568e4de952db7c05f5a29e6fc8fabaa0c944dc8b571a1514b5d9aae1118b94a4332e2e5456cdb0c776a629d1a19ef0d4a9803dd23e0844dc228cc03
-  data.tar.gz: 5512f1229704cb82a6e354388fc1873fe2eaf7b91d0410931a7e2e9baaadd5cf53815faaa3d4cee4cc4994d5ce8713b52a8ab451d241c3e5c857fc0bfc36f5a5
+  metadata.gz: d03f3cde0036103469210a5a28eb20f2198c4cea7bb5306960a2fada722b109a2030f83858b51d9796a97cb30b6ce7a2f4b3be12209085e561009b9918d8a102
+  data.tar.gz: eca7b964bc9dbd5af65d122e01852650d4892731dc26fc30b71896bf256e98837d5d8c426ea84c59466aee6c4a8c383d67a455e8256c9f5b2fc5be97954065d6

data/CHANGELOG.md

@@ -4,6 +4,15 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [0.22.0] - 2026-10-23
+### Fixed
+- Fix TypeError in Docker#wait when timeout is given ([#352](https://github.com/ManageIQ/floe/pull/352))
+
+### Added
+- Implement StateMachine TimeoutSeconds ([#350](https://github.com/ManageIQ/floe/pull/350))
+- Add StateMachine Version ([#350](https://github.com/ManageIQ/floe/pull/350))
+- Add timeout_at to Workflow and State ([#351](https://github.com/ManageIQ/floe/pull/351))
+
 ## [0.21.0] - 2026-09-16
 ### Added
 - Add volumes: option to run_async! for all container runners ([#347](https://github.com/ManageIQ/floe/pull/347))
@@ -356,7 +365,8 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 ### Added
 - Initial release
 
-[Unreleased]: https://github.com/ManageIQ/floe/compare/v0.21.0...HEAD
+[Unreleased]: https://github.com/ManageIQ/floe/compare/v0.22.0...HEAD
+[0.22.0]: https://github.com/ManageIQ/floe/compare/v0.21.0...v0.22.0
 [0.21.0]: https://github.com/ManageIQ/floe/compare/v0.20.1...v0.21.0
 [0.20.1]: https://github.com/ManageIQ/floe/compare/v0.20.0...v0.20.1
 [0.20.0]: https://github.com/ManageIQ/floe/compare/v0.19.2...v0.20.0

data/lib/floe/container_runner/docker.rb

@@ -48,7 +48,7 @@ module Floe
       end
 
       def wait(timeout: nil, events: %i[create update delete], &block)
-        until_timestamp = (Time.now.utc + timeout).to_i if timeout
+        until_timestamp = Time.now.utc + timeout if timeout
 
         r, w = IO.pipe
 
@@ -168,7 +168,7 @@ module Floe
         since_timestamp = Time.now.utc.to_i
 
         params  = ["events", "--format", "{{json .}}", "--filter", "type=container", "--since", since_timestamp.to_s]
-        params += ["--until", until_timestamp.to_s] if until_timestamp
+        params += ["--until", until_timestamp.to_i.to_s] if until_timestamp
         params
       end
 

data/lib/floe/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Floe
-  VERSION = "0.21.0"
+  VERSION = "0.22.0"
 end

data/lib/floe/workflow/context.rb

@@ -26,7 +26,7 @@ module Floe
         raise Floe::InvalidExecutionInput, "Invalid State Machine Execution Input: #{err}: was expecting (JSON String, Number, Array, Object or token 'null', 'true' or 'false')"
       end
 
-      def prepare_start(start_at)
+      def prepare_start(start_at, timeout_seconds: nil)
         return if started?
 
         state["Name"]  = start_at
@@ -35,6 +35,7 @@ module Floe
 
         execution["Id"]      ||= SecureRandom.uuid
         execution["StartTime"] = Time.now.utc.iso8601
+        execution["TimeoutAt"] = (Time.now.utc + timeout_seconds).iso8601 if timeout_seconds
 
         if logger.respond_to?(:execution_id=)
           logger.execution_id = execution["Id"]

data/lib/floe/workflow/state.rb

@@ -45,8 +45,9 @@ module Floe
       def run_nonblock!(context)
         # Only start the state if it isn't already started and it isn't waiting
         # from a prior Retry.
-        start(context)       unless started?(context) || waiting?(context)
-        return Errno::EAGAIN unless ready?(context)
+        start(context)           unless started?(context) || waiting?(context)
+        raise Floe::TimeoutError if timed_out?(context)
+        return Errno::EAGAIN     unless ready?(context)
 
         finish(context)
       rescue Floe::ExecutionError => e
@@ -115,6 +116,15 @@ module Floe
         context.state["WaitUntil"] && Time.parse(context.state["WaitUntil"])
       end
 
+      def timeout_at(context)
+        context.execution["TimeoutAt"] && Time.parse(context.execution["TimeoutAt"])
+      end
+
+      def timed_out?(context)
+        t = timeout_at(context)
+        t && Time.now.utc > t
+      end
+
       def short_name
         name.last
       end

data/lib/floe/workflow/states/task.rb

@@ -39,8 +39,7 @@ module Floe
         def start(context)
           super
 
-          # Wakeup no later than timeout_seconds to check if the Resource has timed out
-          wait_until!(context, :seconds => timeout_seconds) if timeout_seconds
+          set_timeout_at!(context)
 
           input          = process_input(context)
           secrets        = credentials&.value(context, context.input)
@@ -62,7 +61,6 @@ module Floe
         end
 
         def running?(context)
-          raise Floe::TimeoutError if timed_out?(context)
           return false if finished?(context)
 
           runner.status!(context.state["RunnerContext"])
@@ -80,8 +78,25 @@ module Floe
           @end
         end
 
+        def timeout_at(context)
+          workflow_timeout = super
+          task_timeout     = context.state["TimeoutAt"] && Time.parse(context.state["TimeoutAt"])
+
+          [workflow_timeout, task_timeout].compact.min
+        end
+
         private
 
+        def set_timeout_at!(context)
+          return if timeout_seconds.nil? && timeout_seconds_path.nil?
+
+          entered_time = Time.parse(context.state["EnteredTime"])
+          seconds      = timeout_seconds || timeout_seconds_path.value(context, context.input)
+          raise Floe::PathError, "TimeoutSecondsPath references an invalid value [#{seconds}]" unless seconds.kind_of?(Integer) && seconds > 0
+
+          context.state["TimeoutAt"] = (entered_time + seconds).iso8601
+        end
+
         attr_reader :runner
 
         def validate_state!(workflow)
@@ -107,22 +122,6 @@ module Floe
           runner.success?(context.state["RunnerContext"])
         end
 
-        def timed_out?(context)
-          return false if timeout_seconds.nil? && timeout_seconds_path.nil?
-
-          timeout      = timeout_seconds || timeout_seconds_path.value(context, context.input)
-          entered_time = Time.parse(context.state["EnteredTime"])
-
-          Time.now.utc > entered_time + timeout
-        end
-
-        def task_timed_out!(context)
-          context.state["RunnerContext"]["Error"] = "States.Timeout"
-          context.state["RunnerContext"]["Cause"] = "Task timed out"
-
-          false
-        end
-
         def parse_error(output)
           return if output.nil?
           return output if output.kind_of?(Hash)

data/lib/floe/workflow.rb

@@ -42,9 +42,10 @@ module Floe
           break if timeout && (timeout.zero? || Time.now.utc > run_until)
 
           # Find the earliest time that we should wakeup if no container events
-          # are caught, either a workflow in a Wait or Retry state or we've
-          # exceeded the requested timeout
+          # are caught, either a workflow in a Wait, Retry, or Timeout state or
+          # we've exceeded the requested timeout
           wait_until = workflows.map(&:wait_until)
+                                .concat(workflows.map(&:timeout_at))
                                 .unshift(run_until)
                                 .compact
                                 .min
@@ -77,7 +78,7 @@ module Floe
       end
     end
 
-    attr_reader :comment, :context
+    attr_reader :comment, :context, :timeout_seconds, :version
 
     def initialize(payload, context = nil, credentials = nil, name = nil)
       payload     = JSON.parse(payload)     if payload.kind_of?(String)
@@ -88,8 +89,10 @@ module Floe
       # caller should really put credentials into context and not pass that variable
       context.credentials = credentials if credentials
 
-      @context = context
-      @comment = payload["Comment"]
+      @context         = context
+      @comment         = payload["Comment"]
+      @timeout_seconds = payload["TimeoutSeconds"]
+      @version         = payload["Version"] || "1.0"
 
       super(payload, name)
     rescue Floe::Error
@@ -136,6 +139,10 @@ module Floe
       current_state.wait_until(context)
     end
 
+    def timeout_at
+      current_state.timeout_at(context)
+    end
+
     def status
       context.status
     end
@@ -150,7 +157,7 @@ module Floe
 
     # setup a workflow
     def start_workflow
-      context.prepare_start(start_at)
+      context.prepare_start(start_at, :timeout_seconds => timeout_seconds)
       self
     end
 
@@ -170,6 +177,13 @@ module Floe
 
     private
 
+    def validate_workflow!
+      super
+      return unless timeout_seconds
+
+      invalid_field_error!("TimeoutSeconds", timeout_seconds, "must be a positive, non-zero integer") unless timeout_seconds.kind_of?(Integer) && timeout_seconds.positive?
+    end
+
     def step!
       next_state = {"Name" => context.next_state, "Guid" => SecureRandom.uuid, "PreviousStateGuid" => context.state["Guid"]}
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: floe
 version: !ruby/object:Gem::Version
-  version: 0.21.0
+  version: 0.22.0
 platform: ruby
 authors:
 - ManageIQ Developers