business_flow 0.18.1 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9163d03b65bfd1a9419b31593b1e7efca00c7eb1b13838dab9a5c402597e14e1
-  data.tar.gz: 65cb6f0168df3fb353c70a7db3614950be0fce5304f99529357e9ccdf664d1e7
+  metadata.gz: 358d1c9f044cb27c403f3f09dca2ff62306a43a86b89cbdbd0a5bd2f1052384b
+  data.tar.gz: 9ace3fc7d47f1f383dbe5a5dcee90891b790bc5dfe602530c3230f5ae2b11db9
 SHA512:
-  metadata.gz: 156666c6666f24bd1d4bfa024d63b337c33cec5055cb7918bde71428e452609d37b45da7f8dd74d7aafd1890952006ca89b17eeaf508fe7d70f14bb408d71522
-  data.tar.gz: a907affc0aea2953272d33cb836b42ab8b6729a4a9ce43eaf88617ea03aae510efff9dfeb30f61198dd18a16d61ae88698d873a95223404c763d717be50ad9f3
+  metadata.gz: 12300927b4b0ed87c5961d86709d030059fb3734c54680b17c450a1e3f64d6e28fe2c22c158e9578f24ce137c0a24952bc3c14a501c24332fb7baf292ffedff8
+  data.tar.gz: b53b551074f8edb4fddc50791e1f6a64682205f49af85b1cbf6915f57677b9ab6f762c4c1e100eee658477f78b9c9abfc7199b5594490524144bf0653e5825a5

data/Gemfile.lock

@@ -1,53 +1,52 @@
 PATH
   remote: .
   specs:
-    business_flow (0.18.1)
+    business_flow (0.19.0)
       activemodel (>= 4.2, < 8)
       activesupport (>= 4.2, < 8)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (7.0.2)
-      activesupport (= 7.0.2)
-    activesupport (7.0.2)
+    activemodel (7.0.4)
+      activesupport (= 7.0.4)
+    activesupport (7.0.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
     ast (2.4.2)
-    codeclimate-engine-rb (0.4.2)
-    concurrent-ruby (1.1.9)
+    concurrent-ruby (1.1.10)
     diff-lcs (1.5.0)
-    docile (1.1.5)
-    i18n (1.9.1)
+    docile (1.4.0)
+    i18n (1.12.0)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.4)
-    json (2.6.1)
-    minitest (5.15.0)
-    parallel (1.21.0)
-    parser (2.5.3.0)
-      ast (~> 2.4.0)
+    kwalify (0.7.2)
+    minitest (5.16.3)
+    parallel (1.22.1)
+    parser (3.2.2.1)
+      ast (~> 2.4.1)
     rainbow (3.1.1)
     rake (10.5.0)
-    reek (4.8.2)
-      codeclimate-engine-rb (~> 0.4.0)
-      parser (>= 2.5.0.0, < 2.6)
+    reek (6.1.4)
+      kwalify (~> 0.7.0)
+      parser (~> 3.2.0)
       rainbow (>= 2.0, < 4.0)
     retryable (3.0.5)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.2)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.2)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.3)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.3)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
     rubocop (0.68.1)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
@@ -58,13 +57,14 @@ GEM
     rubocop-rspec (1.24.0)
       rubocop (>= 0.53.0)
     ruby-progressbar (1.11.0)
-    simplecov (0.15.1)
-      docile (~> 1.1.0)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
-    timecop (0.9.4)
-    tzinfo (2.0.4)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    timecop (0.9.6)
+    tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
     unicode-display_width (1.5.0)
 
@@ -74,12 +74,12 @@ PLATFORMS
 DEPENDENCIES
   business_flow!
   rake (~> 10.0)
-  reek (~> 4.8)
+  reek (~> 6.1)
   retryable (~> 3.0.4)
   rspec (~> 3.0)
   rubocop (~> 0.53)
   rubocop-rspec (~> 1.24.0)
-  simplecov (~> 0.15.1)
+  simplecov (~> 0.22.0)
   timecop (~> 0.9.1)
 
 BUNDLED WITH

data/business_flow.gemspec

