business_flow 0.21.0 → 0.21.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9d5e39246745984117d29b635e976b219dd98849fa878925c740b9abdd0f499
-  data.tar.gz: bc30bd5baf31d6ed5305b830506bbf6ae777ccd4f001c74faa0971498af31ec8
+  metadata.gz: 58b3100df6d7fe1c1a09846cec4cd3df8692e7c8ab6a1a5f59387bddd116adf9
+  data.tar.gz: cc3a48bc0b5cb9932b921ebabfab8ceaf5ce64b292f7eed5e2c48e58f37912c7
 SHA512:
-  metadata.gz: efc19e3d43bdb141d74450bcb303b668fd8a6b50077cd7174f2ad71fa76a6218c22a015295f8e95639e1752342b16633ab3e84c793c8417d6ada013f52cfeee0
-  data.tar.gz: 2c231d90e0b1e32f8ff1eb15f844f1d563065c5ed34d533b2be3852d007d677bfaf22b395b98a696e2415599e78c463470735f4bb83a60955cc78cb08644c3dd
+  metadata.gz: a50eaa3074e7369e57ff20f715f77c332fbea9dc2f2904fb8cbe84e8aafcc20f0b7dc1f7c3d9681642b7b3b6db8106d8ab6bad6367368e93a81145db6a7f6381
+  data.tar.gz: 4ce3770b14b51f01b77e0bbe57d990fe0ea6156539a5154afe99a99436cd07b0ff9787b7da1a4d5757adff719d0bcbe7842f72f996c9b9578ee5eb0453c7143c

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 0.21.1
+
+ENHANCEMENTS:
+
+* Added #failure_exception= to flow classes for setting an exception causing a failure. Setting an exception also fails the flow execution.
+* Added #exception to flow result classes for reading the exception causing a failure.
+* Set #exception as the cause: on FlowFailedException.
+* ClusterLock now propogates Zookeeper errors through failure_exception and the case on its LockFailure exception.
+
 ## 0.21.0
 
 BUG FIXES:

data/lib/business_flow/cluster_lock.rb

@@ -3,6 +3,35 @@
 module BusinessFlow
   # Mixin for business flow to acquire and retain a cluster lock.
   module ClusterLock
+    # Error raised when there is an internal issue with acquiring a lock.
+    class LockFailure < StandardError
+      attr_reader :error_type
+
+      def initialize(error_type, message)
+        @error_type = error_type
+        super(message)
+      end
+
+      def add_to(flow)
+        errors = flow.errors
+        unless errors.key?(:cluster_lock)
+          BusinessFlow.add_error(errors, :cluster_lock, error_type, message)
+        end
+        flow.failure_exception = self
+        flow
+      end
+    end
+
+    # Holder for information about the lock
+    class LockInfo
+      attr_reader :lock_name, :zookeeper_servers
+
+      def initialize(lock_name, zookeeper_servers)
+        @lock_name = lock_name
+        @zookeeper_servers = zookeeper_servers
+      end
+    end
+
     def self.included(klass)
       klass.extend(ClassMethods)
     end
@@ -51,34 +80,6 @@ module BusinessFlow
 
     # DSL Methods
     module ClassMethods # rubocop:disable Metrics/ModuleLength
-      # Error raised when there is an internal issue with acquiring a lock.
-      class LockFailure < StandardError
-        attr_reader :error_type
-
-        def initialize(error_type, message)
-          @error_type = error_type
-          super(message)
-        end
-
-        def add_to(flow)
-          errors = flow.errors
-          unless errors.key?(:cluster_lock)
-            BusinessFlow.add_error(errors, :cluster_lock, error_type, message)
-          end
-          flow
-        end
-      end
-
-      # Holder for information about the lock
-      class LockInfo
-        attr_reader :lock_name, :zookeeper_servers
-
-        def initialize(lock_name, zookeeper_servers)
-          @lock_name = lock_name
-          @zookeeper_servers = zookeeper_servers
-        end
-      end
-
       def with_cluster_lock(lock_name = nil, opts = {}, &blk)
         if lock_name.is_a?(String)
           @lock_name = Step.new(Callable.new(proc { lock_name }), {})
@@ -216,7 +217,7 @@ module BusinessFlow
       rescue ZK::Exceptions::LockAssertionFailedError, ZK::Exceptions::OperationTimeOut => e
         # This would occur if we asserted a cluster lock while executing the flow.
         # This will have set an error on the flow, so we can carry on.
-        raise LockFailure.new(exception_to_error_type(e), e.message)
+        raise LockFailure.new(exception_to_error_type(e), e.message), cause: e
       ensure
         cleanup(lock, zk_connection)
       end

data/lib/business_flow/dsl.rb

@@ -128,7 +128,7 @@ module BusinessFlow
 
       def call!(*args)
         flow = call(*args)
-        raise FlowFailedException, flow if flow.errors?
+        raise FlowFailedException, flow, cause: flow.exception if flow.errors?
 
         flow
       end
@@ -154,7 +154,8 @@ module BusinessFlow
         # We use instance_variable_get here instead of making it part of
         # from_flow to ensure that we do not create the errors object unless
         # we need it.
-        result = const_get(:Result).new(flow.instance_variable_get(:@errors))
+        result = const_get(:Result).new(flow.instance_variable_get(:@errors),
+                                        flow.send(:failure_exception))
         result.from_flow(flow) if @result_copy
         result
       end
@@ -205,8 +206,11 @@ module BusinessFlow
 
     RESULT_DEF = %(
       class Result
-        def initialize(errors)
+        attr_reader :exception
+
+        def initialize(errors, exception)
           @errors = errors
+          @exception = exception
         end
 
         def errors
@@ -216,7 +220,7 @@ module BusinessFlow
         def errors?
           # We're explicitly using the instance variable here so that if no
           # errors have been created, we don't initialize the error object.
-          !!@errors && @errors.present?
+          (!!@errors && @errors.present?) || !exception.nil?
         end
 
         def valid?(_context = nil)
@@ -263,6 +267,9 @@ module BusinessFlow
     attr_reader :parameter_object
     private :parameter_object
 
+    attr_accessor :failure_exception
+    private :failure_exception
+
     def call
       return if invalid?
 

data/lib/business_flow/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BusinessFlow
-  VERSION = '0.21.0'
+  VERSION = '0.21.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: business_flow
 version: !ruby/object:Gem::Version
-  version: 0.21.0
+  version: 0.21.1
 platform: ruby
 authors:
 - Alex Scarborough