deploy_pin 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a760ef5554d4821d4e57eca80bd547a24f5456c7e2bd27768fc2d62db3bad25e
-  data.tar.gz: 33e218e88444b4362b29d7f506fcdc455f07c07b4c6760228043b5f403687948
+  metadata.gz: f3006ccc3913b4cc7ee0b5d68b316ffb70ecef2bbfeae27c7efec65422246cdb
+  data.tar.gz: d055a8554b590bc039915d3a2866f23aa8541db9ffe8c2c933294f54c2013785
 SHA512:
-  metadata.gz: fbae2f1401711aabf1e88e3e01daeb2b8a1e07a4f3072fb8d54eb9f0f40f0bb74a4eaaed7859cd4119574544a2814393a44dcb7297808db6f89dd7e659d03220
-  data.tar.gz: cb8203f11fefb55c2e525fb2b6a2ca82e0d8791b69c64717d3f830bf2c5a3cf91977cb3e3842d780aa6084171795154eb548546a610798a60c53938b35f7173b
+  metadata.gz: 70d4054142995c62609666711a87d4d4e42783bf4631e61f3a43e3407a9cd68654de65b0925655ca416fb65e41bccd3a2246125e446f5f4d8a9cb48f70e7ffd4
+  data.tar.gz: 654cbb997e23bf9a2cc9d8579e71646f68fd669dfd92235da2a1d15b8b3d9775b01db714ce99e79e23e6389282a907c2f9ae5b573c348bd4b0d3f43105989903

data/lib/deploy_pin/collector.rb

@@ -19,7 +19,11 @@ module DeployPin
         yield(index, _tasks.count, task, executable)
 
         # run if executable
-        task.run if executable
+        if executable
+          run_with_timeout(!task.explicit_timeout? && !task.parallel?) do
+            task.run
+          end
+        end
 
         # mark each task as done
         task.mark unless task.done?
@@ -46,23 +50,30 @@ module DeployPin
     end
 
     private
+      # :reek:UtilityFunction
+      def files
+        Dir["#{DeployPin.tasks_path}/*.rb"]
+      end
 
-    def files
-      Dir["#{DeployPin.tasks_path}/*.rb"]
-    end
+      def tasks
+        files.map do |file|
+          task = DeployPin::Task.new(file)
+          task.parse_file
 
-    def tasks
-      files.map do |file|
-        task = DeployPin::Task.new(file)
-        task.parse_file
+          # check if task is suitable
+          task if task_criteria.suitable?(task)
+        end.compact.sort # sort by group position in config
+      end
 
-        # check if task is suitable
-        task if task_criteria.suitable?(task)
-      end.compact.sort # sort by group position in config
-    end
+      def task_criteria
+        @task_criteria ||= DeployPin::TaskCriteria.new(identifiers: identifiers)
+      end
 
-    def task_criteria
-      @task_criteria ||= DeployPin::TaskCriteria.new(identifiers: identifiers)
-    end
+      # :reek:UtilityFunction and :reek:ControlParameter
+      def run_with_timeout(under_timeout, &block)
+        return yield unless under_timeout
+
+        DeployPin::Database.execute_with_timeout(DeployPin.statement_timeout, **{}, &block)
+      end
   end
 end

data/lib/deploy_pin/database.rb

@@ -2,6 +2,9 @@
 
 module DeployPin
   module Database
+    PG_TIMEOUT_STATEMENT = 'SET statement_timeout TO %s'
+    MYSQL_TIMEOUT_STATEMENT = 'SET max_execution_time = %s'
+
     extend self
 
     # Run a block under a sql maximum timeout.
@@ -46,7 +49,7 @@ module DeployPin
 
       return call_block_under_timeout(timeout, &blk) unless params.key? :connected_to
 
-      klass = params[:connected_to].key? :database ? ActiveRecord::Base : ::ApplicationRecord
+      klass = params[:connected_to].key?(:database) ? ActiveRecord::Base : ::ApplicationRecord
       klass.connected_to(**params[:connected_to]) do
         call_block_under_timeout(timeout, &blk)
       end
@@ -65,32 +68,24 @@ module DeployPin
 
         timeout_statement =
           if postgresql?
-            postgresql_timeout_statement
+            PG_TIMEOUT_STATEMENT
           elsif mysql?
-            mysql_timeout_statement
+            MYSQL_TIMEOUT_STATEMENT
           end
 
-        connection.select_all "#{timeout_statement} #{connection.quote(timeout_in_milliseconds)}"
+        connection.execute timeout_statement % connection.quote(timeout_in_milliseconds)
       end
 
       def postgresql?
         connection.adapter_name =~ /postg/i
       end
 
-      def postgresql_timeout_statement
-        "SET statement_timeout TO"
-      end
-
       def mysql?
         connection.adapter_name =~ /mysql/i
       end
 
-      def mysql_timeout_statement
-        "SET max_execution_time ="
-      end
-
       def connection
         ActiveRecord::Base.connection
       end
   end
-end
+end