@@ -24,11 +24,11 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'activesupport', '>= 4.2', '< 8'
 
   spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'reek', '~> 4.8'
+  spec.add_development_dependency 'reek', '~> 6.1'
   spec.add_development_dependency 'retryable', '~> 3.0.4'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rubocop', '~> 0.53'
   spec.add_development_dependency 'rubocop-rspec', '~> 1.24.0'
-  spec.add_development_dependency 'simplecov', '~> 0.15.1'
+  spec.add_development_dependency 'simplecov', '~> 0.22.0'
   spec.add_development_dependency 'timecop', '~> 0.9.1'
 end

data/lib/business_flow/cluster_lock.rb

@@ -0,0 +1,193 @@
+# frozen_string_literal: true
+
+module BusinessFlow
+  # Mixin for business flow to acquire and retain a cluster lock.
+  module ClusterLock
+    def self.included(klass)
+      klass.extend(ClassMethods)
+    end
+
+    def self.disable!
+      @disabled = true
+    end
+
+    def self.enable!
+      @disabled = false
+    end
+
+    def self.disabled?
+      !!@disabled
+    end
+
+    def self.default_servers=(servers)
+      if servers.is_a?(String)
+        @default_servers = proc { servers }
+      elsif servers
+        @default_servers = Callable.new(servers)
+      else
+        @default_servers = nil
+      end
+    end
+
+    def self.default_servers
+      @default_servers ||= proc { nil }
+    end
+
+    def assert_cluster_lock!
+      @_business_flow_cluster_lock.assert! if !BusinessFlow::ClusterLock.disabled?
+    rescue ZK::Exceptions::ZKError => exc
+      errors.add(:cluster_lock, :assert_failed, message: exc.message)
+      raise
+    end
+
+    # DSL Methods
+    module ClassMethods
+      # 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
+          errors.add(:cluster_lock, error_type, message: message) if !errors.key?(:cluster_lock)
+          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 }), {})
+        elsif lock_name || blk
+          @lock_name = Step.new(Callable.new(lock_name || blk),
+                                { default_output: :lock_name }.merge(opts))
+        else
+          @lock_name ||= Step.new(Callable.new(default_lock_name), opts)
+        end
+      end
+
+      def with_zookeeper_servers(servers = nil, opts = {}, &blk)
+        if servers.is_a?(String)
+          @zookeeper_servers = Step.new(Callable.new(proc { servers }), {})
+        elsif servers || blk
+          @zookeeper_servers = Step.new(Callable.new(servers || blk),
+                                        { default_output: :zookeeper_servers }.merge(opts))
+        else
+          @zookeeper_servers || Step.new(BusinessFlow::ClusterLock.default_servers, opts)
+        end
+      end
+
+      def default_lock_name
+        proc { self.class.name }
+      end
+
+      def build(parameter_object)
+        add_cluster_luck_info_to_result_class
+        super(parameter_object)
+      end
+
+      def execute(flow)
+        lock_info = LockInfo.new(
+          ClassMethods.lock_name(flow),
+          ClassMethods.zookeeper_server_list(flow)
+        )
+        ClassMethods.with_lock(flow, lock_info) do
+          super(flow)._business_flow_cluster_lock_finalize(lock_info)
+        end
+      rescue LockFailure => exc
+        return result_from(exc.add_to(flow))._business_flow_cluster_lock_finalize(lock_info)
+      end
+
+      RESULT_FINALIZE = proc do |cluster_lock_info|
+        @cluster_lock_info = cluster_lock_info
+        self
+      end
+
+      def add_cluster_luck_info_to_result_class
+        return if @cluster_lock_info_added
+        result_class = const_get(:Result)
+        DSL::PublicField.new(:cluster_lock_info).add_to(result_class)
+        result_class.send(:define_method, :_business_flow_cluster_lock_finalize,
+                          RESULT_FINALIZE)
+        @cluster_lock_info_added = true
+      end
+
+      # :reek:NilCheck
+      def self.zookeeper_server_list(flow)
+        servers = catch(:halt_step) { flow.class.with_zookeeper_servers.call(flow)&.merge_into(flow)&.to_s }
+        if servers.nil? || servers.length == 0
+          raise LockFailure.new(:no_servers, 'no zookeeper servers provided')
+        end
+        servers
+      end
+
+      # :reek:NilCheck
+      def self.lock_name(flow)
+        lock_name = catch(:halt_step) { flow.class.with_cluster_lock.call(flow)&.merge_into(flow)&.to_s }
+        if lock_name.nil? || lock_name.length == 0
+          raise LockFailure.new(:no_lock_name, 'no lock name provided')
+        end
+        lock_name
+      end
+
+      def self.instrumented_acquire_lock(flow, lock_info)
+        flow.class.instrument(:cluster_lock_setup, flow) do |payload|
+          payload[:lock_name] = lock_info.lock_name if payload
+          acquire_lock(flow, lock_info, payload)
+        end
+      end
+
+      def self.acquire_lock(flow, lock_info, payload)
+        zk_connection = ZK::Client::Threaded.new(lock_info.zookeeper_servers)
+        lock = flow.instance_variable_set(
+          :@_business_flow_cluster_lock,
+          ZK::Locker::ExclusiveLocker.new(zk_connection, lock_info.lock_name)
+        )
+        inner_acquire_lock(zk_connection, lock, payload)
+      end
+
+      def self.inner_acquire_lock(zk_connection, lock, payload)
+        lock_held = lock.lock(wait: false)
+        payload[:lock_acquired] = lock_held if payload
+        if !lock_held
+          zk_connection.close!
+          raise LockFailure.new(:lock_unavailable, 'the lock was not available')
+        end
+        [zk_connection, lock]
+      end
+
+      def self.cleanup(lock, zk_connection)
+        lock.unlock if lock
+        zk_connection.close! if zk_connection
+      end
+
+      def self.with_lock(flow, lock_info, &blk)
+        zk_connection, lock =
+          if !BusinessFlow::ClusterLock.disabled?
+            instrumented_acquire_lock(flow, lock_info)
+          end
+        yield lock_info
+      rescue ZK::Exceptions::LockAssertionFailedError => exc
+        # 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(:assert_failed, exc.message)
+      rescue ZK::Exceptions::OperationTimeOut
+        # Sometimes this happens. Just let the ensure block take care of everything
+      ensure
+        cleanup(lock, zk_connection)
+      end
+    end
+  end
+end

