deploy_pin 1.5.1 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c21646b048b09408bf131ab463208e76dd54b18596dcdfce4c16fae3fa1669f1
-  data.tar.gz: 5ac45e42ba5a3af95dadbf44031e683997f8fe42a8e422f1d7114f5007437e8e
+  metadata.gz: ced30166491b43cb26d26c837ca1276e9825d3b48631cea70f3095e0a8590d01
+  data.tar.gz: '0538bf5ea753ba70a2daa8e2104939d38d8605f8ae72d284417bcbe249659a4f'
 SHA512:
-  metadata.gz: 6137f6270259681a0a74188e1a0145894d25eb77bde43d8ed47b9dea38c1ab7733ca618b44ac04d15e6ebbaf3f565200cb09af3ee91e8f9b2fca756ee9c5c250
-  data.tar.gz: 8551c4fadd20f97cd19584566408a115d42a9402b45b46fba4c4fdf6e94b3f1b9b074136287b814ca3ff1603bfe77b5fa51bbc9814fcdf1ef59f421dd6052025
+  metadata.gz: f16f07130b5544236e0a17d0658e2c1b5ec2eb2103a5321c4f11ef391492f87c056b69e8b8498553f686e1523989f6723bec205147760fc2c12062f266c3a27e
+  data.tar.gz: 64424aa72c121603c5ddd23f9e15051fca979b4e3393b1ed942b0319aadd3d441515d24203201148c8c125aed4c6dcb0e43b4c2079466e430f7681a56c5700e8

data/README.md

@@ -6,8 +6,6 @@
 
 # DeployPin
 
