acidic_job 1.0.0.pre3 → 1.0.0.pre6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7c1aec259fa05e5cd62425643534a6944b44df91e1077dfb2eb98fa0717c3e1
-  data.tar.gz: 1e9759e91c7a10ea89f39626add3c60b5c3856d54a380958b9f4e6455c6cc937
+  metadata.gz: 9247c761078c570dfbacac2542bc8b7417c816bb9928f975bf7b92722a29f6a4
+  data.tar.gz: 8d36bb7517db0493d37eaf44aee901339a5d8d77411cad0e55fefe2d940137c6
 SHA512:
-  metadata.gz: 53d61ee2cee38e5e4a136eb37386c2bb912933ba35f839949ac411c486dd14091478d5d23ae3bb2d4ebd3f4c2d9f051e77a64ef1113f8fec2e533f7209662cdd
-  data.tar.gz: b8e4dcb13d2f4551d1cc37271003eff592bc03791c77edd3224d306d211c240b850ef258d184155511c29983af349ef9039b4b2dab99d298cc925a36217d7f11
+  metadata.gz: 47697f8b833d7061bacb2b6eaf1e6c15a9d6fec700db0891f881b8f945cf271e1c37adba9cde4572aed5d0e272767a690c172ece0937dbc212a90bc0dd02e8e5
+  data.tar.gz: cda551ac7a76a63199f03b19e7787ba0bfae414253b1e71b098b8304705458d0c8f21b1755f9f10c15b651d55b849469284754d6e585d13159ee4c28a17ed723

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    acidic_job (1.0.0.pre3)
+    acidic_job (1.0.0.pre6)
       activerecord (>= 6.1.0)
       activesupport
 
@@ -122,6 +122,8 @@ GEM
     nokogiri (1.12.3)
       mini_portile2 (~> 2.6.1)
       racc (~> 1.4)
+    nokogiri (1.12.3-x86_64-darwin)
+      racc (~> 1.4)
     noticed (1.5.7)
       http (>= 4.0.0)
       rails (>= 5.2.0)

data/README.md

@@ -40,7 +40,7 @@ Or simply execute to install the gem yourself:
 Then, use the following command to copy over the `AcidicJob::Run` migration file.
 
 ```
-rails generate acidic_job
+rails generate acidic_job:install
 ```
 
 ## Usage

data/UPGRADE_GUIDE.md

@@ -1,19 +1,19 @@
 # AcidicJob Upgrade Guide
 
-1. Update version requirements in `Gemfile`
+## 1. Update version requirements in `Gemfile`
 
-```ruby
--gem "acidic_job"
-+gem "acidic_job", "~> 1.0.0.pre1"
+```diff
+- gem "acidic_job"
++ gem "acidic_job", "~> 1.0.0.pre1"
 ```
 
 result:
 ```
-Installing acidic_job 1.0.0.pre1 (was 0.7.7)
+Installing acidic_job 1.0.0.pre4 (was 0.7.7)
 Bundle updated!
 ```
 
-2. Generate migration for new `AcidicJob::Run` model
+## 2. Generate migration for new `AcidicJob::Run` model
 
 ```bash
 rails generate acidic_job
@@ -24,7 +24,7 @@ result:
 create  db/migrate/#{yyyymmddhhmmss}_create_acidic_job_runs.rb
 ```
 
-3. Delete any unneeded `AcidicJob::Key` records
+## 3. Delete any unneeded `AcidicJob::Key` records
 
 Typically, records that are already finished do not need to be retained. Sometimes, however, applications key finished records around for some amount of time for debugging or metrics aggregation. Whatever your application's logic is for whether or not an `AcidicJob::Key` record is still needed, for all unneeded records, delete them.
 
@@ -34,7 +34,7 @@ For example, this would delete all finished `Key` records over 1 month old:
 AcidicJob::Key.where(recovery_point: AcidicJob::Key::RECOVERY_POINT_FINISHED, last_run_at: ..1.month.ago).delete_all
 ```
 
