acidic_job 1.0.0.pre4 → 1.0.0.pre7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d549814b3b04592d10c716f8715e67d15eb7383c3235ecb5d74319ab568b5507
-  data.tar.gz: 5279750f02439d8fe453d6e5c430c3611513010bebbbdb18c2853d0d5b8d2764
+  metadata.gz: bf6aac5040961c40dafe3650663ae883ce7f8a101bea9eaaf3e82c23df75938d
+  data.tar.gz: 5ddef7d9b955f06306c9a7f338c3b2dca01e85a7716f24c2865d94f294ac26dc
 SHA512:
-  metadata.gz: 7fa1a9fff8203a7a426738f8559d4f7afbcedc9e35832508a9550a113e348f158adc3c28ab58fb4f0ce6ca0fb3c9cc08c7f17d84cb2e574323e376d78188b18e
-  data.tar.gz: 001dd65449fdc56b3ca2bd9b74be00bb0646b3875986844392b31ec4536a7135c23da66fa7b32e20b7a893ecfc255caaefd423a72bfdaa8d3b39a68fe469329f
+  metadata.gz: a224fb33d1c86ac07c4a0d6bd5d4f8853a7ddbb477fef6c3a1584c62002f7e1c7741c89b751874b8405d99132bfa17fefae6aa0364373709f9cd5725b64cb02f
+  data.tar.gz: '090ca69264e42984c3dd2331e073d90cd9f3d464c602b854f81d745a9dedd33586f155cfbd885d832b30b8e4c0956b0eda192978e3aa5165b623ce503a651b01'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    acidic_job (1.0.0.pre4)
+    acidic_job (1.0.0.pre7)
       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

@@ -176,7 +176,6 @@ One final feature for those of you using Sidekiq Pro: an integrated DSL for Side
 In my opinion, any commercial software using Sidekiq should get Sidekiq Pro; it is _absolutely_ worth the money. If, however, you are using `acidic_job` in a non-commercial application, you could use the open-source dropin replacement for this functionality: https://github.com/breamware/sidekiq-batch
 
 ```ruby
-# TODO: write code sample
 class RideCreateJob < ActiveJob::Base
   include AcidicJob
 
@@ -192,6 +191,71 @@ class RideCreateJob < ActiveJob::Base
 end
 ```
 