-![DeployPin](http://hereisfree.com/content1//pic/zip/2009109935062477801.jpg)
-
 Deploying applications often involves the need to execute a series of specific commands or tasks either before or after the deployment process. While you might typically turn to migrations for such operations, these tasks aren't always migration-related. Additionally, there are situations where you need to execute code before or after a migration without causing the main thread to block.
 
 Introducing deploy_pins – your go-to solution for streamlined task management during the deployment process. This Ruby library allows you to seamlessly orchestrate tasks before, after, or independently of migrations, offering the flexibility you need to maintain a smooth and efficient deployment workflow. With deploy_pins, you can take control of your deployment tasks and ensure that your application operates flawlessly in any environment.
@@ -178,6 +176,30 @@ end
 
 To use a different formatting value than the default, you need to specify it explicitly in the task, similar to the database timeout configuration.
 
+## Resumable Tasks
+
+When working with long-running code that processes a large dataset, it makes sense to store progress in the database to allow resuming the task later. You can do this by using the `DeployPin::Task` instance methods: `#progress` and `#increment_progress(num)`.
+
+Here is an example of how to use these methods:
+
+```ruby
+# Some DeployPin task
+...
+# === task code goes here ===
+
+# The progress is 0 by default
+Users.where(id: progress..).find_each do |user|
+  # Do some work
+  increment_progress(1) # Increment progress by 1 and store it in the database so you can resume the task from this point
+end
+```
+
+This allows your task to resume from where it left off, minimizing the risk of repeating work.
+
+
+
+```bash
+
 ## Recurring Tasks
 If you want to generate a recurring task, you can use the `--recurring` option. Make sure to set a correct `--identifier`, which should be a numeric value. Positive and negative numbers are possible here. The identifier affects the order of task execution, allowing you to customize the sequence as desired.
 
@@ -192,27 +214,29 @@ rails g deploy_pin:task some_task_title --parallel --recurring --identifier 5
 ## DeploymentStateTrack
 In the initializer
 ```ruby
-    DeployPin.setup do
-      groups %w[I II III post rollback]
-      ...
-      deployment_state_transition({
-        ongoing: %w[I III],
-        pending: "rollback", # enters to pending step before "rollback"
-        ttl: 20.second, # memoize the state to avoid Redis spam
-        redis_url: "redis://localhost:6379"
-      })
-    end
+DeployPin.setup do
+  groups %w[I II III post rollback]
+  ...
+  deployment_state_transition({
+    ongoing: %w[I III],
+    pending: "rollback", # enters to pending step before "rollback"
+    ttl: 20.second, # memoize the state to avoid Redis spam
+    redis_url: "redis://localhost:6379"
+  })
+end
 
-    # enabled next methods
-    DeployPin.ongoing_deployment?
-    DeployPin.pending_deployment?
+# enabled next methods
+DeployPin.ongoing_deployment?
+DeployPin.pending_deployment?
 ```
 
 Around the deployment
 ```bash
-    bundle exec rake deploy_pin:run[I, II, III] - # enters to ongoing state before "I" and leaves it after "III" so all tasks in I, II, III have DeployPin.oingoing_deployment? == true
-    bundle exec rake deploy_pin:run[rollback] - # enters "pending state"
+bundle exec rake deploy_pin:run[I, II, III] - # enters to ongoing state before "I" and leaves it after "III" so all tasks in I, II, III have DeployPin.oingoing_deployment? == true
+bundle exec rake deploy_pin:run[rollback] - # enters "pending state"
 ```
+## Similar Gems
+- https://github.com/theSteveMitchell/after_party
 
 ## Contributing
 Contribution directions go here.

data/lib/deploy_pin/collector.rb

@@ -12,50 +12,51 @@ module DeployPin
     # :reek:TooManyStatements
     def run
       # cache tasks
-      _tasks = tasks
-      _tasks.each_with_index do |task, index|
-        DeployPin.task_wrapper.call(task, -> { process(_tasks, task, index) })
+      tasks = init_tasks
+      tasks.each_with_index do |task, index|
+        DeployPin.task_wrapper.call(task, -> { process(tasks, task, index) })
       end
     end
     # :reek:TooManyStatements
 
     def list
-      _tasks = tasks
-      _tasks.each_with_index do |task, index|
+      tasks = init_tasks
+      tasks.each_with_index do |task, index|
         DeployPin.list_formatter.call(index, task)
       end
     end
 
     def executable
       # cache tasks
-      _tasks = tasks
-      _tasks.map.with_index do |task, index|
-        task if _tasks[0..index].none? { |_task| task.eql?(_task) }
+      tasks = init_tasks
+      tasks.map.with_index do |task, index|
+        task if tasks[0..index].none? { |other_task| task.eql?(other_task) }
       end.compact
     end
 
     def tasks_count
-      tasks.count
+      init_tasks.count
     end
 
     private
 
       # :reek:FeatureEnvy
       # :reek:TooManyStatements
-      def process(cached_tasks, task, index)
+      def process(tasks, task, index)
         # run only uniq tasks
-        executable = cached_tasks[0..index].none? { |_task| task.eql?(_task) }
+        executable = tasks[0..index].none? { |other_task| task.eql?(other_task) }
 
-        DeployPin.run_formatter.call(index, cached_tasks.count, task, executable, true)
+        DeployPin.run_formatter.call(index, tasks.count, task, executable, true)
+
+        task.prepare
 
         # run if executable
         if executable
           duration = execution_duration { run_with_timeout(task) { task.run } }
-          DeployPin.run_formatter.call(index, cached_tasks.count, task, executable, false, duration)
+          DeployPin.run_formatter.call(index, tasks.count, task, executable, false, duration)
         end
 
-        # mark each task as done
-        task.mark unless task.done?
+        task.mark # mark each task as done
       end
       # :reek:TooManyStatements
       # :reek:FeatureEnvy
@@ -65,7 +66,7 @@ module DeployPin
         Dir["#{DeployPin.tasks_path}/*.rb"]
       end
 
-      def tasks
+      def init_tasks
         [*DeployPin.deployment_tasks_code, *files].map do |file|
           task = DeployPin::Task.new(file)
           task.parse
@@ -76,7 +77,7 @@ module DeployPin
       end
 
       def task_criteria
-        @task_criteria ||= DeployPin::TaskCriteria.new(identifiers: identifiers)
+        @task_criteria ||= DeployPin::TaskCriteria.new(identifiers:)
       end
 
       # :reek:UtilityFunction and :reek:ControlParameter

data/lib/deploy_pin/database.rb

@@ -2,13 +2,8 @@
 
 module DeployPin
   module Database
-    PG_TIMEOUT_STATEMENT = 'SET statement_timeout TO %s'
-    MYSQL_TIMEOUT_STATEMENT = 'SET max_execution_time = %s'
-
     extend self
 
-    def dummy_method; end
-
     # Run a block under a sql maximum timeout.
     #
     # A default timeout will be get from DeployPin.setup
@@ -68,23 +63,11 @@ module DeployPin
 
       def set_max_timeout(timeout)
         timeout_in_milliseconds = timeout.to_f.in_milliseconds.ceil # Make sure is always at least 1. 0 turns this off
-
-        timeout_statement =
-          if postgresql?
-            PG_TIMEOUT_STATEMENT
-          elsif mysql?
-            MYSQL_TIMEOUT_STATEMENT
-          end
-
-        connection.execute timeout_statement % connection.quote(timeout_in_milliseconds)
-      end
-
-      def postgresql?
-        connection.adapter_name =~ /postg/i
+        connection.execute db_engine::TIMEOUT_STATEMENT % connection.quote(timeout_in_milliseconds)
       end
 
-      def mysql?
-        connection.adapter_name =~ /mysql/i
+      def db_engine
+        @db_engine ||= DeployPin::DatabaseEngine.new(connection).detect
       end
 
       def connection

data/lib/deploy_pin/database_engine.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module DeployPin
+  # This class is used to detect used database engine and managing specific
+  # differences between them.
+  class DatabaseEngine
+    module PostgreSQL
+      TIMEOUT_STATEMENT = 'SET statement_timeout TO %s'
+    end
+
+    module MySQL
+      TIMEOUT_STATEMENT = 'SET max_execution_time = %s'
+    end
+
+    module MariaDB
+      TIMEOUT_STATEMENT = 'SET SESSION max_statement_time = %s'
+    end
+
+    DB_ENGINES_MAPPING = {
+      mariadb: MariaDB,
+      mysql: MySQL,
+      pg: PostgreSQL
+    }.freeze
+
+    def initialize(connection)
+      @connection = connection
+    end
+
+    def detect
+      db_engine_symbol =
+        case connection.adapter_name
+        when /postg/i then :pg
+        when /mysql/i, /trilogy/i then detect_mysql_based_engine
+        end
+
+      DB_ENGINES_MAPPING[db_engine_symbol]
+    end
+
+    private
+
+      attr_reader :connection
+
+      def detect_mysql_based_engine
+        mariadb? ? :mariadb : :mysql
+      end
+
+      def mariadb?
+        connection.select_value('SELECT VERSION()') =~ /MariaDB/i
+      end
+  end
+end

data/lib/deploy_pin/runner.rb

@@ -4,17 +4,17 @@
 module DeployPin
   module Runner
     def self.run(identifiers:)
-      DeployPin::Collector.new(identifiers: identifiers).run
+      DeployPin::Collector.new(identifiers:).run
     end
 
     def self.list(identifiers:)
-      DeployPin::Collector.new(identifiers: identifiers).list
+      DeployPin::Collector.new(identifiers:).list
     end
 
     def self.summary(identifiers:)
       # print summary
       self.print('======= Summary ========')
-      self.print("Tasks number: #{DeployPin::Collector.new(identifiers: identifiers).tasks_count}")
+      self.print("Tasks number: #{DeployPin::Collector.new(identifiers:).tasks_count}")
     end
 
     def self.print(msg)

data/lib/deploy_pin/task.rb

@@ -14,6 +14,8 @@ module DeployPin
                 :recurring,
                 :explicit_timeout
 
+    delegate :progress, to: :record
+
     def initialize(file)
       @file = file
       @identifier = nil
@@ -29,17 +31,34 @@ module DeployPin
       eval(script)
     end
 
+    def record
+      DeployPin::Record.find_by(uuid: identifier)
+    end
+
+    def prepare
+      return if recurring
+
+      DeployPin::Record.create(uuid: identifier) unless record
+    end
+
     def mark
       return if recurring
 
       # store record in the DB
-      DeployPin::Record.create(uuid: identifier)
+      record.update(completed_at: Time.current)
+    end
+
+    def increment_progress!(incrementor)
+      raise NotImplementedError, 'Recurring tasks do not support progress yet.' if recurring
+
+      record.increment!(:progress, incrementor)
     end
 
     def done?
       return if recurring
+      return unless record
 
-      DeployPin::Record.where(uuid: identifier).exists?
+      record.completed_at.present?
     end
 
     def under_timeout?
@@ -74,9 +93,9 @@ module DeployPin
 
     def details
       {
-        identifier: identifier,
-        group: group,
-        title: title
+        identifier:,
+        group:,
+        title:
       }
     end
 
@@ -104,7 +123,6 @@ module DeployPin
 
     protected
 
-
       def group_index
         DeployPin.groups.index(group)
       end

data/lib/deploy_pin/version.rb

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

data/lib/deploy_pin.rb

@@ -8,20 +8,21 @@ require 'deploy_pin/task'
 require 'deploy_pin/task_criteria'
 require 'deploy_pin/engine'
 require 'deploy_pin/database'
+require 'deploy_pin/database_engine'
 require 'parallel'
 require 'ruby-progressbar'
 require 'colorize'
 
 module DeployPin
   OPTIONS = %i[
-    tasks_path
+    deployment_state_transition
     fallback_group
     groups
-    statement_timeout
-    run_formatter
     list_formatter
+    run_formatter
+    statement_timeout
     task_wrapper
-    deployment_state_transition
+    tasks_path
   ].freeze
 
   DEFAULTS = {

data/lib/generators/deploy_pin/install/templates/create_deploy_pins.rb

@@ -4,6 +4,8 @@ class CreateDeployPins < ActiveRecord::Migration[7.0]
   def change
     create_table :deploy_pins do |t|
       t.string :uuid
+      t.integer :progress, default: 0
+      t.datetime :completed_at, default: nil
       t.timestamps
     end
   end

data/lib/generators/deploy_pin/install/templates/deploy_pin.rb

@@ -6,11 +6,11 @@ DeployPin.setup do
   fallback_group 'III'
   statement_timeout 10.minutes
   deployment_state_transition({
-    ongoing: %w[I III],
-    pending: 'rollback', # enters to pending step before "rollback"
-    ttl: 20.second, # memoize the state to avoid the store spam
-    redis_url: 'redis://localhost:6379'
-  })
+                                ongoing: %w[I III],
+                                pending: 'rollback', # enters to pending step before "rollback"
+                                ttl: 20.second, # memoize the state to avoid the store spam
+                                redis_url: 'redis://localhost:6379'
+                              })
   run_formatter(
     lambda do |index, task_count, task, executable, start, duration = nil|
       end_of_msg = if executable

data/lib/generators/deploy_pin/upgrade/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Upgrades the deploy_pins table in the DB with an extra columns for resumable tasks
+
+Example:
+    rails generate deploy_pin:upgrade
+
+    This will create:
+        db/migrate/upgrade_deploy_pins.rb

data/lib/generators/deploy_pin/upgrade/templates/upgrade_deploy_pins.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+class UpgradeDeployPins < ActiveRecord::Migration[7.0]
+  def change
+    add_column :deploy_pins, :progress, :integer, default: 0, if_not_exists: true
+    add_column :deploy_pins, :completed_at, :datetime, default: nil, if_not_exists: true
+  end
+end

data/lib/generators/deploy_pin/upgrade/upgrade_generator.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module DeployPin
+  # This generator is used to generate the migration file for upgrading db schema for 1.7 version support.
+  class UpgradeGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+
+    source_root File.expand_path('templates', __dir__)
+    desc 'Add the upgrade migration for DeployPin.'
+
+    def self.next_migration_number(path)
+      next_migration_number = current_migration_number(path) + 1
+      ActiveRecord::Migration.next_migration_number(next_migration_number)
+    end
+
+    def copy_migrations
+      migration_template 'upgrade_deploy_pins.rb', 'db/migrate/upgrade_deploy_pins.rb'
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deploy_pin
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.7.0
 platform: ruby
 authors:
 - Viktor Sych
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-19 00:00:00.000000000 Z
+date: 2024-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -235,6 +235,7 @@ files:
 - lib/deploy_pin.rb
 - lib/deploy_pin/collector.rb
 - lib/deploy_pin/database.rb
+- lib/deploy_pin/database_engine.rb
 - lib/deploy_pin/deployment_state.rb
 - lib/deploy_pin/engine.rb
 - lib/deploy_pin/parallel_wrapper.rb
@@ -250,6 +251,9 @@ files:
 - lib/generators/deploy_pin/task/task_generator.rb
 - lib/generators/deploy_pin/task/templates/parallel_task.rb.erb
 - lib/generators/deploy_pin/task/templates/task.rb.erb
+- lib/generators/deploy_pin/upgrade/USAGE
+- lib/generators/deploy_pin/upgrade/templates/upgrade_deploy_pins.rb
+- lib/generators/deploy_pin/upgrade/upgrade_generator.rb
 - lib/tasks/deploy_pin_tasks.rake
 homepage: https://github.com/skcc321/deploy_pin
 licenses:
@@ -264,14 +268,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: pin some task around deployment