data/lib/business_flow/compat.rb

@@ -14,7 +14,7 @@ module BusinessFlow
 
     if !ActiveModel::Errors.instance_methods.include?(:merge!)
       # ActiveModel 5 added details (which we do not use here) and #merge!
-      # :reek:PrimaDonnaMethod Look it's the API.
+      # :reek:MissingSafeMethod Look it's the API.
       class ::ActiveModel::Errors
         def merge!(other)
           other.each do |attribute, message|

data/lib/business_flow/dsl.rb

@@ -103,7 +103,9 @@ module BusinessFlow
       end
 
       def call(parameter_object = {})
-        execute(build(parameter_object))
+        flow = build(parameter_object)
+        return result_from(flow) if flow.errors?
+        execute(flow)
       end
 
       # :reek:UtilityFunction This is a function on us so that other modules

data/lib/business_flow/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BusinessFlow
-  VERSION = '0.18.1'.freeze
+  VERSION = '0.19.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: business_flow
 version: !ruby/object:Gem::Version
-  version: 0.18.1
+  version: 0.19.0
 platform: ruby
 authors:
 - Alex Scarborough
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-01 00:00:00.000000000 Z
+date: 2023-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -70,14 +70,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.8'
+        version: '6.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.8'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: retryable
   requirement: !ruby/object:Gem::Requirement
@@ -140,14 +140,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.15.1
+        version: 0.22.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.15.1
+        version: 0.22.0
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -184,6 +184,7 @@ files:
 - lib/business_flow/base.rb
 - lib/business_flow/cacheable.rb
 - lib/business_flow/callable.rb
+- lib/business_flow/cluster_lock.rb
 - lib/business_flow/compat.rb
 - lib/business_flow/default_step_executor.rb
 - lib/business_flow/dsl.rb