-4. Migrate `AcidicJob::Key` to `AcidicJob::Run`
+## 4. Migrate `AcidicJob::Key` to `AcidicJob::Run`
 
 `AcidicJob` ships with an upgrade module that provides a script to migrate older `Key` records to the new `Run` model.
 
@@ -47,25 +47,35 @@ This script will prepare an `insert_all` command for `Run` records by mapping th
 result:
 ```
 {
-	run_records: <Integer>,
-	key_records: <Integer>,
-	errored_keys: <Array>
+  run_records: <Integer>,
+  key_records: <Integer>,
+  errored_keys: <Array>
 }
 ```
 
-5. Triage remaining `AcidicJob::Key` records
+## 5. Triage remaining `AcidicJob::Key` records
 
 If there were any `AcidicJob::Key` records that failed to be mapped to the new `Run` model, you will need to manually triage whatever the exception was. In all likelihood, the exception would be relating to the translation of the `Key#job_args` field to the `Run#serialized_job` field, as all other fields have a fairly straight-forward mapping. If you can't resolve the issue, please open an Issue in GitHub.
 
-6. Ensure all `AcidicJob::Staged` records are processed
+## 6. Ensure all `AcidicJob::Staged` records are processed
 
 `AcidicJob` still ships with an upgrade module that provides the older `Key` and `Staged` records, so this functionality will still be present to handle any existing records in your database when you deploy the updated version.
 