data/lib/deploy_pin/parallel_wrapper.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module DeployPin
+  # Parallel wrapper to run parallel tasks using database statement timeout.
+  # This wrapper keeps parallel interface, but running the processes under db statement timeout.
+  #
+  # In order to use this wrapper, just use call parallel methods with `parallel_`. Ex.:
+  #   parallel_each(1..2, in_processes: 2, timeout: 0.3.seconds) do |i|
+  #     puts "Item: #{i}, Worker: #{Parallel.worker_number}"
+  #     ActiveRecord::Base.connection.execute("<some db query>")
+  #   end
+  #
+  # In order to pass more `timeout` options, it requires to pass an array, like:
+  #   parallel_each(1..2, in_processes: 2, timeout: [0.3.seconds, { connected_to: { role: :reading } }]) do |i|
+  #     puts "Item: #{i}, Worker: #{Parallel.worker_number}"
+  #     ActiveRecord::Base.connection.execute("<some db query>")
+  #   end
+  module ParallelWrapper
+    PARALLEL_PREFIX = 'parallel_'
+
+    # :reek:TooManyInstanceVariables
+    class ParallelRunner
+      def initialize(method_name, *args, &db_block)
+        @method_name = method_name
+        @db_block = db_block
+
+        if args.last.is_a?(Hash) && args.last.key?(:timeout)
+          @timeout_args = args.pop
+          prepare_timeout_args
+        end
+
+        @parallel_args = args
+      end
+
+      def run
+        raise 'You must provide at least one argument for parallel methods' if parallel_args.empty?
+
+        Parallel.send(parallel_method_name, *parallel_args) do |*block_args|
+          ActiveRecord::Base.connection_pool.with_connection do
+            DeployPin::Database.execute_with_timeout(timeout, **timeout_params) do
+              db_block.call(*block_args)
+            end
+          end
+        end
+      end
+
+      private
+
+        attr_accessor :method_name, :parallel_args, :db_block
+
+        def prepare_timeout_args
+          timeout = @timeout_args[:timeout]
+          if timeout.is_a?(Array)
+            @timeout = timeout.shift
+            @timeout_params = timeout.first
+          else
+            @timeout = timeout
+          end
+        end
+
+        def timeout
+          @timeout ||= DeployPin.statement_timeout
+        end
+
+        def timeout_params
+          @timeout_params ||= {}
+        end
+
+        def parallel_method_name
+          @parallel_method_name ||= method_name.to_s.gsub(PARALLEL_PREFIX, '').to_sym
+        end
+    end
+
+    def method_missing(name, *args, &block)
+      return super unless respond_to_missing?(name)
+
+      ParallelRunner.new(name, *args, &block).run
+    end
+
+    # :reek:ManualDispatch and :reek:BooleanParameter
+    def respond_to_missing?(method_name, include_private = false)
+      return super unless parallel_prefix_pattern.match? method_name
+
+      parallel_method_name = method_name.to_s.gsub(PARALLEL_PREFIX, '').to_sym
+
+      Parallel.respond_to?(parallel_method_name) || super
+    end
+
+    private
+
+      def parallel_prefix_pattern
+        @parallel_prefix_pattern ||= /\A#{PARALLEL_PREFIX}/
+      end
+  end
+end

data/lib/deploy_pin/task.rb

@@ -3,11 +3,15 @@
 # Task wrapper
 module DeployPin
   class Task
+    extend ::DeployPin::ParallelWrapper
+    include ::DeployPin::ParallelWrapper
+
     attr_reader :file,
                 :uuid,
                 :group,
                 :title,
-                :script
+                :script,
+                :explicit_timeout
 
     def initialize(file)
       @file = file
@@ -15,6 +19,8 @@ module DeployPin
       @group = nil
       @title = ''
       @script = ''
+      @explicit_timeout = false
+      @parallel = false
     end
 
     def run
@@ -31,6 +37,14 @@ module DeployPin
       DeployPin::Record.where(uuid: uuid).exists?
     end
 
+    def explicit_timeout?
+      @explicit_timeout
+    end
+
+    def parallel?
+      @parallel
+    end
+
     def parse_file
       File.foreach(file) do |line|
         case line.strip
@@ -41,6 +55,9 @@ module DeployPin
           @title = Regexp.last_match(1).strip
         when /\A[^#].*/
           @script += line
+
+          @explicit_timeout = true if line =~ /Database.execute_with_timeout.*/
+          @parallel = true if line =~ /[Pp]arallel.*/
         end
       end
     end
@@ -60,13 +77,13 @@ module DeployPin
 
     protected
 
-    # for sorting
-    def <=>(other)
-      group_index <=> other.group_index
-    end
+      # for sorting
+      def <=>(other)
+        group_index <=> other.group_index
+      end
 
-    def group_index
-      DeployPin.groups.index(group)
-    end
+      def group_index
+        DeployPin.groups.index(group)
+      end
   end
 end

data/lib/deploy_pin/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DeployPin
-  VERSION = '1.3.0'
+  VERSION = '1.3.1'
 end

data/lib/deploy_pin.rb

@@ -2,6 +2,7 @@
 
 require 'deploy_pin/runner'
 require 'deploy_pin/collector'
+require 'deploy_pin/parallel_wrapper'
 require 'deploy_pin/task'
 require 'deploy_pin/task_criteria'
 require 'deploy_pin/engine'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deploy_pin
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Viktor Sych
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-16 00:00:00.000000000 Z
+date: 2022-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -166,6 +166,7 @@ files:
 - lib/deploy_pin/collector.rb
 - lib/deploy_pin/database.rb
 - lib/deploy_pin/engine.rb
+- lib/deploy_pin/parallel_wrapper.rb
 - lib/deploy_pin/runner.rb
 - lib/deploy_pin/task.rb
 - lib/deploy_pin/task_criteria.rb