+## Testing
+
+When testing acidic jobs, you are likely to run into `ActiveRecord::TransactionIsolationError`s:
+
+```
+ActiveRecord::TransactionIsolationError: cannot set transaction isolation in a nested transaction
+```
+
+This error is thrown because by default RSpec and most MiniTest test suites use database transactions to keep the test database clean between tests. The database transaction that is wrapping all of the code executed in your test is run at the standard isolation level, but acidic jobs then try to create another transaction run at a more conservative isolation level. You cannot have a nested transaction that runs at a different isolation level, thus, this error. 
+
+In order to avoid this error, you need to ensure firstly that your tests that run your acidic jobs are not using a database transaction and secondly that they use some different strategy to keep your test database clean. The [DatabaseCleaner](https://github.com/DatabaseCleaner/database_cleaner) gem is a commonly used tool to manage different strategies for keeping your test database clean. As for which strategy to use, `truncation` and `deletion` are both safe, but their speed varies based on our app's table structure (see https://github.com/DatabaseCleaner/database_cleaner#what-strategy-is-fastest). Either is fine; use whichever is faster for your app.
+
+In order to make this test setup simpler, `AcidicJob` provides a `TestCase` class that your MiniTest jobs tests can inherit from. It is simple; it inherits from `ActiveJob::TestCase`, sets `use_transactional_tests` to `false`, and ensures `DatabaseCleaner` is run for each of your tests:
+
+```ruby
+class AcidicJob::TestCase < ActiveJob::TestCase
+  self.use_transactional_tests = false
+
+  def before_setup
+    super
+    DatabaseCleaner.start
+  end
+
+  def after_teardown
+    DatabaseCleaner.clean
+    super
+  end
+
+  # ...
+end
+```
+
+For those of you using RSpec, you can require the `acidic_job/rspec_configuration` file, which will configure RSpec in the exact same way I have used in my RSpec projects to allow me to test acidic jobs with either the `deletion` strategy but still have all of my other tests use the fast `transaction` strategy:
+
+```ruby
+require "database_cleaner/active_record"
+
+# see https://github.com/DatabaseCleaner/database_cleaner#how-to-use
+RSpec.configure do |config|
+  config.use_transactional_fixtures = false
+
+  config.before(:suite) do
+    DatabaseCleaner.clean_with :truncation
+
+    # Here we are defaulting to :transaction but swapping to deletion for some specs;
+    # if your spec or its code-under-test uses
+    # nested transactions then specify :transactional e.g.:
+    #   describe "SomeWorker", :transactional do
+    #
+    DatabaseCleaner.strategy = :transaction
+
+    config.before(:context, transactional: true) { DatabaseCleaner.strategy = :deletion }
+    config.after(:context, transactional: true) { DatabaseCleaner.strategy = :transaction }
+    config.before(:context, type: :system) { DatabaseCleaner.strategy = :deletion }
+    config.after(:context, type: :system) { DatabaseCleaner.strategy = :transaction }
+  end
+
+  config.around(:each) do |example|
+    DatabaseCleaner.cleaning do
+      example.run
+    end
+  end
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

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/rspec_configuration.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "rspec"
+require "database_cleaner/active_record"
+
+# see https://github.com/DatabaseCleaner/database_cleaner#how-to-use
+RSpec.configure do |config|
+  config.use_transactional_fixtures = false
+
+  config.before(:suite) do
+    DatabaseCleaner.clean_with :truncation
+
+    # Here we are defaulting to :transaction but swapping to deletion for some specs;
+    # if your spec or its code-under-test uses
+    # nested transactions then specify :transactional e.g.:
+    #   describe "SomeWorker", :transactional do
+    #
+    DatabaseCleaner.strategy = :transaction
+
+    config.before(:context, transactional: true) { DatabaseCleaner.strategy = :deletion }
+    config.after(:context, transactional: true) { DatabaseCleaner.strategy = :transaction }
+    config.before(:context, type: :system) { DatabaseCleaner.strategy = :deletion }
+    config.after(:context, type: :system) { DatabaseCleaner.strategy = :transaction }
+  end
+
+  config.around(:each) do |example|
+    DatabaseCleaner.cleaning do
+      example.run
+    end
+  end
+end

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/test_case.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "active_job/test_case"
+require "database_cleaner/active_record"
+
+module AcidicJob
+  class TestCase < ActiveJob::TestCase
+    self.use_transactional_tests = false
+
+    def before_setup
+      super
+      DatabaseCleaner.start
+    end
+
+    def after_teardown
+      DatabaseCleaner.clean
+      super
+    end
+  end
+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.pre4"
+  VERSION = "1.0.0.pre7"
 end

data/lib/generators/acidic_job/drop_tables_generator.rb

@@ -3,24 +3,24 @@
 require "rails/generators/active_record"
 
 module AcidicJob
-	module Generators
-		class DropTablesGenerator < ::Rails::Generators::Base
-			include ActiveRecord::Generators::Migration
-			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 "Drops the pre-1.0 tables for the AcidicJob::Key and AcidicJob::Staged models."
+      desc "Drops the pre-1.0 tables for the AcidicJob::Key and AcidicJob::Staged models."
 
-			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
+      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

@@ -7,21 +7,21 @@ module AcidicJob
     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
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acidic_job
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre4
+  version: 1.0.0.pre7
 platform: ruby
 authors:
 - fractaledmind
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-03 00:00:00.000000000 Z
+date: 2022-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -84,9 +84,11 @@ files:
 - lib/acidic_job/idempotency_key.rb
 - lib/acidic_job/perform_wrapper.rb
 - lib/acidic_job/recovery_point.rb
+- lib/acidic_job/rspec_configuration.rb
 - lib/acidic_job/run.rb
 - lib/acidic_job/staging.rb
 - lib/acidic_job/step.rb
+- lib/acidic_job/test_case.rb
 - lib/acidic_job/upgrade_service.rb
 - lib/acidic_job/version.rb
 - lib/generators/acidic_job/drop_tables_generator.rb