-7. Remove the old tables
+## 7. Remove the old tables
 
 Once you have successfully migrated everything over and the new system has been running smoothly for some time, you should drop the old `acidic_job_keys` and `staged_acidic_jobs` tables. We provide a migration generator just for this purpose:
 
 ```bash
 rails generate acidic_job:drop_tables
+```
+
+result:
+```
+create  db/migrate/#{yyyymmddhhmmss}_drop_old_acidic_job_tables.rb
+```
+
+You can then run the migration to have those tables removed:
+
+```bash
 rails db:migrate
-```
+```

data/lib/acidic_job/run.rb

@@ -35,6 +35,19 @@ module AcidicJob
       validates :workflow, presence: true
     end
 
+    def self.purge
+      successfully_completed = where(
+        recovery_point: FINISHED_RECOVERY_POINT,
+        error_object: nil
+      )
+      count = successfully_completed.count
+
+      return 0 if count.zero?
+
+      Rails.logger.info("Deleting #{count} successfully completed AcidicJob runs")
+      successfully_completed.delete_all
+    end
+
     def finished?
       recovery_point == FINISHED_RECOVERY_POINT
     end

data/lib/acidic_job/upgrade_service.rb

@@ -3,113 +3,116 @@
 require "active_support/concern"
 
 module AcidicJob
-	# recreate the original `Key` model
-	class Key < ::ActiveRecord::Base
-		RECOVERY_POINT_FINISHED = "FINISHED"
-
-		self.table_name = "acidic_job_keys"
-
-		serialize :error_object
-		serialize :job_args
-		serialize :workflow
-		store :attr_accessors
-	end
-
-	# recreate the original `Staged` model
-	class Staged < ActiveRecord::Base
-		self.table_name = "staged_acidic_jobs"
-	
-		serialize :job_args
-
-		after_create_commit :enqueue_job
-
-		private
-	
-		# rubocop:disable Metrics/AbcSize, Metrics/MethodLength
-		def enqueue_job
-			gid = { "staged_job_gid" => to_global_id.to_s }
-	
-			if job_args.is_a?(Hash) && job_args.key?("arguments")
-				job_args["arguments"].concat([gid])
-			else
-				job_args.concat([gid])
-			end
-	
-			case adapter
-			when "activejob"
-				::ActiveJob::Base.deserialize(job_args).enqueue
-			when "sidekiq"
-				job_name.constantize.perform_async(*job_args)
-			else
-				raise UnknownJobAdapter.new(adapter: adapter)
-			end
-	
-			# NOTE: record will be deleted after the job has successfully been performed
-			true
-		end
-		# rubocop:enable Metrics/AbcSize, Metrics/MethodLength
-	end
-
-	module UpgradeService
-		def self.execute()
-			# prepare an array to hold the attribute hashes to be passed to `insert_all`
-			run_attributes = []
-			# prepare an array to hold any `Key` records that we couldn't successfully map to `Run` records
-			errored_keys = []
-
-			# iterate over all `AcidicJob::Key` records in batches, preparing a `Run` attribute hash to be passed to `insert_all`
-			::AcidicJob::Key.find_each do |key|
-				# map all of the simple attributes directly
-				attributes = {
-					id: key.id, 
-					staged: false, 
-					idempotency_key: key.idempotency_key, 
-					job_class: key.job_name, 
-					last_run_at: key.last_run_at, 
-					locked_at: key.locked_at, 
-					recovery_point: key.recovery_point, 
-					error_object: key.error_object, 
-					attr_accessors: key.attr_accessors, 
-					workflow: key.workflow, 
-					created_at: key.created_at, 
-					updated_at: key.updated_at 
-				}
-
-				# prepare the more complicated `job_args` -> `serialized_job` translation
-				job_class = key.job_name.constantize
-				if defined?(::Sidekiq) && job_class.include?(::Sidekiq::Worker)
-					job_class.include(::AcidicJob::Extensions::Sidekiq) unless job_class.include?(::AcidicJob::Extensions::Sidekiq)
-					job_instance = job_class.new
-					serialized_job = job_instance.serialize_job(*key.job_args)
-				elsif defined?(::ActiveJob) && job_class < ::ActiveJob::Base
-					job_class.include(::AcidicJob::Extensions::ActiveJob) unless job_class.include?(::AcidicJob::Extensions::ActiveJob)
-					job_args = begin
-						::ActiveJob::Arguments.deserialize(key.job_args)
-					rescue ::ActiveJob::DeserializationError
-						key.job_args
-					end
-					job_instance = job_class.new(*job_args)
-					serialized_job = job_instance.serialize_job()
-				end
-
-				attributes[:serialized_job] = serialized_job
-				run_attributes << attributes
-			rescue StandardError => exception
-				errored_keys << [exception, key]
-			end
-
-			# insert all of the `Run` records
-			::AcidicJob::Run.insert_all(run_attributes)
-
-			# delete all successfully migrated `Key` record
-			::AcidicJob::Key.where(id: ::AcidicJob::Run.select(:id)).delete_all
-
-			# return a report of the upgrade migration
-			{
-				run_records: ::AcidicJob::Run.count,
-				key_records: ::AcidicJob::Key.count,
-				errored_keys: errored_keys
-			}
-		end
-	end
+  # recreate the original `Key` model
+  class Key < ::ActiveRecord::Base
+    RECOVERY_POINT_FINISHED = "FINISHED"
+
+    self.table_name = "acidic_job_keys"
+
+    serialize :error_object
+    serialize :job_args
+    serialize :workflow
+    store :attr_accessors
+  end
+
+  # recreate the original `Staged` model
+  class Staged < ActiveRecord::Base
+    self.table_name = "staged_acidic_jobs"
+
+    serialize :job_args
+
+    after_create_commit :enqueue_job
+
+    private
+
+    def enqueue_job
+      gid = { "staged_job_gid" => to_global_id.to_s }
+
+      if job_args.is_a?(Hash) && job_args.key?("arguments")
+        job_args["arguments"].concat([gid])
+      else
+        job_args.concat([gid])
+      end
+
+      case adapter
+      when "activejob"
+        ::ActiveJob::Base.deserialize(job_args).enqueue
+      when "sidekiq"
+        job_name.constantize.perform_async(*job_args)
+      else
+        raise UnknownJobAdapter.new(adapter: adapter)
+      end
+
+      # NOTE: record will be deleted after the job has successfully been performed
+      true
+    end
+  end
+
+  module UpgradeService
+    def self.execute
+      # prepare an array to hold the attribute hashes to be passed to `insert_all`
+      run_attributes = []
+      # prepare an array to hold any `Key` records that we couldn't successfully map to `Run` records
+      errored_keys = []
+
+      # iterate over all `AcidicJob::Key` records in batches,
+      # preparing a `Run` attribute hash to be passed to `insert_all`
+      ::AcidicJob::Key.find_each do |key|
+        # map all of the simple attributes directly
+        attributes = {
+          id: key.id,
+          staged: false,
+          idempotency_key: key.idempotency_key,
+          job_class: key.job_name,
+          last_run_at: key.last_run_at,
+          locked_at: key.locked_at,
+          recovery_point: key.recovery_point,
+          error_object: key.error_object,
+          attr_accessors: key.attr_accessors,
+          workflow: key.workflow,
+          created_at: key.created_at,
+          updated_at: key.updated_at
+        }
+
+        # prepare the more complicated `job_args` -> `serialized_job` translation
+        job_class = key.job_name.constantize
+        if defined?(::Sidekiq) && job_class.include?(::Sidekiq::Worker)
+          unless job_class.include?(::AcidicJob::Extensions::Sidekiq)
+            job_class.include(::AcidicJob::Extensions::Sidekiq)
+          end
+          job_instance = job_class.new
+          serialized_job = job_instance.serialize_job(*key.job_args)
+        elsif defined?(::ActiveJob) && job_class < ::ActiveJob::Base
+          unless job_class.include?(::AcidicJob::Extensions::ActiveJob)
+            job_class.include(::AcidicJob::Extensions::ActiveJob)
+          end
+          job_args = begin
+            ::ActiveJob::Arguments.deserialize(key.job_args)
+          rescue ::ActiveJob::DeserializationError
+            key.job_args
+          end
+          job_instance = job_class.new(*job_args)
+          serialized_job = job_instance.serialize_job
+        end
+
+        attributes[:serialized_job] = serialized_job
+        run_attributes << attributes
+      rescue StandardError => e
+        errored_keys << [e, key]
+      end
+
+      # insert all of the `Run` records
+      ::AcidicJob::Run.insert_all(run_attributes)
+
+      # delete all successfully migrated `Key` record
+      ::AcidicJob::Key.where(id: ::AcidicJob::Run.select(:id)).delete_all
+
+      # return a report of the upgrade migration
+      {
+        run_records: ::AcidicJob::Run.count,
+        key_records: ::AcidicJob::Key.count,
+        errored_keys: errored_keys
+      }
+    end
+  end
 end

data/lib/acidic_job/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AcidicJob
-  VERSION = "1.0.0.pre3"
+  VERSION = "1.0.0.pre6"
 end

data/lib/generators/acidic_job/drop_tables_generator.rb

@@ -1,31 +1,26 @@
 # frozen_string_literal: true
 
-require "rails/generators"
 require "rails/generators/active_record"
 
 module AcidicJob
-	module Generators
-		class DropTablesGenerator < ActiveRecord::Generators::Base
-			source_root File.expand_path("../templates", __dir__)
+  module Generators
+    class DropTablesGenerator < ::Rails::Generators::Base
+      include ActiveRecord::Generators::Migration
+      source_root File.expand_path("templates", __dir__)
 
-			desc "Generates a class for a custom delivery method with the given NAME."
-			
-			# ActiveRecord::Generators::Base inherits from Rails::Generators::NamedBase
-			# which requires a NAME parameter for the new table name.
-			# Our generator always uses "acidic_job_runs", so we just set a random name here.
-			argument :name, type: :string, default: "random_name"
+      desc "Drops the pre-1.0 tables for the AcidicJob::Key and AcidicJob::Staged models."
 
-			# Copies the migration template to db/migrate.
-			def copy_acidic_job_runs_migration_files
-				migration_template "drop_acidic_job_keys_migration.rb.erb",
-													 "db/migrate/drop_old_acidic_job_tables.rb"
-			end
-			
-			protected
-			
-			def migration_class
-				ActiveRecord::Migration["#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}"]
-			end
-		end
-	end
-end
+      def copy_migration
+        migration_template "drop_acidic_job_keys_migration.rb.erb",
+                           "db/migrate/drop_old_acidic_job_tables.rb",
+                           migration_version: migration_version
+      end
+
+      protected
+
+      def migration_version
+        "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
+      end
+    end
+  end
+end

data/lib/generators/acidic_job/install_generator.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "rails/generators/active_record"
+
+module AcidicJob
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      include ActiveRecord::Generators::Migration
+      source_root File.expand_path("templates", __dir__)
+
+      desc "Generates a migration for the AcidicJob::Run table."
+
+      # Copies the migration template to db/migrate.
+      def copy_acidic_job_runs_migration_files
+        migration_template "create_acidic_job_runs_migration.rb.erb",
+                           "db/migrate/create_acidic_job_runs.rb",
+                           migration_version: migration_version
+      end
+
+      protected
+
+      def migration_version
+        "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
+      end
+    end
+  end
+end

data/lib/generators/{templates → acidic_job/templates}/create_acidic_job_runs_migration.rb.erb

@@ -1,4 +1,4 @@
-class CreateAcidicJobRuns < <%= migration_class %>
+class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version %>
   def change
     create_table :acidic_job_runs do |t|
       t.boolean 	:staged, 					null: false, 	default: -> { false }

data/lib/generators/{templates → acidic_job/templates}/drop_acidic_job_keys_migration.rb.erb

@@ -1,4 +1,4 @@
-class DropOldAcidicJobTables < <%= migration_class %>
+class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version %>
   def change
     drop_table :acidic_job_keys do |t|
       t.string :idempotency_key, null: false

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acidic_job
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre3
+  version: 1.0.0.pre6
 platform: ruby
 authors:
 - fractaledmind
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-03 00:00:00.000000000 Z
+date: 2022-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -90,9 +90,9 @@ files:
 - lib/acidic_job/upgrade_service.rb
 - lib/acidic_job/version.rb
 - lib/generators/acidic_job/drop_tables_generator.rb
-- lib/generators/acidic_job_generator.rb
-- lib/generators/templates/create_acidic_job_runs_migration.rb.erb
-- lib/generators/templates/drop_acidic_job_keys_migration.rb.erb
+- lib/generators/acidic_job/install_generator.rb
+- lib/generators/acidic_job/templates/create_acidic_job_runs_migration.rb.erb
+- lib/generators/acidic_job/templates/drop_acidic_job_keys_migration.rb.erb
 homepage: https://github.com/fractaledmind/acidic_job
 licenses:
 - MIT

data/lib/generators/acidic_job_generator.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-require "rails/generators"
-require "rails/generators/active_record"
-
-class AcidicJobGenerator < ActiveRecord::Generators::Base
-  # ActiveRecord::Generators::Base inherits from Rails::Generators::NamedBase
-  # which requires a NAME parameter for the new table name.
-  # Our generator always uses "acidic_job_runs", so we just set a random name here.
-  argument :name, type: :string, default: "random_name"
-
-  source_root File.expand_path("templates", __dir__)
-
-  # Copies the migration template to db/migrate.
-  def copy_acidic_job_runs_migration_files
-    migration_template "create_acidic_job_runs_migration.rb.erb",
-                       "db/migrate/create_acidic_job_runs.rb"
-  end
-
-  protected
-
-  def migration_class
-    ActiveRecord::Migration["#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}"]
-  end
-end